File Coverage

blib/lib/Params/Dry/Declare.pm

Criterion	Covered	Total	%
statement	15	15	100.0
branch			n/a
condition			n/a
subroutine	5	5	100.0
pod			n/a
total	20	20	100.0

#*
#* Name: Params::Dry::Declare (some magic for Params::Dry :)
#* Info: Extension to Params::Dry, which make possible declaration of the parameters
#* Author: Pawel Guspiel (neo77)
#* Details:
#*      The module allow parameters declaration in following form:
#*
#*          sub new (
#*              ! name:;                                    --- name of the user
#*              ? second_name   : name      = 'unknown';    --- second name
#*              ? details       : String    = 'yakusa';     --- details
#*          ) {
#*
#*      instead of using:
#*
#*          sub table {
#*              my $self = __@_;
#*
#*              my $p_name          = rq 'name', DEFAULT_TYPE;               # name of the user
#*              my $p_second_name   = op 'second_name', 'name', 'unknown';   # second name
#*              ...
#*
#*      As a consequence of using this module you can use parameters in the function body as follows:
#*          print "name: ".p_name;
#*
#*      I'm suggesting you to use coloring in your text editor for p_\w+ to see function parameters everywhere

use Params::Dry qw(:short);    # required to take care of parameters (and because is the best of course ;)
                               # for multi types 1.20 or higher is required

package Params::Dry::Declare;
{
    use strict;
    use warnings;

    # --- version ---
    our $VERSION = 0.9907;

    #=------------------------------------------------------------------------ { use, constants }

    use Filter::Simple;        # extends subroutine definition

    #=------------------------------------------------------------------------ { module magic }

    FILTER_ONLY code_no_comments => sub {
        while ( my ( $orig_sub, $sub_name, $sub_declared_vars ) = $_ =~ /(sub\s+(\w+)\s*\(\s*(?:(.+?)\s*)?\)\s*{)/s ) {

            # --- clean
            $sub_declared_vars //= '';
            $sub_declared_vars =~ s/\n//;

            # --- prepare variables string
            my $variables_string = 'my $self = __@_;';

            # --- parse variables
            for my $param ( split /\s*;\s*/, $sub_declared_vars ) {

                #+ remove comments
                $param =~ s/---.+?([?!]|$)/$1/s;

                next unless $param;

                #+ parse
                $param =~ /^(?[!?]) \s* (?\w+) \s* : \s* (?\w+ (?:\[.+?\])? (?:\|\w+ (?:\[.+?\])?)* )? \s* (?:= \s* (?.+))? (?:[#].*)?$/x;

                my ( $is_rq, $param_name, $param_type, $default ) = ( '' ) x 4;

                $is_rq = $+{ 'is_rq' } eq '!';
                ( $param_name, $param_type, $default ) = ( $+{ 'param_name' }, $+{ 'param_type' }, $+{ 'default' } );
                $param_type ||= $param_name;

                $variables_string .= "my \$p_$param_name = " . ( ( $is_rq ) ? 'rq' : 'op' ) . " '$param_name'";
                $variables_string .= ", '$param_type'" if $param_type;
                $variables_string .= ", $default"      if $default;
                $variables_string .= '; ';
            } #+ end of: for my $param ( split /\s*;\s*/...)

            # --- for errors in correct lines
            my $new_lines = "\n" x ( $orig_sub =~ s/\n/\n/gs );
            s/\Q$orig_sub/sub $sub_name { $new_lines $variables_string no_more;/;

        } #+ end of: while ( my ( $orig_sub, $sub_name...))
        $_;
    };
};
0115 && 0x4d;

#+ End of Params::Declare magic :)
# ABSTRACT: Declare extension for Params::Dry - Simple Global Params Management System which helps you to keep the DRY rule everywhere

#+ End of Params::Dry
__END__