1 package MooseX::Emulate::Class::Accessor::Fast;
5 our $VERSION = '0.00100';
9 MooseX::Emulate::Class::Accessor::Fast -
10 Emulate Class::Accessor::Fast behavior using Moose attributes
17 with 'MooseX::Emulate::Class::Accessor::Fast';
20 #fields with readers and writers
21 __PACKAGE__->mk_accessors(qw/field1 field2/);
22 #fields with readers only
23 __PACKAGE__->mk_accessors(qw/field3 field4/);
24 #fields with writers only
25 __PACKAGE__->mk_accessors(qw/field5 field6/);
30 This module attempts to emulate the behavior of L<Class::Accessor::Fast> as
31 accurately as possible using the Moose attribute system. The public API of
32 C<Class::Accessor::Fast> is wholly supported, but the private methods are not.
33 If you are only using the public methods (as you should) migration should be a
34 matter of switching your C<use base> line to a C<with> line.
36 While I have attempted to emulate the behavior of Class::Accessor::Fast as closely
37 as possible bugs may still be lurking in edge-cases.
41 Simple documentation is provided here for your convenience, but for more thorough
42 documentation please see L<Class::Accessor::Fast> and L<Class::Accessor>.
44 =head2 A note about introspection
46 Please note that, at this time, the C<is> flag attribute is not being set. To
47 determine the C<reader> and C<writer> methods using introspection in later versions
48 of L<Class::MOP> ( > 0.38) please use the C<get_read_method> and C<get_write_method>
49 methods in L<Class::MOP::Attribute>. Example
51 # with Class::MOP <= 0.38
52 my $attr = $self->meta->find_attribute_by_name($field_name);
53 my $reader_method = $attr->reader || $attr->accessor;
54 my $writer_method = $attr->writer || $attr->accessor;
56 # with Class::MOP > 0.38
57 my $attr = $self->meta->find_attribute_by_name($field_name);
58 my $reader_method = $attr->get_read_method;
59 my $writer_method = $attr->get_write_method;
63 =head2 mk_accessors @field_names
65 Create read-write accessors. An attribute named C<$field_name> will be created.
66 The name of the c<reader> and C<writer> methods will be determined by the return
67 value of C<accessor_name_for> and C<mutator_name_for>, which by default return the
68 name passed unchanged. If the accessor and mutator names are equal the C<accessor>
69 attribute will be passes to Moose, otherwise the C<reader> and C<writer> attributes
70 will be passed. Please see L<Class::MOP::Attribute> for more information.
76 my $meta = $self->meta;
77 for my $attr_name (@_){
78 my $reader = $self->accessor_name_for($attr_name);
79 my $writer = $self->mutator_name_for( $attr_name);
80 #dont overwrite existing methods
81 my @opts = $reader eq $writer ?
82 ( $self->can($reader) ? () : (accessor => $reader) ) :
84 ( $self->can($reader) ? () : (reader => $reader) ),
85 ( $self->can($writer) ? () : (writer => $writer) ),
87 $meta->add_attribute($attr_name, @opts);
89 $meta->add_method("_${attr_name}_accessor", $self->can($reader) )
90 if($reader eq $attr_name && !$self->can("_${attr_name}_accessor") );
94 =head2 mk_ro_accessors @field_names
96 Create read-only accessors.
102 my $meta = $self->meta;
103 for my $attr_name (@_){
104 my $reader = $self->accessor_name_for($attr_name);
105 $meta->add_attribute($attr_name,
106 $self->can($reader) ? () : (reader => $reader) );
107 $meta->add_method("_${attr_name}_accessor", $meta->find_method_by_name($reader))
108 if($reader eq $attr_name && !$self->can("_${attr_name}_accessor") );
112 =head2 mk_ro_accessors @field_names
114 Create write-only accessors.
118 #this is retarded.. but we need it for compatibility or whatever.
121 my $meta = $self->meta;
122 for my $attr_name (@_){
123 my $writer = $self->mutator_name_for($attr_name);
124 $meta->add_attribute($attr_name, $self->can($writer) ? () : (writer => $writer) );
125 $meta->add_method("_${attr_name}_accessor", $meta->find_method_by_name($writer))
126 if($writer eq $attr_name && !$self->can("_${attr_name}_accessor") );
130 =head2 follow_best_practices
132 Preface readers with 'get_' and writers with 'set_'.
133 See original L<Class::Accessor> documentation for more information.
137 sub follow_best_practice{
139 my $meta = $self->meta;
141 $meta->remove_method('mutator_name_for');
142 $meta->remove_method('accessor_name_for');
143 $meta->add_method('mutator_name_for', sub{ return "set_".$_[1] });
144 $meta->add_method('accessor_name_for', sub{ return "get_".$_[1] });
147 =head2 mutator_name_for
149 =head2 accessor_name_for
151 See original L<Class::Accessor> documentation for more information.
155 sub mutator_name_for{ return $_[1] }
156 sub accessor_name_for{ return $_[1] }
160 See original L<Class::Accessor> documentation for more information.
167 confess "Wrong number of arguments received" unless scalar @_;
169 #my $writer = $self->mutator_name_for( $k );
170 confess "No such attribute '$k'"
171 unless ( my $attr = $self->meta->find_attribute_by_name($k) );
172 my $writer = $attr->writer || $attr->accessor;
173 $self->$writer(@_ > 1 ? [@_] : @_);
178 See original L<Class::Accessor> documentation for more information.
184 confess "Wrong number of arguments received" unless scalar @_;
187 #while( my $attr = $self->meta->find_attribute_by_name( shift(@_) ){
189 confess "No such attribute '$_'"
190 unless ( my $attr = $self->meta->find_attribute_by_name($_) );
191 my $reader = $attr->reader || $attr->accessor;
192 @_ > 1 ? push(@values, $self->$reader) : return $self->$reader;
202 See L<Moose::Meta::Class>.
208 L<Moose>, L<Moose::Meta::Attribute>, L<Class::Accessor>, L<Class::Accessor::Fast>,
209 L<Class::MOP::Attribute>, L<MooseX::Adopt::Class::Accessor::Fast>
213 Guillermo Roditi (groditi) <groditi@cpan.org>
217 You may distribute this code under the same terms as Perl itself.