mongoid-history 0.4.7 → 0.5.0

data/lib/mongoid/history/tracker.rb

@@ -8,13 +8,13 @@ module Mongoid
         include Mongoid::Timestamps
         attr_writer :trackable
 
-        field :association_chain,       type: Array,     default: []
+        field :association_chain,       type: Array, default: []
         field :modified,                type: Hash
         field :original,                type: Hash
         field :version,                 type: Integer
         field :action,                  type: String
         field :scope,                   type: String
-        belongs_to :modifier,                class_name: Mongoid::History.modifier_class_name
+        belongs_to :modifier, class_name: Mongoid::History.modifier_class_name
 
         index(scope: 1)
         index(association_chain: 1)
@@ -27,7 +27,7 @@ module Mongoid
           re_create
         elsif action.to_sym == :create
           re_destroy
-        elsif Mongoid::History.mongoid3?
+        elsif Mongoid::Compatibility::Version.mongoid3?
           trackable.update_attributes!(undo_attr(modifier), without_protection: true)
         else
           trackable.update_attributes!(undo_attr(modifier))
@@ -39,7 +39,7 @@ module Mongoid
           re_destroy
         elsif action.to_sym == :create
           re_create
-        elsif Mongoid::History.mongoid3?
+        elsif Mongoid::Compatibility::Version.mongoid3?
           trackable.update_attributes!(redo_attr(modifier), without_protection: true)
         else
           trackable.update_attributes!(redo_attr(modifier))

data/lib/mongoid/history/version.rb

@@ -1,5 +1,5 @@
 module Mongoid
   module History
-    VERSION = '0.4.7'
+    VERSION = '0.5.0'
   end
 end

data/mongoid-history.gemspec

@@ -20,12 +20,13 @@ Gem::Specification.new do |s|
 
   s.add_runtime_dependency 'easy_diff'
   s.add_runtime_dependency 'mongoid', '>= 3.0'
+  s.add_runtime_dependency 'mongoid-compatibility'
   s.add_runtime_dependency 'activesupport'
 
   s.add_development_dependency 'rake'
   s.add_development_dependency 'rspec', '~> 3.1'
   s.add_development_dependency 'bundler'
-  s.add_development_dependency 'rubocop', '0.27.1'
+  s.add_development_dependency 'rubocop', '0.34.1'
   s.add_development_dependency 'yard'
   s.add_development_dependency 'gem-release'
   s.add_development_dependency 'coveralls'

data/spec/integration/embedded_in_polymorphic_spec.rb

@@ -11,10 +11,10 @@ describe Mongoid::History::Tracker do
       embeds_one :address, class_name: 'Contact', as: :contactable
       embeds_one :embone,  as: :embedable
 
-      track_history on: :all,       # track title and body fields only, default is :all
+      track_history on: :all, # track title and body fields only, default is :all
                     modifier_field: :modifier, # adds "referenced_in :modifier" to track who made the change, default is :modifier
                     version_field: :version,   # adds "field :version, :type => Integer" to track current version, default is :version
-                    track_create: true,    # track document creation, default is false
+                    track_create: true, # track document creation, default is false
                     track_update: true,     # track document updates, default is true
                     track_destroy: false    # track document destruction, default is false
     end
@@ -27,14 +27,14 @@ describe Mongoid::History::Tracker do
       belongs_to :user
       embeds_one :address, class_name: 'Contact', as: :contactable
       embeds_one :second_address, class_name: 'Contact', as: :contactable
-      embeds_one :embone,  as: :embedable
+      embeds_one :embone, as: :embedable
 
-      track_history on: :all,       # track title and body fields only, default is :all
+      track_history on: :all, # track title and body fields only, default is :all
                     modifier_field: :modifier, # adds "referenced_in :modifier" to track who made the change, default is :modifier
                     version_field: :version,   # adds "field :version, :type => Integer" to track current version, default is :version
-                    track_create: true,    # track document creation, default is false
-                    track_update: true,     # track document updates, default is true
-                    track_destroy: false   # track document destruction, default is false
+                    track_create: true, # track document creation, default is false
+                    track_update: true, # track document updates, default is true
+                    track_destroy: false # track document destruction, default is false
     end
 
     class Embone
@@ -44,12 +44,12 @@ describe Mongoid::History::Tracker do
       field :name
       embedded_in :embedable, polymorphic: true
 
-      track_history on: :all,       # track title and body fields only, default is :all
+      track_history on: :all, # track title and body fields only, default is :all
                     modifier_field: :modifier, # adds "referenced_in :modifier" to track who made the change, default is :modifier
                     version_field: :version,   # adds "field :version, :type => Integer" to track current version, default is :version
-                    track_create: true,    # track document creation, default is false
-                    track_update: true,     # track document updates, default is true
-                    track_destroy: false,    # track document destruction, default is false
+                    track_create: true, # track document creation, default is false
+                    track_update: true, # track document updates, default is true
+                    track_destroy: false, # track document destruction, default is false
                     scope: :embedable
     end
 
@@ -62,12 +62,12 @@ describe Mongoid::History::Tracker do
       field :state
       embedded_in :contactable, polymorphic: true
 
-      track_history on: :all,       # track title and body fields only, default is :all
+      track_history on: :all, # track title and body fields only, default is :all
                     modifier_field: :modifier, # adds "referenced_in :modifier" to track who made the change, default is :modifier
                     version_field: :version,   # adds "field :version, :type => Integer" to track current version, default is :version
-                    track_create: true,    # track document creation, default is false
-                    track_update: true,     # track document updates, default is true
-                    track_destroy: false,    # track document destruction, default is false
+                    track_create: true, # track document creation, default is false
+                    track_update: true, # track document updates, default is true
+                    track_destroy: false, # track document destruction, default is false
                     scope: [:real_state, :company]
     end
 
@@ -97,8 +97,8 @@ describe Mongoid::History::Tracker do
     real_state.build_embone(name: 'Lorem ipsum').save!
     expect(real_state.history_tracks.count).to eq(4)
     expect(real_state.embone.history_tracks.count).to eq(1)
-    expect(real_state.history_tracks.last.action).to eq('create')
-    expect(real_state.history_tracks.last.association_chain.last['name']).to eq('embone')
+    expect(real_state.embone.history_tracks.last.action).to eq('create')
+    expect(real_state.embone.history_tracks.last.association_chain.last['name']).to eq('embone')
 
     company = user.companies.build(name: 'co_name')
     company.save!
@@ -115,13 +115,13 @@ describe Mongoid::History::Tracker do
     company.build_second_address(address: 'Main Street #789', city: 'Highland Park', state: 'IL').save!
     expect(company.history_tracks.count).to eq(4)
     expect(company.second_address.history_tracks.count).to eq(1)
-    expect(company.history_tracks.last.action).to eq('create')
-    expect(company.history_tracks.last.association_chain.last['name']).to eq('second_address')
+    expect(company.second_address.history_tracks.last.action).to eq('create')
+    expect(company.second_address.history_tracks.last.association_chain.last['name']).to eq('second_address')
 
     company.build_embone(name: 'Lorem ipsum').save!
     expect(company.history_tracks.count).to eq(5)
     expect(company.embone.history_tracks.count).to eq(1)
-    expect(company.history_tracks.last.action).to eq('create')
-    expect(company.history_tracks.last.association_chain.last['name']).to eq('embone')
+    expect(company.embone.history_tracks.last.action).to eq('create')
+    expect(company.embone.history_tracks.last.association_chain.last['name']).to eq('embone')
   end
 end

data/spec/integration/integration_spec.rb

@@ -75,11 +75,11 @@ describe Mongoid::History do
   end
 
   before(:each) { Mongoid::History.trackable_class_options = @persisted_history_options }
-  let(:user) { User.create(name: 'Aaron', email: 'aaron@randomemail.com', aliases: ['bob'], country: 'Canada', city: 'Toronto', address: '21 Jump Street') }
-  let(:another_user) { User.create(name: 'Another Guy', email: 'anotherguy@randomemail.com') }
-  let(:post) { Post.create(title: 'Test', body: 'Post', modifier: user, views: 100) }
-  let(:comment) { post.comments.create(title: 'test', body: 'comment', modifier: user) }
-  let(:tag) { Tag.create(title: 'test') }
+  let(:user) { User.create!(name: 'Aaron', email: 'aaron@randomemail.com', aliases: ['bob'], country: 'Canada', city: 'Toronto', address: '21 Jump Street') }
+  let(:another_user) { User.create!(name: 'Another Guy', email: 'anotherguy@randomemail.com') }
+  let(:post) { Post.create!(title: 'Test', body: 'Post', modifier: user, views: 100) }
+  let(:comment) { post.comments.create!(title: 'test', body: 'comment', modifier: user) }
+  let(:tag) { Tag.create!(title: 'test') }
 
   describe 'track' do
     describe 'on creation' do
@@ -88,7 +88,7 @@ describe Mongoid::History do
       end
 
       it 'should assign title and body on modified' do
-        expect(comment.history_tracks.first.modified).to eq('t' => 'test', 'body' =>  'comment')
+        expect(comment.history_tracks.first.modified).to eq('t' => 'test', 'body' => 'comment')
       end
 
       it 'should not assign title and body on original' do
@@ -212,7 +212,7 @@ describe Mongoid::History do
       end
 
       it 'should undo non-existing field changes' do
-        post = Post.create(modifier: user, views: 100)
+        post = Post.create!(modifier: user, views: 100)
         expect(post.reload.title).to be_nil
         post.update_attributes(title: 'Aaron2')
         expect(post.reload.title).to eq('Aaron2')
@@ -502,9 +502,8 @@ describe Mongoid::History do
     end
 
     describe 'embedded with cascading callbacks' do
-
-      let(:tag_foo) { post.tags.create(title: 'foo', updated_by: user) }
-      let(:tag_bar) { post.tags.create(title: 'bar') }
+      let(:tag_foo) { post.tags.create!(title: 'foo', updated_by: user) }
+      let(:tag_bar) { post.tags.create!(title: 'bar') }
 
       # it "should have cascaded the creation callbacks and set timestamps" do
       #   tag_foo; tag_bar # initialize
@@ -627,7 +626,7 @@ describe Mongoid::History do
       end
 
       describe 'undo' do
-        { 'undo'  => [nil], 'undo!' => [nil, :reload] }.each do |test_method, methods|
+        { 'undo' => [nil], 'undo!' => [nil, :reload] }.each do |test_method, methods|
           methods.each do |method|
             context "#{method || 'instance'}" do
               it 'recognizes :from, :to options' do
@@ -654,7 +653,7 @@ describe Mongoid::History do
                 expect(comment.title).to eq('Test2')
               end
 
-              if Mongoid::History.mongoid3?
+              if Mongoid::Compatibility::Version.mongoid3?
                 context 'protected attributes' do
                   before :each do
                     Comment.attr_accessible(nil)
@@ -713,7 +712,7 @@ describe Mongoid::History do
               expect(comment.title).to eq('Test5')
             end
 
-            if Mongoid::History.mongoid3?
+            if Mongoid::Compatibility::Version.mongoid3?
               context 'protected attributes' do
                 before :each do
                   Comment.attr_accessible(nil)
@@ -738,7 +737,6 @@ describe Mongoid::History do
             end
           end
         end
-
       end
     end
 
@@ -754,7 +752,7 @@ describe Mongoid::History do
       end
       it 'should correctly undo and redo' do
         if Sausage.respond_to?(:localized_fields)
-          sausage = Sausage.create(flavour_translations: { 'en' => 'Apple', 'nl' => 'Appel' })
+          sausage = Sausage.create!(flavour_translations: { 'en' => 'Apple', 'nl' => 'Appel' })
           sausage.update_attributes(flavour: 'Guinness')
 
           track = sausage.history_tracks.last
@@ -777,7 +775,7 @@ describe Mongoid::History do
       let(:foo) { Foo.new(title: 'a title', body: 'a body') }
       before :each do
         post.comments << foo
-        post.save
+        post.save!
       end
       it 'should assign interface name in association chain' do
         foo.update_attribute(:body, 'a changed body')
@@ -828,7 +826,6 @@ describe Mongoid::History do
       end
 
       describe 'post' do
-
         it 'should correctly undo and redo' do
           post.update_attributes(title: 'a new title')
           track = post.history_tracks.last
@@ -901,5 +898,28 @@ describe Mongoid::History do
         end
       end
     end
+
+    describe 'overriden changes_method with additional fields' do
+      before :each do
+        class OverriddenChangesMethod
+          include Mongoid::Document
+          include Mongoid::History::Trackable
+
+          track_history on: [:foo], changes_method: :my_changes
+
+          def my_changes
+            { foo: %w(bar baz) }
+          end
+        end
+      end
+
+      it 'should add foo to the changes history' do
+        o = OverriddenChangesMethod.create
+        o.save!
+        track = o.history_tracks.last
+        expect(track.modified).to eq('foo' => 'baz')
+        expect(track.original).to eq('foo' => 'bar')
+      end
+    end
   end
 end

data/spec/integration/multi_relation_spec.rb

@@ -13,7 +13,7 @@ describe Mongoid::History::Tracker do
       track_history on: [:name, :user, :external_user_ids], # track title and body fields only, default is :all
                     modifier_field: :modifier, # adds "referenced_in :modifier" to track who made the change, default is :modifier
                     modifier_field_inverse_of: nil, # no inverse modifier relationship
-                    version_field: :version,   # adds "field :version, :type => Integer" to track current version, default is :version
+                    version_field: :version, # adds "field :version, :type => Integer" to track current version, default is :version
                     track_create: false,    # track document creation, default is false
                     track_update: true,     # track document updates, default is true
                     track_destroy: false    # track document destruction, default is false

data/spec/integration/nested_embedded_documents_spec.rb

@@ -10,7 +10,7 @@ describe Mongoid::History::Tracker do
       belongs_to :user, inverse_of: :models
       embeds_many :embones
 
-      track_history on: :all,       # track title and body fields only, default is :all
+      track_history on: :all, # track title and body fields only, default is :all
                     modifier_field: :modifier, # adds "referenced_in :modifier" to track who made the change, default is :modifier
                     version_field: :version,   # adds "field :version, :type => Integer" to track current version, default is :version
                     track_create: false,    # track document creation, default is false
@@ -26,12 +26,12 @@ describe Mongoid::History::Tracker do
       embeds_many :embtwos, store_as: :ems
       embedded_in :model
 
-      track_history on: :all,       # track title and body fields only, default is :all
+      track_history on: :all, # track title and body fields only, default is :all
                     modifier_field: :modifier, # adds "referenced_in :modifier" to track who made the change, default is :modifier
                     version_field: :version,   # adds "field :version, :type => Integer" to track current version, default is :version
                     track_create: false,    # track document creation, default is false
                     track_update: true,     # track document updates, default is true
-                    track_destroy: false,    # track document destruction, default is false
+                    track_destroy: false, # track document destruction, default is false
                     scope: :model
     end
 
@@ -42,12 +42,12 @@ describe Mongoid::History::Tracker do
       field :name
       embedded_in :embone
 
-      track_history on: :all,       # track title and body fields only, default is :all
+      track_history on: :all, # track title and body fields only, default is :all
                     modifier_field: :modifier, # adds "referenced_in :modifier" to track who made the change, default is :modifier
                     version_field: :version,   # adds "field :version, :type => Integer" to track current version, default is :version
                     track_create: false,    # track document creation, default is false
                     track_update: true,     # track document updates, default is true
-                    track_destroy: false,    # track document destruction, default is false
+                    track_destroy: false, # track document destruction, default is false
                     scope: :model
     end
 

data/spec/integration/nested_embedded_polymorphic_documents_spec.rb

@@ -8,7 +8,7 @@ describe Mongoid::History::Tracker do
 
       field :name, type: String
       belongs_to :user
-      embeds_one :embedded_one,  as: :embedable
+      embeds_one :embedded_one, as: :embedable
 
       track_history on: :all,
                     modifier_field: :modifier,
@@ -24,7 +24,7 @@ describe Mongoid::History::Tracker do
 
       field :name, type: String
       belongs_to :user
-      embeds_one :embedded_one,  as: :embedable
+      embeds_one :embedded_one, as: :embedable
 
       track_history on: :all,
                     modifier_field: :modifier,
@@ -93,8 +93,8 @@ describe Mongoid::History::Tracker do
     modelone.build_embedded_one(name: 'Lorem ipsum').save!
     expect(modelone.history_tracks.count).to eq(4)
     expect(modelone.embedded_one.history_tracks.count).to eq(1)
-    expect(modelone.history_tracks.last.action).to eq('create')
-    expect(modelone.history_tracks.last.association_chain.last['name']).to eq('embedded_one')
+    expect(modelone.embedded_one.history_tracks.last.action).to eq('create')
+    expect(modelone.embedded_one.history_tracks.last.association_chain.last['name']).to eq('embedded_one')
 
     embedded_one1 = modelone.embedded_one.embedded_twos.create(name: 'modelone_embedded_one_1')
     expect(modelone.history_tracks.count).to eq(5)
@@ -116,8 +116,8 @@ describe Mongoid::History::Tracker do
     modeltwo.build_embedded_one(name: 'Lorem ipsum').save!
     expect(modeltwo.history_tracks.count).to eq(4)
     expect(modeltwo.embedded_one.history_tracks.count).to eq(1)
-    expect(modeltwo.history_tracks.last.action).to eq('create')
-    expect(modeltwo.history_tracks.last.association_chain.last['name']).to eq('embedded_one')
+    expect(modeltwo.embedded_one.history_tracks.last.action).to eq('create')
+    expect(modeltwo.embedded_one.history_tracks.last.association_chain.last['name']).to eq('embedded_one')
 
     embedded_one2 = modeltwo.embedded_one.embedded_twos.create(name: 'modeltwo_embedded_one_1')
     expect(modeltwo.history_tracks.count).to eq(5)

data/spec/spec_helper.rb

@@ -12,10 +12,8 @@ require 'mongoid/history'
 
 RSpec.configure do |config|
   config.raise_errors_for_deprecations!
-  config.expect_with :rspec do |expectations|
-    expectations.syntax = [:should, :expect]
-  end
-  config.mock_with :rspec do |mocks|
-    mocks.syntax = [:should, :expect]
+  config.before :all do
+    Mongoid.logger.level = Logger::INFO
+    Mongo::Logger.logger.level = Logger::INFO if Mongoid::Compatibility::Version.mongoid5?
   end
 end

data/spec/unit/trackable_spec.rb

@@ -6,6 +6,12 @@ class MyModel
   field :foo
 end
 
+class MyDynamicModel
+  include Mongoid::Document
+  include Mongoid::History::Trackable
+  include Mongoid::Attributes::Dynamic unless Mongoid::Compatibility::Version.mongoid3?
+end
+
 class HistoryTracker
   include Mongoid::History::Tracker
 end
@@ -95,6 +101,50 @@ describe Mongoid::History::Trackable do
       it 'should allow field aliases' do
         expect(MyModel.tracked_field?(:id, :destroy)).to be true
       end
+
+      context 'when model is dynamic' do
+        it 'should allow dynamic fields tracking' do
+          MyDynamicModel.track_history
+          expect(MyDynamicModel.tracked_field?(:dynamic_field, :destroy)).to be true
+        end
+      end
+
+      unless Mongoid::Compatibility::Version.mongoid3?
+        context 'when model is not dynamic' do
+          it 'should not allow dynamic fields tracking' do
+            MyModel.track_history
+            expect(MyModel.tracked_field?(:dynamic_field, :destroy)).to be false
+          end
+        end
+      end
+
+      it 'allows a non-database field to be specified' do
+        class MyNonDatabaseModel
+          include Mongoid::Document
+          include Mongoid::History::Trackable
+          track_history on: ['baz']
+        end
+
+        expect(MyNonDatabaseModel.tracked_field?(:baz)).to be true
+      end
+    end
+
+    context '#dynamic_field?' do
+      context 'when model is dynamic' do
+        it 'should return true' do
+          MyDynamicModel.track_history
+          expect(MyDynamicModel.dynamic_field?(:dynamic_field)).to be true
+        end
+      end
+
+      unless Mongoid::Compatibility::Version.mongoid3?
+        context 'when model is not dynamic' do
+          it 'should return false' do
+            MyModel.track_history
+            expect(MyModel.dynamic_field?(:dynamic_field)).to be false
+          end
+        end
+      end
     end
 
     context 'sub-model' do
@@ -113,9 +163,7 @@ describe Mongoid::History::Trackable do
     end
 
     describe '#track_history?' do
-
       context 'when tracking is globally enabled' do
-
         it 'should be enabled on the current thread' do
           expect(Mongoid::History.enabled?).to eq(true)
           expect(MyModel.new.track_history?).to eq(true)
@@ -154,7 +202,6 @@ describe Mongoid::History::Trackable do
       end
 
       context 'when tracking is globally disabled' do
-
         around(:each) do |example|
           Mongoid::History.disable do
             example.run
@@ -213,7 +260,6 @@ describe Mongoid::History::Trackable do
     end
 
     describe ':changes_method' do
-
       it 'should default to :changes' do
         m = MyModel.create
         expect(m).to receive(:changes).exactly(3).times.and_call_original