sub thaw {
my ( $class, $packed, $type, @args ) = @_;
-
- (exists $type->{format})
+
+ (exists $type->{format})
|| confess "You must specify a format type to thaw from";
my $class_to_load = 'MooseX::Storage::Format::' . $type->{format};
Class::MOP::load_class($class_to_load);
-
+
my $method_to_call = $class_to_load . '::thaw';
-
+
$class->$method_to_call($packed, @args);
}
sub freeze {
my ( $self, $type, @args ) = @_;
-
- (exists $type->{format})
- || confess "You must specify a format type to freeze into";
-
+
+ (exists $type->{format})
+ || confess "You must specify a format type to freeze into";
+
my $class_to_load = 'MooseX::Storage::Format::' . $type->{format};
Class::MOP::load_class($class_to_load);
my $method_to_call = $class_to_load . '::freeze';
-
- $self->$method_to_call(@args);
+
+ $self->$method_to_call(@args);
+}
+
+sub load {
+ my ( $class, $filename, $type, @args ) = @_;
+
+ (exists $type->{io})
+ || confess "You must specify an I/O type to load with";
+
+ my $class_to_load = 'MooseX::Storage::IO::' . $type->{io};
+ Class::MOP::load_class($class_to_load);
+
+ my $method_to_call = $class_to_load . '::load';
+
+ $class->$method_to_call($filename, $type, @args);
+}
+
+sub store {
+ my ( $self, $filename, $type, @args ) = @_;
+
+ (exists $type->{io})
+ || confess "You must specify an I/O type to store with";
+
+ my $class_to_load = 'MooseX::Storage::IO::' . $type->{io};
+ Class::MOP::load_class($class_to_load);
+
+ my $method_to_call = $class_to_load . '::store';
+
+ $self->$method_to_call($filename, $type, @args);
}
1;
package Point;
use Moose;
use MooseX::Storage;
-
+
our $VERSION = '0.01';
-
+
with 'MooseX::Storage::Deferred';
-
+
has 'x' => (is => 'rw', isa => 'Int');
has 'y' => (is => 'rw', isa => 'Int');
-
+
1;
-
+
my $p = Point->new(x => 10, y => 10);
-
- ## methods to freeze/thaw into
+
+ ## methods to freeze/thaw into
## a specified serialization format
## (in this case JSON)
-
+
# pack the class into a JSON string
$p->freeze({ format => 'JSON' }); # { "__CLASS__" : "Point", "x" : 10, "y" : 10 }
-
+
# unpack the JSON string into a class
my $p2 = Point->thaw(
'{ "__CLASS__" : "Point", "x" : 10, "y" : 10 }',
{ format => 'JSON' }
- );
+ );
=head1 DESCRIPTION
-This role is designed for those times when you need to
-serialize into many different formats or I/O options.
-It basically allows you to choose the format and IO
-options only when you actually use them (see the
+This role is designed for those times when you need to
+serialize into many different formats or I/O options.
+
+It basically allows you to choose the format and IO
+options only when you actually use them (see the
SYNOPSIS for more info)
+=head1 SUPPORTED FORMATS
+
+=over 4
+
+=item I<JSON>
+
+=item I<YAML>
+
+=item I<Storable>
+
+=back
+
+=head1 SUPPORTED I/O
+
+=over 4
+
+=item I<File>
+
+=item I<AtomicFile>
+
+=back
+
+B<NOTE:> The B<StorableFile> I/O option is not supported,
+this is because it does not mix well with options who also
+have a C<thaw> and C<freeze> methods like this. It is possible
+to probably work around this issue, but I don't currently
+have the need for it. If you need this supported, talk to me
+and I will see what I can do.
+
=head1 METHODS
=over 4
=item B<thaw ($data, $type_desc)>
+=item B<load ($filename, $type_desc)>
+
+=item B<store ($filename, $type_desc)>
+
=back
=head2 Introspection
=head1 BUGS
-All complex software has bugs lurking in it, and this module is no
+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.
with 'MooseX::Storage::IO::File';
sub store {
- my ( $self, $filename ) = @_;
- MooseX::Storage::Engine::IO::AtomicFile->new( file => $filename )->store( $self->freeze() );
+ my ( $self, $filename, @args ) = @_;
+ MooseX::Storage::Engine::IO::AtomicFile->new( file => $filename )->store( $self->freeze(@args) );
}
1;
requires 'freeze';
sub load {
- my ( $class, $filename ) = @_;
- $class->thaw( MooseX::Storage::Engine::IO::File->new( file => $filename )->load() );
+ my ( $class, $filename, @args ) = @_;
+ $class->thaw( MooseX::Storage::Engine::IO::File->new( file => $filename )->load(), @args );
}
sub store {
- my ( $self, $filename ) = @_;
- MooseX::Storage::Engine::IO::File->new( file => $filename )->store( $self->freeze() );
+ my ( $self, $filename, @args ) = @_;
+ MooseX::Storage::Engine::IO::File->new( file => $filename )->store( $self->freeze(@args) );
}
1;
requires 'unpack';
sub load {
- my ( $class, $filename ) = @_;
+ my ( $class, $filename, @args ) = @_;
# try thawing
- return $class->thaw( Storable::retrieve($filename) )
+ return $class->thaw( Storable::retrieve($filename), @args )
if $class->can('thaw');
# otherwise just unpack
- $class->unpack( Storable::retrieve($filename) );
+ $class->unpack( Storable::retrieve($filename), @args );
}
sub store {
- my ( $self, $filename ) = @_;
+ my ( $self, $filename, @args ) = @_;
Storable::nstore(
# try freezing, otherwise just pack
- ($self->can('freeze') ? $self->freeze() : $self->pack()),
+ ($self->can('freeze') ? $self->freeze(@args) : $self->pack(@args)),
$filename
);
}
--- /dev/null
+#!/usr/bin/perl
+
+use strict;
+use warnings;
+
+use Test::More tests => 21;
+
+BEGIN {
+ use_ok('MooseX::Storage');
+}
+
+{
+ package Foo;
+ use Moose;
+ use MooseX::Storage;
+
+ with 'MooseX::Storage::Deferred';
+
+ has 'number' => (is => 'ro', isa => 'Int');
+ has 'string' => (is => 'ro', isa => 'Str');
+ has 'float' => (is => 'ro', isa => 'Num');
+ has 'array' => (is => 'ro', isa => 'ArrayRef');
+ has 'hash' => (is => 'ro', isa => 'HashRef');
+ has 'object' => (is => 'ro', isa => 'Object');
+}
+
+my $file = 'temp.json';
+
+{
+ my $foo = Foo->new(
+ number => 10,
+ string => 'foo',
+ float => 10.5,
+ array => [ 1 .. 10 ],
+ hash => { map { $_ => undef } (1 .. 10) },
+ object => Foo->new( number => 2 ),
+ );
+ isa_ok($foo, 'Foo');
+
+ $foo->store($file, { format => 'JSON', io => 'File' });
+}
+
+{
+ my $foo = Foo->load($file, { format => 'JSON', io => 'File' });
+ isa_ok($foo, 'Foo');
+
+ is($foo->number, 10, '... got the right number');
+ is($foo->string, 'foo', '... got the right string');
+ is($foo->float, 10.5, '... got the right float');
+ is_deeply($foo->array, [ 1 .. 10], '... got the right array');
+ is_deeply($foo->hash, { map { $_ => undef } (1 .. 10) }, '... got the right hash');
+
+ isa_ok($foo->object, 'Foo');
+ is($foo->object->number, 2, '... got the right number (in the embedded object)');
+}
+
+unlink $file;
+ok(!(-e $file), '... the file has been deleted');
+
+{
+ my $foo = Foo->new(
+ number => 10,
+ string => 'foo',
+ float => 10.5,
+ array => [ 1 .. 10 ],
+ hash => { map { $_ => undef } (1 .. 10) },
+ object => Foo->new( number => 2 ),
+ );
+ isa_ok($foo, 'Foo');
+
+ $foo->store($file, { format => 'JSON', io => 'AtomicFile' });
+}
+
+{
+ my $foo = Foo->load($file, { format => 'JSON', io => 'AtomicFile' });
+ isa_ok($foo, 'Foo');
+
+ is($foo->number, 10, '... got the right number');
+ is($foo->string, 'foo', '... got the right string');
+ is($foo->float, 10.5, '... got the right float');
+ is_deeply($foo->array, [ 1 .. 10], '... got the right array');
+ is_deeply($foo->hash, { map { $_ => undef } (1 .. 10) }, '... got the right hash');
+
+ isa_ok($foo->object, 'Foo');
+ is($foo->object->number, 2, '... got the right number (in the embedded object)');
+}
+
+unlink $file;
+ok(!(-e $file), '... the file has been deleted');
+
projects / gitmo/MooseX-Storage.git / commitdiff