minitest-heat 0.0.7 → 0.0.11

data/lib/minitest/heat_plugin.rb

@@ -2,25 +2,17 @@
 
 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
-      # Heat.show_fast!
-    end
-
-    # TODO: options.
-    # 1. Fail Fast
-    # 2. Don't worry about skips.
-    # 3. Skip coverage.
-  end
-
+module Minitest # rubocop:disable Style/Documentation
   def self.plugin_heat_init(options)
-    io = options[:io]
+    io = options.fetch(:io, $stdout)
 
-    # Clean out the existing reporters.
-    reporter.reporters = []
+    reporter.reporters.reject! do |reporter|
+      # Minitest Heat acts as a unified Progress *and* Summary reporter. Using other reporters of
+      # those types in conjunction with it creates some overly-verbose output
+      reporter.is_a?(ProgressReporter) || reporter.is_a?(SummaryReporter)
+    end
 
-    # Use Reviewer as the sole reporter.
-    reporter << HeatReporter.new(io, options)
+    # Hook up Reviewer
+    self.reporter.reporters << HeatReporter.new(io, options)
   end
 end

data/lib/minitest/heat_reporter.rb

@@ -32,15 +32,15 @@ module Minitest
     attr_reader :output,
                 :options,
                 :timer,
-                :results,
-                :map
+                :results
 
     def initialize(io = $stdout, options = {})
+      super()
+
       @options = options
 
       @timer =    Heat::Timer.new
       @results =  Heat::Results.new
-      @map =      Heat::Map.new
       @output =   Heat::Output.new(io)
     end
 
@@ -64,32 +64,37 @@ module Minitest
     def record(result)
       # Convert a Minitest Result into an "issue" to more consistently expose the data needed to
       # adjust the failure output to the type of failure
-      issue = Heat::Issue.new(result)
+      issue = Heat::Issue.from_result(result)
+
+      # Note the number of assertions for the performance summary
+      timer.increment_counts(issue.assertions)
 
-      timer.increment_counts(issue.result.assertions)
+      # Record the issue to show details later
       results.record(issue)
-      map.add(*issue.to_hit) if issue.hit?
 
+      # Show the marker
       output.marker(issue.type)
+    rescue StandardError => e
+      display_exception_guidance(e)
     end
 
-    # Outputs the summary of the run.
-    def report
-      timer.stop!
-
-      # A couple of blank lines to create some breathing room
+    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}:"
+      exception.backtrace.each do |line|
+        puts "  #{line}"
+      end
       output.newline
+    end
 
-      # Issues start with the least critical and go up to the most critical so that the most
-      #   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.
-      %i[slows painfuls skips failures brokens errors].each do |issue_category|
-        next unless show?(issue_category)
+    # Outputs the summary of the run.
+    def report
+      timer.stop!
 
-        results.send(issue_category).each { |issue| output.issue_details(issue) }
-      end
+      # The list of individual issues and their associated details
+      output.issues_list(results)
 
       # Display a short summary of the total issue counts fore ach category as well as performance
       # details for the test suite as a whole
@@ -97,9 +102,9 @@ module Minitest
 
       # 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)
+      output.heat_map(results)
 
-      # A blank line to create some breathing room
+      output.newline
       output.newline
     end
 
@@ -107,23 +112,5 @@ module Minitest
     def passed?
       results.errors.empty? && results.failures.empty?
     end
-
-    private
-
-    def no_problems?
-      !results.problems?
-    end
-
-    def no_problems_or_skips?
-      !results.problems? && !results.skips.any?
-    end
-
-    def show?(issue_category)
-      case issue_category
-      when :skips            then no_problems?
-      when :painfuls, :slows then no_problems_or_skips?
-      else true
-      end
-    end
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: minitest-heat
 version: !ruby/object:Gem::Version
-  version: 0.0.7
+  version: 0.0.11
 platform: ruby
 authors:
 - Garrett Dimon
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2021-10-14 00:00:00.000000000 Z
+date: 2021-11-15 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: minitest
@@ -143,10 +143,11 @@ files:
 - bin/setup
 - lib/minitest/heat.rb
 - lib/minitest/heat/backtrace.rb
+- lib/minitest/heat/backtrace/line_parser.rb
 - lib/minitest/heat/hit.rb
 - lib/minitest/heat/issue.rb
-- lib/minitest/heat/line.rb
 - lib/minitest/heat/location.rb
+- lib/minitest/heat/locations.rb
 - lib/minitest/heat/map.rb
 - lib/minitest/heat/output.rb
 - lib/minitest/heat/output/backtrace.rb
@@ -188,7 +189,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.1.6
+rubygems_version: 3.2.22
 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/line.rb

@@ -1,74 +0,0 @@
-# frozen_string_literal: true
-
-require 'forwardable'
-
-module Minitest
-  module Heat
-    # Represents a line of code from the project and provides convenient access to information about
-    #  the line for displaying in test results
-    class Line
-      attr_accessor :pathname, :number, :container
-      alias line_number number
-
-      def initialize(pathname:, number:, container: nil)
-        @pathname = Pathname(pathname)
-        @number = number.to_i
-        @container = container.to_s
-      end
-
-      # Convenient interface to read a line from a backtrace convert it to usable components
-      def self.parse_backtrace(raw_text)
-        raw_pathname, raw_line_number, raw_container = raw_text.split(':')
-        raw_container = raw_container.delete_prefix('in `').delete_suffix("'")
-
-        new(pathname: raw_pathname, number: raw_line_number, container: raw_container)
-      end
-
-      def to_s
-        "#{location} in `#{container}`"
-      end
-
-      def path
-        pathname.exist? ? pathname.dirname : UNRECOGNIZED
-      end
-
-      def file
-        pathname.exist? ? pathname.basename : UNRECOGNIZED
-      end
-
-      def mtime
-        pathname.exist? ? pathname.mtime : UNKNOWN_MODIFICATION_TIME
-      end
-
-      def age_in_seconds
-        pathname.exist? ? seconds_ago : UNKNOWN_MODIFICATION_SECONDS
-      end
-
-      def location
-        "#{pathname}:#{number}"
-      end
-
-      def short_location
-        "#{file}:#{number}"
-      end
-
-      def source_code(max_line_count: 1)
-        Minitest::Heat::Source.new(
-          pathname.to_s,
-          line_number: line_number,
-          max_line_count: max_line_count
-        )
-      end
-
-      private
-
-      UNRECOGNIZED = '(Unrecognized File)'
-      UNKNOWN_MODIFICATION_TIME = Time.at(0)
-      UNKNOWN_MODIFICATION_SECONDS = -1
-
-      def seconds_ago
-        (Time.now - mtime).to_i
-      end
-    end
-  end
-end