minitest-heat 1.0.0 → 1.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 887dc01f3a08341f1e88cb24b539d0843cdce81fdb49246fbce8af875ff00d3f
-  data.tar.gz: 875d197ab5c65c2cb85b192201375be653ba30da2fc91896b4a3e61702cacefd
+  metadata.gz: cf4115aeb375e2fef72d98e7f706dc023ae1e61fa9d1fc3e8f490797a31e2ae0
+  data.tar.gz: ba968646ff2b12fa2891b47fb58d2d98330d117c2a038e29f1caef449bfbd857
 SHA512:
-  metadata.gz: 6ef73c9df5b91b5950cc444f6ea7a18ccd867bda4fbdb015b8d713eaebe91b925a2cfb48b596a43a0d36af023dcb04f5c8ec0803602ab27bf709372fe6f9b0f3
-  data.tar.gz: d338944e9d32e8ec326cce9dbe861c5b8bec408bb455e4e984d45567ef9d9c5af9154f4475c2862ddc43778c95d8e58f12beef8757aa37f6b76d91da1b17a4c5
+  metadata.gz: 67a7e17e10fe0f75f5a5cad93bd97a7f4f87e136e6dfe6f338b0e8df0e80f83533d8e70b07e218fc0431e3e7c5bbdc2d14f71c8c3d32a98d846f276cb573f225
+  data.tar.gz: 2a0cb94a433fe5b69bef58cd4fe24393adaad5bf69e76120b9296a3f8224b2e9a55da10e176bb0fa13e228e3aa57f0836d61fe0ca8116bd973681cc7e458912f

data/.github/FUNDING.yml

@@ -0,0 +1,3 @@
+# These are supported funding model platforms
+
+github: garrettdimon

data/.github/workflows/main.yml

@@ -0,0 +1,23 @@
+name: Ruby
+
+on: [push,pull_request]
+
+env:
+  CI: true
+
+jobs:
+  build:
+    strategy:
+      matrix:
+        os: [ubuntu-latest, macos-latest]
+        ruby: [2.5.9, 2.6.9, 2.7.5, 3.0.3, 3.1.0-preview1]
+    runs-on: ubuntu-latest
+    steps:
+    - uses: actions/checkout@v2
+    - name: Set up Ruby
+      uses: ruby/setup-ruby@v1
+      with:
+        ruby-version: ${{ matrix.ruby }}
+        bundler-cache: true
+    - name: Run Tests
+      run: bundle exec rake

data/CHANGELOG.md

@@ -0,0 +1,17 @@
+## [Unreleased]
+
+Nothing at the moment.
+
+## [1.1.0] - 2021-12-09
+
+The biggest update is that the slow thresholds are now configurable.
+
+- Configurable Thresholds
+- Fixed a bug where `vendor/bundle` gem files were considered project source code files
+- Set up [GitHub Actions](https://github.com/garrettdimon/minitest-heat/actions) to ensure tests are run on Ubuntu latest and macOs for the [latest Ruby versions](https://github.com/garrettdimon/minitest-heat/blob/main/.github/workflows/main.yml)
+- Fixed some tests that were accidentally left path-dependent and couldn't pass on other machines
+
+## [1.0.0] - 2021-12-01
+
+Initial release.
+

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    minitest-heat (1.0.0)
+    minitest-heat (1.1.0)
       minitest
 
 GEM

data/README.md

@@ -1,39 +1,9 @@
 # 🔥 Minitest::Heat 🔥
 Minitest::Heat helps you identify problems faster so you can more efficiently resolve test failures. It does this through a few different methods.
 
-It collects failures and inspects backtraces to identify patterns and provide a heat map summary of the files and line numbers that most frequently appear to be the causes of issues.
+For a more detailed explanation of Minitest Heat with screenshots, [head over the wiki for the full story](https://github.com/garrettdimon/minitest-heat/wiki).
 
-![Example Heat Map Displayed by Minitest Heat](https://raw.githubusercontent.com/garrettdimon/minitest-heat/main/examples/map.png)
-
-It suppresses less critical issues like skips or slows when there are legitimate failures. It won't display information about slow tests unless all tests are passing (meaning no errors, failures, or skips)
-
-It presents failures differently depending on the context of failure. For instance, it treats exceptions differently based on whether they arose directly from a test or from source code. It also treats extremely slow tests differently from moderately slow tests.
-
-Markers get some nuance so that slow tests receive different markers than standard passing tests, and exception-triggered failures get different markers for source-code triggered exceptions (E) and test-triggered exceptions ('B' for 'Broken Test').
-
-![Example Markers Displayed by Minitest Heat](https://raw.githubusercontent.com/garrettdimon/minitest-heat/main/examples/markers.png)
-
-It also formats the failure details and backtraces to make them more scannable by emphasizing the project-relates lines from the backtrace.
-
-It intelligently recognizes when an exception was raised from a test defintion vs. when an exception is genuinely triggered from the source code in order to help focus on fixing deeper exceptions first.
-
-![Example Exceptions Displayed by Minitest Heat](https://raw.githubusercontent.com/garrettdimon/minitest-heat/main/examples/exceptions.png)
-
-Failures are displayed ina  fairly predictable manner but formatted to show the source code from the test so you can see the assertion that failed in addition to the summary of values that didn't satisfy the assertion.
-
-![Example Failures Displayed by Minitest Heat](https://raw.githubusercontent.com/garrettdimon/minitest-heat/main/examples/failures.png)
-
-Skipped tests are displayed in a simple manner as well so that it's easy to see the source of the skipped test as well as the reason it was skipped.
-
-![Example Skips Displayed by Minitest Heat](https://raw.githubusercontent.com/garrettdimon/minitest-heat/main/examples/skips.png)
-
-Slow tests get slightly more informative labels to indicate that they did pass, but they could use performance improvements. Tests that are particularly slow are called out with a little more emphasis so it's easier to focus on really slow tests first as they frequently represent the most potential for performance gains.
-
-![Example Slows Displayed by Minitest Heat](https://raw.githubusercontent.com/garrettdimon/minitest-heat/main/examples/slows.png)
-
-It also always displays the most significant issues at the bottom of the list in order to reduce the need to scroll up through the test failures. As you fix issues, the list becomes shorter, and the less significant issues will make there way to the bottom and be visible without scrolling.
-
-For some additional insight about priorities and how it works, this [Twitter thread](https://twitter.com/garrettdimon/status/1432703746526560266) is currently the best place to start.
+Or for some additional insight about priorities and how it works, this [Twitter thread](https://twitter.com/garrettdimon/status/1432703746526560266) is a good read.
 
 ## Installation
 Add this line to your application's Gemfile:
@@ -57,7 +27,18 @@ require 'minitest/heat'
 ```
 
 ## Configuration
-Minitest Heat doesn't currently offer a significant set of configuration options, but it will eventually support customizing the thresholds for "Slow" and "Painfully Slow". By default, it considers anything over 1.0s to be 'slow' and anything over 3.0s to be 'painfully slow'.
+Minitest Heat doesn't currently offer a significant set of configuration options, but the thresholds for "Slow" and "Painfully Slow" tests can be adjusted. By default, it considers anything over 1.0s to be 'slow' and anything over 3.0s to be 'painfully slow'.
+
+You can add a configuration block to your `test_helper.rb` file after the `require 'minitest/heat'` line.
+
+For example:
+
+```ruby
+Minitest::Heat.configure do |config|
+  config.slow_threshold = 0.01
+  config.painfully_slow_threshold = 0.5
+end
+```
 
 ## Development
 After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake test` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.

data/lib/minitest/heat/configuration.rb

@@ -0,0 +1,18 @@
+# frozen_string_literal: true
+
+require 'forwardable'
+
+module Minitest
+  module Heat
+    # For managing configuration options on how Minitest Heat should handle results
+    class Configuration
+      attr_accessor :slow_threshold,
+                    :painfully_slow_threshold
+
+      def initialize
+        @slow_threshold = 1.0
+        @painfully_slow_threshold = 3.0
+      end
+    end
+  end
+end

data/lib/minitest/heat/issue.rb

@@ -120,18 +120,14 @@ module Minitest
       #
       # @return [Float] number of seconds after which a test is considered slow
       def slow_threshold
-        # Using a method here so that this can eventually be configurable such that the constant is
-        # only a fallback value if it's not specified anywhere else
-        SLOW_THRESHOLDS[:slow]
+        Minitest::Heat.configuration.slow_threshold || SLOW_THRESHOLDS[:slow]
       end
 
       # The number, in seconds, for a test to be considered "painfully slow"
       #
       # @return [Float] number of seconds after which a test is considered painfully slow
       def painfully_slow_threshold
-        # Using a method here so that this can eventually be configurable such that the constant is
-        # only a fallback value if it's not specified anywhere else
-        SLOW_THRESHOLDS[:painful]
+        Minitest::Heat.configuration.painfully_slow_threshold || SLOW_THRESHOLDS[:painful]
       end
 
       # Determines if a test should be considered slow by comparing it to the low end definition of

data/lib/minitest/heat/location.rb

@@ -131,9 +131,16 @@ module Minitest
 
       # Determines if a given file is from the project directory
       #
-      # @return [Boolean] true if the file is in the project (source code or test)
+      # @return [Boolean] true if the file is in the project (source code or test) but not vendored
       def project_file?
-        path.include?(project_root_dir)
+        path.include?(project_root_dir) && !bundled_file?
+      end
+
+      # Determines if the file is in the project `vendor/bundle` directory.
+      #
+      # @return [Boolean] true if the file is in `<project_root>/vendor/bundle
+      def bundled_file?
+        path.include?("#{project_root_dir}/vendor/bundle")
       end
 
       # Determines if a given file follows the standard approaching to naming test files.
@@ -145,9 +152,9 @@ module Minitest
 
       # Determines if a given file is a non-test file from the project directory
       #
-      # @return [Boolean] true if the file is in the project but not a test file
+      # @return [Boolean] true if the file is in the project but not a test file or vendored file
       def source_code_file?
-        project_file? && !test_file?
+        project_file? && !test_file? && !bundled_file?
       end
 
       # A safe interface to getting the last modified time for the file in question

data/lib/minitest/heat/version.rb

@@ -2,6 +2,6 @@
 
 module Minitest
   module Heat
-    VERSION = '1.0.0'
+    VERSION = '1.1.0'
   end
 end

data/lib/minitest/heat.rb

@@ -1,5 +1,6 @@
 # frozen_string_literal: true
 
+require_relative 'heat/configuration'
 require_relative 'heat/backtrace'
 require_relative 'heat/hit'
 require_relative 'heat/issue'
@@ -32,5 +33,20 @@ module Minitest
   # Pulls from minitest-color as well:
   #   https://github.com/teoljungberg/minitest-color/blob/master/lib/minitest/color_plugin.rb
   module Heat
+    class << self
+      attr_writer :configuration
+    end
+
+    def self.configuration
+      @configuration ||= Configuration.new
+    end
+
+    def self.reset
+      @configuration = Configuration.new
+    end
+
+    def self.configure
+      yield(configuration)
+    end
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: minitest-heat
 version: !ruby/object:Gem::Version
-  version: 1.0.0
+  version: 1.1.0
 platform: ruby
 authors:
 - Garrett Dimon
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2021-12-01 00:00:00.000000000 Z
+date: 2021-12-09 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: minitest
@@ -130,9 +130,12 @@ executables: []
 extensions: []
 extra_rdoc_files: []
 files:
+- ".github/FUNDING.yml"
+- ".github/workflows/main.yml"
 - ".gitignore"
 - ".rubocop.yml"
 - ".travis.yml"
+- CHANGELOG.md
 - CODE_OF_CONDUCT.md
 - Gemfile
 - Gemfile.lock
@@ -141,15 +144,10 @@ files:
 - Rakefile
 - bin/console
 - bin/setup
-- examples/exceptions.png
-- examples/failures.png
-- examples/map.png
-- examples/markers.png
-- examples/skips.png
-- examples/slows.png
 - lib/minitest/heat.rb
 - lib/minitest/heat/backtrace.rb
 - lib/minitest/heat/backtrace/line_parser.rb
+- lib/minitest/heat/configuration.rb
 - lib/minitest/heat/hit.rb
 - lib/minitest/heat/issue.rb
 - lib/minitest/heat/location.rb