The Perl Toolchain Summit needs more sponsors. If your company depends on Perl, please support this very important event.
 / 
Params-Dry-Declare-0.9907
River stage zero No dependents
++
/ Params::Dry::Declare

NAME

Params::Dry::Declare - Declare extension for Params::Dry - Simple Global Params Management System which helps you to keep the DRY rule everywhere

VERSION

version 0.9907 (beta)

SYNOPSIS

Params::Dry::Declare (some magic for Params::Dry :) Extension to Params::Dry, which make possible declaration of the parameters, keeping comments declarations and all this things near.

DESCRIPTION

Fast start!

  • typedef - defines global types for variables (from Params::Dry)

  • ! - required parameter

  • ? - optional parameter

  • --- - comment

  • no_more - not needed any more :)

  • __@_ - not needed any more :)

Example:

    # The module allow parameters declaration in following form:

          sub new (
              ! name:;                                    --- name of the user
              ? second_name   : name      = 'unknown';    --- second name
              ? details       : String|Int    = '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 it was in Params::Dry

    #  As a consequence of using this module you can use parameters in the function body as follows:
          print "name: ".$p_name;

    # IMPORTANT - to mark declaration of no params function please use empty params list (;)

        sub get_no_params(;) {

        }

Grammar:

You are declaring in-variable using following schema:

required/optional variable name : [ type name ] [ = default value ] [ --- comment ]

where:

  • ! - required parameter

  • ? - optional parameter

  • variable name - any perl variable name

  • type name - type defined by typedef or ad-hoc type (alternative types can be added after pipe(|) sign ex. String[3]|Int[2])

  • default value - default value for the parameter

  • comment - just a comment to remember what this variable is doing

Because all parameters are available as $p_variable name I'm suggesting you to use coloring in your text editor for $p_\w+ to see function parameters everywhere

Important!

To mark declaration of no params function please use empty params list (;)

        sub get_no_params(;) {

        }

Understand main concepts

First. If you can use any function as in natural languague - you will use and understand it even after few months.

Second. Your lazy life will be easy, and you will reduce a lot of errors if you will have guarancy that your parameter in whole project means the same ( ex. when you see 'client' you know that it is always String[32] ).

Third. You want to set the type in one and only in one place.

Yes, DRY principle in its pure form!

So all your dreams you can now find in this module.

And even more, every parameter is declared in the function header and no where more. So it helps keeping your code clean!

That's all. Easy to use. Easy to manage. Easy to understand.

AUTHOR

Pawel Guspiel (neo77), <neo at cpan.org>

BUGS

Please report any bugs or feature requests to bug-params at rt.cpan.org, or through the web interface at http://rt.cpan.org/NoAuth/ReportBug.html?Queue=Params-Dry-Declare. I will be notified, and then you'll automatically be notified of progress on your bug as I make changes.

SUPPORT

You can find documentation for this module with the perldoc command.

    perldoc Params::Dry::Declare
    perldoc Params::Dry

You can also look for information at:

LICENSE AND COPYRIGHT

Copyright 2013 Pawel Guspiel (neo77).

This program is free software; you can redistribute it and/or modify it under the terms of the the Artistic License (2.0). You may obtain a copy of the full license at:

http://www.perlfoundation.org/artistic_license_2_0

Any use, modification, and distribution of the Standard or Modified Versions is governed by this Artistic License. By using, modifying or distributing the Package, you accept this license. Do not use, modify, or distribute the Package, if you do not accept this license.

If your Modified Version has been derived from a Modified Version made by someone other than you, you are nevertheless required to ensure that your Modified Version complies with the requirements of this license.

This license does not grant you the right to use any trademark, service mark, tradename, or logo of the Copyright Holder.

This license includes the non-exclusive, worldwide, free-of-charge patent license to make, have made, use, offer to sell, sell, import and otherwise transfer the Package with respect to any patent claims licensable by the Copyright Holder that are necessarily infringed by the Package. If you institute patent litigation (including a cross-claim or counterclaim) against any party alleging that the Package constitutes direct or contributory patent infringement, then this Artistic License to you shall terminate on the date that such litigation is filed.

Disclaimer of Warranty: THE PACKAGE IS PROVIDED BY THE COPYRIGHT HOLDER AND CONTRIBUTORS "AS IS' AND WITHOUT ANY EXPRESS OR IMPLIED WARRANTIES. THE IMPLIED WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE, OR NON-INFRINGEMENT ARE DISCLAIMED TO THE EXTENT PERMITTED BY YOUR LOCAL LAW. UNLESS REQUIRED BY LAW, NO COPYRIGHT HOLDER OR CONTRIBUTOR WILL BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, OR CONSEQUENTIAL DAMAGES ARISING IN ANY WAY OUT OF THE USE OF THE PACKAGE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.