memories 0.2.5 → 0.2.6

data/README.markdown

@@ -115,3 +115,34 @@ 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.
+
+## Attachments
+
+By default, memories doesn't version attachments. If you'd like to version attachments, simply call the `remember_attachments!` class method in your 
+class definition: 
+
+  class MyDoc < CouchRest::Model::Base
+    use_database MY_DB
+    include Memories
+
+    remember_attachments!
+  end
+
+If you only want specific attachments versioned, pass 
+strings and/or regular expressions to this macro. Any attachments
+with matching names will be versioned.
+
+  class HtmlPage < CouchRest::Model::Base
+    use_database MY_DB
+    include Memories
+
+    remember_attachments! "image.png", %r{stylesheets/.*}
+  end
+
+## Accessing Previous Versions
+
+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[1..20] # ==> returns versions 1 through 20 of your document

data/README.rdoc

@@ -115,3 +115,35 @@ 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.
+
+== Attachments
+
+By default, memories doesn't version attachments. If you'd like to version attachments, simply call the `remember\_attachments!` class method in your 
+class definition: 
+
+    class MyDoc < CouchRest::Model::Base
+      use_database MY_DB
+      include Memories
+
+      remember_attachments!
+    end
+
+If you only want specific attachments versioned, pass 
+strings and/or regular expressions to this macro. Any attachments
+with matching names will be versioned.
+
+    class HtmlPage < CouchRest::Model::Base
+      use_database MY_DB
+      include Memories
+
+      remember_attachments! "image.png", %r{stylesheets/.*}
+    end
+
+
+== Accessing Previous Versions
+
+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[1..20] # ==> returns versions 1 through 20 of your document

data/lib/memories.rb

@@ -1,5 +1,6 @@
 require 'base64'
 require 'couchrest_model'
 require 'memories/annotation'
+require 'memories/versions_proxy'
 require 'memories/attachment'
 require 'memories/base'

data/lib/memories/base.rb

@@ -7,8 +7,7 @@ module Memories
     end
 
     base.before_update :add_version_attachment
-    base.after_create :decode_attachments
-    base.after_update :decode_attachments
+    base.after_save :decode_attachments
     base.send :extend, ClassMethods
   end
   
@@ -119,7 +118,7 @@ module Memories
   # Returns a list of attachments it should remember.
   def attachments_to_remember
     return [] unless self.class.remember_attachments?
-    (self['_attachments'] || {}).keys.reject do |a| 
+    (self.database.get(self.id)["_attachments"] || {}).keys.reject do |a| 
       a.match(VERSION_REGEX) || 
         !(self.class.remember_attachments.map { |attachment_name_pattern|
           a.match attachment_name_pattern
@@ -204,6 +203,10 @@ module Memories
     version_number rev
   end
 
+  def versions
+    @versions ||= VersionsProxy.new self
+  end
+
   # Flag the current version as a milestone. You can optionally annotate the milestone by passing a do block to the method.
   #   some_article.milestone! do
   #     notes "Passed first round of editing."
@@ -219,7 +222,7 @@ module Memories
   end
 
   # returns an array of all milestones. Each milestone contains a "version" property (pointing to a specific revision)
-  # and an "annotations" property, containing a (possible empty) hash of key/value pairs corresponding to any annotations
+  # 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.
   def milestones
     self.milestone_memories
@@ -238,7 +241,7 @@ 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
@@ -264,7 +267,7 @@ module Memories
   end
 
   def add_version_attachment
-    current_document_version = Attachment.new prep_for_versioning(self.database.get(self.id, :rev => self.rev)).to_json
+    current_document_version = Attachment.new prep_for_versioning(self.database.get(self.id)).to_json
    
     self.create_attachment( 
       :file => current_document_version, 
@@ -275,25 +278,25 @@ module Memories
 
   def prep_for_versioning(doc)
     versioned_doc = doc.dup
-    strip_unversioned_properties versioned_doc
     add_attachment_memories versioned_doc if self.class.remember_attachments?
+    strip_unversioned_properties versioned_doc
     versioned_doc
   end
   
   def add_attachment_memories(doc)
     doc['attachment_memories'] = {
-      'versioned_attachments' => base64_encoded_attachments_to_remember,
+      'versioned_attachments' => base64_encoded_attachments_to_remember(doc),
       'known_attachments' => (self.database.get(self.id, :rev => self.rev)["_attachments"] || {}).keys.select {|a| !a.match(VERSION_REGEX)}
     }
   end
 
-  def base64_encoded_attachments_to_remember
+  def base64_encoded_attachments_to_remember(doc)
     encoded_attachments = {}
     attachments_to_remember.each do |a|
       attachment_data = self.read_attachment(a) rescue nil
       if attachment_data
         encoded_attachments[a] = { 
-          :content_type => self['_attachments'][a]['content_type'],
+          :content_type => doc['_attachments'][a]['content_type'],
           :data => Base64.encode64(attachment_data).gsub(/\s/, '')
         }
       end

data/lib/memories/versions_proxy.rb

@@ -0,0 +1,40 @@
+module Memories
+  class VersionsProxy
+    def initialize(doc)
+      @doc = doc
+    end
+
+    def count
+      @doc.current_version
+    end
+
+    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."
+      end
+    end
+
+    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| @doc.revert_to(i); @doc.dup}
+      versions << current_version if current_version 
+      versions
+    end
+
+    def version_num(num)
+      return nil if !num.kind_of?(Fixnum) or num > @doc.current_version or num < 1
+      @doc.revert_to(num)
+      @doc.dup
+    end
+
+    def version_id(id)
+      version_num @doc.version_number(id)
+    end
+  end
+end

metadata

@@ -1,21 +1,22 @@
 --- !ruby/object:Gem::Specification 
 name: memories
 version: !ruby/object:Gem::Version 
-  hash: 29
+  hash: 27
   prerelease: false
   segments: 
   - 0
   - 2
-  - 5
-  version: 0.2.5
+  - 6
+  version: 0.2.6
 platform: ruby
 authors: 
 - Matt Parker
+- Gary Cheong
 autorequire: 
 bindir: bin
 cert_chain: []
 
-date: 2010-11-01 00:00:00 -04:00
+date: 2010-12-24 00:00:00 -05:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency 
@@ -50,14 +51,15 @@ files:
 - lib/memories/annotation.rb
 - lib/memories/attachment.rb
 - lib/memories/base.rb
+- lib/memories/versions_proxy.rb
 - README.markdown
 has_rdoc: true
 homepage: http://github.com/moonmaster9000/memories
 licenses: []
 
 post_install_message: 
-rdoc_options: 
-- --charset=UTF-8
+rdoc_options: []
+
 require_paths: 
 - lib
 required_ruby_version: !ruby/object:Gem::Requirement