paper_trail 4.0.0.beta2 → 4.0.0.rc1

data/spec/models/widget_spec.rb

@@ -121,8 +121,8 @@ describe Widget, :type => :model do
 
   describe "Methods" do
     describe "Instance", :versioning => true do
-      describe '#originator' do
-        it { is_expected.to respond_to(:originator) }
+      describe '#paper_trail_originator' do
+        it { is_expected.to respond_to(:paper_trail_originator) }
 
         describe "return value" do
           let(:orig_name) { Faker::Name.name }
@@ -133,9 +133,9 @@ describe Widget, :type => :model do
             specify { expect(widget).to be_live }
 
             it "should return the originator for the model at a given state" do
-              expect(widget.originator).to eq(orig_name)
+              expect(widget.paper_trail_originator).to eq(orig_name)
               widget.whodunnit(new_name) { |w| w.update_attributes(:name => 'Elizabeth') }
-              expect(widget.originator).to eq(new_name)
+              expect(widget.paper_trail_originator).to eq(new_name)
             end
           end
 
@@ -150,7 +150,7 @@ describe Widget, :type => :model do
               let(:reified_widget) { widget.versions[1].reify }
 
               it "should return the appropriate originator" do
-                expect(reified_widget.originator).to eq(orig_name)
+                expect(reified_widget.paper_trail_originator).to eq(orig_name)
               end
 
               it "should not create a new model instance" do
@@ -162,7 +162,7 @@ describe Widget, :type => :model do
               let(:reified_widget) { widget.versions[1].reify(:dup => true) }
 
               it "should return the appropriate originator" do
-                expect(reified_widget.originator).to eq(orig_name)
+                expect(reified_widget.paper_trail_originator).to eq(orig_name)
               end
 
               it "should not create a new model instance" do
@@ -173,6 +173,27 @@ describe Widget, :type => :model do
         end
       end
 
+      describe "#originator" do
+        subject { widget }
+
+        it { is_expected.to respond_to(:originator) }
+        let(:warning_msg) do
+          "DEPRECATED: use `paper_trail_originator` instead of `originator`." +
+          " Support for `originator` will be removed in PaperTrail 4.0"
+        end
+
+        it 'should set the invoke `paper_trail_originator`' do
+          is_expected.to receive(:warn)
+          is_expected.to receive(:paper_trail_originator)
+          subject.originator
+        end
+
+        it 'should display a deprecation warning' do
+          is_expected.to receive(:warn).with(warning_msg)
+          subject.originator
+        end
+      end
+
       describe '#version_at' do
         it { is_expected.to respond_to(:version_at) }
 

data/spec/modules/paper_trail_spec.rb

@@ -0,0 +1,27 @@
+require 'rails_helper'
+
+describe PaperTrail, :type => :module, :versioning => true do
+  describe '#config' do
+    it { is_expected.to respond_to(:config) }
+
+    it "should allow for config values to be set" do
+      expect(subject.config.enabled).to eq(true)
+      subject.config.enabled = false
+      expect(subject.config.enabled).to eq(false)
+    end
+
+    it "should accept blocks and yield the config instance" do
+      expect(subject.config.enabled).to eq(true)
+      subject.config { |c| c.enabled = false }
+      expect(subject.config.enabled).to eq(false)
+    end
+  end
+
+  describe '#configure' do
+    it { is_expected.to respond_to(:configure) }
+
+    it "should be an alias for the `config` method" do
+      expect(subject.method(:configure)).to eq(subject.method(:config))
+    end
+  end
+end

data/spec/requests/articles_spec.rb

@@ -9,7 +9,6 @@ describe "Articles management", :type => :request, :order => :defined do
     it "should not create a version" do
       expect(PaperTrail).to be_enabled_for_controller
       expect { post(articles_path, valid_params) }.to_not change(PaperTrail::Version, :count)
-      expect(PaperTrail).not_to be_enabled_for_controller
     end
 
     it "should not leak the state of the `PaperTrail.enabled_for_controller?` into the next test" do
@@ -24,7 +23,6 @@ describe "Articles management", :type => :request, :order => :defined do
       it "should set that value as the `whodunnit`" do
         expect { post articles_path, valid_params }.to change(PaperTrail::Version, :count).by(1)
         expect(article.title).to eq('Doh')
-        expect(PaperTrail.whodunnit).to eq('foobar')
         expect(article.versions.last.whodunnit).to eq('foobar')
       end
     end

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

@@ -1,4 +1,6 @@
 class Animal < ActiveRecord::Base
   has_paper_trail
   self.inheritance_column = 'species'
+
+  attr_accessible :species, :name if ::PaperTrail.active_record_protected_attributes?
 end

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

@@ -0,0 +1,4 @@
+class Boolit < ActiveRecord::Base
+  default_scope { where(:scoped => true) }
+  has_paper_trail
+end

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

@@ -0,0 +1,5 @@
+class Fruit < ActiveRecord::Base
+  if ENV['DB'] == 'postgres' || JsonVersion.table_exists?
+    has_paper_trail :class_name => 'JsonVersion'
+  end
+end

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

@@ -1,6 +1,7 @@
 # Example from 'Overwriting default accessors' in ActiveRecord::Base.
 class Song < ActiveRecord::Base
   has_paper_trail
+  attr_accessor :name
 
   # Uses an integer of seconds to hold the length of the song
   def length=(minutes)
@@ -9,4 +10,23 @@ class Song < ActiveRecord::Base
   def length
     read_attribute(:length) / 60
   end
+
+  # override attributes hashes like some libraries do
+  def attributes_with_name
+    if name
+      attributes_without_name.merge(:name => name)
+    else
+      attributes_without_name
+    end
+  end
+  alias_method_chain :attributes, :name
+
+  def changed_attributes_with_name
+    if name
+      changed_attributes_without_name.merge(:name => name)
+    else
+      changed_attributes_without_name
+    end
+  end
+  alias_method_chain :changed_attributes, :name
 end

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

@@ -0,0 +1,3 @@
+class Thing < ActiveRecord::Base
+  has_paper_trail :save_changes => false
+end

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

@@ -0,0 +1,4 @@
+class Whatchamajigger < ActiveRecord::Base
+  has_paper_trail
+  belongs_to :owner, :polymorphic => true
+end

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

@@ -1,6 +1,7 @@
 class Widget < ActiveRecord::Base
   has_paper_trail
   has_one :wotsit
+  has_many :whatchamajiggers, :as => :owner
 
   EXCLUDED_NAME = 'Biglet'
 

data/test/dummy/app/versions/json_version.rb

@@ -0,0 +1,3 @@
+class JsonVersion < PaperTrail::Version
+  self.table_name = 'json_versions'
+end

data/test/dummy/config/initializers/paper_trail.rb

@@ -1,3 +1,6 @@
+# Turn on associations tracking when the test suite is run on Travis CI
+PaperTrail.config.track_associations = true if ENV['TRAVIS']
+
 module PaperTrail
   class Version < ActiveRecord::Base
     attr_accessible :answer, :action, :question, :article_id, :ip, :user_agent, :title if ::PaperTrail.active_record_protected_attributes?

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

@@ -12,7 +12,7 @@ class SetUpTestTables < ActiveRecord::Migration
       t.boolean   :a_boolean
       t.string    :sacrificial_column
       t.string    :type
-      t.timestamps
+      t.timestamps :null => true
     end
 
     create_table :versions, :force => true do |t|
@@ -60,10 +60,23 @@ class SetUpTestTables < ActiveRecord::Migration
     end
     add_index :post_versions, [:item_type, :item_id]
 
+    if ENV['DB'] == 'postgres' && ::ActiveRecord::VERSION::MAJOR >= 4
+      create_table :json_versions, :force => true do |t|
+        t.string   :item_type, :null => false
+        t.integer  :item_id,   :null => false
+        t.string   :event,     :null => false
+        t.string   :whodunnit
+        t.json     :object
+        t.json     :object_changes
+        t.datetime :created_at
+      end
+      add_index :json_versions, [:item_type, :item_id]
+    end
+
     create_table :wotsits, :force => true do |t|
       t.integer :widget_id
       t.string  :name
-      t.timestamps
+      t.timestamps :null => true
     end
 
     create_table :fluxors, :force => true do |t|
@@ -71,6 +84,12 @@ class SetUpTestTables < ActiveRecord::Migration
       t.string  :name
     end
 
+    create_table :whatchamajiggers, :force => true do |t|
+      t.string  :owner_type
+      t.integer :owner_id
+      t.string  :name
+    end
+
     create_table :articles, :force => true do |t|
       t.string :title
       t.string :content
@@ -128,6 +147,10 @@ class SetUpTestTables < ActiveRecord::Migration
       t.integer   :version
     end
 
+    create_table :things, :force => true do |t|
+      t.string    :name
+    end
+
     create_table :translations, :force => true do |t|
       t.string    :headline
       t.string    :content
@@ -138,7 +161,7 @@ class SetUpTestTables < ActiveRecord::Migration
     create_table :gadgets, :force => true do |t|
       t.string    :name
       t.string    :brand
-      t.timestamps
+      t.timestamps :null => true
     end
 
     create_table :customers, :force => true do |t|
@@ -154,6 +177,16 @@ class SetUpTestTables < ActiveRecord::Migration
       t.integer :order_id
       t.string  :product
     end
+
+    create_table :fruits, :force => true do |t|
+      t.string :name
+      t.string :color
+    end
+
+    create_table :boolits, :force => true do |t|
+      t.string :name
+      t.boolean :scoped, :default => true
+    end
   end
 
   def self.down
@@ -166,20 +199,28 @@ class SetUpTestTables < ActiveRecord::Migration
     drop_table :authorships
     drop_table :books
     drop_table :articles
+    drop_table :whatchamajiggers
     drop_table :fluxors
     drop_table :wotsits
     remove_index :post_versions, :column => [:item_type, :item_id]
     drop_table :post_versions
     remove_index :versions, :column => [:item_type, :item_id]
     drop_table :versions
+    if JsonVersion.table_exists?
+      remove_index :json_versions, :column => [:item_type, :item_id]
+      drop_table :json_versions
+    end
     drop_table :widgets
     drop_table :documents
     drop_table :legacy_widgets
+    drop_table :things
     drop_table :translations
     drop_table :gadgets
     drop_table :customers
     drop_table :orders
     drop_table :line_items
+    drop_table :fruits
+    drop_table :boolits
     remove_index :version_associations, :column => [:version_id]
     remove_index :version_associations, :name => 'index_version_associations_on_foreign_key'
     drop_table :version_associations

data/test/dummy/db/schema.rb

@@ -84,12 +84,11 @@ ActiveRecord::Schema.define(version: 20110208155312) do
   end
 
   create_table "post_versions", force: true do |t|
-    t.string   "item_type",      null: false
-    t.integer  "item_id",        null: false
-    t.string   "event",          null: false
+    t.string   "item_type",  null: false
+    t.integer  "item_id",    null: false
+    t.string   "event",      null: false
     t.string   "whodunnit"
     t.text     "object"
-    t.integer  "transaction_id"
     t.datetime "created_at"
     t.string   "ip"
     t.string   "user_agent"
@@ -110,6 +109,10 @@ ActiveRecord::Schema.define(version: 20110208155312) do
     t.integer "length"
   end
 
+  create_table "things", force: true do |t|
+    t.string "name"
+  end
+
   create_table "translations", force: true do |t|
     t.string "headline"
     t.string "content"
@@ -146,6 +149,12 @@ ActiveRecord::Schema.define(version: 20110208155312) do
 
   add_index "versions", ["item_type", "item_id"], name: "index_versions_on_item_type_and_item_id"
 
+  create_table "whatchamajiggers", force: true do |t|
+    t.string  "owner_type"
+    t.integer "owner_id"
+    t.string  "name"
+  end
+
   create_table "widgets", force: true do |t|
     t.string   "name"
     t.text     "a_text"

data/test/functional/controller_test.rb

@@ -7,8 +7,10 @@ class ControllerTest < ActionController::TestCase
     @request.env['REMOTE_ADDR'] = '127.0.0.1'
   end
 
+  # Mimick what RequestStore will do outside of the test env, since it is
+  # middleware, and doesn't get executed in controller / request specs
   teardown do
-    PaperTrail.enabled_for_controller = true
+    RequestStore.store[:paper_trail] = nil
   end
 
   test 'disable on create' do
@@ -82,7 +84,7 @@ class ControllerTest < ActionController::TestCase
     @request.env['HTTP_USER_AGENT'] = 'Disable User-Agent'
     post :create, :widget => { :name => 'Flugel' }
     assert_equal 0, assigns(:widget).versions.length
-    assert !PaperTrail.enabled_for_controller?    
+    assert !PaperTrail.enabled_for_controller?
     assert PaperTrail.whodunnit.nil?
     assert PaperTrail.controller_info.nil?
   end

data/test/unit/model_test.rb

@@ -218,8 +218,8 @@ class HasPaperTrailModelTest < ActiveSupport::TestCase
 
       should 'have changes' do
 
-        #TODO Postgres does not appear to pass back ActiveSupport::TimeWithZone, 
-        # so chosing the lowest common denominator to test. 
+        #TODO Postgres does not appear to pass back ActiveSupport::TimeWithZone,
+        # so chosing the lowest common denominator to test.
 
         changes = {
           'name'       => [nil, 'Henry'],
@@ -332,6 +332,31 @@ class HasPaperTrailModelTest < ActiveSupport::TestCase
           end
         end
 
+        context 'and has many associated polymorphic objects' do
+          setup do
+            @f0 = @widget.whatchamajiggers.create :name => 'f-zero'
+            @f1 = @widget.whatchamajiggers.create :name => 'f-zero'
+            @reified_widget = @widget.versions.last.reify
+          end
+
+          should 'copy the has_many associations when reifying' do
+            assert_equal @widget.whatchamajiggers.length, @reified_widget.whatchamajiggers.length
+            assert_same_elements @widget.whatchamajiggers, @reified_widget.whatchamajiggers
+
+            assert_equal @widget.versions.length, @reified_widget.versions.length
+            assert_same_elements @widget.versions, @reified_widget.versions
+          end
+        end
+
+        context 'polymorphic objects by themselves' do
+          setup do
+            @widget = Whatchamajigger.new :name => 'f-zero'
+          end
+
+          should 'not fail with a nil pointer on the polymorphic association' do
+            @widget.save!
+          end
+        end
 
         context 'and then destroyed' do
           setup do
@@ -446,7 +471,7 @@ class HasPaperTrailModelTest < ActiveSupport::TestCase
         @last = @widget.versions.last
       end
 
-      teardown do 
+      teardown do
         restore_schema
       end
 
@@ -571,9 +596,9 @@ class HasPaperTrailModelTest < ActiveSupport::TestCase
 
       should 'track who made the change' do
         assert_equal 'Alice', @version.whodunnit
-        assert_nil   @version.originator
+        assert_nil   @version.paper_trail_originator
         assert_equal 'Alice', @version.terminator
-        assert_equal 'Alice', @widget.originator
+        assert_equal 'Alice', @widget.paper_trail_originator
       end
 
       context 'when a record is updated' do
@@ -585,9 +610,9 @@ class HasPaperTrailModelTest < ActiveSupport::TestCase
 
         should 'track who made the change' do
           assert_equal 'Bob',   @version.whodunnit
-          assert_equal 'Alice', @version.originator
+          assert_equal 'Alice', @version.paper_trail_originator
           assert_equal 'Bob',   @version.terminator
-          assert_equal 'Bob',   @widget.originator
+          assert_equal 'Bob',   @widget.paper_trail_originator
         end
 
         context 'when a record is destroyed' do
@@ -599,9 +624,9 @@ class HasPaperTrailModelTest < ActiveSupport::TestCase
 
           should 'track who made the change' do
             assert_equal 'Charlie', @version.whodunnit
-            assert_equal 'Bob',     @version.originator
+            assert_equal 'Bob',     @version.paper_trail_originator
             assert_equal 'Charlie', @version.terminator
-            assert_equal 'Charlie', @widget.originator
+            assert_equal 'Charlie', @widget.paper_trail_originator
           end
         end
       end
@@ -620,7 +645,6 @@ class HasPaperTrailModelTest < ActiveSupport::TestCase
       assert_not_nil @wotsit.versions.last.reify.updated_at
     end
 
-    # Currently the gem generates a bunch of deprecation warnings about serialized attributes on AR 4.2
     should 'not generate warning' do
       # Tests that it doesn't try to write created_on as an attribute just because a created_on
       # method exists.
@@ -651,7 +675,7 @@ class HasPaperTrailModelTest < ActiveSupport::TestCase
     should 'should return the correct originator' do
       PaperTrail.whodunnit = 'Ben'
       @foo.update_attribute(:name, 'Geoffrey')
-      assert_equal PaperTrail.whodunnit, @foo.originator
+      assert_equal PaperTrail.whodunnit, @foo.paper_trail_originator
     end
 
     context 'when destroyed' do
@@ -1102,6 +1126,21 @@ class HasPaperTrailModelTest < ActiveSupport::TestCase
     should 'return "overwritten" value on reified instance' do
       assert_equal 4, @song.versions.last.reify.length
     end
+
+    context 'Has a virtual attribute injected into the ActiveModel::Dirty changes' do
+      setup do
+        @song.name = 'Good Vibrations'
+        @song.save
+        @song.name = 'Yellow Submarine'
+      end
+
+      should 'return persist the changes on the live instance properly' do
+        assert_equal 'Yellow Submarine', @song.name
+      end
+      should 'return "overwritten" virtual attribute on the reified instance' do
+        assert_equal 'Good Vibrations', @song.versions.last.reify.name
+      end
+    end
   end
 
 
@@ -1189,6 +1228,31 @@ class HasPaperTrailModelTest < ActiveSupport::TestCase
         assert_equal 'destroy', @fluxor.versions.last.event
       end
     end
+    context 'on []' do
+      setup do
+        Fluxor.reset_callbacks :create
+        Fluxor.reset_callbacks :update
+        Fluxor.reset_callbacks :destroy
+        Fluxor.instance_eval <<-END
+          has_paper_trail :on => []
+        END
+        @fluxor = Fluxor.create
+        @fluxor.update_attributes :name => 'blah'
+      end
+
+      teardown do
+        @fluxor.destroy
+      end
+
+      should 'not have any versions' do
+        assert_equal 0, @fluxor.versions.length
+      end
+
+      should 'still respond to touch_with_version' do
+        @fluxor.touch_with_version
+        assert_equal 1, @fluxor.versions.length
+      end
+    end
     context 'allows a symbol to be passed' do
       setup do
         Fluxor.reset_callbacks :create
@@ -1838,4 +1902,4 @@ class HasPaperTrailModelTransactionalTest < ActiveSupport::TestCase
       end
     end
   end
-end
+end

data/test/unit/serializer_test.rb

@@ -10,7 +10,7 @@ class SerializerTest < ActiveSupport::TestCase
       END
 
       @fluxor = Fluxor.create :name => 'Some text.'
-      @original_fluxor_attributes = @fluxor.send(:item_before_change).attributes # this is exactly what PaperTrail serializes
+      @original_fluxor_attributes = @fluxor.send(:attributes_before_change) # this is exactly what PaperTrail serializes
       @fluxor.update_attributes :name => 'Some more text.'
     end
 
@@ -41,7 +41,7 @@ class SerializerTest < ActiveSupport::TestCase
       END
 
       @fluxor = Fluxor.create :name => 'Some text.'
-      @original_fluxor_attributes = @fluxor.send(:item_before_change).attributes # this is exactly what PaperTrail serializes
+      @original_fluxor_attributes = @fluxor.send(:attributes_before_change) # this is exactly what PaperTrail serializes
       @fluxor.update_attributes :name => 'Some more text.'
     end
 
@@ -83,7 +83,7 @@ class SerializerTest < ActiveSupport::TestCase
       END
 
       @fluxor = Fluxor.create
-      @original_fluxor_attributes = @fluxor.send(:item_before_change).attributes.reject { |k,v| v.nil? } # this is exactly what PaperTrail serializes
+      @original_fluxor_attributes = @fluxor.send(:attributes_before_change).reject { |k,v| v.nil? } # this is exactly what PaperTrail serializes
       @fluxor.update_attributes :name => 'Some more text.'
     end