paper_trail 2.5.2 → 2.6.0

data/.gitignore

@@ -1,5 +1,6 @@
 test/debug.log
 test/paper_trail_plugin.sqlite3.db
+test/dummy/db/*.sqlite3
 test/dummy/log/*
 test/dummy/tmp/*
 coverage

data/README.md

@@ -179,6 +179,16 @@ You can choose which events to track with the `on` option.  For example, to igno
     end
 
 
+## Choosing When To Save New Versions
+
+You can choose the conditions when to add new versions with the `if` and `unless` options. For example, to save versions only for US non-draft translations:
+
+    class Translation < ActiveRecord::Base
+      has_paper_trail :if     => Proc.new { |t| t.language_code == 'US' },
+                      :unless => Proc.new { |t| t.type == 'DRAFT'       }
+    end
+
+
 
 ## Choosing Attributes To Monitor
 
@@ -694,6 +704,7 @@ Many thanks to:
 * [Benjamin Curtis](https://github.com/stympy)
 * [Peter Harkins](https://github.com/pushcx)
 * [Mohd Amree](https://github.com/amree)
+* [Nikita Cernovs](https://github.com/nikitachernov)
 
 
 ## Inspirations

data/lib/paper_trail/has_paper_trail.rb

@@ -15,6 +15,7 @@ module PaperTrail
       #               `:create`, `:update`, `:destroy` as desired.
       # :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.
+      # :if, :unless  Procs that allow to specify conditions when to save versions for an object
       # :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
@@ -43,6 +44,12 @@ module PaperTrail
         class_attribute :ignore
         self.ignore = ([options[:ignore]].flatten.compact || []).map &:to_s
 
+        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
 
@@ -63,8 +70,8 @@ module PaperTrail
                  :as         => :item,
                  :order      => "created_at ASC, #{self.version_class_name.constantize.primary_key} ASC"
 
-        after_create  :record_create  if !options[:on] || options[:on].include?(:create)
-        before_update :record_update  if !options[:on] || options[:on].include?(:update)
+        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)
       end
 
@@ -215,7 +222,10 @@ module PaperTrail
       def switched_on?
         PaperTrail.enabled? && PaperTrail.enabled_for_controller? && self.class.paper_trail_enabled_for_model
       end
-    end
 
+      def save_version?
+        (if_condition.blank? || if_condition.call(self)) && !unless_condition.try(:call, self)
+      end
+    end
   end
 end

data/lib/paper_trail/version_number.rb

@@ -1,3 +1,3 @@
 module PaperTrail
-  VERSION = '2.5.2'
+  VERSION = '2.6.0'
 end

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

@@ -0,0 +1,4 @@
+class Translation < ActiveRecord::Base
+  has_paper_trail :if     => Proc.new { |t| t.language_code == 'US' },
+                  :unless => Proc.new { |t| t.type == 'DRAFT'       }
+end

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

@@ -103,7 +103,13 @@ class SetUpTestTables < ActiveRecord::Migration
       t.string    :name
       t.integer   :version
     end
-  
+
+    create_table :translations, :force => true do |t|
+      t.string    :headline
+      t.string    :content
+      t.string    :language_code
+      t.string    :type
+    end
   end
 
   def self.down
@@ -123,5 +129,6 @@ class SetUpTestTables < ActiveRecord::Migration
     drop_table :widgets
     drop_table :documents
     drop_table :legacy_widgets
+    drop_table :translations
   end
 end

data/test/unit/model_test.rb

@@ -68,6 +68,48 @@ class HasPaperTrailModelTest < ActiveSupport::TestCase
     end
   end
 
+  context 'A record with defined "if" and "unless" attributes' do
+    setup { @translation = Translation.new :headline => 'Headline' }
+
+    context 'for non-US translations' do
+      setup { @translation.save }
+      should_not_change('the number of versions') { Version.count }
+
+      context 'after update' do
+        setup { @translation.update_attributes :content => 'Content' }
+        should_not_change('the number of versions') { Version.count }
+      end
+    end
+
+    context 'for US translations' do
+      setup { @translation.language_code = "US" }
+
+      context 'that are drafts' do
+        setup do
+          @translation.type = 'DRAFT'
+          @translation.save
+        end
+
+        should_not_change('the number of versions') { Version.count }
+
+        context 'after update' do
+          setup { @translation.update_attributes :content => 'Content' }
+          should_not_change('the number of versions') { Version.count }
+        end
+      end
+
+      context 'that are not drafts' do
+        setup { @translation.save }
+
+        should_change('the number of versions', :by => 1) { Version.count }
+
+        context 'after update' do
+          setup { @translation.update_attributes :content => 'Content' }
+          should_change('the number of versions', :by => 1) { Version.count }
+        end
+      end
+    end
+  end
 
   context 'A new record' do
     setup { @widget = Widget.new }

metadata

@@ -1,13 +1,13 @@
 --- !ruby/object:Gem::Specification 
 name: paper_trail
 version: !ruby/object:Gem::Version 
-  hash: 31
+  hash: 23
   prerelease: 
   segments: 
   - 2
-  - 5
-  - 2
-  version: 2.5.2
+  - 6
+  - 0
+  version: 2.6.0
 platform: ruby
 authors: 
 - Andy Stewart
@@ -15,7 +15,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2012-01-16 00:00:00 +01:00
+date: 2012-01-18 00:00:00 +01:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency 
@@ -138,6 +138,7 @@ files:
 - test/dummy/app/models/person.rb
 - test/dummy/app/models/post.rb
 - test/dummy/app/models/song.rb
+- test/dummy/app/models/translation.rb
 - test/dummy/app/models/widget.rb
 - test/dummy/app/models/wotsit.rb
 - test/dummy/app/versions/post_version.rb
@@ -157,10 +158,8 @@ files:
 - test/dummy/config/initializers/session_store.rb
 - test/dummy/config/locales/en.yml
 - test/dummy/config/routes.rb
-- test/dummy/db/development.sqlite3
 - test/dummy/db/migrate/20110208155312_set_up_test_tables.rb
 - test/dummy/db/schema.rb
-- test/dummy/db/test.sqlite3
 - test/dummy/public/404.html
 - test/dummy/public/422.html
 - test/dummy/public/500.html
@@ -235,6 +234,7 @@ test_files:
 - test/dummy/app/models/person.rb
 - test/dummy/app/models/post.rb
 - test/dummy/app/models/song.rb
+- test/dummy/app/models/translation.rb
 - test/dummy/app/models/widget.rb
 - test/dummy/app/models/wotsit.rb
 - test/dummy/app/versions/post_version.rb
@@ -254,10 +254,8 @@ test_files:
 - test/dummy/config/initializers/session_store.rb
 - test/dummy/config/locales/en.yml
 - test/dummy/config/routes.rb
-- test/dummy/db/development.sqlite3
 - test/dummy/db/migrate/20110208155312_set_up_test_tables.rb
 - test/dummy/db/schema.rb
-- test/dummy/db/test.sqlite3
 - test/dummy/public/404.html
 - test/dummy/public/422.html
 - test/dummy/public/500.html