File Coverage

blib/lib/Syntax/Feature/Method.pm

Criterion	Covered	Total	%
statement	27	27	100.0
branch			n/a
condition	4	4	100.0
subroutine	9	9	100.0
pod	1	1	100.0
total	41	41	100.0

use strict;
use warnings;

# ABSTRACT: Provide a method keyword

package Syntax::Feature::Method;
BEGIN {
  $Syntax::Feature::Method::VERSION = '0.001';
}

use Method::Signatures::Simple  ();
use B::Hooks::EndOfScope;
use Carp                        ();

use namespace::clean;

$Carp::Internal{ +__PACKAGE__ }++;

sub install {
    my ($class, %args) = @_;

    my $target      = $args{into};
    my $name        = $args{options}{ -as }         || 'method';
    my $invocant    = $args{options}{ -invocant }   || '$self';

    # install keyword
    Method::Signatures::Simple->import(
        into        => $target,
        name        => $name,
        invocant    => $invocant,
    );

    # remove runtime handler at end of scope
    on_scope_end {
        namespace::clean->clean_subroutines($target, $name);
    };

    return 1;
}

1;



=pod

=head1 NAME

Syntax::Feature::Method - Provide a method keyword

=head1 VERSION

version 0.001

=head1 SYNOPSIS

    use syntax 'method';

    method foo ($n) { $n * $self->bar }

    my $method = method ($msg) {
        print "$msg\n";
    };

=head1 DESCRIPTION

This module will install the L syntax extension
into the requesting namespace.

You can import the keyword multiple times under different names with different
options:

    use syntax
        'method',
        'method' => {
            -as         => 'classmethod',
            -invocant   => '$class',
        };

=head1 OPTIONS

=head2 -as

    use syntax method => { -as => 'provide' };

    provide addition ($n, $m) { $n + $m }

The C<-as> keyword allows you to install the keyword under a different name.
This is especially useful if you want a separate keyword for class methods with
a different L.

=head2 -invocant

    use syntax method => { -invocant => '$me' };

    method sum { $me->foo + $me->bar }

Allows you to set a different default invocant. Useful if you want to import
a second keyword for class methods that has a C<$class> invocant.

=head1 METHODS

=head2 install

Called by the L dispatcher to install the exntension into the
requesting package.

=head1 SEE ALSO

L,
L

=head1 BUGS

Please report any bugs or feature requests to [e-mail] or through the web interface at:
 http://rt.cpan.org/Public/Dist/Display.html?Name=Syntax-Feature-Method

=head1 AUTHOR

Robert 'phaylon' Sedlacek

=head1 COPYRIGHT AND LICENSE

This software is copyright (c) 2010 by Robert 'phaylon' Sedlacek.

This is free software; you can redistribute it and/or modify it under
the same terms as the Perl 5 programming language system itself.

=cut


__END__