no_shit_in_my_green_dots 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 60d92b885844546d8b21b5a5c65a7ee3ba5f3dcbc7a0babdf6f8e9b8cac191bd
+  data.tar.gz: 71f19dd05cb35ffb9768ff103205aedeb9756a713befcb0cc79da1a4609deef7
+SHA512:
+  metadata.gz: a6775155b5cdc02c3754a3c2efef143d7eb3bc58173f44c66b18a583551e1bcdac08086954093c57c68abf629c6fb92a080ccaf8de5a5ea1e4b61a65b67fb4f2
+  data.tar.gz: 8cbf9bac58a4f359cc3b6d572ef830df0ecbf4b28c82343a0071ce2c80eb6aef6af148a9181301f4dcfa1f2aefa75d241a1b7d227d256119049b4696df3619d8

data/.github/workflows/ci.yml

@@ -0,0 +1,28 @@
+name: CI
+
+on:
+  push:
+    branches:
+      - main
+  pull_request:
+
+jobs:
+  test:
+    runs-on: ubuntu-latest
+    strategy:
+      fail-fast: false
+      matrix:
+        ruby: ["3.2", "3.3", "3.4"]
+
+    steps:
+      - name: Checkout
+        uses: actions/checkout@v4
+
+      - name: Setup Ruby
+        uses: ruby/setup-ruby@v1
+        with:
+          ruby-version: ${{ matrix.ruby }}
+          bundler-cache: true
+
+      - name: Run standardrb + tests
+        run: bundle exec rake

data/.mise.toml

@@ -0,0 +1,2 @@
+[tools]
+ruby = "3.4"

data/.standard.yml

@@ -0,0 +1 @@
+ruby_version: 3.1

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2025 Nate Berkopec
+
+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,67 @@
+# NoShitInMyGreenDots
+
+Are you sick of this?
+
+```
+Run options: --seed 12345
+
+# Running:
+
+.D, [2025-01-20T10:23:45.123456 #12345] DEBUG -- : Redis connected to localhost:6379
+.I, [2025-01-20T10:23:45.234567 #12345]  INFO -- : Processing user #1234
+.[ActiveJob] Enqueued EmailJob (Job ID: abc-123) to Sidekiq(default)
+.HTTP Request: GET /api/users
+..D, [2025-01-20T10:23:45.345678 #12345] DEBUG -- : Cache miss for key: user_1234
+.[Rack::Handler::WEBrick] 127.0.0.1 - - [20/Jan/2025:10:23:45 EST] "GET /health HTTP/1.1" 200
+I, [2025-01-20T10:23:45.456789 #12345]  INFO -- : Background job completed in 0.05s
+..
+
+Finished in 0.012345s, 810.0 runs/s, 810.0 assertions/s.
+
+10 runs, 10 assertions, 0 failures, 0 errors, 0 skips
+```
+
+Now, you can enforce your overly fastidious notions of clean test output on your friends and co-workers!
+
+```
+Run options: --seed 12345
+
+# Running:
+
+....F.....
+
+Finished in 0.012345s, 810.0 runs/s, 810.0 assertions/s.
+
+  1) STDOUT:
+NoisyTest#test_logs [test/noisy_test.rb:6]:
+Test wrote to STDOUT:
+---
+direct write
+I, [2025-01-01T12:34:56.789012 #1234]  INFO -- : logger write
+child_output
+---
+
+10 runs, 10 assertions, 1 failures, 0 errors, 0 skips
+```
+
+## Installation
+
+Add the gem to your bundle:
+
+```ruby
+group :test do
+  gem "no_shit_in_my_green_dots"
+end
+```
+
+If you need a work-safe name, use:
+
+```ruby
+group :test do
+  gem "no_stuff_in_my_green_dots"
+end
+```
+
+## How it works
+
+For each example/test, STDOUT is redirected to a pipe. If anything other than the test framework's reporter writes to STDOUT during that example/test, the example/test fails with a short dump of the captured output (truncated for very noisy cases). Only suite-wide enablement is supported; per-example toggles are intentionally not provided. STDERR is left alone, and IO objects that were duped from STDOUT *before* enabling the gem may not be caught—point long-lived loggers at `STDOUT`/`$stdout` after enabling if you need them guarded.

data/RELEASE.md

@@ -0,0 +1,10 @@
+# Release process
+
+1. Bump `lib/no_shit_in_my_green_dots/version.rb`.
+2. Release the primary gem (keeps tagging/metadata as-is):
+   - `bundle exec rake release`
+3. Publish the work-safe name at the same version (no extra tag):
+   - `bundle exec gem build no_stuff_in_my_green_dots.gemspec`
+   - `bundle exec gem push no_stuff_in_my_green_dots-<VERSION>.gem`
+
+Both gemspecs rely on the same code and version constant; keep them in lockstep.

data/Rakefile

@@ -0,0 +1,17 @@
+# frozen_string_literal: true
+
+require "bundler/gem_helper"
+Bundler::GemHelper.install_tasks name: "no_shit_in_my_green_dots"
+require "rake/testtask"
+
+desc "Run standardrb (lint)"
+task :standard do
+  sh "bundle exec standardrb"
+end
+
+Rake::TestTask.new(:test) do |t|
+  t.libs << "test"
+  t.pattern = "test/**/*_test.rb"
+end
+
+task default: %i[standard test]

data/gemspec_helper.rb

@@ -0,0 +1,43 @@
+# frozen_string_literal: true
+
+require_relative "lib/no_shit_in_my_green_dots/version"
+
+module NoShitInMyGreenDots
+  module GemspecHelper
+    module_function
+
+    def build(name:, gemspec_filename:)
+      Gem::Specification.new do |spec|
+        spec.name = name
+        spec.version = NoShitInMyGreenDots::VERSION
+        spec.authors = ["Nate Berkopec"]
+        spec.email = ["nate.berkopec@gmail.com"]
+
+        spec.summary = "Fails tests that leak STDOUT into your green dots."
+        spec.description = "A small helper you drop into spec_helper.rb or test_helper.rb to fail examples that write to STDOUT."
+        spec.homepage = "https://github.com/nateberkopec/no_shit_in_my_green_dots"
+        spec.license = "MIT"
+        spec.required_ruby_version = ">= 3.1.0"
+
+        spec.metadata["homepage_uri"] = spec.homepage
+        spec.metadata["source_code_uri"] = "https://github.com/nateberkopec/no_shit_in_my_green_dots"
+        spec.metadata["rubygems_mfa_required"] = "true"
+
+        spec.files = IO.popen(%w[git ls-files -z], chdir: __dir__, err: IO::NULL) do |ls|
+          ls.readlines("\x0", chomp: true).reject do |f|
+            (f == gemspec_filename) ||
+              f.start_with?(*%w[bin/ Gemfile .gitignore])
+          end
+        end
+        spec.bindir = "exe"
+        spec.executables = spec.files.grep(%r{\Aexe/}) { |f| File.basename(f) }
+        spec.require_paths = ["lib"]
+
+        spec.add_development_dependency "minitest", "~> 5.21"
+        spec.add_development_dependency "rake", "~> 13.0"
+        spec.add_development_dependency "rspec", "~> 3.13"
+        spec.add_development_dependency "standard", "~> 1.40"
+      end
+    end
+  end
+end

data/lib/no_shit_in_my_green_dots/minitest.rb

@@ -0,0 +1,43 @@
+# frozen_string_literal: true
+
+require "minitest"
+
+module NoShitInMyGreenDots
+  module Integrations
+    module Minitest
+      class StdoutLeak < ::Minitest::Assertion
+        RESULT_LABEL = "STDOUT"
+
+        def initialize(output)
+          super(NoShitInMyGreenDots.leak_message(output))
+          set_backtrace(caller)
+        end
+
+        def result_label
+          RESULT_LABEL
+        end
+      end
+
+      module TestExtension
+        def run
+          result = nil
+          stdout, = capture_io { result = super }
+
+          unless stdout.nil? || stdout.empty?
+            result.failures << StdoutLeak.new(stdout)
+          end
+
+          result
+        end
+      end
+
+      def self.install!
+        return if @installed
+
+        require "minitest/test"
+        ::Minitest::Test.prepend(TestExtension)
+        @installed = true
+      end
+    end
+  end
+end

data/lib/no_shit_in_my_green_dots/rspec.rb

@@ -0,0 +1,34 @@
+# frozen_string_literal: true
+
+require "rspec/core"
+
+module NoShitInMyGreenDots
+  module Integrations
+    module RSpec
+      class StdoutLeak < StandardError
+        def initialize(output)
+          super(NoShitInMyGreenDots.leak_message(output))
+        end
+      end
+
+      def self.install!
+        return if @installed
+
+        ::RSpec.configure do |config|
+          config.around do |example|
+            matcher = ::RSpec::Matchers::BuiltIn::Output.new(nil).to_stdout_from_any_process
+            matcher.matches?(-> { example.run })
+            captured_output = matcher.instance_variable_get(:@actual).to_s
+
+            next if captured_output.nil? || captured_output.empty?
+            next if example.exception
+
+            raise StdoutLeak.new(captured_output)
+          end
+        end
+
+        @installed = true
+      end
+    end
+  end
+end

data/lib/no_shit_in_my_green_dots/version.rb

@@ -0,0 +1,5 @@
+# frozen_string_literal: true
+
+module NoShitInMyGreenDots
+  VERSION = "0.1.0"
+end

data/lib/no_shit_in_my_green_dots.rb

@@ -0,0 +1,65 @@
+# frozen_string_literal: true
+
+require_relative "no_shit_in_my_green_dots/version"
+
+module NoShitInMyGreenDots
+  class Error < StandardError; end
+
+  class << self
+    def enable!(framework = nil)
+      @enabled ||= {}
+
+      frameworks = framework ? [framework] : [:rspec, :minitest]
+      frameworks.each { |fw| install_framework(fw) }
+    end
+
+    def enabled?(framework = nil)
+      return false unless defined?(@enabled)
+      return @enabled.values.any? if framework.nil?
+
+      !!@enabled[framework]
+    end
+
+    def leak_message(output)
+      return "Test wrote to STDOUT (no content captured)." if output.nil? || output.empty?
+
+      trimmed = output.dup
+      trimmed = trimmed[0, 720] + "...(truncated)" if trimmed.length > 720
+      <<~MSG
+        Test wrote to STDOUT:
+        ---
+        #{trimmed}
+        ---
+      MSG
+    end
+
+    private
+
+    def install_framework(framework)
+      return if @enabled[framework]
+
+      case framework
+      when :rspec
+        require "rspec/core"
+        require_relative "no_shit_in_my_green_dots/rspec"
+        Integrations::RSpec.install!
+      when :minitest
+        require "minitest"
+        require_relative "no_shit_in_my_green_dots/minitest"
+        Integrations::Minitest.install!
+      else
+        raise Error, "Unknown framework #{framework.inspect}"
+      end
+
+      @enabled[framework] = true
+    rescue LoadError
+      # Framework not available; skip install
+    end
+
+    def auto_enable!
+      enable!
+    end
+  end
+end
+
+NoShitInMyGreenDots.send(:auto_enable!)

data/no_stuff_in_my_green_dots.gemspec

@@ -0,0 +1,8 @@
+# frozen_string_literal: true
+
+require_relative "gemspec_helper"
+
+NoShitInMyGreenDots::GemspecHelper.build(
+  name: "no_stuff_in_my_green_dots",
+  gemspec_filename: File.basename(__FILE__)
+)

data/sig/no_shit_in_my_green_dots.rbs

@@ -0,0 +1,7 @@
+module NoShitInMyGreenDots
+  VERSION: String
+
+  def self.enable!: (?Symbol framework) -> void
+  def self.enabled?: (?Symbol framework) -> bool
+  def self.leak_message: (String) -> String
+end

data/test/fixtures/minitest/noisy/noisy_suite.rb

@@ -0,0 +1,12 @@
+# frozen_string_literal: true
+
+require_relative "test_helper"
+require "logger"
+
+class NoisyTest < Minitest::Test
+  def test_noise
+    puts "direct write"
+    Logger.new($stdout).info("logger write")
+    system("printf child_output")
+  end
+end

data/test/fixtures/minitest/noisy/test_helper.rb

@@ -0,0 +1,8 @@
+# frozen_string_literal: true
+
+$LOAD_PATH.unshift(File.expand_path("../../../../../lib", __dir__))
+
+require "minitest/autorun"
+require "no_shit_in_my_green_dots"
+
+NoShitInMyGreenDots.enable!(:minitest)

data/test/fixtures/minitest/quiet/quiet_suite.rb

@@ -0,0 +1,13 @@
+# frozen_string_literal: true
+
+require_relative "test_helper"
+
+class QuietTest < Minitest::Test
+  def test_math
+    assert_equal 2, 1 + 1
+  end
+
+  def test_string
+    assert_includes %w[a b c], "a"
+  end
+end

data/test/fixtures/minitest/quiet/test_helper.rb

@@ -0,0 +1,8 @@
+# frozen_string_literal: true
+
+$LOAD_PATH.unshift(File.expand_path("../../../../../lib", __dir__))
+
+require "minitest/autorun"
+require "no_shit_in_my_green_dots"
+
+NoShitInMyGreenDots.enable!(:minitest)

data/test/fixtures/rspec/noisy/spec_helper.rb

@@ -0,0 +1,14 @@
+# frozen_string_literal: true
+
+$LOAD_PATH.unshift(File.expand_path("../../../../../lib", __dir__))
+
+require "rspec"
+require "no_shit_in_my_green_dots"
+
+NoShitInMyGreenDots.enable!(:rspec)
+
+RSpec.configure do |config|
+  config.expect_with :rspec do |c|
+    c.syntax = :expect
+  end
+end

data/test/fixtures/rspec/noisy/stdout_spec.rb

@@ -0,0 +1,14 @@
+# frozen_string_literal: true
+
+require_relative "spec_helper"
+
+RSpec.describe "stdout noise" do
+  it "fails when writing to stdout" do
+    puts "spec noise"
+  end
+
+  it "fails when child writes to stdout" do
+    pid = fork { $stdout.puts "spec_child" }
+    Process.wait(pid)
+  end
+end

data/test/fixtures/rspec/quiet/spec_helper.rb

@@ -0,0 +1,14 @@
+# frozen_string_literal: true
+
+$LOAD_PATH.unshift(File.expand_path("../../../../../lib", __dir__))
+
+require "rspec"
+require "no_shit_in_my_green_dots"
+
+NoShitInMyGreenDots.enable!(:rspec)
+
+RSpec.configure do |config|
+  config.expect_with :rspec do |c|
+    c.syntax = :expect
+  end
+end

data/test/fixtures/rspec/quiet/stdout_spec.rb

@@ -0,0 +1,9 @@
+# frozen_string_literal: true
+
+require_relative "spec_helper"
+
+RSpec.describe "stdout quiet" do
+  it "stays silent" do
+    expect(1 + 1).to eq 2
+  end
+end

data/test/minitest_integration_test.rb

@@ -0,0 +1,44 @@
+# frozen_string_literal: true
+
+require "test_helper"
+require "open3"
+
+class MinitestIntegrationTest < Minitest::Test
+  def test_suite_fails_when_stdout_is_used
+    status, output = run_minitest_suite(fixture: "noisy")
+
+    refute status.success?, "Expected minitest suite to fail when STDOUT is used"
+    assert_includes output, "Test wrote to STDOUT"
+    assert_includes output, "direct write"
+    assert_includes output, "logger write"
+    assert_includes output, "child_output"
+  end
+
+  def test_suite_passes_when_quiet
+    status, output = run_minitest_suite(fixture: "quiet")
+
+    assert status.success?, "Expected quiet minitest suite to pass"
+    refute_includes output, "Test wrote to STDOUT"
+  end
+
+  private
+
+  def run_minitest_suite(fixture:)
+    fixture_path = File.expand_path("fixtures/minitest/#{fixture}", __dir__)
+    filename = "#{fixture}_suite.rb"
+    stdout, stderr, status = Open3.capture3(
+      bundle_env,
+      "bundle",
+      "exec",
+      "ruby",
+      filename,
+      chdir: fixture_path
+    )
+
+    [status, stdout + stderr]
+  end
+
+  def bundle_env
+    {"BUNDLE_GEMFILE" => File.expand_path("../Gemfile", __dir__)}
+  end
+end

data/test/rspec_integration_test.rb

@@ -0,0 +1,45 @@
+# frozen_string_literal: true
+
+require "test_helper"
+require "open3"
+
+class RSpecIntegrationTest < Minitest::Test
+  def test_suite_fails_when_stdout_is_used
+    status, output = run_rspec_suite(fixture: "noisy")
+
+    refute status.success?, "Expected rspec suite to fail when STDOUT is used"
+    assert_includes output, "Test wrote to STDOUT"
+    assert_includes output, "spec noise"
+    assert_includes output, "spec_child"
+  end
+
+  def test_suite_passes_when_quiet
+    status, output = run_rspec_suite(fixture: "quiet")
+
+    assert status.success?, "Expected quiet rspec suite to pass"
+    refute_includes output, "Test wrote to STDOUT"
+  end
+
+  private
+
+  def run_rspec_suite(fixture:)
+    fixture_path = File.expand_path("fixtures/rspec/#{fixture}", __dir__)
+
+    stdout, stderr, status = Open3.capture3(
+      bundle_env,
+      "bundle",
+      "exec",
+      "rspec",
+      "--format",
+      "progress",
+      "stdout_spec.rb",
+      chdir: fixture_path
+    )
+
+    [status, stdout + stderr]
+  end
+
+  def bundle_env
+    {"BUNDLE_GEMFILE" => File.expand_path("../Gemfile", __dir__)}
+  end
+end

data/test/test_helper.rb

@@ -0,0 +1,6 @@
+# frozen_string_literal: true
+
+$LOAD_PATH.unshift File.expand_path("../lib", __dir__)
+
+require "minitest/autorun"
+require "no_shit_in_my_green_dots"

metadata

@@ -0,0 +1,125 @@
+--- !ruby/object:Gem::Specification
+name: no_shit_in_my_green_dots
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Nate Berkopec
+bindir: exe
+cert_chain: []
+date: 1980-01-02 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: minitest
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5.21'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5.21'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '13.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '13.0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.13'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.13'
+- !ruby/object:Gem::Dependency
+  name: standard
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.40'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.40'
+description: A small helper you drop into spec_helper.rb or test_helper.rb to fail
+  examples that write to STDOUT.
+email:
+- nate.berkopec@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".github/workflows/ci.yml"
+- ".mise.toml"
+- ".standard.yml"
+- LICENSE.txt
+- README.md
+- RELEASE.md
+- Rakefile
+- gemspec_helper.rb
+- lib/no_shit_in_my_green_dots.rb
+- lib/no_shit_in_my_green_dots/minitest.rb
+- lib/no_shit_in_my_green_dots/rspec.rb
+- lib/no_shit_in_my_green_dots/version.rb
+- no_stuff_in_my_green_dots.gemspec
+- sig/no_shit_in_my_green_dots.rbs
+- test/fixtures/minitest/noisy/noisy_suite.rb
+- test/fixtures/minitest/noisy/test_helper.rb
+- test/fixtures/minitest/quiet/quiet_suite.rb
+- test/fixtures/minitest/quiet/test_helper.rb
+- test/fixtures/rspec/noisy/spec_helper.rb
+- test/fixtures/rspec/noisy/stdout_spec.rb
+- test/fixtures/rspec/quiet/spec_helper.rb
+- test/fixtures/rspec/quiet/stdout_spec.rb
+- test/minitest_integration_test.rb
+- test/rspec_integration_test.rb
+- test/test_helper.rb
+homepage: https://github.com/nateberkopec/no_shit_in_my_green_dots
+licenses:
+- MIT
+metadata:
+  homepage_uri: https://github.com/nateberkopec/no_shit_in_my_green_dots
+  source_code_uri: https://github.com/nateberkopec/no_shit_in_my_green_dots
+  rubygems_mfa_required: 'true'
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 3.1.0
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.6.9
+specification_version: 4
+summary: Fails tests that leak STDOUT into your green dots.
+test_files: []