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