some thoughts and hacks on type handling,.. this probably needs some work
[gitmo/MooseX-Storage.git] / lib / MooseX / Storage / Engine.pm
index d496fd1..0eb6e2c 100644 (file)
@@ -41,11 +41,6 @@ sub expand_attribute {
 sub collapse_attribute_value {
     my ($self, $attr)  = @_;
        my $value = $attr->get_value($self->object);
-       # TODO:
-       # we want to explicitly disallow 
-       # cycles here, because the base
-       # storage engine does not support 
-       # them
     if (defined $value && $attr->has_type_constraint) {
         my $type_converter = $self->match_type($attr->type_constraint);
         (defined $type_converter)
@@ -57,10 +52,6 @@ sub collapse_attribute_value {
 
 sub expand_attribute_value {
     my ($self, $attr, $value)  = @_;
-    # TODO:
-    # we need to check $value here to 
-    # make sure that we do not have
-    # a cycle here.
     if (defined $value && $attr->has_type_constraint) {
         my $type_converter = $self->match_type($attr->type_constraint);
         $value = $type_converter->{expand}->($value);
@@ -77,48 +68,123 @@ sub map_attributes {
     } ($self->object || $self->class)->meta->compute_all_applicable_attributes;
 }
 
+## ------------------------------------------------------------------
+## Everything below here might need some re-thinking ...
+## ------------------------------------------------------------------
+
+# NOTE:
+# these are needed by the 
+# ArrayRef and HashRef handlers
+# below, so I need easy access 
+my %OBJECT_HANDLERS = (
+    expand => sub {
+        my $data = shift;   
+        (exists $data->{'__class__'})
+            || confess "Serialized item has no class marker";
+        $data->{'__class__'}->unpack($data);
+    },
+    collapse => sub {
+        my $obj = shift;
+        ($obj->can('does') && $obj->does('MooseX::Storage::Basic'))
+            || confess "Bad object ($obj) does not do MooseX::Storage::Basic role";
+        $obj->pack();
+    },
+);
+
+
 my %TYPES = (
     'Int'      => { expand => sub { shift }, collapse => sub { shift } },
     'Num'      => { expand => sub { shift }, collapse => sub { shift } },
     'Str'      => { expand => sub { shift }, collapse => sub { shift } },
-    'ArrayRef' => { expand => sub { shift }, collapse => sub { shift } },
-    'HashRef'  => { expand => sub { shift }, collapse => sub { shift } },
-    'Object'   => {
+    'ArrayRef' => { 
+        # FIXME:
+        # these should also probably be
+        # recursive as well, so they 
+        # can handle arbitrarily deep
+        # arrays and such. Or perhaps
+        # we force the user to handle 
+        # the types in a custom way. 
+        # This would require a more 
+        # sophisticated way of handling
+        # this %TYPES hash.
         expand => sub {
-            my $data = shift;   
-            (exists $data->{'__class__'})
-                || confess "Serialized item has no class marker";
-            $data->{'__class__'}->unpack($data);
-        },
-        collapse => sub {
-            my $obj = shift;
-            ($obj->can('does') && $obj->does('MooseX::Storage::Base'))
-                || confess "Bad object ($obj) does not do MooseX::Storage::Base role";
-            $obj->pack();
-        },
-    }       
+            my $array = shift;
+            foreach my $i (0 .. $#{$array}) {
+                next unless ref($array->[$i]) eq 'HASH' 
+                         && exists $array->[$i]->{'__class__'};
+                $array->[$i] = $OBJECT_HANDLERS{expand}->($array->[$i])
+            }
+            $array;
+        }, 
+        collapse => sub { 
+            my $array = shift;   
+            # NOTE:         
+            # we need to make a copy cause
+            # otherwise it will affect the 
+            # other real version.
+            [ map {
+                blessed($_)
+                    ? $OBJECT_HANDLERS{collapse}->($_)
+                    : $_
+            } @$array ] 
+        } 
+    },
+    'HashRef'  => { 
+        expand   => sub { shift }, 
+        collapse => sub { shift } 
+    },
+    'Object'   => \%OBJECT_HANDLERS,
+    # NOTE:
+    # The sanity of enabling this feature by 
+    # default is very questionable.
+    # - SL
+    #'CodeRef' => {
+    #    expand   => sub {}, # use eval ...
+    #    collapse => sub {}, # use B::Deparse ...        
+    #}       
 );
 
 sub match_type {
     my ($self, $type_constraint) = @_;
-    return $TYPES{$type_constraint->name} if exists $TYPES{$type_constraint->name};
+    
+    # this should handle most type usages
+    # since they they are usually just 
+    # the standard set of built-ins
+    return $TYPES{$type_constraint->name} 
+        if exists $TYPES{$type_constraint->name};
+      
+    # the next possibility is they are 
+    # a subtype of the built-in types, 
+    # in which case this will DWIM in 
+    # most cases. It is probably not 
+    # 100% ideal though, but until I 
+    # come up with a decent test case 
+    # it will do for now.
     foreach my $type (keys %TYPES) {
         return $TYPES{$type} 
             if $type_constraint->is_subtype_of($type);
     }
-    # TODO:
-    # from here we can expand this to support the following:
-    # - if it is subtype of Ref
-    # -- if it is a subtype of Object
-    # --- treat it like an object
-    # -- else 
-    # --- treat it like any other Ref
-    # - else
-    # -- if it is a subtype of Num or Str
-    # --- treat it like Num or Str
-    # -- else
-    # --- pass it on
-    # this should cover 80% of all use cases
+    
+    # NOTE:
+    # the reason the above will work has to 
+    # do with the fact that custom subtypes
+    # are mostly used for validation of 
+    # the guts of a type, and not for some
+    # weird structural thing which would 
+    # need to be accomidated by the serializer.
+    # Of course, mst or phaylon will probably  
+    # do something to throw this assumption 
+    # totally out the door ;)
+    # - SL
+    
+
+       # To cover the last possibilities we 
+       # need a way for people to extend this 
+       # process. Which they can do by subclassing
+       # this class and overriding the method 
+       # below to handle things.
+       my $match = $self->_custom_type_match($type_constraint);
+       return $match if defined $match;
 
     # NOTE:
     # if this method hasnt returned by now
@@ -127,12 +193,97 @@ sub match_type {
     confess "Cannot handle type constraint (" . $type_constraint->name . ")";    
 }
 
+sub _custom_type_match {
+    return;
+    # my ($self, $type_constraint) = @_;
+}
+
 1;
 
 __END__
 
 =pod
 
+=head1 NAME
+
+MooseX::Storage::Engine
+
+=head1 SYNOPSIS
+
+=head1 DESCRIPTION
+
+=head1 METHODS
+
+=head2 Accessors
+
+=over 4
+
+=item B<class>
+
+=item B<object>
+
+=item B<storage>
+
+=back
+
+=head2 API
+
+=over 4
+
+=item B<expand_object>
+
+=item B<collapse_object>
+
+=back
+
+=head2 ...
+
+=over 4
+
+=item B<collapse_attribute>
+
+=item B<collapse_attribute_value>
+
+=item B<expand_attribute>
+
+=item B<expand_attribute_value>
+
+=item B<map_attributes>
+
+=item B<match_type>
+
+=back
+
+=head2 Introspection
+
+=over 4
+
+=item B<meta>
+
+=back
+
+=head1 BUGS
+
+All complex software has bugs lurking in it, and this module is no 
+exception. If you find a bug please either email me, or add the bug
+to cpan-RT.
+
+=head1 AUTHOR
+
+Chris Prather E<lt>chris.prather@iinteractive.comE<gt>
+
+Stevan Little E<lt>stevan.little@iinteractive.comE<gt>
+
+=head1 COPYRIGHT AND LICENSE
+
+Copyright 2007 by Infinity Interactive, Inc.
+
+L<http://www.iinteractive.com>
+
+This library is free software; you can redistribute it and/or modify
+it under the same terms as Perl itself.
+
 =cut
 
 
+