memories 0.2.8 → 0.2.10

data/lib/memories/base.rb

@@ -11,7 +11,7 @@ module Memories
     base.send :extend, ClassMethods
   end
   
-  module ClassMethods
+  module ClassMethods #:nodoc: all
     # If you'd like to exclude certain properties from versioning, simply pass those properties
     # to this method: 
     #   
@@ -25,7 +25,7 @@ module Memories
     #     property :prop2 #not versioned
     #     property :prop3 #versioned
     #   end
-    def forget(*props)
+    def forget(*props) #:doc:
       raise StandardError, "Ambiguous use of both #remember and #forget." if @remember_called
       @forget_called = true
       self.forget_properties += props.map {|p| p.to_s}
@@ -45,7 +45,7 @@ module Memories
     #     property :prop2 #versioned
     #     property :prop3 # not versioned
     #   end
-    def remember(*props)
+    def remember(*props) #:doc:
       raise StandardError, "Ambiguous use of both #remember and #forget." if @forget_called
       @remember_called = true
       props = props.map {|p| p.to_s}
@@ -57,7 +57,7 @@ module Memories
     end 
 
     # Returns true if self is set up to remember attachments. False otherwise.
-    def remember_attachments?
+    def remember_attachments? #:doc:
       @remember_attachments ? true : false
     end
 
@@ -88,7 +88,7 @@ module Memories
     #     remember_attachments! "image.png", %r{stylesheets/.*}
     #   end
     #
-    def remember_attachments!(*attachment_names)
+    def remember_attachments!(*attachment_names) #:doc:
       if attachment_names.empty?
         @remember_attachments = [/.*/]
       else 
@@ -96,24 +96,24 @@ module Memories
       end
     end
 
-    def remember_properties #:nodoc
+    def remember_properties
       @remember_properties ||= nil
     end
 
-    def remember_properties=(props) #:nodoc
+    def remember_properties=(props)
       @remember_properties = props
     end
 
-    def forget_properties #:nodoc:
+    def forget_properties
       @forget_properties ||= ["couchrest-type", "_id", "_rev", "_attachments", "milestone_memories"]
     end
 
-    def forget_properties=(props) #:nodoc:
+    def forget_properties=(props)
       @forget_properties = props
     end
   end
-  
-  VERSION_REGEX = /(?:rev-)?(\d+)-[a-zA-Z0-9]+/
+   
+  VERSION_REGEX = /(?:rev-)?(\d+)-[a-zA-Z0-9]+/ #:nodoc:
   
   # Returns a list of attachments it should remember.
   def attachments_to_remember
@@ -261,10 +261,14 @@ module Memories
 
   def revert(version, revert_type = :soft)
     raise StandardError, "Unknown revert type passed to 'revert' method. Allowed types: :soft, :hard." if revert_type != :soft && revert_type != :hard
-    
+   
     if (match = version.to_s.match(VERSION_REGEX)) && match[1]
       version = match[1].to_i  
     end
+
+    raise StandardError, "Unknown version" unless version.kind_of?(Fixnum)
+    raise StandardError, "The requested version does not exist" if version < 1 or version > current_version
+    return self if version == current_version
     
     if properties = JSON.parse(self.read_attachment(version_id version))
       revert_attachments properties

data/lib/memories/versions_proxy.rb

@@ -11,7 +11,7 @@ module Memories
     
     # Returns the number of versions of your document.
     #   doc = Book.create :name => '2001'
-    #   doc.name => '2001: A Space Odyssey'
+    #   doc.name = '2001: A Space Odyssey'
     #   doc.save
     #   doc.versions.count # ==> 2
     def count
@@ -20,7 +20,7 @@ module Memories
 
     # Returns the first version of your document
     #   doc = Book.create :name => '2001'
-    #   doc.name => '2001: A Space Odyssey'
+    #   doc.name = '2001: A Space Odyssey'
     #   doc.save
     #   doc.versions.first.name # ==> '2001'
     def first
@@ -29,7 +29,7 @@ module Memories
 
     # 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.name = '2001: A Space Odyssey'
     #   doc.save
     #   doc.versions.last.name # ==> '2001: A Space Odyssey'
     def last
@@ -54,19 +54,21 @@ module Memories
 
     private
     def version_range(range)
-      return [] if range.first > @doc.current_version
-      current_version = range.last >= @doc.current_version ? @doc.dup : nil
-      last = range.last >= @doc.current_version ? @doc.current_version - 1 : range.last
-      versions = (range.first..last).to_a.map {|i| version_num i}
-      versions << current_version if current_version 
-      versions
+      sanitize_range(range).to_a.map {|i| version_num i}
     end
 
     def version_num(num)
-      return nil if !num.kind_of?(Fixnum) or num >= @doc.current_version or num < 1
+      return nil if !num.kind_of?(Fixnum) or num > @doc.current_version or num < 1
       @versions[num] ||= @doc.dup.revert_to(num)
     end
 
+    def sanitize_range(range)
+      return [] if range.first > @doc.current_version
+      first = range.first < 1 ? 1 : range.first
+      last = range.last > @doc.current_version ? @doc.current_version : range.last
+      (first..last)
+    end
+
     def version_id(id)
       version_num @doc.version_number(id)
     end

metadata

@@ -1,13 +1,13 @@
 --- !ruby/object:Gem::Specification 
 name: memories
 version: !ruby/object:Gem::Version 
-  hash: 7
+  hash: 3
   prerelease: false
   segments: 
   - 0
   - 2
-  - 8
-  version: 0.2.8
+  - 10
+  version: 0.2.10
 platform: ruby
 authors: 
 - Matt Parker