File Coverage

blib/lib/Venus/Role/Doable.pm

Criterion	Covered	Total	%
statement	17	17	100.0
branch			n/a
condition	1	2	50.0
subroutine	6	7	85.7
pod	1	2	50.0
total	25	28	89.2

package Venus::Role::Doable;

use 5.018;

use strict;
use warnings;

use Venus::Role 'with';

# METHODS

sub do {
  my ($self, $code, @args) = @_;

  $code ||= sub{};

  local $_ = $self;
  $self->$code(@args);

  return $self;
}

# EXPORTS

sub EXPORT {
  ['do']
}

1;



=head1 NAME

Venus::Role::Doable - Doable Role

=cut

=head1 ABSTRACT

Doable Role for Perl 5

=cut

=head1 SYNOPSIS

  package Example;

  use Venus::Class;

  with 'Venus::Role::Doable';

  attr 'time';

  sub execute {
    return;
  }

  package main;

  my $example = Example->new;

  # $example->do(time => time)->execute;

=cut

=head1 DESCRIPTION

This package modifies the consuming package and provides methods for chaining
any chainable and non-chainable methods (by ignoring their return values).

=cut

=head1 METHODS

This package provides the following methods:

=cut

=head2 do

  do(string | coderef $method, any @args) (object)

The do method dispatches the method call or executes the callback and returns
the invocant. This method supports dispatching, i.e. providing a method name
and arguments whose return value will be acted on by this method.

I>

=over 4

=item do example 1

  package main;

  my $example = Example->new;

  $example = $example->do(time => time);

  # bless({ time => 0000000000 }, "Example")

  # $example->execute;

=back

=cut

=head1 AUTHORS

Awncorp, C

=cut

=head1 LICENSE

Copyright (C) 2000, Awncorp, C.

This program is free software, you can redistribute it and/or modify it under
the terms of the Apache license version 2.0.

=cut