minitest-rails 3.0.0 → 6.1.0

data/lib/minitest/rails/expectations/action_mailer.rb

@@ -0,0 +1,175 @@
+require "active_support/concern"
+
+module Minitest
+  module Rails
+    module Expectations
+      module ActionMailer
+        ##
+        # Asserts that the number of emails sent matches the given number.
+        #
+        #   def test_emails
+        #     must_have_emails 0
+        #     ContactMailer.welcome.deliver_now
+        #     must_have_emails 1
+        #     ContactMailer.welcome.deliver_now
+        #     must_have_emails 2
+        #   end
+        #
+        # If a block is passed, that block should cause the specified number of
+        # emails to be sent.
+        #
+        #   def test_emails_again
+        #     must_have_emails 1 do
+        #       ContactMailer.welcome.deliver_now
+        #     end
+        #
+        #     must_have_emails 2 do
+        #       ContactMailer.welcome.deliver_now
+        #       ContactMailer.welcome.deliver_later
+        #     end
+        #   end
+        #
+        # See also ActionMailer::TestClass#assert_emails
+        # See https://api.rubyonrails.org/v6.1/classes/ActionMailer/TestHelper.html#method-i-assert_emails
+        #
+        # :method: must_have_emails
+        # :call-seq: must_have_emails(number, &block)
+
+        # Asserts that no emails have been sent.
+        #
+        #   def test_emails
+        #     wont_have_emails
+        #     ContactMailer.welcome.deliver_now
+        #     must_have_emails 1
+        #   end
+        #
+        # If a block is passed, that block should not cause any emails to be sent.
+        #
+        #   def test_emails_again
+        #     wont_have_emails do
+        #       # No emails should be sent from this block
+        #     end
+        #   end
+        #
+        # Note: This assertion is simply a shortcut for:
+        #
+        #   must_have_emails 0, &block
+        #
+        # See also ActionMailer::TestClass#wont_have_emails
+        # See https://api.rubyonrails.org/v6.1/classes/ActionMailer/TestHelper.html#method-i-assert_no_emails
+        #
+        # :method: wont_have_emails
+        # :call-seq: wont_have_emails(&block)
+
+        ##
+        # Asserts that the number of emails enqueued for later delivery matches
+        # the given number.
+        #
+        #   def test_emails
+        #     must_have_enqueued_emails 0
+        #     ContactMailer.welcome.deliver_later
+        #     must_have_enqueued_emails 1
+        #     ContactMailer.welcome.deliver_later
+        #     must_have_enqueued_emails 2
+        #   end
+        #
+        # If a block is passed, that block should cause the specified number of
+        # emails to be enqueued.
+        #
+        #   def test_emails_again
+        #     must_have_enqueued_emails 1 do
+        #       ContactMailer.welcome.deliver_later
+        #     end
+        #
+        #     must_have_enqueued_emails 2 do
+        #       ContactMailer.welcome.deliver_later
+        #       ContactMailer.welcome.deliver_later
+        #     end
+        #   end
+        #
+        # See also ActionMailer::TestClass#assert_enqueued_emails
+        # See https://api.rubyonrails.org/v6.1/classes/ActionMailer/TestHelper.html#method-i-assert_enqueued_emails
+        #
+        # :method: must_have_enqueued_emails
+        # :call-seq: must_have_enqueued_emails(number, &block)
+
+        ##
+        # Asserts that a specific email has been enqueued, optionally
+        # matching arguments.
+        #
+        #   def test_email
+        #     ContactMailer.welcome.deliver_later
+        #     must_enqueue_email_with ContactMailer, :welcome
+        #   end
+        #
+        #   def test_email_with_arguments
+        #     ContactMailer.welcome("Hello", "Goodbye").deliver_later
+        #     must_enqueue_email_with ContactMailer, :welcome, args: ["Hello", "Goodbye"]
+        #   end
+        #
+        # If a block is passed, that block should cause the specified email
+        # to be enqueued.
+        #
+        #   def test_email_in_block
+        #     must_enqueue_email_with ContactMailer, :welcome do
+        #       ContactMailer.welcome.deliver_later
+        #     end
+        #   end
+        #
+        # If +args+ is provided as a Hash, a parameterized email is matched.
+        #
+        #   def test_parameterized_email
+        #     must_enqueue_email_with ContactMailer, :welcome,
+        #       args: {email: 'user@example.com'} do
+        #       ContactMailer.with(email: 'user@example.com').welcome.deliver_later
+        #     end
+        #   end
+        #
+        # See also ActionMailer::TestClass#assert_enqueued_email_with
+        # See https://api.rubyonrails.org/v6.1/classes/ActionMailer/TestHelper.html#method-i-assert_enqueued_email_with
+        #
+        # :method: must_enqueue_email_with
+        # :call-seq: must_enqueue_email_with(mailer, method, args: nil, queue: "mailers", &block)
+
+        ##
+        # Asserts that no emails are enqueued for later delivery.
+        #
+        #   def test_no_emails
+        #     wont_have_enqueued_emails
+        #     ContactMailer.welcome.deliver_later
+        #     wont_have_enqueued_emails 1
+        #   end
+        #
+        # If a block is provided, it should not cause any emails to be enqueued.
+        #
+        #   def test_no_emails
+        #     wont_have_enqueued_emails do
+        #       # No emails should be enqueued from this block
+        #     end
+        #   end
+        #
+        # See also ActionMailer::TestClass#assert_no_enqueued_emails
+        # See https://api.rubyonrails.org/v6.1/classes/ActionMailer/TestHelper.html#method-i-assert_no_enqueued_emails
+        #
+        # :method: wont_have_enqueued_emails
+        # :call-seq: wont_have_enqueued_emails(&block)
+
+        extend ::ActiveSupport::Concern
+
+        included do
+          alias_method :must_have_emails, :assert_emails
+          alias_method :wont_have_emails, :assert_no_emails
+          alias_method :must_have_enqueued_emails, :assert_enqueued_emails
+          alias_method :must_enqueue_email_with, :assert_enqueued_email_with
+          alias_method :wont_have_enqueued_emails, :assert_no_enqueued_emails
+        end
+      end
+    end
+  end
+end
+
+unless ENV["MT_NO_EXPECTATIONS"]
+  class ActionMailer::TestCase # :nodoc:
+    include Minitest::Rails::Expectations::ActionMailer
+  end
+end

data/lib/minitest/rails/expectations/active_job.rb

@@ -0,0 +1,182 @@
+require "active_support/concern"
+
+module Minitest
+  module Rails
+    module Expectations
+      # This exists as a module to allow easy mixing into classes
+      # other than ActiveJob::TestCase where you might want to do
+      # job testing e.g. in an Active Record model which triggers
+      # jobs in a callback.
+      module ActiveJob
+        ##
+        # Expects that the number of enqueued jobs matches the given number.
+        #
+        #   def test_jobs
+        #     must_enqueue_jobs 0
+        #     HelloJob.perform_later('david')
+        #     must_enqueue_jobs 1
+        #     HelloJob.perform_later('abdelkader')
+        #     must_enqueue_jobs 2
+        #   end
+        #
+        # If a block is passed, that block should cause the specified number of
+        # jobs to be enqueued.
+        #
+        #   def test_jobs_again
+        #     must_enqueue_jobs 1 do
+        #       HelloJob.perform_later('cristian')
+        #     end
+        #
+        #     must_enqueue_jobs 2 do
+        #       HelloJob.perform_later('aaron')
+        #       HelloJob.perform_later('rafael')
+        #     end
+        #   end
+        #
+        # See also ActiveJob::TestCase#assert_enqueued_jobs
+        #
+        # :method: must_enqueue_jobs
+        # :call-seq: must_enqueue_jobs(number)
+
+        ##
+        # Expects that no jobs have been enqueued.
+        #
+        #   def test_jobs
+        #     wont_enqueue_jobs
+        #     HelloJob.perform_later('jeremy')
+        #     must_enqueue_jobs 1
+        #   end
+        #
+        # If a block is passed, that block should not cause any job to be enqueued.
+        #
+        #   def test_jobs_again
+        #     wont_enqueue_jobs do
+        #       # No job should be enqueued from this block
+        #     end
+        #   end
+        #
+        # Note: This expectation is simply a shortcut for:
+        #
+        #   must_enqueue_jobs 0, &block
+        #
+        # See also ActiveJob::TestCase#refute_enqueued_jobs
+        #
+        # :method: wont_enqueue_jobs
+        # :call-seq: wont_enqueue_jobs(number)
+
+        ##
+        # Expects that the number of performed jobs matches the given number.
+        # If no block is passed, <tt>perform_enqueued_jobs</tt>d
+        # must be called around the job call.
+        #
+        #   def test_jobs
+        #     must_perform_jobs 0
+        #
+        #     perform_enqueued_jobs do
+        #       HelloJob.perform_later('xavier')
+        #     end
+        #     must_perform_jobs 1
+        #
+        #     perform_enqueued_jobs do
+        #       HelloJob.perform_later('yves')
+        #       must_perform_jobs 2
+        #     end
+        #   end
+        #
+        # If a block is passed, that block should cause the specified number of
+        # jobs to be performed.
+        #
+        #   def test_jobs_again
+        #     must_perform_jobs 1 do
+        #       HelloJob.perform_later('robin')
+        #     end
+        #
+        #     must_perform_jobs 2 do
+        #       HelloJob.perform_later('carlos')
+        #       HelloJob.perform_later('sean')
+        #     end
+        #   end
+        #
+        # See also ActiveJob::TestCase#assert_performed_jobs
+        #
+        # :method: must_perform_jobs
+        # :call-seq: must_perform_jobs(number)
+
+        ##
+        # Expects that no jobs have been performed.
+        #
+        #   def test_jobs
+        #     wont_perform_jobs
+        #
+        #     perform_enqueued_jobs do
+        #       HelloJob.perform_later('matthew')
+        #       must_perform_jobs 1
+        #     end
+        #   end
+        #
+        # If a block is passed, that block should not cause any job to be performed.
+        #
+        #   def test_jobs_again
+        #     wont_perform_jobs do
+        #       # No job should be performed from this block
+        #     end
+        #   end
+        #
+        # Note: This assertion is simply a shortcut for:
+        #
+        #   must_perform_jobs 0, &block
+        #
+        # See also ActiveJob::TestCase#refute_performed_jobs
+        #
+        # :method: wont_perform_jobs
+        # :call-seq: wont_perform_jobs(number)
+
+        ##
+        # Expects that the job passed in the block has been enqueued with the given arguments.
+        #
+        #   def test_must_enqueue_with
+        #     must_enqueue_with(job: MyJob, args: [1,2,3], queue: 'low') do
+        #       MyJob.perform_later(1,2,3)
+        #     end
+        #   end
+        #
+        # See also Minitest::Rails::Expectations#assert_enqueued_with
+        #
+        # :method: must_enqueue_with
+        # :call-seq: must_enqueue_with(args)
+
+        ##
+        # Expects that the job passed in the block has been performed with the given arguments.
+        #
+        #   def test_must_perform_with
+        #     must_perform_with(job: MyJob, args: [1,2,3], queue: 'high') do
+        #       MyJob.perform_later(1,2,3)
+        #     end
+        #   end
+        #
+        # See also Minitest::Rails::Expectations#assert_performed_with
+        #
+        # :method: must_perform_with
+        # :call-seq: must_perform_with(args)
+
+        extend ::ActiveSupport::Concern
+        include ::ActiveJob::TestHelper
+
+        included do
+          alias_method :must_enqueue_jobs, :assert_enqueued_jobs
+          alias_method :must_perform_jobs, :assert_performed_jobs
+          alias_method :wont_enqueue_jobs, :assert_no_enqueued_jobs
+          alias_method :wont_perform_jobs, :assert_no_performed_jobs
+          alias_method :must_enqueue_with, :assert_enqueued_with
+          alias_method :must_perform_with, :assert_performed_with
+        end
+      end
+    end
+  end
+end
+
+unless ENV["MT_NO_EXPECTATIONS"]
+  class ActiveJob::TestCase # :nodoc:
+    include Minitest::Rails::Expectations::ActiveJob
+  end
+end

data/lib/minitest/rails/expectations/active_support.rb

@@ -0,0 +1,73 @@
+module Minitest
+  module Rails
+    module Expectations
+      module ActiveSupport
+        ##
+        # Assertion that the result of evaluating an expression is changed before and
+        # after invoking the passed in block.
+        #
+        #     value { User.create password: "valid" }.must_change "User.count"
+        #     value { 3.times do
+        #               User.create password: "valid"
+        #             end }.must_change "User.count", from: 5, to: 8
+        #
+        # See also ActiveSupport::TestCase#assert_difference
+        # See https://api.rubyonrails.org/v6.1/classes/ActiveSupport/Testing/Assertions.html#method-i-assert_changes
+        #
+        # :method: must_change
+        # :args: expression, from: UNTRACKED, to: UNTRACKED
+        infect_an_assertion :assert_changes, :must_change, :block
+
+        ##
+        # Assertion that the result of evaluating an expression is not changed before
+        # and after invoking the passed in block.
+        #
+        #   refute_changes "Status.all_good?" do
+        #     post :create, params: { status: { ok: true } }
+        #   end
+        #
+        # See also ActiveSupport::TestCase#assert_difference
+        # See https://api.rubyonrails.org/v6.1/classes/ActiveSupport/Testing/Assertions.html#method-i-assert_no_changes
+        #
+        # :method: wont_change
+        # :args: expression
+        infect_an_assertion :refute_changes, :wont_change, :block
+
+        ##
+        # Test numeric difference between the return value of an expression as a
+        # result of what is evaluated.
+        #
+        #     value { User.create password: "valid" }.must_differ "User.count"
+        #     value { 3.times do
+        #               User.create password: "valid"
+        #             end }.must_differ "User.count", 3
+        #
+        # See also ActiveSupport::TestCase#assert_difference
+        # See https://api.rubyonrails.org/v6.1/classes/ActiveSupport/Testing/Assertions.html#method-i-assert_difference
+        #
+        # :method: must_differ
+        # :args: expression, *args
+        infect_an_assertion :assert_difference, :must_differ, :block
+
+        ##
+        # Assertion that the numeric result of evaluating an expression is not changed
+        # before and after invoking.
+        #
+        #     value { User.new }.wont_differ "User.count"
+        #
+        # See also ActiveSupport::TestCase#refute_difference
+        # See https://api.rubyonrails.org/v6.1/classes/ActiveSupport/Testing/Assertions.html#method-i-assert_no_difference
+        #
+        # :method: wont_differ
+        # :args: expression
+        infect_an_assertion :refute_difference, :wont_differ, :block
+      end
+    end
+  end
+end
+
+unless ENV["MT_NO_EXPECTATIONS"]
+  class Object # :nodoc:
+    include Minitest::Rails::Expectations::ActiveSupport
+  end
+end

data/lib/minitest/rails/parallelize.rb

@@ -0,0 +1,41 @@
+require "pathname"
+require "rails"
+
+# :stopdoc:
+
+##
+# These changes are here to support the spec DSL when using Rails parallelize.
+# The issue is the spec DSL creates Class objects that are not assigned to
+# a Ruby constant. When those Class objects are passed through Drb they are
+# wrapped in a DrbObject and cannot be run. The solution is to assign each Class
+# object to a constant. Hopefully the constant name is consistent enough that
+# the constant can be passed across processes (or even machines).
+
+module Minitest
+  module Rails
+    ##
+    # This module is a placeholder for all the Test classes created using the
+    # spec DSL. Normally all classes are created but not assigned to a constant.
+    # This module is where constants will be created for these classes.
+    module SpecTests #:nodoc:
+    end
+  end
+end
+
+module Kernel #:nodoc:
+  alias describe_before_minitest_spec_constant_fix describe
+  private :describe_before_minitest_spec_constant_fix
+  def describe *args, &block
+    cls = describe_before_minitest_spec_constant_fix(*args, &block)
+    cls_const = "Test__#{cls.name.to_s.split(/\W/).reject(&:empty?).join('_'.freeze)}"
+    if block.source_location
+      source_path, line_num = block.source_location
+      source_path = Pathname.new(File.expand_path(source_path)).relative_path_from(Rails.root).to_s
+      source_path = source_path.split(/\W/).reject(&:empty?).join("_".freeze)
+      cls_const += "__#{source_path}__#{line_num}"
+    end
+    cls_const += "_1" while Minitest::Rails::SpecTests.const_defined? cls_const
+    Minitest::Rails::SpecTests.const_set cls_const, cls
+    cls
+  end
+end