mongoid-history 0.4.4 → 0.4.5

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: fc676c3c474a938c28348873980b310b13a23755
-  data.tar.gz: cf12dbab2b4462f7697f0c98e6c15004718df721
+  metadata.gz: 1fa9bab26aeaf58f5e6f047b910f5d7e09c68e6d
+  data.tar.gz: 9da6ba97971fe87d296fd995ec73cf6562e3d49e
 SHA512:
-  metadata.gz: 8f3a8201b62c8a378a6f5707f047c58c6dc161000289fa0a835b05f732ab3e15b64fb10cc7be8d55ff434d680f72df5ed6e9a79ebf8a4f85067027e32666852a
-  data.tar.gz: 41e023a44672b5091e791ac365b88e3ea71b46db42ebfeb4b50a647f51a260579492c07b18897713472a494b994c783b7e21028f29fa000507d1425e71050ab8
+  metadata.gz: 56c010855bf25272c2cc7af7589077a2903afb2d3f3e899e3d6a3dfd7c795cce513e79e9aae0ebc857d09a42c2f13261aa55b250b88f5331f7ad593ffa1765ed
+  data.tar.gz: 6b8eedd5c6138854a8b8e0c9de1c0fc8a846efc90e03cd6ea3a934ed91c8437cb9a4fbf029a4e60acf9ddd2b2bf9ae4866748e0c7dc3149a24ba569a79b71a81

data/.rubocop.yml

@@ -3,74 +3,4 @@ AllCops:
     - vendor/**/*
     - bin/**/*
 
-LineLength:
-  Enabled: false
-
-MethodLength:
-  Enabled: false
-
-ClassLength:
-  Enabled: false
-
-Documentation:
-  # don't require classes to be documented
-  Enabled: false
-
-CollectionMethods:
-  # don't prefer map to collect, recuce to inject
-  Enabled: false
-
-Encoding:
-  # no need to always specify encoding
-  Enabled: false
-
-StringLiterals:
-  # use single or double-quoted strings, as you please
-  Enabled: false
-
-Void:
-  # == operator used in void context in specs
-  Enabled: false
-
-SignalException:
-  # prefer raise to fail
-  EnforcedStyle: only_raise
-
-RaiseArgs:
-  # don't care for what kind of raise
-  Enabled: false
-
-PerlBackrefs:
-  # TODO: regular expression matching with $1, $2, etc.
-  Enabled: false
-
-BlockNesting:
-  # TODO: fix too much nesting
-  Max: 4
-
-Lambda:
-  # TODO: replace all lambda with -> or Proc
-  Enabled: false
-
-Blocks:
-  # allow multi-line blocks like expect { }
-  Enabled: false
-
-WordArray:
-  # %w vs. [ '', ... ]
-  Enabled: false
-
-CyclomaticComplexity:
-  Enabled: false
-
-HandleExceptions:
-  Enabled: false
-
-MultilineBlockChain:
-  Enabled: false
-
-FileName:
-  Enabled: false
-
-RegexpLiteral:
-  Enabled: false
+inherit_from: .rubocop_todo.yml

data/.rubocop_todo.yml

@@ -0,0 +1,61 @@
+# This configuration was generated by `rubocop --auto-gen-config`
+# on 2014-12-09 07:20:55 -0500 using RuboCop version 0.27.1.
+# The point is for the user to remove these configuration records
+# one by one as the offenses are removed from the code base.
+# Note that changes in the inspected code, or installation of new
+# versions of RuboCop, may require this file to be generated again.
+
+# Offense count: 3
+Lint/HandleExceptions:
+  Enabled: false
+
+# Offense count: 27
+Lint/Void:
+  Enabled: false
+
+# Offense count: 12
+Metrics/AbcSize:
+  Max: 51
+
+# Offense count: 4
+Metrics/CyclomaticComplexity:
+  Max: 10
+
+# Offense count: 181
+# Configuration parameters: AllowURI, URISchemes.
+Metrics/LineLength:
+  Max: 688
+
+# Offense count: 7
+# Configuration parameters: CountComments.
+Metrics/MethodLength:
+  Max: 32
+
+# Offense count: 4
+Metrics/PerceivedComplexity:
+  Max: 12
+
+# Offense count: 37
+Style/Documentation:
+  Enabled: false
+
+# Offense count: 6
+Style/EachWithObject:
+  Enabled: false
+
+# Offense count: 1
+# Configuration parameters: Exclude.
+Style/FileName:
+  Enabled: false
+
+# Offense count: 1
+Style/Lambda:
+  Enabled: false
+
+# Offense count: 3
+Style/MultilineBlockChain:
+  Enabled: false
+
+# Offense count: 2
+Style/RegexpLiteral:
+  MaxSlashes: 0

data/.travis.yml

@@ -1,5 +1,7 @@
 services: mongodb
 
+sudo: false
+
 language: ruby
 
 cache: bundler
@@ -8,7 +10,7 @@ rvm:
   - 2.1.1
   - 2.0.0
   - 1.9.3
-  - rbx-2
+  - rbx-2.2.10
   - jruby-19mode
 
 env:

data/CHANGELOG.md

@@ -1,3 +1,11 @@
+0.4.5 (2/9/2015)
+----------------
+
+* [#131](https://github.com/aq1018/mongoid-history/pull/131) - Add `undo` method, that helps to get specific version of an object without saving changes - [@alexkravets](https://github.com/alexkravets).
+* [#127](https://github.com/aq1018/mongoid-history/pull/127) - Fix gem naming per [rubygems](http://guides.rubygems.org/name-your-gem/) specs, now you can `require 'mongoid/history'` - [@nofxx](https://github.com/nofxx).
+* [#129](https://github.com/aq1018/mongoid-history/pull/129) - Support multiple levels of embedded polimorphic documents - [@BrunoChauvet](https://github.com/BrunoChauvet).
+* [#123](https://github.com/aq1018/mongoid-history/pull/123): Use a method compatible with mongoid-observers to determinine the version of Mongoid - [@zeitnot](https://github.com/zeitnot).
+
 0.4.4 (7/29/2014)
 -----------------
 

data/README.md

@@ -121,6 +121,9 @@ track.undo! user # comment title should be "Test"
 
 track.redo! user # comment title should be "Test 2"
 
+# undo comment to version 1 without save
+comment.undo nil, from: 1, to: comment.version
+
 # undo last change
 comment.undo! user
 
@@ -238,6 +241,27 @@ instructions above then run the following command:
 MyHistoryTracker.all.each{|ht| ht.rename(:modifier_id, :created_by)
 ```
 
+**Setting Modifier Class Name**
+
+If your app will track history changes to a user, Mongoid History looks for these modifiers in the ``User`` class by default.  If you have named your 'user' accounts differently, you will need to add that to your Mongoid History config:
+
+The following examples set the modifier class name using a Rails initializer:
+
+If your app uses a class ``Author``:
+
+```ruby
+# config/initializers/mongoid-history.rb
+# initializer for mongoid-history
+
+Mongoid::History.modifier_class_name = 'Author'
+```
+
+Or perhaps you are namespacing to a module:
+
+```ruby
+Mongoid::History.modifier_class_name = 'CMS::Author'
+```
+
 **Using an alternate changes method**
 
 Sometimes you may wish to provide an alternate method for determining which changes should be tracked.  For example, if you are using embedded documents

data/Rakefile

@@ -3,7 +3,7 @@ begin
   Bundler.setup(:default, :development)
 rescue Bundler::BundlerError => e
   $stderr.puts e.message
-  $stderr.puts "Run `bundle install` to install missing gems"
+  $stderr.puts 'Run `bundle install` to install missing gems'
   exit e.status_code
 end
 
@@ -13,11 +13,11 @@ require 'rspec/core'
 require 'rspec/core/rake_task'
 RSpec::Core::RakeTask.new(:spec) do |spec|
   spec.pattern = FileList['spec/**/*_spec.rb']
-  spec.rspec_opts = "--color --format progress"
+  spec.rspec_opts = '--color --format progress'
 end
 
 require 'rubocop/rake_task'
-Rubocop::RakeTask.new(:rubocop)
+RuboCop::RakeTask.new(:rubocop)
 
 task default: [:rubocop, :spec]
 

data/lib/mongoid/history.rb

@@ -1,6 +1,13 @@
+require 'easy_diff'
+
+require 'mongoid/history/version'
+require 'mongoid/history/mongoid'
+require 'mongoid/history/tracker'
+require 'mongoid/history/trackable'
+
 module Mongoid
   module History
-    GLOBAL_TRACK_HISTORY_FLAG = "mongoid_history_trackable_enabled"
+    GLOBAL_TRACK_HISTORY_FLAG = 'mongoid_history_trackable_enabled'
 
     mattr_accessor :tracker_class_name
     mattr_accessor :trackable_class_options
@@ -23,3 +30,7 @@ module Mongoid
     end
   end
 end
+
+Mongoid::History.modifier_class_name = 'User'
+Mongoid::History.trackable_class_options = {}
+Mongoid::History.current_user_method ||= :current_user

data/lib/mongoid/history/mongoid.rb

@@ -1,7 +1,7 @@
 module Mongoid
   module History
     def self.mongoid3?
-      ::Mongoid.const_defined? :Observer # deprecated in Mongoid 4.x
+      Mongoid::VERSION =~ /^3\./
     end
   end
 end

data/lib/mongoid/history/trackable.rb

@@ -74,7 +74,7 @@ module Mongoid
         #  undo :from => 1, :to => 5
         #  undo 4
         #  undo :last => 10
-        def undo!(modifier = nil, options_or_version = nil)
+        def undo(modifier = nil, options_or_version = nil)
           versions = get_versions_criteria(options_or_version).to_a
           versions.sort! { |v1, v2| v2.version <=> v1.version }
 
@@ -82,13 +82,20 @@ module Mongoid
             undo_attr = v.undo_attr(modifier)
             if Mongoid::History.mongoid3? # update_attributes! not bypassing rails 3 protected attributes
               assign_attributes(undo_attr, without_protection: true)
-              save!
             else # assign_attributes with 'without_protection' option does not work with rails 4/mongoid 4
-              update_attributes!(undo_attr)
+              self.attributes = undo_attr
             end
           end
         end
 
+        #  undo! :from => 1, :to => 5
+        #  undo! 4
+        #  undo! :last => 10
+        def undo!(modifier = nil, options_or_version = nil)
+          undo(modifier, options_or_version)
+          save!
+        end
+
         def redo!(modifier = nil, options_or_version = nil)
           versions = get_versions_criteria(options_or_version).to_a
           versions.sort! { |v1, v2| v1.version <=> v2.version }
@@ -120,11 +127,11 @@ module Mongoid
             if options[:from] && options[:to]
               lower = options[:from] >= options[:to] ? options[:to] : options[:from]
               upper = options[:from] <  options[:to] ? options[:to] : options[:from]
-              versions = history_tracks.where(:version.in => (lower .. upper).to_a)
+              versions = history_tracks.where(:version.in => (lower..upper).to_a)
             elsif options[:last]
               versions = history_tracks.limit(options[:last])
             else
-              raise "Invalid options, please specify (:from / :to) keys or :last key."
+              fail 'Invalid options, please specify (:from / :to) keys or :last key.'
             end
           else
             options_or_version = options_or_version.to_a if options_or_version.is_a?(Range)
@@ -138,13 +145,20 @@ module Mongoid
 
         def related_scope
           scope = history_trackable_options[:scope]
-          scope = _parent.collection_name.to_s.singularize.to_sym if scope.is_a?(Array)
 
-          if Mongoid::History.mongoid3?
-            scope = metadata.inverse_class_name.tableize.singularize.to_sym if metadata.present? && scope == metadata.as
+          # Use top level document if its name is specified in the scope
+          root_document_name = traverse_association_chain.first['name'].singularize.underscore.gsub('/', '_').to_sym
+          if scope.is_a?(Array) && scope.include?(root_document_name)
+            scope = root_document_name
           else
-            scope = relation_metadata.inverse_class_name.tableize.singularize.to_sym if relation_metadata.present? && scope == relation_metadata.as
+            scope = _parent.collection_name.to_s.singularize.to_sym if scope.is_a?(Array)
+            if Mongoid::History.mongoid3?
+              scope = metadata.inverse_class_name.tableize.singularize.to_sym if metadata.present? && scope == metadata.as
+            else
+              scope = relation_metadata.inverse_class_name.tableize.singularize.to_sym if relation_metadata.present? && scope == relation_metadata.as
+            end
           end
+
           scope
         end
 
@@ -308,7 +322,7 @@ module Mongoid
         #
         # @return [ Array < String > ] the list of reserved database field names
         def reserved_tracked_fields
-          @reserved_tracked_fields ||= ["_id", history_trackable_options[:version_field].to_s, "#{history_trackable_options[:modifier_field]}_id"]
+          @reserved_tracked_fields ||= ['_id', history_trackable_options[:version_field].to_s, "#{history_trackable_options[:modifier_field]}_id"]
         end
 
         def history_trackable_options

data/lib/mongoid/history/tracker.rb

@@ -140,10 +140,10 @@ module Mongoid
       #   { field_1: value, field_2: value }
       def affected
         target = action.to_sym == :destroy ? :from : :to
-        @affected ||= tracked_changes.inject(HashWithIndifferentAccess.new) { |h, (k, v)|
+        @affected ||= tracked_changes.inject(HashWithIndifferentAccess.new) do |h, (k, v)|
           h[k] = v[target]
           h
-        }
+        end
       end
 
       # Returns the class of the trackable, irrespective of whether the trackable object
@@ -151,7 +151,7 @@ module Mongoid
       #
       # @return [ Class ] the class of the trackable
       def trackable_parent_class
-        association_chain.first["name"].constantize
+        association_chain.first['name'].constantize
       end
 
       private
@@ -166,18 +166,18 @@ module Mongoid
 
       def create_standalone
         restored = trackable_parent_class.new(localize_keys(original))
-        restored.id = original["_id"]
+        restored.id = original['_id']
         restored.save!
       end
 
       def create_on_parent
-        name = association_chain.last["name"]
+        name = association_chain.last['name']
         if trackable_parent.class.embeds_one?(name)
           trackable_parent.create_embedded(name, localize_keys(original))
         elsif trackable_parent.class.embeds_many?(name)
           trackable_parent.get_embedded(name).create!(localize_keys(original))
         else
-          raise "This should never happen. Please report bug!"
+          fail 'This should never happen. Please report bug!'
         end
       end
 
@@ -202,7 +202,7 @@ module Mongoid
                 elsif doc.class.embeds_many?(name)
                   doc.get_embedded(name).unscoped.where(_id: node['id']).first
                 else
-                  raise "This should never happen. Please report bug."
+                  fail 'This should never happen. Please report bug.'
                 end
           documents << doc
           break if chain.empty?
@@ -211,7 +211,7 @@ module Mongoid
       end
 
       def localize_keys(hash)
-        klass = association_chain.first["name"].constantize
+        klass = association_chain.first['name'].constantize
         klass.localized_fields.keys.each do |name|
           hash["#{name}_translations"] = hash.delete(name) if hash[name].present?
         end if klass.respond_to?(:localized_fields)

data/lib/mongoid/history/version.rb

@@ -1,5 +1,5 @@
 module Mongoid
   module History
-    VERSION = '0.4.4'
+    VERSION = '0.4.5'
   end
 end

data/mongoid-history.gemspec

@@ -23,9 +23,9 @@ Gem::Specification.new do |s|
   s.add_runtime_dependency 'activesupport'
 
   s.add_development_dependency 'rake'
-  s.add_development_dependency 'rspec', '>= 3.0'
+  s.add_development_dependency 'rspec', '~> 3.1'
   s.add_development_dependency 'bundler'
-  s.add_development_dependency 'rubocop', '0.21.0'
+  s.add_development_dependency 'rubocop', '0.27.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

@@ -78,13 +78,13 @@ describe Mongoid::History::Tracker do
     end
   end
 
-  it "tracks history for nested embedded documents with polymorphic relations" do
+  it 'tracks history for nested embedded documents with polymorphic relations' do
     user = User.new
     user.save!
 
     real_state = user.real_states.build(name: 'rs_name')
     real_state.save!
-    real_state.build_address(address: "Main Street #123", city: "Highland Park", state: 'IL').save!
+    real_state.build_address(address: 'Main Street #123', city: 'Highland Park', state: 'IL').save!
     expect(real_state.history_tracks.count).to eq(2)
     expect(real_state.address.history_tracks.count).to eq(1)
 
@@ -102,7 +102,7 @@ describe Mongoid::History::Tracker do
 
     company = user.companies.build(name: 'co_name')
     company.save!
-    company.build_address(address: "Main Street #456", city: "Evanston", state: 'IL').save!
+    company.build_address(address: 'Main Street #456', city: 'Evanston', state: 'IL').save!
     expect(company.history_tracks.count).to eq(2)
     expect(company.address.history_tracks.count).to eq(1)
 
@@ -112,7 +112,7 @@ describe Mongoid::History::Tracker do
     expect(company.address.history_tracks.count).to eq(2)
     expect(company.history_tracks.last.action).to eq('update')
 
-    company.build_second_address(address: "Main Street #789", city: "Highland Park", state: 'IL').save!
+    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')