paper_trail 3.0.5 → 3.0.6

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 3ee3ec4b4dd8dfad13cbe5e9b46ccfa30f3318a3
-  data.tar.gz: 20559b46236a0318c4b7e2eb940bfbd79600cfad
+  metadata.gz: 342a6b8d2c4c6685107d14ae36f6711d7fe09d78
+  data.tar.gz: f7d83394a6bb503a898509b26e9adf0f712c1dfb
 SHA512:
-  metadata.gz: 6cf548b9641d5994bf67b3e886d4ed60fed0d6d16e9134e6374ca8ecaaa7ff3662fd4d97684e2bd1b59cffa710f1e19a58c0d4679433483dcd471fdc4ef201ad
-  data.tar.gz: 3ae713d8799f7ce5b95b5787134eeaf3aada506b1c71a89d3e25e3703c1fbc5a809f183e0a62c521c65f473312261e5049843d01a54166243ddac7a994120332
+  metadata.gz: d240d05e510adf0a4e178a27cda8e490b99750384a15af935daa6019f02f8ce944c7894fdea76fb970a07dde7bdbbf62de8c314a24f5684f961d8da949fe3b64
+  data.tar.gz: 078716e13039aebf41ea3c10e78180e78d1879ab30095a39298678bb88e6e5659a760f67449cbffee22492419943988df53eac04417fd8da8259804a08fe4732

data/CHANGELOG.md

@@ -1,11 +1,17 @@
+## 3.0.6
+
+  - [#414](https://github.com/airblade/paper_trail/issues/414) - Fix functionality `ignore` argument to `has_paper_trail`
+    in `ActiveRecord` 4.
+
 ## 3.0.5
 
   - [#401](https://github.com/airblade/paper_trail/issues/401) / [#406](https://github.com/airblade/paper_trail/issues/406)
     `PaperTrail::Version` class is not loaded via a `Rails::Engine`, even when the gem is used with in Rails. This feature has
     will be re-introduced in version `3.1.0`.
+  - [#398](https://github.com/airblade/paper_trail/pull/398) - Only require the `RSpec` helper if `RSpec::Core` is required.
 
 ## 3.0.3
-*This version was yanked from RubyGems and has been replaced by version `3.0.5`, which is identical but does not eager load
+*This version was yanked from RubyGems and has been replaced by version `3.0.5`, which is almost identical, but does not eager load
 in the `PaperTrail::Version` class through a `Rails::Engine` when the gem is used on Rails since it was causing issues for some users.*
 
   - [#386](https://github.com/airblade/paper_trail/issues/386) - Fix eager loading of `versions` association with custom class name

data/README.md

@@ -1,4 +1,4 @@
-# PaperTrail [![Build Status](https://img.shields.io/travis/airblade/paper_trail/master.svg)](https://travis-ci.org/airblade/paper_trail) [![Dependency Status](https://img.shields.io/gemnasium/airblade/paper_trail.svg)](https://gemnasium.com/airblade/paper_trail)
+# PaperTrail [![Build Status](https://travis-ci.org/airblade/paper_trail.svg?branch=3.0-stable)](https://travis-ci.org/airblade/paper_trail) [![Dependency Status](https://img.shields.io/gemnasium/airblade/paper_trail.svg)](https://gemnasium.com/airblade/paper_trail)
 
 PaperTrail lets you track changes to your models' data.  It's good for auditing or versioning.  You can see how a model looked at any stage in its lifecycle, revert it to any version, and even undelete it after it's been destroyed.
 
@@ -42,7 +42,7 @@ The Rails 2.3 code is on the [`rails2`](https://github.com/airblade/paper_trail/
 
 1. Add PaperTrail to your `Gemfile`.
 
-    `gem 'paper_trail', '~> 3.0.5'`
+    `gem 'paper_trail', '~> 3.0.6'`
 
 2. Generate a migration which will add a `versions` table to your database.
 
@@ -64,7 +64,7 @@ your applications `ActiveRecord` connection in a manner similar to the way `Rail
 
 1. Add PaperTrail to your `Gemfile`.
 
-    `gem 'paper_trail', '~> 3.0.5'`
+    `gem 'paper_trail', '~> 3.0.6'`
 
 2. Generate a migration to add a `versions` table to your database.
 

data/lib/paper_trail/has_paper_trail.rb

@@ -360,8 +360,16 @@ module PaperTrail
         end
       end
 
+      # This method is invoked in order to determine whether it is appropriate to generate a new version instance.
+      # In ActiveRecord 4, the way ActiveModel::Dirty handles the `changes` hash has changed so that
+      # `timestamp_attributes_for_update` get inserted PRIOR to the persistence happening, so we must accomodate
+      # this by checking to ensure attributes other than those ignored and update timestamps are really being modified.
       def changed_notably?
-        notably_changed.any?
+        if self.paper_trail_options[:ignore].any? && (changed & self.paper_trail_options[:ignore]).any?
+          (notably_changed - timestamp_attributes_for_update_in_model.map(&:to_s)).any?
+        else
+          notably_changed.any?
+        end
       end
 
       def notably_changed

data/lib/paper_trail/version_number.rb

@@ -2,7 +2,7 @@ module PaperTrail
   module VERSION
     MAJOR = 3
     MINOR = 0
-    TINY  = 5
+    TINY  = 6
     PRE   = nil
 
     STRING = [MAJOR, MINOR, TINY, PRE].compact.join('.')

data/spec/models/gadget_spec.rb

@@ -0,0 +1,68 @@
+require 'spec_helper'
+
+describe Gadget do
+  it { should be_versioned }
+
+  let(:gadget) { Gadget.create!(:name => 'Wrench', :brand => 'Acme') }
+
+  describe "updates", :versioning => true do
+    it "should generate a version for updates to `name` attribute" do
+      expect { gadget.update_attribute(:name, 'Hammer').to change{gadget.versions.size}.by(1) }
+    end
+
+    it "should ignore for updates to `brand` attribute" do
+      expect { gadget.update_attribute(:brand, 'Stanley') }.to_not change{gadget.versions.size}
+    end
+
+    it "should still generate a version when only the `updated_at` attribute is updated" do
+      expect { gadget.update_attribute(:updated_at, Time.now) }.to change{gadget.versions.size}.by(1)
+    end
+  end
+
+  describe "Methods" do
+    describe "Instance", :versioning => true do
+      describe "private" do
+        describe :changed_notably? do
+          subject { Gadget.new(:created_at => Time.now) }
+
+          # apparently the private methods list in Ruby18 is different than in Ruby19+
+          if RUBY_VERSION.to_f >= 1.9
+            its(:private_methods) { should include(:changed_notably?) }
+          end
+
+          context "create events" do
+            it { subject.send(:changed_notably?).should == true }
+          end
+
+          context "update events" do
+            before { subject.save! }
+
+            context "without update timestamps" do
+              it "should only acknowledge non-ignored attrs" do
+                subject.name = 'Wrench'
+                subject.send(:changed_notably?).should == true
+              end
+
+              it "should not acknowledge ignored attrs and timestamps only" do
+                subject.brand = 'Acme'
+                subject.send(:changed_notably?).should == false
+              end
+            end
+
+            context "with update timestamps" do
+              it "should only acknowledge non-ignored attrs" do
+                subject.name, subject.updated_at = 'Wrench', Time.now
+                subject.send(:changed_notably?).should == true
+              end
+
+              it "should not acknowledge ignored attrs and timestamps only" do
+                subject.brand, subject.updated_at = 'Acme', Time.now
+                subject.send(:changed_notably?).should == false
+              end
+            end
+          end
+        end
+      end
+    end
+  end
+end

data/test/dummy/app/models/gadget.rb

@@ -0,0 +1,3 @@
+class Gadget < ActiveRecord::Base
+  has_paper_trail :ignore => :brand
+end

data/test/dummy/db/migrate/20110208155312_set_up_test_tables.rb

@@ -116,6 +116,12 @@ class SetUpTestTables < ActiveRecord::Migration
       t.string    :language_code
       t.string    :type
     end
+
+    create_table :gadgets, :force => true do |t|
+      t.string    :name
+      t.string    :brand
+      t.timestamps
+    end
   end
 
   def self.down
@@ -136,5 +142,6 @@ class SetUpTestTables < ActiveRecord::Migration
     drop_table :documents
     drop_table :legacy_widgets
     drop_table :translations
+    drop_table :gadgets
   end
 end

data/test/unit/model_test.rb

@@ -224,7 +224,7 @@ class HasPaperTrailModelTest < ActiveSupport::TestCase
           'id'         => [nil, @widget.id]
         }
 
-        assert_equal "Time", @widget.versions.last.changeset['updated_at'][1].class.to_s
+        assert_equal Time, @widget.versions.last.changeset['updated_at'][1].class
         assert_equal changes, @widget.versions.last.changeset
       end
 

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: paper_trail
 version: !ruby/object:Gem::Version
-  version: 3.0.5
+  version: 3.0.6
 platform: ruby
 authors:
 - Andy Stewart
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-08-30 00:00:00.000000000 Z
+date: 2014-10-09 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activerecord
@@ -263,6 +263,7 @@ files:
 - lib/paper_trail/version_number.rb
 - paper_trail.gemspec
 - spec/generators/install_generator_spec.rb
+- spec/models/gadget_spec.rb
 - spec/models/joined_version_spec.rb
 - spec/models/post_with_status_spec.rb
 - spec/models/version_spec.rb
@@ -290,6 +291,7 @@ files:
 - test/dummy/app/models/elephant.rb
 - test/dummy/app/models/fluxor.rb
 - test/dummy/app/models/foo_widget.rb
+- test/dummy/app/models/gadget.rb
 - test/dummy/app/models/legacy_widget.rb
 - test/dummy/app/models/person.rb
 - test/dummy/app/models/post.rb
@@ -378,6 +380,7 @@ specification_version: 4
 summary: Track changes to your models' data. Good for auditing or versioning.
 test_files:
 - spec/generators/install_generator_spec.rb
+- spec/models/gadget_spec.rb
 - spec/models/joined_version_spec.rb
 - spec/models/post_with_status_spec.rb
 - spec/models/version_spec.rb
@@ -405,6 +408,7 @@ test_files:
 - test/dummy/app/models/elephant.rb
 - test/dummy/app/models/fluxor.rb
 - test/dummy/app/models/foo_widget.rb
+- test/dummy/app/models/gadget.rb
 - test/dummy/app/models/legacy_widget.rb
 - test/dummy/app/models/person.rb
 - test/dummy/app/models/post.rb