shoulda-matchers 4.3.0 → 4.4.0

data/lib/shoulda/matchers/active_record/association_matchers/join_table_matcher.rb

@@ -29,7 +29,7 @@ module Shoulda
               if option_verifier.correct_for_string?(:join_table, options[:join_table_name])
                 true
               else
-                @failure_message = "#{name} should use '#{options[:join_table_name]}' for :join_table option"
+                @failure_message = "#{name} should use #{options[:join_table_name].inspect} for :join_table option"
                 false
               end
             else
@@ -38,7 +38,7 @@ module Shoulda
           end
 
           def join_table_exists?
-            if RailsShim.tables_and_views(connection).include?(join_table_name)
+            if RailsShim.tables_and_views(connection).include?(join_table_name.to_s)
               true
             else
               @failure_message = missing_table_message

data/lib/shoulda/matchers/active_record/association_matchers/model_reflection.rb

@@ -35,12 +35,12 @@ module Shoulda
             join_table_name.to_s
           end
 
-          def association_relation
+          def association_relation(related_instance)
             relation = associated_class.all
 
             if reflection.scope
               # Source: AR::Associations::AssociationScope#eval_scope
-              relation.instance_exec(subject, &reflection.scope)
+              relation.instance_exec(related_instance, &reflection.scope)
             else
               relation
             end
@@ -65,16 +65,22 @@ module Shoulda
             end
           end
 
+          def validate_inverse_of_through_association!
+            if through?
+              reflection.check_validity!
+            end
+          end
+
+          def has_and_belongs_to_many_name
+            reflection.options[:through]
+          end
+
           protected
 
           attr_reader :reflection, :subject
 
           private
 
-          def has_and_belongs_to_many_name
-            reflection.options[:through]
-          end
-
           def has_and_belongs_to_many_name_table_name
             if has_and_belongs_to_many_reflection
               has_and_belongs_to_many_reflection.table_name

data/lib/shoulda/matchers/active_record/association_matchers/model_reflector.rb

@@ -4,15 +4,32 @@ module Shoulda
       module AssociationMatchers
         # @private
         class ModelReflector
-          delegate :associated_class, :through?, :join_table_name,
-            :association_relation, :polymorphic?, :foreign_key,
-            :association_foreign_key, to: :reflection
+          delegate(
+            :associated_class,
+            :association_foreign_key,
+            :foreign_key,
+            :has_and_belongs_to_many_name,
+            :join_table_name,
+            :polymorphic?,
+            :validate_inverse_of_through_association!,
+            to: :reflection
+          )
+
+          delegate(
+            :through?,
+            to: :reflection,
+            allow_nil: true
+          )
 
           def initialize(subject, name)
             @subject = subject
             @name = name
           end
 
+          def association_relation
+            reflection.association_relation(subject)
+          end
+
           def reflection
             @reflection ||= reflect_on_association(name)
           end

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

@@ -0,0 +1,147 @@
+module Shoulda
+  module Matchers
+    module ActiveRecord
+      def have_one_attached(name)
+        HaveAttachedMatcher.new(:one, name)
+      end
+
+      def have_many_attached(name)
+        HaveAttachedMatcher.new(:many, name)
+      end
+
+      # @private
+      class HaveAttachedMatcher
+        attr_reader :name
+
+        def initialize(macro, name)
+          @macro = macro
+          @name = name
+        end
+
+        def description
+          "have a has_#{macro}_attached called #{name}"
+        end
+
+        def failure_message
+          <<-MESSAGE
+Expected #{expectation}, but this could not be proved.
+  #{@failure}
+          MESSAGE
+        end
+
+        def failure_message_when_negated
+          <<-MESSAGE
+Did not expect #{expectation}, but it does.
+          MESSAGE
+        end
+
+        def expectation
+          "#{model_class.name} to #{description}"
+        end
+
+        def matches?(subject)
+          @subject = subject
+          reader_attribute_exists? &&
+            writer_attribute_exists? &&
+            attachments_association_exists? &&
+            blobs_association_exists? &&
+            eager_loading_scope_exists?
+        end
+
+        private
+
+        attr_reader :subject, :macro
+
+        def reader_attribute_exists?
+          if subject.respond_to?(name)
+            true
+          else
+            @failure = "#{model_class.name} does not have a :#{name} method."
+            false
+          end
+        end
+
+        def writer_attribute_exists?
+          if subject.respond_to?("#{name}=")
+            true
+          else
+            @failure = "#{model_class.name} does not have a :#{name}= method."
+            false
+          end
+        end
+
+        def attachments_association_exists?
+          if attachments_association_matcher.matches?(subject)
+            true
+          else
+            @failure = attachments_association_matcher.failure_message
+            false
+          end
+        end
+
+        def attachments_association_matcher
+          @_attachments_association_matcher ||=
+            AssociationMatcher.new(
+              :"has_#{macro}",
+              attachments_association_name,
+            ).
+              conditions(name: name).
+              class_name('ActiveStorage::Attachment').
+              inverse_of(:record)
+        end
+
+        def attachments_association_name
+          case macro
+          when :one then
+            "#{name}_attachment"
+          when :many then
+            "#{name}_attachments"
+          end
+        end
+
+        def blobs_association_exists?
+          if blobs_association_matcher.matches?(subject)
+            true
+          else
+            @failure = blobs_association_matcher.failure_message
+            false
+          end
+        end
+
+        def blobs_association_matcher
+          @_blobs_association_matcher ||=
+            AssociationMatcher.new(
+              :"has_#{macro}",
+              blobs_association_name,
+            ).
+              through(attachments_association_name).
+              class_name('ActiveStorage::Blob').
+              source(:blob)
+        end
+
+        def blobs_association_name
+          case macro
+          when :one then
+            "#{name}_blob"
+          when :many then
+            "#{name}_blobs"
+          end
+        end
+
+        def eager_loading_scope_exists?
+          if model_class.respond_to?("with_attached_#{name}")
+            true
+          else
+            @failure = "#{model_class.name} does not have a " \
+                       ":with_attached_#{name} scope."
+            false
+          end
+        end
+
+        def model_class
+          subject.class
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,106 @@
+module Shoulda
+  module Matchers
+    module ActiveRecord
+      # The `have_implicit_order_column` matcher tests that the model has `implicit_order_column`
+      # assigned to one of the table columns. (Rails 6+ only)
+      #
+      #     class Product < ApplicationRecord
+      #       self.implicit_order_column = :created_at
+      #     end
+      #
+      #     # RSpec
+      #     RSpec.describe Product, type: :model do
+      #       it { should have_implicit_order_column(:created_at) }
+      #     end
+      #
+      #     # Minitest (Shoulda)
+      #     class ProductTest < ActiveSupport::TestCase
+      #       should have_implicit_order_column(:created_at)
+      #     end
+      #
+      # @return [HaveImplicitOrderColumnMatcher]
+      #
+      if RailsShim.active_record_gte_6?
+        def have_implicit_order_column(column_name)
+          HaveImplicitOrderColumnMatcher.new(column_name)
+        end
+      end
+
+      # @private
+      class HaveImplicitOrderColumnMatcher
+        attr_reader :failure_message
+
+        def initialize(column_name)
+          @column_name = column_name
+        end
+
+        def matches?(subject)
+          @subject = subject
+          check_column_exists!
+          check_implicit_order_column_matches!
+          true
+        rescue SecondaryCheckFailedError => error
+          @failure_message = Shoulda::Matchers.word_wrap(
+            "Expected #{model.name} to #{expectation}, " +
+            "but that could not be proved: #{error.message}."
+          )
+          false
+        rescue PrimaryCheckFailedError => error
+          @failure_message = Shoulda::Matchers.word_wrap(
+            "Expected #{model.name} to #{expectation}, but #{error.message}."
+          )
+          false
+        end
+
+        def failure_message_when_negated
+          Shoulda::Matchers.word_wrap(
+            "Expected #{model.name} not to #{expectation}, but it did."
+          )
+        end
+
+        def description
+          expectation
+        end
+
+        private
+
+        attr_reader :column_name, :subject
+
+        def check_column_exists!
+          matcher = HaveDbColumnMatcher.new(column_name)
+
+          if !matcher.matches?(@subject)
+            raise SecondaryCheckFailedError.new(
+              "The :#{model.table_name} table does not have a " +
+              ":#{column_name} column"
+            )
+          end
+        end
+
+        def check_implicit_order_column_matches!
+          if model.implicit_order_column.to_s != column_name.to_s
+            message =
+              if model.implicit_order_column.nil?
+                "implicit_order_column is not set"
+              else
+                "it is :#{model.implicit_order_column}"
+              end
+
+            raise PrimaryCheckFailedError.new(message)
+          end
+        end
+
+        def model
+          subject.class
+        end
+
+        def expectation
+          "have an implicit_order_column of :#{column_name}"
+        end
+
+        class SecondaryCheckFailedError < StandardError; end
+        class PrimaryCheckFailedError < StandardError; end
+      end
+    end
+  end
+end

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

@@ -4,12 +4,7 @@ module Shoulda
       # The `have_secure_token` matcher tests usage of the
       # `has_secure_token` macro.
       #
-      # #### Example
-      #
       #     class User < ActiveRecord
-      #       attr_accessor :token
-      #       attr_accessor :auth_token
-      #
       #       has_secure_token
       #       has_secure_token :auth_token
       #     end
@@ -26,14 +21,32 @@ module Shoulda
       #       should have_secure_token(:auth_token)
       #     end
       #
+      # #### Qualifiers
+      #
+      # ##### ignoring_check_for_db_index
+      #
+      # By default, this matcher tests that an index is defined on your token
+      # column. Use `ignoring_check_for_db_index` if this is not the case.
+      #
+      #     class User < ActiveRecord
+      #       has_secure_token :auth_token
+      #     end
+      #
+      #     # RSpec
+      #     RSpec.describe User, type: :model do
+      #       it { should have_secure_token(:auth_token).ignoring_check_for_db_index }
+      #     end
+      #
+      #     # Minitest (Shoulda)
+      #     class UserTest < ActiveSupport::TestCase
+      #       should have_secure_token(:auth_token).ignoring_check_for_db_index
+      #     end
+      #
       # @return [HaveSecureToken]
       #
-
-      # rubocop:disable Style/PredicateName
       def have_secure_token(token_attribute = :token)
         HaveSecureTokenMatcher.new(token_attribute)
       end
-      # rubocop:enable Style/PredicateName
 
       # @private
       class HaveSecureTokenMatcher
@@ -41,6 +54,7 @@ module Shoulda
 
         def initialize(token_attribute)
           @token_attribute = token_attribute
+          @options = { ignore_check_for_db_index: false }
         end
 
         def description
@@ -65,6 +79,11 @@ module Shoulda
           @errors.empty?
         end
 
+        def ignoring_check_for_db_index
+          @options[:ignore_check_for_db_index] = true
+          self
+        end
+
         private
 
         def run_checks
@@ -75,7 +94,7 @@ module Shoulda
           if !has_expected_db_column?
             @errors << "missing correct column #{token_attribute}:string"
           end
-          if !has_expected_db_index?
+          if !@options[:ignore_check_for_db_index] && !has_expected_db_index?
             @errors << "missing unique index for #{table_and_column}"
           end
           @errors

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

@@ -1,14 +1,14 @@
 module Shoulda
   module Matchers
-    module ActiveModel
+    module ActiveRecord
       # @private
       module Uniqueness
+        autoload :Model, 'shoulda/matchers/active_record/uniqueness/model'
+        autoload :Namespace, 'shoulda/matchers/active_record/uniqueness/namespace'
+        autoload :TestModelCreator, 'shoulda/matchers/active_record/uniqueness/test_model_creator'
+        autoload :TestModels, 'shoulda/matchers/active_record/uniqueness/test_models'
       end
     end
   end
 end
 
-require 'shoulda/matchers/active_record/uniqueness/model'
-require 'shoulda/matchers/active_record/uniqueness/namespace'
-require 'shoulda/matchers/active_record/uniqueness/test_model_creator'
-require 'shoulda/matchers/active_record/uniqueness/test_models'

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

@@ -396,7 +396,7 @@ module Shoulda
         end
 
         def validations
-          model._validators[@attribute].select do |validator|
+          model.validators_on(@attribute).select do |validator|
             validator.is_a?(::ActiveRecord::Validations::UniquenessValidator)
           end
         end
@@ -820,7 +820,7 @@ module Shoulda
           elsif previous_value.respond_to?(:next)
             previous_value.next
           elsif previous_value.respond_to?(:to_datetime)
-            previous_value.to_datetime.next
+            previous_value.to_datetime.in(60).next
           elsif boolean_value?(previous_value)
             !previous_value
           else