paper_trail 2.1.1 → 2.2.0

data/README.md

@@ -1,3 +1,9 @@
+# Extended
+
+Added the possibility to disable/enable PaperTrail from a controller.
+
+
+
 # PaperTrail
 
 PaperTrail lets you track changes to your models' data.  It's good for auditing or versioning.  You can see how a model looked at any stage in its lifecycle, revert it to any version, and even undelete it after it's been destroyed.
@@ -18,6 +24,7 @@ There's an excellent [Railscast on implementing Undo with Paper Trail](http://ra
 * Allows you to store arbitrary model-level metadata with each version (useful for filtering versions).
 * Allows you to store arbitrary controller-level information with each version, e.g. remote IP.
 * Can be turned off/on per class (useful for migrations).
+* Can be turned off/on per request (useful for testing with an external service).
 * Can be turned off/on globally (useful for testing).
 * No configuration necessary.
 * Stores everything in a single database table by default (generates migration for you), or can use separate tables for separate models.
@@ -478,15 +485,11 @@ For diffing two ActiveRecord objects:
 
 Sometimes you don't want to store changes.  Perhaps you are only interested in changes made by your users and don't need to store changes you make yourself in, say, a migration -- or when testing your application.
 
-If you are about change some widgets and you don't want a paper trail of your changes, you can turn PaperTrail off like this:
+You can turn PaperTrail on or off in three ways: globally, per request, or per class.
 
-    >> Widget.paper_trail_off
+### Globally
 
-And on again like this:
-
-    >> Widget.paper_trail_on
-
-You can also disable PaperTrail for all models:
+On a global level you can turn PaperTrail off like this:
 
     >> PaperTrail.enabled = false
 
@@ -518,6 +521,27 @@ And then use it in your tests like this:
       end
     end
 
+### Per request
+
+You can turn PaperTrail on or off per request by adding a `paper_trail_enabled_for_controller` method to your controller which returns true or false:
+
+    class ApplicationController < ActionController::Base
+      def paper_trail_enabled_for_controller
+        request.user_agent != 'Disable User-Agent'
+      end
+    end
+
+### Per class
+
+If you are about change some widgets and you don't want a paper trail of your changes, you can turn PaperTrail off like this:
+
+    >> Widget.paper_trail_off
+
+And on again like this:
+
+    >> Widget.paper_trail_on
+
+
 
 ## Deleting Old Versions
 
@@ -583,6 +607,7 @@ Many thanks to:
 * [Matthew MacLeod](https://github.com/mattmacleod)
 * [benzittlau](https://github.com/benzittlau)
 * [Tom Derks](https://github.com/EgoH)
+* [Jonas Hoglund](https://github.com/jhoglund)
 
 
 ## Inspirations

data/lib/paper_trail/controller.rb

@@ -4,6 +4,7 @@ module PaperTrail
     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
     end
 
     protected
@@ -40,6 +41,13 @@ module PaperTrail
 
     private
 
+    # Tells PaperTrail if version should be saved.
+    def set_paper_trail_enabled_for_controller
+      if respond_to? :paper_trail_enabled_for_controller
+        ::PaperTrail.enabled_for_controller = paper_trail_enabled_for_controller
+      end
+    end
+
     # Tells PaperTrail who is responsible for any changes that occur.
     def set_paper_trail_whodunnit
       ::PaperTrail.whodunnit = user_for_paper_trail

data/lib/paper_trail/has_paper_trail.rb

@@ -38,10 +38,8 @@ module PaperTrail
         cattr_accessor :meta
         self.meta = options[:meta] || {}
 
-        # Indicates whether or not PaperTrail is active for this class.
-        # This is independent of whether PaperTrail is globally enabled or disabled.
-        cattr_accessor :paper_trail_active
-        self.paper_trail_active = true
+        cattr_accessor :paper_trail_enabled_for_model
+        self.paper_trail_enabled_for_model = true
 
         has_many :versions, :class_name => version_class_name, :as => :item, :order => 'created_at ASC, id ASC'
 
@@ -52,12 +50,12 @@ module PaperTrail
 
       # Switches PaperTrail off for this class.
       def paper_trail_off
-        self.paper_trail_active = false
+        self.paper_trail_enabled_for_model = false
       end
 
       # Switches PaperTrail on for this class.
       def paper_trail_on
-        self.paper_trail_active = true
+        self.paper_trail_enabled_for_model = true
       end
     end
 
@@ -167,10 +165,8 @@ module PaperTrail
         changed - self.class.ignore
       end
 
-      # Returns `true` if PaperTrail is globally enabled and active for this class,
-      # `false` otherwise.
       def switched_on?
-        PaperTrail.enabled? && self.class.paper_trail_active
+        PaperTrail.enabled? && PaperTrail.enabled_for_controller? && self.class.paper_trail_enabled_for_model
       end
     end
 

data/lib/paper_trail/version_number.rb

@@ -1,3 +1,3 @@
 module PaperTrail
-  VERSION = '2.1.1'
+  VERSION = '2.2.0'
 end

data/lib/paper_trail.rb

@@ -20,6 +20,15 @@ module PaperTrail
     !!PaperTrail.config.enabled
   end
 
+  # Returns `true` if PaperTrail is enabled for the controller, `false` otherwise.
+  def self.enabled_for_controller?
+    !!paper_trail_store[:request_enabled_for_controller]
+  end
+
+  # Sets if PaperTrails is disabled by controller
+  def self.enabled_for_controller=(value)
+    paper_trail_store[:request_enabled_for_controller] = value
+  end
 
   # Returns who is reponsible for any changes that occur.
   def self.whodunnit

data/paper_trail.gemspec

@@ -20,4 +20,5 @@ Gem::Specification.new do |s|
   s.add_development_dependency 'shoulda',      '2.10.3'
   s.add_development_dependency 'sqlite3-ruby', '~> 1.2'
   s.add_development_dependency 'capybara',     '>= 0.4.0'
+  s.add_development_dependency 'turn'
 end

data/test/dummy/app/controllers/application_controller.rb

@@ -13,4 +13,5 @@ class ApplicationController < ActionController::Base
   def info_for_paper_trail
     {:ip => request.remote_ip, :user_agent => request.user_agent}
   end
+  
 end

data/test/dummy/app/controllers/widgets_controller.rb

@@ -1,4 +1,9 @@
 class WidgetsController < ApplicationController
+
+  def paper_trail_enabled_for_controller
+    request.user_agent != 'Disable User-Agent'
+  end
+
   def create
     @widget = Widget.create params[:widget]
     head :ok

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

@@ -1,3 +1,4 @@
 class Animal < ActiveRecord::Base
   has_paper_trail
+  set_inheritance_column 'species'
 end

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

@@ -1,3 +1,2 @@
 class Cat < Animal
-  set_inheritance_column 'species'
 end

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

@@ -1,3 +1,2 @@
 class Dog < Animal
-  set_inheritance_column 'species'
 end

data/test/functional/controller_test.rb

@@ -7,6 +7,36 @@ class ControllerTest < ActionController::TestCase
     @request.env['REMOTE_ADDR'] = '127.0.0.1'
   end
 
+  teardown do
+    PaperTrail.enabled_for_controller = true
+  end
+
+  test 'disable on create' do
+    @request.env['HTTP_USER_AGENT'] = 'Disable User-Agent'
+    post :create, :widget => { :name => 'Flugel' }
+    assert_equal 0, assigns(:widget).versions.length
+  end
+
+  test 'disable on update' do
+    @request.env['HTTP_USER_AGENT'] = 'Disable User-Agent'
+    post :create, :widget => { :name => 'Flugel' }
+    w = assigns(:widget)
+    assert_equal 0, w.versions.length
+    put :update, :id => w.id, :widget => { :name => 'Bugle' }
+    widget = assigns(:widget)
+    assert_equal 0, widget.versions.length
+  end
+
+  test 'disable on destroy' do
+    @request.env['HTTP_USER_AGENT'] = 'Disable User-Agent'
+    post :create, :widget => { :name => 'Flugel' }
+    w = assigns(:widget)
+    assert_equal 0, w.versions.length
+    delete :destroy, :id => w.id
+    widget = assigns(:widget)
+    assert_equal 0, Version.with_item_keys('Widget', w.id).size
+  end
+
   test 'create' do
     post :create, :widget => { :name => 'Flugel' }
     widget = assigns(:widget)

data/test/test_helper.rb

@@ -4,6 +4,12 @@ ENV["RAILS_ENV"] = "test"
 require File.expand_path("../dummy/config/environment.rb",  __FILE__)
 require "rails/test_help"
 
+begin
+  require 'turn'
+rescue LoadError
+  # noop
+end
+
 #ActionMailer::Base.delivery_method = :test
 #ActionMailer::Base.perform_deliveries = true
 #ActionMailer::Base.default_url_options[:host] = "test.com"

data/test/unit/inheritance_column_test.rb

@@ -7,25 +7,36 @@ class InheritanceColumnTest < ActiveSupport::TestCase
       @animal = Animal.create :name => 'Animal'
       @animal.update_attributes :name => 'Animal from the Muppets'
       @animal.update_attributes :name => 'Animal Muppet'
+      @animal.destroy
 
       @dog = Dog.create :name => 'Snoopy'
       @dog.update_attributes :name => 'Scooby'
       @dog.update_attributes :name => 'Scooby Doo'
+      @dog.destroy
 
       @cat = Cat.create :name => 'Garfield'
       @cat.update_attributes :name => 'Garfield (I hate Mondays)'
       @cat.update_attributes :name => 'Garfield The Cat'
+      @cat.destroy
     end
 
     should 'work with custom STI inheritance column' do
-      assert_equal 9, Version.count
-      assert_equal 3, @animal.versions.count
-      assert_equal 3, @dog.versions.count
-      assert_equal 3, @cat.versions.count
-
-      assert_equal 'Animal from the Muppets',   @animal.versions.last.reify.name
-      assert_equal 'Scooby',       @dog.versions.last.reify.name
-      assert_equal 'Garfield (I hate Mondays)', @cat.versions.last.reify.name
+      assert_equal 12, Version.count
+      assert_equal 4, @animal.versions.count
+      assert @animal.versions.first.reify.nil?
+      @animal.versions[1..-1].each { |v| assert_equal 'Animal', v.reify.class.name }
+
+      # For some reason `@dog.versions` doesn't include the final `destroy` version.
+      # Neither do `@dog.versions.scoped` nor `@dog.versions(true)` nor `@dog.versions.reload`.
+      dog_versions = Version.where(:item_id => @dog.id)
+      assert_equal 4, dog_versions.count
+      assert dog_versions.first.reify.nil?
+      dog_versions[1..-1].each { |v| assert_equal 'Dog', v.reify.class.name }
+
+      cat_versions = Version.where(:item_id => @cat.id)
+      assert_equal 4, cat_versions.count
+      assert cat_versions.first.reify.nil?
+      cat_versions[1..-1].each { |v| assert_equal 'Cat', v.reify.class.name }
     end
   end
 

data/test/unit/model_test.rb

@@ -14,7 +14,7 @@ class HasPaperTrailModelTest < ActiveSupport::TestCase
       setup { @article.update_attributes :title => 'My first title', :content => 'Some text here.' }
       should_change('the number of versions', :by => 1) { Version.count }
     end
-    
+
     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 }
@@ -24,7 +24,7 @@ class HasPaperTrailModelTest < ActiveSupport::TestCase
       setup { @article.update_attributes :abstract => 'Other abstract'}
       should_not_change('the number of versions') { Version.count }
     end
-    
+
   end
 
 
@@ -712,36 +712,36 @@ class HasPaperTrailModelTest < ActiveSupport::TestCase
 
   context 'A new model instance which uses a custom Version class' do
     setup { @post = Post.new }
-    
+
     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 }
     end
   end
-    
+
   context 'An existing model instance which uses a custom Version class' do
     setup { @post = Post.create }
-    
+
     context 'on the first version' do
       setup { @version = @post.versions.first }
-      
+
       should 'have the correct index' do
         assert_equal 0, @version.index
       end
     end
-    
+
     should 'should have versions of the custom class' do
       assert_equal "PostVersion", @post.versions.first.class.name
     end
-    
+
     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 }
     end
   end
-    
+
 
   context 'An overwritten default accessor' do
     setup do

metadata

@@ -1,13 +1,13 @@
 --- !ruby/object:Gem::Specification 
 name: paper_trail
 version: !ruby/object:Gem::Version 
-  hash: 9
+  hash: 7
   prerelease: false
   segments: 
   - 2
-  - 1
-  - 1
-  version: 2.1.1
+  - 2
+  - 0
+  version: 2.2.0
 platform: ruby
 authors: 
 - Andy Stewart
@@ -15,13 +15,12 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2011-03-31 00:00:00 +01:00
+date: 2011-04-05 00:00:00 +01:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency 
-  name: rails
   prerelease: false
-  requirement: &id001 !ruby/object:Gem::Requirement 
+  version_requirements: &id001 !ruby/object:Gem::Requirement 
     none: false
     requirements: 
     - - ~>
@@ -30,12 +29,12 @@ dependencies:
         segments: 
         - 3
         version: "3"
+  requirement: *id001
+  name: rails
   type: :runtime
-  version_requirements: *id001
 - !ruby/object:Gem::Dependency 
-  name: shoulda
   prerelease: false
-  requirement: &id002 !ruby/object:Gem::Requirement 
+  version_requirements: &id002 !ruby/object:Gem::Requirement 
     none: false
     requirements: 
     - - "="
@@ -46,12 +45,12 @@ dependencies:
         - 10
         - 3
         version: 2.10.3
+  requirement: *id002
+  name: shoulda
   type: :development
-  version_requirements: *id002
 - !ruby/object:Gem::Dependency 
-  name: sqlite3-ruby
   prerelease: false
-  requirement: &id003 !ruby/object:Gem::Requirement 
+  version_requirements: &id003 !ruby/object:Gem::Requirement 
     none: false
     requirements: 
     - - ~>
@@ -61,12 +60,12 @@ dependencies:
         - 1
         - 2
         version: "1.2"
+  requirement: *id003
+  name: sqlite3-ruby
   type: :development
-  version_requirements: *id003
 - !ruby/object:Gem::Dependency 
-  name: capybara
   prerelease: false
-  requirement: &id004 !ruby/object:Gem::Requirement 
+  version_requirements: &id004 !ruby/object:Gem::Requirement 
     none: false
     requirements: 
     - - ">="
@@ -77,8 +76,23 @@ dependencies:
         - 4
         - 0
         version: 0.4.0
+  requirement: *id004
+  name: capybara
+  type: :development
+- !ruby/object:Gem::Dependency 
+  prerelease: false
+  version_requirements: &id005 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 3
+        segments: 
+        - 0
+        version: "0"
+  requirement: *id005
+  name: turn
   type: :development
-  version_requirements: *id004
 description: Track changes to your models' data.  Good for auditing or versioning.
 email: boss@airbladesoftware.com
 executables: []