paper_trail 2.4.0 → 2.4.1

data/README.md

@@ -215,6 +215,14 @@ This means that only changes to the `title` will save a version of the article:
 
 Passing both `:ignore` and `:only` options will result in the article being saved if a changed attribute is included in `:only` but not in `:ignore`.
 
+You can skip fields altogether with the `:skip` option.  As with `:ignore`, updates to these fields will not create a new `Version`.  In addition, these fields will not be included in the serialised version of the object whenever a new `Version` is created.
+
+For example:
+
+    class Article < ActiveRecord::Base
+      has_paper_trail :skip => [:file_upload]
+    end
+
 
 ## Reverting And Undeleting A Model
 
@@ -461,7 +469,9 @@ PaperTrail will call your proc with the current article and store the result in
 N.B.  You must also:
 
 * Add your metadata columns to the `versions` table.
-* Declare your metadata columns using `attr_accessible` like this:
+* Declare your metadata columns using `attr_accessible`.
+
+For example:
 
     # config/initializers/paper_trail.rb
     class Version < ActiveRecord::Base
@@ -661,6 +671,7 @@ Many thanks to:
 * [Eduard Tsech](https://github.com/edtsech)
 * [Mathieu Arnold](https://github.com/mat813)
 * [Nicholas Thrower](https://github.com/throwern)
+* [Benjamin Curtis](https://github.com/stympy)
 
 
 ## Inspirations

data/lib/paper_trail/has_paper_trail.rb

@@ -16,6 +16,9 @@ module PaperTrail
       # :class_name   the name of a custom Version class.  This class should inherit from Version.
       # :ignore       an array of attributes for which a new `Version` will not be created if only they change.
       # :only         inverse of `ignore` - a new `Version` will be created only for these attributes if supplied
+      # :skip         fields to ignore completely.  As with `ignore`, updates to these fields will not create
+      #               a new `Version`.  In addition, these fields will not be included in the serialized versions
+      #               of the object whenever a new `Version` is created.
       # :meta         a hash of extra data to store.  You must add a column to the `versions` table for each key.
       #               Values are objects or procs (which are called with `self`, i.e. the model with the paper
       #               trail).  See `PaperTrail::Controller.info_for_paper_trail` for how to store data from
@@ -40,6 +43,9 @@ module PaperTrail
         class_attribute :ignore
         self.ignore = ([options[:ignore]].flatten.compact || []).map &:to_s
 
+        class_attribute :skip
+        self.skip = ([options[:skip]].flatten.compact || []).map &:to_s
+
         class_attribute :only
         self.only = ([options[:only]].flatten.compact || []).map &:to_s
 
@@ -191,7 +197,7 @@ module PaperTrail
       end
 
       def object_to_string(object)
-        object.attributes.to_yaml
+        object.attributes.except(*self.class.skip).to_yaml
       end
 
       def changed_notably?
@@ -203,7 +209,7 @@ module PaperTrail
       end
 
       def changed_and_not_ignored
-        changed - self.class.ignore
+        changed - self.class.ignore - self.class.skip
       end
 
       def switched_on?

data/lib/paper_trail/version_number.rb

@@ -1,3 +1,3 @@
 module PaperTrail
-  VERSION = '2.4.0'
+  VERSION = '2.4.1'
 end

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

@@ -1,6 +1,7 @@
 class Article < ActiveRecord::Base
   has_paper_trail :ignore => :title,
                   :only => [:content],
+                  :skip => [:file_upload],
                   :meta   => {:answer => 42,
                               :action => :action_data_provider_method,
                               :question => Proc.new { "31 + 11 = #{31 + 11}" },

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

@@ -65,6 +65,7 @@ class SetUpTestTables < ActiveRecord::Migration
       t.string :title
       t.string :content
       t.string :abstract
+      t.string :file_upload
     end
 
     create_table :books, :force => true do |t|

data/test/unit/model_test.rb

@@ -28,7 +28,36 @@ class HasPaperTrailModelTest < ActiveSupport::TestCase
       setup { @article.update_attributes :abstract => 'Other abstract'}
       should_not_change('the number of versions') { Version.count }
     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 }
+    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 'have stored only non-skipped attributes' do
+        assert_equal ({'content' => [nil, 'Some text here.']}), @article.versions.last.changeset
+      end
+      
+      context 'and when updated again' do
+        setup do
+          @article.update_attributes :file_upload => 'More data goes here', :content => 'More text here.'
+          @old_article = @article.versions.last
+        end
+        
+        should 'have removed the skipped attributes when saving the previous version' do
+          assert_equal nil, YAML::load(@old_article.object)['file_upload']
+        end
+        
+        should 'have kept the non-skipped attributes in the previous version' do
+          assert_equal 'Some text here.', YAML::load(@old_article.object)['content']
+        end
+      end
+    end
+    
   end
 
 

metadata

@@ -1,13 +1,13 @@
 --- !ruby/object:Gem::Specification 
 name: paper_trail
 version: !ruby/object:Gem::Version 
-  hash: 31
+  hash: 29
   prerelease: 
   segments: 
   - 2
   - 4
-  - 0
-  version: 2.4.0
+  - 1
+  version: 2.4.1
 platform: ruby
 authors: 
 - Andy Stewart
@@ -15,7 +15,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2011-09-29 00:00:00 +02:00
+date: 2011-11-09 00:00:00 +01:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency