minitest-silence 0.2.1 → 0.2.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 894b83d82e7bf198235f1cf78bdd65fde161bd8c0b4f1482222100f123cc77b7
-  data.tar.gz: 14b98586d504f4517a37ecf72bd1da332476afc0cb3c0fc31f37e149a075ab69
+  metadata.gz: 9f46e0aa024886e79f3e5abc617aae0d6d448ab42d964bfdf4e81990c6830b89
+  data.tar.gz: 3b49cb9b7af3af68a9f39a7c37d4b90ab3e2d95424f76e092cd200a4b1b7b435
 SHA512:
-  metadata.gz: 5f3764089e498187ff25b31a55814157aa3ad1ad6ef7ed354293934efbb43ff76e8fa356945f76dec6cb533d76bcd5b84f473867a6c07784ae8d66786b14db37
-  data.tar.gz: 79f4295dda87d176f029e6acb93d3c140d31759e77ec1d0697ea65ba8567a542759af24ddd8a9d43cf10af97b6dd3665b178ad29a2bd61cc63c1fd8c802005cb
+  metadata.gz: 78e574ada8ebd7508c983fd82ae23de9e9ac265558297ae33f816907930d23c08cefb4448d7840c994b77624f4041f541db5e2a451fe715282f125f9d9418a63
+  data.tar.gz: ed262141df222aedcba0ac04db78244df3ccde2e57b5304549311cf27b70647b29eb220e600aba9b187760e3745329c118ac1382bda6d9c5a7e0e4e2b89c2fa4

data/README.md

@@ -1,6 +1,12 @@
 # Minitest::Silence
 
-Minitest plugin to suppress output from tests. This plugin will buffer any output coming from a test going to STDOUT or STDERR, to make sure it doesn't interfere with the output of the test runner itself. By default, it will discard any output, unless the `--verbose` option is set. It also supports failing a test if it is writing anything to STDOUT or STDERR by setting the `--fail-on-output` command line option.
+Minitest plugin to capture output to stdout and stderr from tests.
+
+It's best practice for tests to not write anything to `STDOUT` or `STDERR` while running. Besides it being an implicit dependency, it interferes with the output from the test runner. Even though this is a best practice, when your test suite grows large enough, it becomes almost impossible to make sure every test conforms to this best practice.
+
+This plugins aims to solve this problem by rebinding `STDOUT` and `STDERR` while a test is running. Any output written will be redirected to a pipe, so it won't interfere with the output of the test runner. The plugin will also bind `STDIN` to `/dev/null`. This codifies the best practice that automated tests should not depend on user input.
+
+This plugin is inspired by [how the Python test runner handles output](https://docs.pytest.org/en/stable/capture.html).
 
 ## Installation
 
@@ -14,9 +20,11 @@ gem 'minitest-silence', require: false
 
 The plugin will be automatically activated by Minitest if it is in your application's bundle.
 
-- By default, it will simply discard any output writting to `STDOUT` or `STDERR` by your tests.
-- When specifying `--verbose`, the output will be buffered and written to the `STDOUT` inside a box that makes clear what test the output originated from.
-- When running with the `--fail-on-output` option, a test will fail if it writes anything to either `STDOUT` or `STDERR`.
+- By default, the captured output produced by tests will be discarded, so the output of the test runner will look like how it was intended.
+-  If you run tests with the `--verbose` option , it will be nicely included in the test runner's output, inside a box that will tell you what test it originated from.
+- You can also run this plugin in "strict mode": by running tests with the `--fail-on-output` option, tests will fail if they produce any output to STDOUT or STDERR.
+
+You can disable the plugin by providing the `--disable-silence` command line option to your test invocation. The primary use case for this is when you want to use a debugger inside a test, which will require a the standard input and outputs to work interactively.
 
 ## Development
 
@@ -26,7 +34,7 @@ To install this gem onto your local machine, run `bin/rake install`. To release
 
 ## Contributing
 
-Bug reports and pull requests are welcome on GitHub at https://github.com/Shopifyminitest-silence. 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/Shopify/minitest-silence/blob/master/CODE_OF_CONDUCT.md).
+Bug reports and pull requests are welcome on GitHub at https://github.com/Shopify/minitest-silence. 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/Shopify/minitest-silence/blob/master/CODE_OF_CONDUCT.md).
 
 ## License
 

data/lib/minitest/silence/version.rb

@@ -1,6 +1,6 @@
 # frozen_string_literal: true
 module Minitest
   module Silence
-    VERSION = "0.2.1"
+    VERSION = "0.2.2"
   end
 end

data/lib/minitest/silence_plugin.rb

@@ -37,6 +37,7 @@ module Minitest
         end
 
         result.output = output_thread.value
+        output_reader.close
         result
       end
     end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: minitest-silence
 version: !ruby/object:Gem::Version
-  version: 0.2.1
+  version: 0.2.2
 platform: ruby
 authors:
 - Willem van Bergen
-autorequire:
+autorequire: 
 bindir: exe
 cert_chain: []
-date: 2020-06-17 00:00:00.000000000 Z
+date: 2020-11-18 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: minitest
@@ -61,7 +61,7 @@ metadata:
   allowed_push_host: https://rubygems.org
   homepage_uri: https://github.com/Shopify/minitest-silence
   source_code_uri: https://github.com/Shopify/minitest-silence
-post_install_message:
+post_install_message: 
 rdoc_options: []
 require_paths:
 - lib
@@ -76,8 +76,8 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.1.2
-signing_key:
+rubygems_version: 3.0.3
+signing_key: 
 specification_version: 4
 summary: Minitest plugin to suppress output from tests.
 test_files: []