doggo 0.0.2 → 1.2.0

checksums.yaml

@@ -1,7 +1,17 @@
 ---
-SHA256:
-  metadata.gz: e400910e348f37feab93f558dc22c8ccff17bb5978ac0466827274f7b568a3cc
-  data.tar.gz: db85734f689ef749c06ad135ce24bc5e36e92b3a749178da187cbddb95cfbe3c
+!binary "U0hBMjU2":
+  metadata.gz: !binary |-
+    ZjZiMjhhN2YwNGMyM2RhNDk0ZWNmYWFiMzE2ODM2MmI3YTgyZjU2OGQwZmY0
+    OGQ1MmUyYTI2MDY1OWQxODI0ZQ==
+  data.tar.gz: !binary |-
+    Yjk2MzQzN2M2NmFiYzZjZDE0YTdmNmQwMDNlNzUzMjVkMzEyOWU3ZGJkYWRl
+    ZTNjODcyMGNjMmQwYzMzMjc4Ng==
 SHA512:
-  metadata.gz: c8f448cde211ab681a0057c1bfbeb56c3ae80aad416078c39fc1b12714ad81e7d934680ff77eaf71076fba55b67abe8f5839bf11ea31088bc352feca69c92964
-  data.tar.gz: e4561e754671832aab4f1afea408c2c06613b848387d7239679385e0ebe8ce684926ccbb279beb579cd032ec4e1c425142dabc833388be4e5f4d9a39759b6d09
+  metadata.gz: !binary |-
+    ODJmNjM2YWQ4NTk3NmQyZjA2MGVjNzEyOGEwNDllMDVmMmRmZGRkZGRhNjky
+    NWZkNTUyMGVjMDFiZWE4OTllODVmZTkyNGNhNjY4ZWMwOWQ1M2NmOGI1NjVk
+    OTkzYjA0ODcyZTcyN2U5YWNkYWI4ZDA1MDMzMzE0M2IwNmU5NDA=
+  data.tar.gz: !binary |-
+    YmQzYjkzMDA5YWQ0NmM2MWZiYjk5YzNkYzlkZWU5MWVmNGViNDE2NjAyMjI2
+    YjJmNDQ5NmQxMWNlZTYwY2FhMmEzNWMwNzA5ODc2MDY5NjdjMWMzNTBjZjY2
+    YjlhZTQ4NGM5MzUyZWM5NjY1MTIzYTkzNWNkMWViZWM0YzU3MDc=

data/LICENSE.txt

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2021 RIPA Global
+
+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,125 @@
+# Doggo
+
+[![License](https://img.shields.io/badge/license-mit-blue.svg)](https://opensource.org/licenses/MIT)
+[![Build Status](https://app.travis-ci.com/RIPGlobal/doggo.svg?branch=master)](https://app.travis-ci.com/RIPGlobal/doggo)
+
+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.
+
+## Example output
+
+Regenerate this with `FOR_EXAMPLE=yes bundle exec rspec --order defined`:
+
+```
+[   10] Doggo examples
+[01/10]   outer passes
+[02/10]   FAILED (1) - outer fails
+
+  1) Doggo examples outer fails
+     Failure/Error: expect(true).to eql(false)
+
+       expected: false
+            got: true
+
+       (compared using eql?)
+
+       Diff:
+       @@ -1,2 +1,2 @@
+       -false
+       +true
+
+     # ./spec/example/doggo_spec.rb:29:in `block (2 levels) in <top (required)>'
+
+[03/10]   PENDING - outer is pending with xit
+[04/10]   FAILED (2) - outer is pending with a custom message
+
+  2) Doggo examples outer is pending with a custom message FIXED
+     Expected pending 'custom message' to fail. No error was raised.
+     # ./spec/example/doggo_spec.rb:35
+
+[   10]   in a context
+[   10]     with a nested context
+[05/10]       passes
+[06/10]       FAILED (3) - fails
+
+  3) Doggo examples in a context with a nested context fails
+     Failure/Error: expect(true).to eql(false)
+
+       expected: false
+            got: true
+
+       (compared using eql?)
+
+       Diff:
+       @@ -1,2 +1,2 @@
+       -false
+       +true
+
+     # ./spec/example/doggo_spec.rb:12:in `block (4 levels) in <top (required)>'
+
+[07/10]       PENDING - is pending with xit
+[08/10]       FAILED (4) - is pending with a custom message
+
+  4) Doggo examples in a context with a nested context is pending with a custom message FIXED
+     Expected pending 'custom message' to fail. No error was raised.
+     # ./spec/example/doggo_spec.rb:18
+
+[   10]   test count
+[09/10]     is taken to 9
+[10/10]     is taken to 10, showing leading zero pad formatting
+```
+
+Notable things are:
+
+* Group title entries omit the example number
+* Left zero padding to keep column alignment, working for any number of total tests
+* `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
+* A `PENDING` default message of `Temporarily skipped with xit` is suppressed for brevity, but any other message would be shown inline.
+* Detailed failure messages are shown inline, so you can start investigating test failures while your test suite continues to run.
+
+## Installation
+
+Either:
+
+```shell
+gem install doggo
+```
+
+...or in a Gemfile:
+
+```ruby
+gem 'doggo', '~> 1.0'
+```
+
+## Usage
+
+Drive RSpec with:
+
+```
+rspec --format Doggo
+```
+
+Alternatively, edit your `.rspec` file:
+
+```
+# .rspec
+
+--format Doggo
+```
+
+...or alter your `spec_helper.rb` file or equivalent:
+
+```ruby
+RSpec.configure do | config |
+  config.add_formatter 'Doggo'
+end
+```
+
+## Development
+
+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:
+
+```
+gem update --system 2.7.11
+```
+
+According to the [release history](https://rubygems.org/gems/rubygems-update/versions), 2.7.11 is the last of the v2.x RubyGems releases which still supported Ruby v1.x. Version 2.7.11 was released on December 9th 2020.

data/lib/doggo.rb

@@ -71,7 +71,7 @@ class Doggo < RSpec::Core::Formatters::BaseTextFormatter
 
   def example_passed(passed)
     self.outstr.puts(passed_output(passed.example))
-    flush_messages
+    flush_messages()
 
     self.passed_count   += 1
     self.example_running = false
@@ -85,17 +85,21 @@ class Doggo < RSpec::Core::Formatters::BaseTextFormatter
       )
     )
 
-    flush_messages
+    flush_messages()
 
     self.pending_count  += 1
     self.example_running = false
   end
 
   def example_failed(failure)
+    self.failed_count += 1
+
     self.outstr.puts(failure_output(failure.example))
-    flush_messages
+    self.outstr.puts(failure.fully_formatted(self.failed_count))
+    self.outstr.puts("\n")
+
+    flush_messages()
 
-    self.failed_count   += 1
     self.example_running = false
   end
 

data/spec/internal_spec.rb

@@ -91,7 +91,12 @@ RSpec.describe Doggo do
     context '#example_failed' do
       before :each do
         @dog.start(@notification)
+        @detail = 'failure detail'
         @failed = double('Failing test', example: @example)
+
+        allow(@failed).to receive(:fully_formatted) do | count |
+          "#{count} #{@detail}"
+        end
       end
 
       it 'notes an example is no longer running' do
@@ -116,7 +121,7 @@ RSpec.describe Doggo do
         expect(@dog.failed_count).to eql(2)
       end
 
-      it 'logs the failure' do
+      it 'logs the summary failure' do
         @dog.example_started(@notification)
         @dog.example_failed(@failed)
 
@@ -124,6 +129,13 @@ RSpec.describe Doggo do
         expect(@bork.string).to include('FAILED')
         expect(@bork.string).to include(@example_description)
       end
+
+      it 'logs the detailed failure' do
+        @dog.example_started(@notification)
+        @dog.example_failed(@failed)
+
+        expect(@bork.string).to include("1 #{@detail}")
+      end
     end # "context '#example_failed' do"
 
     context '#example_pending' do

metadata

@@ -1,79 +1,88 @@
 --- !ruby/object:Gem::Specification
 name: doggo
 version: !ruby/object:Gem::Version
-  version: 0.0.2
+  version: 1.2.0
 platform: ruby
 authors:
-- RIP Global
+- RIPA Global
 - Andrew David Hodgkinson
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2020-04-02 00:00:00.000000000 Z
+date: 2021-09-27 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rspec-core
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ~>
       - !ruby/object:Gem::Version
-        version: '3.0'
+        version: '3.10'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ~>
       - !ruby/object:Gem::Version
-        version: '3.0'
+        version: '3.10'
 - !ruby/object:Gem::Dependency
   name: rspec
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ~>
       - !ruby/object:Gem::Version
-        version: '3.7'
+        version: '3.10'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ~>
       - !ruby/object:Gem::Version
-        version: '3.7'
-description: Similar to RSpec -f d, but adds indication of test number and total tests
-  on each line
+        version: '3.10'
+description: Similar to "rspec -f d", but also indicates progress by showing the current
+  test number and total test count on each line.
 email:
-- andrew@ripglobal.com
+- dev@ripaglobal.com
 executables: []
 extensions: []
-extra_rdoc_files: []
+extra_rdoc_files:
+- LICENSE.txt
+- README.md
 files:
+- LICENSE.txt
+- README.md
 - lib/doggo.rb
 - spec/example/doggo_spec.rb
 - spec/internal_spec.rb
 - spec/spec_helper.rb
-homepage: https://ripglobal.com/
+homepage: https://www.ripaglobal.com/
 licenses:
 - MIT
-metadata: {}
+metadata:
+  homepage_uri: https://www.ripaglobal.com/
+  source_code_uri: https://github.com/RIPAGlobal/doggo/
+  bug_tracker_uri: https://github.com/RIPAGlobal/doggo/issues/
+  changelog_uri: https://github.com/RIPAGlobal/doggo/blob/master/CHANGELOG.md
 post_install_message: 
 rdoc_options: []
 require_paths:
 - lib
 required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
-  - - ">="
+  - - ! '>='
     - !ruby/object:Gem::Version
-      version: 2.6.5
+      version: 1.9.3
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
-  - - ">="
+  - - ! '>='
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.0.3
+rubyforge_project: 
+rubygems_version: 2.7.11
 signing_key: 
 specification_version: 4
-summary: RSpec formatter - documentation, with progress indication
+summary: RSpec 3 formatter - documentation, with progress indication
 test_files:
 - spec/spec_helper.rb
 - spec/internal_spec.rb