paper_trail 2.3.1 → 2.3.2

data/README.md

@@ -187,7 +187,7 @@ You can ignore changes to certain attributes like this:
       has_paper_trail :ignore => [:title, :rating]
     end
 
-This means that changes to just the `title` or `rating` will not store another version of the article.  It does not mean that the `title` and `rating` attributes will be ignored if some other change causes a new `Version` to be crated.  For example:
+This means that changes to just the `title` or `rating` will not store another version of the article.  It does not mean that the `title` and `rating` attributes will be ignored if some other change causes a new `Version` to be created.  For example:
 
     >> a = Article.create
     >> a.versions.length                         # 1
@@ -563,6 +563,17 @@ And on again like this:
 
     >> Widget.paper_trail_on
 
+### Per method call
+
+You can call a method without creating a new version using `without_versioning`.  It takes either a method name as a symbol:
+
+    @widget.without_versioning :destroy
+
+Or a block:
+
+    @widget.without_versioning do
+      @widget.update_attributes :name => 'Ford'
+    end
 
 
 ## Deleting Old Versions

data/lib/paper_trail/has_paper_trail.rb

@@ -29,22 +29,22 @@ module PaperTrail
         # The version this instance was reified from.
         attr_accessor :version
 
-        cattr_accessor :version_class_name
+        class_attribute :version_class_name
         self.version_class_name = options[:class_name] || 'Version'
 
-        cattr_accessor :ignore
+        class_attribute :ignore
         self.ignore = ([options[:ignore]].flatten.compact || []).map &:to_s
 
-        cattr_accessor :only
+        class_attribute :only
         self.only = ([options[:only]].flatten.compact || []).map &:to_s
 
-        cattr_accessor :meta
+        class_attribute :meta
         self.meta = options[:meta] || {}
 
-        cattr_accessor :paper_trail_enabled_for_model
+        class_attribute :paper_trail_enabled_for_model
         self.paper_trail_enabled_for_model = true
 
-        cattr_accessor :versions_association_name
+        class_attribute :versions_association_name
         self.versions_association_name = options[:versions] || :versions
 
         has_many self.versions_association_name,
@@ -104,6 +104,15 @@ module PaperTrail
         subsequent_version.reify if subsequent_version
       end
 
+      # Executes the given method or block without creating a new version.
+      def without_versioning(method = nil)
+        paper_trail_was_enabled = self.paper_trail_enabled_for_model
+        self.class.paper_trail_off
+        method ? method.to_proc.call(self) : yield
+      ensure
+        self.class.paper_trail_on if paper_trail_was_enabled
+      end
+
       private
 
       def version_class

data/lib/paper_trail/version.rb

@@ -84,7 +84,7 @@ class Version < ActiveRecord::Base
   def changeset
     if self.class.column_names.include? 'object_changes'
       if changes = object_changes
-        YAML::load(changes)
+        HashWithIndifferentAccess[YAML::load(changes)]
       else
         {}
       end

data/lib/paper_trail/version_number.rb

@@ -1,3 +1,3 @@
 module PaperTrail
-  VERSION = '2.3.1'
+  VERSION = '2.3.2'
 end

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

@@ -0,0 +1,3 @@
+class Elephant < Animal
+  paper_trail_off
+end

data/test/unit/model_test.rb

@@ -64,7 +64,7 @@ class HasPaperTrailModelTest < ActiveSupport::TestCase
         assert @widget.live?
       end
 
-      should 'should not have changes' do
+      should 'not have changes' do
         assert_equal Hash.new, @widget.versions.last.changeset
       end
 
@@ -109,6 +109,11 @@ class HasPaperTrailModelTest < ActiveSupport::TestCase
           assert_equal ({'name' => ['Henry', 'Harry']}), @widget.versions.last.changeset
         end
 
+        should 'return changes with indifferent access' do
+          assert_equal ['Henry', 'Harry'], @widget.versions.last.changeset[:name]
+          assert_equal ['Henry', 'Harry'], @widget.versions.last.changeset['name']
+        end
+
         if defined?(ActiveRecord::IdentityMap) && ActiveRecord::IdentityMap.respond_to?(:without)
           should 'not clobber the IdentityMap when reifying' do
             module ActiveRecord::IdentityMap
@@ -191,7 +196,7 @@ class HasPaperTrailModelTest < ActiveSupport::TestCase
             assert_equal 1, @reified_widget.fluxors.length
           end
 
-          should 'should not have changes' do
+          should 'not have changes' do
             assert_equal Hash.new, @widget.versions.last.changeset
           end
         end
@@ -329,6 +334,13 @@ class HasPaperTrailModelTest < ActiveSupport::TestCase
         end
       end
 
+      context 'when destroyed "without versioning"' do
+        should 'leave paper trail off after call' do
+          @widget.without_versioning :destroy
+          assert !Widget.paper_trail_enabled_for_model
+        end
+      end
+
       context 'and then its paper trail turned on' do
         setup { Widget.paper_trail_on }
 
@@ -339,6 +351,22 @@ class HasPaperTrailModelTest < ActiveSupport::TestCase
             assert_equal @count + 1, @widget.versions.length
           end
         end
+
+        context 'when updated "without versioning"' do
+          setup do
+            @widget.without_versioning do
+              @widget.update_attributes :name => 'Ford'
+            end
+          end
+
+          should 'not create new version' do
+            assert_equal 1, @widget.versions.length
+          end
+
+          should 'enable paper trail after call' do
+            assert Widget.paper_trail_enabled_for_model
+          end
+        end
       end
     end
   end
@@ -772,7 +800,7 @@ class HasPaperTrailModelTest < ActiveSupport::TestCase
       end
     end
 
-    should 'should have versions of the custom class' do
+    should 'have versions of the custom class' do
       assert_equal "PostVersion", @post.versions.first.class.name
     end
 

metadata

@@ -1,13 +1,13 @@
 --- !ruby/object:Gem::Specification 
 name: paper_trail
 version: !ruby/object:Gem::Version 
-  hash: 1
+  hash: 7
   prerelease: false
   segments: 
   - 2
   - 3
-  - 1
-  version: 2.3.1
+  - 2
+  version: 2.3.2
 platform: ruby
 authors: 
 - Andy Stewart
@@ -15,7 +15,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2011-08-22 00:00:00 +02:00
+date: 2011-08-31 00:00:00 +02:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency 
@@ -131,6 +131,7 @@ files:
 - test/dummy/app/models/cat.rb
 - test/dummy/app/models/document.rb
 - test/dummy/app/models/dog.rb
+- test/dummy/app/models/elephant.rb
 - test/dummy/app/models/fluxor.rb
 - test/dummy/app/models/foo_widget.rb
 - test/dummy/app/models/person.rb
@@ -226,6 +227,7 @@ test_files:
 - test/dummy/app/models/cat.rb
 - test/dummy/app/models/document.rb
 - test/dummy/app/models/dog.rb
+- test/dummy/app/models/elephant.rb
 - test/dummy/app/models/fluxor.rb
 - test/dummy/app/models/foo_widget.rb
 - test/dummy/app/models/person.rb