croaky-rspec 0.1.0 → 0.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 96cc773958ccf61a6ec8d239e0bf8b8842cf3e4c4298304984f5ef5a1da42238
-  data.tar.gz: d53e758996c2e3341e75c1d7d6773e6d074bc8801063081b6d9b1537d81dd197
+  metadata.gz: e9b40aca9ee81c3bdec2f4f7e0e6897fff9b5a9fcf3589d086716089d3b67fa8
+  data.tar.gz: 6664d2e782b19ced2ab7e7149b6caf0925954eac998f1780ebda7871d7e7b4e6
 SHA512:
-  metadata.gz: 7a3f5f511c6cbb5d9ab79c1ffdb1544d8bb9db700d34454b9967ad3baea2b6990c0036da47d3a212fa9186a9608f02b69cb2e0af75e05a468e6ebe243db2ed3a
-  data.tar.gz: 32c5aaea9381c390cbcd9e60305f250a12fec543d34735bf964e55967c8abce18c4bc4682f390b04bda88cf23b924bb1abd27a4aef80806ca92f2d430d5857ba
+  metadata.gz: a4db00879f3bb750293f3b59617470a895e7fa35d630ada1519293f2b10c77736d204380b64d3fb344e20f473ed8ea1723595f4df9dc16bdb317a79980cc8154
+  data.tar.gz: 4262baa0d0e0bb1afbdd56fa0a99428f2b9b9470642809ea901abae7bc6141f970177673626a40ea96eb6902d3cd51edd05685ec4590ae4dd899f2592f35aaff

data/Gemfile

@@ -8,6 +8,6 @@ gemspec
 group :test, :development do
   gem 'rake', '~> 12.0'
   gem 'rspec', '~> 3.0'
-  gem 'rubocop'
+  gem 'rubocop', '= 0.89.1'
   gem 'simplecov'
 end

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    croaky-rspec (0.1.0)
+    croaky-rspec (0.2.0)
 
 GEM
   remote: https://rubygems.org/
@@ -55,7 +55,7 @@ DEPENDENCIES
   croaky-rspec!
   rake (~> 12.0)
   rspec (~> 3.0)
-  rubocop
+  rubocop (= 0.89.1)
   simplecov
 
 BUNDLED WITH

data/README.md

@@ -1,8 +1,13 @@
 # Croaky::Rspec
 
-Welcome to your new gem! In this directory, you'll find the files you need to be able to package up your Ruby library into a gem. Put your Ruby code in the file `lib/croaky/rspec`. To experiment with that code, run `bin/console` for an interactive prompt.
+[![Gem Version](https://badge.fury.io/rb/croaky-rspec.svg)](https://badge.fury.io/rb/croaky-rspec)
+[![Build Status](https://travis-ci.org/sayantam/croaky-rspec.svg?branch=master)](https://travis-ci.org/sayantam/croaky-rspec)
 
-TODO: Delete this and the text above, and describe your gem
+RSpec 3.0 formatter that croaks only for failed examples. The formatter captures stdout and stderr during an example
+run, and dumps them for failed examples only. Progress is shown as per progress formatter.
+
+It detects a JRuby platform and captures output from Java as well. For example, it will capture console output from a
+logger like ``log4j``, as well as Java IO streams such as ``java.lang.System.out``, and ``java.lang.System.err``.
 
 ## Installation
 
@@ -22,17 +27,27 @@ Or install it yourself as:
 
 ## Usage
 
-TODO: Write usage instructions here
+This is meant to be an RSpec >= 3.0 formatter. The fully qualified class name is ``Croaky::RSpec::CroakyFormatter``.
+Use RSpec's ``format`` option to specify this formatter.
+
+```bash
+$ bundle exec rspec -f Croaky::RSpec::CroakyFormatter
+```
 
 ## Development
 
-After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake spec` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
+After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake spec` to run the tests.
+You can also run `bin/console` for an interactive prompt that will allow you to experiment.
 
-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`, which will create a git tag for the version, push git commits and tags, and push the `.gem` file to [rubygems.org](https://rubygems.org).
+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 push to origin master. This will trigger a CI flow, that
+will run the specs, and upon success, it will release a new gem to [rubygems.org](https://rubygems.org).
 
 ## Contributing
 
-Bug reports and pull requests are welcome on GitHub at https://github.com/[USERNAME]/croaky-rspec. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [code of conduct](https://github.com/[USERNAME]/croaky-rspec/blob/master/CODE_OF_CONDUCT.md).
+Bug reports and pull requests are welcome on GitHub at https://github.com/sayantam/croaky-rspec. This project is
+intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to
+the [code of conduct](https://github.com/[USERNAME]/croaky-rspec/blob/master/CODE_OF_CONDUCT.md).
 
 
 ## License
@@ -41,4 +56,5 @@ The gem is available as open source under the terms of the [MIT License](https:/
 
 ## Code of Conduct
 
-Everyone interacting in the Croaky::Rspec project's codebases, issue trackers, chat rooms and mailing lists is expected to follow the [code of conduct](https://github.com/[USERNAME]/croaky-rspec/blob/master/CODE_OF_CONDUCT.md).
+Everyone interacting in the Croaky::Rspec project's codebases, issue trackers, chat rooms and mailing lists is
+expected to follow the [code of conduct](https://github.com/[USERNAME]/croaky-rspec/blob/master/CODE_OF_CONDUCT.md).

data/croaky-rspec.gemspec

@@ -12,8 +12,8 @@ Gem::Specification.new do |spec|
 
   spec.summary       = 'RSpec formatter that croaks only for failed examples.'
   spec.description   = <<-DESC
-  Captures stdout and stderr during an example run, and dumps them for failed examples only.
-  Progress is shown as per progress formatter
+  RSpec formatter that captures stdout and stderr during an example run, and dumps them for failed examples only.
+  Progress is shown as per progress formatter.
   DESC
   spec.homepage      = 'https://github.com/sayantam/croaky-rspec'
   spec.license       = 'MIT'

data/lib/croaky/rspec/croaky_formatter.rb

@@ -23,6 +23,12 @@ module Croaky
         @io_stream = io_stream
       end
 
+      def start(notification)
+        super(notification)
+
+        io_stream.capture_io
+      end
+
       def example_started(_notification)
         io_stream.capture_io
       end

data/lib/croaky/version.rb

@@ -3,5 +3,5 @@
 require 'croaky'
 
 module Croaky
-  VERSION = '0.1.0'
+  VERSION = '0.2.0'
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: croaky-rspec
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.2.0
 platform: ruby
 authors:
 - Sayantam Dey
@@ -11,8 +11,8 @@ cert_chain: []
 date: 2020-08-28 00:00:00.000000000 Z
 dependencies: []
 description: |2
-    Captures stdout and stderr during an example run, and dumps them for failed examples only.
-    Progress is shown as per progress formatter
+    RSpec formatter that captures stdout and stderr during an example run, and dumps them for failed examples only.
+    Progress is shown as per progress formatter.
 email:
 - sayantam@gmail.com
 executables: []