NAME
Identity::Utils - Provide utility functions related to distribution identities
SYNOPSIS
use Identity::Utils;
my $identity = "Foo::Bar:ver<0.0.42>:auth<zef:lizmat>:api<2.0>";
say short-name($identity); # Foo::Bar
say ver($identity); # 0.0.42
say without-ver($identity); # Foo::Bar:auth<zef:lizmat>:api<2.0>
say version($identity); # v0.0.42
say auth($identity); # zef:lizmat
say without-auth($identity); # Foo::Bar:ver<0.0.42>:api<2.0>
say ecosystem($identity); # zef
say nick($identity); # lizmat
say api($identity); # 2.0
say without-api($identity); # Foo::Bar:ver<0.0.42>:auth<zef:lizmat>
say sanitize($identity); # Foo::Bar:ver<0.0.42>:auth<zef:lizmat>:api<2.0>
say build("Foo::Bar", :ver<0.0.42>); # Foo::Bar:ver<0.0.42>
DESCRIPTION
Identity::Utils provides some utility functions for inspecting various aspects of distribution identity strings. They assume any given string is a well-formed identity in the form name:ver<0.0.1>:auth<eco:nick>
with an optional api:<1>
field.
A general note with regards to api
: if it consists of "0"
, then it is assumed there is no api field specified.
SUBROUTINES
api
my $identity = "Foo::Bar:ver<0.0.42>:auth<zef:lizmat>:api<2.0>";
say api($identity); # 2.0
Returns the api
field of the given identity, or Nil
if no api
field could be found.
auth
my $identity = "Foo::Bar:ver<0.0.42>:auth<zef:lizmat>:api<2.0>";
say auth($identity); # zef:lizmat
Returns the auth
field of the given identity, or Nil
if no auth
field could be found.
build
my $ver = "0.0.42";
my $auth = "zef:lizmat";
my $api = "2.0";
say build("Foo::Bar", :$ver, :$auth, :$api);
# Foo::Bar:ver<0.0.42>:auth<zef:lizmat>:api<2.0>
say build("Foo::Bar", :$ver, :nick<lizmat>);
# Foo::Bar:ver<0.0.42>:auth<zef:lizmat>
Builds an identity string from the given short name and optional named arguments:
ver - the "ver" value to be used
auth - the "auth" value to be used, overrides "ecosystem" and "nick"
api - the "api" value to be used
ecosystem - the ecosystem part of "auth", defaults to "zef"
nick - the nick part of "auth", unless overridden by "auth"
ecosystem
my $identity = "Foo::Bar:ver<0.0.42>:auth<zef:lizmat>:api<2.0>";
say ecosystem($identity); # zef
Returns the ecosystem part of the auth
field of the given identity, or Nil
if no auth
field could be found.
nick
my $identity = "Foo::Bar:ver<0.0.42>:auth<zef:lizmat>:api<2.0>";
say nick($identity); # lizmat
Returns the nickname part of the auth
field of the given identity, or Nil
if no auth
field could be found.
sanitize
my $identity = "Foo::Bar:auth<zef:lizmat>:ver<0.0.42>:api<2.0>";
say sanitize($identity); # Foo::Bar:ver<0.0.42>:auth<zef:lizmat>:api<2.0>
Returns a version of the given identity in which any ver
, auth
and api
fields are put in the correct order.
short-name
my $identity = "Foo::Bar:ver<0.0.42>:auth<zef:lizmat>:api<2.0>";
say short-name($identity); # Foo::Bar
Returns the short name part of the given identity, or the identity itself if no ver
, auth
or api
fields could be found.
ver
my $identity = "Foo::Bar:ver<0.0.42>:auth<zef:lizmat>:api<2.0>";
say ver($identity); # 0.0.42
Returns the ver
field of the given identity as a Str
, or Nil
if no ver
field could be found.
version
my $identity = "Foo::Bar:ver<0.0.42>:auth<zef:lizmat>:api<2.0>";
say version($identity); # v0.0.42
Returns the ver
field of the given identity as a Version
object, or Nil
if no ver
field could be found.
without-api
my $identity = "Foo::Bar:ver<0.0.42>:auth<zef:lizmat>:api<2.0>";
say without-api($identity); # Foo::Bar:ver<0.0.42>:auth<zef:lizmat>
Returns the identity without any api
field of the given identity
without-auth
my $identity = "Foo::Bar:ver<0.0.42>:auth<zef:lizmat>:api<2.0>";
say without-auth($identity); # Foo::Bar:ver<0.0.42>:api<2.0>
Returns the identity without any auth
field of the given identity
without-ver
my $identity = "Foo::Bar:ver<0.0.42>:auth<zef:lizmat>:api<2.0>";
say without-ver($identity); # Foo::Bar:auth<zef:lizmat>:api<2.0>
Returns the identity without any ver
field of the given identity
AUTHOR
Elizabeth Mattijsen liz@raku.rocks
Source can be located at: https://github.com/lizmat/Identity-Utils . Comments and Pull Requests are welcome.
COPYRIGHT AND LICENSE
Copyright 2022 Elizabeth Mattijsen
This library is free software; you can redistribute it and/or modify it under the Artistic License 2.0.