minitest-reporters-json_reporter 0.1.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 94a1de8a674e4127f623f886a6ba0643726d5d86
+  data.tar.gz: 678bd26a89e8565ec5f1892fbf9d1c8ab65db7c7
+SHA512:
+  metadata.gz: 32264e3865b0e4a3c287e96ab466d070c105e081e46847834c8c793062eae47cf45c715630d4fdca7895ec9c80688f0dbac190a186144b3d256c4774bbf5f3e7
+  data.tar.gz: a43bfb4e853845f1695b13c7877ef0020df3a0ea37bf8908704170c7d2fea69499b56f1ae560b0197afc8df4fc8136bfdc6006b8ed597a41e8a74af655140623

data/.gitignore

@@ -0,0 +1,9 @@
+/.bundle/
+/.yardoc
+/Gemfile.lock
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/

data/.rubocop.yml

@@ -0,0 +1,15 @@
+# rubocop.yml - settings for Rubocop Ruby static code analyzer
+Metrics/LineLength:
+  Max: 85
+  Exclude:
+    - 'minitest-reporters-json_reporter.gemspec'
+
+Style/Documentation:
+  Exclude:
+    - 'spec/**/*'
+    - 'test/**/*'
+#Style/Semicolon:
+#  Exclude:
+#    - 'lib/minitest/reporters/json_reporter.rb'
+Metrics/ClassLength:
+  Max: 120

data/.travis.yml

@@ -0,0 +1,3 @@
+language: ruby
+rvm:
+  - 2.2.2

data/CODE_OF_CONDUCT.md

@@ -0,0 +1,13 @@
+# Contributor Code of Conduct
+
+As contributors and maintainers of this project, we pledge to respect all people who contribute through reporting issues, posting feature requests, updating documentation, submitting pull requests or patches, and other activities.
+
+We are committed to making participation in this project a harassment-free experience for everyone, regardless of level of experience, gender, gender identity and expression, sexual orientation, disability, personal appearance, body size, race, age, or religion.
+
+Examples of unacceptable behavior by participants include the use of sexual language or imagery, derogatory comments or personal attacks, trolling, public or private harassment, insults, or other unprofessional conduct.
+
+Project maintainers have the right and responsibility to remove, edit, or reject comments, commits, code, wiki edits, issues, and other contributions that are not aligned to this Code of Conduct. Project maintainers who do not follow the Code of Conduct may be removed from the project team.
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be reported by opening an issue or contacting one or more of the project maintainers.
+
+This Code of Conduct is adapted from the [Contributor Covenant](http:contributor-covenant.org), version 1.0.0, available at [http://contributor-covenant.org/version/1/0/0/](http://contributor-covenant.org/version/1/0/0/)

data/Gemfile

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

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2016 edhowland
+
+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,58 @@
+# Minitest::Reporters::JsonReporter
+
+This is an extension  gem for the minitest-reporters gem. It adds JSON output as an output format.
+You can use this gem to interface MiniTest output into automated tools or IDEs or programmer's 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  Programmer's editor for the blind programmer community. See: [https://github.com/edhowland/viper](https://github.com/edhowland/viper)
+
+## Version 0.1.1
+
+
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'minitest-reporters-json_reporter'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install minitest-reporters-json_reporter
+
+## Usage
+
+Add this line to your 'spec_helper.rb' or 'test_helper.rb':
+
+```
+require 'minitest/reporters/json_reporter'
+```
+
+In that same file, add something like this near the bottom of the file:
+
+```
+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 objects contained within this output:
+
+1. metadata - General information about this test run. Includes generator name, version and the test run completion time in UTC formatted in ISO8601 format.
+2. 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.
+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.
+5. skips - Array of each skipped. Each object contains the information as a failed test, including the skip message, if any.
+
+
+## Contributing
+
+1. Fork it ( https://github.com/edhowland/minitest-reporters-json_reporter/fork )
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Commit your changes (`git commit -am 'Add some feature'`)
+4. Push to the branch (`git push origin my-new-feature`)
+5. Create a new Pull Request

data/Rakefile

@@ -0,0 +1 @@
+require 'bundler/gem_tasks'

data/TODO.txt

@@ -0,0 +1,4 @@
+# TODO.txt: 
+
+
+To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release` to create a git tag for the version, push git commits and tags, and push the `.gem` file to [rubygems.org](https://rubygems.org).

data/lib/minitest/reporters/json_reporter.rb

@@ -0,0 +1,161 @@
+# json_reporter.rb - class MiniTest::Reporters::JsonReporter
+
+require 'json'
+require 'time'
+require 'minitest'
+require 'minitest/reporters'
+
+require_relative 'json_reporter/version'
+
+# MiniTest namespace - plugins must live here
+module MiniTest
+  # MiniTest::Reporters from minitest-reporters gem: See: https://github.com/kern/minitest-reporters
+  module Reporters
+    # MiniTest Reporter that produces a JSON output for interface in IDEs, editor
+    class JsonReporter < BaseReporter
+      def initialize(opts = {})
+        super(opts)
+        @skipped = 0
+        @failed = 0
+        @errored = 0
+        @passed = 0
+        @storage = init_status
+      end
+
+      def metadata_h
+        {
+          generated_by: self.class.name,
+          version: MiniTest::Reporters::JsonReporter::VERSION,
+          time: Time.now.utc.iso8601
+        }
+      end
+
+      def init_status
+        {
+          status: red_status,
+          metadata: metadata_h,
+          statistics: {},
+          fails: [],
+          skips: []
+        }
+      end
+
+      def record(test)
+        super
+        skipped(test) || errored(test) || failed(test) || passed(test)
+      end
+
+      def report
+        super
+        set_status # sets the sucess or failure and color in the status object
+        @storage[:statistics][:total] = @passed + @skipped + @failed + @errored
+        @storage[:statistics][:failed] = @failed
+        @storage[:statistics][:errored] = @errored
+        @storage[:statistics][:skipped] = @skipped
+        @storage[:statistics][:passed] = @passed
+
+        # output JSON
+        output($stdout, @storage)
+      end
+
+      def yellow?
+        @skipped > 0 && !red?
+      end
+
+      def green?
+        !red? && !yellow?
+      end
+
+      def red?
+        @failed + @errored > 0
+      end
+
+      private
+
+      def set_status
+        if yellow?
+          @storage[:status] = yellow_status
+        elsif green?
+          @storage[:status] = green_status
+        end
+      end
+
+      def color_h(code, color)
+        { code: code, color: color }
+      end
+
+      def red_status
+        color_h('Failed', 'red')
+      end
+
+      def yellow_status
+        color_h('Passed, with skipped tests', 'yellow')
+      end
+
+      def green_status
+        color_h('Success', 'green')
+      end
+
+      def location(exception)
+        last_before_assertion = ''
+
+        exception.backtrace.reverse_each do |s|
+          break if s =~ /in .(assert|refute|flunk|pass|fail|raise|must|wont)/
+          last_before_assertion = s
+        end
+
+        last_before_assertion.sub(/:in .*$/, '')
+      end
+
+      def fault_h(type, test, e)
+        {
+          type: type,
+          class: test.class.name,
+          name: test.name,
+          message: e.message,
+          location: location(e)
+        }
+      end
+
+      def status(type, test, msg, &_blk)
+        result = test.send(msg)
+        if result
+          e = fault_h(type, test, test.failure)
+          yield(e)
+        end
+
+        result
+      end
+
+      def skipped(test)
+        status('skipped', test, :skipped?) do |e|
+          @storage[:skips] << e
+          @skipped += 1
+        end
+      end
+
+      def errored(test)
+        status('error', test, :error?) do |e|
+          @storage[:fails] << e
+          @errored += 1
+        end
+      end
+
+      def failed(test)
+        status('failure', test, :failure) do |e|
+          @storage[:fails] << e
+          @failed += 1
+        end
+      end
+
+      def passed(_test)
+        @passed += 1
+      end
+
+      # I/O
+      def output(io, body)
+        io.write(JSON.dump(body))
+      end
+    end
+  end
+end

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

@@ -0,0 +1,12 @@
+# version.rb - version constant: MiniTest::Reporters::JsonReporter::VERSION
+
+# MiniTest namespace - plugins must live here
+module MiniTest
+  # MiniTest::Reporters from minitest-reporters gem: See: https://github.com/kern/minitest-reporters
+  module Reporters
+    # MiniTest Reporter that produces a JSON output for interface in IDEs, editor.
+    class JsonReporter < BaseReporter
+      VERSION = '0.1.1'.freeze
+    end
+  end
+end

data/minitest-reporters-json_reporter.gemspec

@@ -0,0 +1,29 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'minitest/reporters'
+
+require 'minitest/reporters/json_reporter/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = 'minitest-reporters-json_reporter'
+  spec.version       = Minitest::Reporters::JsonReporter::VERSION
+  spec.authors       = ['edhowland']
+  spec.email         = ['ed.howland@gmail.com']
+
+  spec.summary       = 'JSON Reporter format for minitest-reporters gem.'
+  spec.description   = '    Formats the output of a MiniTest run as JSON. Useful for interfacing MiniTest or MiniSpec to IDEs or programming text editors, such as the Atom editor.
+See: https://atom.io. Originally written to interface with the Viper Audible editor for blind programmers. See https://github.com/edhowland/viper'
+  spec.homepage      = "https://github.com/edhowland/minitest-reporters-json_reporter"
+  spec.license       = 'MIT'
+
+  spec.files         = `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
+  spec.bindir        = 'exe'
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ['lib']
+  spec.add_runtime_dependency 'minitest', '~> 5.7'
+  spec.add_runtime_dependency 'minitest-reporters', '~> 1.1.8'
+
+  spec.add_development_dependency 'bundler', '~> 1.9'
+  spec.add_development_dependency 'rake', '~> 10.0'
+end

metadata

@@ -0,0 +1,115 @@
+--- !ruby/object:Gem::Specification
+name: minitest-reporters-json_reporter
+version: !ruby/object:Gem::Version
+  version: 0.1.1
+platform: ruby
+authors:
+- edhowland
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2016-04-07 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: minitest
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5.7'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5.7'
+- !ruby/object:Gem::Dependency
+  name: minitest-reporters
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 1.1.8
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 1.1.8
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.9'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.9'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+description: |2-
+      Formats the output of a MiniTest run as JSON. Useful for interfacing MiniTest or MiniSpec to IDEs or programming text editors, such as the Atom editor.
+  See: https://atom.io. Originally written to interface with the Viper Audible editor for blind programmers. See https://github.com/edhowland/viper
+email:
+- ed.howland@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rubocop.yml"
+- ".travis.yml"
+- CODE_OF_CONDUCT.md
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- TODO.txt
+- lib/minitest/reporters/json_reporter.rb
+- lib/minitest/reporters/json_reporter/version.rb
+- minitest-reporters-json_reporter.gemspec
+homepage: https://github.com/edhowland/minitest-reporters-json_reporter
+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.4.5
+signing_key: 
+specification_version: 4
+summary: JSON Reporter format for minitest-reporters gem.
+test_files: []
+has_rdoc: