minitest-doc_reporter 0.5.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- checksums.yaml +7 -0
- data/.gitignore +18 -0
- data/.ruby-version +1 -0
- data/Gemfile +4 -0
- data/Gemfile.lock +29 -0
- data/LICENSE +20 -0
- data/README.md +33 -0
- data/Rakefile +1 -0
- data/lib/minitest/doc_reporter/version.rb +5 -0
- data/lib/minitest/doc_reporter.rb +130 -0
- data/lib/minitest/doc_reporter_plugin.rb +13 -0
- data/minitest-doc_reporter.gemspec +26 -0
- metadata +126 -0
checksums.yaml
ADDED
@@ -0,0 +1,7 @@
|
|
1
|
+
---
|
2
|
+
SHA1:
|
3
|
+
metadata.gz: 85c768217355836afe6702b768dd3e16b6b00c6e
|
4
|
+
data.tar.gz: b60f591c141fe04e73793f1c78881fd20dad5328
|
5
|
+
SHA512:
|
6
|
+
metadata.gz: 92adead9743b98fe37ad4269d9a9a9cb58a1d2acbc507defc927475142618d22d3254d49816977ba3c14f8787a02feae40a951f36445b3551625dcc2d6de33d7
|
7
|
+
data.tar.gz: 84f3a148f315112a747a86b57c5ea600020c21f3431b67143cd3c31b6177c7c47d3f194a0e3a67d7538014a940d719e6be3dfe735553ff13e9f4f29f821f6d52
|
data/.gitignore
ADDED
data/.ruby-version
ADDED
@@ -0,0 +1 @@
|
|
1
|
+
2.0.0
|
data/Gemfile
ADDED
data/Gemfile.lock
ADDED
@@ -0,0 +1,29 @@
|
|
1
|
+
PATH
|
2
|
+
remote: .
|
3
|
+
specs:
|
4
|
+
minitest-doc_reporter (0.5.0)
|
5
|
+
ansi
|
6
|
+
minitest (~> 5.0)
|
7
|
+
|
8
|
+
GEM
|
9
|
+
remote: https://rubygems.org/
|
10
|
+
specs:
|
11
|
+
ansi (1.4.3)
|
12
|
+
coderay (1.0.9)
|
13
|
+
method_source (0.8.2)
|
14
|
+
minitest (5.0.8)
|
15
|
+
pry (0.9.12.2)
|
16
|
+
coderay (~> 1.0.5)
|
17
|
+
method_source (~> 0.8)
|
18
|
+
slop (~> 3.4)
|
19
|
+
rake (10.1.0)
|
20
|
+
slop (3.4.6)
|
21
|
+
|
22
|
+
PLATFORMS
|
23
|
+
ruby
|
24
|
+
|
25
|
+
DEPENDENCIES
|
26
|
+
bundler (~> 1.3)
|
27
|
+
minitest-doc_reporter!
|
28
|
+
pry
|
29
|
+
rake
|
data/LICENSE
ADDED
@@ -0,0 +1,20 @@
|
|
1
|
+
The MIT License (MIT)
|
2
|
+
|
3
|
+
Copyright (c) 2013 Jason Thompson
|
4
|
+
|
5
|
+
Permission is hereby granted, free of charge, to any person obtaining a copy of
|
6
|
+
this software and associated documentation files (the "Software"), to deal in
|
7
|
+
the Software without restriction, including without limitation the rights to
|
8
|
+
use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of
|
9
|
+
the Software, and to permit persons to whom the Software is furnished to do so,
|
10
|
+
subject to the following conditions:
|
11
|
+
|
12
|
+
The above copyright notice and this permission notice shall be included in all
|
13
|
+
copies or substantial portions of the Software.
|
14
|
+
|
15
|
+
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
|
16
|
+
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS
|
17
|
+
FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR
|
18
|
+
COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER
|
19
|
+
IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN
|
20
|
+
CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
|
data/README.md
ADDED
@@ -0,0 +1,33 @@
|
|
1
|
+
# minitest-doc-reporter
|
2
|
+
|
3
|
+
|
4
|
+
[](http://badge.fury.io/rb/gemfury)
|
5
|
+
|
6
|
+
A more detailed reporter for minitest inspired by the documentation output of
|
7
|
+
Rspec.
|
8
|
+
|
9
|
+
## Install
|
10
|
+
|
11
|
+
### Requirements
|
12
|
+
|
13
|
+
This gem has not yet been tested with ruby versions previous 2.0.0-p247.
|
14
|
+
|
15
|
+
### Installation
|
16
|
+
|
17
|
+
```
|
18
|
+
gem install minitest-doc_reporter
|
19
|
+
```
|
20
|
+
|
21
|
+
Or in your gem file:
|
22
|
+
|
23
|
+
```ruby
|
24
|
+
gem "minitest-doc_reporter"
|
25
|
+
```
|
26
|
+
|
27
|
+
## Usage
|
28
|
+
|
29
|
+
Add the following to the top of your minitest file or you spec_helper file:
|
30
|
+
|
31
|
+
```require 'minitest/doc_reporter'```
|
32
|
+
|
33
|
+
This will replace Minitest's default reports with minitest-doc_reporter's.
|
data/Rakefile
ADDED
@@ -0,0 +1 @@
|
|
1
|
+
require "bundler/gem_tasks"
|
@@ -0,0 +1,130 @@
|
|
1
|
+
gem "minitest"
|
2
|
+
require 'minitest/autorun'
|
3
|
+
require 'ansi/code'
|
4
|
+
|
5
|
+
module Minitest
|
6
|
+
module DocReporter
|
7
|
+
require "minitest/doc_reporter/version"
|
8
|
+
|
9
|
+
class DocReporter < AbstractReporter
|
10
|
+
include ANSI::Code
|
11
|
+
|
12
|
+
attr_reader :io, :options, :results
|
13
|
+
|
14
|
+
attr_accessor :start_time, :total_time, :failures, :errors, :skips, :count,
|
15
|
+
:results
|
16
|
+
|
17
|
+
def initialize(options = {})
|
18
|
+
@io = io
|
19
|
+
@options = options
|
20
|
+
self.results = []
|
21
|
+
self.errors = 0
|
22
|
+
self.skips = 0
|
23
|
+
self.count = 0
|
24
|
+
self.failures = 0
|
25
|
+
end
|
26
|
+
|
27
|
+
def start
|
28
|
+
self.start_time = Time.now
|
29
|
+
end
|
30
|
+
|
31
|
+
def record(result)
|
32
|
+
puts format_header(result.class)
|
33
|
+
puts format_result(result)
|
34
|
+
puts
|
35
|
+
|
36
|
+
if result.error?
|
37
|
+
puts format_error_info(result)
|
38
|
+
puts
|
39
|
+
end
|
40
|
+
|
41
|
+
if result.failure
|
42
|
+
puts pad(result.failure.to_s)
|
43
|
+
puts
|
44
|
+
end
|
45
|
+
|
46
|
+
self.count += 1
|
47
|
+
|
48
|
+
self.results << result if not result.passed? or result.skipped?
|
49
|
+
end
|
50
|
+
|
51
|
+
def report
|
52
|
+
super
|
53
|
+
|
54
|
+
aggregate = self.results.group_by { |r| r.failure.class }
|
55
|
+
aggregate.default = [] # dumb. group_by should provide this
|
56
|
+
|
57
|
+
self.failures = aggregate[Assertion].size
|
58
|
+
self.errors = aggregate[UnexpectedError].size
|
59
|
+
self.skips = aggregate[Skip].size
|
60
|
+
|
61
|
+
puts
|
62
|
+
puts format_tests_run_count(count, total_time)
|
63
|
+
puts statistics
|
64
|
+
puts
|
65
|
+
end
|
66
|
+
|
67
|
+
private
|
68
|
+
|
69
|
+
def statistics
|
70
|
+
"#{format_result_type('Errors', errors, :red)} #{format_divider}" + \
|
71
|
+
"#{format_result_type('Failures', failures, :red)} #{format_divider}" + \
|
72
|
+
"#{format_result_type('Skips', skips, :yellow)}"
|
73
|
+
end
|
74
|
+
|
75
|
+
def total_time
|
76
|
+
Time.now - start_time
|
77
|
+
end
|
78
|
+
|
79
|
+
#formatters
|
80
|
+
def pad(str, amount = 2)
|
81
|
+
" " * amount + str
|
82
|
+
end
|
83
|
+
|
84
|
+
def format_error_info(result)
|
85
|
+
e = result.failure.exception
|
86
|
+
bt = Minitest.filter_backtrace e.backtrace
|
87
|
+
pad(ANSI.bold {e.class.to_s} + "\n" + pad(e.message.to_s) + "\n" + \
|
88
|
+
format_backtrace(bt))
|
89
|
+
end
|
90
|
+
|
91
|
+
def format_backtrace(bt)
|
92
|
+
output = ""
|
93
|
+
bt.each {|l| output << l}
|
94
|
+
pad output
|
95
|
+
end
|
96
|
+
|
97
|
+
def format_result(result)
|
98
|
+
output = ""
|
99
|
+
if result.passed?
|
100
|
+
output = ANSI.green {result.name}
|
101
|
+
else
|
102
|
+
output = ANSI.red {result.name}
|
103
|
+
end
|
104
|
+
pad output
|
105
|
+
end
|
106
|
+
|
107
|
+
def format_header(header)
|
108
|
+
ANSI.bold(header)
|
109
|
+
end
|
110
|
+
|
111
|
+
def format_tests_run_count(count, total_time)
|
112
|
+
ANSI.bold "#{count} tests run in #{total_time}"
|
113
|
+
end
|
114
|
+
|
115
|
+
def format_result_type(type, count, colour)
|
116
|
+
summary = "#{type}: #{count}"
|
117
|
+
|
118
|
+
if count.zero?
|
119
|
+
return ANSI.ansi(summary, :white, :bold)
|
120
|
+
else
|
121
|
+
return ANSI.ansi(summary, colour, :bold)
|
122
|
+
end
|
123
|
+
end
|
124
|
+
|
125
|
+
def format_divider(divider = '|')
|
126
|
+
ANSI.white + ANSI.bold + " #{divider} "
|
127
|
+
end
|
128
|
+
end
|
129
|
+
end
|
130
|
+
end
|
@@ -0,0 +1,13 @@
|
|
1
|
+
require_relative 'doc_reporter'
|
2
|
+
|
3
|
+
module Minitest
|
4
|
+
include Minitest::DocReporter
|
5
|
+
|
6
|
+
def self.plugin_doc_reporter_options(opts, options)
|
7
|
+
end
|
8
|
+
|
9
|
+
def self.plugin_doc_reporter_init(options)
|
10
|
+
self.reporter.reporters = []
|
11
|
+
self.reporter << DocReporter::DocReporter.new(options)
|
12
|
+
end
|
13
|
+
end
|
@@ -0,0 +1,26 @@
|
|
1
|
+
# coding: utf-8
|
2
|
+
lib = File.expand_path('../lib', __FILE__)
|
3
|
+
$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
|
4
|
+
require 'minitest/doc_reporter/version'
|
5
|
+
|
6
|
+
Gem::Specification.new do |spec|
|
7
|
+
spec.name = "minitest-doc_reporter"
|
8
|
+
spec.version = Minitest::DocReporter::VERSION
|
9
|
+
spec.authors = ["Jason Thompson"]
|
10
|
+
spec.email = ["jason@jthompson.ca"]
|
11
|
+
spec.description = %q{A detailed spec-by-spec report for Minitest}
|
12
|
+
spec.summary = %q{Provides a detailed report modelled after the documentation report style in rspec.}
|
13
|
+
spec.homepage = "http://github.com/jasonthompson/minitest-doc_reporter"
|
14
|
+
spec.license = "MIT"
|
15
|
+
|
16
|
+
spec.files = `git ls-files`.split($/)
|
17
|
+
spec.test_files = spec.files.grep(%r{^(test|spec|features)/})
|
18
|
+
spec.require_paths = ["lib"]
|
19
|
+
|
20
|
+
spec.add_development_dependency "bundler", "~> 1.3"
|
21
|
+
spec.add_development_dependency "rake"
|
22
|
+
spec.add_development_dependency "pry"
|
23
|
+
|
24
|
+
spec.add_runtime_dependency "minitest", "~> 5.0"
|
25
|
+
spec.add_runtime_dependency "ansi"
|
26
|
+
end
|
metadata
ADDED
@@ -0,0 +1,126 @@
|
|
1
|
+
--- !ruby/object:Gem::Specification
|
2
|
+
name: minitest-doc_reporter
|
3
|
+
version: !ruby/object:Gem::Version
|
4
|
+
version: 0.5.0
|
5
|
+
platform: ruby
|
6
|
+
authors:
|
7
|
+
- Jason Thompson
|
8
|
+
autorequire:
|
9
|
+
bindir: bin
|
10
|
+
cert_chain: []
|
11
|
+
date: 2013-11-10 00:00:00.000000000 Z
|
12
|
+
dependencies:
|
13
|
+
- !ruby/object:Gem::Dependency
|
14
|
+
name: bundler
|
15
|
+
requirement: !ruby/object:Gem::Requirement
|
16
|
+
requirements:
|
17
|
+
- - ~>
|
18
|
+
- !ruby/object:Gem::Version
|
19
|
+
version: '1.3'
|
20
|
+
type: :development
|
21
|
+
prerelease: false
|
22
|
+
version_requirements: !ruby/object:Gem::Requirement
|
23
|
+
requirements:
|
24
|
+
- - ~>
|
25
|
+
- !ruby/object:Gem::Version
|
26
|
+
version: '1.3'
|
27
|
+
- !ruby/object:Gem::Dependency
|
28
|
+
name: rake
|
29
|
+
requirement: !ruby/object:Gem::Requirement
|
30
|
+
requirements:
|
31
|
+
- - '>='
|
32
|
+
- !ruby/object:Gem::Version
|
33
|
+
version: '0'
|
34
|
+
type: :development
|
35
|
+
prerelease: false
|
36
|
+
version_requirements: !ruby/object:Gem::Requirement
|
37
|
+
requirements:
|
38
|
+
- - '>='
|
39
|
+
- !ruby/object:Gem::Version
|
40
|
+
version: '0'
|
41
|
+
- !ruby/object:Gem::Dependency
|
42
|
+
name: pry
|
43
|
+
requirement: !ruby/object:Gem::Requirement
|
44
|
+
requirements:
|
45
|
+
- - '>='
|
46
|
+
- !ruby/object:Gem::Version
|
47
|
+
version: '0'
|
48
|
+
type: :development
|
49
|
+
prerelease: false
|
50
|
+
version_requirements: !ruby/object:Gem::Requirement
|
51
|
+
requirements:
|
52
|
+
- - '>='
|
53
|
+
- !ruby/object:Gem::Version
|
54
|
+
version: '0'
|
55
|
+
- !ruby/object:Gem::Dependency
|
56
|
+
name: minitest
|
57
|
+
requirement: !ruby/object:Gem::Requirement
|
58
|
+
requirements:
|
59
|
+
- - ~>
|
60
|
+
- !ruby/object:Gem::Version
|
61
|
+
version: '5.0'
|
62
|
+
type: :runtime
|
63
|
+
prerelease: false
|
64
|
+
version_requirements: !ruby/object:Gem::Requirement
|
65
|
+
requirements:
|
66
|
+
- - ~>
|
67
|
+
- !ruby/object:Gem::Version
|
68
|
+
version: '5.0'
|
69
|
+
- !ruby/object:Gem::Dependency
|
70
|
+
name: ansi
|
71
|
+
requirement: !ruby/object:Gem::Requirement
|
72
|
+
requirements:
|
73
|
+
- - '>='
|
74
|
+
- !ruby/object:Gem::Version
|
75
|
+
version: '0'
|
76
|
+
type: :runtime
|
77
|
+
prerelease: false
|
78
|
+
version_requirements: !ruby/object:Gem::Requirement
|
79
|
+
requirements:
|
80
|
+
- - '>='
|
81
|
+
- !ruby/object:Gem::Version
|
82
|
+
version: '0'
|
83
|
+
description: A detailed spec-by-spec report for Minitest
|
84
|
+
email:
|
85
|
+
- jason@jthompson.ca
|
86
|
+
executables: []
|
87
|
+
extensions: []
|
88
|
+
extra_rdoc_files: []
|
89
|
+
files:
|
90
|
+
- .gitignore
|
91
|
+
- .ruby-version
|
92
|
+
- Gemfile
|
93
|
+
- Gemfile.lock
|
94
|
+
- LICENSE
|
95
|
+
- README.md
|
96
|
+
- Rakefile
|
97
|
+
- lib/minitest/doc_reporter.rb
|
98
|
+
- lib/minitest/doc_reporter/version.rb
|
99
|
+
- lib/minitest/doc_reporter_plugin.rb
|
100
|
+
- minitest-doc_reporter.gemspec
|
101
|
+
homepage: http://github.com/jasonthompson/minitest-doc_reporter
|
102
|
+
licenses:
|
103
|
+
- MIT
|
104
|
+
metadata: {}
|
105
|
+
post_install_message:
|
106
|
+
rdoc_options: []
|
107
|
+
require_paths:
|
108
|
+
- lib
|
109
|
+
required_ruby_version: !ruby/object:Gem::Requirement
|
110
|
+
requirements:
|
111
|
+
- - '>='
|
112
|
+
- !ruby/object:Gem::Version
|
113
|
+
version: '0'
|
114
|
+
required_rubygems_version: !ruby/object:Gem::Requirement
|
115
|
+
requirements:
|
116
|
+
- - '>='
|
117
|
+
- !ruby/object:Gem::Version
|
118
|
+
version: '0'
|
119
|
+
requirements: []
|
120
|
+
rubyforge_project:
|
121
|
+
rubygems_version: 2.1.10
|
122
|
+
signing_key:
|
123
|
+
specification_version: 4
|
124
|
+
summary: Provides a detailed report modelled after the documentation report style
|
125
|
+
in rspec.
|
126
|
+
test_files: []
|