minitest-rg 5.1.0 → 5.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
-SHA1:
-  metadata.gz: 55dc3099933a62ddeaafc23ef6f47d6bbc73929c
-  data.tar.gz: a2acd49203e7899db66917820f13752c385ffc45
+SHA256:
+  metadata.gz: 51456eb04e86f229b8cd70613c2d933927d63f7b6336314dbc0b19f93a75bbe6
+  data.tar.gz: 356b290fe5e524c65e173db06988b73abf1679f6b03f8386be4add89f9b9e924
 SHA512:
-  metadata.gz: 3e8a32bb68564d205b71f8239ea9a3afbfbb58b95d9042e2aaba11573ffe00a449d70119cc44d3aa89e8ae29700b07f3c0c1661e352f9bd9ce819cd1b5f378ee
-  data.tar.gz: b8e61130f90247c3a94fb1388a3eceb2166a81294aef62e92fd98c5cb2b49e0d05a00fa3e3df0f34a9ee1e4885bcd2189b6e7e194d9b5c39ac7bb97a6f4c56c5
+  metadata.gz: 79060f30f6ce4609a91c52a5f049f5a04b0b361839f405dd50c564b667dfe57f088daa046658dd73cab483936faa08984b4516a03156c3adf85c643ec35b6069
+  data.tar.gz: 568de8ebd5a63fdd652ef493bebfd5fea298423bd9d072c504933248446159dac4fe05e96b28c6cb500a69cbeaa7789d1e244118caef95bbf27952aa2d1c1d27

data/.autotest

@@ -1,8 +1,8 @@
 # -*- ruby -*-
 
-require 'autotest/restart'
+require "autotest/restart"
 
 Autotest.add_hook :initialize do |at|
-  at.testlib          = 'minitest/autorun'
+  at.testlib          = "minitest/autorun"
   at.find_directories = ARGV unless ARGV.empty?
 end

data/.rubocop.yml

@@ -0,0 +1,29 @@
+AllCops:
+  NewCops: enable
+  SuggestExtensions: false
+  TargetRubyVersion: 2.7
+  Exclude:
+    - "doc/**/*"
+    - "pkg/**/*"
+    - "vendor/**/*"
+    - "minitest-rg.gemspec"
+    - "Rakefile"
+    - "Gemfile"
+
+
+Layout/SpaceAroundOperators:
+  Enabled: false
+Metrics/AbcSize:
+  Max: 25
+Metrics/CyclomaticComplexity:
+  Max: 10
+Metrics/MethodLength:
+  Max: 15
+Style/Documentation:
+  Enabled: false
+Metrics/PerceivedComplexity:
+  Max: 10
+Style/MethodDefParentheses:
+  EnforcedStyle: require_no_parentheses
+Style/StringLiterals:
+  EnforcedStyle: double_quotes

data/CHANGELOG.rdoc

@@ -1,3 +1,14 @@
+=== 5.3.0 / 2023-10-31
+
+Add +--no-rg+ flag. (grosser)
+
+Fix loading issue on newer Minitest versions. (zenspider/dazuma)
+
+=== 5.2.0 / 2015-08-14
+
+Only output red/green colors when TTY is supported. (cbougher)
+Add +--rg+ flag.
+
 === 5.1.0 / 2014-04-16
 
 Activate plugin only when required, and fix circular loading issue. (grosser)

data/Gemfile

@@ -1,4 +1,5 @@
-source "http://rubygems.org"
+# frozen_string_literal: true
 
-gem "minitest", "~> 5.0"
-gem "hoe",      "~> 3.11", :group => :development
+source "https://rubygems.org"
+
+gemspec

data/Manifest.txt

@@ -1,5 +1,6 @@
 .autotest
 .gemtest
+.rubocop.yml
 CHANGELOG.rdoc
 Gemfile
 LICENSE
@@ -9,4 +10,8 @@ Rakefile
 lib/minitest/rg.rb
 lib/minitest/rg_plugin.rb
 minitest-rg.gemspec
-test/test_minitest-rg.rb
+scripts/run_error
+scripts/run_fail
+scripts/run_pass
+scripts/run_skip
+test/test_rg.rb

data/README.rdoc

@@ -1,6 +1,12 @@
 = minitest-rg
 
-Adds color to your MiniTest output.
+home :: https://github.com/minitest/minitest-rg
+bugs :: https://github.com/minitest/minitest-rg/issues
+
+{rdoc-image:https://github.com/minitest/minitest-rg/actions/workflows/ci.yml/badge.svg}[https://github.com/minitest/minitest-rg/actions/workflows/ci.yml]
+{rdoc-image:https://github.com/minitest/minitest-rg/actions/workflows/github-code-scanning/codeql/badge.svg}[https://github.com/minitest/minitest-rg/actions/workflows/github-code-scanning/codeql]
+
+Adds red/green color to your Minitest output.
 
 == Install
 
@@ -10,15 +16,33 @@ Adds color to your MiniTest output.
 
 Add the following to your test helper:
 
-    require 'minitest/rg'
+    require "minitest/rg"
+
+Or you can run your tests with the `--rg` flag:
+
+    $ ruby test/test_the_thing.rb --rg
+
+Or if you are using a rake task to run your tests you can set the `--rg` flag in the `TESTOPTS` environment variable.
+
+    $ rake test TESTOPTS="--rg"
+
+== Get Involved
+
+Join the Github discussions to get help or offer suggestions:
+
+https://github.com/minitest/minitest-rg/discussions
+
+Report bugs by opening an issue:
+
+https://github.com/minitest/minitest-rg/issues
 
-== Contribute
+Contribute changes by creating a pull request:
 
-http://github.com/blowmage/minitest-rg
+https://github.com/minitest/minitest-rg/pulls
 
 == License
 
-Copyright (c) 2012 Mike Moore
+Copyright (c) 2023 Mike Moore
 
 Permission is hereby granted, free of charge, to any person obtaining
 a copy of this software and associated documentation files (the

data/Rakefile

@@ -1,25 +1,70 @@
+# frozen_string_literal: true
+
 # -*- ruby -*-
 
-require 'rubygems'
-require 'hoe'
+require "rubygems"
+require "hoe"
 
 Hoe.plugin :gemspec  # `gem install hoe-gemspec`
 Hoe.plugin :git      # `gem install hoe-git`
 Hoe.plugin :minitest # `gem install hoe-minitest`
-Hoe.plugins.delete :rubyforge
 
-Hoe.spec 'minitest-rg' do
-  developer 'Mike Moore', 'mike@blowmage.com'
+Hoe.spec "minitest-rg" do
+  developer "Mike Moore", "mike@blowmage.com"
 
-  self.summary     = 'RedGreen for MiniTest'
-  self.description = 'Adds color to your MiniTest output'
-  self.urls        = ['http://blowmage.com/minitest-rg']
-  self.license       "MIT"
+  self.summary     = "Red/Green for Minitest"
+  self.description = "Colored red/green output for Minitest"
+  license "MIT"
 
-  self.readme_file       = 'README.rdoc'
-  self.history_file      = 'CHANGELOG.rdoc'
+  self.readme_file       = "README.rdoc"
+  self.history_file      = "CHANGELOG.rdoc"
 
-  dependency 'minitest',  '~> 5.0'
+  dependency "minitest",  "~> 5.0"
+  dependency "rubocop",   "~> 1.57.0", :dev
 end
 
 # vim: syntax=ruby
+
+desc "Run all test type scripts"
+task :sanity do
+  puts "="*72
+  puts "Running a \e[32mpassing\e[0m test:"
+  puts "="*72
+  puts
+  puts capture_output("pass")
+  puts
+
+  puts "="*72
+  puts "Running a \e[31mfailing\e[0m test:"
+  puts "="*72
+  puts
+  puts capture_output("fail")
+  puts
+
+  puts "="*72
+  puts "Running a \e[33merroring\e[0m test:"
+  puts "="*72
+  puts
+  puts capture_output("error")
+  puts
+
+  puts "="*72
+  puts "Running a \e[36mskipped\e[0m test:"
+  puts "="*72
+  puts
+  puts capture_output("skip")
+  puts
+end
+
+def capture_output command
+  os = `uname -s`.chomp
+  if os.include?("BSD") || os.include?("Darwin")
+    `script -q /dev/null ./scripts/run_#{command}`
+  else
+    `script -q -c ./scripts/run_#{command} /dev/null`
+  end
+end
+
+require "rubocop/rake_task"
+
+RuboCop::RakeTask.new

data/lib/minitest/rg.rb

@@ -1,4 +1,6 @@
+# frozen_string_literal: true
+
 require "minitest"
 
 Minitest.load_plugins
-Minitest::RG.rg!
+Minitest::RG.rg! color: $stdout.tty?

data/lib/minitest/rg_plugin.rb

@@ -1,34 +1,36 @@
-require "minitest/test"
+# frozen_string_literal: true
 
-module MiniTest
+require "minitest"
 
-  def self.plugin_rg_options opts, options # :nodoc:
+module Minitest
+  def self.plugin_rg_options opts, _options # :nodoc:
+    opts.on "--[no-]rg", "Add red/green to test output." do |bool|
+      RG.rg! color: bool
+    end
   end
 
   def self.plugin_rg_init options # :nodoc:
-    if RG.rg?
-      io = RG.new options[:io]
+    return unless RG.rg?
 
-      self.reporter.reporters.grep(Minitest::Reporter).each do |rep|
-        rep.io = io
-      end
-    end
+    io = RG.new options[:io]
+
+    reporter.reporters.grep(Minitest::Reporter).each { |rep| rep.io = io }
   end
 
   class RG
-    VERSION = "5.1.0"
+    VERSION = "5.3.0"
 
     COLORS = {
-      '.' => "\e[32m.\e[0m",
-      'E' => "\e[33mE\e[0m",
-      'F' => "\e[31mF\e[0m",
-      'S' => "\e[36mS\e[0m",
-    }
+      "." => "\e[32m.\e[0m",
+      "E" => "\e[33mE\e[0m",
+      "F" => "\e[31mF\e[0m",
+      "S" => "\e[36mS\e[0m"
+    }.freeze
 
     attr_reader :io, :colors
 
-    def self.rg!
-      @rg = true
+    def self.rg! color: true
+      @rg = color
     end
 
     def self.rg?
@@ -40,26 +42,34 @@ module MiniTest
       @colors = colors
     end
 
-    def print o
-      io.print(colors[o] || o)
+    def print output
+      io.print(colors[output] || output)
     end
 
-    def puts o=nil
-      return io.puts if o.nil?
-      if o =~ /(\d+) failures, (\d+) errors/
-        if $1 != '0' || $2 != '0'
-          io.puts "\e[31m#{o}\e[0m"
+    def puts output = nil
+      return io.puts if output.nil?
+
+      if output =~ /(\d+) failures, (\d+) errors/
+        if Regexp.last_match[1] != "0" || Regexp.last_match[2] != "0"
+          io.puts "\e[31m#{output}\e[0m"
         else
-          io.puts "\e[32m#{o}\e[0m"
+          io.puts "\e[32m#{output}\e[0m"
         end
       else
-        io.puts o
+        io.puts output
       end
     end
 
     def method_missing msg, *args
-      return super unless io.respond_to? msg
-      io.send(msg, *args)
+      return io.send(msg, *args) if io.respond_to? msg
+
+      super
+    end
+
+    def respond_to_missing? method_name, include_all = false
+      return true if io.respond_to? method_name, include_all
+
+      super
     end
   end
 end

data/minitest-rg.gemspec

@@ -1,40 +1,29 @@
 # -*- encoding: utf-8 -*-
-# stub: minitest-rg 5.1.0.20140416094215 ruby lib
+# stub: minitest-rg 5.3.0.20231031004948 ruby lib
 
 Gem::Specification.new do |s|
-  s.name = "minitest-rg"
-  s.version = "5.1.0.20140416094215"
+  s.name = "minitest-rg".freeze
+  s.version = "5.3.0.20231031004948"
 
-  s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
-  s.require_paths = ["lib"]
-  s.authors = ["Mike Moore"]
-  s.date = "2014-04-16"
-  s.description = "Adds color to your MiniTest output"
-  s.email = ["mike@blowmage.com"]
-  s.extra_rdoc_files = ["CHANGELOG.rdoc", "Manifest.txt", "README.rdoc"]
-  s.files = [".autotest", ".gemtest", "CHANGELOG.rdoc", "Gemfile", "LICENSE", "Manifest.txt", "README.rdoc", "Rakefile", "lib/minitest/rg.rb", "lib/minitest/rg_plugin.rb", "minitest-rg.gemspec", "test/test_minitest-rg.rb"]
-  s.homepage = "http://blowmage.com/minitest-rg"
-  s.licenses = ["MIT"]
-  s.rdoc_options = ["--main", "README.rdoc"]
-  s.rubygems_version = "2.2.2"
-  s.summary = "RedGreen for MiniTest"
-  s.test_files = ["test/test_minitest-rg.rb"]
+  s.required_rubygems_version = Gem::Requirement.new(">= 0".freeze) if s.respond_to? :required_rubygems_version=
+  s.metadata = { "bug_tracker_uri" => "https://github.com/minitest/minitest-rg/issues", "homepage_uri" => "https://github.com/minitest/minitest-rg" } if s.respond_to? :metadata=
+  s.require_paths = ["lib".freeze]
+  s.authors = ["Mike Moore".freeze]
+  s.date = "2023-10-31"
+  s.description = "Colored red/green output for Minitest".freeze
+  s.email = ["mike@blowmage.com".freeze]
+  s.extra_rdoc_files = ["CHANGELOG.rdoc".freeze, "Manifest.txt".freeze, "README.rdoc".freeze]
+  s.files = [".autotest".freeze, ".gemtest".freeze, ".rubocop.yml".freeze, "CHANGELOG.rdoc".freeze, "Gemfile".freeze, "LICENSE".freeze, "Manifest.txt".freeze, "README.rdoc".freeze, "Rakefile".freeze, "lib/minitest/rg.rb".freeze, "lib/minitest/rg_plugin.rb".freeze, "minitest-rg.gemspec".freeze, "scripts/run_error".freeze, "scripts/run_fail".freeze, "scripts/run_pass".freeze, "scripts/run_skip".freeze, "test/test_rg.rb".freeze]
+  s.homepage = "https://github.com/minitest/minitest-rg".freeze
+  s.licenses = ["MIT".freeze]
+  s.rdoc_options = ["--main".freeze, "README.rdoc".freeze]
+  s.rubygems_version = "3.4.12".freeze
+  s.summary = "Red/Green for Minitest".freeze
 
-  if s.respond_to? :specification_version then
-    s.specification_version = 4
+  s.specification_version = 4
 
-    if Gem::Version.new(Gem::VERSION) >= Gem::Version.new('1.2.0') then
-      s.add_runtime_dependency(%q<minitest>, ["~> 5.0"])
-      s.add_development_dependency(%q<rdoc>, ["~> 4.0"])
-      s.add_development_dependency(%q<hoe>, ["~> 3.11"])
-    else
-      s.add_dependency(%q<minitest>, ["~> 5.0"])
-      s.add_dependency(%q<rdoc>, ["~> 4.0"])
-      s.add_dependency(%q<hoe>, ["~> 3.11"])
-    end
-  else
-    s.add_dependency(%q<minitest>, ["~> 5.0"])
-    s.add_dependency(%q<rdoc>, ["~> 4.0"])
-    s.add_dependency(%q<hoe>, ["~> 3.11"])
-  end
+  s.add_runtime_dependency(%q<minitest>.freeze, ["~> 5.0"])
+  s.add_development_dependency(%q<rubocop>.freeze, ["~> 1.57.0"])
+  s.add_development_dependency(%q<rdoc>.freeze, [">= 4.0", "< 7"])
+  s.add_development_dependency(%q<hoe>.freeze, ["~> 4.0"])
 end

data/scripts/run_error

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+# frozen_string_literal: true
+
+gem "minitest"
+require "minitest/autorun"
+
+$LOAD_PATH.unshift "#{File.dirname(__FILE__)}/../lib"
+require "minitest/rg"
+
+class TestPass < Minitest::Test
+  def test_error
+    raise "Error should be YELLOW"
+  end
+end

data/scripts/run_fail

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+# frozen_string_literal: true
+
+gem "minitest"
+require "minitest/autorun"
+
+$LOAD_PATH.unshift "#{File.dirname(__FILE__)}/../lib"
+require "minitest/rg"
+
+class TestPass < Minitest::Test
+  def test_fail
+    assert_equal 1, 2, "Failure should be RED"
+  end
+end

data/scripts/run_pass

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+# frozen_string_literal: true
+
+gem "minitest"
+require "minitest/autorun"
+
+$LOAD_PATH.unshift "#{File.dirname(__FILE__)}/../lib"
+require "minitest/rg"
+
+class TestPass < Minitest::Test
+  def test_pass
+    assert_equal 1, 1, "Pass should be GREEN"
+  end
+end

data/scripts/run_skip

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+# frozen_string_literal: true
+
+gem "minitest"
+require "minitest/autorun"
+
+$LOAD_PATH.unshift "#{File.dirname(__FILE__)}/../lib"
+require "minitest/rg"
+
+class TestPass < Minitest::Test
+  def test_skip
+    skip "Skip should be CYAN"
+  end
+end

data/test/test_rg.rb

@@ -0,0 +1,79 @@
+# frozen_string_literal: true
+
+require "bundler/setup"
+
+$LOAD_PATH.unshift "#{File.dirname(__FILE__)}/../lib"
+
+require "minitest/autorun"
+require "minitest/rg"
+
+class TestRG < Minitest::Test
+  def test_pass_is_green
+    output = capture_output "pass"
+
+    exp_dot = "\e[32m.\e[0m"
+    exp_sum = "\e[32m1 runs, 1 assertions, 0 failures, 0 errors, 0 skips\e[0m"
+
+    assert_match exp_dot, output, "Passing tests are GREEN"
+    assert_match exp_sum, output, "Passing summary is GREEN"
+  end
+
+  def test_fail_is_red
+    output = capture_output "fail"
+
+    exp_dot = "\e[31mF\e[0m"
+    exp_sum = "\e[31m1 runs, 1 assertions, 1 failures, 0 errors, 0 skips\e[0m"
+
+    assert_match exp_dot, output, "Failing tests are RED"
+    assert_match exp_sum, output, "Failing summary is RED"
+  end
+
+  def test_error_is_yellow
+    output = capture_output "error"
+
+    exp_dot = "\e[33mE\e[0m"
+    exp_sum = "\e[31m1 runs, 0 assertions, 0 failures, 1 errors, 0 skips\e[0m"
+
+    assert_match exp_dot, output, "Erroring tests are YELLOW"
+    assert_match exp_sum, output, "Erroring summary is YELLOW"
+  end
+
+  def test_skip_is_cyan
+    output = capture_output "skip"
+
+    exp_dot = "\e[36mS\e[0m"
+    exp_sum = "\e[32m1 runs, 0 assertions, 0 failures, 0 errors, 1 skips\r\n" \
+              "\r\nYou have skipped tests. Run with --verbose for details.\e[0m"
+
+    assert_match exp_dot, output, "Skipped tests are CYAN"
+    assert_match exp_sum, output, "Skipped summary is CYAN"
+  end
+
+  def test_no_colors_via_option
+    output = capture_output "no_color"
+    assert_includes output, "\n1 runs"
+  end
+
+  def test_force_colors_via_option
+    output = capture_output "color", tty: false
+    assert_includes output, "\n\e[32m1 runs"
+  end
+
+  def test_no_color_without_tty
+    output = capture_output "pass", tty: false
+    assert_includes output, "\n1 runs"
+  end
+
+  def capture_output command, tty: true
+    if tty
+      os = `uname -s`.chomp
+      if os.include?("BSD") || os.include?("Darwin")
+        `script -q /dev/null ./scripts/run_#{command}`
+      else
+        `script -q -c ./scripts/run_#{command} /dev/null`
+      end
+    else
+      `scripts/run_#{command} </dev/null`
+    end
+  end
+end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: minitest-rg
 version: !ruby/object:Gem::Version
-  version: 5.1.0
+  version: 5.3.0
 platform: ruby
 authors:
 - Mike Moore
-autorequire: 
+autorequire:
 bindir: bin
 cert_chain: []
-date: 2014-04-16 00:00:00.000000000 Z
+date: 2023-10-31 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: minitest
@@ -25,34 +25,54 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '5.0'
 - !ruby/object:Gem::Dependency
-  name: rdoc
+  name: rubocop
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '4.0'
+        version: 1.57.0
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
+      - !ruby/object:Gem::Version
+        version: 1.57.0
+- !ruby/object:Gem::Dependency
+  name: rdoc
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
       - !ruby/object:Gem::Version
         version: '4.0'
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '7'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '4.0'
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '7'
 - !ruby/object:Gem::Dependency
   name: hoe
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '3.11'
+        version: '4.0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '3.11'
-description: Adds color to your MiniTest output
+        version: '4.0'
+description: Colored red/green output for Minitest
 email:
 - mike@blowmage.com
 executables: []
@@ -64,6 +84,7 @@ extra_rdoc_files:
 files:
 - ".autotest"
 - ".gemtest"
+- ".rubocop.yml"
 - CHANGELOG.rdoc
 - Gemfile
 - LICENSE
@@ -73,12 +94,18 @@ files:
 - lib/minitest/rg.rb
 - lib/minitest/rg_plugin.rb
 - minitest-rg.gemspec
-- test/test_minitest-rg.rb
-homepage: http://blowmage.com/minitest-rg
+- scripts/run_error
+- scripts/run_fail
+- scripts/run_pass
+- scripts/run_skip
+- test/test_rg.rb
+homepage: https://github.com/minitest/minitest-rg
 licenses:
 - MIT
-metadata: {}
-post_install_message: 
+metadata:
+  homepage_uri: https://github.com/minitest/minitest-rg
+  bug_tracker_uri: https://github.com/minitest/minitest-rg/issues
+post_install_message:
 rdoc_options:
 - "--main"
 - README.rdoc
@@ -95,10 +122,8 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubyforge_project: 
-rubygems_version: 2.2.2
-signing_key: 
+rubygems_version: 3.4.12
+signing_key:
 specification_version: 4
-summary: RedGreen for MiniTest
-test_files:
-- test/test_minitest-rg.rb
+summary: Red/Green for Minitest
+test_files: []

data/test/test_minitest-rg.rb

@@ -1,25 +0,0 @@
-gem "minitest"
-require 'minitest/autorun'
-require 'minitest/rg'
-
-describe 'minitest-rg' do
-  # generate passing
-  it "passes" do
-    assert_equal 1, 1, "Pass should be GREEN"
-  end
-
-  # generate failing
-  it "fails" do
-    assert_equal 1, 2, "Failure should be RED"
-  end
-
-  # generate error
-  it "error" do
-    raise "Error should be YELLOW"
-  end
-
-  # generate skip
-  it "skips" do
-    skip "Skip should be CYAN"
-  end
-end