minitest-silence 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: f6db18145fa32f96ca4c2f3ca5fe7099949b0603ee5fdff92981564f1b18e606
+  data.tar.gz: 456dcf9fe20ddc6302d1c1a611958c65752d3177f31184ab467a9ff53d9946ff
+SHA512:
+  metadata.gz: fa01057df17eb458c34fa559e5b108583cc614b669d85657eb22d254e5ad6b171257f0a39291eb87bb93a93723a8624fbdc8804571fd4c2bd38ab14824be050f
+  data.tar.gz: 6f318bca2ebe5dab21ab5f07ad32ace16b9d02838d25d96d72c8ce843096b1166b03ca79a1f5aa2ccc71944c6f42d7cda6af1a33e3dcacdf6c81433230fa4c55

data/.github/workflows/ruby.yml

@@ -0,0 +1,37 @@
+name: Ruby
+
+on: push
+
+jobs:
+  test:
+    name: "Tests (on Ruby ${{ matrix.ruby_version }})"
+    runs-on: ubuntu-latest
+    strategy:
+      fail-fast: false
+      matrix:
+        ruby_version: [2.5, 2.6, 2.7]
+
+    steps:
+    - name: Set up Ruby ${{ matrix.ruby_version }}
+      uses: actions/setup-ruby@v1
+      with:
+        ruby-version: ${{ matrix.ruby_version }}
+    - uses: actions/checkout@v2
+    - name: Install dependencies
+      run: gem update --system && gem install bundler && bundle install
+    - name: Run tests
+      run: bin/rake test
+
+  lint:
+    name: "Lint (using Rubocop)"
+    runs-on: ubuntu-latest
+    steps:
+    - name: Set up Ruby 2.5
+      uses: actions/setup-ruby@v1
+      with:
+        ruby-version: 2.5
+    - uses: actions/checkout@v2
+    - name: Install dependencies
+      run: gem install bundler && bundle install
+    - name: Lint Ruby code
+      run: bin/rubocop

data/.gitignore

@@ -0,0 +1,8 @@
+/.bundle/
+/.yardoc
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/

data/.rubocop.yml

@@ -0,0 +1,32 @@
+inherit_gem:
+  rubocop-shopify: rubocop.yml
+
+AllCops:
+  TargetRubyVersion: 2.5
+  UseCache: true
+  CacheRootDirectory: tmp/rubocop
+  Exclude:
+    - minitest-stateful.gemspec
+
+Style/MethodCallWithArgsParentheses:
+  IgnoredMethods:
+    - require
+    - require_relative
+    - raise
+    - assert
+    - refute
+    - assert_equal
+    - refute_equal
+    - assert_nil
+    - refute_nil
+    - assert_predicate
+    - refute_predicate
+    - assert_empty
+    - refute_empty
+    - assert_includes
+    - refute_includes
+    - flunk
+
+# This cop is still broken
+Layout/RescueEnsureAlignment:
+  Enabled: false

data/.travis.yml

@@ -0,0 +1,6 @@
+---
+language: ruby
+cache: bundler
+rvm:
+  - 2.6.6
+before_install: gem install bundler -v 2.1.4

data/CODE_OF_CONDUCT.md

@@ -0,0 +1,74 @@
+# Contributor Covenant Code of Conduct
+
+## Our Pledge
+
+In the interest of fostering an open and welcoming environment, we as
+contributors and maintainers pledge to making participation in our project and
+our community a harassment-free experience for everyone, regardless of age, body
+size, disability, ethnicity, gender identity and expression, level of experience,
+nationality, personal appearance, race, religion, or sexual identity and
+orientation.
+
+## Our Standards
+
+Examples of behavior that contributes to creating a positive environment
+include:
+
+* Using welcoming and inclusive language
+* Being respectful of differing viewpoints and experiences
+* Gracefully accepting constructive criticism
+* Focusing on what is best for the community
+* Showing empathy towards other community members
+
+Examples of unacceptable behavior by participants include:
+
+* The use of sexualized language or imagery and unwelcome sexual attention or
+advances
+* Trolling, insulting/derogatory comments, and personal or political attacks
+* Public or private harassment
+* Publishing others' private information, such as a physical or electronic
+  address, without explicit permission
+* Other conduct which could reasonably be considered inappropriate in a
+  professional setting
+
+## Our Responsibilities
+
+Project maintainers are responsible for clarifying the standards of acceptable
+behavior and are expected to take appropriate and fair corrective action in
+response to any instances of unacceptable behavior.
+
+Project maintainers have the right and responsibility to remove, edit, or
+reject comments, commits, code, wiki edits, issues, and other contributions
+that are not aligned to this Code of Conduct, or to ban temporarily or
+permanently any contributor for other behaviors that they deem inappropriate,
+threatening, offensive, or harmful.
+
+## Scope
+
+This Code of Conduct applies both within project spaces and in public spaces
+when an individual is representing the project or its community. Examples of
+representing a project or community include using an official project e-mail
+address, posting via an official social media account, or acting as an appointed
+representative at an online or offline event. Representation of a project may be
+further defined and clarified by project maintainers.
+
+## Enforcement
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be
+reported by contacting the project team at willem@vanbergen.org. All
+complaints will be reviewed and investigated and will result in a response that
+is deemed necessary and appropriate to the circumstances. The project team is
+obligated to maintain confidentiality with regard to the reporter of an incident.
+Further details of specific enforcement policies may be posted separately.
+
+Project maintainers who do not follow or enforce the Code of Conduct in good
+faith may face temporary or permanent repercussions as determined by other
+members of the project's leadership.
+
+## Attribution
+
+This Code of Conduct is adapted from the [Contributor Covenant][homepage], version 1.4,
+available at [https://contributor-covenant.org/version/1/4][version]
+
+[homepage]: https://contributor-covenant.org
+[version]: https://contributor-covenant.org/version/1/4/

data/Gemfile

@@ -0,0 +1,9 @@
+# frozen_string_literal: true
+source "https://rubygems.org"
+
+# Specify your gem's dependencies in minitest-silence.gemspec
+gemspec
+
+gem "rake", "~> 12.0"
+gem "minitest", "~> 5.0"
+gem "rubocop-shopify"

data/Gemfile.lock

@@ -0,0 +1,42 @@
+PATH
+  remote: .
+  specs:
+    minitest-silence (0.1.0)
+      minitest (~> 5.12)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    ast (2.4.0)
+    jaro_winkler (1.5.4)
+    minitest (5.14.1)
+    parallel (1.19.1)
+    parser (2.7.1.3)
+      ast (~> 2.4.0)
+    rainbow (3.0.0)
+    rake (12.3.3)
+    rexml (3.2.4)
+    rubocop (0.82.0)
+      jaro_winkler (~> 1.5.1)
+      parallel (~> 1.10)
+      parser (>= 2.7.0.1)
+      rainbow (>= 2.2.2, < 4.0)
+      rexml
+      ruby-progressbar (~> 1.7)
+      unicode-display_width (>= 1.4.0, < 2.0)
+    rubocop-shopify (1.0.2)
+      rubocop (~> 0.82.0)
+    ruby-progressbar (1.10.1)
+    unicode-display_width (1.7.0)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  minitest (~> 5.0)
+  minitest-silence!
+  rake (~> 12.0)
+  rubocop-shopify
+
+BUNDLED WITH
+   2.1.4

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2020 Willem van Bergen
+
+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,37 @@
+# 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.
+
+## Installation
+
+Add this line to your application's Gemfile, and run `bundle install`:
+
+```ruby
+gem 'minitest-silence', require: false
+```
+
+## Usage
+
+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`.
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake test` 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 `bin/rake install`. To release a new version, update the version number in `version.rb`, and then run `bin/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).
+
+## 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).
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).
+
+## Code of Conduct
+
+Everyone interacting in the Minitest::Silence project's codebases, issue trackers, chat rooms and mailing lists is expected to follow the [code of conduct](https://github.com/Shopify/minitest-silence/blob/master/CODE_OF_CONDUCT.md).

data/Rakefile

@@ -0,0 +1,13 @@
+# frozen_string_literal: true
+require "bundler/gem_tasks"
+require "rake/testtask"
+
+Rake::TestTask.new(:test) do |t|
+  t.libs << "test"
+  t.libs << "lib"
+  t.test_files = FileList["test/**/*_test.rb"] -
+    FileList["test/lib/**/*_test.rb"] -
+    FileList["test/fixtures/**/*_test.rb"]
+end
+
+task(default: :test)

data/bin/console

@@ -0,0 +1,15 @@
+#!/usr/bin/env ruby
+# frozen_string_literal: true
+
+require "bundler/setup"
+require "minitest/silence"
+
+# You can add fixtures and/or initialization code here to make experimenting
+# with your gem easier. You can also use a different console, if you like.
+
+# (If you use this, don't forget to add pry to your Gemfile!)
+# require "pry"
+# Pry.start
+
+require "irb"
+IRB.start(__FILE__)

data/bin/rake

@@ -0,0 +1,29 @@
+#!/usr/bin/env ruby
+# frozen_string_literal: true
+
+#
+# This file was generated by Bundler.
+#
+# The application 'rake' is installed as part of a gem, and
+# this file is here to facilitate running it.
+#
+
+require "pathname"
+ENV["BUNDLE_GEMFILE"] ||= File.expand_path("../../Gemfile",
+  Pathname.new(__FILE__).realpath)
+
+bundle_binstub = File.expand_path("../bundle", __FILE__)
+
+if File.file?(bundle_binstub)
+  if File.read(bundle_binstub, 300) =~ /This file was generated by Bundler/
+    load(bundle_binstub)
+  else
+    abort("Your `bin/bundle` was not generated by Bundler, so this binstub cannot run.
+Replace `bin/bundle` by running `bundle binstubs bundler --force`, then run this command again.")
+  end
+end
+
+require "rubygems"
+require "bundler/setup"
+
+load(Gem.bin_path("rake", "rake"))

data/bin/rubocop

@@ -0,0 +1,29 @@
+#!/usr/bin/env ruby
+# frozen_string_literal: true
+
+#
+# This file was generated by Bundler.
+#
+# The application 'rubocop' is installed as part of a gem, and
+# this file is here to facilitate running it.
+#
+
+require "pathname"
+ENV["BUNDLE_GEMFILE"] ||= File.expand_path("../../Gemfile",
+  Pathname.new(__FILE__).realpath)
+
+bundle_binstub = File.expand_path("../bundle", __FILE__)
+
+if File.file?(bundle_binstub)
+  if File.read(bundle_binstub, 300) =~ /This file was generated by Bundler/
+    load(bundle_binstub)
+  else
+    abort("Your `bin/bundle` was not generated by Bundler, so this binstub cannot run.
+Replace `bin/bundle` by running `bundle binstubs bundler --force`, then run this command again.")
+  end
+end
+
+require "rubygems"
+require "bundler/setup"
+
+load(Gem.bin_path("rubocop", "rubocop"))

data/bin/setup

@@ -0,0 +1,8 @@
+#!/usr/bin/env bash
+set -euo pipefail
+IFS=$'\n\t'
+set -vx
+
+bundle install
+
+# Do any other automated setup that you need to do here

data/lib/minitest/silence/boxed_output_reporter.rb

@@ -0,0 +1,14 @@
+# frozen_string_literal: true
+
+module Minitest
+  module Silence
+    class BoxedOutputReporter < Minitest::Reporter
+      def record(result)
+        unless result.output.empty?
+          io.puts(Minitest::Silence.boxed("Output from #{result.class_name}##{result.name}", result.output))
+          io.puts
+        end
+      end
+    end
+  end
+end

data/lib/minitest/silence/fail_on_output_reporter.rb

@@ -0,0 +1,19 @@
+# frozen_string_literal: true
+
+module Minitest
+  module Silence
+    class FailOnOutputReporter < Minitest::Reporter
+      def record(result)
+        unless result.output.empty?
+          assertion = Minitest::Assertion.new(<<~EOM.chomp)
+            The test unexpectedly wrote output to STDOUT or STDERR.
+
+            #{Minitest::Silence.boxed('Output', result.output)}
+          EOM
+          assertion.set_backtrace(caller)
+          result.failures << assertion
+        end
+      end
+    end
+  end
+end

data/lib/minitest/silence/version.rb

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

data/lib/minitest/silence_plugin.rb

@@ -0,0 +1,69 @@
+# frozen_string_literal: true
+
+require "minitest/silence/fail_on_output_reporter"
+require "minitest/silence/boxed_output_reporter"
+require "minitest/silence/version"
+require "io/console"
+
+module Minitest
+  module Silence
+    Error = Class.new(StandardError)
+    UnexpectedOutput = Class.new(Error)
+
+    module ResultOutputPatch
+      attr_accessor :output
+    end
+
+    module RunOneMethodPatch
+      def run_one_method(klass, method_name)
+        output_reader, output_writer = IO.pipe
+        output_thread = Thread.new { output_reader.read }
+
+        old_stdout = $stdout.dup
+        old_stderr = $stderr.dup
+
+        result = begin
+          $stdout.reopen(output_writer)
+          $stderr.reopen(output_writer)
+          super
+        ensure
+          $stdout.reopen(old_stdout)
+          $stderr.reopen(old_stderr)
+          output_writer.close
+        end
+
+        result.output = output_thread.value
+        result
+      end
+    end
+
+    class << self
+      def boxed(title, content)
+        box = +"── #{title} ──\n"
+        box << "#{content}\n"
+        box << "───#{'─' * title.length}───\n"
+      end
+    end
+  end
+
+  class << self
+    def plugin_silence_options(opts, options)
+      opts.on('--fail-on-output', "Fail a test when it writes to STDOUT or STDERR") do
+        options[:fail_on_output] = true
+      end
+    end
+
+    def plugin_silence_init(options)
+      Minitest::Result.prepend(Minitest::Silence::ResultOutputPatch)
+      Minitest.singleton_class.prepend(Minitest::Silence::RunOneMethodPatch)
+
+      if options[:fail_on_output]
+        # We have to make sure this reporter runs as the first reporter, so it can still adjust
+        # the result and other reporters will take the change into account.
+        reporter.reporters.unshift(Minitest::Silence::FailOnOutputReporter.new(options[:io], options))
+      elsif options[:verbose]
+        reporter << Minitest::Silence::BoxedOutputReporter.new(options[:io], options)
+      end
+    end
+  end
+end

data/minitest-silence.gemspec

@@ -0,0 +1,37 @@
+# frozen_string_literal: true
+require_relative 'lib/minitest/silence/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "minitest-silence"
+  spec.version       = Minitest::Silence::VERSION
+  spec.authors       = ["Willem van Bergen"]
+  spec.email         = ["willem@vanbergen.org"]
+
+  spec.summary       = 'Minitest plugin to suppress output from tests.'
+  spec.description   = <<~DESCRIPTION
+    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.
+  DESCRIPTION
+  spec.homepage      = "https://github.com/Shopify/minitest-silence"
+  spec.license       = "MIT"
+  spec.required_ruby_version = Gem::Requirement.new(">= 2.3.0")
+
+  spec.metadata["allowed_push_host"] = "https://rubygems.org"
+
+  spec.metadata["homepage_uri"] = spec.homepage
+  spec.metadata["source_code_uri"] = "https://github.com/Shopify/minitest-silence"
+
+  # Specify which files should be added to the gem when it is released.
+  # The `git ls-files -z` loads the files in the RubyGem that have been added into git.
+  spec.files = Dir.chdir(File.expand_path('..', __FILE__)) do
+    %x(git ls-files -z).split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
+  end
+  spec.bindir        = "exe"
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ["lib"]
+
+  spec.add_dependency("minitest", "~> 5.12")
+end

metadata

@@ -0,0 +1,84 @@
+--- !ruby/object:Gem::Specification
+name: minitest-silence
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Willem van Bergen
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2020-06-03 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: minitest
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5.12'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5.12'
+description: |
+  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.
+email:
+- willem@vanbergen.org
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".github/workflows/ruby.yml"
+- ".gitignore"
+- ".rubocop.yml"
+- ".travis.yml"
+- CODE_OF_CONDUCT.md
+- Gemfile
+- Gemfile.lock
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/rake
+- bin/rubocop
+- bin/setup
+- lib/minitest/silence/boxed_output_reporter.rb
+- lib/minitest/silence/fail_on_output_reporter.rb
+- lib/minitest/silence/version.rb
+- lib/minitest/silence_plugin.rb
+- minitest-silence.gemspec
+homepage: https://github.com/Shopify/minitest-silence
+licenses:
+- MIT
+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: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 2.3.0
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.1.2
+signing_key: 
+specification_version: 4
+summary: Minitest plugin to suppress output from tests.
+test_files: []