Deprecate DBIx::Class::Serialize::Storable (all functionality is in ResultSourceHandle)

[dbsrgits/DBIx-Class.git] / lib / DBIx / Class / Serialize / Storable.pm

diff --git a/lib/DBIx/Class/Serialize/Storable.pm b/lib/DBIx/Class/Serialize/Storable.pm
index c9f1314..bceb1b1 100644 (file)
--- a/lib/DBIx/Class/Serialize/Storable.pm
+++ b/lib/DBIx/Class/Serialize/Storable.pm
@@ -3,46 +3,82 @@ use strict;
 use warnings;
 use Storable;
 
+use Carp::Clan qw/^DBIx::Class/;
+
+carp 'The Serialize::Storable component is now *DEPRECATED*. It has not '
+    .'been providing any useful functionality for quite a while, and in fact '
+    .'destroys prefetched results in its current implementation. Do not use!';
+
+
 sub STORABLE_freeze {
-    my ($self,$cloning) = @_;
+    my ($self, $cloning) = @_;
     my $to_serialize = { %$self };
+
+    # The source is either derived from _source_handle or is
+    # reattached in the thaw handler below
     delete $to_serialize->{result_source};
-    return (Storable::freeze($to_serialize));
+
+    # Dynamic values, easy to recalculate
+    delete $to_serialize->{$_} for qw/related_resultsets _inflated_column/;
+
+    return (Storable::nfreeze($to_serialize));
 }
 
 sub STORABLE_thaw {
-    my ($self,$cloning,$serialized) = @_;
+    my ($self, $cloning, $serialized) = @_;
+
     %$self = %{ Storable::thaw($serialized) };
+
+    # if the handle went missing somehow, reattach
     $self->result_source($self->result_source_instance)
-      if $self->can('result_source_instance');
+      if !$self->_source_handle && $self->can('result_source_instance');
 }
 
 1;
 
 __END__
 
-=head1 NAME 
+=head1 NAME
+
+    DBIx::Class::Serialize::Storable - hooks for Storable nfreeze/thaw
 
-    DBIx::Class::Serialize::Storable - hooks for Storable freeze/thaw
-    (EXPERIMENTAL)
+=head1 DEPRECATION NOTE
+
+This component is now B<DEPRECATED>. It has not been providing any useful
+functionality for quite a while, and in fact destroys prefetched results
+in its current implementation. Do not use!
 
 =head1 SYNOPSIS
 
     # in a table class definition
     __PACKAGE__->load_components(qw/Serialize::Storable/);
-    
+
     # meanwhile, in a nearby piece of code
     my $cd = $schema->resultset('CD')->find(12);
-    $cache->set($cd->ID, $cd); # if the cache uses Storable, this
-                              # will work automatically
+    # if the cache uses Storable, this will work automatically
+    $cache->set($cd->ID, $cd);
 
 =head1 DESCRIPTION
 
 This component adds hooks for Storable so that row objects can be
 serialized. It assumes that your row object class (C<result_class>) is
-the same as your table class, which is the normal situation. However,
-this code is not yet well tested, and so should be considered
-experimental.
+the same as your table class, which is the normal situation.
+
+=head1 HOOKS
+
+The following hooks are defined for L<Storable> - see the
+documentation for L<Storable/Hooks> for detailed information on these
+hooks.
+
+=head2 STORABLE_freeze
+
+The serializing hook, called on the object during serialization. It
+can be inherited, or defined in the class itself, like any other
+method.
+
+=head2 STORABLE_thaw
+
+The deserializing hook called on the object during deserialization.
 
 =head1 AUTHORS