paper_trail 1.6.4 → 1.6.5

data/README.md

@@ -541,6 +541,7 @@ Many thanks to:
 * Danny Trelogan
 * [Mikl Kurkov](http://github.com/mkurkov)
 * [Franco Catena](https://github.com/francocatena)
+* [Emmanuel](https://github.com/emmanuel)
 
 
 ## Inspirations

data/lib/paper_trail/has_paper_trail.rb

@@ -3,9 +3,6 @@ module PaperTrail
 
     def self.included(base)
       base.send :extend, ClassMethods
-
-      # The version this instance was reified from.
-      attr_accessor :version
     end
 
 
@@ -24,6 +21,9 @@ module PaperTrail
         # any more ActiveRecord models than we have to.
         send :include, InstanceMethods
 
+        # The version this instance was reified from.
+        attr_accessor :version
+
         cattr_accessor :ignore
         self.ignore = (options[:ignore] || []).map &:to_s
 
@@ -71,14 +71,14 @@ module PaperTrail
       def version_at(timestamp)
         # Because a version stores how its object looked *before* the change,
         # we need to look for the first version created *after* the timestamp.
-        version = versions.first :conditions => ['created_at > ?', timestamp], :order => 'created_at ASC, id ASC'
+        version = versions.after(timestamp).first
         version ? version.reify : self
       end
 
       # Returns the object (not a Version) as it was most recently.
       def previous_version
-        last_version = version ? version.previous : versions.last
-        last_version.try :reify
+        preceding_version = version ? version.previous : versions.last
+        preceding_version.try :reify
       end
 
       # Returns the object (not a Version) as it became next.
@@ -98,7 +98,7 @@ module PaperTrail
       end
 
       def record_update
-        if switched_on? && changed_and_we_care?
+        if switched_on? && changed_notably?
           versions.build merge_metadata(:event     => 'update',
                                         :object    => object_to_string(item_before_change),
                                         :whodunnit => PaperTrail.whodunnit)
@@ -117,27 +117,36 @@ module PaperTrail
       def merge_metadata(data)
         # First we merge the model-level metadata in `meta`.
         meta.each do |k,v|
-          data[k] = v.respond_to?(:call) ? v.call(self) : v
+          data[k] = 
+            if v.respond_to?(:call)
+              v.call(self)
+            elsif v.is_a?(Symbol) && respond_to?(v)
+              send(v)
+            else
+              v
+            end
         end
         # Second we merge any extra data from the controller (if available).
         data.merge(PaperTrail.controller_info || {})
       end
 
       def item_before_change
-        previous = self.clone
-        previous.id = id
-        changes.each do |attr, ary|
-          previous.send :write_attribute, attr.to_sym, ary.first
+        self.clone.tap do |previous|
+          previous.id = id
+          changed_attributes.each { |attr, before| previous[attr] = before }
         end
-        previous
       end
 
       def object_to_string(object)
         object.attributes.to_yaml
       end
 
-      def changed_and_we_care?
-        changed? and !(changed - self.class.ignore).empty?
+      def changed_notably?
+        notably_changed.any?
+      end
+
+      def notably_changed
+        changed - self.class.ignore
       end
 
       # Returns `true` if PaperTrail is globally enabled and active for this class,

data/lib/paper_trail/version.rb

@@ -2,6 +2,26 @@ class Version < ActiveRecord::Base
   belongs_to :item, :polymorphic => true
   validates_presence_of :event
 
+  named_scope :with_item_keys, lambda { |item_type, item_id| {
+    :conditions => { :item_type => item_type, :item_id => item_id }
+  } }
+
+  named_scope :subsequent, lambda { |version| {
+    :conditions => ["id > ?", version.is_a?(ActiveRecord::Base) ? version.id : version],
+    :order      => "id ASC",
+  } }
+
+  named_scope :preceding, lambda { |version| {
+    :conditions => ["id < ?", version.is_a?(ActiveRecord::Base) ? version.id : version],
+    :order      => "id DESC",
+  } }
+
+  named_scope :after, lambda { |timestamp| {
+    :conditions => ['created_at > ?', timestamp],
+    # TODO: is this :order necessary, considering its presence on the has_many :versions association?
+    :order      => 'created_at ASC, id ASC'
+  } }
+
   # Restore the item from this version.
   #
   # This will automatically restore all :has_one associations as they were "at the time",
@@ -69,19 +89,20 @@ class Version < ActiveRecord::Base
     whodunnit
   end
 
+  def sibling_versions
+    Version.with_item_keys(item_type, item_id)
+  end
+
   def next
-    Version.first :conditions => ["id > ? AND item_type = ? AND item_id = ?", id, item_type, item_id],
-                  :order => 'id ASC'
+    sibling_versions.subsequent(self).first
   end
 
   def previous
-    Version.first :conditions => ["id < ? AND item_type = ? AND item_id = ?", id, item_type, item_id],
-                  :order => 'id DESC'
+    sibling_versions.preceding(self).first
   end
 
   def index
-    Version.all(:conditions => ["item_type = ? AND item_id = ?", item_type, item_id],
-                :order => 'id ASC').index(self)
+    sibling_versions.all(:select => :id, :order => "id ASC").map(&:id).index(self.id)
   end
 
   private

data/lib/paper_trail/version_number.rb

@@ -1,3 +1,3 @@
 module PaperTrail
-  VERSION = '1.6.4'
+  VERSION = '1.6.5'
 end

data/paper_trail.gemspec

@@ -21,7 +21,10 @@ Gem::Specification.new do |s|
   s.add_development_dependency 'shoulda',       '2.10.3'
   s.add_development_dependency 'activesupport', '~> 2.3'
   s.add_development_dependency 'sqlite3-ruby',  '~> 1.2'
+  # Repeated here to make bundler happy
+  s.add_development_dependency 'activerecord',  '~> 2.3'
+  s.add_development_dependency 'actionpack',    '~> 2.3'
 
-  s.add_dependency 'activerecord',  '>= 2.3'
-  s.add_dependency 'actionpack',    '>= 2.3'
+  s.add_dependency 'activerecord',  '~> 2.3'
+  s.add_dependency 'actionpack',    '~> 2.3'
 end

data/test/paper_trail_model_test.rb

@@ -21,8 +21,13 @@ end
 class Article < ActiveRecord::Base
   has_paper_trail :ignore => [:title],
                   :meta   => {:answer => 42,
+                              :action => :action_data_provider_method,
                               :question => Proc.new { "31 + 11 = #{31 + 11}" },
                               :article_id => Proc.new { |article| article.id } }
+
+  def action_data_provider_method
+    self.object_id.to_s
+  end
 end
 
 class Book < ActiveRecord::Base
@@ -528,6 +533,10 @@ class HasPaperTrailModelTest < Test::Unit::TestCase
         assert_equal @article.id, @article.versions.last.article_id
       end
 
+      should 'store dynamic meta data based on a method of the item' do
+        assert_equal @article.action_data_provider_method, @article.versions.last.action
+      end
+
 
       context 'and updated' do
         setup { @article.update_attributes! :content => 'Better text.' }

data/test/schema.rb

@@ -25,6 +25,7 @@ ActiveRecord::Schema.define(:version => 0) do
 
     # Metadata columns.
     t.integer :answer
+    t.string :action
     t.string  :question
     t.integer :article_id
 

metadata

@@ -1,13 +1,13 @@
 --- !ruby/object:Gem::Specification 
 name: paper_trail
 version: !ruby/object:Gem::Version 
-  hash: 7
+  hash: 5
   prerelease: false
   segments: 
   - 1
   - 6
-  - 4
-  version: 1.6.4
+  - 5
+  version: 1.6.5
 platform: ruby
 authors: 
 - Andy Stewart
@@ -15,14 +15,13 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2010-11-19 00:00:00 +00:00
+date: 2011-02-08 00:00:00 +00:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency 
   name: bundler
-  type: :development
   prerelease: false
-  version_requirements: &id001 !ruby/object:Gem::Requirement 
+  requirement: &id001 !ruby/object:Gem::Requirement 
     none: false
     requirements: 
     - - ~>
@@ -32,12 +31,12 @@ dependencies:
         - 1
         - 0
         version: "1.0"
-  requirement: *id001
+  type: :development
+  version_requirements: *id001
 - !ruby/object:Gem::Dependency 
   name: rake
-  type: :development
   prerelease: false
-  version_requirements: &id002 !ruby/object:Gem::Requirement 
+  requirement: &id002 !ruby/object:Gem::Requirement 
     none: false
     requirements: 
     - - "="
@@ -48,12 +47,12 @@ dependencies:
         - 8
         - 7
         version: 0.8.7
-  requirement: *id002
+  type: :development
+  version_requirements: *id002
 - !ruby/object:Gem::Dependency 
   name: shoulda
-  type: :development
   prerelease: false
-  version_requirements: &id003 !ruby/object:Gem::Requirement 
+  requirement: &id003 !ruby/object:Gem::Requirement 
     none: false
     requirements: 
     - - "="
@@ -64,12 +63,12 @@ dependencies:
         - 10
         - 3
         version: 2.10.3
-  requirement: *id003
+  type: :development
+  version_requirements: *id003
 - !ruby/object:Gem::Dependency 
   name: activesupport
-  type: :development
   prerelease: false
-  version_requirements: &id004 !ruby/object:Gem::Requirement 
+  requirement: &id004 !ruby/object:Gem::Requirement 
     none: false
     requirements: 
     - - ~>
@@ -79,12 +78,12 @@ dependencies:
         - 2
         - 3
         version: "2.3"
-  requirement: *id004
+  type: :development
+  version_requirements: *id004
 - !ruby/object:Gem::Dependency 
   name: sqlite3-ruby
-  type: :development
   prerelease: false
-  version_requirements: &id005 !ruby/object:Gem::Requirement 
+  requirement: &id005 !ruby/object:Gem::Requirement 
     none: false
     requirements: 
     - - ~>
@@ -94,37 +93,68 @@ dependencies:
         - 1
         - 2
         version: "1.2"
-  requirement: *id005
+  type: :development
+  version_requirements: *id005
 - !ruby/object:Gem::Dependency 
   name: activerecord
-  type: :runtime
   prerelease: false
-  version_requirements: &id006 !ruby/object:Gem::Requirement 
+  requirement: &id006 !ruby/object:Gem::Requirement 
     none: false
     requirements: 
-    - - ">="
+    - - ~>
       - !ruby/object:Gem::Version 
         hash: 5
         segments: 
         - 2
         - 3
         version: "2.3"
-  requirement: *id006
+  type: :development
+  version_requirements: *id006
 - !ruby/object:Gem::Dependency 
   name: actionpack
+  prerelease: false
+  requirement: &id007 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ~>
+      - !ruby/object:Gem::Version 
+        hash: 5
+        segments: 
+        - 2
+        - 3
+        version: "2.3"
+  type: :development
+  version_requirements: *id007
+- !ruby/object:Gem::Dependency 
+  name: activerecord
+  prerelease: false
+  requirement: &id008 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ~>
+      - !ruby/object:Gem::Version 
+        hash: 5
+        segments: 
+        - 2
+        - 3
+        version: "2.3"
   type: :runtime
+  version_requirements: *id008
+- !ruby/object:Gem::Dependency 
+  name: actionpack
   prerelease: false
-  version_requirements: &id007 !ruby/object:Gem::Requirement 
+  requirement: &id009 !ruby/object:Gem::Requirement 
     none: false
     requirements: 
-    - - ">="
+    - - ~>
       - !ruby/object:Gem::Version 
         hash: 5
         segments: 
         - 2
         - 3
         version: "2.3"
-  requirement: *id007
+  type: :runtime
+  version_requirements: *id009
 description: Track changes to your models' data.  Good for auditing or versioning.
 email: boss@airbladesoftware.com
 executables: []