shoulda-matchers 4.4.1 → 4.5.0

data/lib/shoulda/matchers/active_record/have_db_column_matcher.rb

@@ -84,6 +84,8 @@ module Shoulda
 
       # @private
       class HaveDbColumnMatcher
+        OPTIONS = %i(precision limit default null scale primary).freeze
+
         def initialize(column)
           @column = column
           @options = {}
@@ -95,7 +97,8 @@ module Shoulda
         end
 
         def with_options(opts = {})
-          %w(precision limit default null scale primary).each do |attribute|
+          validate_options(opts)
+          OPTIONS.each do |attribute|
             if opts.key?(attribute.to_sym)
               @options[attribute.to_sym] = opts[attribute.to_sym]
             end
@@ -125,23 +128,38 @@ module Shoulda
 
         def description
           desc = "have db column named #{@column}"
-          desc << " of type #{@options[:column_type]}"    if @options.key?(:column_type)
-          desc << " of precision #{@options[:precision]}" if @options.key?(:precision)
-          desc << " of limit #{@options[:limit]}"         if @options.key?(:limit)
-          desc << " of default #{@options[:default]}"     if @options.key?(:default)
-          desc << " of null #{@options[:null]}"           if @options.key?(:null)
-          desc << " of primary #{@options[:primary]}"     if @options.key?(:primary)
-          desc << " of scale #{@options[:scale]}"         if @options.key?(:scale)
+          if @options.key?(:column_type)
+            desc << " of type #{@options[:column_type]}"
+          end
+          if @options.key?(:precision)
+            desc << " of precision #{@options[:precision]}"
+          end
+          desc << " of limit #{@options[:limit]}" if @options.key?(:limit)
+          desc << " of default #{@options[:default]}" if @options.key?(:default)
+          desc << " of null #{@options[:null]}" if @options.key?(:null)
+          desc << " of primary #{@options[:primary]}" if @options.key?(:primary)
+          desc << " of scale #{@options[:scale]}" if @options.key?(:scale)
           desc
         end
 
         protected
 
+        def validate_options(opts)
+          invalid_options = opts.keys.map(&:to_sym) - OPTIONS
+          if invalid_options.any?
+            raise(
+              ArgumentError,
+              "Unknown option(s): #{invalid_options.map(&:inspect).join(', ')}",
+            )
+          end
+        end
+
         def column_exists?
           if model_class.column_names.include?(@column.to_s)
             true
           else
-            @missing = "#{model_class} does not have a db column named #{@column}."
+            @missing =
+              "#{model_class} does not have a db column named #{@column}."
             false
           end
         end
@@ -152,8 +170,9 @@ module Shoulda
           if matched_column.type.to_s == @options[:column_type].to_s
             true
           else
-            @missing = "#{model_class} has a db column named #{@column} " <<
-                       "of type #{matched_column.type}, not #{@options[:column_type]}."
+            @missing =
+              "#{model_class} has a db column named #{@column} " <<
+              "of type #{matched_column.type}, not #{@options[:column_type]}."
             false
           end
         end
@@ -229,18 +248,21 @@ module Shoulda
             true
           else
             @missing = "#{model_class} has a db column named #{@column} "
-            if @options[:primary]
-              @missing << 'that is not primary, but should be'
-            else
-              @missing << 'that is primary, but should not be'
-            end
+            @missing <<
+              if @options[:primary]
+                'that is not primary, but should be'
+              else
+                'that is primary, but should not be'
+              end
             false
           end
         end
 
         def matched_column
           @_matched_column ||= begin
-            column = model_class.columns.detect { |each| each.name == @column.to_s }
+            column = model_class.columns.detect do |each|
+              each.name == @column.to_s
+            end
             DecoratedColumn.new(model_class, column)
           end
         end

data/lib/shoulda/matchers/active_record/have_db_index_matcher.rb

@@ -156,7 +156,7 @@ module Shoulda
 
           description <<
             if qualifiers.include?(:unique)
-              Shoulda::Matchers::Util.a_or_an(index_type) + ' '
+              "#{Shoulda::Matchers::Util.a_or_an(index_type)} "
             else
               'an '
             end

data/lib/shoulda/matchers/active_record/have_implicit_order_column.rb

@@ -39,22 +39,22 @@ module Shoulda
           check_column_exists!
           check_implicit_order_column_matches!
           true
-        rescue SecondaryCheckFailedError => error
+        rescue SecondaryCheckFailedError => e
           @failure_message = Shoulda::Matchers.word_wrap(
             "Expected #{model.name} to #{expectation}, " +
-            "but that could not be proved: #{error.message}."
+            "but that could not be proved: #{e.message}.",
           )
           false
-        rescue PrimaryCheckFailedError => error
+        rescue PrimaryCheckFailedError => e
           @failure_message = Shoulda::Matchers.word_wrap(
-            "Expected #{model.name} to #{expectation}, but #{error.message}."
+            "Expected #{model.name} to #{expectation}, but #{e.message}.",
           )
           false
         end
 
         def failure_message_when_negated
           Shoulda::Matchers.word_wrap(
-            "Expected #{model.name} not to #{expectation}, but it did."
+            "Expected #{model.name} not to #{expectation}, but it did.",
           )
         end
 
@@ -72,7 +72,7 @@ module Shoulda
           if !matcher.matches?(@subject)
             raise SecondaryCheckFailedError.new(
               "The :#{model.table_name} table does not have a " +
-              ":#{column_name} column"
+              ":#{column_name} column",
             )
           end
         end
@@ -81,7 +81,7 @@ module Shoulda
           if model.implicit_order_column.to_s != column_name.to_s
             message =
               if model.implicit_order_column.nil?
-                "implicit_order_column is not set"
+                'implicit_order_column is not set'
               else
                 "it is :#{model.implicit_order_column}"
               end

data/lib/shoulda/matchers/active_record/have_readonly_attribute_matcher.rb

@@ -35,17 +35,19 @@ module Shoulda
         def matches?(subject)
           @subject = subject
           if readonly_attributes.include?(@attribute)
-            @failure_message_when_negated = "Did not expect #{@attribute} to be read-only"
+            @failure_message_when_negated = "Did not expect #{@attribute}"\
+            ' to be read-only'
             true
           else
-            if readonly_attributes.empty?
-              @failure_message = "#{class_name} attribute #{@attribute} " <<
-                'is not read-only'
-            else
-              @failure_message = "#{class_name} is making " <<
-                "#{readonly_attributes.to_a.to_sentence} " <<
-                "read-only, but not #{@attribute}."
-            end
+            @failure_message =
+              if readonly_attributes.empty?
+                "#{class_name} attribute #{@attribute} " <<
+                  'is not read-only'
+              else
+                "#{class_name} is making " <<
+                  "#{readonly_attributes.to_a.to_sentence} " <<
+                  "read-only, but not #{@attribute}."
+              end
             false
           end
         end
@@ -57,7 +59,7 @@ module Shoulda
         private
 
         def readonly_attributes
-          @readonly_attributes ||= (@subject.class.readonly_attributes || [])
+          @_readonly_attributes ||= (@subject.class.readonly_attributes || [])
         end
 
         def class_name

data/lib/shoulda/matchers/active_record/have_rich_text_matcher.rb

@@ -12,7 +12,7 @@ module Shoulda
       #
       #     # RSpec
       #     RSpec.describe Post, type: :model do
-      #       it { is_expected.to have_rich_text(:content) }
+      #       it { should have_rich_text(:content) }
       #     end
       #
       #     # Minitest (Shoulda)
@@ -20,20 +20,21 @@ module Shoulda
       #       should have_rich_text(:content)
       #     end
       #
-      # @return [HaveRichText]
+      # @return [HaveRichTextMatcher]
       #
       def have_rich_text(rich_text_attribute)
-        HaveRichText.new(rich_text_attribute)
+        HaveRichTextMatcher.new(rich_text_attribute)
       end
 
       # @private
-      class HaveRichText
+      class HaveRichTextMatcher
         def initialize(rich_text_attribute)
           @rich_text_attribute = rich_text_attribute
         end
 
         def description
-          "have configured :#{rich_text_attribute} as a ActionText::RichText association"
+          "have configured :#{rich_text_attribute} as a "\
+          'ActionText::RichText association'
         end
 
         def failure_message
@@ -41,7 +42,8 @@ module Shoulda
         end
 
         def failure_message_when_negated
-          "Did not expect #{subject.class} to have ActionText::RichText :#{rich_text_attribute}"
+          "Did not expect #{subject.class} to have ActionText::RichText"\
+          " :#{rich_text_attribute}"
         end
 
         def matches?(subject)
@@ -67,7 +69,9 @@ module Shoulda
         end
 
         def has_expected_action_text?
-          @subject.send(rich_text_attribute).class.name == 'ActionText::RichText'
+          defined?(ActionText::RichText) &&
+            @subject.send(rich_text_attribute).
+              instance_of?(ActionText::RichText)
         end
 
         def error_description

data/lib/shoulda/matchers/active_record/have_secure_token_matcher.rb

@@ -63,12 +63,14 @@ module Shoulda
 
         def failure_message
           return if !@errors
+
           "Expected #{@subject.class} to #{description} but the following " \
           "errors were found: #{@errors.join(', ')}"
         end
 
         def failure_message_when_negated
           return if !@errors
+
           "Did not expect #{@subject.class} to have secure token " \
           ":#{token_attribute}"
         end

data/lib/shoulda/matchers/active_record/serialize_matcher.rb

@@ -121,7 +121,9 @@ module Shoulda
 
         def description
           description = "serialize :#{@name}"
-          description += " class_name => #{@options[:type]}" if @options.key?(:type)
+          if @options.key?(:type)
+            description += " class_name => #{@options[:type]}"
+          end
           description
         end
 
@@ -141,13 +143,12 @@ module Shoulda
             klass = serialization_coder
             if klass == @options[:type]
               true
+            elsif klass.respond_to?(:object_class) &&
+                  klass.object_class == @options[:type]
+              true
             else
-              if klass.respond_to?(:object_class) && klass.object_class == @options[:type]
-                true
-              else
-                @missing = ":#{@name} should be a type of #{@options[:type]}"
-                false
-              end
+              @missing = ":#{@name} should be a type of #{@options[:type]}"
+              false
             end
           else
             true
@@ -176,9 +177,12 @@ module Shoulda
         end
 
         def expectation
-          expectation = "#{model_class.name} to serialize the attribute called :#{@name}"
+          expectation = "#{model_class.name} to serialize the attribute called"\
+            " :#{@name}"
           expectation += " with a type of #{@options[:type]}" if @options[:type]
-          expectation += " with an instance of #{@options[:instance_type]}" if @options[:instance_type]
+          if @options[:instance_type]
+            expectation += " with an instance of #{@options[:instance_type]}"
+          end
           expectation
         end
 

data/lib/shoulda/matchers/active_record/uniqueness.rb

@@ -1,6 +1,6 @@
 module Shoulda
   module Matchers
-    module ActiveModel
+    module ActiveRecord
       # @private
       module Uniqueness
       end

data/lib/shoulda/matchers/active_record/uniqueness/test_model_creator.rb

@@ -1,5 +1,3 @@
-require 'thread'
-
 module Shoulda
   module Matchers
     module ActiveRecord
@@ -37,7 +35,7 @@ module Shoulda
           def new_model
             @_new_model ||= Model.next_unique_copy_of(
               model_name_without_namespace,
-              namespace
+              namespace,
             )
           end
 

data/lib/shoulda/matchers/active_record/uniqueness/test_models.rb

@@ -1,5 +1,3 @@
-require 'thread'
-
 module Shoulda
   module Matchers
     module ActiveRecord

data/lib/shoulda/matchers/active_record/validate_uniqueness_of_matcher.rb

@@ -80,7 +80,7 @@ module Shoulda
       #
       #     RSpec.describe Post, type: :model do
       #       describe "validations" do
-      #         subject { Post.create(content: "Here is the content") }
+      #         subject { Post.new(content: "Here is the content") }
       #         it { should validate_uniqueness_of(:title) }
       #       end
       #     end
@@ -92,7 +92,7 @@ module Shoulda
       #
       #     RSpec.describe Post, type: :model do
       #       describe "validations" do
-      #         subject { FactoryBot.create(:post) }
+      #         subject { FactoryBot.build(:post) }
       #         it { should validate_uniqueness_of(:title) }
       #       end
       #     end
@@ -157,6 +157,12 @@ module Shoulda
       #       should validate_uniqueness_of(:slug).scoped_to(:journal_id)
       #     end
       #
+      # NOTE: Support for testing uniqueness validation scoped to an array of
+      # associations is not available.
+      #
+      # For more information, please refer to
+      # https://github.com/thoughtbot/shoulda-matchers/issues/814
+      #
       # ##### case_insensitive
       #
       # Use `case_insensitive` to test usage of the `:case_sensitive` option
@@ -264,14 +270,14 @@ module Shoulda
           super(attribute)
           @expected_message = :taken
           @options = {
-            case_sensitivity_strategy: :sensitive
+            case_sensitivity_strategy: :sensitive,
           }
           @existing_record_created = false
           @failure_reason = nil
           @failure_reason_when_negated = nil
           @attribute_setters = {
             existing_record: AttributeSetters.new,
-            new_record: AttributeSetters.new
+            new_record: AttributeSetters.new,
           }
         end
 
@@ -407,11 +413,12 @@ module Shoulda
           else
             @failure_reason = 'Expected the validation '
 
-            if expected_scopes.empty?
-              @failure_reason << 'not to be scoped to anything, '
-            else
-              @failure_reason << "to be scoped to #{inspected_expected_scopes}, "
-            end
+            @failure_reason <<
+              if expected_scopes.empty?
+                'not to be scoped to anything, '
+              else
+                "to be scoped to #{inspected_expected_scopes}, "
+              end
 
             if actual_sets_of_scopes.any?
               @failure_reason << 'but it was scoped to '
@@ -455,7 +462,7 @@ module Shoulda
         def inspected_actual_scopes
           inspected_actual_sets_of_scopes.to_sentence(
             words_connector: ' and ',
-            last_word_connector: ', and'
+            last_word_connector: ', and',
           )
         end
 
@@ -491,7 +498,9 @@ module Shoulda
         def does_not_match_allow_nil?
           expects_to_allow_nil? && (
             update_existing_record!(nil) &&
-            (@failure_reason = nil || disallows_value_of(nil, @expected_message))
+            (@failure_reason = nil ||
+              disallows_value_of(nil, @expected_message)
+            )
           )
         end
 
@@ -527,21 +536,15 @@ module Shoulda
         end
 
         def find_existing_record
-          record = model.first
-
-          if record.present?
-            record
-          else
-            nil
-          end
+          model.first.presence
         end
 
         def create_existing_record
           @given_record.tap do |existing_record|
             existing_record.save(validate: false)
           end
-        rescue ::ActiveRecord::StatementInvalid => error
-          raise ExistingRecordInvalid.create(underlying_exception: error)
+        rescue ::ActiveRecord::StatementInvalid => e
+          raise ExistingRecordInvalid.create(underlying_exception: e)
         end
 
         def update_existing_record!(value)
@@ -577,7 +580,7 @@ module Shoulda
           attribute_names_under_test.each do |attribute_name|
             set_attribute_on_new_record!(
               attribute_name,
-              existing_record.public_send(attribute_name)
+              existing_record.public_send(attribute_name),
             )
           end
 
@@ -619,11 +622,12 @@ module Shoulda
 
             reason << inspected_scopes.to_sentence
 
-            if inspected_scopes.many?
-              reason << " do not seem to be attributes"
-            else
-              reason << " does not seem to be an attribute"
-            end
+            reason <<
+              if inspected_scopes.many?
+                ' do not seem to be attributes'
+              else
+                ' does not seem to be an attribute'
+              end
 
             reason << " on #{model.name}."
 
@@ -643,11 +647,12 @@ module Shoulda
 
             reason << inspected_scopes.to_sentence
 
-            if inspected_scopes.many?
-              reason << " seem to be attributes"
-            else
-              reason << " seems to be an attribute"
-            end
+            reason <<
+              if inspected_scopes.many?
+                ' seem to be attributes'
+              else
+                ' seems to be an attribute'
+              end
 
             reason << " on #{model.name}."
 
@@ -658,14 +663,14 @@ module Shoulda
         end
 
         def scopes_present_on_model
-          @_present_scopes ||= expected_scopes.select do |scope|
+          @_scopes_present_on_model ||= expected_scopes.select do |scope|
             model.method_defined?("#{scope}=")
           end
         end
 
         def scopes_missing_on_model
-          @_missing_scopes ||= expected_scopes.select do |scope|
-            !model.method_defined?("#{scope}=")
+          @_scopes_missing_on_model ||= expected_scopes.reject do |scope|
+            model.method_defined?("#{scope}=")
           end
         end
 
@@ -697,7 +702,7 @@ module Shoulda
                 raise NonCaseSwappableValueError.create(
                   model: model,
                   attribute: @attribute,
-                  value: value
+                  value: value,
                 )
               end
 
@@ -724,7 +729,7 @@ module Shoulda
                 raise NonCaseSwappableValueError.create(
                   model: model,
                   attribute: @attribute,
-                  value: value
+                  value: value,
                 )
               end
 
@@ -789,7 +794,7 @@ module Shoulda
           column = column_for(scope)
 
           if column.respond_to?(:array) && column.array
-            [ dummy_scalar_value_for(column) ]
+            [dummy_scalar_value_for(column)]
           else
             dummy_scalar_value_for(column)
           end
@@ -801,7 +806,7 @@ module Shoulda
 
         def next_value_for(scope, previous_value)
           if previous_value.is_a?(Array)
-            [ next_scalar_value_for(scope, previous_value[0]) ]
+            [next_scalar_value_for(scope, previous_value[0])]
           else
             next_scalar_value_for(scope, previous_value)
           end
@@ -857,7 +862,7 @@ module Shoulda
           attribute_setter = build_attribute_setter(
             record,
             attribute_name,
-            value
+            value,
           )
           attribute_setter.set!
 
@@ -869,7 +874,7 @@ module Shoulda
             :existing_record,
             existing_record,
             attribute_name,
-            value
+            value,
           )
         end
 
@@ -878,7 +883,7 @@ module Shoulda
             :new_record,
             new_record,
             attribute_name,
-            value
+            value,
           )
         end
 
@@ -896,13 +901,14 @@ module Shoulda
         end
 
         def build_attribute_setter(record, attribute_name, value)
-          Shoulda::Matchers::ActiveModel::AllowValueMatcher::AttributeSetter.new(
-            matcher_name: :validate_uniqueness_of,
-            object: record,
-            attribute_name: attribute_name,
-            value: value,
-            ignore_interference_by_writer: ignore_interference_by_writer
-          )
+          Shoulda::Matchers::ActiveModel::AllowValueMatcher::AttributeSetter.
+            new(
+              matcher_name: :validate_uniqueness_of,
+              object: record,
+              attribute_name: attribute_name,
+              value: value,
+              ignore_interference_by_writer: ignore_interference_by_writer,
+            )
         end
 
         def existing_value_read
@@ -929,7 +935,7 @@ module Shoulda
           @given_record.class
         end
 
-        def failure_message_preface
+        def failure_message_preface # rubocop:disable Metrics/MethodLength
           prefix = ''
 
           if @existing_record_created
@@ -938,30 +944,28 @@ module Shoulda
             if attribute_setter_for_existing_record
               prefix << ', setting '
               prefix << description_for_attribute_setter(
-                attribute_setter_for_existing_record
+                attribute_setter_for_existing_record,
               )
             else
               prefix << ", whose :#{attribute} is "
               prefix << "‹#{existing_value_read.inspect}›"
             end
 
-            prefix << ", and saving it as the existing record, then"
+            prefix << ', and saving it as the existing record, then'
+          elsif attribute_setter_for_existing_record
+            prefix << "Given an existing #{model.name},"
+            prefix << ' after setting '
+            prefix << description_for_attribute_setter(
+              attribute_setter_for_existing_record,
+            )
+            prefix << ', then'
           else
-            if attribute_setter_for_existing_record
-              prefix << "Given an existing #{model.name},"
-              prefix << ' after setting '
-              prefix << description_for_attribute_setter(
-                attribute_setter_for_existing_record
-              )
-              prefix << ', then'
-            else
-              prefix << "Given an existing #{model.name} whose :#{attribute}"
-              prefix << ' is '
-              prefix << Shoulda::Matchers::Util.inspect_value(
-                existing_value_read
-              )
-              prefix << ', after'
-            end
+            prefix << "Given an existing #{model.name} whose :#{attribute}"
+            prefix << ' is '
+            prefix << Shoulda::Matchers::Util.inspect_value(
+              existing_value_read,
+            )
+            prefix << ', after'
           end
 
           prefix << " making a new #{model.name} and setting "
@@ -988,7 +992,10 @@ different altogether.
           MESSAGE
         end
 
-        def description_for_attribute_setter(attribute_setter, same_as_existing: nil)
+        def description_for_attribute_setter(
+          attribute_setter,
+          same_as_existing: nil
+        )
           description = "its :#{attribute_setter.attribute_name} to "
 
           if same_as_existing == false
@@ -996,13 +1003,13 @@ different altogether.
           end
 
           description << Shoulda::Matchers::Util.inspect_value(
-            attribute_setter.value_written
+            attribute_setter.value_written,
           )
 
           if attribute_setter.attribute_changed_value?
             description << ' (read back as '
             description << Shoulda::Matchers::Util.inspect_value(
-              attribute_setter.value_read
+              attribute_setter.value_read,
             )
             description << ')'
           end
@@ -1026,7 +1033,7 @@ different altogether.
             )
             description_for_attribute_setter(
               attribute_setter,
-              same_as_existing: same_as_existing
+              same_as_existing: same_as_existing,
             )
           end
         end
@@ -1109,7 +1116,7 @@ b) If you meant for the validation to be case-insensitive, then you need to
 
 For more information, please see:
 
-http://matchers.shoulda.io/docs/v#{Shoulda::Matchers::VERSION}/file.NonCaseSwappableValueError.html
+https://matchers.shoulda.io/docs/v#{Shoulda::Matchers::VERSION}/file.NonCaseSwappableValueError.html
             MESSAGE
           end
         end