paper_trail 3.0.2 → 3.0.5

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: a4b0bcf1de1e90e178545aca16201e7f3bf5de2a
-  data.tar.gz: 01b443dae88b5d51479bbca1e788b723f2c37c89
+  metadata.gz: 3ee3ec4b4dd8dfad13cbe5e9b46ccfa30f3318a3
+  data.tar.gz: 20559b46236a0318c4b7e2eb940bfbd79600cfad
 SHA512:
-  metadata.gz: f4ca7aa698867e094708d43673e77a29a681674ab3ddceefda21df783167d7f5876e0ea067945978e58615b25fdd7229f27a1630100d881c9da99feb01ee873a
-  data.tar.gz: f01d87966c55fe86b9894d015cf906ef833fe70e67187a920aa20676694ab5a1c64a79182917fbdb6b5a0cd8ea66d457f3d2370862f6ce764af0573530bbb112
+  metadata.gz: 6cf548b9641d5994bf67b3e886d4ed60fed0d6d16e9134e6374ca8ecaaa7ff3662fd4d97684e2bd1b59cffa710f1e19a58c0d4679433483dcd471fdc4ef201ad
+  data.tar.gz: 3ae713d8799f7ce5b95b5787134eeaf3aada506b1c71a89d3e25e3703c1fbc5a809f183e0a62c521c65f473312261e5049843d01a54166243ddac7a994120332

data/CHANGELOG.md

@@ -1,3 +1,26 @@
+## 3.0.5
+
+  - [#401](https://github.com/airblade/paper_trail/issues/401) / [#406](https://github.com/airblade/paper_trail/issues/406)
+    `PaperTrail::Version` class is not loaded via a `Rails::Engine`, even when the gem is used with in Rails. This feature has
+    will be re-introduced in version `3.1.0`.
+
+## 3.0.3
+*This version was yanked from RubyGems and has been replaced by version `3.0.5`, which is identical but does not eager load
+in the `PaperTrail::Version` class through a `Rails::Engine` when the gem is used on Rails since it was causing issues for some users.*
+
+  - [#386](https://github.com/airblade/paper_trail/issues/386) - Fix eager loading of `versions` association with custom class name
+    in `ActiveRecord` 4.1.
+  - [#384](https://github.com/airblade/paper_trail/issues/384) - Fix `VersionConcern#originator` instance method.
+  - [#383](https://github.com/airblade/paper_trail/pull/383) - Make gem compatible with `ActiveRecord::Enum` (available in `ActiveRecord` 4.1+).
+  - [#380](https://github.com/airblade/paper_trail/pull/380) / [#377](https://github.com/airblade/paper_trail/issues/377) -
+    Add `VersionConcern#where_object` instance method; acts as a helper for querying against the `object` column in versions table.
+  - [#373](https://github.com/airblade/paper_trail/pull/373) - Fix default sort order for the `versions` association in `ActiveRecord` 4.1.
+  - [#372](https://github.com/airblade/paper_trail/pull/372) - Use [Arel](https://github.com/rails/arel) for SQL construction.
+  - [#365](https://github.com/airblade/paper_trail/issues/365) - `VersionConcern#version_at` should return `nil` when receiving a timestamp
+    that occured after the object was destroyed.
+  - Expand `PaperTrail::VERSION` into a module, mimicking the form used by Rails to give it some additional modularity & versatility.
+  - Fixed `VersionConcern#index` instance method so that it conforms to using the primary key for ordering when possible.
+
 ## 3.0.2
 
   - [#357](https://github.com/airblade/paper_trail/issues/357) - If a `Version` instance is reified and then persisted at that state,

data/README.md

@@ -40,9 +40,9 @@ The Rails 2.3 code is on the [`rails2`](https://github.com/airblade/paper_trail/
 
 ### Rails 3 & 4
 
-1. Add `PaperTrail` to your `Gemfile`.
+1. Add PaperTrail to your `Gemfile`.
 
-    `gem 'paper_trail', '~> 3.0.2'`
+    `gem 'paper_trail', '~> 3.0.5'`
 
 2. Generate a migration which will add a `versions` table to your database.
 
@@ -56,15 +56,15 @@ The Rails 2.3 code is on the [`rails2`](https://github.com/airblade/paper_trail/
 
 ### Sinatra
 
-In order to configure `PaperTrail` for usage with [Sinatra](http://www.sinatrarb.com),
-your `Sinatra` app must be using `ActiveRecord` 3 or  `ActiveRecord` 4. It is also recommended to use the
+In order to configure PaperTrail for usage with [Sinatra](http://www.sinatrarb.com),
+your `Sinatra` app must be using `ActiveRecord` 3 or 4. It is also recommended to use the
 [Sinatra ActiveRecord Extension](https://github.com/janko-m/sinatra-activerecord) or something similar for managing
 your applications `ActiveRecord` connection in a manner similar to the way `Rails` does. If using the aforementioned
-`Sinatra ActiveRecord Extension`, steps for setting up your app with `PaperTrail` will look something like this:
+`Sinatra ActiveRecord Extension`, steps for setting up your app with PaperTrail will look something like this:
 
-1. Add `PaperTrail` to your `Gemfile`.
+1. Add PaperTrail to your `Gemfile`.
 
-    `gem 'paper_trail', '~> 3.0.2'`
+    `gem 'paper_trail', '~> 3.0.5'`
 
 2. Generate a migration to add a `versions` table to your database.
 
@@ -813,11 +813,14 @@ If you disable PaperTrail in your test environment but want to enable it for spe
 # in test/test_helper.rb
 def with_versioning
   was_enabled = PaperTrail.enabled?
+  was_enabled_for_controller = PaperTrail.enabled_for_controller?
   PaperTrail.enabled = true
+  PaperTrail.enabled_for_controller = true
   begin
     yield
   ensure
     PaperTrail.enabled = was_enabled
+    PaperTrail.enabled_for_controller = was_enabled_for_controller
   end
 end
 ```
@@ -1004,9 +1007,9 @@ Spork.prefork do
 end
 ```
 
-### Zeus
+### Zeus or Spring
 
-If you wish to use the `RSpec` or `Cucumber` heleprs with [Zeus](https://github.com/burke/zeus), you will need to
+If you wish to use the `RSpec` or `Cucumber` helpers with [Zeus](https://github.com/burke/zeus) or [Spring](https://github.com/rails/spring), you will need to
 manually require the helper(s) in your test helper, like so:
 
 ```ruby
@@ -1032,6 +1035,7 @@ export DB=sqlite # this is default
 
 ## Articles
 
+* [Versioning with PaperTrail](http://www.sitepoint.com/versioning-papertrail), [Ilya Bodrov](http://www.sitepoint.com/author/ibodrov), 10th April 2014
 * [Using PaperTrail to track stack traces](http://rubyrailsexpert.com/?p=36), T James Corcoran's blog, 1st October 2013.
 * [RailsCast #255 - Undo with PaperTrail](http://railscasts.com/episodes/255-undo-with-paper-trail), 28th February 2011.
 * [Keep a Paper Trail with PaperTrail](http://www.linux-mag.com/id/7528), Linux Magazine, 16th September 2009.
@@ -1046,6 +1050,7 @@ Please use GitHub's [issue tracker](http://github.com/airblade/paper_trail/issue
 
 Many thanks to:
 
+* [Dmitry Polushkin](https://github.com/dmitry)
 * [Russell Osborne](https://github.com/rposborne)
 * [Zachery Hostens](http://github.com/zacheryph)
 * [Jeremy Weiskotten](http://github.com/jeremyw)

data/gemfiles/3.0.gemfile

@@ -19,7 +19,7 @@ group :development, :test do
   gem 'generator_spec'
 
   # To do proper transactional testing with ActiveSupport::TestCase on MySQL
-  gem 'database_cleaner', '~> 1.2'
+  gem 'database_cleaner', '~> 1.2.0'
 
   platforms :ruby do 
     gem 'sqlite3', '~> 1.2'

data/lib/paper_trail.rb

@@ -1,10 +1,12 @@
-require 'paper_trail/config'
-require 'paper_trail/has_paper_trail'
-require 'paper_trail/cleaner'
-require 'paper_trail/version_number'
+# Require core library
+Dir[File.join(File.dirname(__FILE__), 'paper_trail', '*.rb')].each do |file|
+  require File.join('paper_trail', File.basename(file, '.rb'))
+end
 
 # Require serializers
-Dir[File.join(File.dirname(__FILE__), 'paper_trail', 'serializers', '*.rb')].each { |file| require file }
+Dir[File.join(File.dirname(__FILE__), 'paper_trail', 'serializers', '*.rb')].each do |file|
+  require File.join('paper_trail', 'serializers', File.basename(file, '.rb'))
+end
 
 module PaperTrail
   extend PaperTrail::Cleaner
@@ -118,21 +120,13 @@ unless PaperTrail.active_record_protected_attributes?
   rescue LoadError; end # will rescue if `ProtectedAttributes` gem is not available
 end
 
-require 'paper_trail/version'
-
 ActiveSupport.on_load(:active_record) do
   include PaperTrail::Model
 end
 
 # Require frameworks
+require 'paper_trail/frameworks/active_record'
 require 'paper_trail/frameworks/sinatra'
-require 'paper_trail/frameworks/rspec' if defined? RSpec
+require 'paper_trail/frameworks/rails' if defined? Rails
+require 'paper_trail/frameworks/rspec' if defined? RSpec::Core
 require 'paper_trail/frameworks/cucumber' if defined? World
-
-if defined?(ActionController)
-  require 'paper_trail/frameworks/rails'
-
-  ActiveSupport.on_load(:action_controller) do
-    include PaperTrail::Rails::Controller
-  end
-end

data/lib/paper_trail/frameworks/active_record.rb

@@ -0,0 +1,5 @@
+# This file only needs to be loaded if the gem is being used outside of Rails, since otherwise
+# the model(s) will get loaded in via the `Rails::Engine`
+Dir[File.join(File.dirname(__FILE__), 'active_record', 'models', 'paper_trail', '*.rb')].each do |file|
+  require "paper_trail/frameworks/active_record/models/paper_trail/#{File.basename(file, '.rb')}"
+end

data/lib/paper_trail/{version.rb → frameworks/active_record/models/paper_trail/version.rb}

@@ -1,4 +1,4 @@
-require File.expand_path('../version_concern', __FILE__)
+require 'paper_trail/version_concern'
 
 module PaperTrail
   class Version < ::ActiveRecord::Base

data/lib/paper_trail/frameworks/rails.rb

@@ -1,74 +1,6 @@
+require 'paper_trail/frameworks/rails/controller'
+
 module PaperTrail
   module Rails
-    module Controller
-
-      def self.included(base)
-        base.before_filter :set_paper_trail_enabled_for_controller
-        base.before_filter :set_paper_trail_whodunnit, :set_paper_trail_controller_info
-      end
-
-      protected
-
-      # Returns the user who is responsible for any changes that occur.
-      # By default this calls `current_user` and returns the result.
-      #
-      # Override this method in your controller to call a different
-      # method, e.g. `current_person`, or anything you like.
-      def user_for_paper_trail
-        return unless defined?(current_user)
-        ActiveSupport::VERSION::MAJOR >= 4 ? current_user.try!(:id) : current_user.try(:id)
-      rescue NoMethodError
-        current_user
-      end
-
-      # Returns any information about the controller or request that you
-      # want PaperTrail to store alongside any changes that occur.  By
-      # default this returns an empty hash.
-      #
-      # Override this method in your controller to return a hash of any
-      # information you need.  The hash's keys must correspond to columns
-      # in your `versions` table, so don't forget to add any new columns
-      # you need.
-      #
-      # For example:
-      #
-      #     {:ip => request.remote_ip, :user_agent => request.user_agent}
-      #
-      # The columns `ip` and `user_agent` must exist in your `versions` # table.
-      #
-      # Use the `:meta` option to `PaperTrail::Model::ClassMethods.has_paper_trail`
-      # to store any extra model-level data you need.
-      def info_for_paper_trail
-        {}
-      end
-
-      # Returns `true` (default) or `false` depending on whether PaperTrail should
-      # be active for the current request.
-      #
-      # Override this method in your controller to specify when PaperTrail should
-      # be off.
-      def paper_trail_enabled_for_controller
-        ::PaperTrail.enabled?
-      end
-
-      private
-
-      # Tells PaperTrail whether versions should be saved in the current request.
-      def set_paper_trail_enabled_for_controller
-        ::PaperTrail.enabled_for_controller = paper_trail_enabled_for_controller
-      end
-
-      # Tells PaperTrail who is responsible for any changes that occur.
-      def set_paper_trail_whodunnit
-        ::PaperTrail.whodunnit = user_for_paper_trail if ::PaperTrail.enabled_for_controller?
-      end
-
-      # Tells PaperTrail any information from the controller you want
-      # to store alongside any changes that occur.
-      def set_paper_trail_controller_info
-        ::PaperTrail.controller_info = info_for_paper_trail if ::PaperTrail.enabled_for_controller?
-      end
-
-    end
   end
 end

data/lib/paper_trail/frameworks/rails/controller.rb

@@ -0,0 +1,78 @@
+module PaperTrail
+  module Rails
+    module Controller
+
+      def self.included(base)
+        base.before_filter :set_paper_trail_enabled_for_controller
+        base.before_filter :set_paper_trail_whodunnit, :set_paper_trail_controller_info
+      end
+
+      protected
+
+      # Returns the user who is responsible for any changes that occur.
+      # By default this calls `current_user` and returns the result.
+      #
+      # Override this method in your controller to call a different
+      # method, e.g. `current_person`, or anything you like.
+      def user_for_paper_trail
+        return unless defined?(current_user)
+        ActiveSupport::VERSION::MAJOR >= 4 ? current_user.try!(:id) : current_user.try(:id)
+      rescue NoMethodError
+        current_user
+      end
+
+      # Returns any information about the controller or request that you
+      # want PaperTrail to store alongside any changes that occur.  By
+      # default this returns an empty hash.
+      #
+      # Override this method in your controller to return a hash of any
+      # information you need.  The hash's keys must correspond to columns
+      # in your `versions` table, so don't forget to add any new columns
+      # you need.
+      #
+      # For example:
+      #
+      #     {:ip => request.remote_ip, :user_agent => request.user_agent}
+      #
+      # The columns `ip` and `user_agent` must exist in your `versions` # table.
+      #
+      # Use the `:meta` option to `PaperTrail::Model::ClassMethods.has_paper_trail`
+      # to store any extra model-level data you need.
+      def info_for_paper_trail
+        {}
+      end
+
+      # Returns `true` (default) or `false` depending on whether PaperTrail should
+      # be active for the current request.
+      #
+      # Override this method in your controller to specify when PaperTrail should
+      # be off.
+      def paper_trail_enabled_for_controller
+        ::PaperTrail.enabled?
+      end
+
+      private
+
+      # Tells PaperTrail whether versions should be saved in the current request.
+      def set_paper_trail_enabled_for_controller
+        ::PaperTrail.enabled_for_controller = paper_trail_enabled_for_controller
+      end
+
+      # Tells PaperTrail who is responsible for any changes that occur.
+      def set_paper_trail_whodunnit
+        ::PaperTrail.whodunnit = user_for_paper_trail if ::PaperTrail.enabled_for_controller?
+      end
+
+      # Tells PaperTrail any information from the controller you want
+      # to store alongside any changes that occur.
+      def set_paper_trail_controller_info
+        ::PaperTrail.controller_info = info_for_paper_trail if ::PaperTrail.enabled_for_controller?
+      end
+
+    end
+  end
+
+  if defined?(::ActionController)
+    ::ActiveSupport.on_load(:action_controller) { include PaperTrail::Rails::Controller }
+  end
+end

data/lib/paper_trail/frameworks/rails/engine.rb

@@ -0,0 +1,7 @@
+module PaperTrail
+  module Rails
+    class Engine < ::Rails::Engine
+      paths['app/models'] << 'lib/paper_trail/frameworks/active_record/models'
+    end
+  end
+end

data/lib/paper_trail/has_paper_trail.rb

@@ -61,7 +61,7 @@ module PaperTrail
 
         if ::ActiveRecord::VERSION::MAJOR >= 4 # `has_many` syntax for specifying order uses a lambda in Rails 4
           has_many self.versions_association_name,
-            lambda { |model| order(model.version_class_name.constantize.timestamp_sort_order) },
+            lambda { order(model.timestamp_sort_order) },
             :class_name => self.version_class_name, :as => :item
         else
           has_many self.versions_association_name,
@@ -174,7 +174,7 @@ module PaperTrail
 
       # Returns who put the object into its current state.
       def originator
-        @originator ||= self.class.paper_trail_version_class.with_item_keys(self.class.base_class.name, id).last.try :whodunnit
+        (source_version || send(self.class.versions_association_name).last).try(:whodunnit)
       end
 
       # Returns the object (not a Version) as it was at the given timestamp.
@@ -182,7 +182,8 @@ module PaperTrail
         # Because a version stores how its object looked *before* the change,
         # we need to look for the first version created *after* the timestamp.
         v = send(self.class.versions_association_name).subsequent(timestamp, true).first
-        v ? v.reify(reify_options) : self
+        return v.reify(reify_options) if v
+        self unless self.destroyed?
       end
 
       # Returns the objects (not Versions) as they were between the given times.
@@ -290,7 +291,7 @@ module PaperTrail
         end.tap { |changes| self.class.serialize_attribute_changes(changes) }
       end
 
-      # Invoked via `after_update` callback for when a previous version is reified and then saved
+      # Invoked via`after_update` callback for when a previous version is reified and then saved
       def clear_version_instance!
         send("#{self.class.version_association_name}=", nil)
       end
@@ -342,9 +343,13 @@ module PaperTrail
         all_timestamp_attributes.each do |column|
           previous[column] = send(column) if self.class.column_names.include?(column.to_s) and not send(column).nil?
         end
+        enums = previous.respond_to?(:defined_enums) ? previous.defined_enums : {}
         previous.tap do |prev|
           prev.id = id # `dup` clears the `id` so we add that back
-          changed_attributes.select { |k,v| self.class.column_names.include?(k) }.each { |attr, before| prev[attr] = before }
+          changed_attributes.select { |k,v| self.class.column_names.include?(k) }.each do |attr, before|
+            before = enums[attr][before] if enums[attr]
+            prev[attr] = before
+          end
         end
       end
 

data/lib/paper_trail/serializers/json.rb

@@ -12,6 +12,25 @@ module PaperTrail
       def dump(object)
         ActiveSupport::JSON.encode object
       end
+
+      # Returns a SQL condition to be used to match the given field and value in
+      # the serialized object.
+      def where_object_condition(arel_field, field, value)
+        # Convert to JSON to handle strings and nulls correctly.
+        json_value = value.to_json
+
+        # If the value is a number, we need to ensure that we find the next
+        # character too, which is either `,` or `}`, to ensure that searching
+        # for the value 12 doesn't yield false positives when the value is
+        # 123.
+        if value.is_a? Numeric
+          arel_field.matches("%\"#{field}\":#{json_value},%").
+            or(
+          arel_field.matches("%\"#{field}\":#{json_value}}%"))
+        else
+          arel_field.matches("%\"#{field}\":#{json_value}%")
+        end
+      end
     end
   end
 end

data/lib/paper_trail/serializers/yaml.rb

@@ -12,6 +12,12 @@ module PaperTrail
       def dump(object)
         ::YAML.dump object
       end
+
+      # Returns a SQL condition to be used to match the given field and value in
+      # the serialized object.
+      def where_object_condition(arel_field, field, value)
+        arel_field.matches("%\n#{field}: #{value}\n%")
+      end
     end
   end
 end

data/lib/paper_trail/version_concern.rb

@@ -37,35 +37,50 @@ module PaperTrail
       # `timestamp_arg` receives `true`
       def subsequent(obj, timestamp_arg = false)
         if timestamp_arg != true && self.primary_key_is_int?
-          return where("#{table_name}.#{self.primary_key} > ?", obj).order("#{table_name}.#{self.primary_key} ASC")
+          return where(arel_table[primary_key].gt(obj.id)).order(arel_table[primary_key].asc)
         end
 
         obj = obj.send(PaperTrail.timestamp_field) if obj.is_a?(self)
-        where("#{table_name}.#{PaperTrail.timestamp_field} > ?", obj).order(self.timestamp_sort_order)
+        where(arel_table[PaperTrail.timestamp_field].gt(obj)).order(self.timestamp_sort_order)
       end
 
       def preceding(obj, timestamp_arg = false)
         if timestamp_arg != true && self.primary_key_is_int?
-          return where("#{table_name}.#{self.primary_key} < ?", obj).order("#{table_name}.#{self.primary_key} DESC")
+          return where(arel_table[primary_key].lt(obj.id)).order(arel_table[primary_key].desc)
         end
 
         obj = obj.send(PaperTrail.timestamp_field) if obj.is_a?(self)
-        where("#{table_name}.#{PaperTrail.timestamp_field} < ?", obj).order(self.timestamp_sort_order('DESC'))
+        where(arel_table[PaperTrail.timestamp_field].lt(obj)).order(self.timestamp_sort_order('desc'))
       end
 
 
       def between(start_time, end_time)
-        where("#{table_name}.#{PaperTrail.timestamp_field} > ? AND #{table_name}.#{PaperTrail.timestamp_field} < ?",
-          start_time, end_time).order(self.timestamp_sort_order)
+        where(
+          arel_table[PaperTrail.timestamp_field].gt(start_time).
+          and(arel_table[PaperTrail.timestamp_field].lt(end_time))
+        ).order(self.timestamp_sort_order)
       end
 
       # defaults to using the primary key as the secondary sort order if possible
-      def timestamp_sort_order(order = 'ASC')
-        if self.primary_key_is_int?
-          "#{table_name}.#{PaperTrail.timestamp_field} #{order}, #{table_name}.#{self.primary_key} #{order}"
-        else
-          "#{table_name}.#{PaperTrail.timestamp_field} #{order}"
+      def timestamp_sort_order(direction = 'asc')
+        [arel_table[PaperTrail.timestamp_field].send(direction.downcase)].tap do |array|
+          array << arel_table[primary_key].send(direction.downcase) if self.primary_key_is_int?
+        end
+      end
+
+      # Performs an attribute search on the serialized object by invoking the
+      # identically-named method in the serializer being used.
+      def where_object(args = {})
+        raise ArgumentError, 'expected to receive a Hash' unless args.is_a?(Hash)
+        arel_field = arel_table[:object]
+
+        where_conditions = args.map do |field, value|
+          PaperTrail.serializer.where_object_condition(arel_field, field, value)
+        end.reduce do |condition1, condition2|
+          condition1.and(condition2)
         end
+
+        where(where_conditions)
       end
 
       def primary_key_is_int?
@@ -189,10 +204,14 @@ module PaperTrail
     end
 
     def index
-      table_name = self.class.table_name
-      @index ||= sibling_versions.
-        select(["#{table_name}.#{PaperTrail.timestamp_field}", "#{table_name}.#{self.class.primary_key}"]).
-        order("#{table_name}.#{PaperTrail.timestamp_field} ASC").index(self)
+      table = self.class.arel_table unless @index
+      @index ||=
+        if self.class.primary_key_is_int?
+          sibling_versions.select(table[self.class.primary_key]).order(table[self.class.primary_key].asc).index(self)
+        else
+          sibling_versions.select([table[PaperTrail.timestamp_field], table[self.class.primary_key]]).
+            order(self.class.timestamp_sort_order).index(self)
+        end
     end
 
     private

data/lib/paper_trail/version_number.rb

@@ -1,3 +1,18 @@
 module PaperTrail
-  VERSION = '3.0.2'
+  module VERSION
+    MAJOR = 3
+    MINOR = 0
+    TINY  = 5
+    PRE   = nil
+
+    STRING = [MAJOR, MINOR, TINY, PRE].compact.join('.')
+
+    def self.to_s
+      STRING
+    end
+  end
+
+  def self.version
+    VERSION::STRING
+  end
 end

data/paper_trail.gemspec

@@ -3,7 +3,7 @@ require 'paper_trail/version_number'
 
 Gem::Specification.new do |s|
   s.name          = 'paper_trail'
-  s.version       = PaperTrail::VERSION
+  s.version       = PaperTrail.version
   s.platform      = Gem::Platform::RUBY
   s.summary       = "Track changes to your models' data. Good for auditing or versioning."
   s.description   = s.summary

data/spec/models/post_with_status_spec.rb

@@ -0,0 +1,17 @@
+require 'spec_helper'
+
+# This model is in the test suite soley for the purpose of testing ActiveRecord::Enum,
+# which is available in ActiveRecord4+ only
+describe PostWithStatus do
+  if defined?(ActiveRecord::Enum)
+    with_versioning do
+      let(:post) { PostWithStatus.create!(:status => 'draft') }
+
+      it "should stash the enum value properly in versions" do
+        post.published!
+        post.archived!
+        post.previous_version.published?.should == true
+      end
+    end
+  end
+end

data/spec/models/version_spec.rb

@@ -40,5 +40,49 @@ describe PaperTrail::Version do
         end
       end
     end
+
+    describe "Class" do
+      describe :where_object do
+        it { PaperTrail::Version.should respond_to(:where_object) }
+
+        context "invalid arguments" do
+          it "should raise an error" do
+            expect { PaperTrail::Version.where_object(:foo) }.to raise_error(ArgumentError)
+            expect { PaperTrail::Version.where_object([]) }.to raise_error(ArgumentError)
+          end
+        end
+
+        context "valid arguments", :versioning => true do
+          let(:widget) { Widget.new }
+          let(:name) { Faker::Name.first_name }
+          let(:int) { rand(10) + 1 }
+
+          before do
+            widget.update_attributes!(:name => name, :an_integer => int)
+            widget.update_attributes!(:name => 'foobar', :an_integer => 100)
+            widget.update_attributes!(:name => Faker::Name.last_name, :an_integer => 15)
+          end
+
+          context "`serializer == YAML`" do
+            specify { PaperTrail.serializer == PaperTrail::Serializers::YAML }
+
+            it "should be able to locate versions according to their `object` contents" do
+              PaperTrail::Version.where_object(:name => name).should == [widget.versions[1]]
+              PaperTrail::Version.where_object(:an_integer => 100).should == [widget.versions[2]]
+            end
+          end
+
+          context "`serializer == JSON`" do
+            before { PaperTrail.serializer = PaperTrail::Serializers::JSON }
+            specify { PaperTrail.serializer == PaperTrail::Serializers::JSON }
+
+            it "should be able to locate versions according to their `object` contents" do
+              PaperTrail::Version.where_object(:name => name).should == [widget.versions[1]]
+              PaperTrail::Version.where_object(:an_integer => 100).should == [widget.versions[2]]
+            end
+          end
+        end
+      end
+    end
   end
 end

data/spec/models/widget_spec.rb

@@ -61,8 +61,65 @@ describe Widget do
     end
   end
 
+  describe "Association", :versioning => true do
+    describe "sort order" do
+      it "should sort by the timestamp order from the `VersionConcern`" do
+        widget.versions.to_sql.should ==
+          widget.versions.reorder(PaperTrail::Version.timestamp_sort_order).to_sql
+      end
+    end
+  end
+
   describe "Methods" do
     describe "Instance", :versioning => true do
+      describe :originator do
+        it { should respond_to(:originator) }
+
+        describe "return value" do
+          let(:orig_name) { Faker::Name.name }
+          let(:new_name) { Faker::Name.name }
+          before { PaperTrail.whodunnit = orig_name }
+
+          context "accessed from live model instance" do
+            specify { widget.should be_live }
+
+            it "should return the originator for the model at a given state" do
+              widget.originator.should == orig_name
+              widget.whodunnit(new_name) { |w| w.update_attributes(:name => 'Elizabeth') }
+              widget.originator.should == new_name
+            end
+          end
+
+          context "accessed from a reified model instance" do
+            before do
+              widget.update_attributes(:name => 'Andy')
+              PaperTrail.whodunnit = new_name
+              widget.update_attributes(:name => 'Elizabeth')
+            end
+            let(:reified_widget) { widget.versions[1].reify }
+
+            it "should return the appropriate originator" do
+              reified_widget.originator.should == orig_name
+            end
+          end
+        end
+      end
+
+      describe :version_at do
+        it { should respond_to(:version_at) }
+
+        context "Timestamp argument is AFTER object has been destroyed" do
+          before do
+            widget.update_attribute(:name, 'foobar')
+            widget.destroy
+          end
+
+          it "should return `nil`" do
+            widget.version_at(Time.now).should be_nil
+          end
+        end
+      end
+
       describe :whodunnit do
         it { should respond_to(:whodunnit) }
 
@@ -127,9 +184,9 @@ describe Widget do
         it { should respond_to(:paper_trail_off!) }
 
         it 'should set the `paper_trail_enabled_for_model?` to `false`' do
-          subject.paper_trail_enabled_for_model?.should be_true
+          subject.paper_trail_enabled_for_model?.should == true
           subject.paper_trail_off!
-          subject.paper_trail_enabled_for_model?.should be_false
+          subject.paper_trail_enabled_for_model?.should == false
         end
       end
 
@@ -154,9 +211,9 @@ describe Widget do
         it { should respond_to(:paper_trail_on!) }
 
         it 'should set the `paper_trail_enabled_for_model?` to `true`' do
-          subject.paper_trail_enabled_for_model?.should be_false
+          subject.paper_trail_enabled_for_model?.should == false
           subject.paper_trail_on!
-          subject.paper_trail_enabled_for_model?.should be_true
+          subject.paper_trail_enabled_for_model?.should == true
         end
       end
 

data/spec/modules/version_number_spec.rb

@@ -0,0 +1,44 @@
+require 'spec_helper'
+
+describe 'PaperTrail::VERSION' do
+
+  describe "Constants" do
+    subject { PaperTrail::VERSION }
+
+    describe :MAJOR do
+      it { should be_const_defined(:MAJOR) }
+      it { subject::MAJOR.should be_a(Integer) }
+    end
+    describe :MINOR do
+      it { should be_const_defined(:MINOR) }
+      it { subject::MINOR.should be_a(Integer) }
+    end
+    describe :TINY do
+      it { should be_const_defined(:TINY) }
+      it { subject::TINY.should be_a(Integer) }
+    end
+    describe :PRE do
+      it { should be_const_defined(:PRE) }
+      if PaperTrail::VERSION::PRE
+        it { subject::PRE.should be_instance_of(String) }
+      end
+    end
+    describe :STRING do
+      it { should be_const_defined(:STRING) }
+      it { subject::STRING.should be_instance_of(String) }
+
+      it "should join the numbers into a period separated string" do
+        subject::STRING.should ==
+          [subject::MAJOR, subject::MINOR, subject::TINY, subject::PRE].compact.join('.')
+      end
+    end
+  end
+
+end
+
+describe PaperTrail do
+  describe :version do
+    it { should respond_to(:version) }
+    its(:version) { should == PaperTrail::VERSION::STRING }
+  end
+end

data/spec/spec_helper.rb

@@ -44,5 +44,5 @@ RSpec.configure do |config|
   # order dependency and want to debug it, you can fix the order by providing
   # the seed, which is printed after each run.
   #     --seed 1234
-  # config.order ||= 'random'
+  # config.order = 'random'
 end

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

@@ -0,0 +1,8 @@
+class PostWithStatus < ActiveRecord::Base
+  has_paper_trail
+
+  # ActiveRecord::Enum is only supported in AR4.1+
+  if defined?(ActiveRecord::Enum)
+    enum :status => { :draft => 0, :published => 1, :archived => 2 }
+  end
+end

data/test/dummy/db/migrate/20110208155312_set_up_test_tables.rb

@@ -92,6 +92,10 @@ class SetUpTestTables < ActiveRecord::Migration
       t.string :content
     end
 
+    create_table :post_with_statuses, :force => true do |t|
+      t.integer :status
+    end
+
     create_table :animals, :force => true do |t|
       t.string :name
       t.string :species   # single table inheritance column
@@ -100,7 +104,7 @@ class SetUpTestTables < ActiveRecord::Migration
     create_table :documents, :force => true do |t|
       t.string :name
     end
-    
+
     create_table :legacy_widgets, :force => true do |t|
       t.string    :name
       t.integer   :version

data/test/unit/model_test.rb

@@ -1376,7 +1376,6 @@ class HasPaperTrailModelTest < ActiveSupport::TestCase
     end
   end
 
-
   private
 
   # Updates `model`'s last version so it looks like the version was

data/test/unit/serializers/json_test.rb

@@ -37,4 +37,39 @@ class JSONTest < ActiveSupport::TestCase
     end
   end
 
+  context '`where_object` class method' do
+    context "when value is a string" do
+      should 'construct correct WHERE query' do
+        matches = PaperTrail::Serializers::JSON.where_object_condition(
+          PaperTrail::Version.arel_table[:object], :arg1, "Val 1")
+
+        assert matches.instance_of?(Arel::Nodes::Matches)
+        assert_equal matches.right, "%\"arg1\":\"Val 1\"%"
+      end
+    end
+
+    context "when value is `null`" do
+      should 'construct correct WHERE query' do
+        matches = PaperTrail::Serializers::JSON.where_object_condition(
+          PaperTrail::Version.arel_table[:object], :arg1, nil)
+
+        assert matches.instance_of?(Arel::Nodes::Matches)
+        assert_equal matches.right, "%\"arg1\":null%"
+      end
+    end
+
+    context "when value is a number" do
+      should 'construct correct WHERE query' do
+        grouping = PaperTrail::Serializers::JSON.where_object_condition(
+          PaperTrail::Version.arel_table[:object], :arg1, -3.5)
+
+        assert grouping.instance_of?(Arel::Nodes::Grouping)
+        matches = grouping.select { |v| v.instance_of?(Arel::Nodes::Matches) }
+        # Numeric arguments need to ensure that they match for only the number, not the beginning 
+        # of a #, so it uses an Grouping matcher (See notes on `PaperTrail::Serializers::JSON`)
+        assert_equal matches.first.right, "%\"arg1\":-3.5,%"
+        assert_equal matches.last.right, "%\"arg1\":-3.5}%"
+      end
+    end
+  end
 end

data/test/unit/serializers/yaml_test.rb

@@ -37,4 +37,12 @@ class YamlTest < ActiveSupport::TestCase
     end
   end
 
+  context '`where_object` class method' do
+    should 'construct correct WHERE query' do
+      matches = PaperTrail::Serializers::YAML.where_object_condition(
+        PaperTrail::Version.arel_table[:object], :arg1, "Val 1")
+      assert matches.instance_of?(Arel::Nodes::Matches)
+      assert_equal matches.right, "%\narg1: Val 1\n%"
+    end
+  end
 end

data/test/unit/version_test.rb

@@ -68,7 +68,7 @@ class PaperTrail::VersionTest < ActiveSupport::TestCase
       should "return all versions that were created before the Timestamp" do
         value = PaperTrail::Version.subsequent(1.hour.ago, true)
         assert_equal value, @animal.versions.to_a
-        assert_not_nil value.to_sql.match(/ORDER BY versions.created_at ASC/)
+        assert_not_nil value.to_sql.match(/ORDER BY #{PaperTrail::Version.arel_table[:created_at].asc.to_sql}/)
       end
     end
 
@@ -87,7 +87,7 @@ class PaperTrail::VersionTest < ActiveSupport::TestCase
       should "return all versions that were created before the Timestamp" do
         value = PaperTrail::Version.preceding(5.seconds.from_now, true)
         assert_equal value, @animal.versions.reverse
-        assert_not_nil value.to_sql.match(/ORDER BY versions.created_at DESC/)
+        assert_not_nil value.to_sql.match(/ORDER BY #{PaperTrail::Version.arel_table[:created_at].desc.to_sql}/)
       end
     end
 

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: paper_trail
 version: !ruby/object:Gem::Version
-  version: 3.0.2
+  version: 3.0.5
 platform: ruby
 authors:
 - Andy Stewart
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-05-12 00:00:00.000000000 Z
+date: 2014-08-30 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activerecord
@@ -247,23 +247,28 @@ files:
 - lib/paper_trail.rb
 - lib/paper_trail/cleaner.rb
 - lib/paper_trail/config.rb
+- lib/paper_trail/frameworks/active_record.rb
+- lib/paper_trail/frameworks/active_record/models/paper_trail/version.rb
 - lib/paper_trail/frameworks/cucumber.rb
 - lib/paper_trail/frameworks/rails.rb
+- lib/paper_trail/frameworks/rails/controller.rb
+- lib/paper_trail/frameworks/rails/engine.rb
 - lib/paper_trail/frameworks/rspec.rb
 - lib/paper_trail/frameworks/rspec/helpers.rb
 - lib/paper_trail/frameworks/sinatra.rb
 - lib/paper_trail/has_paper_trail.rb
 - lib/paper_trail/serializers/json.rb
 - lib/paper_trail/serializers/yaml.rb
-- lib/paper_trail/version.rb
 - lib/paper_trail/version_concern.rb
 - lib/paper_trail/version_number.rb
 - paper_trail.gemspec
 - spec/generators/install_generator_spec.rb
 - spec/models/joined_version_spec.rb
+- spec/models/post_with_status_spec.rb
 - spec/models/version_spec.rb
 - spec/models/widget_spec.rb
 - spec/modules/version_concern_spec.rb
+- spec/modules/version_number_spec.rb
 - spec/paper_trail_spec.rb
 - spec/requests/articles_spec.rb
 - spec/spec_helper.rb
@@ -288,6 +293,7 @@ files:
 - test/dummy/app/models/legacy_widget.rb
 - test/dummy/app/models/person.rb
 - test/dummy/app/models/post.rb
+- test/dummy/app/models/post_with_status.rb
 - test/dummy/app/models/protected_widget.rb
 - test/dummy/app/models/song.rb
 - test/dummy/app/models/translation.rb
@@ -366,16 +372,18 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: 1.3.6
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.2.1
+rubygems_version: 2.2.2
 signing_key: 
 specification_version: 4
 summary: Track changes to your models' data. Good for auditing or versioning.
 test_files:
 - spec/generators/install_generator_spec.rb
 - spec/models/joined_version_spec.rb
+- spec/models/post_with_status_spec.rb
 - spec/models/version_spec.rb
 - spec/models/widget_spec.rb
 - spec/modules/version_concern_spec.rb
+- spec/modules/version_number_spec.rb
 - spec/paper_trail_spec.rb
 - spec/requests/articles_spec.rb
 - spec/spec_helper.rb
@@ -400,6 +408,7 @@ test_files:
 - test/dummy/app/models/legacy_widget.rb
 - test/dummy/app/models/person.rb
 - test/dummy/app/models/post.rb
+- test/dummy/app/models/post_with_status.rb
 - test/dummy/app/models/protected_widget.rb
 - test/dummy/app/models/song.rb
 - test/dummy/app/models/translation.rb