paper_trail 2.6.0 → 2.6.1

data/README.md

@@ -358,6 +358,16 @@ This allows you to store each model's versions in a separate table, which is use
 
 Alternatively you could store certain metadata for one type of version, and other metadata for other versions.
 
+If you only use custom version classes and don't use PaperTrail's built-in one, on Rails 3.2 you must:
+
+- either declare PaperTrail's version class abstract like this (in `config/initializers/paper_trail_patch.rb`):
+
+        Version.module_eval do
+          self.abstract_class = true
+        end
+
+- or define a `versions` table in the database so Rails can instantiate the version superclass.
+
 You can also specify custom names for the versions and version associations.  This is useful if you already have `versions` or/and `version` methods on your model.  For example:
 
     class Post < ActiveRecord::Base
@@ -705,6 +715,8 @@ Many thanks to:
 * [Peter Harkins](https://github.com/pushcx)
 * [Mohd Amree](https://github.com/amree)
 * [Nikita Cernovs](https://github.com/nikitachernov)
+* [Jason Noble](https://github.com/jasonnoble)
+* [Jared Mehle](https://github.com/jrmehle)
 
 
 ## Inspirations

data/lib/paper_trail.rb

@@ -32,6 +32,16 @@ module PaperTrail
     paper_trail_store[:request_enabled_for_controller] = value
   end
 
+  # Set the field which records when a version was created.
+  def self.timestamp_field=(field_name)
+    PaperTrail.config.timestamp_field = field_name
+  end
+
+  # Returns the field which records when a version was created.
+  def self.timestamp_field
+    PaperTrail.config.timestamp_field
+  end
+
   # Returns who is reponsible for any changes that occur.
   def self.whodunnit
     paper_trail_store[:whodunnit]

data/lib/paper_trail/config.rb

@@ -1,11 +1,12 @@
 module PaperTrail
   class Config
     include Singleton
-    attr_accessor :enabled
+    attr_accessor :enabled, :timestamp_field
  
     def initialize
       # Indicates whether PaperTrail is on or off.
-      @enabled = true
+      @enabled         = true
+      @timestamp_field = :created_at
     end
   end
 end

data/lib/paper_trail/has_paper_trail.rb

@@ -68,7 +68,7 @@ module PaperTrail
         has_many self.versions_association_name,
                  :class_name => version_class_name,
                  :as         => :item,
-                 :order      => "created_at ASC, #{self.version_class_name.constantize.primary_key} ASC"
+                 :order      => "#{PaperTrail.timestamp_field} ASC, #{self.version_class_name.constantize.primary_key} ASC"
 
         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)

data/lib/paper_trail/version.rb

@@ -8,16 +8,16 @@ class Version < ActiveRecord::Base
   end
 
   scope :subsequent, lambda { |version|
-    where(["#{self.primary_key} > ?", version.is_a?(self) ? version.id : version]).order("#{self.primary_key} ASC")
+    where(["#{self.primary_key} > ?", version.is_a?(self) ? version.send(self.primary_key) : version]).order("#{self.primary_key} ASC")
   }
 
   scope :preceding, lambda { |version|
-    where(["#{self.primary_key} < ?", version.is_a?(self) ? version.id : version]).order("#{self.primary_key} DESC")
+    where(["#{self.primary_key} < ?", version.is_a?(self) ? version.send(self.primary_key) : version]).order("#{self.primary_key} DESC")
   }
 
   scope :following, lambda { |timestamp|
     # TODO: is this :order necessary, considering its presence on the has_many :versions association?
-    where(['created_at > ?', timestamp]).order("created_at ASC, #{self.primary_key} ASC")
+    where(["#{PaperTrail.timestamp_field} > ?", timestamp]).order("#{PaperTrail.timestamp_field} ASC, #{self.primary_key} ASC")
   }
 
   # Restore the item from this version.
@@ -116,7 +116,8 @@ class Version < ActiveRecord::Base
   end
 
   def index
-    sibling_versions.select(:id).order("id ASC").map(&:id).index(self.id)
+    id_column = self.class.primary_key.to_sym
+    sibling_versions.select(id_column).order("#{id_column} ASC").map(&id_column).index(self.send(id_column))
   end
 
   private
@@ -145,7 +146,7 @@ class Version < ActiveRecord::Base
         # but until PaperTrail knows which updates are "together" (e.g. parent and child being
         # updated on the same form), it's impossible to tell when the overall update started;
         # and therefore impossible to know when "just before" was.
-        if (child_as_it_was = child.version_at(created_at - lookback.seconds))
+        if (child_as_it_was = child.version_at(send(PaperTrail.timestamp_field) - lookback.seconds))
           child_as_it_was.attributes.each do |k,v|
             model.send(assoc.name).send :write_attribute, k.to_sym, v rescue nil
           end

data/lib/paper_trail/version_number.rb

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

data/paper_trail.gemspec

@@ -20,5 +20,5 @@ Gem::Specification.new do |s|
   s.add_development_dependency 'rake'
   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 'capybara',     '~> 1.0.0'
 end

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

@@ -1,4 +1,4 @@
 class Animal < ActiveRecord::Base
   has_paper_trail
-  set_inheritance_column 'species'
+  self.inheritance_column = 'species'
 end

data/test/dummy/app/versions/post_version.rb

@@ -1,3 +1,3 @@
 class PostVersion < Version
-  set_table_name :post_versions
+  self.table_name = 'post_versions'
 end

data/test/support/integration_case.rb

@@ -1,5 +1,5 @@
 # Define a bare test case to use with Capybara
 class ActiveSupport::IntegrationCase < ActiveSupport::TestCase
-  include Capybara
+  include Capybara::DSL
   include Rails.application.routes.url_helpers
 end

data/test/test_helper.rb

@@ -38,6 +38,7 @@ def change_schema
   ActiveRecord::Migration.verbose = false
   ActiveRecord::Schema.define do
     remove_column :widgets, :sacrificial_column
+    add_column :versions, :custom_created_at, :datetime
   end
   ActiveRecord::Migration.verbose = true
 end

data/test/unit/timestamp_test.rb

@@ -0,0 +1,39 @@
+require 'test_helper'
+
+class TimestampTest < ActiveSupport::TestCase
+
+  setup do
+    PaperTrail.config.timestamp_field = :custom_created_at
+    change_schema
+    Version.reset_column_information
+
+    Fluxor.instance_eval <<-END
+      has_paper_trail
+    END
+
+    @fluxor = Fluxor.create :name => 'Some text.'
+    @fluxor.update_attributes :name => 'Some more text.'
+    @fluxor.update_attributes :name => 'Even more text.'
+  end
+
+  test 'versions works with custom timestamp field' do
+    # Normal behaviour
+    assert_equal 3, @fluxor.versions.length
+    assert_nil @fluxor.versions[0].reify
+    assert_equal 'Some text.', @fluxor.versions[1].reify.name
+    assert_equal 'Some more text.', @fluxor.versions[2].reify.name
+
+    # Tinker with custom timestamps.
+    now = Time.now.utc
+    @fluxor.versions.reverse.each_with_index do |version, index|
+      version.update_attribute :custom_created_at, (now + index.seconds)
+    end
+
+    # Test we are ordering by custom timestamps.
+    @fluxor.versions true  # reload association
+    assert_nil @fluxor.versions[2].reify
+    assert_equal 'Some text.', @fluxor.versions[1].reify.name
+    assert_equal 'Some more text.', @fluxor.versions[0].reify.name
+  end
+
+end

metadata

@@ -1,13 +1,13 @@
 --- !ruby/object:Gem::Specification 
 name: paper_trail
 version: !ruby/object:Gem::Version 
-  hash: 23
+  hash: 21
   prerelease: 
   segments: 
   - 2
   - 6
-  - 0
-  version: 2.6.0
+  - 1
+  version: 2.6.1
 platform: ruby
 authors: 
 - Andy Stewart
@@ -15,13 +15,13 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2012-01-18 00:00:00 +01:00
+date: 2012-03-12 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: 
     - - ~>
@@ -31,11 +31,11 @@ dependencies:
         - 3
         version: "3"
   type: :runtime
-  version_requirements: *id001
+  requirement: *id001
 - !ruby/object:Gem::Dependency 
   name: rake
   prerelease: false
-  requirement: &id002 !ruby/object:Gem::Requirement 
+  version_requirements: &id002 !ruby/object:Gem::Requirement 
     none: false
     requirements: 
     - - ">="
@@ -45,11 +45,11 @@ dependencies:
         - 0
         version: "0"
   type: :development
-  version_requirements: *id002
+  requirement: *id002
 - !ruby/object:Gem::Dependency 
   name: shoulda
   prerelease: false
-  requirement: &id003 !ruby/object:Gem::Requirement 
+  version_requirements: &id003 !ruby/object:Gem::Requirement 
     none: false
     requirements: 
     - - "="
@@ -61,11 +61,11 @@ dependencies:
         - 3
         version: 2.10.3
   type: :development
-  version_requirements: *id003
+  requirement: *id003
 - !ruby/object:Gem::Dependency 
   name: sqlite3-ruby
   prerelease: false
-  requirement: &id004 !ruby/object:Gem::Requirement 
+  version_requirements: &id004 !ruby/object:Gem::Requirement 
     none: false
     requirements: 
     - - ~>
@@ -76,23 +76,23 @@ dependencies:
         - 2
         version: "1.2"
   type: :development
-  version_requirements: *id004
+  requirement: *id004
 - !ruby/object:Gem::Dependency 
   name: capybara
   prerelease: false
-  requirement: &id005 !ruby/object:Gem::Requirement 
+  version_requirements: &id005 !ruby/object:Gem::Requirement 
     none: false
     requirements: 
-    - - ">="
+    - - ~>
       - !ruby/object:Gem::Version 
-        hash: 15
+        hash: 23
         segments: 
+        - 1
         - 0
-        - 4
         - 0
-        version: 0.4.0
+        version: 1.0.0
   type: :development
-  version_requirements: *id005
+  requirement: *id005
 description: Track changes to your models' data.  Good for auditing or versioning.
 email: boss@airbladesoftware.com
 executables: []
@@ -180,6 +180,7 @@ files:
 - test/test_helper.rb
 - test/unit/inheritance_column_test.rb
 - test/unit/model_test.rb
+- test/unit/timestamp_test.rb
 has_rdoc: true
 homepage: http://github.com/airblade/paper_trail
 licenses: []
@@ -276,3 +277,4 @@ test_files:
 - test/test_helper.rb
 - test/unit/inheritance_column_test.rb
 - test/unit/model_test.rb
+- test/unit/timestamp_test.rb