lib/MooseX/AttributeHelpers.pm

   1
   2 package MooseX::AttributeHelpers;
   3
   4 our $VERSION   = '0.08';
   5 our $AUTHORITY = 'cpan:STEVAN';
   6
   7 use MooseX::AttributeHelpers::Meta::Method::Provided;
   8
   9 use MooseX::AttributeHelpers::Trait::Counter;
  10 use MooseX::AttributeHelpers::Trait::Number;
  11 use MooseX::AttributeHelpers::Trait::String;
  12 use MooseX::AttributeHelpers::Trait::Collection::List;
  13 use MooseX::AttributeHelpers::Trait::Collection::Array;
  14 use MooseX::AttributeHelpers::Trait::Collection::Hash;
  15 use MooseX::AttributeHelpers::Trait::Collection::ImmutableHash;
  16 use MooseX::AttributeHelpers::Trait::Collection::Bag;
  17
  18 use MooseX::AttributeHelpers::Counter;
  19 use MooseX::AttributeHelpers::Number;
  20 use MooseX::AttributeHelpers::String;
  21 use MooseX::AttributeHelpers::Collection::List;
  22 use MooseX::AttributeHelpers::Collection::Array;
  23 use MooseX::AttributeHelpers::Collection::Hash;
  24 use MooseX::AttributeHelpers::Collection::ImmutableHash;
  25 use MooseX::AttributeHelpers::Collection::Bag;
  26
  27 1;
  28
  29 __END__
  30
  31 =pod
  32
  33 =head1 NAME
  34
  35 MooseX::AttributeHelpers - Extend your attribute interfaces
  36
  37 =head1 SYNOPSIS
  38
  39   package MyClass;
  40   use Moose;
  41   use MooseX::AttributeHelpers;
  42
  43   has 'mapping' => (
  44       metaclass => 'Collection::Hash',
  45       is        => 'rw',
  46       isa       => 'HashRef[Str]',
  47       default   => sub { {} },
  48       provides  => {
  49           exists    => 'exists_in_mapping',
  50           keys      => 'ids_in_mapping',
  51           get       => 'get_mapping',
  52           set       => 'set_mapping',
  53       },
  54   );
  55
  56   # ...
  57
  58   my $obj = MyClass->new;
  59   $obj->set_mapping(4, 'foo');
  60   $obj->set_mapping(5, 'bar');
  61   $obj->set_mapping(6, 'baz');
  62
  63   # prints 'bar'
  64   print $obj->get_mapping(5) if $obj->exists_in_mapping(5);
  65
  66   # prints '4, 5, 6'
  67   print join ', ', $obj->ids_in_mapping;
  68
  69 =head1 DESCRIPTION
  70
  71 While L<Moose> attributes provide you with a way to name your accessors,
  72 readers, writers, clearers and predicates, this library provides commonly
  73 used attribute helper methods for more specific types of data.
  74
  75 As seen in the L</SYNOPSIS>, you specify the extension via the
  76 C<metaclass> parameter. Available meta classes are:
  77
  78 =over
  79
  80 =item L<Number|MooseX::AttributeHelpers::Number>
  81
  82 Common numerical operations.
  83
  84 =item L<Counter|MooseX::AttributeHelpers::Counter>
  85
  86 Methods for incrementing and decrementing a counter attribute.
  87
  88 =item L<Collection::Hash|MooseX::AttributeHelpers::Collection::Hash>
  89
  90 Common methods for hash references.
  91
  92 =item L<Collection::Array|MooseX::AttributeHelpers::Collection::Array>
  93
  94 Common methods for array references.
  95
  96 =item L<Collection::List|MooseX::AttributeHelpers::Collection::List>
  97
  98 Common list methods for array references.
  99
 100 =back
 101
 102 =head1 CAVEAT
 103
 104 This is an early release of this module. Right now it is in great need
 105 of documentation and tests in the test suite. However, we have used this
 106 module to great success at C<$work> where it has been tested very thoroughly
 107 and deployed into a major production site.
 108
 109 I plan on getting better docs and tests in the next few releases, but until
 110 then please refer to the few tests we do have and feel free email and/or
 111 message me on irc.perl.org if you have any questions.
 112
 113 =head1 TODO
 114
 115 We need tests and docs badly.
 116
 117 =head1 BUGS
 118
 119 All complex software has bugs lurking in it, and this module is no
 120 exception. If you find a bug please either email me, or add the bug
 121 to cpan-RT.
 122
 123 =head1 AUTHOR
 124
 125 Stevan Little E<lt>stevan@iinteractive.comE<gt>
 126
 127 B<with contributions from:>
 128
 129 Robert (rlb3) Boone
 130
 131 Chris (perigrin) Prather
 132
 133 Robert (phaylon) Sedlacek
 134
 135 Tom (dec) Lanyon
 136
 137 Yuval Kogman
 138
 139 =head1 COPYRIGHT AND LICENSE
 140
 141 Copyright 2007, 2008 by Infinity Interactive, Inc.
 142
 143 L<http://www.iinteractive.com>
 144
 145 This library is free software; you can redistribute it and/or modify
 146 it under the same terms as Perl itself.
 147
 148 =cut