memories 0.2.2 → 0.2.3

data/README.markdown

@@ -7,6 +7,10 @@ stored as an attachment on the document. This versioning strategy was originally
 
     $ gem install memories
 
+## Documentation
+
+Browse the documentation on rdoc.info: http://rdoc.info/github/moonmaster9000/memories
+
 ##How does it work?
 
 Just "include Memories" in your "CouchRest::Model::Base" classes and let the auto-versioning begin.
@@ -61,6 +65,7 @@ If you'd like to exclude certain properties from versioning, use the #forget cla
     p b.notes # ==> "creating the book. updating the title. might ship today. 9/2/2010. MKP"
     b.current_version #==> 3
 
+If you'd like to explicitly define which properties to version, use the #remember method. It works just like #forget, but in reverse. Duh.
 
 ###Milestones
 

data/README.rdoc

@@ -7,6 +7,10 @@ stored as an attachment on the document. This versioning strategy was originally
 
     $ gem install memories
 
+== Documentation
+
+Browse the documentation on rdoc.info: http://rdoc.info/github/moonmaster9000/memories
+
 == How does it work?
 
 Just "include Memories" in your "CouchRest::Model::Base" classes and let the auto-versioning begin.
@@ -61,6 +65,8 @@ If you'd like to exclude certain properties from versioning, use the #forget cla
     p b.notes # ==> "creating the book. updating the title. might ship today. 9/2/2010. MKP"
     b.current_version #==> 3
 
+If you'd like to explicitly define which properties to version, use the #remember method. It works just like #forget, but in reverse. Duh.
+
 === Milestones
 
 As of version 0.2.0, Memories also supports milestones. Milestones are special versions that you want to flag in some way.

data/lib/memories/base.rb

@@ -17,6 +17,8 @@ module Memories
     #   
     #   class MyDocument < CouchRest::Model::Base
     #     use_database MY_DATABASE
+    #     include Memories
+    #
     #     forget :prop1, :prop2
     #
     #     property :prop1 #not versioned
@@ -24,9 +26,44 @@ module Memories
     #     property :prop3 #versioned
     #   end
     def forget(*props)
+      raise StandardError, "Ambiguous use of both #remember and #forget." if @remember_called
+      @forget_called = true
       self.forget_properties += props.map {|p| p.to_s}
     end
 
+
+    # If you'd like to explicitly define which properties you want versioned simply pass those properties
+    # to this method: 
+    #   
+    #   class MyDocument < CouchRest::Model::Base
+    #     use_database MY_DATABASE
+    #     include Memories
+    #
+    #     remember :prop1, :prop2
+    #
+    #     property :prop1 #versioned
+    #     property :prop2 #versioned
+    #     property :prop3 # not versioned
+    #   end
+    def remember(*props)
+      raise StandardError, "Ambiguous use of both #remember and #forget." if @forget_called
+      @remember_called = true
+      props = props.map {|p| p.to_s}
+      if self.remember_properties.nil?
+        self.remember_properties = props 
+      else
+        self.remember_properties += props 
+      end
+    end 
+
+    def remember_properties #:nodoc
+      @remember_properties ||= nil
+    end
+
+    def remember_properties=(props) #:nodoc
+      @remember_properties = props
+    end
+
     def forget_properties #:nodoc:
       @forget_properties ||= ["couchrest-type", "_id", "_rev", "_attachments", "milestone_memories"]
     end
@@ -174,7 +211,11 @@ module Memories
   end
 
   def prep_for_versioning(doc)
-    doc.dup.delete_if {|k,v| self.class.forget_properties.include? k}
+    if self.class.remember_properties.nil?
+      doc.dup.delete_if {|k,v| self.class.forget_properties.include? k}
+    else
+      doc.dup.delete_if {|k,v| !self.class.remember_properties.include?(k)}
+    end
   end
 
   def decode_attachments

metadata

@@ -1,13 +1,13 @@
 --- !ruby/object:Gem::Specification 
 name: memories
 version: !ruby/object:Gem::Version 
-  hash: 19
+  hash: 17
   prerelease: false
   segments: 
   - 0
   - 2
-  - 2
-  version: 0.2.2
+  - 3
+  version: 0.2.3
 platform: ruby
 authors: 
 - Matt Parker
@@ -15,7 +15,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2010-09-04 00:00:00 -04:00
+date: 2010-09-11 00:00:00 -04:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency