paper_trail 7.0.2 → 7.0.3

data/spec/paper_trail/serializer_spec.rb

@@ -0,0 +1,85 @@
+require "spec_helper"
+require "support/custom_json_serializer"
+
+RSpec.describe(PaperTrail, versioning: true) do
+  context "YAML serializer" do
+    it "saves the expected YAML in the object column" do
+      customer = Customer.create(name: "Some text.")
+      original_attributes = customer.paper_trail.attributes_before_change
+      customer.update(name: "Some more text.")
+      expect(customer.versions.length).to(eq(2))
+      expect(customer.versions[0].reify).to(be_nil)
+      expect(customer.versions[1].reify.name).to(eq("Some text."))
+      expect(YAML.load(customer.versions[1].object)).to(eq(original_attributes))
+      expect(customer.versions[1].object).to(eq(YAML.dump(original_attributes)))
+    end
+  end
+
+  context "JSON Serializer" do
+    before do
+      PaperTrail.configure do |config|
+        config.serializer = PaperTrail::Serializers::JSON
+      end
+    end
+
+    after do
+      PaperTrail.config.serializer = PaperTrail::Serializers::YAML
+    end
+
+    it "reify with JSON serializer" do
+      customer = Customer.create(name: "Some text.")
+      original_attributes = customer.paper_trail.attributes_before_change
+      customer.update(name: "Some more text.")
+      expect(customer.versions.length).to(eq(2))
+      expect(customer.versions[0].reify).to(be_nil)
+      expect(customer.versions[1].reify.name).to(eq("Some text."))
+      expect(ActiveSupport::JSON.decode(customer.versions[1].object)).to(eq(original_attributes))
+      expect(customer.versions[1].object).to(eq(ActiveSupport::JSON.encode(original_attributes)))
+    end
+
+    describe "#changeset" do
+      it "returns the expected hash" do
+        customer = Customer.create(name: "Some text.")
+        customer.update(name: "Some more text.")
+        initial_changeset = { "name" => [nil, "Some text."], "id" => [nil, customer.id] }
+        second_changeset = { "name" => ["Some text.", "Some more text."] }
+        expect(customer.versions[0].changeset).to(eq(initial_changeset))
+        expect(customer.versions[1].changeset).to(eq(second_changeset))
+      end
+    end
+  end
+
+  context "Custom Serializer" do
+    before do
+      PaperTrail.configure { |config| config.serializer = CustomJsonSerializer }
+    end
+
+    after do
+      PaperTrail.config.serializer = PaperTrail::Serializers::YAML
+    end
+
+    it "reify with custom serializer" do
+      customer = Customer.create
+      original_attributes = customer.paper_trail.attributes_before_change.reject { |_k, v| v.nil? }
+      customer.update(name: "Some more text.")
+      expect(customer.versions.length).to(eq(2))
+      expect(customer.versions[0].reify).to(be_nil)
+      expect(customer.versions[1].reify.name).to(be_nil)
+      expect(
+        ActiveSupport::JSON.decode(customer.versions[1].object)
+      ).to eq(original_attributes)
+      expect(
+        customer.versions[1].object
+      ).to eq(ActiveSupport::JSON.encode(original_attributes))
+    end
+
+    describe "#changeset" do
+      it "store object_changes" do
+        customer = Customer.create
+        customer.update(name: "banana")
+        expect(customer.versions[0].changeset).to eq("id" => [nil, customer.id])
+        expect(customer.versions[1].changeset).to eq("name" => [nil, "banana"])
+      end
+    end
+  end
+end

data/spec/paper_trail/serializers/custom_yaml_serializer_spec.rb

@@ -1,4 +1,4 @@
-require "rails_helper"
+require "spec_helper"
 
 module CustomYamlSerializer
   extend PaperTrail::Serializers::YAML

data/spec/paper_trail/serializers/json_spec.rb

@@ -1,8 +1,8 @@
-require "rails_helper"
+require "spec_helper"
 
 module PaperTrail
   module Serializers
-    RSpec.describe JSON do
+    ::RSpec.describe JSON do
       let(:word_hash) {
         (1..4).each_with_object({}) { |i, a| a["key#{i}"] = ::FFaker::Lorem.word }
       }

data/spec/paper_trail/serializers/yaml_spec.rb

@@ -0,0 +1,42 @@
+require "spec_helper"
+
+module PaperTrail
+  module Serializers
+    ::RSpec.describe(YAML, versioning: true) do
+      let(:array) { ::Array.new(10) { ::FFaker::Lorem.word } }
+      let(:hash) {
+        {
+          alice: "bob",
+          binary: 0xdeadbeef,
+          octal_james_bond: 0o7,
+          int: 42,
+          float: 4.2
+        }
+      }
+
+      describe ".load" do
+        it "deserializes YAML to Ruby" do
+          expect(described_class.load(hash.to_yaml)).to eq(hash)
+          expect(described_class.load(array.to_yaml)).to eq(array)
+        end
+      end
+
+      describe ".dump" do
+        it "serializes Ruby to YAML" do
+          expect(described_class.dump(hash)).to eq(hash.to_yaml)
+          expect(described_class.dump(array)).to eq(array.to_yaml)
+        end
+      end
+
+      describe ".where_object" do
+        it "constructs the correct WHERE query" do
+          matches = described_class.where_object_condition(
+            ::PaperTrail::Version.arel_table[:object], :arg1, "Val 1"
+          )
+          expect(matches.instance_of?(Arel::Nodes::Matches)).to(eq(true))
+          expect(matches.right.val).to eq("%\narg1: Val 1\n%")
+        end
+      end
+    end
+  end
+end

data/spec/paper_trail/version_limit_spec.rb

@@ -1,7 +1,7 @@
-require "rails_helper"
+require "spec_helper"
 
 module PaperTrail
-  RSpec.describe Cleaner, versioning: true do
+  ::RSpec.describe Cleaner, versioning: true do
     after do
       PaperTrail.config.version_limit = nil
     end

data/spec/paper_trail/version_spec.rb

@@ -0,0 +1,96 @@
+require "spec_helper"
+
+module PaperTrail
+  ::RSpec.describe(Version, versioning: true) do
+    describe ".creates" do
+      it "returns only create events" do
+        animal = Animal.create(name: "Foo")
+        animal.update_attributes(name: "Bar")
+        expect(described_class.creates.pluck(:event)).to eq(["create"])
+      end
+    end
+
+    describe ".updates" do
+      it "returns only update events" do
+        animal = Animal.create
+        animal.update_attributes(name: "Animal")
+        expect(described_class.updates.pluck(:event)).to eq(["update"])
+      end
+    end
+
+    describe ".destroys" do
+      it "returns only destroy events" do
+        animal = Animal.create
+        animal.destroy
+        expect(described_class.destroys.pluck(:event)).to eq(["destroy"])
+      end
+    end
+
+    describe ".not_creates" do
+      it "returns all versions except create events" do
+        animal = Animal.create
+        animal.update_attributes(name: "Animal")
+        animal.destroy
+        expect(
+          described_class.not_creates.pluck(:event)
+        ).to match_array(%w[update destroy])
+      end
+    end
+
+    describe ".subsequent" do
+      context "given a timestamp" do
+        it "returns all versions that were created after the timestamp" do
+          animal = Animal.create
+          2.times do
+            animal.update_attributes(name: FFaker::Lorem.word)
+          end
+          value = described_class.subsequent(1.hour.ago, true)
+          expect(value).to eq(animal.versions.to_a)
+          expect(value.to_sql).to match(
+            /ORDER BY #{described_class.arel_table[:created_at].asc.to_sql}/
+          )
+        end
+      end
+
+      context "given a Version" do
+        it "grab the timestamp from the version and use that as the value" do
+          animal = Animal.create
+          2.times do
+            animal.update_attributes(name: FFaker::Lorem.word)
+          end
+          expect(described_class.subsequent(animal.versions.first)).to eq(
+            animal.versions.to_a.drop(1)
+          )
+        end
+      end
+    end
+
+    describe ".preceding" do
+      context "given a timestamp" do
+        it "returns all versions that were created before the timestamp" do
+          animal = Animal.create
+          2.times do
+            animal.update_attributes(name: FFaker::Lorem.word)
+          end
+          value = described_class.preceding(5.seconds.from_now, true)
+          expect(value).to eq(animal.versions.reverse)
+          expect(value.to_sql).to match(
+            /ORDER BY #{described_class.arel_table[:created_at].desc.to_sql}/
+          )
+        end
+      end
+
+      context "given a Version" do
+        it "grab the timestamp from the version and use that as the value" do
+          animal = Animal.create
+          2.times do
+            animal.update_attributes(name: FFaker::Lorem.word)
+          end
+          expect(described_class.preceding(animal.versions.last)).to eq(
+            animal.versions.to_a.tap(&:pop).reverse
+          )
+        end
+      end
+    end
+  end
+end

data/spec/paper_trail_spec.rb

@@ -1,4 +1,4 @@
-require "rails_helper"
+require "spec_helper"
 
 RSpec.describe PaperTrail do
   describe ".gem_version" do

data/spec/requests/articles_spec.rb

@@ -1,6 +1,6 @@
-require "rails_helper"
+require "spec_helper"
 
-describe "Articles management", type: :request, order: :defined do
+RSpec.describe "Articles management", type: :request, order: :defined do
   let(:valid_params) { { article: { title: "Doh", content: FFaker::Lorem.sentence } } }
 
   context "versioning disabled" do

data/spec/spec_helper.rb

@@ -1,42 +1,19 @@
-require "pry-nav"
+# This file is copied to spec/ when you run 'rails generate rspec:install'
+ENV["RAILS_ENV"] ||= "test"
+ENV["DB"] ||= "sqlite"
+
+unless File.exist?(File.expand_path("../../test/dummy/config/database.yml", __FILE__))
+  warn "WARNING: No database.yml detected for the dummy app, please run `rake prepare` first"
+end
+
+require "pry"
 
-# This file was generated by the `rspec --init` command. Conventionally, all
-# specs live under a `spec` directory, which RSpec adds to the `$LOAD_PATH`.
-# The generated `.rspec` file contains `--require spec_helper` which will cause this
-# file to always be loaded, without a need to explicitly require it in any files.
-#
-# Given that it is always loaded, you are encouraged to keep this file as
-# light-weight as possible. Requiring heavyweight dependencies from this file
-# will add to the boot time of your test suite on EVERY test run, even for an
-# individual file that may not need all of that loaded. Instead, consider making
-# a separate helper file that requires the additional dependencies and performs
-# the additional setup, and require it from the spec files that actually need it.
-#
-# The `.rspec` file also contains a few flags that are not defaults but that
-# users commonly want.
-#
-# See http://rubydoc.info/gems/rspec-core/RSpec/Core/Configuration
 RSpec.configure do |config|
-  # rspec-expectations config goes here. You can use an alternate
-  # assertion/expectation library such as wrong or the stdlib/minitest
-  # assertions if you prefer.
   config.expect_with :rspec do |expectations|
-    # This option will default to `true` in RSpec 4. It makes the `description`
-    # and `failure_message` of custom matchers include text for helper methods
-    # defined using `chain`, e.g.:
-    # be_bigger_than(2).and_smaller_than(4).description
-    #   # => "be bigger than 2 and smaller than 4"
-    # ...rather than:
-    #   # => "be bigger than 2"
     expectations.include_chain_clauses_in_custom_matcher_descriptions = true
   end
 
-  # rspec-mocks config goes here. You can use an alternate test double
-  # library (such as bogus or mocha) by changing the `mock_with` option here.
   config.mock_with :rspec do |mocks|
-    # Prevents you from mocking or stubbing a method that does not exist on
-    # a real object. This is generally recommended, and will default to
-    # `true` in RSpec 4.
     mocks.verify_partial_doubles = true
   end
 
@@ -49,53 +26,15 @@ RSpec.configure do |config|
     end
   end
 
-  # The settings below are suggested to provide a good initial experience
-  # with RSpec, but feel free to customize to your heart's content.
-
-  # These two settings work together to allow you to limit a spec run
-  # to individual examples or groups you care about by tagging them with
-  # `:focus` metadata. When nothing is tagged with `:focus`, all examples
-  # get run.
-  # config.filter_run :focus
-  # config.run_all_when_everything_filtered = true
-
-  # Limits the available syntax to the non-monkey patched syntax that is recommended.
-  # For more details, see:
-  #   - http://myronmars.to/n/dev-blog/2012/06/rspecs-new-expectation-syntax
-  #   - http://teaisaweso.me/blog/2013/05/27/rspecs-new-message-expectation-syntax/
-  #   - http://myronmars.to/n/dev-blog/2014/05/notable-changes-in-rspec-3#new__config_option_to_disable_rspeccore_monkey_patching
-  # config.disable_monkey_patching!
-
-  # This setting enables warnings. It's recommended, but in some cases may
-  # be too noisy due to issues in dependencies.
-  # config.warnings = true
-
-  # Many RSpec users commonly either run the entire suite or an individual
-  # file, and it's useful to allow more verbose output when running an
-  # individual spec file.
-  # if config.files_to_run.one?
-  #   # Use the documentation formatter for detailed output,
-  #   # unless a formatter has already been configured
-  #   # (e.g. via a command-line flag).
-  #   config.default_formatter = 'doc'
-  # end
-
-  # Print the 10 slowest examples and example groups at the
-  # end of the spec run, to help surface which specs are running
-  # particularly slow.
-  # config.profile_examples = 10
-
-  # Run specs in random order to surface order dependencies. If you find an
-  # 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
-
-  # Seed global randomization in this process using the `--seed` CLI option.
-  # Setting this allows you to use `--seed` to deterministically reproduce
-  # test failures related to randomization by passing the same `--seed` value
-  # as the one that triggered the failure.
-  # Kernel.srand config.seed
+  config.filter_run :focus
+  config.run_all_when_everything_filtered = true
+  config.disable_monkey_patching!
+  config.warnings = false
+  if config.files_to_run.one?
+    config.default_formatter = "doc"
+  end
+  config.order = :random
+  Kernel.srand config.seed
 end
 
 def active_record_gem_version
@@ -112,3 +51,32 @@ def params_wrapper(args)
     args
   end
 end
+
+require File.expand_path("../../test/dummy/config/environment", __FILE__)
+require "rspec/rails"
+require "paper_trail/frameworks/rspec"
+require "ffaker"
+require "timecop"
+
+# prevent Test::Unit's AutoRunner from executing during RSpec's rake task
+Test::Unit.run = true if defined?(Test::Unit) && Test::Unit.respond_to?(:run=)
+
+# Checks for pending migrations before tests are run.
+# If you are not using ActiveRecord, you can remove this line.
+ActiveRecord::Migration.check_pending! if ActiveRecord::Migration.respond_to?(:check_pending!)
+
+require "database_cleaner"
+DatabaseCleaner.strategy = :truncation
+
+RSpec.configure do |config|
+  config.fixture_path = "#{::Rails.root}/spec/fixtures"
+  config.use_transactional_fixtures = active_record_gem_version >= ::Gem::Version.new("5")
+
+  # In rails < 5, some tests seem to require DatabaseCleaner-truncation.
+  # Truncation is about three times slower than transaction rollback, so it'll
+  # be nice when we can drop support for rails < 5.
+  if active_record_gem_version < ::Gem::Version.new("5")
+    config.before(:each) { DatabaseCleaner.start }
+    config.after(:each) { DatabaseCleaner.clean }
+  end
+end

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

@@ -1,6 +1,6 @@
 class Document < ActiveRecord::Base
   has_paper_trail(
     versions: :paper_trail_versions,
-    on: %i(create update)
+    on: %i[create update]
   )
 end

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

@@ -1,4 +1,4 @@
 # This model does not record versions when updated.
 class NotOnUpdate < ActiveRecord::Base
-  has_paper_trail on: %i(create destroy)
+  has_paper_trail on: %i[create destroy]
 end

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

@@ -2,7 +2,7 @@ class Widget < ActiveRecord::Base
   EXCLUDED_NAME = "Biglet".freeze
   has_paper_trail
   has_one :wotsit
-  has_many :fluxors, -> { order(:name) }
+  has_many(:fluxors, -> { order(:name) })
   has_many :whatchamajiggers, as: :owner
   validates :name, exclusion: { in: [EXCLUDED_NAME] }
 end

data/test/dummy/config/routes.rb

@@ -1,4 +1,4 @@
 Dummy::Application.routes.draw do
   resources :articles, only: [:create]
-  resources :widgets, only: %i(create update destroy)
+  resources :widgets, only: %i[create update destroy]
 end