m 1.6.1 → 1.7.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: e82a11a5dd9af1f6023bb8150265770adee0b322f21878d88cad02fdd0b99430
-  data.tar.gz: 5734c191624c0b77e27b3c935e4388168fc5d6fbb673182447b69530d3b9d347
+  metadata.gz: 4e5825f9f89739032571e003824817f6ee777b2ce56f32b6404956b6d6a29d93
+  data.tar.gz: c54e2cc45a805c2b4ed8e3a7fa7104aafea8d81b0492fd40505a850247a36a64
 SHA512:
-  metadata.gz: 6a7e89d0ff0ae83bc62d5b8de773fb3120fcd8b0db996ba8795ee11f7016ad34d722544f513fd06fda35c0cd2db2f27f16dc45241e9a839190466bb8d8be6ddf
-  data.tar.gz: dd72cc68f9f91173b455818ad1c503b868158fedbae55c1684246223c209c87f0299513af6ed9a26381a19ef30bc73ca58333a357de2ca2a1f7202d92d48ede2
+  metadata.gz: 2b612e6a37f7c14b6247ffa753ba89bc790cc4c3ea51b569e96fbe04d10fc91e4df4ef29f5ff7526a2aece12706ee8d0fbd8b6fd80d65a3fb5c072038d368c57
+  data.tar.gz: 800ddcf684b4a736c697f439986cdd3979d2ef80f9c037e4fdfcca1ad263eb518de7809a8bc76a312623358cdbd47a8c1b7b77a939deaba472681a659cf8205a

data/.github/workflows/ruby-ci.yml

@@ -10,27 +10,32 @@ on:
 
 jobs:
   test:
-    runs-on: ubuntu-latest
     strategy:
+      fail-fast: false
       matrix:
-        appraisal:
-          - minitest4
-          - minitest5
-          - test_unit_gem
+        os:
+          - ubuntu-latest
         ruby:
-          - ruby-2.6
           - ruby-2.7
           - ruby-3.0
+          - ruby-3.1
+          - ruby-3.2
+          - ruby-3.3
+          - ruby-3.4
+          - ruby-4.0
+          - jruby
           - truffleruby
-    env:
-      BUNDLE_GEMFILE: ${{ github.workspace }}/gemfiles/${{ matrix.appraisal }}.gemfile
+        include:
+          - { os: macos-latest, ruby: ruby-2.7 }
+          - { os: macos-latest, ruby: ruby-4.0 }
+    runs-on: ${{ matrix.os }}
     steps:
       - name: Checkout
-        uses: actions/checkout@v2
+        uses: actions/checkout@v6
       - name: Install
         uses: ruby/setup-ruby@v1
         with:
           ruby-version: ${{ matrix.ruby }}
           bundler-cache: true
       - name: Test
-        run: bundle exec rake
+        run: bundle exec rake test

data/.gitignore

@@ -3,6 +3,7 @@
 .bundle
 .config
 .yardoc
+gemfiles/*.gemfile.lock
 Gemfile.lock
 InstalledFiles
 _yardoc

data/.standard.yml

@@ -0,0 +1 @@
+ruby_version: 2.7

data/Gemfile

@@ -1,10 +1,10 @@
-source 'https://rubygems.org'
+source "https://rubygems.org"
 
-gem 'coveralls', require: false
-gem 'benchmark-ips'
+gem "benchmark-ips"
+gem "coveralls", require: false
+gem "minitest", ">= 5"
+gem "test-unit"
 
-if RUBY_VERSION !~ /^2.0/ && !defined?(JRUBY_VERSION)
-  gem 'allocation_stats'
-end
+gem "allocation_stats" unless defined?(JRUBY_VERSION)
 
 gemspec

data/README.md

@@ -1,8 +1,4 @@
 M.RB
-
-[![Gem Version](https://badge.fury.io/rb/m.svg)](https://rubygems.org/gems/m) [![Code Climate](https://codeclimate.com/github/qrush/m.svg)](https://codeclimate.com/github/qrush/m) [![Build Status](https://travis-ci.org/qrush/m.svg?branch=master)](https://travis-ci.org/qrush/m) [![Coverage Status](https://coveralls.io/repos/qrush/m/badge.svg?branch=master)](https://coveralls.io/r/qrush/m)
-
-
 ----
 
 `m` stands for metal, a better test/unit and minitest test runner that can run tests by line number.
@@ -20,23 +16,10 @@ If you’re using Bundler, you’ll need to include it in your Gemfile. Toss it
 
 ``` ruby
 group :test do
-  gem 'm', '~> 1.5.0'
+  gem "m"
 end
 ```
 
-Developing a RubyGem? Add m as a development dependency.
-
-
-``` ruby
-Gem::Specification.new do |gem|
-  # ...
-  gem.add_development_dependency "m", "~> 1.5.0"
-end
-```
-
-m works on Ruby 2.0+ only and support is only provided for [versions currently maintained by the community](https://www.ruby-lang.org/en/downloads/branches/).
-
-
 USAGE
 =====
 
@@ -129,38 +112,19 @@ SUPPORT
 
 `m` works with a few Ruby test frameworks:
 
+  - Minitest::Test
+  - Minitest::Spec
   - Test::Unit
   - ActiveSupport::TestCase
-  - MiniTest::Unit::TestCase
-  - Minitest
-
 
 CONTRIBUTING
 ============
 
-## Setup
-
-This project uses [Appraisal](https://github.com/thoughtbot/appraisal) to test against different versions of dependencies.
-
-To install all scenarios (appraisals):
-
-    bundle install
-    bundle exec appraisal install
-
 ## Testing
 
 You can run all the tests with:
 
-    bundle exec rake tests
-
-You can also run tests selectively. For minitest 4 run:
-
-    appraisal minitest4 rake test
-
-and the ones for minitest 5 with:
-
-    appraisal minitest5 rake test
-
+    bundle exec rake test
 
 LICENSE
 =======

data/Rakefile

@@ -1,96 +1,22 @@
 #!/usr/bin/env rake
-require 'rubygems'
-require 'bundler/setup'
-require 'appraisal'
-require 'coveralls'
-require 'bundler/gem_tasks'
-require 'rake/clean'
-require 'rake/testtask'
+require "rubygems"
+require "bundler/setup"
+require "coveralls"
+require "bundler/gem_tasks"
+require "rake/clean"
+require "rake/testtask"
+require "standard/rake"
+require "rbconfig"
 
-task :default => [:test]
+task default: [:test, "standard:fix"]
 
 Rake::TestTask.new do |t|
-  t.libs << 'test'
-  t.libs << 'lib'
-  t.pattern = 'test/*_test.rb'
+  t.pattern = "test/*_test.rb"
 end
 
-desc 'Run all tests and get merged test coverage'
-task :tests do
-  system "rake test" or exit!(1)
-  system "appraisal minitest4 rake test" or exit!(1)
-  system "appraisal minitest5 rake test TEST=test/minitest_5_test.rb" or exit!(1)
-  system "appraisal test_unit_gem rake test TEST=test/test_unit_test.rb" or exit!(1)
-  Coveralls.push!
-end
-
-desc 'Run simple benchmarks'
+desc "Run simple benchmarks"
 task :bench do
   current_commit = `git rev-parse HEAD`
-  file_name = "benchmarks/#{Time.now.strftime('%Y%m%d')}-benchmark.log"
-  exec "echo -e 'Data for commit: #{current_commit}' > #{file_name} && ruby test/bench.rb >> #{file_name}"
-end
-
-# ROCCO ===============================================================
-
-begin
-  require 'rdiscount'
-rescue LoadError => e
-  warn e.inspect
-end
-begin
-  require 'rocco/tasks'
-  Rocco::make 'docs/'
-rescue LoadError => e
-  warn e.inspect
-end
-
-desc 'Build rocco docs'
-task :docs => :rocco
-directory 'docs/'
-
-desc 'Build docs and open in browser for the reading'
-task :read => :docs do
-  sh 'open docs/lib/m.html'
-end
-
-# Make index.html a copy of rocco.html
-file 'docs/index.html' => 'docs/lib/m.html' do |f|
-  cp 'docs/lib/m.html', 'docs/index.html', :preserve => true
-end
-
-task :docs => 'docs/index.html'
-CLEAN.include 'docs/index.html'
-
-# Alias for docs task
-task :doc => :docs
-
-# GITHUB PAGES ===============================================================
-
-desc "really kill docs folder"
-task :clean_docs do
-  sh "rm -rf docs/"
-end
-
-desc 'Update gh-pages branch'
-task :pages => [:clean_docs, 'docs/.git', :docs] do
-  rev = `git rev-parse --short HEAD`.strip
-  Dir.chdir 'docs' do
-    sh "mv lib/m m"
-    sh "mv lib/m.html m.html"
-    sh "git add -A"
-    sh "git commit -m 'rebuild pages from #{rev}'" do |ok,res|
-      if ok
-        verbose { puts "gh-pages updated" }
-        sh "git push -q o HEAD:gh-pages"
-      end
-    end
-  end
-end
-
-# Update the pages/ directory clone
-file 'docs/.git' => ['docs/'] do |f|
-  sh "cd docs && git init -q && git remote add o ../.git" if !File.exist?(f.name)
-  sh "cd docs && git fetch -q o && git reset -q --hard o/gh-pages && git rm -r . && git commit -m 'blank out' && touch ."
+  file_name = "benchmarks/#{Time.now.strftime "%Y%m%d"}-benchmark.log"
+  exec "echo -e 'Data for commit: #{current_commit}' > #{file_name} && #{RbConfig.ruby} test/bench.rb >> #{file_name}"
 end
-CLOBBER.include 'docs/.git'

data/bin/m

@@ -1,4 +1,4 @@
 #!/usr/bin/env ruby
 
-require 'm'
-M.run(ARGV)
+require "m"
+M.run ARGV

data/lib/error_tests/error_test.rb

@@ -1,4 +1,4 @@
-require_relative "../../test/test_helper.rb"
+require_relative "../../test/test_helper"
 
 class ErrorTest < MTest
   def test_purposeful_error

data/lib/m/executor.rb

@@ -1,46 +1,47 @@
-require_relative 'runners/base'
-require_relative 'runners/minitest_5'
-require_relative 'runners/minitest_4'
-require_relative 'runners/test_unit'
-require_relative 'runners/unsupported_framework'
+require_relative "runners/base"
+require_relative "runners/minitest_6"
+require_relative "runners/minitest_5"
+require_relative "runners/minitest_4"
+require_relative "runners/test_unit"
+require_relative "runners/unsupported_framework"
 
 module M
   class Executor
-    def initialize(testable)
+    def initialize testable
       @testable = testable
     end
 
     def execute
       # Locate tests to run that may be inside of this line. There could be more than one!
-      tests_to_run = tests.within(testable.lines)
+      tests_to_run = tests.within testable.lines
 
       # If we found any tests,
-      if tests_to_run.size > 0
+      if tests_to_run.size.positive?
         # assemble the regexp to run these tests,
-        test_names = tests_to_run.map { |test| Regexp.escape(test.name) }.join('|')
+        test_names = tests_to_run.map { |test| Regexp.escape(test.name) }.join("|")
 
         # set up the args needed for the runner
         test_arguments = ["-n", "/^(#{test_names})$/"]
 
         # directly run the tests from here and exit with the status of the tests passing or failing
-        runner.run(test_arguments + testable.passthrough_options)
-      elsif tests.size > 0
+        runner.run test_arguments + testable.passthrough_options
+      elsif tests.size.positive?
         # Otherwise we found no tests on this line, so you need to pick one.
-        message = "No tests found on line #{testable.lines.join(', ')}. Valid tests to run:\n\n"
+        message = "No tests found on line #{testable.lines.join ", "}. Valid tests to run:\n\n"
 
         # For every test ordered by line number,
         # spit out the test name and line number where it starts,
         tests.by_line_number do |test|
-          message << "#{sprintf("%0#{tests.column_size}s", test.name)}: m #{testable.file}:#{test.start_line}\n"
+          message << "#{format "%0#{tests.column_size}s", test.name}: m #{testable.file}:#{test.start_line}\n"
         end
 
         # Spit out helpful message and bail
-        STDERR.puts message
+        warn message
         false
       else
         # There were no tests at all
         message = "There were no tests found.\n\n"
-        STDERR.puts message
+        warn message
         false
       end
     end
@@ -58,27 +59,27 @@ module M
         # With each suite and array of tests,
         # and with each test method present in this test file,
         # shove a new test method into this collection.
-        suites.inject(TestCollection.new) do |collection, (suite_class, test_methods)|
+        suites.each_with_object TestCollection.new do |(suite_class, test_methods), collection|
           test_methods.each do |test_method|
             collection << TestMethod.create(suite_class, test_method)
           end
-        collection
         end
       end
     end
 
-
     # Finds all test suites in this test file, with test methods included.
     def suites
       # Since we're not using `ruby -Itest -Ilib` to run the tests, we need to add this directory to the `LOAD_PATH`
-      $:.unshift "./test", "./spec", "./lib"
+      $LOAD_PATH.unshift "./test", "./spec", "./lib"
 
       begin
         # Fire up this Ruby file. Let's hope it actually has tests.
-        require "./#{testable.file}"
+        file = testable.file
+        file = "./#{testable.file}" unless file.start_with? "/"
+        require file
       rescue LoadError => e
         # Fail with a happier error message instead of spitting out a backtrace from this gem
-        STDERR.puts "Failed loading test file:\n#{e.message}"
+        warn "Failed loading test file:\n#{e.message}"
         return []
       end
 
@@ -87,9 +88,7 @@ module M
       # Use some janky internal APIs to group test methods by test suite.
       suites.each_with_object({}) do |suite_class, test_suites|
         # End up with a hash of suite class name to an array of test methods, so we can later find them and ignore empty test suites
-        if runner.test_methods(suite_class).any?
-          test_suites[suite_class] = runner.test_methods(suite_class)
-        end
+        test_suites[suite_class] = runner.test_methods(suite_class) if runner.test_methods(suite_class).any?
       end
     end
 

data/lib/m/finish_line.rb

@@ -0,0 +1,83 @@
+require "ripper"
+
+module M
+  # Stripped down parser that can determine the ending line for a method.
+  class FinishLine < Ripper
+    # Brazenly stolen from Rails::TestUnit::TestParser by Carl Brasic @brasic
+
+    # Helper to translate a method object into the path and line range where
+    # the method was defined.
+    def self.ending_line_for(method_obj)
+      path, begin_line = method_obj.source_location
+      new(File.read(path), path).parse[begin_line]
+    end
+
+    def initialize(*)
+      # A hash mapping the 1-indexed line numbers that tests start on to where they end.
+      @begins_to_ends = {}
+      super
+    end
+
+    def parse
+      super
+      @begins_to_ends
+    end
+
+    # method test e.g. `def test_some_description`
+    # This event's first argument gets the `ident` node containing the method
+    # name, which we have overridden to return the line number of the ident
+    # instead.
+    def on_def(begin_line, *)
+      @begins_to_ends[begin_line] = lineno
+    end
+
+    # Everything past this point is to support declarative tests, which
+    # require more work to get right because of the many different ways
+    # methods can be invoked in ruby, all of which are parsed differently.
+    #
+    # The approach is just to store the current line number when the
+    # "test" method is called and pass it up the tree so it's available at
+    # the point when we also know the line where the associated block ends.
+
+    def on_method_add_block(begin_line, end_line)
+      if begin_line && end_line
+        @begins_to_ends[begin_line] = end_line
+      end
+    end
+
+    def on_command_call(*, begin_lineno, _args)
+      begin_lineno
+    end
+
+    def first_arg(arg, *)
+      arg
+    end
+
+    def just_lineno(*)
+      lineno
+    end
+
+    alias_method :on_method_add_arg, :first_arg
+    alias_method :on_command, :first_arg
+    alias_method :on_stmts_add, :first_arg
+    alias_method :on_arg_paren, :first_arg
+    alias_method :on_bodystmt, :first_arg
+
+    alias_method :on_ident, :just_lineno
+    alias_method :on_do_block, :just_lineno
+    alias_method :on_stmts_new, :just_lineno
+    alias_method :on_brace_block, :just_lineno
+
+    def on_args_new
+      []
+    end
+
+    def on_args_add(parts, part)
+      parts << part
+    end
+
+    def on_args_add_block(args, *rest)
+      args.first
+    end
+  end
+end

data/lib/m/frameworks.rb

@@ -1,14 +1,34 @@
 module M
   class Frameworks
+    def self.minitest_version_major
+      if defined?(Minitest::Unit::VERSION)
+        Minitest::Unit::VERSION.slice(/\d+/)
+      elsif defined?(Minitest::VERSION)
+        Minitest::VERSION.slice(/\d+/)
+      end
+    end
+
+    def self.minitest6?
+      minitest_version_major == "6"
+    end
+
+    def self.minitest5?
+      minitest_version_major == "5"
+    end
+
+    def self.test_unit?
+      defined?(Test::Unit)
+    end
+
     def self.framework_runner
       new.framework_runner
     end
 
     def framework_runner
-      if minitest5?
+      if minitest6?
+        Runners::Minitest6.new
+      elsif minitest5?
         Runners::Minitest5.new
-      elsif minitest4?
-        Runners::Minitest4.new
       elsif test_unit?
         Runners::TestUnit.new
       else
@@ -18,32 +38,16 @@ module M
 
     private
 
-    def minitest5?
-      self.class.minitest5?
+    def minitest6?
+      self.class.minitest6?
     end
 
-    def minitest4?
-      self.class.minitest4?
+    def minitest5?
+      self.class.minitest5?
     end
 
     def test_unit?
       self.class.test_unit?
     end
-
-    def self.minitest_version_major
-      defined?(Minitest) ? Minitest::Unit::VERSION.slice(/\d+/) : nil
-    end
-
-    def self.minitest5?
-      minitest_version_major == "5"
-    end
-
-    def self.minitest4?
-      minitest_version_major == "4"
-    end
-
-    def self.test_unit?
-      defined?(Test::Unit)
-    end
   end
 end

data/lib/m/parser.rb

@@ -1,8 +1,9 @@
-require_relative 'testable'
+require_relative "testable"
+require "rbconfig"
 
 module M
   class Parser
-    def initialize(argv)
+    def initialize argv
       @argv = argv
       @testable = Testable.new
     end
@@ -11,16 +12,16 @@ module M
       # With no arguments,
       if argv.empty?
         # Just shell out to `rake test`.
-        exec "rake test"
+        exec "#{RbConfig.ruby} -S rake test"
       else
         parse_options! argv
 
-        if argv.first.start_with?("--")
-          exec "rake test #{argv.join}"
+        if argv.first.start_with? "--"
+          exec "#{RbConfig.ruby} -S rake test #{argv.join}"
           exit 0
         else
           # Parse out ARGV, it should be coming in in a format like `test/test_file.rb:9:19`
-          parsed = argv.shift.split(':')
+          parsed = argv.shift.split ":"
           testable.file = parsed.shift
           testable.lines = parsed if testable.lines.none?
           # Anything else on ARGV will be passed along to the runner
@@ -28,26 +29,25 @@ module M
         end
 
         # If this file is a directory, not a file, run the tests inside of this directory
-        if Dir.exist?(testable.file)
-          # Make a new rake test task with a hopefully unique name, and run every test looking file in it
-          require "rake/testtask"
-          Rake::TestTask.new(:m_custom) do |t|
-            t.libs << 'test'
-            t.libs << 'spec'
-            t.test_files = FileList[wildcard("test"), wildcard("spec")]
-            t.warning = false
-          end
-          # Invoke the rake task and exit, hopefully it'll work!
-          begin
-            Rake::Task['m_custom'].invoke
-          rescue RuntimeError
-            exit(1)
-          ensure
-            exit($?.exitstatus)
-          end
-        else
-          return testable
+        return testable unless Dir.exist? testable.file
+
+        # Make a new rake test task with a hopefully unique name, and run every test looking file in it
+        require "rake/testtask"
+        Rake::TestTask.new :m_custom do |t|
+          t.libs << "test"
+          t.libs << "spec"
+          t.test_files = FileList[wildcard("test"), wildcard("spec")]
+          t.warning = false
         end
+        # Invoke the rake task and exit, hopefully it'll work!
+        begin
+          Rake::Task["m_custom"].invoke
+        rescue RuntimeError
+          exit 1
+        ensure
+          exit $?.exitstatus
+        end
+
       end
     end
 
@@ -55,29 +55,29 @@ module M
 
     attr_reader :argv, :testable
 
-    def parse_options!(argv)
-      require 'optparse'
+    def parse_options! argv
+      require "optparse"
 
       OptionParser.new do |opts|
-        opts.banner  = 'Options:'
+        opts.banner = "Options:"
         opts.version = M::VERSION
 
-        opts.on '-h', '--help', 'Display this help.' do
+        opts.on "-h", "--help", "Display this help." do
           puts "Usage: m [OPTIONS] [FILES]\n\n", opts
           exit
         end
 
-        opts.on '--version', 'Display the version.' do
+        opts.on "--version", "Display the version." do
           puts "m #{M::VERSION}"
           exit
         end
 
-        opts.on '-l', '--line LINE', Integer, 'Line number for file.' do |line|
+        opts.on "-l", "--line LINE", Integer, "Line number for file." do |line|
           p "parsing line #{line}"
           testable.lines = [line]
         end
 
-        opts.on '-r', '--recursive DIR', 'Search provided directory recursively.' do |directory|
+        opts.on "-r", "--recursive DIR", "Search provided directory recursively." do |directory|
           testable.recursive = true
           argv << directory
         end
@@ -86,7 +86,7 @@ module M
       end
     end
 
-    def wildcard(type)
+    def wildcard type
       if testable.recursive
         "#{testable.file}/**/*#{type}*.rb"
       else