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