Venus::Class - Class Builder
Class Builder for Perl 5
package Person; use Venus::Class 'attr'; attr 'fname'; attr 'lname'; package Identity; use Venus::Role 'attr'; attr 'id'; attr 'login'; attr 'password'; sub EXPORT { # explicitly declare routines to be consumed ['id', 'login', 'password'] } package Authenticable; use Venus::Role; sub authenticate { return true; } sub AUDIT { my ($self, $from) = @_; # ensure the caller has a login and password when consumed die "${from} missing the login attribute" if !$from->can('login'); die "${from} missing the password attribute" if !$from->can('password'); } sub BUILD { my ($self, $data) = @_; $self->{auth} = undef; return $self; } sub EXPORT { # explicitly declare routines to be consumed ['authenticate'] } package User; use Venus::Class; base 'Person'; with 'Identity'; attr 'email'; test 'Authenticable'; sub valid { my ($self) = @_; return $self->login && $self->password ? true : false; } package main; my $user = User->new( fname => 'Elliot', lname => 'Alderson', ); # bless({fname => 'Elliot', lname => 'Alderson'}, 'User')
This package provides a class builder which when used causes the consumer to inherit from Venus::Core::Class which provides object construction and lifecycle hooks.
This package provides the following functions:
attr(string $name) (string)
The attr function creates attribute accessors for the calling package. This function is always exported unless a routine of the same name already exists.
Since 1.00
1.00
package Example; use Venus::Class; attr 'name'; # "Example"
base(string $name) (string)
The base function registers one or more base classes for the calling package. This function is always exported unless a routine of the same name already exists.
package Entity; use Venus::Class; sub output { return; } package Example; use Venus::Class; base 'Entity'; # "Example"
catch(coderef $block) (Venus::Error, any)
The catch function executes the code block trapping errors and returning the caught exception in scalar context, and also returning the result as a second argument in list context. This function isn't export unless requested.
Since 1.01
1.01
package Example; use Venus::Class 'catch'; sub attempt { catch {die}; } package main; my $example = Example->new; my $error = $example->attempt; $error; # "Died at ..."
error(maybe[hashref] $args) (Venus::Error)
The error function throws a Venus::Error exception object using the exception object arguments provided. This function isn't export unless requested.
package Example; use Venus::Class 'error'; sub attempt { error; } package main; my $example = Example->new; my $error = $example->attempt; # bless({...}, 'Venus::Error')
false() (boolean)
The false function returns a falsy boolean value which is designed to be practically indistinguishable from the conventional numerical 0 value. This function is always exported unless a routine of the same name already exists.
0
package Example; use Venus::Class; my $false = false; # 0
from(string $name) (string)
The from function registers one or more base classes for the calling package and performs an "audit". This function is always exported unless a routine of the same name already exists.
package Entity; use Venus::Class; sub AUDIT { my ($self, $from) = @_; die "Missing startup" if !$from->can('startup'); die "Missing shutdown" if !$from->can('shutdown'); } package Example; use Venus::Class; attr 'startup'; attr 'shutdown'; from 'Entity'; # "Example"
mixin(string $name) (string)
The mixin function registers and consumes mixins for the calling package. This function is always exported unless a routine of the same name already exists.
Since 1.02
1.02
package YesNo; use Venus::Mixin; sub no { return 0; } sub yes { return 1; } sub EXPORT { ['no', 'yes'] } package Answer; use Venus::Class; mixin 'YesNo'; # "Answer"
package YesNo; use Venus::Mixin; sub no { return 0; } sub yes { return 1; } sub EXPORT { ['no', 'yes'] } package Answer; use Venus::Class; mixin 'YesNo'; sub no { return [0]; } sub yes { return [1]; } my $package = "Answer"; # "Answer"
raise(string $class | tuple[string, string] $class, maybe[hashref] $args) (Venus::Error)
The raise function generates and throws a named exception object derived from Venus::Error, or provided base class, using the exception object arguments provided. This function isn't export unless requested.
package Example; use Venus::Class 'raise'; sub attempt { raise 'Example::Error'; } package main; my $example = Example->new; my $error = $example->attempt; # bless({...}, 'Example::Error')
role(string $name) (string)
The role function registers and consumes roles for the calling package. This function is always exported unless a routine of the same name already exists.
package Ability; use Venus::Role; sub action { return; } package Example; use Venus::Class; role 'Ability'; # "Example"
package Ability; use Venus::Role; sub action { return; } sub EXPORT { return ['action']; } package Example; use Venus::Class; role 'Ability'; # "Example"
test(string $name) (string)
The test function registers and consumes roles for the calling package and performs an "audit", effectively allowing a role to act as an interface. This function is always exported unless a routine of the same name already exists.
package Actual; use Venus::Role; package Example; use Venus::Class; test 'Actual'; # "Example"
package Actual; use Venus::Role; sub AUDIT { die "Example is not an 'actual' thing" if $_[1]->isa('Example'); } package Example; use Venus::Class; test 'Actual'; # "Example"
true() (boolean)
The true function returns a truthy boolean value which is designed to be practically indistinguishable from the conventional numerical 1 value. This function is always exported unless a routine of the same name already exists.
1
package Example; use Venus::Class; my $true = true; # 1
package Example; use Venus::Class; my $false = !true; # 0
with(string $name) (string)
The with function registers and consumes roles for the calling package. This function is an alias of the "test" function and will perform an "audit" if present. This function is always exported unless a routine of the same name already exists.
package Understanding; use Venus::Role; sub knowledge { return; } package Example; use Venus::Class; with 'Understanding'; # "Example"
package Understanding; use Venus::Role; sub knowledge { return; } sub EXPORT { return ['knowledge']; } package Example; use Venus::Class; with 'Understanding'; # "Example"
Awncorp, awncorp@cpan.org
awncorp@cpan.org
Copyright (C) 2000, Awncorp, awncorp@cpan.org.
This program is free software, you can redistribute it and/or modify it under the terms of the Apache license version 2.0.
To install Venus, copy and paste the appropriate command in to your terminal.
cpanm
cpanm Venus
CPAN shell
perl -MCPAN -e shell install Venus
For more information on module installation, please visit the detailed CPAN module installation guide.