paper_trail 2.2.7 → 2.2.8

data/README.md

@@ -348,7 +348,7 @@ PaperTrail can restore `:has_one` associations as they were at (actually, 3 seco
 
     >> treasure.update_attributes :amount => 153
     >> treasure.location.update_attributes :latitude => 54.321
-    
+
     >> t = treasure.versions.last.reify(:has_one => true)
     >> t.amount                         # 100
     >> t.location.latitude              # 12.345
@@ -374,13 +374,13 @@ Given these models:
       has_many :authors, :through => :authorships, :source => :person
       has_paper_trail
     end
-    
+
     class Authorship < ActiveRecord::Base
       belongs_to :book
       belongs_to :person
       has_paper_trail      # NOTE
     end
-    
+
     class Person < ActiveRecord::Base
       has_many :authorships, :dependent => :destroy
       has_many :books, :through => :authorships
@@ -403,7 +403,7 @@ But none of these will:
 Having said that, you can apparently get all these working (I haven't tested it myself) with this [monkey patch](http://stackoverflow.com/questions/2381033/how-to-create-a-full-audit-log-in-rails-for-every-table/2381411#2381411):
 
     # In config/initializers/core_extensions.rb or lib/core_extensions.rb
-    ActiveRecord::Associations::HasManyThroughAssociation.class_eval do 
+    ActiveRecord::Associations::HasManyThroughAssociation.class_eval do
       def delete_records(records)
         klass = @reflection.through_reflection.klass
         records.each do |associate|
@@ -413,7 +413,7 @@ Having said that, you can apparently get all these working (I haven't tested it
     end
 
 The difference is the call to `destroy_all` instead of `delete_all` in [the original](http://github.com/rails/rails/blob/master/activerecord/lib/active_record/associations/has_many_through_association.rb#L76-81).
-    
+
 
 There may be a way to store authorship versions, probably using association callbacks, no matter how the collection is manipulated but I haven't found it yet.  Let me know if you do.
 
@@ -455,10 +455,10 @@ Remember to add those extra columns to your `versions` table ;)
 
 There are two scenarios: diffing adjacent versions and diffing non-adjacent versions.
 
-The best way to diff adjacent versions is to get PaperTrail to do it for you.  If you add an `object_changes` text column to your `versions` table, either at installation time with the `--with-changes` option or manually, PaperTrail will store the `changes` diff in each `update` version.  You can use the `version.changeset` method to retrieve it.  For example:
+The best way to diff adjacent versions is to get PaperTrail to do it for you.  If you add an `object_changes` text column to your `versions` table, either at installation time with the `--with-changes` option or manually, PaperTrail will store the `changes` diff (excluding any attributes PaperTrail is ignoring) in each `update` version.  You can use the `version.changeset` method to retrieve it.  For example:
 
     >> widget = Widget.create :name => 'Bob'
-    >> widget.versions.last.changeset                # nil
+    >> widget.versions.last.changeset                # {}
     >> widget.update_attributes :name => 'Robert'
     >> widget.versions.last.changeset                # {'name' => ['Bob', 'Robert']}
 

data/lib/paper_trail/has_paper_trail.rb

@@ -114,7 +114,12 @@ module PaperTrail
             :object    => object_to_string(item_before_change),
             :whodunnit => PaperTrail.whodunnit
           }
-          data[:object_changes] = self.changes.to_yaml if Version.method_defined? :object_changes
+          if Version.method_defined? :object_changes
+            # The double negative (reject, !include?) preserves the hash structure of self.changes.
+            data[:object_changes] = self.changes.reject do |key, value|
+              !notably_changed.include?(key)
+            end.to_yaml
+          end
           versions.build merge_metadata(data)
         end
       end

data/lib/paper_trail/version.rb

@@ -80,8 +80,15 @@ class Version < ActiveRecord::Base
   end
 
   # Returns what changed in this version of the item.  Cf. `ActiveModel::Dirty#changes`.
+  # Returns nil if your `versions` table does not have an `object_changes` text column.
   def changeset
-    YAML::load(object_changes) if Version.method_defined?(:object_changes) && object_changes
+    if Version.method_defined?(:object_changes)
+      if changes = object_changes
+        YAML::load(changes)
+      else
+        {}
+      end
+    end
   end
 
   # Returns who put the item into the state stored in this version.

data/lib/paper_trail/version_number.rb

@@ -1,3 +1,3 @@
 module PaperTrail
-  VERSION = '2.2.7'
+  VERSION = '2.2.8'
 end

data/test/unit/model_test.rb

@@ -13,6 +13,10 @@ class HasPaperTrailModelTest < ActiveSupport::TestCase
     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 'have stored only non-ignored attributes' do
+        assert_equal ({'content' => [nil, 'Some text here.']}), @article.versions.last.changeset
+      end
     end
 
     context 'which updates a selected column' do
@@ -61,7 +65,7 @@ class HasPaperTrailModelTest < ActiveSupport::TestCase
       end
 
       should 'should not have changes' do
-        assert_nil @widget.versions.last.changeset
+        assert_equal Hash.new, @widget.versions.last.changeset
       end
 
       context 'and then updated without any changes' do
@@ -105,7 +109,7 @@ class HasPaperTrailModelTest < ActiveSupport::TestCase
           assert_equal ({'name' => ['Henry', 'Harry']}), @widget.versions.last.changeset
         end
 
-        should 'not have stored changes if object_changes column doesn\'t exist' do
+        should "not have stored changes if object_changes column doesn't exist" do
           remove_object_changes_column
           Version.reset_column_information
           assert_nil @widget.versions.last.changeset
@@ -192,6 +196,10 @@ class HasPaperTrailModelTest < ActiveSupport::TestCase
             @reified_widget.save
             assert_equal 1, @reified_widget.fluxors.length
           end
+
+          should 'should not have changes' do
+            assert_equal Hash.new, @widget.versions.last.changeset
+          end
         end
       end
     end

metadata

@@ -1,13 +1,13 @@
 --- !ruby/object:Gem::Specification 
 name: paper_trail
 version: !ruby/object:Gem::Version 
-  hash: 9
+  hash: 23
   prerelease: false
   segments: 
   - 2
   - 2
-  - 7
-  version: 2.2.7
+  - 8
+  version: 2.2.8
 platform: ruby
 authors: 
 - Andy Stewart
@@ -15,7 +15,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2011-07-13 00:00:00 +01:00
+date: 2011-07-14 00:00:00 +01:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency