minitest-summarize 0.0.2

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: e5d19e862386d46d91aece0676ffa467f564a5c0
+  data.tar.gz: f20714e5769844964c137783ac5b1e7bff13d269
+SHA512:
+  metadata.gz: e95c356c2f22d9a6f4784f9c2c158fbd3f92847d9fab3e76d95eee93283f0ccc986327c6af687b7ccfdcaf1162dd4ac6e39175f130b2bf99c16b60cd91d1b7f9
+  data.tar.gz: f54f01a442b80921354f58295d7ea53e79d3ebad885a29fefeea82b06c8e9139ad50afffacb430f042a5853fa6863403ecfa23c8295580683c9fbb25fb4c9712

data/LICENSE

@@ -0,0 +1,21 @@
+(The MIT License)
+
+Copyright © Randy Carnahan
+
+Permission is hereby granted, free of charge, to any person obtaining a copy of
+this software and associated documentation files (the 'Software'), to deal in
+the Software without restriction, including without limitation the rights to
+use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies
+of the Software, and to permit persons to whom the Software is furnished to do
+so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED 'AS IS', WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

data/README.md

@@ -0,0 +1,66 @@
+# Minitest Summarize
+
+I love Minitest. It's really helped me not just better understand BDD, but
+really dive into how the tests are run and so forth.
+
+The source for Minitest is **_really_** easy to read and understand.
+
+However, even despite some of my favorite output plugins making things nice,
+the one thing I got tired of was the long line of dots (or [emoji][1]!) so I
+decided to fix it.
+
+Thus, this Minitest plugin.
+
+## Description
+
+Instead of printing out the standard Minitest output per test, this will
+instead update a summary of the results, in color unless told not to use color.
+
+## Install
+
+```sh
+gem install minitest-summarize
+```
+
+## Usage
+
+```ruby
+require 'minitest/autorun'
+require 'minitest/summarize'
+```
+
+Then, when your tests are run, it'll display a summary before the results long
+form results:
+
+```text
+[Skipped: 1] [Passed: 30] [Failed 2] [Error: 0]
+
+Finished in 0.002814s, 11728.0541 runs/s, 11372.6586 assertions/s.
+
+  1) Failure:
+do some tests#test_0031_has some fails [/Users/rcarnahan/repos/minitest-summarize/spec/main_spec.rb:14]:
+Expected: 1
+  Actual: 0
+
+  2) Failure:
+do some tests#test_0032_has some fails [/Users/rcarnahan/repos/minitest-summarize/spec/main_spec.rb:14]:
+Expected: 2
+  Actual: 1
+
+  3) Skipped:
+do some tests#test_0033_has some skips [/Users/rcarnahan/repos/minitest-summarize/spec/main_spec.rb:20]:
+Skip #0
+```
+
+If you do not want to use color, then you must specify that before tests are
+run via the `no_color!` class method:
+
+```ruby
+Minitest::Summarize.no_color!
+```
+
+## License
+
+MIT.
+
+[1]: <https://github.com/tenderlove/minitest-emoji>

data/VERSION

@@ -0,0 +1 @@
+0.0.2

data/lib/minitest/summarize.rb

@@ -0,0 +1,3 @@
+require 'minitest'
+
+Minitest.load_plugins

data/lib/minitest/summarize_plugin.rb

@@ -0,0 +1,16 @@
+require 'minitest'
+
+require_relative './summarize_reporter'
+
+Minitest::SummarizeReporter.color!
+
+# Update Minitest with Plugin data.
+module Minitest
+  def self.plugin_summarize_init(options)
+    Minitest.reporter.reporters.clear
+
+    io = options[:io]
+
+    Minitest.reporter << SummarizeReporter.new(io)
+  end
+end

data/lib/minitest/summarize_reporter.rb

@@ -0,0 +1,125 @@
+# Add our customer reporter to the Minitest module.
+module Minitest
+  # Define our custom reporter.
+  class SummarizeReporter < Minitest::StatisticsReporter
+    SUMMARY_LABELS = {
+      '.' => 'Passed:',
+      'F' => 'Failed',
+      'E' => 'Error:',
+      'S' => 'Skipped:'
+    }.freeze
+
+    CODE_TO_COLOR = {
+      '.' => :green,
+      'F' => :red,
+      'E' => :red,
+      'S' => :blue
+    }.freeze
+
+    COLOR_CODE = {
+      red:    31,
+      green:  32,
+      blue:   34,
+      none:   0
+    }.freeze
+
+    STATS_FORMAT = 'Finished in %.6fs, %.4f runs/s, %.4f assertions/s.'.freeze
+
+    def self.color!
+      @color = true
+    end
+
+    def self.no_color!
+      @color = false
+    end
+
+    def self.color?
+      @color ||= true
+    end
+
+    def initialize(io)
+      super io
+
+      @io          = io
+      @summary     = {}
+      @last_length = 0
+
+      SUMMARY_LABELS.keys.each { |key| @summary[key] = 0 }
+    end
+
+    def record(result)
+      super
+
+      code = result.result_code
+
+      @summary[code] += 1
+
+      summarize_clear
+
+      @io.print generate_output
+    end
+
+    def report
+      super
+
+      io.puts "\n\n"
+      io.puts statistics
+      io.puts aggregated_results
+      io.puts "\n\n"
+    end
+
+    def statistics
+      format(STATS_FORMAT,
+             total_time, count / total_time,
+             assertions / total_time)
+    end
+
+    def aggregated_results
+      filtered_results = results.sort_by { |result| result.skipped? ? 1 : 0 }
+
+      filtered_results.each_with_index.map do |result, idx|
+        color = result.skipped? ? :yellow : :red
+        text  = format("\n%3d) %s", idx + 1, result)
+
+        self.class.color? ? colorize(color, text) : text
+      end.join + "\n"
+    end
+
+    def generate_output
+      list = []
+
+      SUMMARY_LABELS.each do |key, label|
+        value = @summary[key]
+
+        list.push format_string(key, label, value)
+      end
+
+      @last_format = list.join(' ')
+      @last_length = @last_format.length
+
+      @last_format + "\r"
+    end
+
+    def format_string(key, label, value)
+      str = "#{label} #{value}"
+
+      self.class.color? ? "[#{colorize_by_key(key, str)}]" : "[#{str}]"
+    end
+
+    def colorize_by_key(key, str)
+      code = CODE_TO_COLOR[key]
+
+      colorize(code, str)
+    end
+
+    def colorize(code, str)
+      "\e[#{COLOR_CODE[code]}m#{str}\e[0m"
+    end
+
+    def summarize_clear
+      @io.print ' ' * @last_length if @last_length
+      @io.print "\r"
+      @io.flush
+    end
+  end
+end

metadata

@@ -0,0 +1,49 @@
+--- !ruby/object:Gem::Specification
+name: minitest-summarize
+version: !ruby/object:Gem::Version
+  version: 0.0.2
+platform: ruby
+authors:
+- Randy Carnahan
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2018-10-12 00:00:00.000000000 Z
+dependencies: []
+description: Reduces the output from the standard Minitest run.
+email: syntruth@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- LICENSE
+- README.md
+- VERSION
+- lib/minitest/summarize.rb
+- lib/minitest/summarize_plugin.rb
+- lib/minitest/summarize_reporter.rb
+homepage: https://github.com/syntruth/minitest-summarize
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.5.1
+signing_key: 
+specification_version: 4
+summary: Minitest Summarize Reporter
+test_files: []