1 package MooseX::Emulate::Class::Accessor::Fast;
7 our $VERSION = '0.00701';
11 MooseX::Emulate::Class::Accessor::Fast -
12 Emulate Class::Accessor::Fast behavior using Moose attributes
19 with 'MooseX::Emulate::Class::Accessor::Fast';
22 #fields with readers and writers
23 __PACKAGE__->mk_accessors(qw/field1 field2/);
24 #fields with readers only
25 __PACKAGE__->mk_accessors(qw/field3 field4/);
26 #fields with writers only
27 __PACKAGE__->mk_accessors(qw/field5 field6/);
32 This module attempts to emulate the behavior of L<Class::Accessor::Fast> as
33 accurately as possible using the Moose attribute system. The public API of
34 C<Class::Accessor::Fast> is wholly supported, but the private methods are not.
35 If you are only using the public methods (as you should) migration should be a
36 matter of switching your C<use base> line to a C<with> line.
38 While I have attempted to emulate the behavior of Class::Accessor::Fast as closely
39 as possible bugs may still be lurking in edge-cases.
43 Simple documentation is provided here for your convenience, but for more thorough
44 documentation please see L<Class::Accessor::Fast> and L<Class::Accessor>.
46 =head2 A note about introspection
48 Please note that, at this time, the C<is> flag attribute is not being set. To
49 determine the C<reader> and C<writer> methods using introspection in later versions
50 of L<Class::MOP> ( > 0.38) please use the C<get_read_method> and C<get_write_method>
51 methods in L<Class::MOP::Attribute>. Example
53 # with Class::MOP <= 0.38
54 my $attr = $self->meta->find_attribute_by_name($field_name);
55 my $reader_method = $attr->reader || $attr->accessor;
56 my $writer_method = $attr->writer || $attr->accessor;
58 # with Class::MOP > 0.38
59 my $attr = $self->meta->find_attribute_by_name($field_name);
60 my $reader_method = $attr->get_read_method;
61 my $writer_method = $attr->get_write_method;
65 =head2 BUILD $self %args
67 Change the default Moose class building to emulate the behavior of C::A::F and
68 store arguments in the instance hashref.
72 my $locate_metaclass = sub {
73 my $class = Scalar::Util::blessed($_[0]) || $_[0];
74 return Class::MOP::get_metaclass_by_name($class)
75 || Moose::Meta::Class->initialize($class);
81 if (scalar @_ == 1 && defined $_[0] && ref($_[0]) eq 'HASH') {
83 } elsif( scalar(@_) ) {
86 my @extra = grep { !exists($self->{$_}) } keys %args;
87 @{$self}{@extra} = @args{@extra};
91 =head2 mk_accessors @field_names
93 Create read-write accessors. An attribute named C<$field_name> will be created.
94 The name of the c<reader> and C<writer> methods will be determined by the return
95 value of C<accessor_name_for> and C<mutator_name_for>, which by default return the
96 name passed unchanged. If the accessor and mutator names are equal the C<accessor>
97 attribute will be passes to Moose, otherwise the C<reader> and C<writer> attributes
98 will be passed. Please see L<Class::MOP::Attribute> for more information.
104 my $meta = $locate_metaclass->($self);
105 my $class = $meta->name;
106 confess("You are trying to modify ${class}, which has been made immutable, this is ".
107 "not supported. Try subclassing ${class}, rather than monkeypatching it")
108 if $meta->is_immutable;
110 for my $attr_name (@_){
111 $meta->remove_attribute($attr_name)
112 if $meta->find_attribute_by_name($attr_name);
113 my $reader = $self->accessor_name_for($attr_name);
114 my $writer = $self->mutator_name_for( $attr_name);
116 #dont overwrite existing methods
117 if($reader eq $writer){
118 my %opts = ( $meta->has_method($reader) ? () : (accessor => $reader) );
119 my $attr = $meta->add_attribute($attr_name, %opts);
120 if($attr_name eq $reader){
121 my $alias = "_${attr_name}_accessor";
122 next if $meta->has_method($alias);
123 my @alias_method = $attr->process_accessors(accessor => $alias, 0);
124 $meta->add_method(@alias_method);
127 my @opts = ( $meta->has_method($writer) ? () : (writer => $writer) );
128 push(@opts, (reader => $reader)) unless $meta->has_method($reader);
129 $meta->add_attribute($attr_name, @opts);
134 =head2 mk_ro_accessors @field_names
136 Create read-only accessors.
142 my $meta = $locate_metaclass->($self);
143 my $class = $meta->name;
144 confess("You are trying to modify ${class}, which has been made immutable, this is ".
145 "not supported. Try subclassing ${class}, rather than monkeypatching it")
146 if $meta->is_immutable;
147 for my $attr_name (@_){
148 $meta->remove_attribute($attr_name)
149 if $meta->find_attribute_by_name($attr_name);
150 my $reader = $self->accessor_name_for($attr_name);
151 my @opts = ($meta->has_method($reader) ? () : (reader => $reader) );
152 my $attr = $meta->add_attribute($attr_name, @opts);
153 if($reader eq $attr_name && $reader eq $self->mutator_name_for($attr_name)){
154 $meta->add_method("_${attr_name}_accessor" => $attr->get_read_method_ref)
155 unless $meta->has_method("_${attr_name}_accessor");
160 =head2 mk_ro_accessors @field_names
162 Create write-only accessors.
166 #this is retarded.. but we need it for compatibility or whatever.
169 my $meta = $locate_metaclass->($self);
170 my $class = $meta->name;
171 confess("You are trying to modify ${class}, which has been made immutable, this is ".
172 "not supported. Try subclassing ${class}, rather than monkeypatching it")
173 if $meta->is_immutable;
174 for my $attr_name (@_){
175 $meta->remove_attribute($attr_name)
176 if $meta->find_attribute_by_name($attr_name);
177 my $writer = $self->mutator_name_for($attr_name);
178 my @opts = ($meta->has_method($writer) ? () : (writer => $writer) );
179 my $attr = $meta->add_attribute($attr_name, @opts);
180 if($writer eq $attr_name && $writer eq $self->accessor_name_for($attr_name)){
181 $meta->add_method("_${attr_name}_accessor" => $attr->get_write_method_ref)
182 unless $meta->has_method("_${attr_name}_accessor");
187 =head2 follow_best_practices
189 Preface readers with 'get_' and writers with 'set_'.
190 See original L<Class::Accessor> documentation for more information.
194 sub follow_best_practice{
196 my $meta = $locate_metaclass->($self);
198 $meta->remove_method('mutator_name_for');
199 $meta->remove_method('accessor_name_for');
200 $meta->add_method('mutator_name_for', sub{ return "set_".$_[1] });
201 $meta->add_method('accessor_name_for', sub{ return "get_".$_[1] });
204 =head2 mutator_name_for
206 =head2 accessor_name_for
208 See original L<Class::Accessor> documentation for more information.
212 sub mutator_name_for{ return $_[1] }
213 sub accessor_name_for{ return $_[1] }
217 See original L<Class::Accessor> documentation for more information.
224 confess "Wrong number of arguments received" unless scalar @_;
225 my $meta = $locate_metaclass->($self);
227 confess "No such attribute '$k'"
228 unless ( my $attr = $meta->find_attribute_by_name($k) );
229 my $writer = $attr->get_write_method;
230 $self->$writer(@_ > 1 ? [@_] : @_);
235 See original L<Class::Accessor> documentation for more information.
241 confess "Wrong number of arguments received" unless scalar @_;
242 my $meta = $locate_metaclass->($self);
246 confess "No such attribute '$_'"
247 unless ( my $attr = $meta->find_attribute_by_name($_) );
248 my $reader = $attr->get_read_method;
249 @_ > 1 ? push(@values, $self->$reader) : return $self->$reader;
256 my($class, $field) = @_;
257 my $meta = $locate_metaclass->($class);
258 my $attr = $meta->find_attribute_by_name($field) || $meta->add_attribute($field);
259 my $reader = $attr->get_read_method_ref;
260 my $writer = $attr->get_write_method_ref;
263 return $reader->($self) unless @_;
264 return $writer->($self,(@_ > 1 ? [@_] : @_));
269 sub make_ro_accessor {
270 my($class, $field) = @_;
271 my $meta = $locate_metaclass->($class);
272 my $attr = $meta->find_attribute_by_name($field) || $meta->add_attribute($field);
273 return $attr->get_read_method_ref;
277 sub make_wo_accessor {
278 my($class, $field) = @_;
279 my $meta = $locate_metaclass->($class);
280 my $attr = $meta->find_attribute_by_name($field) || $meta->add_attribute($field);
281 return $attr->get_write_method_ref;
288 See L<Moose::Meta::Class>.
294 L<Moose>, L<Moose::Meta::Attribute>, L<Class::Accessor>, L<Class::Accessor::Fast>,
295 L<Class::MOP::Attribute>, L<MooseX::Adopt::Class::Accessor::Fast>
299 Guillermo Roditi (groditi) E<lt>groditi@cpan.orgE<gt>
301 With contributions from:
305 =item Tomas Doran E<lt>bobtfish@bobtfish.netE<gt>
311 You may distribute this code under the same terms as Perl itself.