mm-versionable 0.2.1 → 0.2.2

data/LICENSE

@@ -0,0 +1,20 @@
+Copyright (c) 2010 Dhruva Sagar
+
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+"Software"), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
+LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
+WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE. 

data/README.md

@@ -8,18 +8,23 @@ $ gem install mm-versionable
 
 Note on Patches/Pull Requests
 -----------------------------
-*Fork the project
-*Make your feature addition or bug fix.
-*Add tests for it. This is critical so that things dont break unintentionally.
-*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.
+* Fork the project
+* Make your feature addition or bug fix.
+* Add tests for it. This is critical so that things dont break unintentionally.
+* 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 request.
 
 Usage
 -----
+The following example should demonstrate how to use versioning well :
+
+<pre>
 class Thing
   include MongoMapper::Document
 
-  enable_versioning :limit => 20 #:limit here defines the size of the version history that will be loaded into memory
+  enable_versioning :limit => 20
+  #:limit here defines the size of the version history that will be loaded into memory,
+  #By default, if not specified, the value is 10, if you wish to load all versions set it to 0
 
   key :name, String, :required => true
   key :date, Time
@@ -38,51 +43,59 @@ 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>]
+#=&gt; [#&lt;Version _id: BSON::ObjectId('4cef96c4f61aa33621000002'), data: {&quot;_id&quot;=&gt;BSON::ObjectId('4cef96c4f61aa33621000001'), &quot;version_message&quot;=&gt;nil, &quot;version_number&quot;=&gt;nil, &quot;name&quot;=&gt;&quot;Dhruva Sagar&quot;, &quot;date&quot;=&gt;2010-11-26 11:15:16 UTC}, date: 2010-11-26 11:15:16 UTC, pos: 0, doc_id: &quot;4cef96c4f61aa33621000001&quot;, message: nil, updater_id: nil&gt;, #&lt;Version _id: BSON::ObjectId('4cef96c4f61aa33621000003'), data: {&quot;_id&quot;=&gt;BSON::ObjectId('4cef96c4f61aa33621000001'), &quot;version_message&quot;=&gt;nil, &quot;version_number&quot;=&gt;nil, &quot;name&quot;=&gt;&quot;Change Thing&quot;, &quot;date&quot;=&gt;2010-11-26 11:15:16 UTC}, date: 2010-11-26 11:15:16 UTC, pos: 1, doc_id: &quot;4cef96c4f61aa33621000001&quot;, message: nil, updater_id: nil&gt;]
 
 thing.all_versions
-#=> #<Plucky::Query doc_id: "4cef96c4f61aa33621000001", sort: [["pos", -1]]> 
+#=&gt; #&lt;Plucky::Query doc_id: &quot;4cef96c4f61aa33621000001&quot;, sort: [[&quot;pos&quot;, -1]]&gt; 
 
 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>
+#=&gt; #&lt;Thing _id: BSON::ObjectId('4cef96c4f61aa33621000001'), version_message: nil, version_number: 0, name: &quot;Dhruva Sagar&quot;, date: 2010-11-26 11:15:16 UTC&gt;
 
 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>
+#=&gt; #&lt;Thing _id: BSON::ObjectId('4cef96c4f61aa33621000001'), version_message: nil, version_number: 0, name: &quot;Dhruva Sagar&quot;, date: 2010-11-26 11:15:16 UTC&gt;
 
 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>
+#=&gt; #&lt;Thing _id: BSON::ObjectId('4cef96c4f61aa33621000001'), version_message: nil, version_number: 1, name: &quot;Change Thing&quot;, date: 2010-11-26 11:15:16 UTC&gt;
 #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>"
+#=&gt; &quot;&lt;del class=\&quot;differ\&quot;&gt;Change&lt;/del&gt;&lt;ins class=\&quot;differ\&quot;&gt;Dhruva&lt;/ins&gt; &lt;del class=\&quot;differ\&quot;&gt;Thing&lt;/del&gt;&lt;ins class=\&quot;differ\&quot;&gt;Sagar&lt;/ins&gt;&quot;
 
 thing.diff(:name, 0, 1, :ascii)
-#=> "{\"Change\" >> \"Dhruva\"} {\"Thing\" >> \"Sagar\"}"
+#=&gt; &quot;{\&quot;Change\&quot; &gt;&gt; \&quot;Dhruva\&quot;} {\&quot;Thing\&quot; &gt;&gt; \&quot;Sagar\&quot;}&quot;
+
+thing.diff(:name, 0, 1, :color)
+#=&gt; &quot;\e[31mChange\e[0m\e[32mDhruva\e[0m \e[31mThing\e[0m\e[32mSagar\e[0m&quot;
 
 thing.current_version
-#=> "\e[31mChange\e[0m\e[32mDhruva\e[0m \e[31mThing\e[0m\e[32mSagar\e[0m"
+#=&gt; #&lt;Version _id: BSON::ObjectId('4cf03822f61aa30fd8000004'), data: {&quot;_id&quot;=&gt;BSON::ObjectId('4cf03816f61aa30fd8000001'), &quot;version_message&quot;=&gt;nil, &quot;version_number&quot;=&gt;nil, &quot;name&quot;=&gt;&quot;Change Thing&quot;, &quot;date&quot;=&gt;2010-11-26 22:43:34 UTC}, date: 2010-11-26 22:43:46 UTC, pos: nil, doc_id: &quot;4cf03816f61aa30fd8000001&quot;, message: nil, updater_id: nil&gt;
 
 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>
+#=&gt; #&lt;Version _id: BSON::ObjectId('4cef96c4f61aa33621000002'), data: {&quot;_id&quot;=&gt;BSON::ObjectId('4cef96c4f61aa33621000001'), &quot;version_message&quot;=&gt;nil, &quot;version_number&quot;=&gt;nil, &quot;name&quot;=&gt;&quot;Dhruva Sagar&quot;, &quot;date&quot;=&gt;2010-11-26 11:15:16 UTC}, date: 2010-11-26 11:15:16 UTC, pos: 0, doc_id: &quot;4cef96c4f61aa33621000001&quot;, message: nil, updater_id: nil&gt;
 
 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>
+#=&gt; #&lt;Version _id: BSON::ObjectId('4cef986df61aa33621000004'), data: {&quot;_id&quot;=&gt;BSON::ObjectId('4cef96c4f61aa33621000001'), &quot;version_message&quot;=&gt;nil, &quot;version_number&quot;=&gt;1, &quot;name&quot;=&gt;&quot;Change Thing&quot;, &quot;date&quot;=&gt;2010-11-26 11:15:16 UTC}, date: 2010-11-26 11:22:21 UTC, pos: nil, doc_id: &quot;4cef96c4f61aa33621000001&quot;, message: nil, updater_id: nil&gt;
 
 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>
+#=&gt; #&lt;Version _id: BSON::ObjectId('4cef96c4f61aa33621000002'), data: {&quot;_id&quot;=&gt;BSON::ObjectId('4cef96c4f61aa33621000001'), &quot;version_message&quot;=&gt;nil, &quot;version_number&quot;=&gt;nil, &quot;name&quot;=&gt;&quot;Dhruva Sagar&quot;, &quot;date&quot;=&gt;2010-11-26 11:15:16 UTC}, date: 2010-11-26 11:15:16 UTC, pos: 0, doc_id: &quot;4cef96c4f61aa33621000001&quot;, message: nil, updater_id: nil&gt;
 
 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>
+#=&gt; #&lt;Version _id: BSON::ObjectId('4cef96c4f61aa33621000003'), data: {&quot;_id&quot;=&gt;BSON::ObjectId('4cef96c4f61aa33621000001'), &quot;version_message&quot;=&gt;nil, &quot;version_number&quot;=&gt;nil, &quot;name&quot;=&gt;&quot;Change Thing&quot;, &quot;date&quot;=&gt;2010-11-26 11:15:16 UTC}, date: 2010-11-26 11:15:16 UTC, pos: 1, doc_id: &quot;4cef96c4f61aa33621000001&quot;, message: nil, updater_id: nil&gt; 
 
 thing.version_at(10)
 #=> nil
+</pre>
 
 Problems or Questions?
 ----------------------
-Hit up on the mongomapper google group: http://groups.google.com/group/mongomapper
-Hop on IRC: irc://chat.freenode.net/#mongomapper
+Hit up on the mongomapper google group:
+http://groups.google.com/group/mongomapper
+
+Hop on IRC:
+irc://chat.freenode.net/#mongomapper
+
 I am available on IRC with the name dhruvasagar, you could alternatively also contact me directly on dhruva.sagar@gmail.com
 
 Copyright
 ---------
-See LICENCE for details.
+See LICENSE for details.

data/lib/versionable/models/version.rb

@@ -3,8 +3,8 @@ class Version
 
   key :data, Hash
   key :date, Time
-  key :pos, Integer
-  key :doc_id, String
+  key :pos, Integer, :index => true
+  key :doc_id, String, :index => true
   key :message, String
   key :updater_id, String
 

data/lib/versionable/plugins/versionable.rb

@@ -32,9 +32,16 @@ module Versionable
     def enable_versioning(opts={})
       attr_accessor :rolling_back
 
-      key :version_message, String
       key :version_number, Integer
 
+      define_method(:version_message) do
+        @version_message
+      end
+
+      define_method(:version_message=) do |message|
+        @version_message = message
+      end
+
       define_method(:versions_count) do
         @versions_count ||= Version.count(:doc_id => self._id.to_s)
       end

data/lib/versionable/version.rb

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

data/mm-versionable.gemspec

@@ -5,17 +5,19 @@
 
 Gem::Specification.new do |s|
   s.name = %q{mm-versionable}
-  s.version = "0.2"
+  s.version = "0.2.2"
 
   s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
   s.authors = ["Dhruva Sagar"]
-  s.date = %q{2010-11-26}
+  s.date = %q{2011-01-18}
   s.description = %q{A MongoMapper extension that enables document versionable}
   s.email = %q{dhruva.sagar@gmail.com}
   s.extra_rdoc_files = [
+    "LICENSE",
     "README.md"
   ]
   s.files = [
+    "LICENSE",
     "README.md",
     "Rakefile",
     "config.ru",

data/test/config/config.rb

@@ -1 +1,3 @@
-MongoMapper.database = YAML.load(File.read('config/database.yml'))[ENV['RACK_ENV']]['database'] rescue 'versionable_test'
+require 'mongo_mapper'
+
+MongoMapper.database = YAML.load(File.read('test/config/database.yml'))[ENV['RACK_ENV']]['database'] rescue 'versionable_test'

data/test/performance/read_write.rb

@@ -6,7 +6,6 @@ MongoMapper.database = 'versionable_performance'
  
 class Foo
   include MongoMapper::Document
-  plugin Versionable
 
   enable_versioning
 
@@ -17,13 +16,28 @@ class Foo
 end
 Foo.collection.remove
 
-Benchmark.bm(5) do |x|
+class Bar
+  include MongoMapper::Document
+
+  key :approved, Boolean
+  key :count, Integer
+  key :approved_at, Time
+  key :expire_on, Date
+end
+Bar.collection.remove
+
+Benchmark.bm(22) do |x|
   ids = []
-  hhids = []
-  x.report("write   ") do
+  x.report("write with versioning   ") do
     1000.times { |i| ids << Foo.create(:count => 0, :approved => true, :approved_at => Time.now, :expire_on => Date.today).id }
   end
-  x.report("read    ") do
+  x.report("write without versioning") do
+    1000.times { |i| ids << Bar.create(:count => 0, :approved => true, :approved_at => Time.now, :expire_on => Date.today).id }
+  end
+  x.report("read with versioning    ") do
     ids.each { |id| Foo.first(:id => id) }
   end
+  x.report("read without versioning ") do
+    ids.each { |id| Bar.first(:id => id) }
+  end
 end

data/test/test_helper.rb

@@ -1,5 +1,6 @@
 $LOAD_PATH.unshift('.') unless $LOAD_PATH.include?('.')
 
+require 'test/config/config'
 require File.expand_path(File.dirname(__FILE__) + '/../lib/versionable')
 
 require 'pp'
@@ -8,8 +9,6 @@ require 'shoulda'
 require 'test/models/post'
 require 'test/models/user'
 
-require 'config/config'
-
 User.delete_all
 u = User.create(:fname => 'dhruva', :lname => 'sagar', :email => 'dhruva.sagar@gmail.com')
 u.fname = 'Dhruva'

data/test/unit/test_versioning.rb

@@ -8,6 +8,9 @@ class VersioningTest < Test::Unit::TestCase
     should 'respond to method version_message' do
       assert @user.respond_to?(:version_message)
     end
+    should 'respond to method version_message=' do
+      assert @user.respond_to?(:version_message=)
+    end
     should 'respond to method version_number' do
       assert @user.respond_to?(:version_number)
     end

metadata

@@ -5,8 +5,8 @@ version: !ruby/object:Gem::Version
   segments: 
   - 0
   - 2
-  - 1
-  version: 0.2.1
+  - 2
+  version: 0.2.2
 platform: ruby
 authors: 
 - Dhruva Sagar
@@ -14,7 +14,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2010-11-26 00:00:00 +05:30
+date: 2011-01-18 00:00:00 +05:30
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency 
@@ -50,8 +50,10 @@ executables: []
 extensions: []
 
 extra_rdoc_files: 
+- LICENSE
 - README.md
 files: 
+- LICENSE
 - README.md
 - Rakefile
 - config.ru