mongoid-history 0.8.3 → 0.8.5

data/mongoid-history.gemspec

@@ -1,25 +1,25 @@
-$LOAD_PATH.push File.expand_path('../lib', __FILE__)
-require 'mongoid/history/version'
-
-Gem::Specification.new do |s|
-  s.name        = 'mongoid-history'
-  s.version     = Mongoid::History::VERSION
-  s.authors     = ['Aaron Qian', 'Justin Grimes', 'Daniel Doubrovkine']
-  s.summary     = 'Track and audit, undo and redo changes on Mongoid documents.'
-  s.description = 'This library 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. Mongoid-history 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.'
-  s.email       = ['aq1018@gmail.com', 'justin.mgrimes@gmail.com', 'dblock@dblock.org']
-  s.homepage    = 'http://github.com/mongoid/mongoid-history'
-  s.license     = 'MIT'
-
-  s.files         = `git ls-files`.split($INPUT_RECORD_SEPARATOR)
-  s.executables   = s.files.grep(%r{^bin/}) { |f| File.basename(f) }
-  s.test_files    = s.files.grep(%r{^(test|spec|features)/})
-  s.require_paths = ['lib']
-
-  s.post_install_message = File.read('UPGRADING') if File.exist?('UPGRADING')
-
-  s.add_runtime_dependency 'easy_diff'
-  s.add_runtime_dependency 'mongoid', '>= 3.0'
-  s.add_runtime_dependency 'mongoid-compatibility', '>= 0.5.1'
-  s.add_runtime_dependency 'activesupport'
-end
+$LOAD_PATH.push File.expand_path('../lib', __FILE__)
+require 'mongoid/history/version'
+
+Gem::Specification.new do |s|
+  s.name        = 'mongoid-history'
+  s.version     = Mongoid::History::VERSION
+  s.authors     = ['Aaron Qian', 'Justin Grimes', 'Daniel Doubrovkine']
+  s.summary     = 'Track and audit, undo and redo changes on Mongoid documents.'
+  s.description = 'This library 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. Mongoid-history 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.'
+  s.email       = ['aq1018@gmail.com', 'justin.mgrimes@gmail.com', 'dblock@dblock.org']
+  s.homepage    = 'http://github.com/mongoid/mongoid-history'
+  s.license     = 'MIT'
+
+  s.files         = `git ls-files`.split($INPUT_RECORD_SEPARATOR)
+  s.executables   = s.files.grep(%r{^bin/}) { |f| File.basename(f) }
+  s.test_files    = s.files.grep(%r{^(test|spec|features)/})
+  s.require_paths = ['lib']
+
+  s.post_install_message = File.read('UPGRADING') if File.exist?('UPGRADING')
+
+  s.add_runtime_dependency 'easy_diff'
+  s.add_runtime_dependency 'mongoid', '>= 3.0'
+  s.add_runtime_dependency 'mongoid-compatibility', '>= 0.5.1'
+  s.add_runtime_dependency 'activesupport'
+end

data/perf/benchmark_modified_attributes_for_create.rb

@@ -1,65 +1,65 @@
-$LOAD_PATH.push File.expand_path('../../lib', __FILE__)
-
-require 'mongoid'
-require 'mongoid/history'
-
-require 'benchmark/ips'
-require './perf/gc_suite'
-
-Mongoid.connect_to('mongoid_history_perf_test')
-Mongo::Logger.logger.level = ::Logger::FATAL
-Mongoid.purge!
-
-Attributes = Mongoid::History::Attributes
-
-module ZeroPointEight
-  class Create < Attributes::Create
-    def attributes
-      @attributes = {}
-      trackable.attributes.each do |k, v|
-        next unless trackable_class.tracked_field?(k, :create)
-        modified = if changes[k]
-                     changes[k].class == Array ? changes[k].last : changes[k]
-                   else
-                     v
-                   end
-        @attributes[k] = [nil, format_field(k, modified)]
-      end
-      insert_embeds_one_changes
-      insert_embeds_many_changes
-      @attributes
-    end
-  end
-end
-
-class Person
-  include Mongoid::Document
-  include Mongoid::History::Trackable
-
-  field :first_name, type: String
-  field :last_name, type: String
-  field :birth_date, type: Date
-  field :title, type: String
-
-  track_history on: %i[first_name last_name birth_date]
-end
-
-new_person = Person.new(first_name: 'Eliot', last_name: 'Horowitz', birth_date: '1981-05-01', title: 'CTO')
-
-Benchmark.ips do |bm|
-  bm.config(suite: GCSuite.new)
-
-  bm.report('HEAD') do
-    Attributes::Create.new(new_person).attributes
-  end
-
-  bm.report('v0.8.2') do
-    ZeroPointEight::Create.new(new_person).attributes
-  end
-
-  bm.report('v0.5.0') do
-    new_person.attributes.each_with_object({}) { |(k, v), h| h[k] = [nil, v] }.select { |k, _| new_person.class.tracked_field?(k, :create) }
-  end
-
-  bm.compare!
-end
+$LOAD_PATH.push File.expand_path('../../lib', __FILE__)
+
+require 'mongoid'
+require 'mongoid/history'
+
+require 'benchmark/ips'
+require './perf/gc_suite'
+
+Mongoid.connect_to('mongoid_history_perf_test')
+Mongo::Logger.logger.level = ::Logger::FATAL
+Mongoid.purge!
+
+Attributes = Mongoid::History::Attributes
+
+module ZeroPointEight
+  class Create < Attributes::Create
+    def attributes
+      @attributes = {}
+      trackable.attributes.each do |k, v|
+        next unless trackable_class.tracked_field?(k, :create)
+        modified = if changes[k]
+                     changes[k].class == Array ? changes[k].last : changes[k]
+                   else
+                     v
+                   end
+        @attributes[k] = [nil, format_field(k, modified)]
+      end
+      insert_embeds_one_changes
+      insert_embeds_many_changes
+      @attributes
+    end
+  end
+end
+
+class Person
+  include Mongoid::Document
+  include Mongoid::History::Trackable
+
+  field :first_name, type: String
+  field :last_name, type: String
+  field :birth_date, type: Date
+  field :title, type: String
+
+  track_history on: %i[first_name last_name birth_date]
+end
+
+new_person = Person.new(first_name: 'Eliot', last_name: 'Horowitz', birth_date: '1981-05-01', title: 'CTO')
+
+Benchmark.ips do |bm|
+  bm.config(suite: GCSuite.new)
+
+  bm.report('HEAD') do
+    Attributes::Create.new(new_person).attributes
+  end
+
+  bm.report('v0.8.2') do
+    ZeroPointEight::Create.new(new_person).attributes
+  end
+
+  bm.report('v0.5.0') do
+    new_person.attributes.each_with_object({}) { |(k, v), h| h[k] = [nil, v] }.select { |k, _| new_person.class.tracked_field?(k, :create) }
+  end
+
+  bm.compare!
+end

data/perf/gc_suite.rb

@@ -1,21 +1,21 @@
-class GCSuite
-  def warming(*)
-    run_gc
-  end
-
-  def running(*)
-    run_gc
-  end
-
-  def warmup_stats(*); end
-
-  def add_report(*); end
-
-  private
-
-  def run_gc
-    GC.enable
-    GC.start
-    GC.disable
-  end
-end
+class GCSuite
+  def warming(*)
+    run_gc
+  end
+
+  def running(*)
+    run_gc
+  end
+
+  def warmup_stats(*); end
+
+  def add_report(*); end
+
+  private
+
+  def run_gc
+    GC.enable
+    GC.start
+    GC.disable
+  end
+end

data/spec/integration/embedded_in_polymorphic_spec.rb

@@ -1,112 +1,112 @@
-require 'spec_helper'
-
-describe Mongoid::History::Tracker do
-  before :each do
-    class RealState
-      include Mongoid::Document
-      include Mongoid::History::Trackable
-
-      field :name, type: String
-      belongs_to :user
-      embeds_one :address, class_name: 'Contact', as: :contactable
-      embeds_one :embone, as: :embedable
-
-      track_history
-    end
-
-    class Company
-      include Mongoid::Document
-      include Mongoid::History::Trackable
-
-      field :name
-      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
-
-      track_history
-    end
-
-    class Embone
-      include Mongoid::Document
-      include Mongoid::History::Trackable
-
-      field :name
-      embedded_in :embedable, polymorphic: true
-
-      track_history scope: :embedable
-    end
-
-    class Contact
-      include Mongoid::Document
-      include Mongoid::History::Trackable
-
-      field :address
-      field :city
-      field :state
-      embedded_in :contactable, polymorphic: true
-
-      track_history scope: %i[real_state company]
-    end
-
-    class User
-      include Mongoid::Document
-      has_many :companies, dependent: :destroy
-      has_many :real_states, dependent: :destroy
-    end
-  end
-
-  after :each do
-    Object.send(:remove_const, :RealState)
-    Object.send(:remove_const, :Company)
-    Object.send(:remove_const, :Embone)
-    Object.send(:remove_const, :Contact)
-    Object.send(:remove_const, :User)
-  end
-
-  let!(:user) { User.create! }
-
-  it 'tracks history for nested embedded documents with polymorphic relations' do
-    real_state = user.real_states.build(name: 'rs_name', modifier: user)
-    real_state.save!
-    real_state.build_address(address: 'Main Street #123', city: 'Highland Park', state: 'IL', modifier: user).save!
-    expect(real_state.history_tracks.count).to eq(2)
-    expect(real_state.address.history_tracks.count).to eq(1)
-
-    real_state.reload
-    real_state.address.update_attributes!(address: 'Second Street', modifier: user)
-    expect(real_state.history_tracks.count).to eq(3)
-    expect(real_state.address.history_tracks.count).to eq(2)
-    expect(real_state.history_tracks.last.action).to eq('update')
-
-    real_state.build_embone(name: 'Lorem ipsum', modifier: user).save!
-    expect(real_state.history_tracks.count).to eq(4)
-    expect(real_state.embone.history_tracks.count).to eq(1)
-    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', modifier: user)
-    company.save!
-    company.build_address(address: 'Main Street #456', city: 'Evanston', state: 'IL', modifier: user).save!
-    expect(company.history_tracks.count).to eq(2)
-    expect(company.address.history_tracks.count).to eq(1)
-
-    company.reload
-    company.address.update_attributes!(address: 'Second Street', modifier: user)
-    expect(company.history_tracks.count).to eq(3)
-    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', modifier: user).save!
-    expect(company.history_tracks.count).to eq(4)
-    expect(company.second_address.history_tracks.count).to eq(1)
-    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', modifier: user).save!
-    expect(company.history_tracks.count).to eq(5)
-    expect(company.embone.history_tracks.count).to eq(1)
-    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
+require 'spec_helper'
+
+describe Mongoid::History::Tracker do
+  before :each do
+    class RealState
+      include Mongoid::Document
+      include Mongoid::History::Trackable
+
+      field :name, type: String
+      belongs_to :user
+      embeds_one :address, class_name: 'Contact', as: :contactable
+      embeds_one :embone, as: :embedable
+
+      track_history
+    end
+
+    class Company
+      include Mongoid::Document
+      include Mongoid::History::Trackable
+
+      field :name
+      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
+
+      track_history
+    end
+
+    class Embone
+      include Mongoid::Document
+      include Mongoid::History::Trackable
+
+      field :name
+      embedded_in :embedable, polymorphic: true
+
+      track_history scope: :embedable
+    end
+
+    class Contact
+      include Mongoid::Document
+      include Mongoid::History::Trackable
+
+      field :address
+      field :city
+      field :state
+      embedded_in :contactable, polymorphic: true
+
+      track_history scope: %i[real_state company]
+    end
+
+    class User
+      include Mongoid::Document
+      has_many :companies, dependent: :destroy
+      has_many :real_states, dependent: :destroy
+    end
+  end
+
+  after :each do
+    Object.send(:remove_const, :RealState)
+    Object.send(:remove_const, :Company)
+    Object.send(:remove_const, :Embone)
+    Object.send(:remove_const, :Contact)
+    Object.send(:remove_const, :User)
+  end
+
+  let!(:user) { User.create! }
+
+  it 'tracks history for nested embedded documents with polymorphic relations' do
+    real_state = user.real_states.build(name: 'rs_name', modifier: user)
+    real_state.save!
+    real_state.build_address(address: 'Main Street #123', city: 'Highland Park', state: 'IL', modifier: user).save!
+    expect(real_state.history_tracks.count).to eq(2)
+    expect(real_state.address.history_tracks.count).to eq(1)
+
+    real_state.reload
+    real_state.address.update_attributes!(address: 'Second Street', modifier: user)
+    expect(real_state.history_tracks.count).to eq(3)
+    expect(real_state.address.history_tracks.count).to eq(2)
+    expect(real_state.history_tracks.last.action).to eq('update')
+
+    real_state.build_embone(name: 'Lorem ipsum', modifier: user).save!
+    expect(real_state.history_tracks.count).to eq(4)
+    expect(real_state.embone.history_tracks.count).to eq(1)
+    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', modifier: user)
+    company.save!
+    company.build_address(address: 'Main Street #456', city: 'Evanston', state: 'IL', modifier: user).save!
+    expect(company.history_tracks.count).to eq(2)
+    expect(company.address.history_tracks.count).to eq(1)
+
+    company.reload
+    company.address.update_attributes!(address: 'Second Street', modifier: user)
+    expect(company.history_tracks.count).to eq(3)
+    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', modifier: user).save!
+    expect(company.history_tracks.count).to eq(4)
+    expect(company.second_address.history_tracks.count).to eq(1)
+    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', modifier: user).save!
+    expect(company.history_tracks.count).to eq(5)
+    expect(company.embone.history_tracks.count).to eq(1)
+    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