mm-versionable 0.2 → 0.2.1

data/README.md

@@ -14,8 +14,68 @@ Note on Patches/Pull Requests
 *Commit, do not make any changes in the rakefile, version, or history. (If you want to have your own version, that is fine but bump the version in a commit by itself so I can ignore it when I pull)
 *Send me a pull requests.
 
-Development
------------
+Usage
+-----
+class Thing
+  include MongoMapper::Document
+
+  enable_versioning :limit => 20 #:limit here defines the size of the version history that will be loaded into memory
+
+  key :name, String, :required => true
+  key :date, Time
+end
+
+thing = Thing.create(:name => 'Dhruva Sagar', :date => Time.now)
+
+thing.name = 'Change Thing'
+thing.save
+
+#Alternatively you can also pass in a "updater_id" to the save method which will be saved within the version, this can be used to track who made changes
+#example :
+#thing.save :updater_id => "4cef9936f61aa33717000001"
+
+thing.versions_count 
+#=> 2
+
+thing.versions
+#=> [#<Version _id: BSON::ObjectId('4cef96c4f61aa33621000002'), data: {"_id"=>BSON::ObjectId('4cef96c4f61aa33621000001'), "version_message"=>nil, "version_number"=>nil, "name"=>"Dhruva Sagar", "date"=>2010-11-26 11:15:16 UTC}, date: 2010-11-26 11:15:16 UTC, pos: 0, doc_id: "4cef96c4f61aa33621000001", message: nil, updater_id: nil>, #<Version _id: BSON::ObjectId('4cef96c4f61aa33621000003'), data: {"_id"=>BSON::ObjectId('4cef96c4f61aa33621000001'), "version_message"=>nil, "version_number"=>nil, "name"=>"Change Thing", "date"=>2010-11-26 11:15:16 UTC}, date: 2010-11-26 11:15:16 UTC, pos: 1, doc_id: "4cef96c4f61aa33621000001", message: nil, updater_id: nil>]
+
+thing.all_versions
+#=> #<Plucky::Query doc_id: "4cef96c4f61aa33621000001", sort: [["pos", -1]]> 
+
+thing.rollback(:first)
+#=> #<Thing _id: BSON::ObjectId('4cef96c4f61aa33621000001'), version_message: nil, version_number: 0, name: "Dhruva Sagar", date: 2010-11-26 11:15:16 UTC>
+
+thing.rollback(:last)
+#=> #<Thing _id: BSON::ObjectId('4cef96c4f61aa33621000001'), version_message: nil, version_number: 0, name: "Dhruva Sagar", date: 2010-11-26 11:15:16 UTC>
+
+thing.rollback!(:latest)
+#=> #<Thing _id: BSON::ObjectId('4cef96c4f61aa33621000001'), version_message: nil, version_number: 1, name: "Change Thing", date: 2010-11-26 11:15:16 UTC>
+#rollback! saves the document as well
+
+thing.diff(:name, 0, 1)
+#=> "<del class=\"differ\">Change</del><ins class=\"differ\">Dhruva</ins> <del class=\"differ\">Thing</del><ins class=\"differ\">Sagar</ins>"
+
+thing.diff(:name, 0, 1, :ascii)
+#=> "{\"Change\" >> \"Dhruva\"} {\"Thing\" >> \"Sagar\"}"
+
+thing.current_version
+#=> "\e[31mChange\e[0m\e[32mDhruva\e[0m \e[31mThing\e[0m\e[32mSagar\e[0m"
+
+thing.version_at(:first)
+#=> #<Version _id: BSON::ObjectId('4cef96c4f61aa33621000002'), data: {"_id"=>BSON::ObjectId('4cef96c4f61aa33621000001'), "version_message"=>nil, "version_number"=>nil, "name"=>"Dhruva Sagar", "date"=>2010-11-26 11:15:16 UTC}, date: 2010-11-26 11:15:16 UTC, pos: 0, doc_id: "4cef96c4f61aa33621000001", message: nil, updater_id: nil>
+
+thing.version_at(:current)
+#=> #<Version _id: BSON::ObjectId('4cef986df61aa33621000004'), data: {"_id"=>BSON::ObjectId('4cef96c4f61aa33621000001'), "version_message"=>nil, "version_number"=>1, "name"=>"Change Thing", "date"=>2010-11-26 11:15:16 UTC}, date: 2010-11-26 11:22:21 UTC, pos: nil, doc_id: "4cef96c4f61aa33621000001", message: nil, updater_id: nil>
+
+thing.version_at(:last)
+#=> #<Version _id: BSON::ObjectId('4cef96c4f61aa33621000002'), data: {"_id"=>BSON::ObjectId('4cef96c4f61aa33621000001'), "version_message"=>nil, "version_number"=>nil, "name"=>"Dhruva Sagar", "date"=>2010-11-26 11:15:16 UTC}, date: 2010-11-26 11:15:16 UTC, pos: 0, doc_id: "4cef96c4f61aa33621000001", message: nil, updater_id: nil>
+
+thing.version_at(:latest)
+#=> #<Version _id: BSON::ObjectId('4cef96c4f61aa33621000003'), data: {"_id"=>BSON::ObjectId('4cef96c4f61aa33621000001'), "version_message"=>nil, "version_number"=>nil, "name"=>"Change Thing", "date"=>2010-11-26 11:15:16 UTC}, date: 2010-11-26 11:15:16 UTC, pos: 1, doc_id: "4cef96c4f61aa33621000001", message: nil, updater_id: nil>
+
+thing.version_at(10)
+#=> nil
 
 Problems or Questions?
 ----------------------

data/lib/versionable.rb

@@ -1,2 +1,11 @@
+require 'differ'
 require 'mongo_mapper'
 require 'versionable/plugins/versionable'
+
+module VersionablePlugin
+  def self.included(model)
+    model.plugin Versionable
+  end
+end
+
+MongoMapper::Document.append_inclusions(VersionablePlugin)

data/lib/versionable/plugins/versionable.rb

@@ -1,13 +1,9 @@
 require 'versionable/models/version'
 
 module Versionable
-  def self.configure(model)
-    model.enable_versioning
-  end
-
   module InstanceMethods
     def save(options={})
-      save_version(options[:updater_id]) if self.respond_to?(:rolling_back) && !rolling_back
+      save_version(options.delete(:updater_id)) if self.respond_to?(:rolling_back) && !rolling_back
       super
     end
 
@@ -24,7 +20,7 @@ module Versionable
           version.updater_id = updater_id
           version.save
 
-          self.versions.shift
+          self.versions.shift if self.versions.count >= @limit
           self.versions << version
 
           @versions_count = @versions_count.to_i + 1
@@ -44,7 +40,8 @@ module Versionable
       end
 
       define_method(:versions) do
-        @versions ||= Version.all(:doc_id => self._id.to_s, :order => 'pos desc', :limit => (opts[:limit] || 10)).reverse
+        @limit ||= opts[:limit] || 10
+        @versions ||= Version.all(:doc_id => self._id.to_s, :order => 'pos desc', :limit => @limit).reverse
       end
 
       define_method(:all_versions) do

data/lib/versionable/version.rb

@@ -1,3 +1,3 @@
 module Versionable
-  Version = '0.2'
+  Version = '0.2.1'
 end

data/test/models/user.rb

@@ -1,6 +1,7 @@
 class User
   include MongoMapper::Document
-  plugin Versionable
+
+  enable_versioning :limit => 20
 
   key :fname, String
   key :lname, String

metadata

@@ -5,7 +5,8 @@ version: !ruby/object:Gem::Version
   segments: 
   - 0
   - 2
-  version: "0.2"
+  - 1
+  version: 0.2.1
 platform: ruby
 authors: 
 - Dhruva Sagar