Venus::Role::Assertable

Assertable Role

Assertable Role for Perl 5

method: assert method: assertion method: check method: coerce method: make

package Example;

use Venus::Class;
use Venus::Assert;

with 'Venus::Role::Assertable';

sub assertion {
  Venus::Assert->new('Example')->accept('Example')
}

package main;

my $example = Example->new;

# $example->check;

This package modifies the consuming package and requires methods for making the object assertable.

The assert method returns the data provided if it passes the registered type constraints, or throws an exception.

assert(any $data) (any)

{ since => '1.23', }

=example-1 assert

# given: synopsis

package main;

my $assert = $example->assert;

# Exception! (isa Venus::Check::Error)

The assertion method receives no arguments and should returns a Venus::Assert object.

assertion() (Venus::Assert)

{ since => '1.23', }

=example-1 assertion

package main;

my $example = Example->new;

my $assertion = $example->assertion;

# bless({name => "Example"}, "Venus::Assert")

The check method returns true if the data provided passes the registered type constraints, or returns false.

check(any $data) (boolean)

{ since => '1.23', }

=example-1 check

# given: synopsis

package main;

my $check = $example->check;

# 0

The coerce method returns a coerced value if the data provided matches any of the registered type coercions, or returns the data provided.

coerce(any $data) (any)

{ since => '1.23', }

=example-1 coerce

# given: synopsis

package main;

my $assertion = $example->assertion;

$assertion->match('string')->format(sub{ucfirst(lc($_))});

my $coerce = $assertion->coerce;

# undef

The make method returns an instance of the invocant, if the data provided passes the registered type constraints, allowing for any coercion, or throws an exception. If the data provided is itself an instance of the invocant it will be returned unaltered.

make(any $data) (object)

{ since => '1.23', }

=example-1 make

# given: synopsis

package main;

my $make = $example->make;

# Exception! (isa Venus::Check::Error)

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

cpanm Venus

perl -MCPAN -e shell
install Venus