minitest-heat 0.0.5 → 0.0.6

data/lib/minitest/heat/output.rb

@@ -2,8 +2,8 @@
 
 require_relative 'output/backtrace'
 require_relative 'output/issue'
-require_relative 'output/location'
 require_relative 'output/map'
+require_relative 'output/marker'
 require_relative 'output/results'
 require_relative 'output/source_code'
 require_relative 'output/token'
@@ -12,35 +12,6 @@ module Minitest
   module Heat
     # Friendly API for printing nicely-formatted output to the console
     class Output
-      FORMATTERS = {
-        error: [
-          [ %i[error label], %i[muted spacer], %i[default test_name] ],
-          [ %i[italicized summary], ],
-          [ %i[default backtrace_summary] ],
-        ],
-        broken: [
-          [ %i[broken label], %i[muted spacer], %i[default test_name], %i[muted spacer], %i[muted test_class] ],
-          [ %i[italicized summary], ],
-          [ %i[default backtrace_summary] ],
-        ],
-        failure: [
-          [ %i[failure label], %i[muted spacer], %i[default test_name], %i[muted spacer], %i[muted test_class] ],
-          [ %i[italicized summary] ],
-          [ %i[muted short_location], ],
-          [ %i[default source_summary], ],
-        ],
-        skipped: [
-          [ %i[skipped label], %i[muted spacer], %i[default test_name], %i[muted spacer], %i[muted test_class] ],
-          [ %i[italicized summary] ],
-          [], # New Line
-        ],
-        slow: [
-          [ %i[slow label], %i[muted spacer], %i[default test_name], %i[muted spacer], %i[default test_class] ],
-          [ %i[bold slowness], %i[muted spacer], %i[default location], ],
-          [], # New Line
-        ]
-      }
-
       attr_reader :stream
 
       def initialize(stream = $stdout)
@@ -59,106 +30,22 @@ module Minitest
       end
       alias newline puts
 
-      # TOOD: Convert to output class
-      #       - This should likely live in the output/issue class
-      #       - Add a 'fail_fast' option that shows the issue as soon as the failure occurs
-      def marker(value)
-        case value
-        when 'E' then text(:error, value)
-        when 'B' then text(:failure, value)
-        when 'F' then text(:failure, value)
-        when 'S' then text(:skipped, value)
-        else          text(:success, value)
-        end
-      end
-
-      # TOOD: Convert to output class
-      #       - This should likely live in the output/issue class
-      #       - There may be justification for creating different "strategies" for the various types
       def issue_details(issue)
-        formatter = FORMATTERS[issue.type]
-
-        formatter.each do |lines|
-          lines.each do |tokens|
-            style, content_method = *tokens
-
-            if issue.respond_to?(content_method)
-              # If it's an available method on issue, use that to get the content
-              content = issue.send(content_method)
-              text(style, content)
-            else
-              # Otherwise, fall back to output and pass issue to *it*
-              send(content_method, issue)
-            end
-          end
-          newline
-        end
-      end
-
-      # TOOD: Convert to output class
-      def heat_map(map)
-        map.files.each do |file|
-          pathname = Pathname(file[0])
-
-          path = pathname.dirname.to_s
-          filename = pathname.basename.to_s
-
-          values = map.hits[pathname.to_s]
-
-
-          text(:error, 'E' * values[:error].size)     if values[:error]&.any?
-          text(:broken, 'B' * values[:broken].size)   if values[:broken]&.any?
-          text(:failure, 'F' * values[:failure].size) if values[:failure]&.any?
-
-          unless values[:error]&.any? || values[:broken]&.any? || values[:failure]&.any?
-            text(:skipped, 'S' * values[:skipped].size) if values[:skipped]&.any?
-            text(:painful, '—' * values[:painful].size) if values[:painful]&.any?
-            text(:slow, '–' * values[:slow].size)       if values[:slow]&.any?
-          end
-
-          text(:muted, ' ') if map.hits.any?
-
-          text(:muted, "#{path.delete_prefix(Dir.pwd)}/")
-          text(:default, filename)
-
-          text(:muted, ':')
-
-          all_line_numbers = values.fetch(:error, []) + values.fetch(:failure, [])
-          all_line_numbers += values.fetch(:skipped, [])
-
-          line_numbers = all_line_numbers.compact.uniq.sort
-          line_numbers.each { |line_number| text(:muted, "#{line_number} ") }
-          newline
-        end
-        newline
+        print_tokens Minitest::Heat::Output::Issue.new(issue).tokens
       end
 
-      # TOOD: Convert to output class
-      def test_name_summary(issue)
-        text(:default, "#{issue.test_class} > #{issue.test_name}")
+      def marker(issue_type)
+        print_token Minitest::Heat::Output::Marker.new(issue_type).token
       end
 
       def compact_summary(results)
-        results_tokens = ::Minitest::Heat::Output::Results.new(results).tokens
-
-        newline
-        print_tokens(results_tokens)
         newline
+        print_tokens ::Minitest::Heat::Output::Results.new(results).tokens
       end
 
-      def backtrace_summary(issue)
-        location = issue.location
-
-        backtrace_tokens = ::Minitest::Heat::Output::Backtrace.new(location).tokens
-        print_tokens(backtrace_tokens)
-      end
-
-      def source_summary(issue)
-        filename    = issue.location.project_file
-        line_number = issue.location.project_failure_line
-
-        source_code_tokens = ::Minitest::Heat::Output::SourceCode.new(filename, line_number).tokens
-        print_tokens(source_code_tokens)
+      def heat_map(map)
+        newline
+        print_tokens ::Minitest::Heat::Output::Map.new(map).tokens
       end
 
       private
@@ -176,6 +63,10 @@ module Minitest
         style_enabled? ? :styled : :unstyled
       end
 
+      def print_token(token)
+        print Token.new(*token).to_s(token_format)
+      end
+
       def print_tokens(lines_of_tokens)
         lines_of_tokens.each do |tokens|
           tokens.each do |token|

data/lib/minitest/heat/results.rb

@@ -2,8 +2,8 @@
 
 module Minitest
   module Heat
+    # A collection of test failures
     class Results
-
       attr_reader :test_count,
                   :assertion_count,
                   :success_count,
@@ -20,6 +20,7 @@ module Minitest
           broken: [],
           failure: [],
           skipped: [],
+          painful: [],
           slow: []
         }
         @start_time = nil
@@ -69,12 +70,20 @@ module Minitest
         issues.fetch(:skipped) { [] }
       end
 
+      def painfuls
+        issues
+          .fetch(:painful) { [] }
+          .sort_by(&:time)
+          .reverse
+          .take(5)
+      end
+
       def slows
         issues
           .fetch(:slow) { [] }
-          .sort { |issue| issue.time }
+          .sort_by(&:time)
           .reverse
-          .take(3)
+          .take(5)
       end
 
       def errors?
@@ -93,6 +102,10 @@ module Minitest
         skips.any?
       end
 
+      def painfuls?
+        painfuls.any?
+      end
+
       def slows?
         slows.any?
       end

data/lib/minitest/heat/version.rb

@@ -1,5 +1,7 @@
+# frozen_string_literal: true
+
 module Minitest
   module Heat
-    VERSION = "0.0.5"
+    VERSION = '0.0.6'
   end
 end

data/lib/minitest/heat.rb

@@ -1,7 +1,9 @@
 # frozen_string_literal: true
 
 require_relative 'heat/backtrace'
+require_relative 'heat/hit'
 require_relative 'heat/issue'
+require_relative 'heat/line'
 require_relative 'heat/location'
 require_relative 'heat/map'
 require_relative 'heat/output'

data/lib/minitest/heat_plugin.rb

@@ -3,12 +3,12 @@
 require_relative 'heat_reporter'
 
 module Minitest
-  def self.plugin_heat_options(opts, options)
-    opts.on '--show-fast', "Show failures as they happen instead of waiting for the entire suite." do
+  def self.plugin_heat_options(opts, _options)
+    opts.on '--show-fast', 'Show failures as they happen instead of waiting for the entire suite.' do
       # Heat.show_fast!
     end
 
-    # TODO options.
+    # TODO: options.
     # 1. Fail Fast
     # 2. Don't worry about skips.
     # 3. Skip coverage.
@@ -18,9 +18,9 @@ module Minitest
     io = options[:io]
 
     # Clean out the existing reporters.
-    self.reporter.reporters = []
+    reporter.reporters = []
 
     # Use Reviewer as the sole reporter.
-    self.reporter << HeatReporter.new(io, options)
+    reporter << HeatReporter.new(io, options)
   end
 end

data/lib/minitest/heat_reporter.rb

@@ -1,6 +1,6 @@
 # frozen_string_literal: true
 
-require_relative "heat"
+require_relative 'heat'
 
 module Minitest
   # Custom minitest reporter to proactively identify likely culprits in test failures by focusing on
@@ -29,31 +29,31 @@ module Minitest
   # Pulls from minitest-color as well:
   #   https://github.com/teoljungberg/minitest-color/blob/master/lib/minitest/color_plugin.rb
   class HeatReporter < AbstractReporter
-
     attr_reader :output,
                 :options,
                 :results,
                 :map
 
     def initialize(io = $stdout, options = {})
-      @output = Heat::Output.new(io)
       @options = options
 
-      @results = Heat::Results.new
-      @map = Heat::Map.new
+      @results =  Heat::Results.new
+      @map =      Heat::Map.new
+      @output =   Heat::Output.new(io)
     end
 
     # Starts reporting on the run.
     def start
-      output.puts
-      output.puts
-      @results.start_timer!
+      results.start_timer!
+
+      # A couple of blank lines to create some breathing room
+      output.newline
+      output.newline
     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
+    def prerecord(klass, name); end
 
     # Records the data from a result.
     # Minitest::Result source:
@@ -61,16 +61,17 @@ module Minitest
     def record(result)
       issue = Heat::Issue.new(result)
 
-      @results.record(issue)
-      @map.add(*issue.to_hit) if issue.hit?
+      results.record(issue)
+      map.add(*issue.to_hit) if issue.hit?
 
-      output.marker(issue.marker)
+      output.marker(issue.type)
     end
 
     # Outputs the summary of the run.
     def report
-      @results.stop_timer!
+      results.stop_timer!
 
+      # A couple of blank lines to create some breathing room
       output.newline
       output.newline
 
@@ -78,20 +79,20 @@ module Minitest
       #   pressing issues are displayed at the bottom of the report in order to reduce scrolling.
       #   This way, as you fix issues, the list gets shorter, and eventually the least critical
       #   issues will be displayed without scrolling once more problematic issues are resolved.
-      if results.failures.empty? && results.brokens.empty? && results.errors.empty? && results.skips.empty?
-        results.slows.each { |issue| output.issue_details(issue) }
+      %i[slows painfuls skips failures brokens errors].each do |issue_category|
+        results.send(issue_category).each { |issue| output.issue_details(issue) }
       end
 
-      if results.failures.empty? && results.brokens.empty? && results.errors.empty?
-        results.skips.each { |issue| output.issue_details(issue) }
-      end
-
-      results.failures.each { |issue| output.issue_details(issue) }
-      results.brokens.each { |issue| output.issue_details(issue) }
-      results.errors.each { |issue| output.issue_details(issue) }
-
+      # Display a short summary of the total issue counts fore ach category as well as performance
+      # details for the test suite as a whole
       output.compact_summary(results)
+
+      # If there were issues, shows a short heat map summary of which files and lines were the most
+      # common sources of issues
       output.heat_map(map)
+
+      # A blank line to create some breathing room
+      output.newline
     end
 
     # Did this run pass?

data/minitest-heat.gemspec

@@ -21,8 +21,6 @@ Gem::Specification.new do |spec|
   spec.metadata['source_code_uri'] = 'https://github.com/garrettdimon/minitest-heat'
   spec.metadata['wiki_uri'] = 'https://github.com/garrettdimon/minitest-heat/wiki'
 
-
-
   # Specify which files should be added to the gem when it is released.
   # The `git ls-files -z` loads the files in the RubyGem that have been added into git.
   spec.files = Dir.chdir(File.expand_path(__dir__)) do
@@ -34,7 +32,11 @@ Gem::Specification.new do |spec|
 
   spec.add_runtime_dependency 'minitest'
 
+  spec.add_development_dependency 'awesome_print'
   spec.add_development_dependency 'dead_end'
   spec.add_development_dependency 'pry'
+  spec.add_development_dependency 'rubocop'
+  spec.add_development_dependency 'rubocop-minitest'
+  spec.add_development_dependency 'rubocop-rake'
   spec.add_development_dependency 'simplecov'
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: minitest-heat
 version: !ruby/object:Gem::Version
-  version: 0.0.5
+  version: 0.0.6
 platform: ruby
 authors:
 - Garrett Dimon
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2021-09-13 00:00:00.000000000 Z
+date: 2021-10-08 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: minitest
@@ -24,6 +24,20 @@ dependencies:
     - - ">="
       - !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: dead_end
   requirement: !ruby/object:Gem::Requirement
@@ -52,6 +66,48 @@ dependencies:
     - - ">="
       - !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:
+    - - ">="
+      - !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
@@ -75,6 +131,7 @@ extensions: []
 extra_rdoc_files: []
 files:
 - ".gitignore"
+- ".rubocop.yml"
 - ".travis.yml"
 - CODE_OF_CONDUCT.md
 - Gemfile
@@ -86,14 +143,16 @@ files:
 - bin/setup
 - lib/minitest/heat.rb
 - lib/minitest/heat/backtrace.rb
+- lib/minitest/heat/hit.rb
 - lib/minitest/heat/issue.rb
+- lib/minitest/heat/line.rb
 - lib/minitest/heat/location.rb
 - lib/minitest/heat/map.rb
 - lib/minitest/heat/output.rb
 - lib/minitest/heat/output/backtrace.rb
 - lib/minitest/heat/output/issue.rb
-- lib/minitest/heat/output/location.rb
 - lib/minitest/heat/output/map.rb
+- lib/minitest/heat/output/marker.rb
 - lib/minitest/heat/output/results.rb
 - lib/minitest/heat/output/source_code.rb
 - lib/minitest/heat/output/token.rb
@@ -128,7 +187,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.1.4
+rubygems_version: 3.1.6
 signing_key:
 specification_version: 4
 summary: Presents test results in a visual manner to guide you to where to look first.

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

@@ -1,20 +0,0 @@
-# frozen_string_literal: true
-
-module Minitest
-  module Heat
-    class Output
-      class Location
-        attr_accessor :location
-
-        def initialize(location)
-          @location = location
-        end
-
-        def tokens
-        end
-
-        private
-      end
-    end
-  end
-end