minitest-reporters-json_reporter 0.9.5 → 0.9.12

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 637cb5c4cf030085c3cf5ea997be1ebb130de915
-  data.tar.gz: 4aab5a9632c88573f94b1a8daf1cd3388e667662
+  metadata.gz: e0789166d0fc2d9eb234eea4ce73bd63c29777f8
+  data.tar.gz: c746180dbe9a3389819b6eee0f5f36cea99a119c
 SHA512:
-  metadata.gz: 2da26b20f88627614a9a142ba19cc8a2a45844342d6c1bdfef840c27bdfd0ff29a81ca0aaa5572c6ac5e0d7cf73e5c7f826ffcd07b2c2bf097f2e2b566029096
-  data.tar.gz: 7700f3b089c870d03f72e4c5891789bf00f5ea8f551a5fd1794075287e6796b1be4178743ccd95401b760190ea6adf7a113ecccfc04d8d6f31d0696450509307
+  metadata.gz: 7ddb553f9d9e94b239e5d6655c03b34a27590119b40294b85f036e33149b9329771d8f0f1ed4adf70e70bffcbfe2fce1a85e20e9d34dc802508af2f6e3deb868
+  data.tar.gz: 7c870a868a1f3badf3c5e1f703efb61e9bbb6dc4bf229d3d5bd5734356a20e8679c56cd08c186feb3f898c9df43c7c004a2946fbd4c9220a610be3e39a1e4629

data/.codeclimate.yml

@@ -0,0 +1,28 @@
+# codeclimate.yml
+engines:
+  rubocop:
+    enabled: true
+    #checks:
+    # Rubocop/Metrics/ClassLength:
+    #   enabled: false
+  brakeman:
+    enabled: true
+    #exclude_fingerprints:
+    #- 08c185b3f764f262539a1f76997d3a89
+  duplication:
+    enabled: true
+    config:
+      languages:
+      - ruby
+        #mass_threshold: 30
+ratings:
+  paths:
+  - app/**
+  - lib/**
+  - "**.rb"
+  - "**.go"
+exclude_paths:
+- spec/**/*
+- "**/vendor/**/*"
+- "**/docs/**/*"
+

data/.coveralls.yml

@@ -0,0 +1 @@
+service_name: travis-ci

data/.gitignore

@@ -3,6 +3,7 @@
 /Gemfile.lock
 /_yardoc/
 /coverage/
+/test/coverage/
 /pkg/
 /spec/reports/
 /tmp/

data/.travis.yml

@@ -7,3 +7,13 @@ rvm:
 #- 1.9.3
 #- jruby-19mode
 #- rbx-2
+
+
+notifications:
+  email:
+    recipients:
+      - ed.howland@gmail.com
+
+    on_success: always
+    on_failure: always
+

data/Develop.md

@@ -0,0 +1,11 @@
+# Develop
+
+A place to put development resources.
+
+## Resources
+
+### Links
+
+[Coveralls](https://coveralls.io/github/edhowland/minitest-reporters-json_reporter)
+Where this repo is listed on the Coveralls repo page for coverage statistics, trends, etc.
+

data/Gemfile

@@ -5,5 +5,5 @@ gemspec
 
 group :development do
   gem 'minitest-reporters', '~> 1.1.8'
+  gem 'coveralls', require: false
 end
-

data/README.md

@@ -2,19 +2,26 @@
 
 This is an extension  gem for the minitest-reporters gem. It adds JSON output as an output format.
 
-[![Gem Version](https://badge.fury.io/rb/minitest-reporters-json_reporter.svg)][gem]
+[![Gem Version](https://badge.fury.io/rb/minitest-reporters-json_reporter.svg)](https://badge.fury.io/rb/minitest-reporters-json_reporter)
 [![Build Status](https://travis-ci.org/edhowland/minitest-reporters-json_reporter.png?branch=master)](https://travis-ci.org/edhowland/minitest-reporters-json_reporter)
-
+[![Coverage Status](https://coveralls.io/repos/github/edhowland/minitest-reporters-json_reporter/badge.svg?branch=master)](https://coveralls.io/github/edhowland/minitest-reporters-json_reporter?branch=master)
+[![Code Climate](https://codeclimate.com/github/edhowland/minitest-reporters-json_reporter/badges/gpa.svg)](https://codeclimate.com/github/edhowland/minitest-reporters-json_reporter)
+[![Inline docs](http://inch-ci.org/github/edhowland/minitest-reporters-json_reporter.svg?style=shields)](http://inch-ci.org/github/edhowland/minitest-reporters-json_reporter)
 
 
 ## Abstract
 
 You can use this gem to interface Minitest output into automated tools like CI, CD or IDEs or code editors. An
 example interface might be to the Atom editor: [https://atom.io](https://atom.io)
+
+Use of JSON as a format for test runs opens up possibilities for different types of analysis.
+You can organize the output based on elapsed time or number of assertions of tests, for example.
+See the 'jq sort' example below.
+
 I originally wrote this gem to interface to the Viper audible  code editor for the blind community. See: [https://github.com/edhowland/viper](https://github.com/edhowland/viper)
 Using this gem with Viper also requires the 'viper_ruby' package. See [https://github.com/edhowland/viper_ruby](https://github.com/edhowland/viper_ruby)
 
-## Version 0.9.5
+## Version 0.9.12
 
 ## Installation
 
@@ -117,7 +124,7 @@ $ ruby report_spec.rb | jq .
   "status": {    "code": "Failed",    "color": "red"  },
   "metadata": {
     "generated_by": "Minitest::Reporters::JsonReporter",
-    "version": "0.9.5",
+    "version": "0.9.12",
     "ruby_version": "2.2.2",
     "ruby_patchlevel": 95,
     "ruby_platform": "x86_64-linux",
@@ -182,6 +189,59 @@ $ ruby report_spec.rb | jq .
 
 ```
 
+## Example analysis feedback
+
+JSON can be parsed and manipulated to provide many types of useful information.
+Below are some example usages.
+We use the 'jq' program to parse and select and arrange the output.
+The version of 'jq' is 1.5. It can be downloaded/install instructions here: [Download JQ](https://stedolan.github.io/jq/download/)
+See: [JQ Developer Manual](https://stedolan.github.io/jq/manual/)
+
+
+
+### Sort by time, slowest first
+
+This sort would show you the slowest tests first, getting faster further down the array.
+Similar to Minitest::Reporters::MeanTimeReporter which produces a report summary showing the slowest running tests.
+
+
+```
+$ ruby timings_spec.rb  --verbose | jq '.passes | sort_by(.time) | reverse[] | .name, .time'
+"test_0001_should be slow"
+5.001584862009622
+"test_0003_should be slightly faster"
+1.0003409570199437
+"test_0002_should be fast"
+2.9060000088065863e-05
+```
+
+### Group By Class example
+
+Minitest usually runs your tests in a random sequence. This is
+great for test isolation and to check for state bleed-thru, but can be annoying if trying 
+to determine where similar tests are failing. You can use the jq 'sort_by' or 'group_by' filters to get them back in 
+some semblace of order.
+
+Here we group the .fails[] array by their class name. (The file: 'group_by_spec.rb' 
+contains 4 tests inside 2 classes.)
+
+```
+$ ruby group_by_spec.rb |jq '.fails | group_by(.class) | flatten[] | .class, .name'
+"TestNumericalGroup"
+"test_4_times_6_equals_24"
+"TestNumericalGroup"
+"test_positive_integers_are_greater_than_0"
+"TestStringGroup"
+"test_string_is_hello_world"
+"TestStringGroup"
+"test_value_length_equals_2"
+```
+
+Note the above result is an array of 2 arrays grouped by the .class key.
+
+
+
+
 ## Customizing the JSON format
 
 You can adjust the contents of the returned JSON by sub-classing the Minitest::Reporters::JsonReporter class.
@@ -221,7 +281,7 @@ Note: Extra credit if git flow feature branching was used.
 
 * Code: [https://github.com/edhowland/minitest-reporters-json_reporter](https://github.com/edhowland/minitest-reporters-json_reporter)
 * Bugs: [https://github.com/edhowland/minitest-reporters-json_reporter/issues](https://github.com/edhowland/minitest-reporters-json_reporter/issues)
-* Docs: [http://www.rubydoc.info/gems/minitest-reporters-json_reporter/0.9.5](http://www.rubydoc.info/gems/minitest-reporters-json_reporter/0.9.5)
+* Docs: [http://www.rubydoc.info/gems/minitest-reporters-json_reporter/0.9.12](http://www.rubydoc.info/gems/minitest-reporters-json_reporter/0.9.5)
 * Gem: [https://rubygems.org/gems/minitest-reporters-json_reporter](https://rubygems.org/gems/minitest-reporters-json_reporter)
 
 ###### Feedback

data/Rakefile

@@ -11,4 +11,4 @@ task :yard do
   sh 'yardoc -o ./doc'
 end
 
-task :default => [:test]
+task default:  [:test]

data/lib/minitest/reporters/json_reporter/version.rb

@@ -8,7 +8,7 @@ module Minitest
     class JsonReporter < BaseReporter
       ##
       # Version of the Minitest::Reporters::JsonReporter gem.
-      VERSION = '0.9.5'.freeze
+      VERSION = '0.9.12'.freeze
     end
   end
 end

data/lib/minitest/reporters/json_reporter.rb

@@ -67,6 +67,8 @@ module Minitest
         h
       end
 
+      ##
+      # Returns the statushash portion of the output.
       def status_h
         {
           code: ['Failed', 'Passed with skipped tests', 'Success'][color_i],
@@ -98,6 +100,8 @@ module Minitest
         end
       end
 
+      ##
+      # Returns the metadata hash portion of the output.
       def metadata_h
         {
           generated_by: self.class.name,
@@ -110,6 +114,9 @@ module Minitest
         }
       end
 
+      ##
+      # Transforms the options hash part of the metadata object to represent the
+      # 'io' object as the string 'STDOUT' if it is $stdout.
       def transform(opts)
         o = opts.clone
         o[:io] = o[:io].class.name
@@ -117,6 +124,8 @@ module Minitest
         o
       end
 
+      ##
+      # Returns the statistics hash object as part of the output.
       def statistics_h
         {
           total: count,
@@ -128,6 +137,8 @@ module Minitest
         }
       end
 
+      ##
+      # Returns the timings hash object as part of the output.
       def timings_h
         {
           total_seconds: total_time,
@@ -136,11 +147,16 @@ module Minitest
         }
       end
 
+      ##
+      # Returns the fails array of failure or error hash objects as part of
+      # the output.
       def failures_h
         tests.reject { |e| e.skipped? || e.passed? || e.failure.nil? }
              .map { |e| failure_h(e) }
       end
 
+      ##
+      # Returns either a failed_h or error_h given a result (test).
       def failure_h(result)
         if result.error?
           error_h(result)
@@ -149,6 +165,9 @@ module Minitest
         end
       end
 
+      ##
+      # Returns the error hash object given a result (test) as part of the
+      # fails[] array.
       def error_h(result)
         h = result_h(result, 'error')
         h[:message] = result.failure.message
@@ -157,6 +176,8 @@ module Minitest
         h
       end
 
+      ##
+      # Returns the failure hash object given a result (test).
       def failed_h(result)
         h = result_h(result, 'failed')
         h[:message] = result.failure.message
@@ -164,10 +185,14 @@ module Minitest
         h
       end
 
+      ##
+      # Returns the skips[] array object as part of the output.
       def skips_h
         tests.select(&:skipped?).map { |e| skip_h(e) }
       end
 
+      ##
+      # Returns the formatted skip hash object given a result (test).
       def skip_h(result)
         h = result_h(result, 'skipped')
         h[:message] = result.failure.message
@@ -175,10 +200,16 @@ module Minitest
         h
       end
 
+      ##
+      # Returns the passes[] array object as part of the output.
       def passes_h
         tests.select(&:passed?).map { |e| result_h(e, 'passed') }
       end
 
+      ##
+      # Returns the common part of a result hash.
+      # Given a type string and a result (test).
+      # Includes the type, the class, the name and the time of the result.
       def result_h(result, type)
         {
           type: type,
@@ -189,6 +220,9 @@ module Minitest
         }
       end
 
+      ##
+      # Returns the location (pathname:line_number) of the line that produced
+      # the failure or error.
       def location(exception)
         last_before_assertion = ''
 

data/minitest-reporters-json_reporter.gemspec

@@ -2,11 +2,10 @@
 lib = File.expand_path('../lib', __FILE__)
 $LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
 
-
 # Must hard code the exact version number because of circular dependency
 Gem::Specification.new do |spec|
   spec.name          = 'minitest-reporters-json_reporter'
-  spec.version       = '0.9.5'
+  spec.version       = '0.9.12'
   spec.authors       = ['edhowland']
   spec.email         = ['ed.howland@gmail.com']
 

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: minitest-reporters-json_reporter
 version: !ruby/object:Gem::Version
-  version: 0.9.5
+  version: 0.9.12
 platform: ruby
 authors:
 - edhowland
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2016-05-09 00:00:00.000000000 Z
+date: 2016-05-24 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: minitest-reporters
@@ -67,12 +67,15 @@ executables: []
 extensions: []
 extra_rdoc_files: []
 files:
+- ".codeclimate.yml"
+- ".coveralls.yml"
 - ".gitignore"
 - ".rubocop.yml"
 - ".travis.yml"
 - Announcement.txt
 - CODE_OF_CONDUCT.md
 - CONTRIBUTING.md
+- Develop.md
 - Gemfile
 - LICENSE.txt
 - README.md