minitest 1.3.0 → 6.0.6

data/lib/minitest/spec.rb

@@ -1,82 +1,324 @@
-#!/usr/bin/ruby -w
-
-require 'minitest/unit'
-
-class Module
-  def infect_with_assertions pos_prefix, neg_prefix, skip_re, map = {}
-    MiniTest::Assertions.public_instance_methods(false).each do |meth|
-      meth = meth.to_s
-
-      new_name = case meth
-                 when /^assert/ then
-                   meth.sub(/^assert/, pos_prefix.to_s)
-                 when /^refute/ then
-                   meth.sub(/^refute/, neg_prefix.to_s)
-                 end
-      next unless new_name
-      next if new_name =~ skip_re
-
-      regexp, replacement = map.find { |re, _| new_name =~ re }
-      new_name.sub! regexp, replacement if replacement
-
-      # warn "%-22p -> %p %p" % [meth, new_name, regexp]
-      self.class_eval <<-EOM
-        def #{new_name} *args, &block
-          return MiniTest::Spec.current.#{meth}(*args, &self)     if Proc === self
-          return MiniTest::Spec.current.#{meth}(args.first, self) if args.size == 1
-          return MiniTest::Spec.current.#{meth}(self, *args)
+require_relative "test"
+
+class Module # :nodoc:
+  def infect_an_assertion meth, new_name, dont_flip = false # :nodoc:
+    block = dont_flip == :block
+    dont_flip = false if block
+
+    # https://eregon.me/blog/2021/02/13/correct-delegation-in-ruby-2-27-3.html
+    # Drop this when we can drop ruby 2.6 (aka after rails 6.1 EOL, ~2024-06)
+    kw_extra = "ruby2_keywords %p" % [new_name] if respond_to? :ruby2_keywords, true
+
+    self.class_eval <<-EOM, __FILE__, __LINE__ + 1
+      def #{new_name} *args
+        raise "Calling ##{new_name} outside of test." unless ctx
+        case
+        when #{!!dont_flip} then
+          ctx.#{meth}(target, *args)
+        when #{block} && Proc === target then
+          ctx.#{meth}(*args, &target)
+        else
+          ctx.#{meth}(args.first, target, *args[1..-1])
         end
-      EOM
-    end
+      end
+      #{kw_extra}
+    EOM
   end
 end
 
-Object.infect_with_assertions(:must, :wont,
-                              /^(must|wont)$|wont_(throw)|
-                                 must_(block|not?_|nothing|raise$)/x,
-                              /(must_throw)s/                 => '\1',
-                              /(?!not)_same/                  => '_be_same_as',
-                              /_in_/                          => '_be_within_',
-                              /_operator/                     => '_be',
-                              /_includes/                     => '_include',
-                              /(must|wont)_(.*_of|nil|empty)/ => '\1_be_\2',
-                              /must_raises/                   => 'must_raise')
-
-class Object
-  alias :must_be_close_to :must_be_within_delta
-  alias :wont_be_close_to :wont_be_within_delta
+# :stopdoc:
+module Minitest # fucking hell rdoc...
+  Expectation = Struct.new :target, :ctx
 end
+# :startdoc:
+
+##
+# Kernel extensions for minitest
 
 module Kernel
-  def describe desc, &block
-    cls = Class.new(MiniTest::Spec)
-    Object.const_set desc.to_s.split(/\W+/).map { |s| s.capitalize }.join, cls
+  ##
+  # Describe a series of expectations for a given target +desc+.
+  #
+  # Defines a test class subclassing from either Minitest::Spec or
+  # from the surrounding describe's class. The surrounding class may
+  # subclass Minitest::Spec manually in order to easily share code:
+  #
+  #     class MySpec < Minitest::Spec
+  #       # ... shared code ...
+  #     end
+  #
+  #     class TestStuff < MySpec
+  #       it "does stuff" do
+  #         # shared code available here
+  #       end
+  #       describe "inner stuff" do
+  #         it "still does stuff" do
+  #           # ...and here
+  #         end
+  #       end
+  #     end
+  #
+  # For more information on getting started with writing specs, see:
+  #
+  # http://www.rubyinside.com/a-minitestspec-tutorial-elegant-spec-style-testing-that-comes-with-ruby-5354.html
+  #
+  # For some suggestions on how to improve your specs, try:
+  #
+  # https://betterspecs.org
+  #
+  # but do note that several items there are debatable or specific to
+  # rspec.
+  #
+  # For more information about expectations, see Minitest::Expectations.
 
+  def describe desc, *additional_desc, &block # :doc:
+    stack = Minitest::Spec.describe_stack
+    is_spec_class = Class === self && kind_of?(Minitest::Spec::DSL)
+    name  = [stack.last, desc, *additional_desc]
+    name.prepend self if stack.empty? && is_spec_class
+    sclas =
+      stack.last                 \
+      || (is_spec_class && self) \
+      || Minitest::Spec.spec_type(desc, *additional_desc)
+
+    cls = sclas.create name.compact.join("::"), desc
+
+    stack.push cls
     cls.class_eval(&block)
+    stack.pop
+    cls
   end
+  private :describe
 end
 
-class MiniTest::Spec < MiniTest::Unit::TestCase
-  def self.current
-    @@current_spec
-  end
+##
+# Minitest::Spec -- The faster, better, less-magical spec framework!
+#
+# For a list of expectations, see Minitest::Expectations.
 
-  def initialize name
-    super
-    @@current_spec = self
-  end
+class Minitest::Spec < Minitest::Test
 
-  def self.before(type = :each, &block)
-    raise "unsupported before type: #{type}" unless type == :each
-    define_method :setup, &block
-  end
+  ##
+  # Oh look! A Minitest::Spec::DSL module! Eat your heart out DHH.
 
-  def self.after(type = :each, &block)
-    raise "unsupported after type: #{type}" unless type == :each
-    define_method :teardown, &block
-  end
+  module DSL
+    ##
+    # Contains pairs of matchers and Spec classes to be used to
+    # calculate the superclass of a top-level describe. This allows for
+    # automatically customizable spec types.
+    #
+    # See: register_spec_type and spec_type
+
+    TYPES = [[//, Minitest::Spec]]
+
+    ##
+    # Register a new type of spec that matches the spec's description.
+    # This method can take either a Regexp and a spec class or a spec
+    # class and a block that takes the description and returns true if
+    # it matches.
+    #
+    # Eg:
+    #
+    #     register_spec_type(/Controller$/, Minitest::Spec::Rails)
+    #
+    # or:
+    #
+    #     register_spec_type(Minitest::Spec::RailsModel) do |desc|
+    #       desc.superclass == ActiveRecord::Base
+    #     end
+
+    def register_spec_type *args, &block
+      if block then
+        matcher, klass = block, args.first
+      else
+        matcher, klass = *args
+      end
+      TYPES.unshift [matcher, klass]
+    end
+
+    ##
+    # Figure out the spec class to use based on a spec's description. Eg:
+    #
+    #     spec_type("BlahController") # => Minitest::Spec::Rails
+
+    def spec_type desc, *additional
+      TYPES.find { |matcher, _klass|
+        if matcher.respond_to? :call then
+          matcher.call desc, *additional
+        else
+          matcher === desc.to_s
+        end
+      }.last
+    end
+
+    def describe_stack # :nodoc:
+      Thread.current[:describe_stack] ||= []
+    end
+
+    def children # :nodoc:
+      @children ||= []
+    end
+
+    def nuke_test_methods! # :nodoc:
+      self.public_instance_methods.grep(/^test_/).each do |name|
+        self.send :undef_method, name
+      end
+    end
+
+    ##
+    # Define a 'before' action. Inherits the way normal methods should.
+    #
+    # NOTE: +type+ is ignored and is only there to make porting easier.
+    #
+    # Equivalent to Minitest::Test#setup.
+
+    def before _type = nil, &block
+      define_method :setup do
+        super()
+        self.instance_eval(&block)
+      end
+    end
+
+    ##
+    # Define an 'after' action. Inherits the way normal methods should.
+    #
+    # NOTE: +type+ is ignored and is only there to make porting easier.
+    #
+    # Equivalent to Minitest::Test#teardown.
+
+    def after _type = nil, &block
+      define_method :teardown do
+        self.instance_eval(&block)
+        super()
+      end
+    end
+
+    ##
+    # Define an expectation with name +desc+. Name gets morphed to a
+    # proper test method name. For some freakish reason, people who
+    # write specs don't like class inheritance, so this goes way out of
+    # its way to make sure that expectations aren't inherited.
+    #
+    # This is also aliased to #specify and doesn't require a +desc+ arg.
+    #
+    # Hint: If you _do_ want inheritance, use minitest/test. You can mix
+    # and match between assertions and expectations as much as you want.
+
+    def it desc = "anonymous", &block
+      block ||= proc { skip "(no tests defined)" }
+
+      @specs ||= 0
+      @specs += 1
 
-  def self.it desc, &block
-    define_method "test_#{desc.gsub(/\W+/, '_').downcase}", &block
+      name = "test_%04d_%s" % [ @specs, desc ]
+
+      undef_klasses = self.children.reject { |c| c.public_method_defined? name }
+
+      define_method name, &block
+
+      undef_klasses.each do |undef_klass|
+        undef_klass.send :undef_method, name
+      end
+
+      name
+    end
+
+    ##
+    # Essentially, define an accessor for +name+ with +block+.
+    #
+    # Why use let instead of def? I honestly don't know.
+
+    def let name, &block
+      name = name.to_s
+      pre, post = "let '#{name}' cannot ", ". Please use another name."
+      methods = Minitest::Spec.instance_methods.map(&:to_s) - %w[subject]
+      raise ArgumentError, "#{pre}begin with 'test'#{post}" if
+        name.start_with? "test"
+      raise ArgumentError, "#{pre}override a method in Minitest::Spec#{post}" if
+        methods.include? name
+
+      define_method name do
+        @_memoized ||= {}
+        @_memoized.fetch(name) { |k| @_memoized[k] = instance_eval(&block) }
+      end
+    end
+
+    ##
+    # Another lazy man's accessor generator. Made even more lazy by
+    # setting the name for you to +subject+.
+
+    def subject &block
+      let :subject, &block
+    end
+
+    def create name, desc # :nodoc:
+      cls = Class.new self do
+        @name = name
+        @desc = desc
+
+        nuke_test_methods!
+      end
+
+      children << cls
+
+      cls
+    end
+
+    def name # :nodoc:
+      defined?(@name) ? @name : super
+    end
+
+    alias to_s name
+    alias inspect name
+
+    attr_reader :desc # :nodoc:
+    alias specify it
+
+    ##
+    # Rdoc... why are you so dumb?
+
+    module InstanceMethods
+      ##
+      # Takes a value or a block and returns a value monad that has
+      # all of Expectations methods available to it.
+      #
+      #   _(1 + 1).must_equal 2
+      #
+      # And for blocks:
+      #
+      #   _ { 1 + "1" }.must_raise TypeError
+      #
+      # This method of expectation-based testing is preferable to
+      # straight-expectation methods (on Object) because it stores its
+      # test context, bypassing our hacky use of thread-local variables.
+      #
+      # It is also aliased to #value and #expect for your aesthetic
+      # pleasure:
+      #
+      #         _(1 + 1).must_equal 2
+      #     value(1 + 1).must_equal 2
+      #    expect(1 + 1).must_equal 2
+
+      def _ value = nil, &block
+        Minitest::Expectation.new block || value, self
+      end
+
+      alias value _
+      alias expect _
+    end
+
+    def self.extended obj # :nodoc:
+      obj.send :include, InstanceMethods
+    end
   end
+
+  extend DSL
+
+  TYPES = DSL::TYPES # :nodoc:
+end
+
+require_relative "expectations"
+
+class Minitest::Expectation
+  include Minitest::Expectations
 end

data/lib/minitest/sprint.rb

@@ -0,0 +1,105 @@
+$LOAD_PATH.unshift "test", "lib"
+
+require "simplecov" if ENV["MT_COV"] || ARGV.delete("--simplecov")
+require_relative "autorun"
+require_relative "path_expander"
+
+module Minitest
+
+  ##
+  # Runs (Get it? It's fast!) your tests and makes it easier to rerun
+  # individual failures.
+
+  class Sprint
+    # extracted version = "1.5.0"
+
+    ##
+    # Process and run minitest cmdline.
+
+    def self.run args = ARGV
+      if args.delete("--bisect") or args.delete("-b") then
+        require_relative "bisect"
+
+        return Minitest::Bisect.run ARGV
+      end
+
+      Minitest::PathExpander.new(args).process { |f|
+        require "./#{f}" if File.file? f
+      }
+    end
+
+    ##
+    # An extra minitest reporter to output how to rerun failures in
+    # various styles.
+
+    class SprintReporter < AbstractReporter
+      ##
+      # The style to report, either lines or regexp. Defaults to lines.
+      attr_accessor :style
+      attr_accessor :results # :nodoc:
+
+      def initialize style = :regexp # :nodoc:
+        self.results = []
+        self.style = style
+      end
+
+      def record result # :nodoc:
+        results << result unless result.passed? or result.skipped?
+      end
+
+      def report # :nodoc:
+        return if results.empty?
+
+        puts
+        puts "Happy Happy Sprint List:"
+        puts
+        print_list
+        puts
+      end
+
+      def print_list # :nodoc:
+        case style
+        when :regexp
+          results.each do |result|
+            puts "  minitest -n #{result.class_name}##{result.name}"
+          end
+        when :lines
+          files = Hash.new { |h,k| h[k] = [] }
+          results.each do |result|
+            path, line = result.source_location
+            path = path.delete_prefix "#{Dir.pwd}/"
+            files[path] << line
+          end
+
+          files.sort.each do |path, lines|
+            puts "  minitest %s:%s" % [path, lines.sort.join(",")]
+          end
+        else
+          raise "unsupported style: %p" % [style]
+        end
+      end
+    end
+
+    ##
+    # An extra minitest reporter to output how to rerun failures using
+    # rake.
+
+    class RakeReporter < SprintReporter
+      ##
+      # The name of the rake task to rerun. Defaults to nil.
+
+      attr_accessor :name
+
+      def initialize name = nil # :nodoc:
+        super()
+        self.name    = name
+      end
+
+      def print_list # :nodoc:
+        results.each do |result|
+          puts ["  rake", name, "N=#{result.class_name}##{result.name}"].compact.join(" ")
+        end
+      end
+    end
+  end
+end

data/lib/minitest/sprint_plugin.rb

@@ -0,0 +1,39 @@
+require_relative "../minitest"
+
+# :stopdoc:
+class OptionParser # unofficial embedded gem "makeoptparseworkwell"
+  def hidden(...)         = define(...).tap { |sw| def sw.summarize(*) = nil }
+  def deprecate(from, to) = hidden(from) { abort "#{from} is deprecated. Use #{to}." }
+  def topdict(name)       = name.length > 1 ? top.long : top.short
+  def alias(from, to)     = (dict = topdict(from) and dict[to] = dict[from])
+end unless OptionParser.method_defined? :hidden
+# :startdoc:
+
+module Minitest # :nodoc:
+  def self.plugin_sprint_options opts, options # :nodoc:
+    opts.on "--rake [TASK]", "Report how to re-run failures with rake." do |task|
+      options[:sprint] = :rake
+      options[:rake_task] = task
+    end
+
+    opts.deprecate "--binstub", "--rerun"
+
+    sprint_styles = %w[rake lines names binstub]
+
+    opts.on "-r", "--rerun [STYLE]", sprint_styles, "Report how to re-run failures using STYLE (names, lines)." do |style|
+      options[:sprint] = (style || :lines).to_sym
+    end
+  end
+
+  def self.plugin_sprint_init options
+    require_relative "sprint"
+    case options[:sprint]
+    when :rake then
+      self.reporter << Minitest::Sprint::RakeReporter.new(options[:rake_task])
+    when :binstub, :names then
+      self.reporter << Minitest::Sprint::SprintReporter.new
+    when :lines then
+      self.reporter << Minitest::Sprint::SprintReporter.new(:lines)
+    end
+  end
+end