paper_trail 5.2.3 → 11.0.0

data/spec/paper_trail_spec.rb

@@ -1,79 +0,0 @@
-require "rails_helper"
-
-describe PaperTrail do
-  context "when enabled" do
-    it "affects all threads" do
-      Thread.new { PaperTrail.enabled = false }.join
-      assert_equal false, PaperTrail.enabled?
-    end
-
-    after do
-      PaperTrail.enabled = true
-    end
-  end
-
-  context "default" do
-    it "should have versioning off by default" do
-      expect(PaperTrail).not_to be_enabled
-    end
-
-    it "should turn versioning on in a `with_versioning` block" do
-      expect(PaperTrail).not_to be_enabled
-      with_versioning do
-        expect(PaperTrail).to be_enabled
-      end
-      expect(PaperTrail).not_to be_enabled
-    end
-
-    context "error within `with_versioning` block" do
-      it "should revert the value of `PaperTrail.enabled?` to it's previous state" do
-        expect(PaperTrail).not_to be_enabled
-        expect { with_versioning { raise } }.to raise_error(RuntimeError)
-        expect(PaperTrail).not_to be_enabled
-      end
-    end
-  end
-
-  context "`versioning: true`", versioning: true do
-    it "should have versioning on by default" do
-      expect(PaperTrail).to be_enabled
-    end
-
-    it "should keep versioning on after a with_versioning block" do
-      expect(PaperTrail).to be_enabled
-      with_versioning do
-        expect(PaperTrail).to be_enabled
-      end
-      expect(PaperTrail).to be_enabled
-    end
-  end
-
-  context "`with_versioning` block at class level" do
-    it { expect(PaperTrail).not_to be_enabled }
-
-    with_versioning do
-      it "should have versioning on by default" do
-        expect(PaperTrail).to be_enabled
-      end
-    end
-    it "should not leak the `enabled?` state into successive tests" do
-      expect(PaperTrail).not_to be_enabled
-    end
-  end
-
-  describe :whodunnit do
-    before(:all) { PaperTrail.whodunnit = "foobar" }
-
-    it "should get set to `nil` by default" do
-      expect(PaperTrail.whodunnit).to be_nil
-    end
-  end
-
-  describe :controller_info do
-    before(:all) { ::PaperTrail.controller_info = { foo: "bar" } }
-
-    it "should get set to an empty hash before each test" do
-      expect(PaperTrail.controller_info).to eq({})
-    end
-  end
-end

data/spec/rails_helper.rb

@@ -1,34 +0,0 @@
-# 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 "spec_helper"
-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!)
-
-RSpec.configure do |config|
-  config.fixture_path = "#{::Rails.root}/spec/fixtures"
-
-  # If you're not using ActiveRecord, or you'd prefer not to run each of your
-  # examples within a transaction, remove the following line or assign false
-  # instead of true.
-  config.use_transactional_fixtures = true
-
-  # The different available types are documented in the features, such as in
-  # https://relishapp.com/rspec/rspec-rails/docs
-  # config.infer_spec_type_from_file_location!
-end

data/spec/requests/articles_spec.rb

@@ -1,34 +0,0 @@
-require "rails_helper"
-
-describe "Articles management", type: :request, order: :defined do
-  let(:valid_params) { { article: { title: "Doh", content: FFaker::Lorem.sentence } } }
-
-  context "versioning disabled" do
-    specify { expect(PaperTrail).not_to be_enabled }
-
-    it "should not create a version" do
-      expect(PaperTrail).to be_enabled_for_controller
-      expect {
-        post articles_path, params_wrapper(valid_params)
-      }.to_not change(PaperTrail::Version, :count)
-    end
-
-    it "should not leak the state of the `PaperTrail.enabled_for_controller?` into the next test" do
-      expect(PaperTrail).to be_enabled_for_controller
-    end
-  end
-
-  with_versioning do
-    let(:article) { Article.last }
-
-    context "`current_user` method returns a `String`" do
-      it "should set that value as the `whodunnit`" do
-        expect {
-          post articles_path, params_wrapper(valid_params)
-        }.to change(PaperTrail::Version, :count).by(1)
-        expect(article.title).to eq("Doh")
-        expect(article.versions.last.whodunnit).to eq("foobar")
-      end
-    end
-  end
-end

data/spec/spec_helper.rb

@@ -1,114 +0,0 @@
-require "pry-nav"
-
-# 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
-
-  # Support for disabling `verify_partial_doubles` on specific examples.
-  config.around(:each, verify_stubs: false) do |ex|
-    config.mock_with :rspec do |mocks|
-      mocks.verify_partial_doubles = false
-      ex.run
-      mocks.verify_partial_doubles = true
-    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
-end
-
-def active_record_gem_version
-  Gem::Version.new(ActiveRecord::VERSION::STRING)
-end
-
-# Wrap args in a hash to support the ActionController::TestCase and
-# ActionDispatch::Integration HTTP request method switch to keyword args
-# (see https://github.com/rails/rails/blob/master/actionpack/CHANGELOG.md)
-def params_wrapper(args)
-  if defined?(::Rails) && active_record_gem_version >= Gem::Version.new("5.0.0.beta1")
-    { params: args }
-  else
-    args
-  end
-end

data/spec/support/alt_db_init.rb

@@ -1,54 +0,0 @@
-# This file copies the test database into locations for the `Foo` and `Bar` namespace,
-# then defines those namespaces, then establishes the sqlite3 connection for the namespaces
-# to simulate an application with multiple database connections.
-
-# Load database yaml to use
-configs = YAML.load_file("#{Rails.root}/config/database.yml")
-
-# If we are testing with sqlite make it quick
-db_directory = "#{Rails.root}/db"
-
-# Set up alternate databases
-if ENV["DB"] == "sqlite"
-  FileUtils.cp "#{db_directory}/test.sqlite3", "#{db_directory}/test-foo.sqlite3"
-  FileUtils.cp "#{db_directory}/test.sqlite3", "#{db_directory}/test-bar.sqlite3"
-end
-
-module Foo
-  class Base < ActiveRecord::Base
-    self.abstract_class = true
-  end
-
-  class Version < Base
-    include PaperTrail::VersionConcern
-  end
-
-  class Document < Base
-    has_paper_trail class_name: "Foo::Version"
-  end
-end
-
-Foo::Base.configurations = configs
-Foo::Base.establish_connection(:foo)
-ActiveRecord::Base.establish_connection(:foo)
-ActiveRecord::Migrator.migrate File.expand_path("#{db_directory}/migrate/", __FILE__)
-
-module Bar
-  class Base < ActiveRecord::Base
-    self.abstract_class = true
-  end
-
-  class Version < Base
-    include PaperTrail::VersionConcern
-  end
-
-  class Document < Base
-    has_paper_trail class_name: "Bar::Version"
-  end
-end
-
-Bar::Base.configurations = configs
-Bar::Base.establish_connection(:bar)
-ActiveRecord::Base.establish_connection(:bar)
-
-ActiveRecord::Migrator.migrate File.expand_path("#{db_directory}/migrate/", __FILE__)

data/test/custom_json_serializer.rb

@@ -1,13 +0,0 @@
-# This custom serializer excludes nil values
-module CustomJsonSerializer
-  extend PaperTrail::Serializers::JSON
-
-  def self.load(string)
-    parsed_value = super(string)
-    parsed_value.is_a?(Hash) ? parsed_value.reject { |k, v| k.blank? || v.blank? } : parsed_value
-  end
-
-  def self.dump(object)
-    object.is_a?(Hash) ? super(object.reject { |_k, v| v.nil? }) : super
-  end
-end

data/test/dummy/Rakefile

@@ -1,7 +0,0 @@
-# Add your own tasks in files placed in lib/tasks ending in .rake,
-# for example lib/tasks/capistrano.rake, and they will automatically be available to Rake.
-
-require File.expand_path("../config/application", __FILE__)
-require "rake"
-
-Dummy::Application.load_tasks

data/test/dummy/app/controllers/application_controller.rb

@@ -1,33 +0,0 @@
-class ApplicationController < ActionController::Base
-  protect_from_forgery
-
-  # Rails 5 deprecates `before_filter`
-  name_of_before_callback = respond_to?(:before_action) ? :before_action : :before_filter
-
-  # Some applications and libraries modify `current_user`. Their changes need
-  # to be reflected in `whodunnit`, so the `set_paper_trail_whodunnit` below
-  # must happen after this.
-  send(name_of_before_callback, :modify_current_user)
-
-  # Going forward, we'll no longer add this `before_filter`, requiring people
-  # to do so themselves, allowing them to control the order in which this filter
-  # happens.
-  send(name_of_before_callback, :set_paper_trail_whodunnit)
-
-  def rescue_action(e)
-    raise e
-  end
-
-  # Returns id of hypothetical current user
-  attr_reader :current_user
-
-  def info_for_paper_trail
-    { ip: request.remote_ip, user_agent: request.user_agent }
-  end
-
-  private
-
-  def modify_current_user
-    @current_user = OpenStruct.new(id: 153)
-  end
-end

data/test/dummy/app/controllers/articles_controller.rb

@@ -1,20 +0,0 @@
-class ArticlesController < ApplicationController
-  def create
-    @article = Article.create article_params
-    head :ok
-  end
-
-  def current_user
-    "foobar"
-  end
-
-  private
-
-  def article_params
-    if PaperTrail.active_record_protected_attributes?
-      params[:article]
-    else
-      params.require(:article).permit!
-    end
-  end
-end

data/test/dummy/app/controllers/test_controller.rb

@@ -1,5 +0,0 @@
-class TestController < ActionController::Base
-  def user_for_paper_trail
-    Thread.current.object_id
-  end
-end

data/test/dummy/app/controllers/widgets_controller.rb

@@ -1,32 +0,0 @@
-class WidgetsController < ApplicationController
-  def paper_trail_enabled_for_controller
-    request.user_agent != "Disable User-Agent"
-  end
-
-  def create
-    @widget = Widget.create widget_params
-    head :ok
-  end
-
-  def update
-    @widget = Widget.find params[:id]
-    @widget.update_attributes widget_params
-    head :ok
-  end
-
-  def destroy
-    @widget = Widget.find params[:id]
-    @widget.destroy
-    head :ok
-  end
-
-  private
-
-  def widget_params
-    if PaperTrail.active_record_protected_attributes?
-      params[:widget]
-    else
-      params[:widget].permit!
-    end
-  end
-end

data/test/dummy/app/helpers/application_helper.rb

@@ -1,2 +0,0 @@
-module ApplicationHelper
-end

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

@@ -1,6 +0,0 @@
-class Animal < ActiveRecord::Base
-  has_paper_trail
-  self.inheritance_column = "species"
-
-  attr_accessible :species, :name if ::PaperTrail.active_record_protected_attributes?
-end