paper_trail 2.2.9 → 2.3.0

data/.travis.yml

@@ -0,0 +1,5 @@
+rvm:
+  - 1.8.7
+  - 1.9.2
+  - ree
+

data/README.md

@@ -1,12 +1,13 @@
-# PaperTrail
+# PaperTrail [![Build Status](http://travis-ci.org/airblade/paper_trail.png)](http://travis-ci.org/airblade/paper_trail)
 
 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.
 
 There's an excellent [Railscast on implementing Undo with Paper Trail](http://railscasts.com/episodes/255-undo-with-paper-trail).
 
+
 ## Features
 
-* Stores every create, update and destroy.
+* Stores every create, update and destroy (or only the lifecycle events you specify).
 * Does not store updates which don't change anything.
 * Allows you to specify attributes (by inclusion or exclusion) which must change for a Version to be stored.
 * Allows you to get at every version, including the original, even once destroyed.
@@ -168,6 +169,16 @@ Here's a helpful table showing what PaperTrail stores:
 PaperTrail stores the values in the Model Before column.  Most other auditing/versioning plugins store the After column.
 
 
+## Choosing Lifecycle Events To Monitor
+
+You can choose which events to track with the `on` option.  For example, to ignore `create` events:
+
+    class Article < ActiveRecord::Base
+      has_paper_trail :on => [:update, :destroy]
+    end
+
+
+
 ## Choosing Attributes To Monitor
 
 You can ignore changes to certain attributes like this:
@@ -331,7 +342,7 @@ Alternatively you could store certain metadata for one type of version, and othe
 You can also specify a custom name for the versions association.  This is useful if you already have a `versions` method on your model.  For example:
 
     class Post < ActiveRecord::Base
-      has_paper_trail :versions_association_name => :paper_trail_versions
+      has_paper_trail :versions => :paper_trail_versions
 
       # Existing versions method.  We don't want to clash.
       def versions

data/lib/paper_trail/has_paper_trail.rb

@@ -11,6 +11,8 @@ module PaperTrail
       # the model is available in the `versions` association.
       #
       # Options:
+      # :on           the events to track (optional; defaults to all of them).  Set to an array of
+      #               `: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.
       # :only         inverse of `ignore` - a new `Version` will be created only for these attributes if supplied
@@ -18,7 +20,7 @@ module PaperTrail
       #               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
       #               the controller.
-      # :versions_association_name    the name to use for the versions association.  Default is `:versions`.
+      # :versions     the name to use for the versions association.  Default is `:versions`.
       def has_paper_trail(options = {})
         # Lazily include the instance methods so we don't clutter up
         # any more ActiveRecord models than we have to.
@@ -50,9 +52,9 @@ module PaperTrail
                  :as         => :item,
                  :order      => "created_at ASC, #{self.primary_key} ASC"
 
-        after_create  :record_create
-        before_update :record_update
-        after_destroy :record_destroy
+        after_create  :record_create  if !options[:on] || options[:on].include?(:create)
+        before_update :record_update  if !options[:on] || options[:on].include?(:update)
+        after_destroy :record_destroy if !options[:on] || options[:on].include?(:destroy)
       end
 
       # Switches PaperTrail off for this class.

data/lib/paper_trail/version_number.rb

@@ -1,3 +1,3 @@
 module PaperTrail
-  VERSION = '2.2.9'
+  VERSION = '2.3.0'
 end

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

@@ -1,3 +1,4 @@
 class Document < ActiveRecord::Base
-  has_paper_trail :versions => :paper_trail_versions
+  has_paper_trail :versions => :paper_trail_versions,
+                  :on => [:create, :update]
 end

data/test/unit/model_test.rb

@@ -833,6 +833,57 @@ class HasPaperTrailModelTest < ActiveSupport::TestCase
     end
   end
 
+  context 'The `on` option' do
+    context 'on create' do
+      setup do
+        Fluxor.instance_eval <<-END
+          has_paper_trail :on => [:create]
+        END
+        @fluxor = Fluxor.create
+        @fluxor.update_attributes :name => 'blah'
+        @fluxor.destroy
+      end
+      should 'only have a version for the create event' do
+        assert_equal 1, @fluxor.versions.length
+        assert_equal 'create', @fluxor.versions.last.event
+      end
+    end
+    context 'on update' do
+      setup do
+        Fluxor.reset_callbacks :create
+        Fluxor.reset_callbacks :update
+        Fluxor.reset_callbacks :destroy
+        Fluxor.instance_eval <<-END
+          has_paper_trail :on => [:update]
+        END
+        @fluxor = Fluxor.create
+        @fluxor.update_attributes :name => 'blah'
+        @fluxor.destroy
+      end
+      should 'only have a version for the update event' do
+        assert_equal 1, @fluxor.versions.length
+        assert_equal 'update', @fluxor.versions.last.event
+      end
+    end
+    context 'on destroy' do
+      setup do
+        Fluxor.reset_callbacks :create
+        Fluxor.reset_callbacks :update
+        Fluxor.reset_callbacks :destroy
+        Fluxor.instance_eval <<-END
+          has_paper_trail :on => [:destroy]
+        END
+        @fluxor = Fluxor.create
+        @fluxor.update_attributes :name => 'blah'
+        @fluxor.destroy
+      end
+      should 'only have a version for the destroy event' do
+        assert_equal 1, @fluxor.versions.length
+        assert_equal 'destroy', @fluxor.versions.last.event
+      end
+    end
+  end
+
   private
 
   # Updates `model`'s last version so it looks like the version was

metadata

@@ -1,13 +1,13 @@
 --- !ruby/object:Gem::Specification 
 name: paper_trail
 version: !ruby/object:Gem::Version 
-  hash: 21
+  hash: 3
   prerelease: false
   segments: 
   - 2
-  - 2
-  - 9
-  version: 2.2.9
+  - 3
+  - 0
+  version: 2.3.0
 platform: ruby
 authors: 
 - Andy Stewart
@@ -15,7 +15,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2011-07-23 00:00:00 +01:00
+date: 2011-08-22 00:00:00 +02:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency 
@@ -103,6 +103,7 @@ extra_rdoc_files: []
 
 files: 
 - .gitignore
+- .travis.yml
 - Gemfile
 - MIT-LICENSE
 - README.md