doggo 0.0.3 → 1.0.0

Sign up to get free protection for your applications and to get access to all the features.
Files changed (4) hide show
  1. checksums.yaml +17 -0
  2. data/LICENSE.txt +21 -0
  3. data/README.md +81 -0
  4. metadata +19 -17
checksums.yaml ADDED
@@ -0,0 +1,17 @@
1
+ ---
2
+ !binary "U0hBMjU2":
3
+ metadata.gz: !binary |-
4
+ MTYyNGM4ZGRjMWVjNWEyNmNhYzA1YjUwZjgzZDg1Y2Y4OWQ1ZjgwYmIwYzJi
5
+ ZDhkMjlhMWUxM2U2NTEwNzBlNw==
6
+ data.tar.gz: !binary |-
7
+ MTYxOWUzNDE1MmIwMWMwNWY3MTI0ZjA0MTE5ZjMxN2U5MGM3YjVjMjg4OGQ0
8
+ N2IwZjcwMjAzODI4YzVmZTgzZg==
9
+ SHA512:
10
+ metadata.gz: !binary |-
11
+ ZWYyZjkyOThhMzYxYTc5Y2YyOGIyM2MxZjExZmJjNzkzMTYwOTllNzZkNGQ2
12
+ ODFmMzZjZmM3NzBiOGU0ZGY2YjlmMmY4MTRkMDdiNjZkMWFlMDE3ODRlM2I1
13
+ N2RhZTQ4MzBjZmU0OTJjNDJjOGZkOWI5YzBiNmU5YWFhOTVjYjk=
14
+ data.tar.gz: !binary |-
15
+ YjA4ZmE4M2RkZDhlNWVlMWNmZjljNjBhZGMyMmVjYTAwMjIwMGUwMGM0OTQ2
16
+ ODZkYzFlZDdjNTQ5MjM5NTEyYWUyNjY1NWM2MThiYjBhN2I2YjYzZGRjNjE3
17
+ NDYwYmYyNzA0YWZjYWEzMDA1ZWRhZjYyYzk1NGNhZGNjYWU2YTQ=
data/LICENSE.txt ADDED
@@ -0,0 +1,21 @@
1
+ MIT License
2
+
3
+ Copyright (c) 2020 RIP Global
4
+
5
+ Permission is hereby granted, free of charge, to any person obtaining a copy
6
+ of this software and associated documentation files (the "Software"), to deal
7
+ in the Software without restriction, including without limitation the rights
8
+ to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
9
+ copies of the Software, and to permit persons to whom the Software is
10
+ furnished to do so, 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,
17
+ FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
18
+ AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
19
+ LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
20
+ OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
21
+ SOFTWARE.
data/README.md ADDED
@@ -0,0 +1,81 @@
1
+ # Doggo
2
+
3
+ [![License](https://img.shields.io/badge/license-mit-blue.svg)](https://opensource.org/licenses/MIT)
4
+
5
+ An [RSpec](https://github.com/rspec) formatter that looks like `--format documentation`, but adds an indication of test number and overall test count at the start of each line.
6
+
7
+ ## Example output
8
+
9
+ Regenerate this with `FOR_EXAMPLE=yes bundle exec rspec --order defined`:
10
+
11
+ ```
12
+ [ 10] Doggo examples
13
+ [01/10] outer passes
14
+ [02/10] FAILED (1) - outer fails
15
+ [03/10] PENDING - outer is pending with xit
16
+ [04/10] FAILED (2) - outer is pending with a custom message
17
+ [ 10] in a context
18
+ [ 10] with a nested context
19
+ [05/10] passes
20
+ [06/10] FAILED (3) - fails
21
+ [07/10] PENDING - is pending with xit
22
+ [08/10] FAILED (4) - is pending with a custom message
23
+ [ 10] test count
24
+ [09/10] is taken to 9
25
+ [10/10] is taken to 10, showing leading zero pad formatting
26
+ ```
27
+
28
+ Notable things are:
29
+
30
+ * Group title entries omit the example number
31
+ * Left zero padding to keep column alignment, working for any number of total tests
32
+ * `FAILED` and `PENDING` states are shown on the left side of the message, not the right as with RSpec's `--format documentation`, to make them a little easier to see in CI output
33
+ * A `PENDING` default message of `Temporarily skipped with xit` is suppressed for brevity, but any other message would be shown inline.
34
+
35
+ ## Installation
36
+
37
+ Either:
38
+
39
+ ```shell
40
+ gem install doggo
41
+ ```
42
+
43
+ ...or in a Gemfile:
44
+
45
+ ```ruby
46
+ gem 'doggo', '~> 1.0'
47
+ ```
48
+
49
+ ## Usage
50
+
51
+ Drive RSpec with:
52
+
53
+ ```
54
+ rspec --format Doggo
55
+ ```
56
+
57
+ Alternatively, edit your `.rspec` file:
58
+
59
+ ```
60
+ # .rspec
61
+
62
+ --format Doggo
63
+ ```
64
+
65
+ ...or alter your `spec_helper.rb` file or equivalent:
66
+
67
+ ```ruby
68
+ RSpec.configure do | config |
69
+ config.add_formatter 'Doggo'
70
+ end
71
+ ```
72
+
73
+ ## Development
74
+
75
+ Doggo works with Ruby 1.9.3-p551 from November 13th 2011, but needs a far newer RubyGems version in order for its `.gemspec` file to be processed. You will therefore probably need to update RubyGems if you are doing development work on the source code and want to, for example, run `bundle update`. _Assuming you are using [rbenv](https://github.com/rbenv/rbenv)_ and have automatically (via Doggo's `.ruby-version` file) or manually (via e.g. running command `rbenv local 1.9.3-p551`) switched to Ruby 1.9.3-p551, you can safely ensure that the most recent compatible RubyGems version is installed by issuing this command:
76
+
77
+ ```
78
+ gem update --system 2.7.10
79
+ ```
80
+
81
+ According to the [release history](https://rubygems.org/gems/rubygems-update/versions), 2.7.10 is the last of the v2.x RubyGems releases which still supported Ruby v1.x. Version 2.7.10 was released on June 14th 2019.
metadata CHANGED
@@ -1,8 +1,7 @@
1
1
  --- !ruby/object:Gem::Specification
2
2
  name: doggo
3
3
  version: !ruby/object:Gem::Version
4
- version: 0.0.3
5
- prerelease:
4
+ version: 1.0.0
6
5
  platform: ruby
7
6
  authors:
8
7
  - RIP Global
@@ -10,12 +9,11 @@ authors:
10
9
  autorequire:
11
10
  bindir: bin
12
11
  cert_chain: []
13
- date: 2020-04-03 00:00:00.000000000 Z
12
+ date: 2020-04-06 00:00:00.000000000 Z
14
13
  dependencies:
15
14
  - !ruby/object:Gem::Dependency
16
15
  name: rspec-core
17
16
  requirement: !ruby/object:Gem::Requirement
18
- none: false
19
17
  requirements:
20
18
  - - ~>
21
19
  - !ruby/object:Gem::Version
@@ -23,7 +21,6 @@ dependencies:
23
21
  type: :runtime
24
22
  prerelease: false
25
23
  version_requirements: !ruby/object:Gem::Requirement
26
- none: false
27
24
  requirements:
28
25
  - - ~>
29
26
  - !ruby/object:Gem::Version
@@ -31,7 +28,6 @@ dependencies:
31
28
  - !ruby/object:Gem::Dependency
32
29
  name: rspec
33
30
  requirement: !ruby/object:Gem::Requirement
34
- none: false
35
31
  requirements:
36
32
  - - ~>
37
33
  - !ruby/object:Gem::Version
@@ -39,47 +35,53 @@ dependencies:
39
35
  type: :development
40
36
  prerelease: false
41
37
  version_requirements: !ruby/object:Gem::Requirement
42
- none: false
43
38
  requirements:
44
39
  - - ~>
45
40
  - !ruby/object:Gem::Version
46
41
  version: '3.7'
47
- description: Similar to RSpec -f d, but adds indication of test number and total tests
48
- on each line
42
+ description: Similar to "rspec -f d", but also indicates progress by showing the current
43
+ test number and total test count on each line.
49
44
  email:
50
45
  - andrew@ripglobal.com
51
46
  executables: []
52
47
  extensions: []
53
- extra_rdoc_files: []
48
+ extra_rdoc_files:
49
+ - LICENSE.txt
50
+ - README.md
54
51
  files:
52
+ - LICENSE.txt
53
+ - README.md
55
54
  - lib/doggo.rb
56
- - spec/spec_helper.rb
57
- - spec/internal_spec.rb
58
55
  - spec/example/doggo_spec.rb
59
- homepage: https://github.com/ripglobal/doggo/
56
+ - spec/internal_spec.rb
57
+ - spec/spec_helper.rb
58
+ homepage: https://www.ripglobal.com/
60
59
  licenses:
61
60
  - MIT
61
+ metadata:
62
+ homepage_uri: https://www.ripglobal.com/
63
+ source_code_uri: https://github.com/ripglobal/doggo/
64
+ bug_tracker_uri: https://github.com/ripglobal/doggo/
65
+ changelog_uri: https://github.com/ripglobal/doggo/blob/master/CHANGELOG.md
62
66
  post_install_message:
63
67
  rdoc_options: []
64
68
  require_paths:
65
69
  - lib
66
70
  required_ruby_version: !ruby/object:Gem::Requirement
67
- none: false
68
71
  requirements:
69
72
  - - ! '>='
70
73
  - !ruby/object:Gem::Version
71
74
  version: 1.9.3
72
75
  required_rubygems_version: !ruby/object:Gem::Requirement
73
- none: false
74
76
  requirements:
75
77
  - - ! '>='
76
78
  - !ruby/object:Gem::Version
77
79
  version: '0'
78
80
  requirements: []
79
81
  rubyforge_project:
80
- rubygems_version: 1.8.23.2
82
+ rubygems_version: 2.7.10
81
83
  signing_key:
82
- specification_version: 3
84
+ specification_version: 4
83
85
  summary: RSpec formatter - documentation, with progress indication
84
86
  test_files:
85
87
  - spec/spec_helper.rb