silent_stream 1.0.10 → 1.0.12

data/RUBOCOP.md

@@ -0,0 +1,71 @@
+# RuboCop Usage Guide
+
+## Overview
+
+A tale of two RuboCop plugin gems.
+
+### RuboCop Gradual
+
+This project uses `rubocop_gradual` instead of vanilla RuboCop for code style checking. The `rubocop_gradual` tool allows for gradual adoption of RuboCop rules by tracking violations in a lock file.
+
+### RuboCop LTS
+
+This project uses `rubocop-lts` to ensure, on a best-effort basis, compatibility with Ruby >= 1.9.2.
+RuboCop rules are meticulously configured by the `rubocop-lts` family of gems to ensure that a project is compatible with a specific version of Ruby. See: https://rubocop-lts.gitlab.io for more.
+
+## Checking RuboCop Violations
+
+To check for RuboCop violations in this project, always use:
+
+```bash
+bundle exec rake rubocop_gradual:check
+```
+
+**Do not use** the standard RuboCop commands like:
+- `bundle exec rubocop`
+- `rubocop`
+
+## Understanding the Lock File
+
+The `.rubocop_gradual.lock` file tracks all current RuboCop violations in the project. This allows the team to:
+
+1. Prevent new violations while gradually fixing existing ones
+2. Track progress on code style improvements
+3. Ensure CI builds don't fail due to pre-existing violations
+
+## Common Commands
+
+- **Check violations**
+    - `bundle exec rake rubocop_gradual`
+    - `bundle exec rake rubocop_gradual:check`
+- **(Safe) Autocorrect violations, and update lockfile if no new violations**
+  - `bundle exec rake rubocop_gradual:autocorrect`
+- **Force update the lock file (w/o autocorrect) to match violations present in code**
+  - `bundle exec rake rubocop_gradual:force_update`
+
+## Workflow
+
+1. Before submitting a PR, run `bundle exec rake rubocop_gradual:autocorrect`
+   a. or just the default `bundle exec rake`, as autocorrection is a pre-requisite of the default task.
+2. If there are new violations, either:
+   - Fix them in your code
+   - Run `bundle exec rake rubocop_gradual:force_update` to update the lock file (only for violations you can't fix immediately)
+3. Commit the updated `.rubocop_gradual.lock` file along with your changes
+
+## Never add inline RuboCop disables
+
+Do not add inline `rubocop:disable` / `rubocop:enable` comments anywhere in the codebase (including specs, except when following the few existing `rubocop:disable` patterns for a rule already being disabled elsewhere in the code). We handle exceptions in two supported ways:
+
+- Permanent/structural exceptions: prefer adjusting the RuboCop configuration (e.g., in `.rubocop.yml`) to exclude a rule for a path or file pattern when it makes sense project-wide.
+- Temporary exceptions while improving code: record the current violations in `.rubocop_gradual.lock` via the gradual workflow:
+  - `bundle exec rake rubocop_gradual:autocorrect` (preferred; will autocorrect what it can and update the lock only if no new violations were introduced)
+  - If needed, `bundle exec rake rubocop_gradual:force_update` (as a last resort when you cannot fix the newly reported violations immediately)
+
+In general, treat the rules as guidance to follow; fix violations rather than ignore them. For example, RSpec conventions in this project expect `described_class` to be used in specs that target a specific class under test.
+
+## Benefits of rubocop_gradual
+
+- Allows incremental adoption of code style rules
+- Prevents CI failures due to pre-existing violations
+- Provides a clear record of code style debt
+- Enables focused efforts on improving code quality over time

data/checksums/silent_stream-1.0.10.gem.sha256

@@ -0,0 +1 @@
+b67962588acdddcb8b1972e35b4b0606bfcc23dd966841b7fec26cd282dc8a47

data/checksums/silent_stream-1.0.10.gem.sha512

@@ -0,0 +1 @@
+062b86979e8ba71e8ad2d5861e62a6624afc00758cfd5752be7cf8209e87fabe1b9d51cc2e35c4be7c8f25a7f46011d485605b4d40c4f1fcfd8d813f5d1ab218

data/checksums/silent_stream-1.0.11.gem.sha256

@@ -0,0 +1 @@
+62f30ff2c1352f675eb2bff9170168d4e2524d71caf3e86be36a1ea741eedcd7

data/checksums/silent_stream-1.0.11.gem.sha512

@@ -0,0 +1 @@
+9a3bd81805f4514e499baf2de8994e3782239f09251304e17fdd5fa822bdc68938ad7a7c00cd92c633ed851e003b720b4230082f17a7095150e9305ac9dab0cb

data/checksums/silent_stream-1.0.12.gem.sha256

@@ -0,0 +1 @@
+f3cdf0e2ef000d28ea28cd324a4e74fcf3ec49a0fee6f156b862aedd1ae7d19c

data/checksums/silent_stream-1.0.12.gem.sha512

@@ -0,0 +1 @@
+677edc4416117621d892c13e119be6335b2a29c4efc0c09ce1a71d7ad33792572a7922d5b16f14c409ea6743518621d053eaf182a880aad492be49e6bb77d366

data/checksums/silent_stream-1.0.9.gem.sha256

@@ -0,0 +1 @@
+45e15ce4ba2d8d2ccbc07b165e795be4bff64715565fb102eb8be8a7c4a0b36c

data/checksums/silent_stream-1.0.9.gem.sha512

@@ -0,0 +1 @@
+196f3d50a68953899daeafa4e6ef1da6ecf073a1e4f9dbc56ff2e606b50be717297de84309c81d4d32c66a1a85545e721d662233affc512add1616f0ad6fc2f4

data/lib/silent_stream/version.rb

@@ -2,6 +2,6 @@
 
 module SilentStream
   module Version
-    VERSION = "1.0.10"
+    VERSION = "1.0.12"
   end
 end

data/lib/silent_stream.rb

@@ -21,14 +21,14 @@ module SilentStream
   end
 
   module Enhanced
-    # param switch is true or false
-    # By default it is true, when means we don't want logging.
-    # Switching it to false enables logging again.
-    # By default, ERROR log level continues to be logged.
-    # The return value is the return value of the block,
-    #   so you can use it without changing code structure.
+    # Silences STDOUT and optionally a Logger while executing the block.
     #
-    # This method is not thread-safe.
+    # @param switch [Boolean] When false, do not silence. Defaults to true.
+    # @param temporary_level [Integer] Logger level to set temporarily (e.g., Logger::ERROR).
+    # @param logger [Logger, nil] Logger instance to adjust; defaults to Rails.logger when available.
+    # @yield The work to perform while silenced.
+    # @return [Object] Returns the block's return value.
+    # @note This method is not thread-safe.
     def silence_all(switch = true, temporary_level = Logger::ERROR, logger = nil, &block)
       if !switch || silent_stream_no_silence
         yield
@@ -67,10 +67,14 @@ module SilentStream
     SILENT_STREAM_NULL_DEVICE = if defined?(IO::NULL)
       IO::NULL
     else
+      # :nocov:
       Gem.win_platform? ? "NUL:" : "/dev/null"
+      # :nocov:
     end
 
     # This method is not thread-safe.
+    # @yield Work to perform while STDERR is silenced.
+    # @return [Object] The block's return value.
     def silence_stderr(&block)
       silence_stream(STDERR, &block)
     end
@@ -83,12 +87,15 @@ module SilentStream
     #
     #   puts 'But this will'
     #
-    # This method is not thread-safe.
+    # @param stream [IO] The stream to silence (e.g., STDOUT or STDERR).
+    # @yield Work to perform while the stream is silenced.
+    # @return [Object] The block's return value.
+    # @note This method is not thread-safe.
     def silence_stream(stream)
       old_stream = stream.dup
       begin
         stream.reopen(SILENT_STREAM_NULL_DEVICE, "a+")
-      rescue Exception => e
+      rescue StandardError => e
         stream.puts "[SilentStream] Unable to silence. #{e.class}: #{e.message}"
       end
       stream.sync = true
@@ -114,22 +121,67 @@ module SilentStream
     #   stream = capture(:stderr) { system('echo error 1>&2') }
     #   stream # => "error\n"
     #
-    # This method is not thread-safe.
+    # @param stream [Symbol, String] :stdout or :stderr (or equivalents), selecting which stream to capture.
+    # @yield Work that writes to the selected stream.
+    # @return [String] Captured contents of the stream written during the block.
+    # @note This method is not thread-safe.
     def capture(stream)
       stream = stream.to_s
+      io_const = (stream == "stdout") ? STDOUT : STDERR # rubocop:disable Style/GlobalStdStream
       captured_stream = Tempfile.new(stream)
-      stream_io = eval("$#{stream}")
-      origin_stream = stream_io.dup
-      stream_io.reopen(captured_stream)
+      # Save original global var ($stdout/$stderr) and a dup of IO constant for restoration
+      origin_gvar = (stream == "stdout") ? $stdout : $stderr
+      origin_io_dup = io_const.dup
+      begin
+        io_const.reopen(captured_stream)
+      rescue StandardError => e
+        io_const.puts "[SilentStream] Unable to capture. #{e.class}: #{e.message}"
+      end
+      io_const.sync = true
+      if stream == "stdout"
+        $stdout = io_const
+      else
+        $stderr = io_const
+      end
 
       yield
 
-      stream_io.rewind
+      begin
+        io_const.flush
+      rescue StandardError
+        # ignore
+      end
+      captured_stream.rewind
       captured_stream.read
     ensure
-      captured_stream.close
-      captured_stream.unlink
-      stream_io.reopen(origin_stream)
+      begin
+        io_const.reopen(origin_io_dup) if defined?(io_const) && io_const
+        origin_io_dup.close if defined?(origin_io_dup) && origin_io_dup
+      rescue StandardError
+        # ignore
+      end
+      # Unexpected, and not reasonably testable.
+      # :nocov:
+      raise "Expected the global variable to exist" unless defined?(origin_gvar)
+      # :nocov:
+
+      if stream == "stdout"
+        $stdout = origin_gvar
+      else
+        $stderr = origin_gvar
+      end
+      if defined?(captured_stream) && captured_stream
+        begin
+          captured_stream.close
+        rescue
+          nil
+        end
+        begin
+          captured_stream.unlink
+        rescue
+          nil
+        end
+      end
     end
     # silence is provided by the LoggerSilence concern that continues to be
     # shipped with Rails, so not continuing with this alias.
@@ -139,12 +191,16 @@ module SilentStream
     #
     #   quietly { system 'bundle install' }
     #
-    # This method is not thread-safe.
+    # @yield Work to perform while both streams are silenced.
+    # @return [Object] The block's return value.
+    # @note This method is not thread-safe.
+    # rubocop:disable Style/GlobalStdStream
     def quietly(&block)
       silence_stream(STDOUT) do
         silence_stream(STDERR, &block)
       end
     end
+    # rubocop:enable Style/GlobalStdStream
 
     private
 

data/sig/silent_stream.rbs

@@ -0,0 +1,44 @@
+module SilentStream
+  module Enhanced
+    # Silence STDOUT (and optionally a Logger) while executing the given block.
+    # When switch is false or NO_SILENCE env var is true, the block executes without silencing.
+    # Returns the block's return value.
+    def silence_all: (*untyped) { () -> untyped } -> untyped
+
+    private
+
+    def silent_stream_no_silence: () -> bool
+    def silent_stream_logger: () -> (::Logger | nil)
+    # Sets logger.level, returns previous level (Integer) or true when previous level was nil
+    def silent_stream_reset_logger_level: (::Logger?, Integer) -> (Integer | true | nil)
+  end
+
+  module Extracted
+    SILENT_STREAM_NULL_DEVICE: String | IO
+
+    # Silence STDERR for the duration of the given block.
+    def silence_stderr: () { () -> untyped } -> untyped
+
+    # Silences the given stream for the duration of the block.
+    # Returns the block's return value.
+    def silence_stream: (IO) { () -> untyped } -> untyped
+
+    # Capture the given stream (:stdout or :stderr) while running the block and
+    # return it as a String.
+    def capture: (Symbol | String) { () -> untyped } -> String
+
+    # Silence both STDOUT and STDERR while running the block.
+    # Returns the block's return value.
+    def quietly: () { () -> untyped } -> untyped
+
+    private
+
+    SILENT_STREAM_WINDOWS_REGEXP: Regexp
+    SILENT_STREAM_REGEXP_HAS_MATCH: bool
+    def windows_os_test: () -> (bool | Integer)
+  end
+end
+
+module SilentStream::Version
+end
+

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: silent_stream
 version: !ruby/object:Gem::Version
-  version: 1.0.10
+  version: 1.0.12
 platform: ruby
 authors:
 - Jeremy Daer
@@ -60,98 +60,124 @@ cert_chain:
   DVjBtqT23eugOqQ73umLcYDZkc36vnqGxUBSsXrzY9pzV5gGr2I8YUxMqf6ATrZt
   L9nRqA==
   -----END CERTIFICATE-----
-date: 2025-05-05 00:00:00.000000000 Z
+date: 2025-08-21 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: logger
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: 1.4.4
+        version: '1.2'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: 1.4.4
+        version: '1.2'
 - !ruby/object:Gem::Dependency
   name: version_gem
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '1.1'
     - - ">="
       - !ruby/object:Gem::Version
-        version: 1.1.7
+        version: 1.1.8
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '3'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 1.1.8
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '3'
+- !ruby/object:Gem::Dependency
+  name: stone_checksums
+  requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.1'
-    - - ">="
+        version: '1.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: 1.1.7
+        version: '1.0'
 - !ruby/object:Gem::Dependency
-  name: minitest
+  name: appraisal2
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '5.15'
+        version: '3.0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '5.15'
+        version: '3.0'
 - !ruby/object:Gem::Dependency
-  name: minitest-reporters
+  name: minitest
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '5.15'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '5.15'
 - !ruby/object:Gem::Dependency
-  name: mocha
+  name: minitest-reporters
   requirement: !ruby/object:Gem::Requirement
     requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.7'
     - - ">="
       - !ruby/object:Gem::Version
-        version: '0'
+        version: 1.7.1
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.7'
     - - ">="
       - !ruby/object:Gem::Version
-        version: '0'
+        version: 1.7.1
 - !ruby/object:Gem::Dependency
-  name: rake
+  name: mocha
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '13.0'
+        version: '2.7'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 2.7.1
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '13.0'
+        version: '2.7'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 2.7.1
 - !ruby/object:Gem::Dependency
   name: ruby_engine
   requirement: !ruby/object:Gem::Requirement
@@ -159,6 +185,9 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '2.0'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 2.0.3
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
@@ -166,6 +195,9 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '2.0'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 2.0.3
 - !ruby/object:Gem::Dependency
   name: ruby_version
   requirement: !ruby/object:Gem::Requirement
@@ -173,6 +205,9 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '1.0'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 1.0.3
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
@@ -180,13 +215,47 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '1.0'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 1.0.3
 - !ruby/object:Gem::Dependency
-  name: stone_checksums
+  name: test-unit
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '3.7'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '3.7'
+- !ruby/object:Gem::Dependency
+  name: erb
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '2.2'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '2.2'
+- !ruby/object:Gem::Dependency
+  name: gitmoji-regex
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '1.0'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 1.0.3
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
@@ -194,59 +263,101 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '1.0'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 1.0.3
 - !ruby/object:Gem::Dependency
-  name: test-unit
+  name: rake
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '3.2'
+        version: '13.0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '3.2'
-description: ActiveSupport Kernel Reporting Detritus with a few enhancements
+        version: '13.0'
+description: "\U0001F515 (formerly) ActiveSupport Kernel Reporting Detritus with a
+  few enhancementsFund overlooked open source projects - bottom of stack, dev/test
+  dependencies: floss-funding.dev"
 email:
-- peter.boling@gmail.com
+- floss@galtzo.com
 executables: []
 extensions: []
 extra_rdoc_files:
 - CHANGELOG.md
+- CITATION.cff
 - CODE_OF_CONDUCT.md
 - CONTRIBUTING.md
 - LICENSE.txt
 - README.md
+- REEK
+- RUBOCOP.md
 - SECURITY.md
+- checksums/silent_stream-1.0.10.gem.sha256
+- checksums/silent_stream-1.0.10.gem.sha512
+- checksums/silent_stream-1.0.11.gem.sha256
+- checksums/silent_stream-1.0.11.gem.sha512
+- checksums/silent_stream-1.0.12.gem.sha256
+- checksums/silent_stream-1.0.12.gem.sha512
+- checksums/silent_stream-1.0.9.gem.sha256
+- checksums/silent_stream-1.0.9.gem.sha512
+- sig/silent_stream.rbs
 files:
 - CHANGELOG.md
+- CITATION.cff
 - CODE_OF_CONDUCT.md
 - CONTRIBUTING.md
 - LICENSE.txt
 - README.md
+- REEK
+- RUBOCOP.md
 - SECURITY.md
+- checksums/silent_stream-1.0.10.gem.sha256
+- checksums/silent_stream-1.0.10.gem.sha512
+- checksums/silent_stream-1.0.11.gem.sha256
+- checksums/silent_stream-1.0.11.gem.sha512
+- checksums/silent_stream-1.0.12.gem.sha256
+- checksums/silent_stream-1.0.12.gem.sha512
+- checksums/silent_stream-1.0.9.gem.sha256
+- checksums/silent_stream-1.0.9.gem.sha512
 - lib/silent_stream.rb
 - lib/silent_stream/version.rb
-homepage: https://github.com/pboling/silent_stream
+- sig/silent_stream.rbs
+homepage: https://github.com/galtzo-floss/silent_stream
 licenses:
 - MIT
 metadata:
-  homepage_uri: https://github.com/pboling/silent_stream
-  source_code_uri: https://github.com/pboling/silent_stream/tree/v1.0.10
-  changelog_uri: https://github.com/pboling/silent_stream/blob/v1.0.10/CHANGELOG.md
-  bug_tracker_uri: https://github.com/pboling/silent_stream/issues
-  documentation_uri: https://www.rubydoc.info/gems/silent_stream/1.0.10
-  wiki_uri: https://github.com/pboling/silent_stream/wiki
-  funding_uri: https://liberapay.com/pboling
+  homepage_uri: https://silent-stream.galtzo.com/
+  source_code_uri: https://github.com/galtzo-floss/silent_stream/tree/v1.0.12
+  changelog_uri: https://github.com/galtzo-floss/silent_stream/blob/v1.0.12/CHANGELOG.md
+  bug_tracker_uri: https://github.com/galtzo-floss/silent_stream/issues
+  documentation_uri: https://www.rubydoc.info/gems/silent_stream/1.0.12
+  funding_uri: https://github.com/sponsors/pboling
+  wiki_uri: https://github.com/galtzo-floss/silent_stream/wiki
   news_uri: https://www.railsbling.com/tags/silent_stream
+  discord_uri: https://discord.gg/3qme4XHNKN
   rubygems_mfa_required: 'true'
 rdoc_options:
 - "--title"
-- silent_stream - ActiveSupport's Stream Silencing - Without ActiveSupport
+- "silent_stream - \U0001F515 (formerly) ActiveSupport's Stream Silencing - Without
+  ActiveSupport"
 - "--main"
+- checksums/**/*.sha256
+- checksums/**/*.sha512
+- sig/**/*.rbs
+- CHANGELOG.md
+- CITATION.cff
+- CODE_OF_CONDUCT.md
+- CONTRIBUTING.md
+- LICENSE.txt
 - README.md
+- REEK
+- RUBOCOP.md
+- SECURITY.md
 - "--line-numbers"
 - "--inline-source"
 - "--quiet"
@@ -263,7 +374,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.6.8
+rubygems_version: 3.7.1
 specification_version: 4
-summary: ActiveSupport's Stream Silencing - Without ActiveSupport
+summary: "\U0001F515 (formerly) ActiveSupport's Stream Silencing - Without ActiveSupport"
 test_files: []