minitest-heat 0.0.2 → 0.0.6

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
@@ -49,8 +50,8 @@ module Minitest
         (assertion_count / total_time).round(2)
       end
 
-      def issues?
-        errors? || failures? || skips?
+      def problems?
+        errors? || brokens? || failures? || skips?
       end
 
       def errors
@@ -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,19 +102,21 @@ module Minitest
         skips.any?
       end
 
-      def count(result)
-        @test_count += 1
-        @assertion_count += result.assertions
-        @success_count += 1 if result.passed?
+      def painfuls?
+        painfuls.any?
       end
 
-      def record_issue(result)
-        issue = Heat::Issue.new(result)
+      def slows?
+        slows.any?
+      end
+
+      def record(issue)
+        @test_count += 1
+        @assertion_count += issue.result.assertions
+        @success_count += 1 if issue.result.passed?
 
         @issues[issue.type] ||= []
         @issues[issue.type] << issue
-
-        issue
       end
     end
   end

data/lib/minitest/heat/source.rb

@@ -51,10 +51,15 @@ module Minitest
       #
       # @return [type] [description]
       def file_lines
-        @raw_lines ||= File.readlines("#{Dir.pwd}#{filename}", chomp: true)
+        @raw_lines ||= File.readlines(filename, chomp: true)
         @raw_lines.pop while @raw_lines.last.strip.empty?
 
         @raw_lines
+      rescue Errno::ENOENT
+        # Occasionally, for a variety of reasons, a file can't be read. In those cases, it's best to
+        # return no source code lines rather than have the test suite raise an error unrelated to
+        # the code being tested becaues that gets confusing.
+        []
       end
 
       private

data/lib/minitest/heat/version.rb

@@ -1,5 +1,7 @@
+# frozen_string_literal: true
+
 module Minitest
   module Heat
-    VERSION = "0.0.2"
+    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,50 +29,49 @@ 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:
     #   https://github.com/seattlerb/minitest/blob/f4f57afaeb3a11bd0b86ab0757704cb78db96cf4/lib/minitest.rb#L504
     def record(result)
-      @results.count(result)
-      if !result.passed? || result.time > ::Minitest::Heat::Issue::SLOW_THRESHOLD
-        issue = @results.record_issue(result)
-        @map.add(*issue.to_hit)
-        output.marker(issue.marker)
-      else
-        output.marker(result.result_code)
-      end
+      issue = Heat::Issue.new(result)
+
+      results.record(issue)
+      map.add(*issue.to_hit) if issue.hit?
+
+      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
 
@@ -80,15 +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.
-      results.slows.each { |issue| output.issue_details(issue) }
-      results.skips.each { |issue| output.issue_details(issue) }
-      results.failures.each { |issue| output.issue_details(issue) }
-      results.brokens.each { |issue| output.issue_details(issue) }
-      results.errors.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
 
+      # 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,6 +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.2
+  version: 0.0.6
 platform: ruby
 authors:
 - Garrett Dimon
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2021-08-29 00:00:00.000000000 Z
+date: 2021-10-08 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: minitest
@@ -24,6 +24,34 @@ 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
+    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: pry
   requirement: !ruby/object:Gem::Requirement
@@ -38,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
@@ -61,6 +131,7 @@ extensions: []
 extra_rdoc_files: []
 files:
 - ".gitignore"
+- ".rubocop.yml"
 - ".travis.yml"
 - CODE_OF_CONDUCT.md
 - Gemfile
@@ -72,10 +143,19 @@ 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/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
 - lib/minitest/heat/results.rb
 - lib/minitest/heat/source.rb
 - lib/minitest/heat/version.rb
@@ -107,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.