2 package MooseX::Storage::Engine;
7 # the class marker when
8 # serializing an object.
9 our $CLASS_MARKER = '__CLASS__';
23 has 'object' => (is => 'rw', isa => 'Object');
24 has 'class' => (is => 'rw', isa => 'Str');
26 ## this is the API used by other modules ...
32 # mark the root object as seen ...
33 $self->seen->{$self->object} = undef;
35 $self->map_attributes('collapse_attribute');
36 $self->storage->{$CLASS_MARKER} = $self->object->meta->identifier;
37 return $self->storage;
41 my ($self, $data) = @_;
44 # mark the root object as seen ...
45 $self->seen->{$data} = undef;
47 $self->map_attributes('expand_attribute', $data);
48 return $self->storage;
51 ## this is the internal API ...
53 sub collapse_attribute {
54 my ($self, $attr) = @_;
55 $self->storage->{$attr->name} = $self->collapse_attribute_value($attr) || return;
58 sub expand_attribute {
59 my ($self, $attr, $data) = @_;
60 $self->storage->{$attr->name} = $self->expand_attribute_value($attr, $data->{$attr->name}) || return;
63 sub collapse_attribute_value {
64 my ($self, $attr) = @_;
65 my $value = $attr->get_value($self->object);
68 # this might not be enough, we might
69 # need to make it possible for the
70 # cycle checker to return the value
71 $self->check_for_cycle_in_collapse($attr, $value)
74 if (defined $value && $attr->has_type_constraint) {
75 my $type_converter = $self->find_type_handler($attr->type_constraint);
76 (defined $type_converter)
77 || confess "Cannot convert " . $attr->type_constraint->name;
78 $value = $type_converter->{collapse}->($value);
83 sub expand_attribute_value {
84 my ($self, $attr, $value) = @_;
87 # (see comment in method above ^^)
88 $self->check_for_cycle_in_expansion($attr, $value)
91 if (defined $value && $attr->has_type_constraint) {
92 my $type_converter = $self->find_type_handler($attr->type_constraint);
93 $value = $type_converter->{expand}->($value);
99 # possibly these two methods will
100 # be used by a cycle supporting
101 # engine. However, I am not sure
102 # if I can make a cycle one work
105 sub check_for_cycle_in_collapse {
106 my ($self, $attr, $value) = @_;
107 (!exists $self->seen->{$value})
108 || confess "Basic Engine does not support cycles in class("
109 . ($attr->associated_class->name) . ").attr("
110 . ($attr->name) . ") with $value";
111 $self->seen->{$value} = undef;
114 sub check_for_cycle_in_expansion {
115 my ($self, $attr, $value) = @_;
116 (!exists $self->seen->{$value})
117 || confess "Basic Engine does not support cycles in class("
118 . ($attr->associated_class->name) . ").attr("
119 . ($attr->name) . ") with $value";
120 $self->seen->{$value} = undef;
126 my ($self, $method_name, @args) = @_;
128 $self->$method_name($_, @args)
130 # Skip our special skip attribute :)
131 !$_->isa('MooseX::Storage::Meta::Attribute::DoNotSerialize')
132 } ($self->object || $self->class)->meta->compute_all_applicable_attributes;
135 ## ------------------------------------------------------------------
136 ## This is all the type handler stuff, it is in a state of flux
137 ## right now, so this may change, or it may just continue to be
138 ## improved upon. Comments and suggestions are welcomed.
139 ## ------------------------------------------------------------------
142 # these are needed by the
143 # ArrayRef and HashRef handlers
144 # below, so I need easy access
145 my %OBJECT_HANDLERS = (
148 (exists $data->{$CLASS_MARKER})
149 || confess "Serialized item has no class marker";
150 # check the class more thoroughly here ...
151 my ($class, $version, $authority) = (split '-' => $data->{$CLASS_MARKER});
152 my $meta = eval { $class->meta };
153 confess "Class ($class) is not loaded, cannot unpack" if $@;
154 ($meta->version == $version)
155 || confess "Class ($class) versions don't match."
156 . " got=($version) available=(" . ($meta->version || '') . ")"
158 ($meta->authority eq $authority)
159 || confess "Class ($class) authorities don't match."
160 . " got=($authority) available=(" . ($meta->authority || '') . ")"
161 if defined $authority;
163 $class->unpack($data);
167 ($obj->can('does') && $obj->does('MooseX::Storage::Basic'))
168 || confess "Bad object ($obj) does not do MooseX::Storage::Basic role";
175 # These are boring ones, so they use the identity function ...
176 'Int' => { expand => sub { shift }, collapse => sub { shift } },
177 'Num' => { expand => sub { shift }, collapse => sub { shift } },
178 'Str' => { expand => sub { shift }, collapse => sub { shift } },
179 # These are the trickier ones, (see notes)
181 # Because we are nice guys, we will check
182 # your ArrayRef and/or HashRef one level
183 # down and inflate any objects we find.
184 # But this is where it ends, it is too
185 # expensive to try and do this any more
186 # recursively, when it is probably not
187 # nessecary in most of the use cases.
188 # However, if you need more then this, subtype
189 # and add a custom handler.
193 foreach my $i (0 .. $#{$array}) {
194 next unless ref($array->[$i]) eq 'HASH'
195 && exists $array->[$i]->{$CLASS_MARKER};
196 $array->[$i] = $OBJECT_HANDLERS{expand}->($array->[$i])
203 # we need to make a copy cause
204 # otherwise it will affect the
205 # other real version.
208 ? $OBJECT_HANDLERS{collapse}->($_)
216 foreach my $k (keys %$hash) {
217 next unless ref($hash->{$k}) eq 'HASH'
218 && exists $hash->{$k}->{$CLASS_MARKER};
219 $hash->{$k} = $OBJECT_HANDLERS{expand}->($hash->{$k})
226 # we need to make a copy cause
227 # otherwise it will affect the
228 # other real version.
231 ? ($_ => $OBJECT_HANDLERS{collapse}->($hash->{$_}))
232 : ($_ => $hash->{$_})
236 'Object' => \%OBJECT_HANDLERS,
238 # The sanity of enabling this feature by
239 # default is very questionable.
242 # expand => sub {}, # use eval ...
243 # collapse => sub {}, # use B::Deparse ...
247 sub add_custom_type_handler {
248 my ($class, $type_name, %handlers) = @_;
249 (exists $handlers{expand} && exists $handlers{collapse})
250 || confess "Custom type handlers need an expand *and* a collapse method";
251 $TYPES{$type_name} = \%handlers;
254 sub remove_custom_type_handler {
255 my ($class, $type_name) = @_;
256 delete $TYPES{$type_name} if exists $TYPES{$type_name};
259 sub find_type_handler {
260 my ($self, $type_constraint) = @_;
262 # this should handle most type usages
263 # since they they are usually just
264 # the standard set of built-ins
265 return $TYPES{$type_constraint->name}
266 if exists $TYPES{$type_constraint->name};
268 # the next possibility is they are
269 # a subtype of the built-in types,
270 # in which case this will DWIM in
271 # most cases. It is probably not
272 # 100% ideal though, but until I
273 # come up with a decent test case
274 # it will do for now.
275 foreach my $type (keys %TYPES) {
277 if $type_constraint->is_subtype_of($type);
281 # the reason the above will work has to
282 # do with the fact that custom subtypes
283 # are mostly used for validation of
284 # the guts of a type, and not for some
285 # weird structural thing which would
286 # need to be accomidated by the serializer.
287 # Of course, mst or phaylon will probably
288 # do something to throw this assumption
289 # totally out the door ;)
293 # if this method hasnt returned by now
294 # then we have no been able to find a
295 # type constraint handler to match
296 confess "Cannot handle type constraint (" . $type_constraint->name . ")";
307 MooseX::Storage::Engine - The meta-engine to handle collapsing and expanding objects
311 No user serviceable parts inside. If you really want to know, read the source :)
333 =item B<expand_object>
335 =item B<collapse_object>
343 =item B<collapse_attribute>
345 =item B<collapse_attribute_value>
347 =item B<expand_attribute>
349 =item B<expand_attribute_value>
351 =item B<check_for_cycle_in_collapse>
353 =item B<check_for_cycle_in_expansion>
355 =item B<map_attributes>
359 =head2 Type Constraint Handlers
363 =item B<find_type_handler>
365 =item B<add_custom_type_handler>
367 =item B<remove_custom_type_handler>
381 All complex software has bugs lurking in it, and this module is no
382 exception. If you find a bug please either email me, or add the bug
387 Chris Prather E<lt>chris.prather@iinteractive.comE<gt>
389 Stevan Little E<lt>stevan.little@iinteractive.comE<gt>
391 =head1 COPYRIGHT AND LICENSE
393 Copyright 2007 by Infinity Interactive, Inc.
395 L<http://www.iinteractive.com>
397 This library is free software; you can redistribute it and/or modify
398 it under the same terms as Perl itself.