shoulda-matchers 3.1.0 → 5.2.0

data/lib/shoulda/matchers/active_record.rb

@@ -1,26 +1,34 @@
-require "shoulda/matchers/active_record/association_matcher"
-require "shoulda/matchers/active_record/association_matchers"
-require "shoulda/matchers/active_record/association_matchers/counter_cache_matcher"
-require "shoulda/matchers/active_record/association_matchers/inverse_of_matcher"
-require "shoulda/matchers/active_record/association_matchers/join_table_matcher"
-require "shoulda/matchers/active_record/association_matchers/order_matcher"
-require "shoulda/matchers/active_record/association_matchers/through_matcher"
-require "shoulda/matchers/active_record/association_matchers/dependent_matcher"
-require "shoulda/matchers/active_record/association_matchers/source_matcher"
-require "shoulda/matchers/active_record/association_matchers/model_reflector"
-require "shoulda/matchers/active_record/association_matchers/model_reflection"
-require "shoulda/matchers/active_record/association_matchers/option_verifier"
-require "shoulda/matchers/active_record/have_db_column_matcher"
-require "shoulda/matchers/active_record/have_db_index_matcher"
-require "shoulda/matchers/active_record/have_readonly_attribute_matcher"
-require "shoulda/matchers/active_record/serialize_matcher"
-require "shoulda/matchers/active_record/accept_nested_attributes_for_matcher"
-require "shoulda/matchers/active_record/define_enum_for_matcher"
-require "shoulda/matchers/active_record/uniqueness"
-require "shoulda/matchers/active_record/validate_uniqueness_of_matcher"
+require 'shoulda/matchers/active_record/association_matcher'
+require 'shoulda/matchers/active_record/association_matchers'
+require 'shoulda/matchers/active_record/association_matchers/counter_cache_matcher'
+require 'shoulda/matchers/active_record/association_matchers/inverse_of_matcher'
+require 'shoulda/matchers/active_record/association_matchers/join_table_matcher'
+require 'shoulda/matchers/active_record/association_matchers/order_matcher'
+require 'shoulda/matchers/active_record/association_matchers/through_matcher'
+require 'shoulda/matchers/active_record/association_matchers/dependent_matcher'
+require 'shoulda/matchers/active_record/association_matchers/required_matcher'
+require 'shoulda/matchers/active_record/association_matchers/optional_matcher'
+require 'shoulda/matchers/active_record/association_matchers/source_matcher'
+require 'shoulda/matchers/active_record/association_matchers/model_reflector'
+require 'shoulda/matchers/active_record/association_matchers/model_reflection'
+require 'shoulda/matchers/active_record/association_matchers/option_verifier'
+require 'shoulda/matchers/active_record/have_db_column_matcher'
+require 'shoulda/matchers/active_record/have_db_index_matcher'
+require 'shoulda/matchers/active_record/have_implicit_order_column'
+require 'shoulda/matchers/active_record/have_readonly_attribute_matcher'
+require 'shoulda/matchers/active_record/have_rich_text_matcher'
+require 'shoulda/matchers/active_record/have_secure_token_matcher'
+require 'shoulda/matchers/active_record/serialize_matcher'
+require 'shoulda/matchers/active_record/accept_nested_attributes_for_matcher'
+require 'shoulda/matchers/active_record/define_enum_for_matcher'
+require 'shoulda/matchers/active_record/uniqueness'
+require 'shoulda/matchers/active_record/validate_uniqueness_of_matcher'
+require 'shoulda/matchers/active_record/have_attached_matcher'
 
 module Shoulda
   module Matchers
+    # This module provides matchers that are used to test behavior within
+    # ActiveRecord classes.
     module ActiveRecord
     end
   end

data/lib/shoulda/matchers/configuration.rb

@@ -5,6 +5,11 @@ module Shoulda
       yield configuration
     end
 
+    # @private
+    def self.integrations
+      configuration.integrations
+    end
+
     # @private
     def self.configuration
       @_configuration ||= Configuration.new
@@ -12,8 +17,14 @@ module Shoulda
 
     # @private
     class Configuration
+      attr_reader :integrations
+
+      def initialize
+        @integrations = nil
+      end
+
       def integrate(&block)
-        Integrations::Configuration.apply(self, &block)
+        @integrations = Integrations::Configuration.apply(&block)
       end
     end
   end

data/lib/shoulda/matchers/doublespeak/double.rb

@@ -82,7 +82,7 @@ module Shoulda
               method_name: _method_name,
               args: args,
               block: block,
-              caller: caller
+              caller: caller,
             )
             implementation.call(call)
           end

data/lib/shoulda/matchers/doublespeak/double_collection.rb

@@ -18,19 +18,19 @@ module Shoulda
         end
 
         def activate
-          doubles_by_method_name.each do |method_name, double|
+          doubles_by_method_name.each do |_method_name, double|
             double.activate
           end
         end
 
         def deactivate
-          doubles_by_method_name.each do |method_name, double|
+          doubles_by_method_name.each do |_method_name, double|
             double.deactivate
           end
         end
 
         def calls_by_method_name
-          doubles_by_method_name.reduce({}) do |hash, (method_name, double)|
+          doubles_by_method_name.inject({}) do |hash, (method_name, double)|
             hash.merge method_name => double.calls.map(&:args)
           end
         end

data/lib/shoulda/matchers/doublespeak/double_implementation_registry.rb

@@ -4,23 +4,26 @@ module Shoulda
       # @private
       module DoubleImplementationRegistry
         class << self
-          REGISTRY = {}
-
           def find(type)
             find_class!(type).create
           end
 
           def register(klass, type)
-            REGISTRY[type] = klass
+            registry[type] = klass
           end
 
           private
 
           def find_class!(type)
-            REGISTRY.fetch(type) do
-              raise ArgumentError, "No double implementation class found for '#{type}'"
+            registry.fetch(type) do
+              raise ArgumentError, 'No double implementation class found for'\
+                " '#{type}'"
             end
           end
+
+          def registry
+            @_registry ||= {}
+          end
         end
       end
     end

data/lib/shoulda/matchers/doublespeak/object_double.rb

@@ -14,7 +14,11 @@ module Shoulda
           @calls_by_method_name[method_name] || []
         end
 
-        def respond_to?(name, include_private = nil)
+        def respond_to?(_name, _include_private = nil)
+          true
+        end
+
+        def respond_to_missing?(_name, _include_all)
           true
         end
 
@@ -23,7 +27,7 @@ module Shoulda
             method_name: method_name,
             args: args,
             block: block,
-            caller: ::Kernel.caller
+            caller: ::Kernel.caller,
           )
           calls << call
           (calls_by_method_name[method_name] ||= []) << call

data/lib/shoulda/matchers/doublespeak/stub_implementation.rb

@@ -14,11 +14,7 @@ module Shoulda
         end
 
         def returns(value = nil, &block)
-          if block
-            @implementation = block
-          else
-            @implementation = proc { value }
-          end
+          @implementation = block || proc { value }
         end
 
         def call(call)

data/lib/shoulda/matchers/doublespeak/world.rb

@@ -39,13 +39,13 @@ module Shoulda
         private
 
         def activate
-          double_collections_by_class.each do |klass, double_collection|
+          double_collections_by_class.each do |_klass, double_collection|
             double_collection.activate
           end
         end
 
         def deactivate
-          double_collections_by_class.each do |klass, double_collection|
+          double_collections_by_class.each do |_klass, double_collection|
             double_collection.deactivate
           end
         end

data/lib/shoulda/matchers/doublespeak.rb

@@ -1,4 +1,5 @@
 require 'forwardable'
+require 'logger'
 
 module Shoulda
   module Matchers
@@ -20,7 +21,7 @@ module Shoulda
 
         def debug(&block)
           if debugging_enabled?
-            puts block.call
+            puts block.call # rubocop:disable Rails/Output
           end
         end
       end

data/lib/shoulda/matchers/error.rb

@@ -18,7 +18,7 @@ module Shoulda
       end
 
       def message
-        ""
+        ''
       end
 
       def inspect

data/lib/shoulda/matchers/independent/delegate_method_matcher.rb

@@ -148,6 +148,26 @@ module Shoulda
       #         with_arguments(expedited: true)
       #     end
       #
+      # ##### allow_nil
+      #
+      # Use `allow_nil` if the delegation accounts for the fact that your
+      # delegate object could be nil. (This is mostly intended as an analogue to
+      # the `allow_nil` option that Rails' `delegate` helper takes.)
+      #
+      #     class Account
+      #       delegate :plan, to: :subscription, allow_nil: true
+      #     end
+      #
+      #     # RSpec
+      #     describe Account do
+      #       it { should delegate_method(:plan).to(:subscription).allow_nil }
+      #     end
+      #
+      #     # Minitest
+      #     class PageTest < Minitest::Test
+      #       should delegate_method(:plan).to(:subscription).allow_nil
+      #     end
+      #
       # @return [DelegateMethodMatcher]
       #
       def delegate_method(delegating_method)
@@ -162,10 +182,11 @@ module Shoulda
           @delegate_method = @delegating_method
           @delegate_object = Doublespeak::ObjectDouble.new
 
-          @delegated_arguments = []
-          @delegate_object_reader_method = nil
+          @context = nil
           @subject = nil
-          @subject_double_collection = nil
+          @delegate_object_reader_method = nil
+          @delegated_arguments = []
+          @expects_to_allow_nil_delegate_object = false
         end
 
         def in_context(context)
@@ -180,11 +201,13 @@ module Shoulda
 
           subject_has_delegating_method? &&
             subject_has_delegate_object_reader_method? &&
-            subject_delegates_to_delegate_object_correctly?
+            subject_delegates_to_delegate_object_correctly? &&
+            subject_handles_nil_delegate_object?
         end
 
         def description
-          string = "delegate #{formatted_delegating_method_name} to " +
+          string =
+            "delegate #{formatted_delegating_method_name} to the " +
             "#{formatted_delegate_object_reader_method_name} object"
 
           if delegated_arguments.any?
@@ -195,6 +218,12 @@ module Shoulda
             string << " as #{formatted_delegate_method}"
           end
 
+          if expects_to_allow_nil_delegate_object?
+            string << ', allowing '
+            string << formatted_delegate_object_reader_method_name
+            string << ' to return nil'
+          end
+
           string
         end
 
@@ -216,26 +245,46 @@ module Shoulda
         def with_prefix(prefix = nil)
           @delegating_method =
             :"#{build_delegating_method_prefix(prefix)}_#{delegate_method}"
-            delegate_method
+          delegate_method
+          self
+        end
+
+        def allow_nil
+          @expects_to_allow_nil_delegate_object = true
           self
         end
 
         def build_delegating_method_prefix(prefix)
           case prefix
-            when true, nil then delegate_object_reader_method
-            else prefix
+          when true, nil then delegate_object_reader_method
+          else prefix
           end
         end
 
         def failure_message
-          "Expected #{class_under_test} to #{description}\n" +
-            "Method calls sent to " +
-            "#{formatted_delegate_object_reader_method_name(include_module: true)}:" +
-            formatted_calls_on_delegate_object
+          message = "Expected #{class_under_test} to #{description}.\n\n"
+
+          if failed_to_allow_nil_delegate_object?
+            message << formatted_delegating_method_name(include_module: true)
+            message << ' did delegate to '
+            message << formatted_delegate_object_reader_method_name
+            message << ' when it was non-nil, but it failed to account '
+            message << 'for when '
+            message << formatted_delegate_object_reader_method_name
+            message << ' *was* nil.'
+          else
+            message << 'Method calls sent to '
+            message << formatted_delegate_object_reader_method_name(
+              include_module: true,
+            )
+            message << ": #{formatted_calls_on_delegate_object}"
+          end
+
+          Shoulda::Matchers.word_wrap(message)
         end
 
         def failure_message_when_negated
-          "Expected #{class_under_test} not to #{description}, but it did"
+          "Expected #{class_under_test} not to #{description}, but it did."
         end
 
         protected
@@ -246,7 +295,6 @@ module Shoulda
           :delegating_method,
           :method,
           :delegate_method,
-          :subject_double_collection,
           :delegate_object,
           :delegate_object_reader_method
 
@@ -270,6 +318,10 @@ module Shoulda
           end
         end
 
+        def expects_to_allow_nil_delegate_object?
+          @expects_to_allow_nil_delegate_object
+        end
+
         def formatted_delegate_method(options = {})
           formatted_method_name_for(delegate_method, options)
         end
@@ -292,7 +344,7 @@ module Shoulda
           if options[:include_module]
             class_under_test.to_s
           else
-            ""
+            ''
           end
         end
 
@@ -329,11 +381,7 @@ module Shoulda
         end
 
         def subject_delegates_to_delegate_object_correctly?
-          register_subject_double_collection
-
-          Doublespeak.with_doubles_activated do
-            subject.public_send(delegating_method, *delegated_arguments)
-          end
+          call_delegating_method_with_delegate_method_returning(delegate_object)
 
           if delegated_arguments.any?
             delegate_object_received_call_with_delegated_arguments?
@@ -342,13 +390,45 @@ module Shoulda
           end
         end
 
-        def register_subject_double_collection
+        def subject_handles_nil_delegate_object?
+          @subject_handled_nil_delegate_object =
+            if expects_to_allow_nil_delegate_object?
+              begin
+                call_delegating_method_with_delegate_method_returning(nil)
+                true
+              rescue Module::DelegationError
+                false
+              rescue NoMethodError => e
+                if e.message =~
+                   /undefined method `#{delegate_method}' for nil:NilClass/
+                  false
+                else
+                  raise e
+                end
+              end
+            else
+              true
+            end
+        end
+
+        def failed_to_allow_nil_delegate_object?
+          expects_to_allow_nil_delegate_object? &&
+            !@subject_handled_nil_delegate_object
+        end
+
+        def call_delegating_method_with_delegate_method_returning(value)
+          register_subject_double_collection_to(value)
+
+          Doublespeak.with_doubles_activated do
+            subject.public_send(delegating_method, *delegated_arguments)
+          end
+        end
+
+        def register_subject_double_collection_to(returned_value)
           double_collection =
             Doublespeak.double_collection_for(subject.singleton_class)
           double_collection.register_stub(delegate_object_reader_method).
-            to_return(delegate_object)
-
-          @subject_double_collection = double_collection
+            to_return(returned_value)
         end
 
         def calls_to_delegate_method
@@ -360,17 +440,17 @@ module Shoulda
         end
 
         def formatted_calls_on_delegate_object
-          string = ""
+          string = ''
 
           if calls_on_delegate_object.any?
-            string << "\n"
+            string << "\n\n"
             calls_on_delegate_object.each_with_index do |call, i|
               name = call.method_name
-              args = call.args.map { |arg| arg.inspect }.join(', ')
-              string << "#{i+1}) #{name}(#{args})\n"
+              args = call.args.map(&:inspect).join(', ')
+              string << "#{i + 1}) #{name}(#{args})\n"
             end
           else
-            string << " (none)"
+            string << ' (none)'
           end
 
           string.rstrip!

data/lib/shoulda/matchers/independent.rb

@@ -1,10 +1,10 @@
 require 'shoulda/matchers/independent/delegate_method_matcher'
-require 'shoulda/matchers/independent/delegate_method_matcher/stubbed_target'
 require 'shoulda/matchers/independent/delegate_method_matcher/target_not_defined_error'
 
 module Shoulda
   module Matchers
-    # Matchers for non-Rails-dependent code.
+    # This module provides matchers that are used to test behavior outside of
+    # Rails-specific classes.
     module Independent
     end
   end

data/lib/shoulda/matchers/integrations/configuration.rb

@@ -5,11 +5,13 @@ module Shoulda
     module Integrations
       # @private
       class Configuration
-        def self.apply(configuration, &block)
-          new(configuration, &block).apply
+        def self.apply(&block)
+          new(&block).apply
         end
 
-        def initialize(configuration, &block)
+        attr_reader :test_frameworks
+
+        def initialize(&block)
           @test_frameworks = Set.new
           @libraries = Set.new
 
@@ -47,6 +49,8 @@ EOT
             test_framework.include(Shoulda::Matchers::Independent)
             @libraries.each { |library| library.integrate_with(test_framework) }
           end
+
+          self
         end
 
         private
@@ -56,7 +60,7 @@ EOT
         end
 
         def no_test_frameworks_added?
-          @test_frameworks.empty? || !@test_frameworks.any?(&:present?)
+          @test_frameworks.empty? || @test_frameworks.none?(&:present?)
         end
 
         def no_libraries_added?

data/lib/shoulda/matchers/integrations/libraries/action_controller.rb

@@ -13,7 +13,7 @@ module Shoulda
             test_framework.include(matchers_module, type: :controller)
 
             include_into(::ActionController::TestCase, matchers_module) do
-              def subject
+              def subject # rubocop:disable Lint/NestedMethodDefinition
                 @controller
               end
             end

data/lib/shoulda/matchers/integrations/libraries/rails.rb

@@ -12,8 +12,8 @@ module Shoulda
             :active_model,
             :active_record,
             :action_controller,
-            :routing
-          ]
+            :routing,
+          ].freeze
 
           def integrate_with(test_framework)
             Shoulda::Matchers.assertion_exception_class =

data/lib/shoulda/matchers/integrations/test_frameworks/active_support_test_case.rb

@@ -9,7 +9,7 @@ module Shoulda
           def validate!
           end
 
-          def include(*modules, **options)
+          def include(*modules, **_options)
             test_case_class.include(*modules)
           end
 

data/lib/shoulda/matchers/integrations/test_frameworks/minitest_4.rb

@@ -9,7 +9,7 @@ module Shoulda
           def validate!
           end
 
-          def include(*modules, **options)
+          def include(*modules, **_options)
             test_case_class.class_eval do
               include(*modules)
               extend(*modules)

data/lib/shoulda/matchers/integrations/test_frameworks/minitest_5.rb

@@ -10,7 +10,7 @@ module Shoulda
           def validate!
           end
 
-          def include(*modules, **options)
+          def include(*modules, **_options)
             test_case_class.class_eval do
               include(*modules)
               extend(*modules)

data/lib/shoulda/matchers/integrations/test_frameworks/missing_test_framework.rb

@@ -20,7 +20,7 @@ Shoulda::Matchers.configure do |config|
     with.test_framework :test_unit
   end
 end
-EOT
+            EOT
           end
 
           def include(*modules, **options)

data/lib/shoulda/matchers/integrations/test_frameworks/test_unit.rb

@@ -9,7 +9,7 @@ module Shoulda
           def validate!
           end
 
-          def include(*modules, **options)
+          def include(*modules, **_options)
             test_case_class.class_eval do
               include(*modules)
               extend(*modules)