paper_trail 2.6.3 → 2.6.4

data/lib/paper_trail.rb

@@ -1,4 +1,3 @@
-require 'singleton'
 require 'yaml'
 
 require 'paper_trail/config'

data/lib/paper_trail/config.rb

@@ -1,3 +1,5 @@
+require 'singleton'
+
 module PaperTrail
   class Config
     include Singleton

data/lib/paper_trail/controller.rb

@@ -2,16 +2,15 @@ module PaperTrail
   module Controller
 
     def self.included(base)
-      base.before_filter :set_paper_trail_whodunnit
-      base.before_filter :set_paper_trail_controller_info
       base.before_filter :set_paper_trail_enabled_for_controller
+      base.before_filter :set_paper_trail_whodunnit, :set_paper_trail_controller_info
     end
 
     protected
 
     # Returns the user who is responsible for any changes that occur.
     # By default this calls `current_user` and returns the result.
-    # 
+    #
     # Override this method in your controller to call a different
     # method, e.g. `current_person`, or anything you like.
     def user_for_paper_trail
@@ -57,7 +56,7 @@ module PaperTrail
 
     # Tells PaperTrail who is responsible for any changes that occur.
     def set_paper_trail_whodunnit
-      ::PaperTrail.whodunnit = user_for_paper_trail
+      ::PaperTrail.whodunnit = user_for_paper_trail if paper_trail_enabled_for_controller
     end
 
     # DEPRECATED: please use `set_paper_trail_whodunnit` instead.
@@ -69,7 +68,7 @@ module PaperTrail
     # Tells PaperTrail any information from the controller you want
     # to store alongside any changes that occur.
     def set_paper_trail_controller_info
-      ::PaperTrail.controller_info = info_for_paper_trail
+      ::PaperTrail.controller_info = info_for_paper_trail if paper_trail_enabled_for_controller
     end
 
   end

data/lib/paper_trail/has_paper_trail.rb

@@ -41,23 +41,15 @@ module PaperTrail
         class_attribute :version_class_name
         self.version_class_name = options[:class_name] || 'Version'
 
-        class_attribute :ignore
-        self.ignore = ([options[:ignore]].flatten.compact || []).map &:to_s
+        class_attribute :paper_trail_options
+        self.paper_trail_options = options.dup
 
-        class_attribute :if_condition
-        self.if_condition = options[:if]
-
-        class_attribute :unless_condition
-        self.unless_condition = options[:unless]
-
-        class_attribute :skip
-        self.skip = ([options[:skip]].flatten.compact || []).map &:to_s
-
-        class_attribute :only
-        self.only = ([options[:only]].flatten.compact || []).map &:to_s
+        [:ignore, :skip, :only].each do |k|
+          paper_trail_options[k] =
+            ([paper_trail_options[k]].flatten.compact || []).map &:to_s
+        end
 
-        class_attribute :meta
-        self.meta = options[:meta] || {}
+        paper_trail_options[:meta] ||= {}
 
         class_attribute :paper_trail_enabled_for_model
         self.paper_trail_enabled_for_model = true
@@ -68,11 +60,15 @@ module PaperTrail
         has_many self.versions_association_name,
                  :class_name => version_class_name,
                  :as         => :item,
-                 :order      => "#{PaperTrail.timestamp_field} ASC, #{self.version_class_name.constantize.primary_key} ASC"
+                 :order      => "#{PaperTrail.timestamp_field} ASC, #{self.version_key} ASC"
 
         after_create  :record_create, :if => :save_version? if !options[:on] || options[:on].include?(:create)
         before_update :record_update, :if => :save_version? if !options[:on] || options[:on].include?(:update)
-        after_destroy :record_destroy if !options[:on] || options[:on].include?(:destroy)
+        after_destroy :record_destroy, :if => :save_version? if !options[:on] || options[:on].include?(:destroy)
+      end
+
+      def version_key
+        self.version_class_name.constantize.primary_key
       end
 
       # Switches PaperTrail off for this class.
@@ -97,7 +93,7 @@ module PaperTrail
 
       # Returns who put the object into its current state.
       def originator
-        version_class.with_item_keys(self.class.name, id).last.try :whodunnit
+        version_class.with_item_keys(self.class.base_class.name, id).last.try :whodunnit
       end
 
       # Returns the object (not a Version) as it was at the given timestamp.
@@ -149,7 +145,17 @@ module PaperTrail
 
       def record_create
         if switched_on?
-          send(self.class.versions_association_name).create merge_metadata(:event => 'create', :whodunnit => PaperTrail.whodunnit)
+          data = {
+            :event     => 'create',
+            :whodunnit => PaperTrail.whodunnit
+          }
+
+          if changed_notably? and version_class.column_names.include?('object_changes')
+            # The double negative (reject, !include?) preserves the hash structure of self.changes.
+            data[:object_changes] = self.changes.reject { |k, _| !notably_changed.include?(k) }.to_yaml
+          end
+
+          send(self.class.versions_association_name).create merge_metadata(data)
         end
       end
 
@@ -183,12 +189,17 @@ module PaperTrail
 
       def merge_metadata(data)
         # First we merge the model-level metadata in `meta`.
-        meta.each do |k,v|
+        paper_trail_options[:meta].each do |k,v|
           data[k] =
             if v.respond_to?(:call)
               v.call(self)
             elsif v.is_a?(Symbol) && respond_to?(v)
-              send(v)
+              # if it is an attribute that is changing, be sure to grab the current version
+              if has_attribute?(v) && send("#{v}_changed?".to_sym)
+                send("#{v}_was".to_sym)
+              else
+                send(v)
+              end
             else
               v
             end
@@ -210,7 +221,7 @@ module PaperTrail
       end
 
       def object_to_string(object)
-        object.attributes.except(*self.class.skip).to_yaml
+        object.attributes.except(*self.class.paper_trail_options[:skip]).to_yaml
       end
 
       def changed_notably?
@@ -218,11 +229,14 @@ module PaperTrail
       end
 
       def notably_changed
-        self.class.only.empty? ? changed_and_not_ignored : (changed_and_not_ignored & self.class.only)
+        only = self.class.paper_trail_options[:only]
+        only.empty? ? changed_and_not_ignored : (changed_and_not_ignored & only)
       end
 
       def changed_and_not_ignored
-        changed - self.class.ignore - self.class.skip
+        ignore = self.class.paper_trail_options[:ignore]
+        skip   = self.class.paper_trail_options[:skip]
+        changed - ignore - skip
       end
 
       def switched_on?
@@ -230,6 +244,8 @@ module PaperTrail
       end
 
       def save_version?
+        if_condition     = self.class.paper_trail_options[:if]
+        unless_condition = self.class.paper_trail_options[:unless]
         (if_condition.blank? || if_condition.call(self)) && !unless_condition.try(:call, self)
       end
     end

data/lib/paper_trail/version_number.rb

@@ -1,3 +1,3 @@
 module PaperTrail
-  VERSION = '2.6.3'
+  VERSION = '2.6.4'
 end

data/paper_trail.gemspec

@@ -19,7 +19,7 @@ Gem::Specification.new do |s|
   s.add_dependency 'activerecord', '~> 3.0'
 
   s.add_development_dependency 'rake'
-  s.add_development_dependency 'shoulda',      '2.10.3'
+  s.add_development_dependency 'shoulda',      '~> 3.3'
   s.add_development_dependency 'sqlite3',      '~> 1.2'
-  s.add_development_dependency 'capybara',     '~> 1.0.0'
+  s.add_development_dependency 'capybara',     '~> 2.0'
 end

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

@@ -2,10 +2,13 @@ class Article < ActiveRecord::Base
   has_paper_trail :ignore => :title,
                   :only => [:content],
                   :skip => [:file_upload],
-                  :meta   => {:answer => 42,
+                  :meta => {
+                              :answer => 42,
                               :action => :action_data_provider_method,
                               :question => Proc.new { "31 + 11 = #{31 + 11}" },
-                              :article_id => Proc.new { |article| article.id } }
+                              :article_id => Proc.new { |article| article.id },
+                              :title => :title
+                            }
 
   def action_data_provider_method
     self.object_id.to_s

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

@@ -29,6 +29,7 @@ class SetUpTestTables < ActiveRecord::Migration
       t.string :action
       t.string  :question
       t.integer :article_id
+      t.string :title
 
       # Controller info columns.
       t.string :ip

data/test/functional/controller_test.rb

@@ -68,4 +68,23 @@ class ControllerTest < ActionController::TestCase
     assert_equal '127.0.0.1',     versions_for_widget.last.ip
     assert_equal 'Rails Testing', versions_for_widget.last.user_agent
   end
+
+  test "controller metadata methods should get evaluated if paper trail is enabled for controller" do
+    @request.env['HTTP_USER_AGENT'] = 'User-Agent'
+    post :create, :widget => { :name => 'Flugel' }
+    assert PaperTrail.enabled_for_controller?
+    assert_equal 153, PaperTrail.whodunnit
+    assert PaperTrail.controller_info.present?
+    assert PaperTrail.controller_info.keys.include?(:ip)
+    assert PaperTrail.controller_info.keys.include?(:user_agent)
+  end
+
+  test "controller metadata methods should not get evaluated if paper trail is disabled for controller" do
+    @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.whodunnit.nil?
+    assert PaperTrail.controller_info.nil?
+  end
 end

data/test/test_helper.rb

@@ -45,5 +45,5 @@ end
 
 class Version < ActiveRecord::Base
   attr_accessible :created_at, :updated_at,
-    :answer, :action, :question, :article_id, :ip, :user_agent
+    :answer, :action, :question, :article_id, :ip, :user_agent, :title
 end

data/test/unit/model_test.rb

@@ -7,12 +7,12 @@ class HasPaperTrailModelTest < ActiveSupport::TestCase
 
     context 'which updates an ignored column' do
       setup { @article.update_attributes :title => 'My first title' }
-      should_not_change('the number of versions') { Version.count }
+      should 'not change the number of versions' do assert_equal(1, Version.count) end
     end
 
     context 'which updates an ignored column and a selected column' do
       setup { @article.update_attributes :title => 'My first title', :content => 'Some text here.' }
-      should_change('the number of versions', :by => 1) { Version.count }
+      should 'change the number of versions' do assert_equal(2, Version.count) end
 
       should 'have stored only non-ignored attributes' do
         assert_equal ({'content' => [nil, 'Some text here.']}), @article.versions.last.changeset
@@ -21,22 +21,22 @@ class HasPaperTrailModelTest < ActiveSupport::TestCase
 
     context 'which updates a selected column' do
       setup { @article.update_attributes :content => 'Some text here.' }
-      should_change('the number of versions', :by => 1) { Version.count }
+      should 'change the number of versions' do assert_equal(2, Version.count) end
     end
 
     context 'which updates a non-ignored and non-selected column' do
       setup { @article.update_attributes :abstract => 'Other abstract'}
-      should_not_change('the number of versions') { Version.count }
+      should 'not change the number of versions' do assert_equal(1, Version.count) end
     end
 
     context 'which updates a skipped column' do
       setup { @article.update_attributes :file_upload => 'Your data goes here' }
-      should_not_change('the number of versions') { Version.count }
+      should 'not change the number of versions' do assert_equal(1, Version.count) end
     end
 
     context 'which updates a skipped column and a selected column' do
       setup { @article.update_attributes :file_upload => 'Your data goes here', :content => 'Some text here.' }
-      should_change('the number of versions', :by => 1) { Version.count }
+      should 'change the number of versions' do assert_equal(2, Version.count) end
 
       should 'have stored only non-skipped attributes' do
         assert_equal ({'content' => [nil, 'Some text here.']}), @article.versions.last.changeset
@@ -64,7 +64,7 @@ class HasPaperTrailModelTest < ActiveSupport::TestCase
 
     context 'which updates an ignored column' do
       setup { @legacy_widget.update_attributes :version => 1 }
-      should_not_change('the number of versions') { Version.count }
+      should 'not change the number of versions' do assert_equal(1, Version.count) end
     end
   end
 
@@ -73,11 +73,16 @@ class HasPaperTrailModelTest < ActiveSupport::TestCase
 
     context 'for non-US translations' do
       setup { @translation.save }
-      should_not_change('the number of versions') { Version.count }
+      should 'not change the number of versions' do assert_equal(0, Version.count) end
 
       context 'after update' do
         setup { @translation.update_attributes :content => 'Content' }
-        should_not_change('the number of versions') { Version.count }
+        should 'not change the number of versions' do assert_equal(0, Version.count) end
+      end
+
+      context 'after destroy' do
+        setup { @translation.destroy }
+        should 'not change the number of versions' do assert_equal(0, Version.count) end
       end
     end
 
@@ -90,22 +95,27 @@ class HasPaperTrailModelTest < ActiveSupport::TestCase
           @translation.save
         end
 
-        should_not_change('the number of versions') { Version.count }
+        should 'not change the number of versions' do assert_equal(0, Version.count) end
 
         context 'after update' do
           setup { @translation.update_attributes :content => 'Content' }
-          should_not_change('the number of versions') { Version.count }
+          should 'not change the number of versions' do assert_equal(0, Version.count) end
         end
       end
 
       context 'that are not drafts' do
         setup { @translation.save }
 
-        should_change('the number of versions', :by => 1) { Version.count }
+        should 'change the number of versions' do assert_equal(1, Version.count) end
 
         context 'after update' do
           setup { @translation.update_attributes :content => 'Content' }
-          should_change('the number of versions', :by => 1) { Version.count }
+          should 'change the number of versions' do assert_equal(2, Version.count) end
+        end
+
+        context 'after destroy' do
+          setup { @translation.destroy }
+          should 'change the number of versions' do assert_equal(2, Version.count) end
         end
       end
     end
@@ -143,12 +153,19 @@ class HasPaperTrailModelTest < ActiveSupport::TestCase
         assert @widget.live?
       end
 
-      should 'not have changes' do
-        assert_equal Hash.new, @widget.versions.last.changeset
+      should 'have changes' do
+        changes = {
+          'name'       => [nil, 'Henry'],
+          'created_at' => [nil, @widget.created_at],
+          'updated_at' => [nil, @widget.updated_at],
+          'id'         => [nil, 1]
+        }
+
+        assert_equal changes, @widget.versions.last.changeset
       end
 
       context 'and then updated without any changes' do
-        setup { @widget.save }
+        setup { @widget.touch }
 
         should 'not have a new version' do
           assert_equal 1, @widget.versions.length
@@ -353,6 +370,7 @@ class HasPaperTrailModelTest < ActiveSupport::TestCase
     context "after a column is removed from the record's schema" do
       setup do
         change_schema
+        Widget.connection.schema_cache.clear!
         Widget.reset_column_information
         assert_raise(NoMethodError) { Widget.new.sacrificial_column }
         @last = @widget.versions.last
@@ -516,6 +534,12 @@ class HasPaperTrailModelTest < ActiveSupport::TestCase
       assert_nil Version.last.next
     end
 
+    should 'should return the correct originator' do
+      PaperTrail.whodunnit = 'Ben'
+      @foo.update_attribute(:name, 'Geoffrey')
+      assert_equal PaperTrail.whodunnit, @foo.originator
+    end
+
     context 'when destroyed' do
       setup { @foo.destroy }
 
@@ -630,7 +654,10 @@ class HasPaperTrailModelTest < ActiveSupport::TestCase
 
 
   context 'An item' do
-    setup { @article = Article.new }
+    setup do
+      @initial_title = 'Foobar'
+      @article = Article.new :title => @initial_title
+    end
 
     context 'which is created' do
       setup { @article.save }
@@ -650,10 +677,16 @@ class HasPaperTrailModelTest < ActiveSupport::TestCase
       should 'store dynamic meta data based on a method of the item' do
         assert_equal @article.action_data_provider_method, @article.versions.last.action
       end
+      
+      should 'store dynamic meta data based on an attribute of the item prior to creation' do
+        assert_equal nil, @article.versions.last.title
+      end
 
 
       context 'and updated' do
-        setup { @article.update_attributes! :content => 'Better text.' }
+        setup do
+          @article.update_attributes! :content => 'Better text.', :title => 'Rhubarb'
+        end
 
         should 'store fixed meta data' do
           assert_equal 42, @article.versions.last.answer
@@ -666,6 +699,10 @@ class HasPaperTrailModelTest < ActiveSupport::TestCase
         should 'store dynamic meta data which depends on the item' do
           assert_equal @article.id, @article.versions.last.article_id
         end
+        
+        should 'store dynamic meta data based on an attribute of the item prior to the update' do
+          assert_equal @initial_title, @article.versions.last.title
+        end
       end
 
 
@@ -683,7 +720,10 @@ class HasPaperTrailModelTest < ActiveSupport::TestCase
         should 'store dynamic meta data which depends on the item' do
           assert_equal @article.id, @article.versions.last.article_id
         end
-
+        
+        should 'store dynamic meta data based on an attribute of the item prior to the destruction' do
+          assert_equal @initial_title, @article.versions.last.title
+        end
       end
     end
   end
@@ -881,13 +921,14 @@ class HasPaperTrailModelTest < ActiveSupport::TestCase
 
     context 'which is then saved' do
       setup { @post.save }
-      should_change('the number of post versions') { PostVersion.count }
-      should_not_change('the number of versions') { Version.count }
+      should 'change the number of post versions' do assert_equal 1, PostVersion.count end
+      should 'not change the number of versions' do assert_equal(0, Version.count) end
     end
   end
 
   context 'An existing model instance which uses a custom Version class' do
     setup { @post = Post.create }
+    should 'have one post version' do assert_equal(1, PostVersion.count) end
 
     context 'on the first version' do
       setup { @version = @post.versions.first }
@@ -903,8 +944,8 @@ class HasPaperTrailModelTest < ActiveSupport::TestCase
 
     context 'which is modified' do
       setup { @post.update_attributes({ :content => "Some new content" }) }
-      should_change('the number of post versions') { PostVersion.count }
-      should_not_change('the number of versions') { Version.count }
+      should 'change the number of post versions' do assert_equal(2, PostVersion.count) end
+      should 'not change the number of versions' do assert_equal(0, Version.count) end
       should "not have stored changes when object_changes column doesn't exist" do
         assert_nil @post.versions.last.changeset
       end