minitest-heat 2.1.0 → 2.2.0

data/lib/minitest/heat/output/results.rb

@@ -10,9 +10,7 @@ module Minitest
         attr_accessor :results, :timer
 
         # Explicitly define issues to avoid Forwardable warning about Object#issues private method
-        def issues
-          @results.issues
-        end
+        def issues = @results.issues
 
         def_delegators :@results, :errors, :brokens, :failures, :skips, :painfuls, :slows, :problems?
 
@@ -68,17 +66,11 @@ module Minitest
           counts_with_separators
         end
 
-        def error_count_token
-          issue_count_token(:error, errors)
-        end
+        def error_count_token = issue_count_token(:error, errors)
 
-        def broken_count_token
-          issue_count_token(:broken, brokens)
-        end
+        def broken_count_token = issue_count_token(:broken, brokens)
 
-        def failure_count_token
-          issue_count_token(:failure, failures)
-        end
+        def failure_count_token = issue_count_token(:failure, failures)
 
         def skip_count_token
           style = problems? ? :muted : :skipped
@@ -86,34 +78,24 @@ module Minitest
         end
 
         def painful_count_token
-          style = problems? || skips.any? ? :muted : :painful
-          issue_count_token(style, painfuls, name: 'Painfully Slow')
+          issue_count_token(secondary_style(:painful), painfuls, name: 'Painfully Slow')
         end
 
         def slow_count_token
-          style = problems? || skips.any? ? :muted : :slow
-          issue_count_token(style, slows, name: 'Slow')
+          issue_count_token(secondary_style(:slow), slows, name: 'Slow')
         end
 
-        def test_count_token
-          [:default, pluralize(timer.test_count, 'test').to_s]
-        end
+        def secondary_style(style) = problems? || skips.any? ? :muted : style
 
-        def tests_performance_token
-          [:default, " (#{timer.tests_per_second}/s)"]
-        end
+        def test_count_token = [:default, pluralize(timer.test_count, 'test').to_s]
 
-        def assertions_count_token
-          [:default, pluralize(timer.assertion_count, 'assertion').to_s]
-        end
+        def tests_performance_token = [:default, " (#{timer.tests_per_second}/s)"]
 
-        def assertions_performance_token
-          [:default, " (#{timer.assertions_per_second}/s)"]
-        end
+        def assertions_count_token = [:default, pluralize(timer.assertion_count, 'assertion').to_s]
 
-        def timing_token
-          [:bold, "#{timer.total_time.round(2)}s"]
-        end
+        def assertions_performance_token = [:default, " (#{timer.assertions_per_second}/s)"]
+
+        def timing_token = [:bold, "#{timer.total_time.round(2)}s"]
 
         def issue_count_token(type, collection, name: type.capitalize)
           return nil if collection.empty?
@@ -121,13 +103,9 @@ module Minitest
           [type, pluralize(collection.size, name)]
         end
 
-        def spacer_token
-          Output::TOKENS[:spacer]
-        end
+        def spacer_token = Output::TOKENS[:spacer]
 
-        def join_token
-          [:default, ' with ']
-        end
+        def join_token = [:default, ' with ']
       end
     end
   end

data/lib/minitest/heat/output/source_code.rb

@@ -63,9 +63,7 @@ module Minitest
         #   three lines. Or it could be something end users could disable in order to reduce noise.
         #
         # @return [Boolean] true if the target line should be highlighted
-        def highlight_key_line?
-          HIGHLIGHT_KEY_LINE
-        end
+        def highlight_key_line? = HIGHLIGHT_KEY_LINE
 
         # The number of spaces each line of code should be indented. Currently defaults to 2 in
         #   order to provide visual separation between test failures, but in the future, it could
@@ -75,9 +73,7 @@ module Minitest
         #   option that would reduce the space used.
         #
         # @return [type] [description]
-        def indentation
-          DEFAULT_INDENTATION_SPACES
-        end
+        def indentation = DEFAULT_INDENTATION_SPACES
 
         private
 
@@ -113,18 +109,14 @@ module Minitest
         # @param line_number [Integer,String] the digits representing the line number
         #
         # @return [Array] the style/content token for the current line number
-        def line_number_token(style, line_number)
-          [style, "#{' ' * indentation}#{line_number.to_s.rjust(max_line_number_digits)} "]
-        end
+        def line_number_token(style, line_number) = [style, "#{' ' * indentation}#{line_number.to_s.rjust(max_line_number_digits)} "]
 
         # The token representing the content of a given line of code.
         # @param style [Symbol] the symbol representing the style for the line of code token
         # @param line_number [Integer,String] the content of the line of code
         #
         # @return [Array] the style/content token for the current line of code
-        def line_of_code_token(style, line_of_code)
-          [style, line_of_code]
-        end
+        def line_of_code_token(style, line_of_code) = [style, line_of_code]
       end
     end
   end

data/lib/minitest/heat/output/token.rb

@@ -6,6 +6,7 @@ module Minitest
       # Provides a convenient interface for creating console-friendly output while ensuring
       #   consistency in the applied styles.
       class Token
+        # Raised when an unrecognized style key is used
         class InvalidStyle < ArgumentError; end
 
         STYLES = {
@@ -23,6 +24,28 @@ module Minitest
           muted: %i[light default]
         }.freeze
 
+        ESC_SEQUENCE = "\e["
+        END_SEQUENCE = 'm'
+
+        WEIGHTS = {
+          default: 0,
+          bold: 1,
+          light: 2,
+          italic: 3
+        }.freeze
+
+        COLORS = {
+          black: 30,
+          red: 31,
+          green: 32,
+          yellow: 33,
+          blue: 34,
+          magenta: 35,
+          cyan: 36,
+          gray: 37,
+          default: 39
+        }.freeze
+
         attr_accessor :style_key, :content
 
         def initialize(style_key, content)
@@ -47,28 +70,6 @@ module Minitest
 
         private
 
-        ESC_SEQUENCE = "\e["
-        END_SEQUENCE = 'm'
-
-        WEIGHTS = {
-          default: 0,
-          bold: 1,
-          light: 2,
-          italic: 3
-        }.freeze
-
-        COLORS = {
-          black: 30,
-          red: 31,
-          green: 32,
-          yellow: 33,
-          blue: 34,
-          magenta: 35,
-          cyan: 36,
-          gray: 37,
-          default: 39
-        }.freeze
-
         def style_string
           "#{ESC_SEQUENCE}#{weight};#{color}#{END_SEQUENCE}"
         end

data/lib/minitest/heat/output.rb

@@ -11,7 +11,7 @@ require_relative 'output/token'
 module Minitest
   module Heat
     # Friendly API for printing nicely-formatted output to the console
-    class Output # rubocop:disable Metrics/ClassLength
+    class Output
       SYMBOLS = {
         middot: '·',
         arrow: '➜',
@@ -33,12 +33,12 @@ module Minitest
         end
       end
 
-      def print(*args)
-        stream.print(*args)
+      def print(*)
+        stream.print(*)
       end
 
-      def puts(*args)
-        stream.puts(*args)
+      def puts(*)
+        stream.puts(*)
       end
       alias newline puts
 
@@ -152,12 +152,10 @@ module Minitest
       def print_tokens(lines_of_tokens)
         lines_of_tokens.each do |tokens|
           tokens.each do |token|
-            begin
-              print Token.new(*token).to_s(token_format)
-            rescue ArgumentError => e
-              # Token format error - output debug info and continue
-              puts "Token error (#{e.message}): #{token.inspect}"
-            end
+            print Token.new(*token).to_s(token_format)
+          rescue ArgumentError => e
+            # Token format error - output debug info and continue
+            puts "Token error (#{e.message}): #{token.inspect}"
           end
           newline
         end

data/lib/minitest/heat/source.rb

@@ -15,21 +15,18 @@ module Minitest
         @line_number = Integer(line_number)
         @max_line_count = max_line_count
         @context = context
+        @raw_lines = nil
       end
 
       # Returns relevant lines as a hash with line numbers as the keys
       #
       # @return [Hash] hash of relevant lines with line numbers as keys
-      def to_h
-        line_numbers.map(&:to_s).zip(lines).to_h
-      end
+      def to_h = line_numbers.map(&:to_s).zip(lines).to_h
 
       # Looks up the line of code referenced
       #
       # @return [String] the line of code at filename:line_number
-      def line
-        file_lines[line_number - 1]
-      end
+      def line = file_lines[line_number - 1]
 
       # Looks up the available lines of code around the referenced line number
       #
@@ -43,9 +40,7 @@ module Minitest
       # Line numbers for the returned lines
       #
       # @return [Array<Integer>] the line numbers corresponding to the lines returned
-      def line_numbers
-        (first_line_number..last_line_number).to_a.uniq
-      end
+      def line_numbers = (first_line_number..last_line_number).to_a.uniq
 
       # Reads (and chomps) the lines of the target file
       #
@@ -68,9 +63,7 @@ module Minitest
       # The largest possible value for line numbers
       #
       # @return [Integer] the last line number of the file
-      def max_line_number
-        file_lines.length
-      end
+      def max_line_number = file_lines.length
 
       # The number of the first line of code to return
       #
@@ -79,7 +72,7 @@ module Minitest
         target = line_number - first_line_offset - leftover_trailing_lines_count
 
         # Can't go earlier than the first line
-        target < 1 ? 1 : target
+        [target, 1].max
       end
 
       # The number of the last line of code to return
@@ -89,7 +82,7 @@ module Minitest
         target = line_number + last_line_offset + leftover_preceding_lines_count
 
         # Can't go past the end of the file
-        target > max_line_number ? max_line_number : target
+        [target, max_line_number].min
       end
 
       # The target number of preceding lines to include
@@ -135,21 +128,15 @@ module Minitest
       end
 
       # The total number of lines to include in addition to the primary line
-      def other_lines_count
-        max_line_count - 1
-      end
+      def other_lines_count = max_line_count - 1
 
-      def preceding_lines_split_count
-        # Round up preceding lines if it's uneven because preceding lines are more likely to be
-        # helpful when debugging
-        (other_lines_count / 2).round(0, half: :up)
-      end
+      # Round up preceding lines if it's uneven because preceding lines are more likely to be
+      # helpful when debugging
+      def preceding_lines_split_count = (other_lines_count / 2).round(0, half: :up)
 
-      def trailing_lines_split_count
-        # Round down preceding lines because they provide context in the file but don't contribute
-        # in terms of the code that led to the error
-        (other_lines_count / 2).round(0, half: :down)
-      end
+      # Round down preceding lines because they provide context in the file but don't contribute
+      # in terms of the code that led to the error
+      def trailing_lines_split_count = (other_lines_count / 2).round(0, half: :down)
     end
   end
 end

data/lib/minitest/heat/timer.rb

@@ -36,12 +36,10 @@ module Minitest
       #   returns a zero that would be problematic as a denomitor in calculating average times
       #
       # @return [Float] the clocktime duration of the test suite run in seconds
-      def total_time
-        # Don't return 0. The time can end up being 0 for a new or realy fast test suite, and
-        # dividing by 0 doesn't go well when determining average time, so this ensures it uses a
-        # close-enough-but-not-zero value.
-        delta.zero? ? 0.01 : delta
-      end
+      # Don't return 0. The time can end up being 0 for a new or realy fast test suite, and
+      # dividing by 0 doesn't go well when determining average time, so this ensures it uses a
+      # close-enough-but-not-zero value.
+      def total_time = delta.zero? ? 0.01 : delta
 
       # Records the test and assertion counts for a given test outcome
       # @param count [Integer] the number of assertions from the test
@@ -55,16 +53,12 @@ module Minitest
       # Provides a nice rounded answer for about how many tests were completed per second
       #
       # @return [Float] the average number of tests completed per second
-      def tests_per_second
-        (test_count / total_time).round(2)
-      end
+      def tests_per_second = (test_count / total_time).round(2)
 
       # Provides a nice rounded answer for about how many assertions were completed per second
       #
       # @return [Float] the average number of assertions completed per second
-      def assertions_per_second
-        (assertion_count / total_time).round(2)
-      end
+      def assertions_per_second = (assertion_count / total_time).round(2)
 
       # Generates a hash representation for JSON serialization
       #

data/lib/minitest/heat/version.rb

@@ -2,6 +2,6 @@
 
 module Minitest
   module Heat
-    VERSION = '2.1.0'
+    VERSION = '2.2.0'
   end
 end

data/lib/minitest/heat_plugin.rb

@@ -2,7 +2,8 @@
 
 require_relative 'heat_reporter'
 
-module Minitest # rubocop:disable Style/Documentation
+# :reek:IrresponsibleModule - reopening Minitest module for plugin registration
+module Minitest
   def self.plugin_heat_options(opts, options)
     opts.on '--heat-json', 'Output results as JSON instead of human-readable format' do
       options[:heat_json] = true
@@ -10,6 +11,8 @@ module Minitest # rubocop:disable Style/Documentation
   end
 
   def self.plugin_heat_init(options)
+    return if reporter.reporters.any? { |existing| existing.is_a?(HeatReporter) }
+
     io = options.fetch(:io, $stdout)
 
     reporter.reporters.reject! do |reporter|

data/lib/minitest/heat_reporter.rb

@@ -38,6 +38,7 @@ module Minitest
       super()
 
       @options = options
+      @recording_error = false
 
       @timer =    Heat::Timer.new
       @results =  Heat::Results.new
@@ -56,8 +57,8 @@ module Minitest
     end
 
     # About to start running a test. This allows a reporter to show that it is starting or that we
-    # are in the middle of a test run.
-    def prerecord(klass, name); end
+    # are in the middle of a test run. Parameters required by Minitest::AbstractReporter interface.
+    def prerecord(_klass, _name); end
 
     # Records the data from a result.
     #
@@ -77,23 +78,25 @@ module Minitest
       # Show the marker (skip for JSON output)
       output.marker(issue.type) unless json_output?
     rescue StandardError => e
+      @recording_error = true
       display_exception_guidance(e)
     end
 
     def display_exception_guidance(exception)
-      output.newline
-      puts 'Sorry, but Minitest Heat encountered an exception recording an issue. Disabling Minitest Heat will get you back on track.'
-      puts 'Please use the following exception details to submit an issue at https://github.com/garrettdimon/minitest-heat/issues'
-      puts "#{exception.message}:"
+      warn ''
+      warn 'Sorry, but Minitest Heat encountered an exception recording an issue. Disabling Minitest Heat will get you back on track.'
+      warn 'Please use the following exception details to submit an issue at https://github.com/garrettdimon/minitest-heat/issues'
+      warn "#{exception.message}:"
       exception.backtrace.each do |line|
-        puts "  #{line}"
+        warn "  #{line}"
       end
-      output.newline
+      warn ''
     end
 
     # Outputs the summary of the run.
     def report
       timer.stop!
+      warn "Nothing ran for filter: #{test_filter}" if empty_filtered_run?
 
       if json_output?
         output_json
@@ -105,26 +108,27 @@ module Minitest
     # Whether to output JSON instead of human-readable text
     #
     # @return [Boolean] true if --heat-json flag was passed
-    def json_output?
-      options[:heat_json]
-    end
+    def json_output? = options[:heat_json]
 
     # Did this run pass?
-    def passed?
-      results.errors.empty? && results.failures.empty?
-    end
+    def passed? = !@recording_error && !results.problems? && !empty_filtered_run?
 
     private
 
+    def test_filter = options[:include] || options[:filter]
+
+    def empty_filtered_run? = test_filter && timer.test_count.zero?
+
     def output_json
       require 'json'
+      require 'time'
       output.stream.puts JSON.pretty_generate(json_results)
     end
 
     def json_results
       {
         version: '1.0',
-        status: results.problems? ? 'failed' : 'passed',
+        status: passed? ? 'passed' : 'failed',
         timestamp: Time.now.iso8601,
         statistics: results.statistics,
         timing: timer.to_h,

data/minitest-heat.gemspec

@@ -31,13 +31,5 @@ Gem::Specification.new do |spec|
   spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
   spec.require_paths = ['lib']
 
-  spec.add_runtime_dependency 'minitest'
-
-  spec.add_development_dependency 'awesome_print'
-  spec.add_development_dependency 'debug'
-  spec.add_development_dependency 'rubocop'
-  spec.add_development_dependency 'rubocop-minitest'
-  spec.add_development_dependency 'rubocop-rake'
-  spec.add_development_dependency 'simplecov'
-  spec.add_development_dependency 'simplecov_json_formatter'
+  spec.add_dependency 'minitest', '>= 5.22.3', '< 7'
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: minitest-heat
 version: !ruby/object:Gem::Version
-  version: 2.1.0
+  version: 2.2.0
 platform: ruby
 authors:
 - Garrett Dimon
@@ -15,112 +15,20 @@ dependencies:
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: '0'
-  type: :runtime
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '0'
-- !ruby/object:Gem::Dependency
-  name: awesome_print
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '0'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '0'
-- !ruby/object:Gem::Dependency
-  name: debug
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '0'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '0'
-- !ruby/object:Gem::Dependency
-  name: rubocop
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '0'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
+        version: 5.22.3
+    - - "<"
       - !ruby/object:Gem::Version
-        version: '0'
-- !ruby/object:Gem::Dependency
-  name: rubocop-minitest
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '0'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '0'
-- !ruby/object:Gem::Dependency
-  name: rubocop-rake
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '0'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '0'
-- !ruby/object:Gem::Dependency
-  name: simplecov
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '0'
-  type: :development
+        version: '7'
+  type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: '0'
-- !ruby/object:Gem::Dependency
-  name: simplecov_json_formatter
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '0'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
+        version: 5.22.3
+    - - "<"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '7'
 description: Presents test results in a visual manner to guide you to where to look
   first.
 email:
@@ -129,10 +37,14 @@ executables: []
 extensions: []
 extra_rdoc_files: []
 files:
+- ".flayignore"
 - ".github/FUNDING.yml"
 - ".github/workflows/main.yml"
 - ".github/workflows/release.yml"
 - ".gitignore"
+- ".reek.yml"
+- ".reviewer.yml"
+- ".reviewer_history.yml"
 - ".rubocop.yml"
 - CHANGELOG.md
 - CODE_OF_CONDUCT.md
@@ -144,6 +56,7 @@ files:
 - Rakefile
 - bin/console
 - bin/setup
+- favicon.svg
 - lib/minitest/heat.rb
 - lib/minitest/heat/backtrace.rb
 - lib/minitest/heat/backtrace/line_count.rb