memories 0.2.14 → 0.3.0

data/README.markdown

@@ -105,10 +105,11 @@ Notice that we annotated our milestone; we gave it a name, and some notes. You c
 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 moonmaster 10000"
+    a.milestones.last.version # ==> 'rev-1-893428ifldlfds9832'
+    a.milestones.last.version_number # ==> 1
+    a.milestones.last.annotations.name # ==> "First publish."
+    a.milestones.last.annotations.notes # ==> "Passed all relevant editing. Signed off by moonmaster 10000"
+    a.milestones.last.instance.title # ==> Memories gem makes versioning simple
 
 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!
@@ -152,9 +153,11 @@ with matching names will be versioned.
 
 You can access old versions of your document via the "versions" method; it will return a proxy with array-like and hash-like access to previous versions.
 
-  @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[1].instance # ==> returns version 1 of your document
+  @doc.versions[1].revision # ==> 'rev-1-jkfldsi32849032894032'
+  @doc.versions[1].version_number # ==> 1
+  @doc.versions['rev-1-kjfdsla3289430289432'].instance # ==> returns version 1 of your document
+  @doc.versions[1..7] # ==> returns version proxies 1 through 7 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/lib/memories/milestones_proxy.rb

@@ -35,8 +35,8 @@ module Memories
   #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.version # ==> 'rev-1-reiwurieowu9340289032804932krew'
+  #    a.milestones.last.version_number # ==> 1
   #    a.milestones.last.annotations.name ==> "First publish."
   #    a.milestones.last.annotations.notes ==> "Passed all relevant editing. Signed off by moonmaster10000"
   #
@@ -75,15 +75,14 @@ module Memories
     end
   end
 
-  class MilestoneProxy
+  class MilestoneProxy < VersionProxy
     def initialize(doc, milestone_metadata)
       @doc = doc
       @milestone_metadata = milestone_metadata
+      @version_number = @doc.version_number @milestone_metadata.version
     end
 
-    def data
-      @doc.versions[@milestone_metadata.version]
-    end
+    def milestone?; true; end
 
     def method_missing(method_name, *args, &block)
       @milestone_metadata.send method_name, *args, &block

data/lib/memories/versions_proxy.rb

@@ -3,81 +3,76 @@ module Memories
     # A Memories::VersionsProxy is automatically initialized, memoized, 
     # and returned when you call the `versions` method on your document.
     #   doc = Book.create :name => '2001'
+    #   doc.name = '2001: A Space Odyssey'
+    #   doc.milestone!
     #   doc.versions.class # ==> ::Memories::VersionsProxy
+    #
+    # You can access versions by version number
+    #   doc.versions[0] #==> nil
+    #   doc.versions[1].revision #==> 'rev-1-io329uidlrew098320'
+    #   doc.versions[1].instance.name #==> '2001'
+    #   doc.versions[1].milestone? #==> false
+    #   doc.versions[2].instance.name #==> '2001: A Space Odyssey'
+    #   doc.versions[2].milestone? #==> true
+    #   doc.versions[2].version_number # ==> 2
+    #
     def initialize(doc)
       @doc = doc
-      @versions = {}
+      @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
+      populate_proxies
+      @versions.count - 1
     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)
+    def [](arg)
+      populate_proxies
+      
+      if arg.kind_of?(String)
+        @versions[@doc.version_number arg]
+      else
+        @versions[arg]
+      end
     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
+    def method_missing(method_name, *args, &block)
+      populate_proxies
+      @versions.send(method_name, *args, &block)
     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
-        when "Fixnum" then version_num arg
-        when "String" then version_id arg
-        else raise "Invalid argument."
+    private
+    def populate_proxies
+      if (@versions.count - 1) < @doc.current_version.to_i
+        (1..@doc.current_version.to_i).each do |i|
+          @versions[i] ||= VersionProxy.new @doc, i
+        end
       end
     end
+  end
 
-    # Iterate through all versions
-    #     @doc.versions.each {|v| puts v.some_property}
-    def each(&block)
-      version_range(1..@doc.current_version).each &block
-    end
+  class VersionProxy
+    attr_reader :version_number
 
-    private
-    def version_range(range)
-      sanitize_range(range).to_a.map {|i| version_num i}
+    def initialize(doc, version_number)
+      @doc = doc
+      @version_number = version_number
+    end
+    
+    def version
+      @version ||= @doc.version_id @version_number
     end
 
-    def version_num(num)
-      return nil if !num.kind_of?(Fixnum) or num > @doc.current_version or num < 1
-      @versions[num] ||= @doc.dup.revert_to(num)
+    def revision
+      version
     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 = [1, range.first].max
-      last  = [range.last, @doc.current_version].min
-      (first..last)
+    def milestone?
+      @is_milestone ||= @doc.milestones.collect(&:version).include? version
     end
 
-    def version_id(id)
-      version_num @doc.version_number(id)
+    def instance
+      @instance ||= @doc.dup.revert_to @version_number
     end
   end
 end

metadata

@@ -1,13 +1,13 @@
 --- !ruby/object:Gem::Specification 
 name: memories
 version: !ruby/object:Gem::Version 
-  hash: 11
+  hash: 19
   prerelease: false
   segments: 
   - 0
-  - 2
-  - 14
-  version: 0.2.14
+  - 3
+  - 0
+  version: 0.3.0
 platform: ruby
 authors: 
 - Matt Parker