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