paper_trail 3.0.6 → 4.2.0

data/spec/modules/paper_trail_spec.rb

@@ -0,0 +1,27 @@
+require 'rails_helper'
+
+describe PaperTrail, :type => :module, :versioning => true do
+  describe '#config' do
+    it { is_expected.to respond_to(:config) }
+
+    it "should allow for config values to be set" do
+      expect(subject.config.enabled).to eq(true)
+      subject.config.enabled = false
+      expect(subject.config.enabled).to eq(false)
+    end
+
+    it "should accept blocks and yield the config instance" do
+      expect(subject.config.enabled).to eq(true)
+      subject.config { |c| c.enabled = false }
+      expect(subject.config.enabled).to eq(false)
+    end
+  end
+
+  describe '#configure' do
+    it { is_expected.to respond_to(:configure) }
+
+    it "should be an alias for the `config` method" do
+      expect(subject.method(:configure)).to eq(subject.method(:config))
+    end
+  end
+end

data/spec/modules/version_concern_spec.rb

@@ -1,21 +1,21 @@
-require 'spec_helper'
+require 'rails_helper'
 
 describe PaperTrail::VersionConcern do
 
   before(:all) { require 'support/alt_db_init' }
 
   it 'allows included class to have different connections' do
-    Foo::Version.connection.should_not == Bar::Version.connection
+    expect(Foo::Version.connection).not_to eq(Bar::Version.connection)
   end
 
   it 'allows custom version class to share connection with superclass' do
-    Foo::Version.connection.should == Foo::Document.connection
-    Bar::Version.connection.should == Bar::Document.connection
+    expect(Foo::Version.connection).to eq(Foo::Document.connection)
+    expect(Bar::Version.connection).to eq(Bar::Document.connection)
   end
 
   it 'can be used with class_name option' do
-    Foo::Document.version_class_name.should == 'Foo::Version'
-    Bar::Document.version_class_name.should == 'Bar::Version'
+    expect(Foo::Document.version_class_name).to eq('Foo::Version')
+    expect(Bar::Document.version_class_name).to eq('Bar::Version')
   end
 
   describe 'persistence', :versioning => true do
@@ -25,8 +25,8 @@ describe PaperTrail::VersionConcern do
     end
 
     it 'should store versions in the correct corresponding db location' do
-      @foo_doc.versions.first.should be_instance_of(Foo::Version)
-      @bar_doc.versions.first.should be_instance_of(Bar::Version)
+      expect(@foo_doc.versions.first).to be_instance_of(Foo::Version)
+      expect(@bar_doc.versions.first).to be_instance_of(Bar::Version)
     end
   end
 end

data/spec/modules/version_number_spec.rb

@@ -1,35 +1,35 @@
 require 'spec_helper'
 
-describe 'PaperTrail::VERSION' do
+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) }
+      it { is_expected.to be_const_defined(:MAJOR) }
+      it { expect(subject::MAJOR).to be_a(Integer) }
     end
     describe :MINOR do
-      it { should be_const_defined(:MINOR) }
-      it { subject::MINOR.should be_a(Integer) }
+      it { is_expected.to be_const_defined(:MINOR) }
+      it { expect(subject::MINOR).to be_a(Integer) }
     end
     describe :TINY do
-      it { should be_const_defined(:TINY) }
-      it { subject::TINY.should be_a(Integer) }
+      it { is_expected.to be_const_defined(:TINY) }
+      it { expect(subject::TINY).to be_a(Integer) }
     end
     describe :PRE do
-      it { should be_const_defined(:PRE) }
+      it { is_expected.to be_const_defined(:PRE) }
       if PaperTrail::VERSION::PRE
-        it { subject::PRE.should be_instance_of(String) }
+        it { expect(subject::PRE).to be_instance_of(String) }
       end
     end
     describe :STRING do
-      it { should be_const_defined(:STRING) }
-      it { subject::STRING.should be_instance_of(String) }
+      it { is_expected.to be_const_defined(:STRING) }
+      it { expect(subject::STRING).to 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('.')
+        expect(subject::STRING).to eq(
+          [subject::MAJOR, subject::MINOR, subject::TINY, subject::PRE].compact.join('.'))
       end
     end
   end
@@ -37,8 +37,8 @@ describe 'PaperTrail::VERSION' do
 end
 
 describe PaperTrail do
-  describe :version do
-    it { should respond_to(:version) }
-    its(:version) { should == PaperTrail::VERSION::STRING }
+  describe '#version' do
+    it { is_expected.to respond_to(:version) }
+    it { expect(subject.version).to eq(PaperTrail::VERSION::STRING) }
   end
 end

data/spec/paper_trail/config_spec.rb

@@ -0,0 +1,52 @@
+require "rails_helper"
+
+module PaperTrail
+  RSpec.describe Config do
+    describe ".instance" do
+      it "returns the singleton instance" do
+        expect { described_class.instance }.to_not raise_error
+      end
+    end
+
+    describe ".new" do
+      it "raises NoMethodError" do
+        expect { described_class.new }.to raise_error(NoMethodError)
+      end
+    end
+
+    describe "#enabled" do
+      context "when paper_trail_enabled is true" do
+        it "returns true" do
+          store = double
+          allow(store).to receive(:fetch).
+            with(:paper_trail_enabled, true).
+            and_return(true)
+          allow(PaperTrail).to receive(:paper_trail_store).and_return(store)
+          expect(described_class.instance.enabled).to eq(true)
+        end
+      end
+
+      context "when paper_trail_enabled is false" do
+        it "returns false" do
+          store = double
+          allow(store).to receive(:fetch).
+            with(:paper_trail_enabled, true).
+            and_return(false)
+          allow(PaperTrail).to receive(:paper_trail_store).and_return(store)
+          expect(described_class.instance.enabled).to eq(false)
+        end
+      end
+
+      context "when paper_trail_enabled is nil" do
+        it "returns true" do
+          store = double
+          allow(store).to receive(:fetch).
+            with(:paper_trail_enabled, true).
+            and_return(nil)
+          allow(PaperTrail).to receive(:paper_trail_store).and_return(store)
+          expect(described_class.instance.enabled).to eq(true)
+        end
+      end
+    end
+  end
+end

data/spec/paper_trail_spec.rb

@@ -1,58 +1,58 @@
-require 'spec_helper'
+require 'rails_helper'
 
 describe "PaperTrail RSpec Helper" do
   context 'default' do
     it 'should have versioning off by default' do
-      ::PaperTrail.should_not be_enabled
+      expect(PaperTrail).not_to be_enabled
     end
     it 'should turn versioning on in a `with_versioning` block' do
-      ::PaperTrail.should_not be_enabled
+      expect(PaperTrail).not_to be_enabled
       with_versioning do
-        ::PaperTrail.should be_enabled
+        expect(PaperTrail).to be_enabled
       end
-      ::PaperTrail.should_not be_enabled
+      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
-        ::PaperTrail.should_not be_enabled
+        expect(PaperTrail).not_to be_enabled
         expect { with_versioning { raise } }.to raise_error
-        ::PaperTrail.should_not be_enabled
+        expect(PaperTrail).not_to be_enabled
       end
     end
   end
 
   context '`versioning: true`', :versioning => true do
     it 'should have versioning on by default' do
-      ::PaperTrail.should be_enabled
+      expect(PaperTrail).to be_enabled
     end
     it 'should keep versioning on after a with_versioning block' do
-      ::PaperTrail.should be_enabled
+      expect(PaperTrail).to be_enabled
       with_versioning do
-        ::PaperTrail.should be_enabled
+        expect(PaperTrail).to be_enabled
       end
-      ::PaperTrail.should be_enabled
+      expect(PaperTrail).to be_enabled
     end
   end
 
   context '`with_versioning` block at class level' do
-    it { ::PaperTrail.should_not be_enabled }
+    it { expect(PaperTrail).not_to be_enabled }
 
     with_versioning do
       it 'should have versioning on by default' do
-        ::PaperTrail.should be_enabled
+        expect(PaperTrail).to be_enabled
       end
     end
     it 'should not leak the `enabled?` state into successive tests' do
-      ::PaperTrail.should_not be_enabled
+      expect(PaperTrail).not_to be_enabled
     end
   end
 
   describe :whodunnit do
-    before(:all) { ::PaperTrail.whodunnit = 'foobar' }
+    before(:all) { PaperTrail.whodunnit = 'foobar' }
 
     it "should get set to `nil` by default" do
-      ::PaperTrail.whodunnit.should be_nil
+      expect(PaperTrail.whodunnit).to be_nil
     end
   end
 
@@ -60,7 +60,7 @@ describe "PaperTrail RSpec Helper" do
     before(:all) { ::PaperTrail.controller_info = {:foo => 'bar'} }
 
     it "should get set to an empty hash before each test" do
-      ::PaperTrail.controller_info.should == {}
+      expect(PaperTrail.controller_info).to eq({})
     end
   end
 end

data/spec/rails_helper.rb

@@ -0,0 +1,34 @@
+# This file is copied to spec/ when you run 'rails generate rspec:install'
+ENV["RAILS_ENV"] ||= 'test'
+ENV["DB"] ||= 'sqlite'
+
+unless File.exists?(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 'shoulda/matchers'
+require 'ffaker'
+
+# 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,19 +1,18 @@
-require 'spec_helper'
+require 'rails_helper'
 
-describe "Articles" do
+describe "Articles management", :type => :request, :order => :defined do
   let(:valid_params) { { :article => { :title => 'Doh', :content => Faker::Lorem.sentence } } }
 
   context "versioning disabled" do
-    specify { PaperTrail.should_not be_enabled }
+    specify { expect(PaperTrail).not_to be_enabled }
 
     it "should not create a version" do
-      PaperTrail.should be_enabled_for_controller
-      expect { post articles_path(valid_params) }.to_not change(PaperTrail::Version, :count)
-      PaperTrail.should_not be_enabled_for_controller
+      expect(PaperTrail).to be_enabled_for_controller
+      expect { post(articles_path, 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
-      PaperTrail.should be_enabled_for_controller
+      expect(PaperTrail).to be_enabled_for_controller
     end
   end
 
@@ -21,13 +20,10 @@ describe "Articles" do
     let(:article) { Article.last }
 
     context "`current_user` method returns a `String`" do
-      if RUBY_VERSION.to_f >= 1.9
-        it "should set that value as the `whodunnit`" do
-          expect { post articles_path(valid_params) }.to change(PaperTrail::Version, :count).by(1)
-          article.title.should == 'Doh'
-          PaperTrail.whodunnit.should == 'foobar'
-          article.versions.last.whodunnit.should == 'foobar'
-        end
+      it "should set that value as the `whodunnit`" do
+        expect { post articles_path, 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

data/spec/spec_helper.rb

@@ -1,48 +1,95 @@
-ENV["RAILS_ENV"] ||= 'test'
-ENV["DB"] ||= 'sqlite'
-
-unless File.exists?(File.expand_path('../../test/dummy/config/database.yml', __FILE__))
-  warn "WARNING: No database.yml detected for the dummy app, please run `rake prepare` first"
+begin
+  require 'pry-nav'
+rescue LoadError
+  # It's OK, we don't include pry in e.g. gemfiles/3.0.gemfile
 end
 
-require File.expand_path('../../test/dummy/config/environment', __FILE__)
-require 'rspec/rails'
-require 'rspec/autorun'
-require 'shoulda/matchers'
-require 'ffaker'
-
-# Requires supporting ruby files with custom matchers and macros, etc,
-# in spec/support/ and its subdirectories.
-Dir[Rails.root.join('spec/support/**/*.rb')].each { |f| require f }
-
+# 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|
-  config.treat_symbols_as_metadata_keys_with_true_values = true
+  # 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
 
-  # ## Mock Framework
-  #
-  # If you prefer to use mocha, flexmock or RR, uncomment the appropriate line:
-  #
-  # config.mock_with :mocha
-  # config.mock_with :flexmock
-  # config.mock_with :rr
+  # 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
 
-  # Remove this line if you're not using ActiveRecord or ActiveRecord fixtures
-  # config.fixture_path = "#{::Rails.root}/spec/fixtures"
+# The settings below are suggested to provide a good initial experience
+# with RSpec, but feel free to customize to your heart's content.
+=begin
+  # 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
 
-  # 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
+  # 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!
 
-  # If true, the base class of anonymous controllers will be inferred
-  # automatically. This will be the default behavior in future versions of
-  # rspec-rails.
-  config.infer_base_class_for_anonymous_controllers = false
+  # 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'
+  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
 end