more tweaks for 0.01
[gitmo/MooseX-Storage.git] / lib / MooseX / Storage / Format / YAML.pm
1
2 package MooseX::Storage::Format::YAML;
3 use Moose::Role;
4
5 use Best [
6     [ qw[YAML::Syck YAML] ], 
7     [ qw[Load Dump] ]
8 ];
9
10 our $VERSION = '0.01';
11
12 requires 'pack';
13 requires 'unpack';
14
15 sub thaw {
16     my ( $class, $json ) = @_;
17     $class->unpack( Load($json) );
18 }
19
20 sub freeze {
21     my $self = shift;
22     Dump( $self->pack() );
23 }
24
25 1;
26
27 __END__
28
29 =pod
30
31 =head1 NAME
32
33 MooseX::Storage::Format::YAML
34
35 =head1 SYNOPSIS
36
37   package Point;
38   use Moose;
39   use MooseX::Storage;
40   
41   with Storage('format' => 'YAML');
42   
43   has 'x' => (is => 'rw', isa => 'Int');
44   has 'y' => (is => 'rw', isa => 'Int');
45   
46   1;
47   
48   my $p = Point->new(x => 10, y => 10);
49   
50   ## methods to freeze/thaw into 
51   ## a specified serialization format
52   ## (in this case YAML)
53   
54   # pack the class into a YAML string
55   $p->freeze(); 
56
57   # ----
58   # __CLASS__: "Point" 
59   # x: 10
60   # y: 10  
61   
62   # unpack the JSON string into a class
63   my $p2 = Point->thaw(<<YAML);  
64   ----
65   __CLASS__: "Point" 
66   x: 10
67   y: 10
68   YAML
69
70 =head1 METHODS
71
72 =over 4
73
74 =item B<freeze>
75
76 =item B<thaw ($yaml)>
77
78 =back
79
80 =head2 Introspection
81
82 =over 4
83
84 =item B<meta>
85
86 =back
87
88 =head1 BUGS
89
90 All complex software has bugs lurking in it, and this module is no 
91 exception. If you find a bug please either email me, or add the bug
92 to cpan-RT.
93
94 =head1 AUTHOR
95
96 Chris Prather E<lt>chris.prather@iinteractive.comE<gt>
97
98 Stevan Little E<lt>stevan.little@iinteractive.comE<gt>
99
100 =head1 COPYRIGHT AND LICENSE
101
102 Copyright 2007 by Infinity Interactive, Inc.
103
104 L<http://www.iinteractive.com>
105
106 This library is free software; you can redistribute it and/or modify
107 it under the same terms as Perl itself.
108
109 =cut
110
111