add comment about YAML::LibYAML

[gitmo/MooseX-Storage.git] / lib / MooseX / Storage / Format / YAML.pm

diff --git a/lib/MooseX/Storage/Format/YAML.pm b/lib/MooseX/Storage/Format/YAML.pm
index 08525e9..08bc3c4 100644 (file)
--- a/lib/MooseX/Storage/Format/YAML.pm
+++ b/lib/MooseX/Storage/Format/YAML.pm
@@ -2,22 +2,28 @@
 package MooseX::Storage::Format::YAML;
 use Moose::Role;
 
+# When I add YAML::LibYAML
+# Tests break because tye YAML is invalid...?
+# -dcp
+
 use Best [
     [ qw[YAML::Syck YAML] ], 
     [ qw[Load Dump] ]
 ];
 
+our $VERSION = '0.02';
+
 requires 'pack';
 requires 'unpack';
 
 sub thaw {
-    my ( $class, $json ) = @_;
-    $class->unpack( Load($json) );
+    my ( $class, $yaml, @args ) = @_;
+    $class->unpack( Load($yaml), @args );
 }
 
 sub freeze {
-    my $self = shift;
-    Dump( $self->pack() );
+    my ( $self, @args ) = @_;
+    Dump( $self->pack(@args) );
 }
 
 1;
@@ -32,7 +38,38 @@ MooseX::Storage::Format::YAML
 
 =head1 SYNOPSIS
 
-=head1 DESCRIPTION
+  package Point;
+  use Moose;
+  use MooseX::Storage;
+  
+  with Storage('format' => 'YAML');
+  
+  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 
+  ## a specified serialization format
+  ## (in this case YAML)
+  
+  # pack the class into a YAML string
+  $p->freeze(); 
+
+  # ----
+  # __CLASS__: "Point" 
+  # x: 10
+  # y: 10  
+  
+  # unpack the JSON string into a class
+  my $p2 = Point->thaw(<<YAML);  
+  ----
+  __CLASS__: "Point" 
+  x: 10
+  y: 10
+  YAML
 
 =head1 METHODS
 
@@ -40,7 +77,7 @@ MooseX::Storage::Format::YAML
 
 =item B<freeze>
 
-=item B<thaw ($json)>
+=item B<thaw ($yaml)>
 
 =back