memories 0.2.10 → 0.2.11

data/README.markdown

@@ -9,7 +9,7 @@ stored as an attachment on the document. This versioning strategy was originally
 
 ## Documentation
 
-Browse the documentation on rdoc.info: http://rdoc.info/github/moonmaster9000/memories
+Browse the documentation on rubydoc.info: http://rubydoc.info/gems/memories/frames
 
 ##How does it work?
 
@@ -102,12 +102,13 @@ they published as a milestone.
     end
 
 Notice that we annotated our milestone; we gave it a name, and some notes. You can annotate with whatever properties you desire. The annotation do block is entirely optional.
-Now that we've created a milestone, let's inspect it: 
+Now that we've created a milestone, let's inspect it via the `milestones` array: 
 
     a.milestones.count #==> 1
-    a.latest_milestone.version # ==> 1
-    a.latest_milestone.annotations.name ==> "First publish."
-    a.latest_milestone.annotations.notes ==> "Passed all relevant editing. Signed off by moonmaster 10000"
+    a.milestones.last.version # ==> 1
+    a.milestones.last.version # ==> 1
+    a.milestones.last.annotations.name ==> "First publish."
+    a.milestones.last.annotations.notes ==> "Passed all relevant editing. Signed off by moonmaster 10000"
 
 Now, let's imagine that we've made some more edits / saves to the document, but they don't get approved. Now we want to revert to the version the document was
 at at the first milestone. How do we do that? Simple!
@@ -116,6 +117,14 @@ at at the first milestone. How do we do that? Simple!
 
 And now our document properties are back to the where they were when we first published the document.
 
+If you want to access the data from a milestone, simply use the "data" method: 
+    
+    a.milestones.first.data.title #==> returns the "title" attribute on the first milestone
+    a.milestones.each do |m|
+      puts "Version: " + m.version
+      puts "Title: " + m.data.title
+    end
+
 ## Attachments
 
 By default, memories doesn't version attachments. If you'd like to version attachments, simply call the `remember_attachments!` class method in your 

data/README.rdoc

@@ -9,7 +9,7 @@ stored as an attachment on the document. This versioning strategy was originally
 
 == Documentation
 
-Browse the documentation on rdoc.info: http://rdoc.info/github/moonmaster9000/memories
+Browse the documentation on rubydoc.info: http://rubydoc.info/gems/memories/frames
 
 == How does it work?
 
@@ -116,6 +116,14 @@ at at the first milestone. How do we do that? Simple!
 
 And now our document properties are back to the where they were when we first published the document.
 
+If you want to access the data from a milestone, simply use the "data" method: 
+    
+    a.milestones.first.data.title #==> returns the "title" attribute on the first milestone
+    a.milestones.each do |m|
+      puts "Version: " + m.version
+      puts "Title: " + m.data.title
+    end
+
 == Attachments
 
 By default, memories doesn't version attachments. If you'd like to version attachments, simply call the `remember\_attachments!` class method in your 

data/lib/memories.rb

@@ -3,4 +3,5 @@ require 'couchrest_model'
 require 'memories/annotation'
 require 'memories/versions_proxy'
 require 'memories/attachment'
+require 'memories/milestones_proxy'
 require 'memories/base'

data/lib/memories/base.rb

@@ -241,11 +241,63 @@ module Memories
     self.save
   end
 
-  # returns an array of all milestones. Each milestone contains a "version" property (pointing to a specific revision)
-  # and an "annotations" property, containing a (possibly empty) hash of key/value pairs corresponding to any annotations
-  # the creator of the milestone decided to write.
+  #As of version 0.2.0, Memories also supports milestones. Milestones are special versions that you want to flag in some way.
+  #For example, suppose you were creating a content management system, and every time someone publishes an article to the website, you want to flag the version
+  #they published as a milestone. 
+  #
+  #    class Article < CouchRest::Model::Base
+  #      include Memories
+  #      use_database SOME_DATABASE
+  #      
+  #      property :title
+  #      property :author
+  #      property :body
+  #
+  #      def publish!
+  #        # .... publishing logic
+  #      end
+  #    end
+  #
+  #    a = Article.create(
+  #      :title => "Memories gem makes versioning simple", 
+  #      :author => "moonmaster9000", 
+  #      :body => <<-ARTICLE
+  #        Check it out at http://github.com/moonmaster9000/memories
+  #      ARTICLE
+  #    )
+  #    a.save
+  #    a.publish!
+  #    a.current_version #==> 1 
+  #    a.milestone! do
+  #      name "First publish."
+  #      notes "Passed all relevant editing. Signed off by moonmaster10000"
+  #    end
+  #
+  #Notice that we annotated our milestone; we gave it a name, and some notes. You can annotate with whatever properties you desire. The annotation do block is entirely optional.
+  #Now that we've created a milestone, let's inspect it via the `milestones` array: 
+  #
+  #    a.milestones.count #==> 1
+  #    a.milestones.last.version # ==> 1
+  #    a.milestones.last.version # ==> 1
+  #    a.milestones.last.annotations.name ==> "First publish."
+  #    a.milestones.last.annotations.notes ==> "Passed all relevant editing. Signed off by moonmaster10000"
+  #
+  #Now, let's imagine that we've made some more edits / saves to the document, but they don't get approved. Now we want to revert to the version the document was
+  #at at the first milestone. How do we do that? Simple!
+  #
+  #    a.revert_to_milestone! 1
+  #
+  #And now our document properties are back to the where they were when we first published the document.
+  #
+  #If you want to access the data from a milestone, simply use the "data" method: 
+  #    
+  #    a.milestones.first.data.title #==> returns the "title" attribute on the first milestone
+  #    a.milestones.each do |m|
+  #      puts "Version: " + m.version
+  #      puts "Title: " + m.data.title
+  #    end
   def milestones
-    self.milestone_memories
+    @milestones_proxy ||= MilestonesProxy.new self
   end
 
   # Returns the metadata (version, annotations) for the latest milestone created.

data/lib/memories/milestones_proxy.rb

@@ -0,0 +1,92 @@
+module Memories
+  #As of version 0.2.0, Memories also supports milestones. Milestones are special versions that you want to flag in some way.
+  #For example, suppose you were creating a content management system, and every time someone publishes an article to the website, you want to flag the version
+  #they published as a milestone. 
+  #
+  #    class Article < CouchRest::Model::Base
+  #      include Memories
+  #      use_database SOME_DATABASE
+  #      
+  #      property :title
+  #      property :author
+  #      property :body
+  #
+  #      def publish!
+  #        # .... publishing logic
+  #      end
+  #    end
+  #
+  #    a = Article.create(
+  #      :title => "Memories gem makes versioning simple", 
+  #      :author => "moonmaster9000", 
+  #      :body => <<-ARTICLE
+  #        Check it out at http://github.com/moonmaster9000/memories
+  #      ARTICLE
+  #    )
+  #    a.save
+  #    a.publish!
+  #    a.current_version #==> 1 
+  #    a.milestone! do
+  #      name "First publish."
+  #      notes "Passed all relevant editing. Signed off by moonmaster10000"
+  #    end
+  #
+  #Notice that we annotated our milestone; we gave it a name, and some notes. You can annotate with whatever properties you desire. The annotation do block is entirely optional.
+  #Now that we've created a milestone, let's inspect it via the `milestones` array: 
+  #
+  #    a.milestones.count #==> 1
+  #    a.milestones.last.version # ==> 1
+  #    a.milestones.last.version # ==> 1
+  #    a.milestones.last.annotations.name ==> "First publish."
+  #    a.milestones.last.annotations.notes ==> "Passed all relevant editing. Signed off by moonmaster10000"
+  #
+  #Now, let's imagine that we've made some more edits / saves to the document, but they don't get approved. Now we want to revert to the version the document was
+  #at at the first milestone. How do we do that? Simple!
+  #
+  #    a.revert_to_milestone! 1
+  #
+  #And now our document properties are back to the where they were when we first published the document.
+  #
+  #If you want to access the data from a milestone, simply use the "data" method: 
+  #    
+  #    a.milestones.first.data.title #==> returns the "title" attribute on the first milestone
+  #    a.milestones.each do |m|
+  #      puts "Version: " + m.version
+  #      puts "Title: " + m.data.title
+  #    end
+  class MilestonesProxy
+    def initialize(doc)
+      @doc = doc
+      @milestone_proxies = []
+    end
+    
+    def method_missing(method_name, *args, &block)
+      populate_proxies
+      @milestone_proxies.send(method_name, *args, &block)
+    end
+
+    private
+    def populate_proxies
+      if @milestone_proxies.count < @doc.milestone_memories.count
+        (@milestone_proxies.count...@doc.milestone_memories.count).each do |i|
+          @milestone_proxies[i] = MilestoneProxy.new @doc, @doc.milestone_memories[i]
+        end
+      end
+    end
+  end
+
+  class MilestoneProxy
+    def initialize(doc, milestone_metadata)
+      @doc = doc
+      @milestone_metadata = milestone_metadata
+    end
+
+    def data
+      @doc.versions[@milestone_metadata.version]
+    end
+
+    def method_missing(method_name, *args, &block)
+      @milestone_metadata.send method_name, *args, &block
+    end
+  end
+end

data/lib/memories/versions_proxy.rb

@@ -63,9 +63,10 @@ module Memories
     end
 
     def sanitize_range(range)
+      raise StandardError, "Sorry, but we don't allow negative numbers in the range." if range.first < 0 or range.last < 0
       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 = [1, range.first].max
+      last  = [range.last, @doc.current_version].min
       (first..last)
     end
 

metadata

@@ -1,13 +1,13 @@
 --- !ruby/object:Gem::Specification 
 name: memories
 version: !ruby/object:Gem::Version 
-  hash: 3
+  hash: 1
   prerelease: false
   segments: 
   - 0
   - 2
-  - 10
-  version: 0.2.10
+  - 11
+  version: 0.2.11
 platform: ruby
 authors: 
 - Matt Parker
@@ -16,7 +16,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2010-12-27 00:00:00 -05:00
+date: 2010-12-28 00:00:00 -05:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency 
@@ -51,6 +51,7 @@ files:
 - lib/memories/annotation.rb
 - lib/memories/attachment.rb
 - lib/memories/base.rb
+- lib/memories/milestones_proxy.rb
 - lib/memories/versions_proxy.rb
 - README.markdown
 has_rdoc: true