minitest-reporters-json_reporter 0.9.12 → 1.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: e0789166d0fc2d9eb234eea4ce73bd63c29777f8
-  data.tar.gz: c746180dbe9a3389819b6eee0f5f36cea99a119c
+  metadata.gz: 137b4c93b51f77e64563dc73e0fee830b729473f
+  data.tar.gz: a0ca90654ccd75f2d10b5ef8fcb85764dca50d1f
 SHA512:
-  metadata.gz: 7ddb553f9d9e94b239e5d6655c03b34a27590119b40294b85f036e33149b9329771d8f0f1ed4adf70e70bffcbfe2fce1a85e20e9d34dc802508af2f6e3deb868
-  data.tar.gz: 7c870a868a1f3badf3c5e1f703efb61e9bbb6dc4bf229d3d5bd5734356a20e8679c56cd08c186feb3f898c9df43c7c004a2946fbd4c9220a610be3e39a1e4629
+  metadata.gz: cd1a72b03cd22c919dc614d3431d5489e2b74482fa7b30426d46b0da6f79590bed226281ed6fa79b4a72afc831c1737683c2af8ac68663e2da9775b231affbcc
+  data.tar.gz: eee8241a1c266566687ed8594c7b3262819b23db87970fb353c67ea23764a7360d4d341758763bc60ef9c060027be453c379e1f4932186e06f6305c0b1dff56f

data/.codeclimate.yml

@@ -24,5 +24,5 @@ ratings:
 exclude_paths:
 - spec/**/*
 - "**/vendor/**/*"
-- "**/docs/**/*"
+- "**/doc/**/*"
 

data/Announcement.txt

@@ -1,21 +1,17 @@
-minitest-reporters-json_reporter version 0.9.5 has been released.
+minitest-reporters-json_reporter version 1.0.0 has been released.
 
 Home, Code: https://github.com/edhowland/minitest-reporters-json_reporter
 Bugs: https://github.com/edhowland/minitest-reporters-json_reporter/issues
-Docs:http://www.rubydoc.info/gems/minitest-reporters-json_reporter/0.9.5
+Docs:http://www.rubydoc.info/gems/minitest-reporters-json_reporter/1.0.0
 
 minitest-reporters-json_reporter is an extension to the Ruby minitest-reporters gem that provides JSON output from your Minitest or MiniSpec test run.
-This version is the beta/release candidate before the official 1.0 version.
 
 Changes:
+o Badges! We have stinkin' badges.
+o Improved class/method documentation.
+o README.md contains better and more 'jq' examples.
 
-Rewritten to be:
-o conformant with Minitest::Reporters superclass.
-o Simpler and easy to customize.
-o More inclusive of elements from the Minitest test run.
-o Includes:
-  o Timings.
-  o Count of assertions.
+This version forms the foundation for the PR on the upstream minitest-reporters gem.
 
 Abstract
 
@@ -24,9 +20,14 @@ for Minitest, but no JSON format until now. If you want to hook up an IDE or som
 framework like a CI or CD tool, it is natural to send output in some parsable format like XML or JSON. This extension summarizes the result of
 a test run in  format like JSON.a test run in an easible consumable format.
 
+Another use case is doing data mining on your test runs. Using a tool like 'jq',
+you canspot trends, find long running tests and group test failures in some
+order.
 
-Usage is very simple. Just require 'minitest/reporters/json_reporter' in your test_helper.rb or spec_helper.rb.
-This gem also depends on 'minitest' and 'minitest/reporters'.  Then, you should also invoke the use! method of Minitest::Reporters class with a call to Minitest::Reporters::JsonReporter.new. 
+Usage is very simple. Just require 'minitest/reporters/json_reporter' in your 
+test_helper.rb or spec_helper.rb.
+Then, you should also invoke the use! method of Minitest::Reporters class
+with a call to Minitest::Reporters::JsonReporter.new. 
 Here is an example test_helper.rb:
 # ... Other requires
 

data/README.md

@@ -21,7 +21,7 @@ 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.12
+## Version 1.0.0
 
 ## Installation
 
@@ -124,7 +124,7 @@ $ ruby report_spec.rb | jq .
   "status": {    "code": "Failed",    "color": "red"  },
   "metadata": {
     "generated_by": "Minitest::Reporters::JsonReporter",
-    "version": "0.9.12",
+    "version": "1.0.0",
     "ruby_version": "2.2.2",
     "ruby_patchlevel": 95,
     "ruby_platform": "x86_64-linux",
@@ -237,10 +237,6 @@ $ ruby group_by_spec.rb |jq '.fails | group_by(.class) | flatten[] | .class, .na
 "test_value_length_equals_2"
 ```
 
-Note the above result is an array of 2 arrays grouped by the .class key.
-
-
-
 
 ## Customizing the JSON format
 
@@ -281,7 +277,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.12](http://www.rubydoc.info/gems/minitest-reporters-json_reporter/0.9.5)
+* Docs: [http://www.rubydoc.info/gems/minitest-reporters-json_reporter/1.0.0](http://www.rubydoc.info/gems/minitest-reporters-json_reporter/1.0.0)
 * Gem: [https://rubygems.org/gems/minitest-reporters-json_reporter](https://rubygems.org/gems/minitest-reporters-json_reporter)
 
 ###### Feedback

data/doc/Minitest.html

@@ -119,7 +119,7 @@
 </div>
 
     <div id="footer">
-  Generated on Tue May  3 20:15:41 2016 by
+  Generated on Wed May 25 22:22:25 2016 by
   <a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
   0.8.7.6 (ruby-2.2.2).
 </div>

data/doc/Minitest/Reporters.html

@@ -120,7 +120,7 @@ href="https://github.com/kern/minitest-reporters">github.com/kern/minitest-repor
 </div>
 
     <div id="footer">
-  Generated on Tue May  3 20:15:41 2016 by
+  Generated on Wed May 25 22:22:25 2016 by
   <a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
   0.8.7.6 (ruby-2.2.2).
 </div>

data/doc/Minitest/Reporters/JsonReporter.html

@@ -134,7 +134,7 @@ editor.</p>
 
 </div>
         </dt>
-        <dd><pre class="code"><span class='tstring'><span class='tstring_beg'>&#39;</span><span class='tstring_content'>0.2.1</span><span class='tstring_end'>&#39;</span></span><span class='period'>.</span><span class='id identifier rubyid_freeze'>freeze</span></pre></dd>
+        <dd><pre class="code"><span class='tstring'><span class='tstring_beg'>&#39;</span><span class='tstring_content'>1.0.0</span><span class='tstring_end'>&#39;</span></span><span class='period'>.</span><span class='id identifier rubyid_freeze'>freeze</span></pre></dd>
       
     </dl>
   
@@ -270,12 +270,12 @@ E.g. :verbose =&gt; true</p>
       <pre class="lines">
 
 
+21
 22
-23
-24</pre>
+23</pre>
     </td>
     <td>
-      <pre class="code"><span class="info file"># File 'lib/minitest/reporters/json_reporter.rb', line 22</span>
+      <pre class="code"><span class="info file"># File 'lib/minitest/reporters/json_reporter.rb', line 21</span>
 
 <span class='kw'>def</span> <span class='id identifier rubyid_initialize'>initialize</span><span class='lparen'>(</span><span class='id identifier rubyid_options'>options</span> <span class='op'>=</span> <span class='lbrace'>{</span><span class='rbrace'>}</span><span class='rparen'>)</span>
   <span class='kw'>super</span>
@@ -318,12 +318,12 @@ E.g. :verbose =&gt; true</p>
       <pre class="lines">
 
 
+27
 28
-29
-30</pre>
+29</pre>
     </td>
     <td>
-      <pre class="code"><span class="info file"># File 'lib/minitest/reporters/json_reporter.rb', line 28</span>
+      <pre class="code"><span class="info file"># File 'lib/minitest/reporters/json_reporter.rb', line 27</span>
 
 <span class='kw'>def</span> <span class='id identifier rubyid_storage'>storage</span>
   <span class='ivar'>@storage</span>
@@ -367,16 +367,16 @@ of to_h to JSON and calls io.write to output it.</p>
       <pre class="lines">
 
 
+32
 33
 34
 35
 36
 37
-38
-39</pre>
+38</pre>
     </td>
     <td>
-      <pre class="code"><span class="info file"># File 'lib/minitest/reporters/json_reporter.rb', line 33</span>
+      <pre class="code"><span class="info file"># File 'lib/minitest/reporters/json_reporter.rb', line 32</span>
 
 <span class='kw'>def</span> <span class='id identifier rubyid_report'>report</span>
   <span class='kw'>super</span>
@@ -395,7 +395,7 @@ of to_h to JSON and calls io.write to output it.</p>
 </div>
 
     <div id="footer">
-  Generated on Tue May  3 20:15:41 2016 by
+  Generated on Wed May 25 22:22:25 2016 by
   <a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
   0.8.7.6 (ruby-2.2.2).
 </div>

data/doc/_index.html

@@ -131,7 +131,7 @@
 </div>
 
     <div id="footer">
-  Generated on Tue May  3 20:15:41 2016 by
+  Generated on Wed May 25 22:22:25 2016 by
   <a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
   0.8.7.6 (ruby-2.2.2).
 </div>

data/doc/file.README.html

@@ -65,15 +65,25 @@
 
 <p>This is an extension  gem for the minitest-reporters gem. It adds JSON output as an output format.</p>
 
-<p>[<img src="https://badge.fury.io/rb/minitest-reporters-json_reporter.svg" alt="Gem Version">][gem]</p>
+<p><a href="https://badge.fury.io/rb/minitest-reporters-json_reporter"><img src="https://badge.fury.io/rb/minitest-reporters-json_reporter.svg" alt="Gem Version"></a>
+<a href="https://travis-ci.org/edhowland/minitest-reporters-json_reporter"><img src="https://travis-ci.org/edhowland/minitest-reporters-json_reporter.png?branch=master" alt="Build Status"></a>
+<a href="https://coveralls.io/github/edhowland/minitest-reporters-json_reporter?branch=master"><img src="https://coveralls.io/repos/github/edhowland/minitest-reporters-json_reporter/badge.svg?branch=master" alt="Coverage Status"></a>
+<a href="https://codeclimate.com/github/edhowland/minitest-reporters-json_reporter"><img src="https://codeclimate.com/github/edhowland/minitest-reporters-json_reporter/badges/gpa.svg" alt="Code Climate"></a>
+<a href="http://inch-ci.org/github/edhowland/minitest-reporters-json_reporter"><img src="http://inch-ci.org/github/edhowland/minitest-reporters-json_reporter.svg?style=shields" alt="Inline docs"></a></p>
 
 <h2>Abstract</h2>
 
 <p>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: <a href="https://atom.io">https://atom.io</a>
-I originally wrote this gem to interface to the Viper audible  code editor for the blind community. See: <a href="https://github.com/edhowland/viper">https://github.com/edhowland/viper</a></p>
+example interface might be to the Atom editor: <a href="https://atom.io">https://atom.io</a></p>
 
-<h2>Version 0.2.1</h2>
+<p>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 &#39;jq sort&#39; example below.</p>
+
+<p>I originally wrote this gem to interface to the Viper audible  code editor for the blind community. See: <a href="https://github.com/edhowland/viper">https://github.com/edhowland/viper</a>
+Using this gem with Viper also requires the &#39;viper_ruby&#39; package. See <a href="https://github.com/edhowland/viper_ruby">https://github.com/edhowland/viper_ruby</a></p>
+
+<h2>Version 1.0.0</h2>
 
 <h2>Installation</h2>
 
@@ -108,29 +118,151 @@ I originally wrote this gem to interface to the Viper audible  code editor for t
 
 <h2>Object Summary</h2>
 
-<ol>
-<li>status -  Status of the overall test run. Can be &#39;Success&#39;, &#39;Passed with skipped tests&#39; or &#39;Failed&#39;. There also a color attribute: green, yellow or red - respectfully.</li>
-<li>metadata - General information about this test run. Includes generator name, version and the test run completion time in UTC formatted in ISO8601 format. Also include options object computed by super classes including command line arguments.</li>
-<li>statistics - Contains the total number of runs, the number of assertions, the number of fails, skips and passes.</li>
-<li>Timings - Including total_seconds, runs_per_second and assertions_per_second in float format</li>
-<li>fails - Array of failed or errored tests. Each object herein contains the information of each test, its name, class, error message, number of assertions, the timing and location of the test and the filtered backtrace array if an error type.</li>
-</ol>
-
-<h3>Optional objects</h3>
-
-<p>If the &#39;--verbose&#39; flag was passed on the command line or the options[:verbose]  = true was passed to the constructor
-you will get 2 additional objects: skips[] and passes[]</p>
-
-<ol>
-<li>skips[] - Information about the skipped test including its message, number of assertions, the time to run the skip and location.</li>
-<li>passes[] - Information for all passed test runs including the type, the test name, class, the number of assertions and timing.</li>
-</ol>
+<ul>
+<li>status of the overall test run. Object.
+
+<ul>
+<li>code - Success, Passed with skipped tests or Failed. String.</li>
+<li>color green, yellow or red. String.</li>
+</ul></li>
+<li>metadata The metadata of this particular test run. Object.
+
+<ul>
+<li>generated_by Class name of the Minitest Reporter. Will usually be Minitest::Reporters::JsonReporter. String.</li>
+<li>version - Version of the minitest-reporters-json_reporter gem. String.</li>
+<li>ruby_version - RUBY_VERSION. String.</li>
+<li>ruby_patchlevel - RUBY_PATCHLEVEL. Integer.</li>
+<li>ruby_platform - RUBY_PLATFORM. String.</li>
+<li>time - Time of test run in UTC and ISO-8601 format. String.</li>
+<li>options - Options object as constructed by passed options, superclasses and command line args. Object.</li>
+<li>io - The class name of the IO object. Will be the string &#39;STDOUT&#39; if equal to $stdout. String.</li>
+<li>keys of the options hash, if any. Various key/value pairs.</li>
+<li>args Array of arguments passed to the program. Array of String.</li>
+<li>total_count - Total number of tests ran. Integer.</li>
+</ul></li>
+<li>statisticsThe accumulated counts for this test run.   Object.
+
+<ul>
+<li>total Number of total runs. Integer.</li>
+<li>assertions Count of assertions performed. Integer.</li>
+<li>failures Number of failed tests. Integer.</li>
+<li>errors Number of errors encountered. Integer.</li>
+<li>skips Number of skipped tests. Integer.</li>
+<li>passes Number of passed tests. Integer.</li>
+</ul></li>
+<li>timings Object containing the computed timing information for the entire test run. Object.
+
+<ul>
+<li>total_seconds total number of seconds for the entire test run. Float.</li>
+<li>runs_per_second Averaged number of runs per second. Float.</li>
+<li>assertions_per_second Averaged number of assertions per second. Float.</li>
+</ul></li>
+<li>fails - Array of failed or errored tests. Array of Object.
+
+<ul>
+<li>type Type of the failure. Either &#39;failure&#39; or &#39;error&#39;. String.</li>
+<li>classClass name of the test. String.</li>
+<li>name Name of the test. String.</li>
+<li>assertions Number of the assertions for this test. Integer.</li>
+<li>time Time in seconds for this test. Float.</li>
+<li>message Message reported by this failure or error. String.</li>
+<li>location File name and line number. file:line. String.</li>
+<li>backtrace (exists only if type is &#39;error&#39;) Array of backtrace paths and line numbers. Array of String.</li>
+</ul></li>
+<li>skips Array of skipped tests. Array of Object.
+
+<ul>
+<li>type The string &#39;skipped&#39;. String.</li>
+<li>class Class name of the test. String.</li>
+<li>name The name of the test. String.</li>
+<li>assertions The count of the assertions for this test. Integer.</li>
+<li>time The time of this test in seconds. Float.</li>
+<li>message The message string passed to the &#39;skip()&#39; method. String.</li>
+<li>location File name and line number. file:line. String.</li>
+</ul></li>
+<li>passes Array of passed test runs. Array of Object.
+
+<ul>
+<li>type The string &#39;passed&#39;. String.</li>
+<li>class Class name of the test. String.</li>
+<li>name The name of the test. String.</li>
+<li>assertions The count of the assertions for this test. Integer.</li>
+<li>time The time of this test in seconds. Float.</li>
+</ul></li>
+</ul>
+
+<p>The last 2 objects: skips[] and passes[] are absent unless the --verbose command
+line flag was passed or if the options[:verbose] value is true.</p>
 
 <h3>Sample output</h3>
 
 <pre class="code ruby"><code class="ruby"><span class='comment'># Use jq to pretty print the JSON output
 </span></code></pre>
 
+<h2>Example analysis feedback</h2>
+
+<p>JSON can be parsed and manipulated to provide many types of useful information.
+Below are some example usages.
+We use the &#39;jq&#39; program to parse and select and arrange the output.
+The version of &#39;jq&#39; is 1.5. It can be downloaded/install instructions here: <a href="https://stedolan.github.io/jq/download/">Download JQ</a>
+See: <a href="https://stedolan.github.io/jq/manual/">JQ Developer Manual</a></p>
+
+<h3>Sort by time, slowest first</h3>
+
+<p>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.</p>
+
+<pre class="code ruby"><code class="ruby">$ ruby timings_spec.rb  --verbose | jq &#39;.passes | sort_by(.time) | reverse[] | .name, .time&#39;
+&quot;test_0001_should be slow&quot;
+5.001584862009622
+&quot;test_0003_should be slightly faster&quot;
+1.0003409570199437
+&quot;test_0002_should be fast&quot;
+2.9060000088065863e-05
+</code></pre>
+
+<h3>Group By Class example</h3>
+
+<p>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 &#39;sort_by&#39; or &#39;group_by&#39; filters to get them back in 
+some semblace of order.</p>
+
+<p>Here we group the .fails[] array by their class name. (The file: &#39;group_by_spec.rb&#39; 
+contains 4 tests inside 2 classes.)</p>
+
+<pre class="code ruby"><code class="ruby">$ ruby group_by_spec.rb |jq &#39;.fails | group_by(.class) | flatten[] | .class, .name&#39;
+&quot;TestNumericalGroup&quot;
+&quot;test_4_times_6_equals_24&quot;
+&quot;TestNumericalGroup&quot;
+&quot;test_positive_integers_are_greater_than_0&quot;
+&quot;TestStringGroup&quot;
+&quot;test_string_is_hello_world&quot;
+&quot;TestStringGroup&quot;
+&quot;test_value_length_equals_2&quot;
+</code></pre>
+
+<h2>Customizing the JSON format</h2>
+
+<p>You can adjust the contents of the returned JSON by sub-classing the Minitest::Reporters::JsonReporter class.
+Override the &#39;to_h&#39; method and delete or modifythe hash it returns.</p>
+
+<p>Here is a simple example that eliminates the &#39;metadata&#39; and &#39;timmings&#39; components:</p>
+
+<pre class="code ruby"><code class="ruby"><span class='comment'># example spec_helper.rb:
+</span>
+<span class='kw'>class</span> <span class='const'>Minitest</span><span class='op'>::</span><span class='const'>Reporters</span><span class='op'>::</span><span class='const'>SlimJsonReporter</span> <span class='op'>&lt;</span> <span class='const'>Minitest</span><span class='op'>::</span><span class='const'>Reporters</span><span class='op'>::</span><span class='const'>JsonReporter</span>
+    <span class='kw'>def</span> <span class='id identifier rubyid_to_h'>to_h</span>
+    <span class='id identifier rubyid_h'>h</span> <span class='op'>=</span> <span class='kw'>super</span>
+    <span class='id identifier rubyid_h'>h</span><span class='period'>.</span><span class='id identifier rubyid_delete'>delete</span><span class='lparen'>(</span><span class='symbol'>:metadata</span><span class='rparen'>)</span>
+    <span class='id identifier rubyid_h'>h</span><span class='period'>.</span><span class='id identifier rubyid_delete'>delete</span><span class='lparen'>(</span><span class='symbol'>:timings</span><span class='rparen'>)</span>
+    <span class='id identifier rubyid_h'>h</span>
+  <span class='kw'>end</span>
+<span class='kw'>end</span>
+
+<span class='const'>Minitest</span><span class='op'>::</span><span class='const'>Reporters</span><span class='period'>.</span><span class='id identifier rubyid_use!'>use!</span><span class='lparen'>(</span> <span class='const'>Minitest</span><span class='op'>::</span><span class='const'>Reporters</span><span class='op'>::</span><span class='const'>SlimJsonReporter</span><span class='period'>.</span><span class='id identifier rubyid_new'>new</span> <span class='rparen'>)</span>
+</code></pre>
+
 <h2>Contributing</h2>
 
 <ol>
@@ -142,10 +274,27 @@ you will get 2 additional objects: skips[] and passes[]</p>
 </ol>
 
 <p>Note: Extra credit if git flow feature branching was used.</p>
+
+<h2>Resources</h2>
+
+<ul>
+<li>Code: <a href="https://github.com/edhowland/minitest-reporters-json_reporter">https://github.com/edhowland/minitest-reporters-json_reporter</a></li>
+<li>Bugs: <a href="https://github.com/edhowland/minitest-reporters-json_reporter/issues">https://github.com/edhowland/minitest-reporters-json_reporter/issues</a></li>
+<li>Docs: <a href="http://www.rubydoc.info/gems/minitest-reporters-json_reporter/1.0.0">http://www.rubydoc.info/gems/minitest-reporters-json_reporter/1.0.0</a></li>
+<li>Gem: <a href="https://rubygems.org/gems/minitest-reporters-json_reporter">https://rubygems.org/gems/minitest-reporters-json_reporter</a></li>
+</ul>
+
+<h6>Feedback</h6>
+
+<p>If you find this gem helpful, please slip me a note via e-mail: <a href="mailto:ed.howland@gmail.com">ed.howland@gmail.com</a></p>
+
+<p>I would like to know if anyone has used this approach to interface Minitest to any automated framework or editor.</p>
+
+<p>Thanks, Ed.</p>
 </div></div>
 
     <div id="footer">
-  Generated on Tue May  3 20:15:41 2016 by
+  Generated on Wed May 25 22:22:25 2016 by
   <a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
   0.8.7.6 (ruby-2.2.2).
 </div>

data/doc/index.html

@@ -65,15 +65,25 @@
 
 <p>This is an extension  gem for the minitest-reporters gem. It adds JSON output as an output format.</p>
 
-<p>[<img src="https://badge.fury.io/rb/minitest-reporters-json_reporter.svg" alt="Gem Version">][gem]</p>
+<p><a href="https://badge.fury.io/rb/minitest-reporters-json_reporter"><img src="https://badge.fury.io/rb/minitest-reporters-json_reporter.svg" alt="Gem Version"></a>
+<a href="https://travis-ci.org/edhowland/minitest-reporters-json_reporter"><img src="https://travis-ci.org/edhowland/minitest-reporters-json_reporter.png?branch=master" alt="Build Status"></a>
+<a href="https://coveralls.io/github/edhowland/minitest-reporters-json_reporter?branch=master"><img src="https://coveralls.io/repos/github/edhowland/minitest-reporters-json_reporter/badge.svg?branch=master" alt="Coverage Status"></a>
+<a href="https://codeclimate.com/github/edhowland/minitest-reporters-json_reporter"><img src="https://codeclimate.com/github/edhowland/minitest-reporters-json_reporter/badges/gpa.svg" alt="Code Climate"></a>
+<a href="http://inch-ci.org/github/edhowland/minitest-reporters-json_reporter"><img src="http://inch-ci.org/github/edhowland/minitest-reporters-json_reporter.svg?style=shields" alt="Inline docs"></a></p>
 
 <h2>Abstract</h2>
 
 <p>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: <a href="https://atom.io">https://atom.io</a>
-I originally wrote this gem to interface to the Viper audible  code editor for the blind community. See: <a href="https://github.com/edhowland/viper">https://github.com/edhowland/viper</a></p>
+example interface might be to the Atom editor: <a href="https://atom.io">https://atom.io</a></p>
 
-<h2>Version 0.2.1</h2>
+<p>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 &#39;jq sort&#39; example below.</p>
+
+<p>I originally wrote this gem to interface to the Viper audible  code editor for the blind community. See: <a href="https://github.com/edhowland/viper">https://github.com/edhowland/viper</a>
+Using this gem with Viper also requires the &#39;viper_ruby&#39; package. See <a href="https://github.com/edhowland/viper_ruby">https://github.com/edhowland/viper_ruby</a></p>
+
+<h2>Version 1.0.0</h2>
 
 <h2>Installation</h2>
 
@@ -108,29 +118,151 @@ I originally wrote this gem to interface to the Viper audible  code editor for t
 
 <h2>Object Summary</h2>
 
-<ol>
-<li>status -  Status of the overall test run. Can be &#39;Success&#39;, &#39;Passed with skipped tests&#39; or &#39;Failed&#39;. There also a color attribute: green, yellow or red - respectfully.</li>
-<li>metadata - General information about this test run. Includes generator name, version and the test run completion time in UTC formatted in ISO8601 format. Also include options object computed by super classes including command line arguments.</li>
-<li>statistics - Contains the total number of runs, the number of assertions, the number of fails, skips and passes.</li>
-<li>Timings - Including total_seconds, runs_per_second and assertions_per_second in float format</li>
-<li>fails - Array of failed or errored tests. Each object herein contains the information of each test, its name, class, error message, number of assertions, the timing and location of the test and the filtered backtrace array if an error type.</li>
-</ol>
-
-<h3>Optional objects</h3>
-
-<p>If the &#39;--verbose&#39; flag was passed on the command line or the options[:verbose]  = true was passed to the constructor
-you will get 2 additional objects: skips[] and passes[]</p>
-
-<ol>
-<li>skips[] - Information about the skipped test including its message, number of assertions, the time to run the skip and location.</li>
-<li>passes[] - Information for all passed test runs including the type, the test name, class, the number of assertions and timing.</li>
-</ol>
+<ul>
+<li>status of the overall test run. Object.
+
+<ul>
+<li>code - Success, Passed with skipped tests or Failed. String.</li>
+<li>color green, yellow or red. String.</li>
+</ul></li>
+<li>metadata The metadata of this particular test run. Object.
+
+<ul>
+<li>generated_by Class name of the Minitest Reporter. Will usually be Minitest::Reporters::JsonReporter. String.</li>
+<li>version - Version of the minitest-reporters-json_reporter gem. String.</li>
+<li>ruby_version - RUBY_VERSION. String.</li>
+<li>ruby_patchlevel - RUBY_PATCHLEVEL. Integer.</li>
+<li>ruby_platform - RUBY_PLATFORM. String.</li>
+<li>time - Time of test run in UTC and ISO-8601 format. String.</li>
+<li>options - Options object as constructed by passed options, superclasses and command line args. Object.</li>
+<li>io - The class name of the IO object. Will be the string &#39;STDOUT&#39; if equal to $stdout. String.</li>
+<li>keys of the options hash, if any. Various key/value pairs.</li>
+<li>args Array of arguments passed to the program. Array of String.</li>
+<li>total_count - Total number of tests ran. Integer.</li>
+</ul></li>
+<li>statisticsThe accumulated counts for this test run.   Object.
+
+<ul>
+<li>total Number of total runs. Integer.</li>
+<li>assertions Count of assertions performed. Integer.</li>
+<li>failures Number of failed tests. Integer.</li>
+<li>errors Number of errors encountered. Integer.</li>
+<li>skips Number of skipped tests. Integer.</li>
+<li>passes Number of passed tests. Integer.</li>
+</ul></li>
+<li>timings Object containing the computed timing information for the entire test run. Object.
+
+<ul>
+<li>total_seconds total number of seconds for the entire test run. Float.</li>
+<li>runs_per_second Averaged number of runs per second. Float.</li>
+<li>assertions_per_second Averaged number of assertions per second. Float.</li>
+</ul></li>
+<li>fails - Array of failed or errored tests. Array of Object.
+
+<ul>
+<li>type Type of the failure. Either &#39;failure&#39; or &#39;error&#39;. String.</li>
+<li>classClass name of the test. String.</li>
+<li>name Name of the test. String.</li>
+<li>assertions Number of the assertions for this test. Integer.</li>
+<li>time Time in seconds for this test. Float.</li>
+<li>message Message reported by this failure or error. String.</li>
+<li>location File name and line number. file:line. String.</li>
+<li>backtrace (exists only if type is &#39;error&#39;) Array of backtrace paths and line numbers. Array of String.</li>
+</ul></li>
+<li>skips Array of skipped tests. Array of Object.
+
+<ul>
+<li>type The string &#39;skipped&#39;. String.</li>
+<li>class Class name of the test. String.</li>
+<li>name The name of the test. String.</li>
+<li>assertions The count of the assertions for this test. Integer.</li>
+<li>time The time of this test in seconds. Float.</li>
+<li>message The message string passed to the &#39;skip()&#39; method. String.</li>
+<li>location File name and line number. file:line. String.</li>
+</ul></li>
+<li>passes Array of passed test runs. Array of Object.
+
+<ul>
+<li>type The string &#39;passed&#39;. String.</li>
+<li>class Class name of the test. String.</li>
+<li>name The name of the test. String.</li>
+<li>assertions The count of the assertions for this test. Integer.</li>
+<li>time The time of this test in seconds. Float.</li>
+</ul></li>
+</ul>
+
+<p>The last 2 objects: skips[] and passes[] are absent unless the --verbose command
+line flag was passed or if the options[:verbose] value is true.</p>
 
 <h3>Sample output</h3>
 
 <pre class="code ruby"><code class="ruby"><span class='comment'># Use jq to pretty print the JSON output
 </span></code></pre>
 
+<h2>Example analysis feedback</h2>
+
+<p>JSON can be parsed and manipulated to provide many types of useful information.
+Below are some example usages.
+We use the &#39;jq&#39; program to parse and select and arrange the output.
+The version of &#39;jq&#39; is 1.5. It can be downloaded/install instructions here: <a href="https://stedolan.github.io/jq/download/">Download JQ</a>
+See: <a href="https://stedolan.github.io/jq/manual/">JQ Developer Manual</a></p>
+
+<h3>Sort by time, slowest first</h3>
+
+<p>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.</p>
+
+<pre class="code ruby"><code class="ruby">$ ruby timings_spec.rb  --verbose | jq &#39;.passes | sort_by(.time) | reverse[] | .name, .time&#39;
+&quot;test_0001_should be slow&quot;
+5.001584862009622
+&quot;test_0003_should be slightly faster&quot;
+1.0003409570199437
+&quot;test_0002_should be fast&quot;
+2.9060000088065863e-05
+</code></pre>
+
+<h3>Group By Class example</h3>
+
+<p>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 &#39;sort_by&#39; or &#39;group_by&#39; filters to get them back in 
+some semblace of order.</p>
+
+<p>Here we group the .fails[] array by their class name. (The file: &#39;group_by_spec.rb&#39; 
+contains 4 tests inside 2 classes.)</p>
+
+<pre class="code ruby"><code class="ruby">$ ruby group_by_spec.rb |jq &#39;.fails | group_by(.class) | flatten[] | .class, .name&#39;
+&quot;TestNumericalGroup&quot;
+&quot;test_4_times_6_equals_24&quot;
+&quot;TestNumericalGroup&quot;
+&quot;test_positive_integers_are_greater_than_0&quot;
+&quot;TestStringGroup&quot;
+&quot;test_string_is_hello_world&quot;
+&quot;TestStringGroup&quot;
+&quot;test_value_length_equals_2&quot;
+</code></pre>
+
+<h2>Customizing the JSON format</h2>
+
+<p>You can adjust the contents of the returned JSON by sub-classing the Minitest::Reporters::JsonReporter class.
+Override the &#39;to_h&#39; method and delete or modifythe hash it returns.</p>
+
+<p>Here is a simple example that eliminates the &#39;metadata&#39; and &#39;timmings&#39; components:</p>
+
+<pre class="code ruby"><code class="ruby"><span class='comment'># example spec_helper.rb:
+</span>
+<span class='kw'>class</span> <span class='const'>Minitest</span><span class='op'>::</span><span class='const'>Reporters</span><span class='op'>::</span><span class='const'>SlimJsonReporter</span> <span class='op'>&lt;</span> <span class='const'>Minitest</span><span class='op'>::</span><span class='const'>Reporters</span><span class='op'>::</span><span class='const'>JsonReporter</span>
+    <span class='kw'>def</span> <span class='id identifier rubyid_to_h'>to_h</span>
+    <span class='id identifier rubyid_h'>h</span> <span class='op'>=</span> <span class='kw'>super</span>
+    <span class='id identifier rubyid_h'>h</span><span class='period'>.</span><span class='id identifier rubyid_delete'>delete</span><span class='lparen'>(</span><span class='symbol'>:metadata</span><span class='rparen'>)</span>
+    <span class='id identifier rubyid_h'>h</span><span class='period'>.</span><span class='id identifier rubyid_delete'>delete</span><span class='lparen'>(</span><span class='symbol'>:timings</span><span class='rparen'>)</span>
+    <span class='id identifier rubyid_h'>h</span>
+  <span class='kw'>end</span>
+<span class='kw'>end</span>
+
+<span class='const'>Minitest</span><span class='op'>::</span><span class='const'>Reporters</span><span class='period'>.</span><span class='id identifier rubyid_use!'>use!</span><span class='lparen'>(</span> <span class='const'>Minitest</span><span class='op'>::</span><span class='const'>Reporters</span><span class='op'>::</span><span class='const'>SlimJsonReporter</span><span class='period'>.</span><span class='id identifier rubyid_new'>new</span> <span class='rparen'>)</span>
+</code></pre>
+
 <h2>Contributing</h2>
 
 <ol>
@@ -142,10 +274,27 @@ you will get 2 additional objects: skips[] and passes[]</p>
 </ol>
 
 <p>Note: Extra credit if git flow feature branching was used.</p>
+
+<h2>Resources</h2>
+
+<ul>
+<li>Code: <a href="https://github.com/edhowland/minitest-reporters-json_reporter">https://github.com/edhowland/minitest-reporters-json_reporter</a></li>
+<li>Bugs: <a href="https://github.com/edhowland/minitest-reporters-json_reporter/issues">https://github.com/edhowland/minitest-reporters-json_reporter/issues</a></li>
+<li>Docs: <a href="http://www.rubydoc.info/gems/minitest-reporters-json_reporter/1.0.0">http://www.rubydoc.info/gems/minitest-reporters-json_reporter/1.0.0</a></li>
+<li>Gem: <a href="https://rubygems.org/gems/minitest-reporters-json_reporter">https://rubygems.org/gems/minitest-reporters-json_reporter</a></li>
+</ul>
+
+<h6>Feedback</h6>
+
+<p>If you find this gem helpful, please slip me a note via e-mail: <a href="mailto:ed.howland@gmail.com">ed.howland@gmail.com</a></p>
+
+<p>I would like to know if anyone has used this approach to interface Minitest to any automated framework or editor.</p>
+
+<p>Thanks, Ed.</p>
 </div></div>
 
     <div id="footer">
-  Generated on Tue May  3 20:15:41 2016 by
+  Generated on Wed May 25 22:22:25 2016 by
   <a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
   0.8.7.6 (ruby-2.2.2).
 </div>

data/doc/top-level-namespace.html

@@ -103,7 +103,7 @@
 </div>
 
     <div id="footer">
-  Generated on Tue May  3 20:15:41 2016 by
+  Generated on Wed May 25 22:22:25 2016 by
   <a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
   0.8.7.6 (ruby-2.2.2).
 </div>

data/lib/minitest/reporters/json_reporter.rb

@@ -59,10 +59,10 @@ module Minitest
       ##
       # Create the detail part of the JSON.
       def detail_h
-        h = { fails: failures_h }
+        h = { fails: failures_a }
         if options[:verbose]
-          h[:skips] = skips_h
-          h[:passes] = passes_h
+          h[:skips] = skips_a
+          h[:passes] = passes_a
         end
         h
       end
@@ -150,7 +150,7 @@ module Minitest
       ##
       # Returns the fails array of failure or error hash objects as part of
       # the output.
-      def failures_h
+      def failures_a
         tests.reject { |e| e.skipped? || e.passed? || e.failure.nil? }
              .map { |e| failure_h(e) }
       end
@@ -187,7 +187,7 @@ module Minitest
 
       ##
       # Returns the skips[] array object as part of the output.
-      def skips_h
+      def skips_a
         tests.select(&:skipped?).map { |e| skip_h(e) }
       end
 
@@ -202,7 +202,7 @@ module Minitest
 
       ##
       # Returns the passes[] array object as part of the output.
-      def passes_h
+      def passes_a
         tests.select(&:passed?).map { |e| result_h(e, 'passed') }
       end
 

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.12'.freeze
+      VERSION = '1.0.0'.freeze
     end
   end
 end

data/minitest-reporters-json_reporter.gemspec

@@ -5,7 +5,7 @@ $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.12'
+  spec.version       = '1.0.0'
   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.12
+  version: 1.0.0
 platform: ruby
 authors:
 - edhowland
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2016-05-24 00:00:00.000000000 Z
+date: 2016-05-25 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: minitest-reporters