minitest-heat 0.0.1

data/lib/minitest/heat/source.rb

@@ -0,0 +1,149 @@
+# frozen_string_literal: true
+
+module Minitest
+  module Heat
+    # Gets the most relevant lines of code surrounding the specified line of code
+    class Source
+      attr_reader :filename
+
+      attr_accessor :line_number, :max_line_count, :context
+
+      CONTEXTS = %i[before around after].freeze
+
+      def initialize(filename, line_number:, max_line_count: 1, context: :around)
+        @filename = filename
+        @line_number = Integer(line_number)
+        @max_line_count = max_line_count
+        @context = context
+      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
+
+      # 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
+
+      # Looks up the available lines of code around the referenced line number
+      #
+      # @return [Array<String>] the range of lines of code around
+      def lines
+        return [line] if max_line_count == 1
+
+        file_lines[(line_numbers.first - 1)..(line_numbers.last - 1)]
+      end
+
+      # 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
+
+      # Reads (and chomps) the lines of the target file
+      #
+      # @return [type] [description]
+      def file_lines
+        @raw_lines ||= File.readlines("#{Dir.pwd}#{filename}", chomp: true)
+        @raw_lines.pop while @raw_lines.last.strip.empty?
+
+        @raw_lines
+      end
+
+      private
+
+      # The largest possible value for line numbers
+      #
+      # @return [Integer] the last line number of the file
+      def max_line_number
+        file_lines.length
+      end
+
+      # The number of the first line of code to return
+      #
+      # @return [Integer] line number
+      def first_line_number
+        target = line_number - first_line_offset - leftover_trailing_lines_count
+
+        # Can't go earlier than the first line
+        target < 1 ? 1 : target
+      end
+
+      # The number of the last line of code to return
+      #
+      # @return [Integer] line number
+      def last_line_number
+        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
+      end
+
+      # The target number of preceding lines to include
+      #
+      # @return [Integer] number of preceding lines to include
+      def first_line_offset
+        case context
+        when :before then other_lines_count
+        when :around then preceding_lines_split_count
+        when :after then 0
+        end
+      end
+
+      # The target number of trailing lines to include
+      #
+      # @return [Integer] number of trailing lines to include
+      def last_line_offset
+        case context
+        when :before then 0
+        when :around then trailing_lines_split_count
+        when :after then other_lines_count
+        end
+      end
+
+      # If the preceding lines offset takes_it past the beginning of the file, this provides the
+      # total number of lines that weren't used
+      #
+      # @return [Integer] number of preceding lines that don't exist
+      def leftover_preceding_lines_count
+        target_line_number = line_number - first_line_offset
+
+        target_line_number < 1 ? target_line_number.abs + 1 : 0
+      end
+
+      # If the trailing lines offset takes_it past the end of the file, this provides the total
+      # number of lines that weren't used
+      #
+      # @return [Integer] number of trailing lines that don't exist
+      def leftover_trailing_lines_count
+        target_line_number = line_number + last_line_offset
+
+        target_line_number > max_line_number ? target_line_number - max_line_number : 0
+      end
+
+      # The total number of lines to include in addition to the primary line
+      def other_lines_count
+        max_line_count - 1
+      end
+
+      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
+
+      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
+    end
+  end
+end

data/lib/minitest/heat/version.rb

@@ -0,0 +1,5 @@
+module Minitest
+  module Heat
+    VERSION = "0.0.1"
+  end
+end

data/lib/minitest/heat.rb

@@ -0,0 +1,32 @@
+# frozen_string_literal: true
+
+require_relative 'heat/backtrace'
+require_relative 'heat/issue'
+require_relative 'heat/location'
+require_relative 'heat/map'
+require_relative 'heat/output'
+require_relative 'heat/results'
+require_relative 'heat/source'
+require_relative 'heat/version'
+
+module Minitest
+  # Custom minitest reporter just for Reviewer. Focuses on printing directly actionable guidance.
+  # - Colorize the Output
+  # - What files had the most errors?
+  # - Show the most impacted areas first.
+  # - Show lowest-level (most nested code) frist.
+  #
+  # Pulls from existing reporters:
+  #   https://github.com/seattlerb/minitest/blob/master/lib/minitest.rb#L554
+  #
+  # Lots of insight from:
+  #   http://www.monkeyandcrow.com/blog/reading_ruby_minitest_plugin_system/
+  #
+  # And a good example available at:
+  #   https://github.com/adamsanderson/minitest-snail
+  #
+  # Pulls from minitest-color as well:
+  #   https://github.com/teoljungberg/minitest-color/blob/master/lib/minitest/color_plugin.rb
+  module Heat
+  end
+end

data/lib/minitest/heat_plugin.rb

@@ -0,0 +1,26 @@
+# frozen_string_literal: true
+
+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
+
+  def self.plugin_heat_init(options)
+    io = options[:io]
+
+    # Clean out the existing reporters.
+    self.reporter.reporters = []
+
+    # Use Reviewer as the sole reporter.
+    self.reporter << HeatReporter.new(io, options)
+  end
+end

data/lib/minitest/heat_reporter.rb

@@ -0,0 +1,99 @@
+# frozen_string_literal: true
+
+require_relative "heat"
+
+module Minitest
+  # Custom minitest reporter to proactively identify likely culprits in test failures by focusing on
+  #   the files and line numbers with the most issues and that were most recently modified. It also
+  #   visually emphasizes results based on the most significant problems.
+  #   1. Errors - Anything that raised an exception could have significant ripple effects.
+  #   2. Failures - Assuming no exceptions, these are kind of important.
+  #   -- Everything else...
+  #   3. Coverage (If using Simplecov) - If things are passing but coverage isn't up to par
+  #   4. Skips - Don't want to skip tests.
+  #   5. Slows (If everything good, but there's )
+  # - Colorize the Output
+  # - What files had the most errors?
+  # - Show the most impacted areas first.
+  # - Show lowest-level (most nested code) frist.
+  #
+  # Pulls from existing reporters:
+  #   https://github.com/seattlerb/minitest/blob/master/lib/minitest.rb#L554
+  #
+  # Lots of insight from:
+  #   http://www.monkeyandcrow.com/blog/reading_ruby_minitest_plugin_system/
+  #
+  # And a good example available at:
+  #   https://github.com/adamsanderson/minitest-snail
+  #
+  # 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
+    end
+
+    # Starts reporting on the run.
+    def start
+      output.puts
+      output.puts
+      @results.start_timer!
+    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
+
+    # 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
+    end
+
+    # Outputs the summary of the run.
+    def report
+      @results.stop_timer!
+
+      output.newline
+      output.newline
+
+      # 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.
+      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) }
+
+      output.compact_summary(results)
+
+      output.heat_map(map)
+    end
+
+    # Did this run pass?
+    def passed?
+      results.errors.empty? && results.failures.empty?
+    end
+  end
+end

data/minitest-heat.gemspec

@@ -0,0 +1,39 @@
+# frozen_string_literal: true
+
+require_relative 'lib/minitest/heat/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = 'minitest-heat'
+  spec.version       = Minitest::Heat::VERSION
+  spec.authors       = ['Garrett Dimon']
+  spec.email         = ['email@garrettdimon.com']
+
+  spec.summary       = 'Presents test results in a visual manner to guide you to where to look first.'
+  spec.description   = 'Presents test results in a visual manner to guide you to where to look first.'
+  spec.homepage      = 'https://github.com/garrettdimon/minitest-heat'
+  spec.license       = 'MIT'
+  spec.required_ruby_version = Gem::Requirement.new('>= 2.5.9')
+
+  spec.metadata['homepage_uri'] = spec.homepage
+  spec.metadata['bug_tracker_uri'] = 'https://github.com/garrettdimon/minitest-heat/issues'
+  spec.metadata['changelog_uri'] = 'https://github.com/garrettdimon/minitest-heat/CHANGELOG.md'
+  spec.metadata['documentation_uri'] = 'https://www.rubydoc.info/gems/minitest-heat'
+  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
+    `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
+  end
+  spec.bindir        = 'exe'
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ['lib']
+
+  spec.add_runtime_dependency 'minitest'
+
+  spec.add_development_dependency 'pry'
+  spec.add_development_dependency 'simplecov'
+end

metadata

@@ -0,0 +1,114 @@
+--- !ruby/object:Gem::Specification
+name: minitest-heat
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- Garrett Dimon
+autorequire:
+bindir: exe
+cert_chain: []
+date: 2021-08-26 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: minitest
+  requirement: !ruby/object:Gem::Requirement
+    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: pry
+  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
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+description: Presents test results in a visual manner to guide you to where to look
+  first.
+email:
+- email@garrettdimon.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".travis.yml"
+- CODE_OF_CONDUCT.md
+- Gemfile
+- Gemfile.lock
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- lib/minitest/heat.rb
+- lib/minitest/heat/backtrace.rb
+- lib/minitest/heat/issue.rb
+- lib/minitest/heat/location.rb
+- lib/minitest/heat/map.rb
+- lib/minitest/heat/output.rb
+- lib/minitest/heat/results.rb
+- lib/minitest/heat/source.rb
+- lib/minitest/heat/version.rb
+- lib/minitest/heat_plugin.rb
+- lib/minitest/heat_reporter.rb
+- minitest-heat.gemspec
+homepage: https://github.com/garrettdimon/minitest-heat
+licenses:
+- MIT
+metadata:
+  homepage_uri: https://github.com/garrettdimon/minitest-heat
+  bug_tracker_uri: https://github.com/garrettdimon/minitest-heat/issues
+  changelog_uri: https://github.com/garrettdimon/minitest-heat/CHANGELOG.md
+  documentation_uri: https://www.rubydoc.info/gems/minitest-heat
+  source_code_uri: https://github.com/garrettdimon/minitest-heat
+  wiki_uri: https://github.com/garrettdimon/minitest-heat/wiki
+post_install_message:
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 2.5.9
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.1.4
+signing_key:
+specification_version: 4
+summary: Presents test results in a visual manner to guide you to where to look first.
+test_files: []