paper_trail 6.0.1 → 6.0.2

data/lib/paper_trail/version_concern.rb

@@ -1,5 +1,7 @@
 require "active_support/concern"
 require "paper_trail/attribute_serializers/object_changes_attribute"
+require "paper_trail/queries/versions/where_object"
+require "paper_trail/queries/versions/where_object_changes"
 
 module PaperTrail
   # Originally, PaperTrail did not provide this module, and all of this
@@ -95,62 +97,60 @@ module PaperTrail
         end
       end
 
-      # Query the `versions.objects` column using the SQL LIKE operator.
-      # Performs an attribute search on the serialized object by invoking the
-      # identically-named method in the serializer being used.
+      # Given a hash of attributes like `name: 'Joan'`, query the
+      # `versions.objects` column.
+      #
+      # ```
+      # SELECT "versions".*
+      # FROM "versions"
+      # WHERE ("versions"."object" LIKE '%
+      # name: Joan
+      # %')
+      # ```
+      #
+      # This is useful for finding versions where a given attribute had a given
+      # value. Imagine, in the example above, that Joan had changed her name
+      # and we wanted to find the versions before that change.
+      #
+      # Based on the data type of the `object` column, the appropriate SQL
+      # operator is used. For example, a text column will use `like`, and a
+      # jsonb column will use `@>`.
+      #
       # @api public
       def where_object(args = {})
         raise ArgumentError, "expected to receive a Hash" unless args.is_a?(Hash)
-
-        if columns_hash["object"].type == :jsonb
-          where("object @> ?", args.to_json)
-        elsif columns_hash["object"].type == :json
-          predicates = []
-          values = []
-          args.each do |field, value|
-            predicates.push "object->>? = ?"
-            values.concat([field, value.to_s])
-          end
-          sql = predicates.join(" and ")
-          where(sql, *values)
-        else
-          arel_field = arel_table[:object]
-          where_conditions = args.map { |field, value|
-            PaperTrail.serializer.where_object_condition(arel_field, field, value)
-          }
-          where_conditions = where_conditions.reduce { |a, e| a.and(e) }
-          where(where_conditions)
-        end
+        Queries::Versions::WhereObject.new(self, args).execute
       end
 
-      # Query the `versions.object_changes` column by attributes, using the
-      # SQL LIKE operator.
+      # Given a hash of attributes like `name: 'Joan'`, query the
+      # `versions.objects_changes` column.
+      #
+      # ```
+      # SELECT "versions".*
+      # FROM "versions"
+      # WHERE .. ("versions"."object_changes" LIKE '%
+      # name:
+      # - Joan
+      # %' OR "versions"."object_changes" LIKE '%
+      # name:
+      # -%
+      # - Joan
+      # %')
+      # ```
+      #
+      # This is useful for finding versions immediately before and after a given
+      # attribute had a given value. Imagine, in the example above, that someone
+      # changed their name to Joan and we wanted to find the versions
+      # immediately before and after that change.
+      #
+      # Based on the data type of the `object` column, the appropriate SQL
+      # operator is used. For example, a text column will use `like`, and a
+      # jsonb column will use `@>`.
+      #
       # @api public
       def where_object_changes(args = {})
         raise ArgumentError, "expected to receive a Hash" unless args.is_a?(Hash)
-
-        if columns_hash["object_changes"].type == :jsonb
-          args.each { |field, value| args[field] = [value] }
-          where("object_changes @> ?", args.to_json)
-        elsif columns_hash["object"].type == :json
-          predicates = []
-          values = []
-          args.each do |field, value|
-            predicates.push(
-              "((object_changes->>? ILIKE ?) OR (object_changes->>? ILIKE ?))"
-            )
-            values.concat([field, "[#{value.to_json},%", field, "[%,#{value.to_json}]%"])
-          end
-          sql = predicates.join(" and ")
-          where(sql, *values)
-        else
-          arel_field = arel_table[:object_changes]
-          where_conditions = args.map { |field, value|
-            PaperTrail.serializer.where_object_changes_condition(arel_field, field, value)
-          }
-          where_conditions = where_conditions.reduce { |a, e| a.and(e) }
-          where(where_conditions)
-        end
+        Queries::Versions::WhereObjectChanges.new(self, args).execute
       end
 
       def primary_key_is_int?

data/lib/paper_trail/version_number.rb

@@ -3,7 +3,7 @@ module PaperTrail
   module VERSION
     MAJOR = 6
     MINOR = 0
-    TINY = 1
+    TINY = 2
     PRE = nil
 
     STRING = [MAJOR, MINOR, TINY, PRE].compact.join(".").freeze

data/paper_trail.gemspec

@@ -5,8 +5,12 @@ Gem::Specification.new do |s|
   s.name = "paper_trail"
   s.version = PaperTrail::VERSION::STRING.dup # The `dup` is for ruby 1.9.3
   s.platform = Gem::Platform::RUBY
-  s.summary = "Track changes to your models' data. Good for auditing or versioning."
-  s.description = s.summary
+  s.summary = "Track changes to your models."
+  s.description = <<-EOS
+Track changes to your models, for auditing or versioning. See how a model looked
+at any stage in its lifecycle, revert it to any version, or restore it after it
+has been destroyed.
+  EOS
   s.homepage = "https://github.com/airblade/paper_trail"
   s.authors = ["Andy Stewart", "Ben Atkins"]
   s.email = "batkinz@gmail.com"
@@ -28,15 +32,31 @@ Gem::Specification.new do |s|
   s.add_development_dependency "rake", "~> 10.4.2"
   s.add_development_dependency "shoulda", "~> 3.5.0"
   s.add_development_dependency "ffaker", "~> 2.1.0"
-  s.add_development_dependency "railties", [">= 3.0", "< 6.0"]
+
+  # Why `railties`? Possibly used by `test/dummy` boot up?
+  s.add_development_dependency "railties", [">= 4.0", "< 5.2"]
+
   s.add_development_dependency "rack-test", "~> 0.6.3"
   s.add_development_dependency "rspec-rails", "~> 3.5"
   s.add_development_dependency "generator_spec", "~> 0.9.3"
   s.add_development_dependency "database_cleaner", "~> 1.2"
   s.add_development_dependency "pry-nav", "~> 0.2.4"
+
+  # We cannot upgrade rubocop until we drop support for ruby 1.9.3.
+  # Rubocop 0.42 requires ruby >= 2.0. We could add a conditional, as we do
+  # below for rack and pg, but that means our config files (e.g. `.rubocop.yml`
+  # would have to simultaneously be valid in two different versions of rubocop.
+  # That is currently possible, but probably won't be in the future, and is
+  # not worth the effort.) Because of pain points like this, I think we'll
+  # have to drop support for ruby 1.9.3 soon.
   s.add_development_dependency "rubocop", "~> 0.41.1"
+
   s.add_development_dependency "timecop", "~> 0.8.0"
 
+  if ::Gem.ruby_version < ::Gem::Version.new("2.0.0")
+    s.add_development_dependency "rack", "< 2"
+  end
+
   if defined?(JRUBY_VERSION)
     s.add_development_dependency "activerecord-jdbcsqlite3-adapter", "~> 1.3.15"
     s.add_development_dependency "activerecord-jdbcpostgresql-adapter", "~> 1.3.15"

data/spec/controllers/articles_controller_spec.rb

@@ -0,0 +1,28 @@
+require "rails_helper"
+
+RSpec.describe ArticlesController, type: :controller do
+  describe "PaperTrail.enabled_for_controller?" do
+    context "PaperTrail.enabled? == true" do
+      before { PaperTrail.enabled = true }
+
+      it "returns true" do
+        assert PaperTrail.enabled?
+        post :create, params_wrapper(article: { title: "Doh", content: FFaker::Lorem.sentence })
+        expect(assigns(:article)).to_not be_nil
+        assert PaperTrail.enabled_for_controller?
+        assert_equal 1, assigns(:article).versions.length
+      end
+
+      after { PaperTrail.enabled = false }
+    end
+
+    context "PaperTrail.enabled? == false" do
+      it "returns false" do
+        assert !PaperTrail.enabled?
+        post :create, params_wrapper(article: { title: "Doh", content: FFaker::Lorem.sentence })
+        assert !PaperTrail.enabled_for_controller?
+        assert_equal 0, assigns(:article).versions.length
+      end
+    end
+  end
+end

data/test/dummy/config/boot.rb

@@ -1,10 +1,24 @@
 require "rubygems"
-gemfile = File.expand_path("../../../../Gemfile", __FILE__)
 
-if File.exist?(gemfile)
-  ENV["BUNDLE_GEMFILE"] = gemfile
-  require "bundler"
-  Bundler.setup
+# We normally use the root project Gemfile (and gemspec), but when we run rake
+# locally (not on travis) in this dummy app, we set the BUNDLE_GEMFILE env.
+# variable. The project Gemfile/gemspec allows AR 4.0, which is a problem
+# because this dummy app uses `enum` in some of its models, and `enum` was
+# introduced in AR 4.1. So, when we run rake here, we use:
+#
+#     BUNDLE_GEMFILE=../../gemfiles/ar_4.2.gemfile bundle exec rake
+#
+# Once we drop support for AR 4.0 and 4.1 this will be less of a problem, but
+# we should keep the ability to specify BUNDLE_GEMFILE because the same
+# situation could come up in the future.
+unless ENV.key?("BUNDLE_GEMFILE")
+  gemfile = File.expand_path("../../../../Gemfile", __FILE__)
+  if File.exist?(gemfile)
+    puts "Booting PT test dummy app: Using gemfile: #{gemfile}"
+    ENV["BUNDLE_GEMFILE"] = gemfile
+  end
 end
+require "bundler"
+Bundler.setup
 
-$LOAD_PATH.unshift File.expand_path("../../../../lib", __FILE__)
+$LOAD_PATH.unshift(File.expand_path("../../../../lib", __FILE__))

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: paper_trail
 version: !ruby/object:Gem::Version
-  version: 6.0.1
+  version: 6.0.2
 platform: ruby
 authors:
 - Andy Stewart
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2016-12-04 00:00:00.000000000 Z
+date: 2016-12-14 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activerecord
@@ -107,20 +107,20 @@ dependencies:
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: '3.0'
+        version: '4.0'
     - - "<"
       - !ruby/object:Gem::Version
-        version: '6.0'
+        version: '5.2'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: '3.0'
+        version: '4.0'
     - - "<"
       - !ruby/object:Gem::Version
-        version: '6.0'
+        version: '5.2'
 - !ruby/object:Gem::Dependency
   name: rack-test
   requirement: !ruby/object:Gem::Requirement
@@ -261,7 +261,10 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: 0.4.2
-description: Track changes to your models' data. Good for auditing or versioning.
+description: |
+  Track changes to your models, for auditing or versioning. See how a model looked
+  at any stage in its lifecycle, revert it to any version, or restore it after it
+  has been destroyed.
 email: batkinz@gmail.com
 executables: []
 extensions: []
@@ -313,6 +316,8 @@ files:
 - lib/paper_trail/frameworks/sinatra.rb
 - lib/paper_trail/has_paper_trail.rb
 - lib/paper_trail/model_config.rb
+- lib/paper_trail/queries/versions/where_object.rb
+- lib/paper_trail/queries/versions/where_object_changes.rb
 - lib/paper_trail/record_history.rb
 - lib/paper_trail/record_trail.rb
 - lib/paper_trail/reifier.rb
@@ -322,6 +327,7 @@ files:
 - lib/paper_trail/version_concern.rb
 - lib/paper_trail/version_number.rb
 - paper_trail.gemspec
+- spec/controllers/articles_controller_spec.rb
 - spec/generators/install_generator_spec.rb
 - spec/generators/paper_trail/templates/create_versions_spec.rb
 - spec/models/animal_spec.rb
@@ -425,7 +431,6 @@ files:
 - test/dummy/db/migrate/20110208155312_set_up_test_tables.rb
 - test/dummy/db/schema.rb
 - test/functional/controller_test.rb
-- test/functional/enabled_for_controller_test.rb
 - test/functional/modular_sinatra_test.rb
 - test/functional/sinatra_test.rb
 - test/functional/thread_safety_test.rb
@@ -461,11 +466,12 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: 1.3.6
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.5.1
+rubygems_version: 2.5.2
 signing_key: 
 specification_version: 4
-summary: Track changes to your models' data. Good for auditing or versioning.
+summary: Track changes to your models.
 test_files:
+- spec/controllers/articles_controller_spec.rb
 - spec/generators/install_generator_spec.rb
 - spec/generators/paper_trail/templates/create_versions_spec.rb
 - spec/models/animal_spec.rb
@@ -569,7 +575,6 @@ test_files:
 - test/dummy/db/migrate/20110208155312_set_up_test_tables.rb
 - test/dummy/db/schema.rb
 - test/functional/controller_test.rb
-- test/functional/enabled_for_controller_test.rb
 - test/functional/modular_sinatra_test.rb
 - test/functional/sinatra_test.rb
 - test/functional/thread_safety_test.rb

data/test/functional/enabled_for_controller_test.rb

@@ -1,28 +0,0 @@
-require "test_helper"
-
-class EnabledForControllerTest < ActionController::TestCase
-  tests ArticlesController
-
-  context "`PaperTrail.enabled? == true`" do
-    should "enabled_for_controller?.should == true" do
-      assert PaperTrail.enabled?
-      post :create, params_wrapper(article: { title: "Doh", content: FFaker::Lorem.sentence })
-      assert_not_nil assigns(:article)
-      assert PaperTrail.enabled_for_controller?
-      assert_equal 1, assigns(:article).versions.length
-    end
-  end
-
-  context "`PaperTrail.enabled? == false`" do
-    setup { PaperTrail.enabled = false }
-
-    should "enabled_for_controller?.should == false" do
-      assert !PaperTrail.enabled?
-      post :create, params_wrapper(article: { title: "Doh", content: FFaker::Lorem.sentence })
-      assert !PaperTrail.enabled_for_controller?
-      assert_equal 0, assigns(:article).versions.length
-    end
-
-    teardown { PaperTrail.enabled = true }
-  end
-end