minitest-reporters-json_reporter 0.2.0 → 0.9.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: f5f134ca33ed222b123711da89d4d1a11e7e028a
-  data.tar.gz: fc6d7d916c7798d6e091232c382be1a439f31680
+  metadata.gz: 79425b4f7ac452e39470769e75a23773949d9531
+  data.tar.gz: f5170807896b351ad3669c601c2ae3d567e17dea
 SHA512:
-  metadata.gz: 47bcd68180b082db1ba5549fc14929faa540052128b792d6d1673d663cd45e2d245e9bf598962b1645bc09456c7c17b384d4f24f879b986380d76f0fcf4c8069
-  data.tar.gz: b3c875b539c0c087ae6f7bb90adc4ebeddb77d7b8efaa38578f4d9ac660765aa09ccbc5ce870eeb4fc3119ea9bb4be608009103f28998f354b743208ecb216ab
+  metadata.gz: 1735a7dc30c50e75ce8e5c98776ca67818c31937d49d8b6ac7ad4f01a1c1b2e4d79c513e7e963d762310b23d17baffa1ece6d69c43d4777df9176fbd766b75ce
+  data.tar.gz: 211f32fdc974942a3354076463ec827b27ee6487662d86207e7bb3ffbe3105fa6ade14ce7db90ee83e7d1596b716124c73bfb8384fddfbe8af25e5514c6b0bf7

data/.rubocop.yml

@@ -15,8 +15,12 @@ Style/Semicolon:
 #    - 'lib/minitest/reporters/json_reporter.rb'
 
 Metrics/ClassLength:
-  Max: 120
+  Max: 140
 
 Style/GlobalVars:
   Exclude:
     - 'test/**/*'
+
+Style/ClassAndModuleChildren:
+  Exclude:
+    - 'test/fake_tests.rb'

data/Announcement.txt

@@ -1,17 +1,21 @@
-minitest-reporters-json_reporter version 0.2.0 has been released.
+minitest-reporters-json_reporter version 0.9.1 has been released.
 
 Home, Code: https://github.com/edhowland/minitest-reporters-json_reporter
 Bugs: https://github.com/edhowland/minitest-reporters-json_reporter/issues
-Docs:https://github.com/edhowland/minitest-reporters-json_reporter/blob/master/doc/index.html
+Docs:http://www.rubydoc.info/gems/minitest-reporters-json_reporter/0.9.1
 
 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.
 
-This version is the preliminary version before doing a PR to the mainline Minitest::Reporters gem.
-It includes a normal unit test in the test folder of the source repository.
-It also includes a customizable output file destination: test/report/json_report.json, some other file or stdout.
-It also includes the passed tests if the --verbose flag is passed.
-It also embeds the backtrace for error fails.
-It also adds parsed command line options to the metadata object.
+Changes:
+
+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.
 
 Abstract
 
@@ -20,11 +24,6 @@ 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.
 
-Anti-features:
-
-This version does not include any timing statistics.
-However, you can subclass Minitest::Reporters::JsonReporter and add to the storage accessor any object. This is just a Hash.
- The class is derived from Minitest::StatisticsReporter wherin you can get this detail.
 
 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. 
@@ -40,82 +39,12 @@ Minitest::Reporters.use! [Minitest::Reporters::JsonReporter.new]
 
 Here is the URLs for the dependent gems:
 
-minitest (5.7.0, 5.4.3) : https://rubygems.org/gems/minitest
-minitest-reporters (1.1.8) : https://rubygems.org/gems/minitest-reporters
+minitest  : https://rubygems.org/gems/minitest
+minitest-reporters  : https://rubygems.org/gems/minitest-reporters
 
 The JSON format is sent to stdout when you run a test or all tests.
-There are 5 (or 6)  objects contained within this output:
-The 6th object : passes is only present when --verbose or the options[:verbose] is supplied.
-
-1. status -  Status of the overall test run. Can be 'Success', 'Passed with skipped tests' or 'Failed'. There also a color attribute: green, yellow or red - respectfully.
-2. metadata - General information about this test run. Includes generator name, version and the test run completion time in UTC formatted in ISO8601 format. This also include the parsed command line in the options object.
-3. statistics - Contains counts of the status of test cases. Includes: Total, Skipped, Failed Errored and Passed.
-4. fails - Array of failed or errored tests. Each object herein contains the information of each test, its name, class, error message and location of the test. Tests that generate an error also contain the filter backtrace.
-5. skips - Array of each skipped. Each object contains the information as a failed test, including the skip message, if any.
-6. passes: (Optional: if --verbose is passed to the test): Class name, name and location of the passed test.
-
-Here is a sample test run:
-# Pretty up JSON output with jq
-$ cd test/functional
-$ ruby report_spec.rb   | jq .
-{
-  "status": {
-    "code": "Failed",
-    "color": "red"
-  },
-  "metadata": {
-    "generated_by": "Minitest::Reporters::JsonReporter",
-    "version": "0.2.0",
-    "time": "2016-04-21T19:09:34Z",
-    "options": {
-      "io": "STDOUT",
-      "seed": 2579,
-      "args": "--seed 2579"
-    }
-  },
-  "statistics": {
-    "total": 5,
-    "failed": 2,
-    "errored": 1,
-    "skipped": 1,
-    "passed": 1
-  },
-  "fails": [
-    {
-      "type": "failure",
-      "class": "failure",
-      "name": "test_0001_anonymous",
-      "message": "Expected: 2\n  Actual: 1",
-      "location": "report_spec.rb:14"
-    },
-    {
-      "type": "failure",
-      "class": "second failure",
-      "name": "test_0001_anonymous",
-      "message": "Expected: 9\n  Actual: 3",
-      "location": "report_spec.rb:20"
-    },
-    {
-      "type": "error",
-      "class": "Error",
-      "name": "test_0001_anonymous",
-      "message": "RuntimeError: should fail\n    report_spec.rb:6:in `block (2 levels) in <main>'",
-      "location": "report_spec.rb:6",
-      "backtrace": [
-        "report_spec.rb:6:in `block (2 levels) in <main>'"
-      ]
-    }
-  ],
-  "skips": [
-    {
-      "type": "skipped",
-      "class": "skipped test",
-      "name": "test_0001_anonymous",
-      "message": "what a layabout",
-      "location": "report_spec.rb:32"
-    }
-  ]
-}
+You can customize where the JSON file is written by setting the :io attribute. It must be some IO stream.
+You can see the format of the JSON created by looking at the Home page on GitHub: https://github.com/edhowland/minitest-reporters-json_reporter
 
 You can use JSON parsing tools to get elements or subsets of this format. One such tool is JQ: https://stedolan.github.io/jq/
 
@@ -124,8 +53,12 @@ Here is how you might view only the color of the test:
 $ ruby blog_test.rb  | jq -r .status.color
 green
 
+If you want to customize the format of the JSON string, you only need to subclass the Minitest::Reporters::JsonReporter class
+and override the to_h method. See the file README.md for an example on this.
+
 If you find this gem useful, please send me a note about how you are using it.
 I would be interested if you are hooking it up to an automated framework like CI, CD or a code editor or IDE.
+
 Thanks, Ed
 
 Author: Ed Howland email: ed.howland@gmail.com

data/README.md

@@ -1,12 +1,17 @@
 # Minitest::Reporters::JsonReporter
 
 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]
+
+## 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)
 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.2.0
-
+## Version 0.9.1
 
 ## Installation
 
@@ -40,62 +45,113 @@ Minitest::Reporters.use! [ Minitest::Reporters::JsonReporter.new ]
 
 Then run your tests as normal. You will get a JSON formatted string in stdout.
 
-There are 5 or 6   objects contained within this output: The 6th object: passes is only included if the --verbose option was passed to the test or set in the options parameter to the constructor.
 
-1. status -  Status of the overall test run. Can be 'Success', 'Passed with skipped tests' or 'Failed'. There also a color attribute: green, yellow or red - respectfully.
-2. 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.
-3. statistics - Contains counts of the status of test cases. Includes: Total, Skipped, Failed Errored and Passed.
-4. fails - Array of failed or errored tests. Each object herein contains the information of each test, its name, class, error message and location of the test and the filtered backtrace array if an error type.
-5. skips - Array of each skipped. Each object contains the information as a failed test, including the skip message, if any.
-6. passes - Array of passing tests if the --verbose option was set . This object is normally absent otherwise.
-
-Here is a sample output:
+## Object Summary
+
+
+* status of the overall test run. Object.
+  * code - Success, Passed with skipped tests or Failed. String.
+  * color green, yellow or red. String.
+* metadata The metadata of this particular test run. Object.
+  * generated_by Class name of the Minitest Reporter. Will usually be Minitest::Reporters::JsonReporter. String.
+  * version - Version of the minitest-reporters-json_reporter gem. String.
+  * ruby_version - RUBY_VERSION. String.
+  * ruby_patchlevel - RUBY_PATCHLEVEL. Integer.
+  * ruby_platform - RUBY_PLATFORM. String.
+  * time - Time of test run in UTC and ISO-8601 format. String.
+  * options - Options object as constructed by passed options, superclasses and command line args. Object.
+    * io - The class name of the IO object. Will be the string 'STDOUT' if equal to $stdout. String.
+    * keys of the options hash, if any. Various key/value pairs.
+    * args Array of arguments passed to the program. Array of String.
+    * total_count - Total number of tests ran. Integer.
+* statisticsThe accumulated counts for this test run.   Object.
+  * total Number of total runs. Integer.
+  * assertions Count of assertions performed. Integer.
+  * failures Number of failed tests. Integer.
+  * errors Number of errors encountered. Integer.
+  * skips Number of skipped tests. Integer.
+  * passes Number of passed tests. Integer.
+* timings Object containing the computed timing information for the entire test run. Object.
+  * total_seconds total number of seconds for the entire test run. Float.
+  * runs_per_second Averaged number of runs per second. Float.
+  * assertions_per_second Averaged number of assertions per second. Float.
+* fails - Array of failed or errored tests. Array of Object.
+  * type Type of the failure. Either 'failure' or 'error'. String.
+  * classClass name of the test. String.
+  * name Name of the test. String.
+  * assertions Number of the assertions for this test. Integer.
+  * time Time in seconds for this test. Float.
+  * message Message reported by this failure or error. String.
+  * location File name and line number. file:line. String.
+  * backtrace (exists only if type is 'error') Array of backtrace paths and line numbers. Array of String.
+* skips Array of skipped tests. Array of Object.
+  * type The string 'skipped'. String.
+  * class Class name of the test. String.
+  * name The name of the test. String.
+  * assertions The count of the assertions for this test. Integer.
+  * time The time of this test in seconds. Float.
+  * message The message string passed to the 'skip()' method. String.
+  * location File name and line number. file:line. String.
+* passes Array of passed test runs. Array of Object.
+  * type The string 'passed'. String.
+  * class Class name of the test. String.
+  * name The name of the test. String.
+  * assertions The count of the assertions for this test. Integer.
+  * time The time of this test in seconds. Float.
+
+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.
+
+
+
+### Sample output
 
 ```
 # Use jq to pretty print the JSON output
 $  cd test/functional/
-$ ruby report_spec.rb  --verbose | jq .
+$ ruby report_spec.rb | jq .
 {
-  "status": {
-    "code": "Failed",
-    "color": "red"
-  },
+  "status": {    "code": "Failed",    "color": "red"  },
   "metadata": {
     "generated_by": "Minitest::Reporters::JsonReporter",
-    "version": "0.2.0",
-    "time": "2016-04-21T19:09:34Z",
+    "version": "0.9.1",
+    "ruby_version": "2.2.2",
+    "ruby_patchlevel": 95,
+    "ruby_platform": "x86_64-linux",
+    "time": "2016-05-03T20:57:42Z",
     "options": {
       "io": "STDOUT",
-      "seed": 2579,
-      "args": "--seed 2579"
+      "verbose": true,
+      "seed": 3023,
+      "args": "--verbose --seed 3023",
+      "total_count": 5
     }
   },
-  "statistics": {
-    "total": 5,
-    "failed": 2,
-    "errored": 1,
-    "skipped": 1,
-    "passed": 1
+  "statistics": {    "total": 5,    "assertions": 4,    "failures": 2,
+    "errors": 1,    "skips": 1,    "passes": 1  },
+  "timings": {
+    "total_seconds": 0.0014724910142831504,
+    "runs_per_second": 3395.606459733908,
+    "assertions_per_second": 2716.4851677871266
   },
   "fails": [
     {
-      "type": "failure",
-      "class": "failure",
-      "name": "test_0001_anonymous",
-      "message": "Expected: 2\n  Actual: 1",
-      "location": "report_spec.rb:14"
-    },
-    {
-      "type": "failure",
-      "class": "second failure",
-      "name": "test_0001_anonymous",
+      "type": "failed",      "class": "second failure",      "name": "test_0001_anonymous",
+      "assertions": 1,      "time": 9.327399311587214e-05,
       "message": "Expected: 9\n  Actual: 3",
       "location": "report_spec.rb:20"
     },
     {
-      "type": "error",
-      "class": "Error",
-      "name": "test_0001_anonymous",
+      "type": "failed",
+      "class": "failure",      "name": "test_0001_anonymous",      "assertions": 1,
+      "time": 3.400500281713903e-05,
+      "message": "Expected: 2\n  Actual: 1",
+      "location": "report_spec.rb:14"
+    },
+    {
+      "type": "error",      "class": "Error",
+      "name": "test_0001_anonymous",      "assertions": 0,
+      "time": 2.1556013962253928e-05,
       "message": "RuntimeError: should fail\n    report_spec.rb:6:in `block (2 levels) in <main>'",
       "location": "report_spec.rb:6",
       "backtrace": [
@@ -105,17 +161,47 @@ $ ruby report_spec.rb  --verbose | jq .
   ],
   "skips": [
     {
-      "type": "skipped",
-      "class": "skipped test",
-      "name": "test_0001_anonymous",
+      "type": "skipped",      "class": "skipped test",      "name": "test_0001_anonymous",
+      "assertions": 0,
+      "time": 3.7049001548439264e-05,
       "message": "what a layabout",
-      "location": "report_spec.rb:32"
+      "location": "report_spec.rb:34"
+    }
+  ],
+  "passes": [
+    {
+      "type": "passed",      "class": "working assertion",
+      "name": "test_0001_should have 2 working assertions",      "assertions": 2,
+      "time": 2.5684013962745667e-05
     }
   ]
 }
 
 ```
 
+## Customizing the JSON format
+
+You can adjust the contents of the returned JSON by sub-classing the Minitest::Reporters::JsonReporter class.
+Override the 'to_h' method and delete or modifythe hash it returns.
+
+Here is a simple example that eliminates the 'metadata' and 'timmings' components:
+
+```
+# example spec_helper.rb:
+
+class Minitest::Reporters::SlimJsonReporter < Minitest::Reporters::JsonReporter
+    def to_h
+    h = super
+    h.delete(:metadata)
+    h.delete(:timings)
+    h
+  end
+end
+
+Minitest::Reporters.use!( Minitest::Reporters::SlimJsonReporter.new )
+```
+
+
 
 ## Contributing
 
@@ -127,3 +213,20 @@ $ ruby report_spec.rb  --verbose | jq .
 
 Note: Extra credit if git flow feature branching was used.
 
+
+## Resources
+
+* 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
+* Gem: [https://rubygems.org/gems/minitest-reporters-json_reporter](https://rubygems.org/gems/minitest-reporters-json_reporter) 
+* Documentation: [http://www.rubydoc.info/gems/minitest-reporters-json_reporter/0.9.1](http://www.rubydoc.info/gems/minitest-reporters-json_reporter/0.9.1)
+
+###### Feedback
+
+If you find this gem helpful, please slip me a note via e-mail: ed.howland@gmail.com
+
+
+I would like to know if anyone has used this approach to interface Minitest to any automated framework or editor.
+
+Thanks, Ed.
+

data/doc/Minitest.html

@@ -4,7 +4,7 @@
   <head>
     <meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
 <title>
-  Module: MiniTest
+  Module: Minitest
   
     &mdash; Documentation by YARD 0.8.7.6
   
@@ -17,7 +17,7 @@
 <script type="text/javascript" charset="utf-8">
   hasFrames = window.top.frames.main ? true : false;
   relpath = '';
-  framesUrl = "frames.html#!MiniTest.html";
+  framesUrl = "frames.html#!Minitest.html";
 </script>
 
 
@@ -34,7 +34,7 @@
     <a href="_index.html">Index (M)</a> &raquo;
     
     
-    <span class="title">MiniTest</span>
+    <span class="title">Minitest</span>
   
 
   <div class="noframes"><span class="title">(</span><a href="." target="_top">no frames</a><span class="title">)</span></div>
@@ -63,7 +63,7 @@
 
     <iframe id="search_frame"></iframe>
 
-    <div id="content"><h1>Module: MiniTest
+    <div id="content"><h1>Module: Minitest
   
   
   
@@ -79,7 +79,9 @@
   
   
     <dt class="r1 last">Defined in:</dt>
-    <dd class="r1 last">lib/minitest/reporters/json_reporter/skip_detail.rb</dd>
+    <dd class="r1 last">lib/minitest/reporters/json_reporter.rb<span class="defines">,<br />
+  lib/minitest/reporters/json_reporter/version.rb</span>
+</dd>
   
 </dl>
 <div class="clear"></div>
@@ -87,7 +89,7 @@
 <h2>Overview</h2><div class="docstring">
   <div class="discussion">
     
-<p>MiniTest Namespace for all things Minitest</p>
+<p>Minitest namespace - plugins must live here</p>
 
 
   </div>
@@ -99,7 +101,7 @@
 <p class="children">
   
     
-      <strong class="modules">Modules:</strong> <span class='object_link'><a href="MiniTest/Reporters.html" title="MiniTest::Reporters (module)">Reporters</a></span>
+      <strong class="modules">Modules:</strong> <span class='object_link'><a href="Minitest/Reporters.html" title="Minitest::Reporters (module)">Reporters</a></span>
     
   
     
@@ -117,7 +119,7 @@
 </div>
 
     <div id="footer">
-  Generated on Thu Apr 21 20:48:52 2016 by
+  Generated on Tue May  3 20:15:41 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>