minitest-bender 0.0.3 → 1.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 07494f6c231ff2de7a071fd6927d4e4084593d5db749d9f29eab51274e536322
-  data.tar.gz: 6e0a7fdc255cd9a6effbbe701739ebd850ae50d003aac8aaafdab7d154cddcae
+  metadata.gz: 49e6e3621dfce3e4fea0607c005dba7865a7619e62d7391b715ac883cf2a43a5
+  data.tar.gz: 7566d1731c3ad37d5124ba48f87300fb1875b63108681c06f34966fa36e06100
 SHA512:
-  metadata.gz: 7391d8c06ad48f013e43ecad0bc5504973a447d4668b9e23cffb45cb19820895226b1c1db38af78ecf8fb5e97d91cfd47c753e363f86bd035f0cd3d7b1be0e8a
-  data.tar.gz: 6a0b1d44d864fe758e15ffce2182e9b579285cafcd72c11800856ef2fab08d159cd76dc221abf80fa71c88e0a8f4e6268e6170507541dc66ff08fee9b96d8518
+  metadata.gz: 511ca6879fa694f7195a86bdea865c213796a8e5bf2d3d05c438b6a1bb028fd9a57c7d5c103bee7572c1515603b279d71cc8018f28fe28067c46c516f2629549
+  data.tar.gz: b2c7a9517be2b69455620ba1c4a871d921d53dc09c37a9d27a11009035a7112ff528e1fe4bb2be147774114320235839eebd53034391e6f31ee4813739fe8dd9

data/CHANGELOG.md

@@ -6,6 +6,19 @@ All notable changes to this project will be documented in this file. This projec
 
 * Your contribution here!
 
+## [1.0.0][] (2020-07-19)
+
+Thanks to [cboos](https://github.com/cboos) for contributing some of these enhancements!
+
+* Two-step activation for better interoperability with other reporters
+* Seven different recorders to choose from, five of which display a progress bar
+* New "overview" section with sorted test results, enabled by default
+* Skips, failures and errors are consistently sorted
+* Irrelevant portions of backtraces are hidden by default
+* Many configurable options such as visible sections and custom colors
+* Graceful degradation of colors in console environments with poor support for them
+* Smarter rerun command generation
+
 ## [0.0.3][] (2019-06-09)
 
 * Fixed running time format of slow tests
@@ -20,6 +33,7 @@ All notable changes to this project will be documented in this file. This projec
 * Initial release
 
 [Semver]: http://semver.org
-[Unreleased]: https://github.com/eugeniobruno/minitest-bender/compare/v0.0.2...HEAD
+[Unreleased]: https://github.com/eugeniobruno/minitest-bender/compare/v1.0.0...HEAD
+[1.0.0]: https://github.com/eugeniobruno/minitest-bender/compare/v0.0.3...v1.0.0
 [0.0.3]: https://github.com/eugeniobruno/minitest-bender/compare/v0.0.2...v0.0.3
 [0.0.2]: https://github.com/eugeniobruno/minitest-bender/compare/v0.0.1...v0.0.2

data/Gemfile

@@ -1,4 +1,4 @@
 source 'https://rubygems.org'
 
-# Specify your gem's dependencies in openhouse.gemspec
+# Specify your gem's dependencies in minitest-bender.gemspec
 gemspec

data/README.md

@@ -3,7 +3,7 @@
 [![Gem Version](https://badge.fury.io/rb/minitest-bender.svg)](https://badge.fury.io/rb/minitest-bender)
 [![Code Climate](https://codeclimate.com/github/eugeniobruno/minitest-bender.svg)](https://codeclimate.com/github/eugeniobruno/minitest-bender)
 
-My own Minitest reporter, without blackjack but with a hook.
+A comprehensive Minitest reporter.
 
 ## Installation
 
@@ -23,24 +23,55 @@ Or install it yourself as:
 
 ## Usage
 
-Require this plugin right after Minitest:
+Require this plugin right after Minitest, and then enable it explicitly:
 
 ```ruby
 require 'minitest/autorun'
 require 'minitest/bender'
+Minitest::Bender.enable!
 ```
 
 That's it! The next time you run your tests, a new report format will be used instead of the default one.
 
+Instead of calling the `enable!` method, you can also specify the `--bender` test option, e.g.
+
+    $ rake test TESTOPTS="--bender"
+
+In both of these cases, Bender is activated with its default configuration. You can refer to [bender_plugin.rb](https://github.com/eugeniobruno/minitest-bender/blob/master/lib/minitest/bender_plugin.rb) or [configuration.rb](https://github.com/eugeniobruno/minitest-bender/blob/master/lib/minitest-bender/configuration.rb) to explore the multitude of options available to customize the output.
+
+As an example, let's say your test suite takes several minutes to run, so you want to see detailed output in realtime. This behaviour is provided by a particular recorder called "progress_verbose", which is not the default one. In order to select this recorder for your app/gem, you can activate Bender like this instead:
+
+```ruby
+Minitest::Bender.enable!({ recorder: :progress_verbose })
+```
+
+You can also set configuration options via environment variables:
+
+    $ BENDER_RECORDER=progress_verbose rake test
+
+Finally, command-line options also work:
+
+    $ rake test TESTOPTS="--bender-recorder=progress_verbose"
+
+Bear in mind that setting a configuration option does not automatically enable the reporter, so remember to either call the `enable!` method, or to include the `--bender` argument.
+
+If you use [minitest-reporters](https://github.com/kern/minitest-reporters) and have it installed and activated, you can select the `BenderReporter` as (one of the) reporters:
+
+    $ MINITEST_REPORTER=BenderReporter,HtmlReporter rake test
+
+
 ## Features
 
-Based on [minitest-colorin](https://github.com/gabynaiman/minitest-colorin/), the minitest-bender reporter offers you colored output including:
+Originally based on [minitest-colorin](https://github.com/gabynaiman/minitest-colorin/), the minitest-bender reporter offers you, out of the box, colored output including:
 
-* Status, running time, name and message for each test/expectation, grouped by class/context
-* Details of skips, failures and errors in three different sections, with diffs, backtraces and commands to rerun each single test
-* Details of the top 3 slowest tests, if they may be relevant
+* A progress bar, mostly useful for long-running suites, as the default of many different recorders
+* Status, running time, name and message for each test/expectation, grouped by class/context and sorted by name
+* Details of skips, failures and errors, with diffs, backtraces and commands to rerun each single test
+* Details of the slowest tests, if they may be relevant
 * The same basic statistics of the default reporter
 
+If the NO_COLOR environment variable is set, Bender will output non-colored text honoring [this standard](https://no-color.org/), thanks to the [paint gem](https://github.com/janlelis/paint/) dependency.
+
 
 ## Development
 

data/lib/minitest-bender/colorizer.rb

@@ -0,0 +1,61 @@
+# frozen_string_literal: true
+
+ENV['ANSICON'] ||= 'Y' if ENV['ConEmuANSI'] != 'ON'
+require 'paint'
+
+module MinitestBender
+  class Colorizer
+    COLORS = {              # Xterm No. - Xterm Name
+      pass:       '87ff87', # 120       - LightGreen
+      skip:       '5fd7ff', # 81        - SteelBlue1
+      fail:       'ff5f5f', # 203       - IndianRed1
+      error:      'ffd75f', # 221       - LightGoldenrod2
+      tests:      '5fafaf', # 73        - CadetBlue
+      assertions: 'd75fd7', # 170       - Orchid
+      time:       '878787', # 102       - Grey53
+      number:     '5fafaf', # 73        - CadetBlue
+      backtrace:  'af8787'  # 138       - RosyBrown
+    }
+
+    # In compatibility modes, colors that are mapped to black are avoided.
+    SAFE_COLORS = {
+      pass:       '00ff5f', # 47        - SpringGreen2
+      tests:      'blue',
+      time:       'gray',
+      number:     'gray',
+      backtrace:  'gray'
+    }
+    COLORS.merge!(SAFE_COLORS) if Paint.mode < 256
+
+    COLORS.freeze
+
+    class << self
+      def custom_colors=(custom_colors)
+        @custom_colors = custom_colors
+      end
+
+      def colorize(string, color, *args)
+        if color == :normal
+          Paint[string, *args]
+        else
+          color_value = colors.fetch(color)
+          Paint[string, color_value, *args]
+        end
+      end
+
+      def color_keys
+        COLORS.keys
+      end
+
+      private
+
+      def colors
+        @colors ||= COLORS.merge(custom_colors)
+      end
+
+      def custom_colors
+        @custom_colors || {}
+      end
+    end
+  end
+end

data/lib/minitest-bender/configuration.rb

@@ -0,0 +1,174 @@
+module MinitestBender
+  class Configuration
+    DEFAULT_CONFIG = {
+      mode: :oblivious,
+      recorder: :progress,
+      sections: [:overview, :time_ranking, :issues, :activity, :suite_status],
+      sections_blacklist: [],
+      overview_sort_key: :name,
+      time_ranking_size: 5,
+      backtrace_view: :user,
+      rerun_command_stem: defined?(Rake) ? 'rake' : 'ruby',
+      custom_colors: {}
+    }.freeze
+
+    def initialize
+      @client_config = {}
+      @options_config = {}
+    end
+
+    def add_client_config(config)
+      validate_config(config)
+      client_config.merge!(config)
+    end
+
+    def mode=(mode)
+      options_config[:mode] = mode
+    end
+
+    def recorder=(recorder)
+      options_config[:recorder] = recorder
+    end
+
+    def sections=(sections)
+      options_config[:sections] = sections
+    end
+
+    def sections_blacklist=(sections_blacklist)
+      options_config[:sections_blacklist] = sections_blacklist
+    end
+
+    def overview_sort_key=(overview_sort_key)
+      options_config[:overview_sort_key] = overview_sort_key
+    end
+
+    def time_ranking_size=(time_ranking_size)
+      options_config[:time_ranking_size] = time_ranking_size
+    end
+
+    def backtrace_view=(backtrace_view)
+      options_config[:backtrace_view] = backtrace_view
+    end
+
+    def rerun_command_stem=(rerun_command_stem)
+      options_config[:rerun_command_stem] = rerun_command_stem
+    end
+
+    def set_custom_color(color_key, color)
+      options_config[:custom_colors] ||= {}
+      options_config[:custom_colors][color_key] = color
+    end
+
+    def cooperative?
+      final_config.fetch(:mode) == :cooperative
+    end
+
+    def recorder
+      final_config.fetch(:recorder)
+    end
+
+    def sections
+      sections_whitelist - sections_blacklist
+    end
+
+    def overview_sort_key
+      final_config.fetch(:overview_sort_key)
+    end
+
+    def time_ranking_size
+      final_config.fetch(:time_ranking_size)
+    end
+
+    def backtrace_view
+      final_config.fetch(:backtrace_view)
+    end
+
+    def rerun_command_stem
+      final_config.fetch(:rerun_command_stem)
+    end
+
+    def custom_colors
+      final_config.fetch(:custom_colors)
+    end
+
+    private
+
+    attr_reader :client_config, :options_config
+
+    def validate_config(config)
+      invalid_options = config.keys.map(&:to_sym) - valid_options
+      unless invalid_options.empty?
+        first_invalid_option = invalid_options.first
+        message = "invalid option: '#{first_invalid_option}'"
+        raise ArgumentError, message
+      end
+    end
+
+    def valid_options
+      default_config.keys
+    end
+
+    def parsed_list(list)
+      strings = list.is_a?(Array) ? list.map(&:to_s) : list.split(',')
+      strings.map { |s| s.strip.to_sym }
+    end
+
+    def default_config
+      DEFAULT_CONFIG
+    end
+
+    def env_config
+      {
+        mode: ENV['BENDER_MODE'],
+        recorder: ENV['BENDER_RECORDER'],
+        sections: ENV['BENDER_SECTIONS'],
+        sections_blacklist: ENV['BENDER_SECTIONS_BLACKLIST'],
+        overview_sort_key: ENV['BENDER_OVERVIEW_SORT_KEY'],
+        time_ranking_size: ENV['BENDER_TIME_RANKING_SIZE'],
+        backtrace_view: ENV['BENDER_BACKTRACE_VIEW'],
+        rerun_command_stem: ENV['BENDER_RERUN_COMMAND_STEM'],
+        custom_colors: custom_colors_env_config
+      }
+    end
+
+    def custom_colors_env_config
+      Colorizer.color_keys.each_with_object({}) do |color_key, h|
+        h[color_key] = ENV["BENDER_#{color_key.upcase}_COLOR"]
+      end
+    end
+
+    def merged_config
+      [default_config, client_config, env_config, options_config].reduce do |acum, config|
+        proper_config = Utils.with_symbolized_keys(Utils.without_nil_values(config))
+        acum.merge(proper_config) do |key, old_val, new_val|
+          if key == :custom_colors
+            old_val.merge(Utils.with_symbolized_keys(Utils.without_nil_values(new_val)))
+          else
+            new_val
+          end
+        end
+      end
+    end
+
+    def final_config
+      merged_config.tap do |config|
+        config[:mode] = config[:mode].to_sym
+        config[:recorder] = config[:recorder].to_sym
+        config[:sections] = parsed_list(config[:sections])
+        config[:sections_blacklist] = parsed_list(config[:sections_blacklist])
+        config[:overview_sort_key] = config[:overview_sort_key].to_sym
+        config[:time_ranking_size] = config[:time_ranking_size].to_i
+        config[:rerun_command_stem] = config[:rerun_command_stem].to_s
+        config[:backtrace_view] = config[:backtrace_view].to_sym
+      end
+    end
+
+    def sections_whitelist
+      final_config.fetch(:sections)
+    end
+
+    def sections_blacklist
+      final_config.fetch(:sections_blacklist)
+    end
+  end
+end

data/lib/minitest-bender/printers/plain.rb

@@ -0,0 +1,29 @@
+module MinitestBender
+  module Printers
+    class Plain
+      def initialize(io)
+        @io = io
+      end
+
+      def print(string)
+        io.print(string)
+      end
+
+      def print_line(line = '')
+        io.puts(line)
+      end
+
+      def print_lines(lines)
+        lines.each { |line| print_line(line) }
+      end
+
+      def advance
+        # do nothing
+      end
+
+      private
+
+      attr_reader :io
+    end
+  end
+end

data/lib/minitest-bender/printers/with_progress_bar.rb

@@ -0,0 +1,115 @@
+# coding: utf-8
+# frozen_string_literal: true
+
+require 'tty-progressbar'
+
+module MinitestBender
+  module Printers
+    class WithProgressBar
+      COMPLETE_ICON = ' '
+      HEAD_ICON = 'ᗧ'
+      INCOMPLETE_ICON = '•'
+      ELAPSED_ICON = '⏱'
+      ETA_ICON = '⌛'
+
+      def initialize(io, total)
+        @io = io
+        @total = total
+        @bar = new_bar
+      end
+
+      def print(string)
+        io.print(string)
+      end
+
+      def print_line(line = '')
+        if io.tty?
+          bar.log(line)
+        else
+          io.puts(line)
+        end
+      end
+
+      def print_lines(lines)
+        lines.each { |line| print_line(line) }
+      end
+
+      def advance
+        bar.update({ head: head })
+        bar.advance(1, { counters_sym => counters })
+      end
+
+      private
+
+      attr_reader :io, :bar, :total
+
+      def new_bar
+        TTY::ProgressBar.new(bar_format_string, {
+          total: total,
+          width: [total, TTY::ProgressBar.max_columns].max,
+          complete: complete_icon,
+          head: head_icon,
+          incomplete: incomplete_icon
+        })
+      end
+
+      def bar_format_string
+        ":bar #{Colorizer.colorize(':current/:total', :tests)}  :#{counters_sym}  #{Colorizer.colorize(elapsed_icon + ' :elapsed', :time)}   #{Colorizer.colorize(eta_icon + ':eta', :time)}  #{Colorizer.colorize(':percent', :normal, :bold)}"
+      end
+
+      def counters
+        states.map do |state|
+          state.colored_icon_with_count(counters_padding_right)
+        end.join('  ')
+      end
+
+      def counters_sym
+        ('c' * counters_sym_length).to_sym
+      end
+
+      def counters_sym_length
+        ( 4 * (total.to_s.size + 1) ) + 6
+      end
+
+      def head
+        Colorizer.colorize(head_icon, head_color)
+      end
+
+      def complete_icon
+        COMPLETE_ICON
+      end
+
+      def head_icon
+        HEAD_ICON
+      end
+
+      def incomplete_icon
+        INCOMPLETE_ICON
+      end
+
+      def elapsed_icon
+        ELAPSED_ICON
+      end
+
+      def eta_icon
+        ETA_ICON
+      end
+
+      def head_color
+        reverse_states.find { |s| !s.results.empty? }.color
+      end
+
+      def states
+        @states ||= MinitestBender.states.values
+      end
+
+      def reverse_states
+        @reverse_states ||= states.reverse
+      end
+
+      def counters_padding_right
+        @counters_padding_right ||= total.to_s.size + 1
+      end
+    end
+  end
+end