minitest-reporters-json_reporter 0.1.1 → 0.2.0

data/lib/minitest/reporters/json_reporter.rb

@@ -1,4 +1,4 @@
-# json_reporter.rb - class MiniTest::Reporters::JsonReporter
+# json_reporter.rb - class Minitest::Reporters::JsonReporter
 
 require 'json'
 require 'time'
@@ -6,15 +6,21 @@ 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
+require_relative 'json_reporter/test_detail'
+require_relative 'json_reporter/pass_detail'
+require_relative 'json_reporter/fault_detail'
+require_relative 'json_reporter/skip_detail'
+require_relative 'json_reporter/error_detail'
+require_relative 'json_reporter/fail_detail'
+
+# 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
+    # Minitest Reporter that produces a JSON output for interface in IDEs, editor
     class JsonReporter < BaseReporter
-      def initialize(opts = {})
-        super(opts)
+      def initialize(my_options = {})
+        super my_options
         @skipped = 0
         @failed = 0
         @errored = 0
@@ -22,19 +28,21 @@ module MiniTest
         @storage = init_status
       end
 
+      attr_reader :storage
+
       def metadata_h
         {
           generated_by: self.class.name,
-          version: MiniTest::Reporters::JsonReporter::VERSION,
+          version: Minitest::Reporters::JsonReporter::VERSION,
           time: Time.now.utc.iso8601
         }
       end
 
       def init_status
         {
-          status: red_status,
+          status: green_status,
           metadata: metadata_h,
-          statistics: {},
+          statistics: statistics_h,
           fails: [],
           skips: []
         }
@@ -47,15 +55,15 @@ module MiniTest
 
       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)
+        set_status # sets the success or failure and color in the status object
+        # options only exists once test run starts
+        @storage[:metadata][:options] = transform_store(options)
+        @storage[:statistics] = statistics_h
+        # Only add this if not already added and verbose option is set
+        @storage[:passes] ||= [] if options[:verbose]
+
+        io.write(JSON.dump(@storage))
       end
 
       def yellow?
@@ -73,11 +81,13 @@ module MiniTest
       private
 
       def set_status
-        if yellow?
-          @storage[:status] = yellow_status
-        elsif green?
-          @storage[:status] = green_status
-        end
+        @storage[:status] = if red?
+                              red_status
+                            elsif yellow?
+                              yellow_status
+                            else
+                              green_status
+                            end
       end
 
       def color_h(code, color)
@@ -96,65 +106,60 @@ module MiniTest
         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)
+      def statistics_h
         {
-          type: type,
-          class: test.class.name,
-          name: test.name,
-          message: e.message,
-          location: location(e)
+          total: @failed + @errored + @skipped + @passed,
+          failed: @failed,
+          errored: @errored,
+          skipped: @skipped,
+          passed: @passed
         }
       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
+        Minitest::Reporters::SkipDetail.new(test).query do |d|
           @skipped += 1
+          @storage[:skips] << d.to_h
         end
       end
 
       def errored(test)
-        status('error', test, :error?) do |e|
-          @storage[:fails] << e
+        Minitest::Reporters::ErrorDetail.new(test).query do |d|
+          d.backtrace = filter_backtrace(d.backtrace)
+          @storage[:fails] << d.to_h
           @errored += 1
         end
       end
 
       def failed(test)
-        status('failure', test, :failure) do |e|
-          @storage[:fails] << e
+        Minitest::Reporters::FailDetail.new(test).query do |d|
+          @storage[:fails] << d.to_h
           @failed += 1
         end
       end
 
-      def passed(_test)
-        @passed += 1
+      # If it is increments @passed and optionally adds PassDetail object
+      # to .passes array
+      # if options[:verbose] == true
+      def passed(test)
+        Minitest::Reporters::PassDetail.new(test).query do |d|
+          @passed += 1
+          if options[:verbose]
+            @storage[:passes] ||= []
+            @storage[:passes] << d.to_h
+          end
+        end
       end
 
-      # I/O
-      def output(io, body)
-        io.write(JSON.dump(body))
+      # transform_store options: make pretty object for our JSON [metadata.options]
+      # If :io is the IO class and == $stdout: "STDOUT"
+      # Delete key: total_count
+      def transform_store(opts)
+        o = opts.clone
+        o[:io] = o[:io].class.name
+        o[:io] = 'STDOUT' if opts[:io] == $stdout
+        o.delete(:total_count)
+        o
       end
     end
   end

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

@@ -0,0 +1,25 @@
+
+# error_detail.rb - class Minitest::Reporters::ErrorDetail
+
+# Minitest Namespace for all things Minitest
+module Minitest
+  # Reporters Namespace for Minitest::Reporters reporters
+  module Reporters
+    # How to handle an error detail
+    class ErrorDetail < FaultDetail
+      def initialize(test)
+        super
+        @type = 'error'
+        @predicate = :error?
+      end
+
+      attr_accessor :backtrace
+
+      def to_h
+        h = super
+        h[:backtrace] = @backtrace
+        h
+      end
+    end
+  end
+end

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

@@ -0,0 +1,16 @@
+# fail_detail.rb - class Minitest::Reporters::FailDetail
+
+# Minitest Namespace for all things Minitest
+module Minitest
+  # Reporters Extensible reporting framework for Minitest runs
+  module Reporters
+    # FailDetail Detail of failed test
+    class FailDetail < FaultDetail
+      def initialize(test)
+        super
+        @type = 'failure'
+        @predicate = :failure
+      end
+    end
+  end
+end

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

@@ -0,0 +1,39 @@
+# fault_detail.rb - class Minitest::Reporters::FaultDetail
+
+# Minitest Base namespace for Minitest related objects
+module Minitest
+  # Reporters - Extensible Reporting framework for Minitest
+  module Reporters
+    # superclass for SkipDetail, FailDetail and ErrorDetail
+    class FaultDetail < TestDetail
+      def initialize(test)
+        # Initialize for  FaultDetail - sets up
+        # exception stuff: message, location and backtrace
+        super test
+      end
+
+      # returns string of found location of this test from backtrace
+      def location
+        @backtrace.reverse.reduce('') do |a, e|
+          break a if e =~ /in .(assert|refute|flunk|pass|fail|raise|must|wont)/
+          e.sub(/:in .*$/, '')
+        end
+      end
+
+      def to_h
+        h = super
+        h[:message] = @message
+        h[:location] = location
+        h
+      end
+
+      protected
+
+      def setup_state
+        @exception = @test_obj.failure
+        @message = @exception.message
+        @backtrace = @exception.backtrace
+      end
+    end
+  end
+end

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

@@ -0,0 +1,16 @@
+# pass_detail.rb - class Minitest::Reporters::PassDetail
+
+# Minitest Namespace for all things Minitest
+module Minitest
+  # Reporters Extensible framework for custom Minitest reporters
+  module Reporters
+    # Handler for detail of passed tests
+    class PassDetail < Minitest::Reporters::TestDetail
+      def initialize(test)
+        super
+        @type = 'passed'
+        @predicate = :passed?
+      end
+    end
+  end
+end

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

@@ -0,0 +1,16 @@
+# skip_detail.rb - class Minitest::Reporters::SkipDetail
+
+# Minitest Namespace for all things Minitest
+module Minitest
+  # Reporters - Extensible reporting framework for Minitest
+  module Reporters
+    # How to handle a skipped test.
+    class SkipDetail < Minitest::Reporters::FaultDetail
+      def initialize(test)
+        super
+        @type = 'skipped'
+        @predicate = :skipped?
+      end
+    end
+  end
+end

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

@@ -0,0 +1,43 @@
+# test_detail.rb - class Minitest::Reporters::TestDetail
+
+# Minitest Namespace for all things Minitest
+module Minitest
+  # Reporters Extensible framework for custom Minitest reporters
+  module Reporters
+    # Base class for detail handlers
+    class TestDetail
+      def initialize(test)
+        @type = 'unknown'
+        @class_name = test.class.name
+        @name = test.name
+        @predicate = :nil?
+        @test_obj = test
+      end
+
+      attr_reader :test_obj, :predicate
+
+      def query(&_blk)
+        # force result to be boolean because of failure in Test is not a predicate ?
+        result = (@test_obj.send(@predicate) ? true : false)
+        if result
+          setup_state
+          yield self if block_given?
+        end
+        result
+      end
+
+      def to_h
+        {
+          type: @type,
+          class: @class_name,
+          name: @name
+        }
+      end
+
+      protected
+
+      def setup_state
+      end
+    end
+  end
+end

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

@@ -1,12 +1,12 @@
-# version.rb - version constant: MiniTest::Reporters::JsonReporter::VERSION
+# 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
+# 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.
+    # Minitest Reporter that produces a JSON output for interface in IDEs, editor.
     class JsonReporter < BaseReporter
-      VERSION = '0.1.1'.freeze
+      VERSION = '0.2.0'.freeze
     end
   end
 end

data/minitest-reporters-json_reporter.gemspec

@@ -12,15 +12,16 @@ Gem::Specification.new do |spec|
   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.
+  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.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.required_ruby_version = '~> 2.0'
   spec.add_runtime_dependency 'minitest', '~> 5.7'
   spec.add_runtime_dependency 'minitest-reporters', '~> 1.1.8'
 

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: minitest-reporters-json_reporter
 version: !ruby/object:Gem::Version
-  version: 0.1.1
+  version: 0.2.0
 platform: ruby
 authors:
 - edhowland
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2016-04-07 00:00:00.000000000 Z
+date: 2016-04-21 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: minitest
@@ -67,7 +67,7 @@ dependencies:
       - !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.
+      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
@@ -78,13 +78,43 @@ files:
 - ".gitignore"
 - ".rubocop.yml"
 - ".travis.yml"
+- Announcement.txt
 - CODE_OF_CONDUCT.md
 - Gemfile
 - LICENSE.txt
 - README.md
 - Rakefile
 - TODO.txt
+- doc/Minitest.html
+- doc/Minitest/Reporters.html
+- doc/Minitest/Reporters/ErrorDetail.html
+- doc/Minitest/Reporters/FailDetail.html
+- doc/Minitest/Reporters/FaultDetail.html
+- doc/Minitest/Reporters/JsonReporter.html
+- doc/Minitest/Reporters/PassDetail.html
+- doc/Minitest/Reporters/SkipDetail.html
+- doc/Minitest/Reporters/TestDetail.html
+- doc/_index.html
+- doc/class_list.html
+- doc/css/common.css
+- doc/css/full_list.css
+- doc/css/style.css
+- doc/file.README.html
+- doc/file_list.html
+- doc/frames.html
+- doc/index.html
+- doc/js/app.js
+- doc/js/full_list.js
+- doc/js/jquery.js
+- doc/method_list.html
+- doc/top-level-namespace.html
 - lib/minitest/reporters/json_reporter.rb
+- lib/minitest/reporters/json_reporter/error_detail.rb
+- lib/minitest/reporters/json_reporter/fail_detail.rb
+- lib/minitest/reporters/json_reporter/fault_detail.rb
+- lib/minitest/reporters/json_reporter/pass_detail.rb
+- lib/minitest/reporters/json_reporter/skip_detail.rb
+- lib/minitest/reporters/json_reporter/test_detail.rb
 - lib/minitest/reporters/json_reporter/version.rb
 - minitest-reporters-json_reporter.gemspec
 homepage: https://github.com/edhowland/minitest-reporters-json_reporter
@@ -97,9 +127,9 @@ require_paths:
 - lib
 required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
-  - - ">="
+  - - "~>"
     - !ruby/object:Gem::Version
-      version: '0'
+      version: '2.0'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="