memories 0.2.7 → 0.2.8

data/README.markdown

@@ -145,4 +145,7 @@ You can access old versions of your document via the "versions" method; it will
 
   @doc.versions[1] # ==> returns version 1 of your document
   @doc.versions['rev-1-kjfdsla3289430289432'] # ==> returns version 1 of your document
-  @doc.versions[1..20] # ==> returns versions 1 through 20 of your document
+  @doc.versions[5..20] # ==> returns versions 5 through 20 of your document
+  @doc.versions.count # ==> returns the number of versions of your document
+  @doc.versions.last # ==> returns the latest version of your document
+  @doc.versions.first # ==> returns the first version of your document

data/README.rdoc

@@ -147,3 +147,4 @@ You can access old versions of your document via the "versions" method; it will
     @doc.versions[1] # ==> returns version 1 of your document
     @doc.versions['rev-1-kjfdsla3289430289432'] # ==> returns version 1 of your document
     @doc.versions[1..20] # ==> returns versions 1 through 20 of your document
+    @doc.versions.count # ==> returns the number of versions of your document

data/lib/memories/base.rb

@@ -216,6 +216,13 @@ module Memories
     version_number rev
   end
 
+  # Provides array-like and hash-like access to the versions of your document.
+  #   @doc.versions[1] # ==> returns version 1 of your document
+  #   @doc.versions['rev-1-kjfdsla3289430289432'] # ==> returns version 1 of your document
+  #   @doc.versions[5..20] # ==> returns versions 5 through 20 of your document
+  #   @doc.versions.count # ==> returns the number of versions of your document
+  #   @doc.versions.last # ==> returns the latest version of your document
+  #   @doc.versions.first # ==> returns the first version of your document
   def versions
     @versions ||= VersionsProxy.new self
   end

data/lib/memories/versions_proxy.rb

@@ -1,14 +1,48 @@
 module Memories
   class VersionsProxy
+    # A Memories::VersionsProxy is automatically initialized, memoized, 
+    # and returned when you call the `versions` method on your document.
+    #   doc = Book.create :name => '2001'
+    #   doc.versions.class # ==> ::Memories::VersionsProxy
     def initialize(doc)
       @doc = doc
       @versions = {}
     end
-
+    
+    # Returns the number of versions of your document.
+    #   doc = Book.create :name => '2001'
+    #   doc.name => '2001: A Space Odyssey'
+    #   doc.save
+    #   doc.versions.count # ==> 2
     def count
       @doc.current_version
     end
 
+    # Returns the first version of your document
+    #   doc = Book.create :name => '2001'
+    #   doc.name => '2001: A Space Odyssey'
+    #   doc.save
+    #   doc.versions.first.name # ==> '2001'
+    def first
+      @doc.current_version == 1 ? @doc.dup : version_num(1)
+    end
+
+    # Returns the last version of your document (which should be the same as your document)    
+    #   doc = Book.create :name => '2001'
+    #   doc.name => '2001: A Space Odyssey'
+    #   doc.save
+    #   doc.versions.last.name # ==> '2001: A Space Odyssey'
+    def last
+      @doc.dup
+    end
+
+    # Provides array-like and hash-like access to the versions of your document.
+    #   @doc.versions[1] # ==> returns version 1 of your document
+    #   @doc.versions['rev-1-kjfdsla3289430289432'] # ==> returns version 1 of your document
+    #   @doc.versions[5..20] # ==> returns versions 5 through 20 of your document
+    #   @doc.versions.count # ==> returns the number of versions of your document
+    #   @doc.versions.last # ==> returns the latest version of your document
+    #   @doc.versions.first # ==> returns the first version of your document
     def [](arg)
       case arg.class.to_s
         when "Range" then version_range arg
@@ -30,7 +64,7 @@ module Memories
 
     def version_num(num)
       return nil if !num.kind_of?(Fixnum) or num >= @doc.current_version or num < 1
-      @versions[num] ||= @doc.revert_to(num).dup
+      @versions[num] ||= @doc.dup.revert_to(num)
     end
 
     def version_id(id)

metadata

@@ -1,13 +1,13 @@
 --- !ruby/object:Gem::Specification 
 name: memories
 version: !ruby/object:Gem::Version 
-  hash: 25
+  hash: 7
   prerelease: false
   segments: 
   - 0
   - 2
-  - 7
-  version: 0.2.7
+  - 8
+  version: 0.2.8
 platform: ruby
 authors: 
 - Matt Parker
@@ -16,7 +16,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2010-12-25 00:00:00 -05:00
+date: 2010-12-27 00:00:00 -05:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency