Viktor Turskyi

NAME

LIVR::Contract - Design by Contract in Perl with Language Independent Validation Rules (LIVR).

SYNOPSIS

  # Common usage
  use LIVR::Contract;

  # Positional arguments
  contract 'my_method1' => (
      requires => {
          0 => [ 'required' ]
          1 => [ 'required', 'positive_integer' ]
          2 => [ 'required' ],
      },
      ensures => {
          0 => ['required', 'positive_integer' ]
      }
  );

  # Named arguments
  contract 'my_method2' => (
      requires => {
          0    => [ 'required' ],
          id   => [ 'required', 'positive_integer' ],
          name => [ 'required' ],
      },
      ensures => {
          0 => ['required', 'positive_integer' ]
      }
  );

  # Named arguments in hashref
  contract 'my_method3' => (
      requires => {
          0 => [ 'required' ],
          1 => [ 'required', { nested_object => {
                  id   => [ 'required', 'positive_integer' ],
                  name => [ 'required' ],
              }
          }
      },
      ensures => {
          0 => ['required', 'positive_integer' ]
      }
  );
  
  sub my_method1 {
      my ($self, $id, $name) = @_;
      return 100;
  }

  sub my_method2 {
      my ($self, %named_args) = @_;
      return 100;
  }

  sub my_method3 {
      my ($self, $named_args_hashref) = @_;
      return 100;
  }

  # Somewhere in your code
  $self->my_method1( 100, 'Some Name');

  # Somewhere in your code
  $self->my_method2(
      id   => 100,
      name => 'Some Name',
  );

  # Somewhere in your code
  $self->my_method3({
      id   => 100,
      name => 'Some Name',
  });

WARNING

This software is under heavy development and considered ALPHA quality. Things might be broken, not all features have been implemented, and APIs are likely to change. YOU HAVE BEEN WARNED.

DESCRIPTION

LIVR::Contract design by Contract in Perl with Language Independent Validation Rules (LIVR). Uses Validator::LIVR underneath.

See https://github.com/koorchik/LIVR for rules descriptions.

TODO

  • Contracts in separate files (Roles)

AUTHOR

Viktor Turskyi, <koorchik at cpan.org>

BUGS

Please report any bugs or feature requests to Github https://github.com/koorchik/LIVR-Contract

SUPPORT

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

    perldoc LIVR::Contract

ACKNOWLEDGEMENTS

LICENSE AND COPYRIGHT

Copyright 2013 Viktor Turskyi.

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.