mongoid-history 0.2.4 → 0.3.0

data/.travis.yml

@@ -1,10 +1,4 @@
 language: ruby
 rvm:
-  - 1.9.2
   - 1.9.3
-  - 1.9.3
-  - ruby-head
-  - jruby
-  - rbx
-  - ree
 

data/CHANGELOG.md

@@ -1,3 +1,8 @@
+Next Release
+------------
+
+* 
+
 0.2.4 (8/21/2012)
 -----------------
 

data/Gemfile

@@ -1,13 +1,12 @@
 source "http://rubygems.org"
 
 gem "easy_diff"
-gem "mongoid", ">= 2.0.0"
+gem "mongoid", "~> 3.0.4"
 
 group :test do
-  gem "bson_ext"
-  gem "rspec"
+  gem "rspec", "~> 2.11.0"
   gem "yard"
   gem "bundler", ">= 1.0.0"
   gem "jeweler"
-  gem "database_cleaner"
+  gem "database_cleaner", ">= 0.8.0"
 end

data/README.md

@@ -3,40 +3,19 @@ mongoid-history
 
 [![Build Status](https://secure.travis-ci.org/aq1018/mongoid-history.png?branch=master)](http://travis-ci.org/aq1018/mongoid-history) [![Dependency Status](https://gemnasium.com/aq1018/mongoid-history.png?travis)](https://gemnasium.com/aq1018/mongoid-history)
 
+Mongoid-history tracks historical changes for any document, including embedded ones. It achieves this by storing all history tracks in a single collection that you define. Embedded documents are referenced by storing an association path, which is an array of `document_name` and `document_id` fields starting from the top most parent document and down to the embedded document that should track history.
 
-In frustration of Mongoid::Versioning, I created this plugin for tracking historical changes for any document, including embedded ones. It achieves this by storing all history tracks in a single collection that you define. Embedded documents are referenced by storing an association path, which is an array of `document_name` and `document_id` fields starting from the top most parent document and down to the embedded document that should track history.
+This gem also implements multi-user undo, which allows users to undo any history change in any order. Undoing a document also creates a new history track. This is great for auditing and preventing vandalism, but is probably not suitable for use cases such as a wiki.
 
-This plugin also implements multi-user undo, which allows users to undo any history change in any order. Undoing a document also creates a new history track. This is great for auditing and preventing vandalism, but it is probably not suitable for use cases such as a wiki.
+Stable Release
+--------------
 
-Note
-----
-
-**Please don't use 0.1.8 and 0.2.0.**
-
-These versions won't work in Rails because there was an error in the sweeper that causes history tracker creation to fail. Upgrade to version 0.2.1 instead as it's able to track history on `embeds_one` documents correctly.
-
-**Refactor in progress**
-
-If you feel brave, you can look at the `refactor` branch and get a feel of what's coming. As I stated many times before, this gem was originally hacked up in one evening, and got patched many times by various fellow users. Thus the code has become pretty unmanagable over time.  The `refactor` branch tries repay this technical debt by breaking things down into smaller class and implement better tests. Stay tuned! :D
-
-Upgrading from mongoid-history-0.1.x to >= 0.2
-------------------------------------------------
-
-If you are upgrading from 0.1.x to version 0.2.x and have existing data, run the following code **before** you start using 0.2.x. This is due to changes in `Mongoid::History::Tracker`'s `association_chain` field.
-
-```ruby
-Mongoid::History.tracker_class.all.each do |tracker|
-  tracker.association_chain[1..-1].each do |node|
-    node['name'] = node['name'].tableize
-  end
-  tracker.save!
-end
-```
+You're reading the documentation the 0.3.x release that supports Mongoid 3.x. For 2.x compatible mongoid-history, please use a 0.2.x version from the [2.x-stable branch](https://github.com/aq1018/mongoid-history/tree/2.4-stable).
 
 Install
 -------
 
-This gem supports Ruby 1.8.7, 1.9.2, 1.9.3, JRuby, Rubinius and REE. Add it to your `Gemfile` or run `gem install mongoid-history`.
+This gem supports Mongoid 3.x on Ruby 1.9.3 only. Add it to your `Gemfile` or run `gem install mongoid-history`.
 
 ```ruby
 gem 'mongoid-history'
@@ -45,8 +24,6 @@ gem 'mongoid-history'
 Usage
 -----
 
-Here is a quick example on how to use this plugin.
-
 **Create a history tracker**
 
 Create a new class to track histories. All histories are stored in this tracker. The name of the class can be anything you like. The only requirement is that it includes `Mongoid::History::Tracker`
@@ -60,7 +37,7 @@ end
 
 **Set tracker class name**
 
-You should manually set the tracker class name to make sure your tracker can be found and loaded properly. You can skip this step if you manually require your tracker before using any trackables.
+Manually set the tracker class name to make sure your tracker can be found and loaded properly. You can skip this step if you manually require your tracker before using any trackables.
 
 The following example sets the tracker class name using a Rails initializer.
 

data/VERSION

@@ -1 +1 @@
-0.2.4
+0.3.0

data/config/mongoid.yml

@@ -0,0 +1,8 @@
+test:
+  sessions:
+    default:
+      database: mongoid-history
+      hosts:
+        - localhost:27017
+      options:
+        consistency: :strong

data/lib/mongoid/history/trackable.rb

@@ -4,7 +4,7 @@ module Mongoid::History
 
     module ClassMethods
       def track_history(options={})
-        scope_name = self.collection_name.singularize.to_sym
+        scope_name = self.collection_name.to_s.singularize.to_sym
         default_options = {
           :on             =>  :all,
           :except         =>  [:created_at, :updated_at],
@@ -34,7 +34,7 @@ module Mongoid::History
         end
 
         field options[:version_field].to_sym, :type => Integer
-        referenced_in options[:modifier_field].to_sym, :class_name => Mongoid::History.modifier_class_name
+        belongs_to options[:modifier_field].to_sym, :class_name => Mongoid::History.modifier_class_name
 
         include MyInstanceMethods
         extend SingletonMethods
@@ -246,7 +246,7 @@ module Mongoid::History
 
     module SingletonMethods
       def history_trackable_options
-        @history_trackable_options ||= Mongoid::History.trackable_class_options[self.collection_name.singularize.to_sym]
+        @history_trackable_options ||= Mongoid::History.trackable_class_options[self.collection_name.to_s.singularize.to_sym]
       end
     end
   end

data/lib/mongoid/history/tracker.rb

@@ -13,7 +13,7 @@ module Mongoid::History
       field       :version,                 :type => Integer
       field       :action,                  :type => String
       field       :scope,                   :type => String
-      referenced_in :modifier,              :class_name => Mongoid::History.modifier_class_name
+      belongs_to :modifier,              :class_name => Mongoid::History.modifier_class_name
 
       Mongoid::History.tracker_class_name = self.name.tableize.singularize.to_sym
 
@@ -95,6 +95,7 @@ private
     def create_standalone
       class_name = association_chain.first["name"]
       restored = class_name.constantize.new(modified)
+      restored.id = modified["_id"]
       restored.save!
     end
 

data/mongoid-history.gemspec

@@ -5,7 +5,7 @@
 
 Gem::Specification.new do |s|
   s.name = "mongoid-history"
-  s.version = "0.2.4"
+  s.version = "0.3.0"
 
   s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
   s.authors = ["Aaron Qian", "Justin Grimes"]
@@ -26,6 +26,7 @@ Gem::Specification.new do |s|
     "README.md",
     "Rakefile",
     "VERSION",
+    "config/mongoid.yml",
     "lib/mongoid-history.rb",
     "lib/mongoid/history.rb",
     "lib/mongoid/history/sweeper.rb",
@@ -50,14 +51,14 @@ Gem::Specification.new do |s|
 
     if Gem::Version.new(Gem::VERSION) >= Gem::Version.new('1.2.0') then
       s.add_runtime_dependency(%q<easy_diff>, [">= 0"])
-      s.add_runtime_dependency(%q<mongoid>, [">= 2.0.0"])
+      s.add_runtime_dependency(%q<mongoid>, ["~> 3.0.4"])
     else
       s.add_dependency(%q<easy_diff>, [">= 0"])
-      s.add_dependency(%q<mongoid>, [">= 2.0.0"])
+      s.add_dependency(%q<mongoid>, ["~> 3.0.4"])
     end
   else
     s.add_dependency(%q<easy_diff>, [">= 0"])
-    s.add_dependency(%q<mongoid>, [">= 2.0.0"])
+    s.add_dependency(%q<mongoid>, ["~> 3.0.4"])
   end
 end
 

data/spec/integration/integration_spec.rb

@@ -17,7 +17,7 @@ describe Mongoid::History do
 
       embeds_many     :comments
       embeds_one      :section
-      embeds_many     :tags, :cascade_callbacks => true
+      embeds_many     :tags
 
       accepts_nested_attributes_for :tags, :allow_destroy => true
 

data/spec/support/mongoid.rb

@@ -1,11 +1,17 @@
-Mongoid.configure do |config|
-  config.master = Mongo::Connection.new.db("mongoid-history")
-end
+ENV["MONGOID_ENV"] = "test"
+Mongoid.load!("config/mongoid.yml")
 
 RSpec.configure do |config|
   config.before :each do
     Mongoid.observers = Mongoid::History::Sweeper
   end
+  config.backtrace_clean_patterns = [
+    # /\/lib\d*\/ruby\//,
+    # /bin\//,
+    # /gems/,
+    # /spec\/spec_helper\.rb/,
+    /lib\/rspec\/(core|expectations|matchers|mocks)/
+    ]
 end
 
 

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: mongoid-history
 version: !ruby/object:Gem::Version
-  version: 0.2.4
+  version: 0.3.0
   prerelease: 
 platform: ruby
 authors:
@@ -33,17 +33,17 @@ dependencies:
   requirement: !ruby/object:Gem::Requirement
     none: false
     requirements:
-    - - ! '>='
+    - - ~>
       - !ruby/object:Gem::Version
-        version: 2.0.0
+        version: 3.0.4
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     none: false
     requirements:
-    - - ! '>='
+    - - ~>
       - !ruby/object:Gem::Version
-        version: 2.0.0
+        version: 3.0.4
 description: ! "In frustration of Mongoid::Versioning, I created this plugin for tracking
   historical changes for any document, including embedded ones. It achieves this by
   storing all history tracks in a single collection that you define. (See Usage for
@@ -72,6 +72,7 @@ files:
 - README.md
 - Rakefile
 - VERSION
+- config/mongoid.yml
 - lib/mongoid-history.rb
 - lib/mongoid/history.rb
 - lib/mongoid/history/sweeper.rb
@@ -99,7 +100,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
       version: '0'
       segments:
       - 0
-      hash: -172559448489131861
+      hash: 877523070155476761
 required_rubygems_version: !ruby/object:Gem::Requirement
   none: false
   requirements: