Venus::Name

Name Class

Name Class for Perl 5

method: default method: dist method: explain method: file method: format method: label method: lookslike_a_file method: lookslike_a_label method: lookslike_a_package method: lookslike_a_path method: lookslike_a_pragma method: package method: path

package main;

use Venus::Name;

my $name = Venus::Name->new('Foo/Bar');

# $name->package;

This package provides methods for parsing and formatting package namespace strings.

Venus::Kind::Utility

Venus::Role::Accessible Venus::Role::Buildable Venus::Role::Explainable Venus::Role::Valuable

The default method returns the default value, i.e. 'Venus'.

default() (string)

{ since => '0.01', }

=example-1 default

# given: synopsis;

my $default = $name->default;

# "Venus"

The dist method returns a package distribution representation of the name.

dist() (string)

{ since => '0.01', }

=example-1 dist

# given: synopsis;

my $dist = $name->dist;

# "Foo-Bar"

The explain method returns the package name and is used in stringification operations.

explain() (string)

{ since => '0.01', }

=example-1 explain

# given: synopsis;

my $explain = $name->explain;

# "Foo/Bar"

The file method returns a file representation of the name.

file() (string)

{ since => '0.01', }

=example-1 file

# given: synopsis;

my $file = $name->file;

# "foo__bar"

The format method calls the specified method passing the result to the core "sprintf" function with itself as an argument. This method supports dispatching, i.e. providing a method name and arguments whose return value will be acted on by this method.

format(string $method, string $format) (string)

{ since => '0.01', }

=example-1 format

# given: synopsis;

my $format = $name->format('file', '%s.t');

# "foo__bar.t"

The label method returns a label (or constant) representation of the name.

label() (string)

{ since => '0.01', }

=example-1 label

# given: synopsis;

my $label = $name->label;

# "Foo_Bar"

The lookslike_a_file method returns truthy if its state resembles a filename.

lookslike_a_file() (string)

{ since => '0.01', }

=example-1 lookslike_a_file

# given: synopsis;

my $lookslike_a_file = $name->lookslike_a_file;

# ""

The lookslike_a_label method returns truthy if its state resembles a label (or constant).

lookslike_a_label() (string)

{ since => '0.01', }

=example-1 lookslike_a_label

# given: synopsis;

my $lookslike_a_label = $name->lookslike_a_label;

# ""

The lookslike_a_package method returns truthy if its state resembles a package name.

lookslike_a_package() (string)

{ since => '0.01', }

=example-1 lookslike_a_package

# given: synopsis;

my $lookslike_a_package = $name->lookslike_a_package;

# ""

The lookslike_a_path method returns truthy if its state resembles a file path.

lookslike_a_path() (string)

{ since => '0.01', }

=example-1 lookslike_a_path

# given: synopsis;

my $lookslike_a_path = $name->lookslike_a_path;

# 1

The lookslike_a_pragma method returns truthy if its state resembles a pragma.

lookslike_a_pragma() (string)

{ since => '0.01', }

=example-1 lookslike_a_pragma

# given: synopsis;

my $lookslike_a_pragma = $name->lookslike_a_pragma;

# ""

The package method returns a package name representation of the name given.

package() (string)

{ since => '0.01', }

=example-1 package

# given: synopsis;

my $package = $name->package;

# "Foo::Bar"

The path method returns a path representation of the name.

path() (string)

{ since => '0.01', }

=example-1 path

# given: synopsis;

my $path = $name->path;

# "Foo/Bar"

This package overloads the . operator.

This package overloads the eq operator.

This package overloads the ne operator.

This package overloads the qr operator.

This package overloads the "" operator.

This package overloads the ~~ operator.

t/Venus.t: present: authors t/Venus.t: present: license

cpanm Venus

perl -MCPAN -e shell
install Venus