silent_stream 1.0.5 → 1.0.6

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: a8973e45d20ed7c5dcbf2c5b2efc32b182cf7450b5ab380e615e25c7f5469cb3
-  data.tar.gz: 8e4031ed9fab5ca71011f42427e406abaeac5cb8926983394d2f41fb90da0ac5
+  metadata.gz: e0674612ee30874ba629342778f29d7b96d6366b0398f2848a4a6958c59c2620
+  data.tar.gz: eac29a150200bfeafd87b8b31557f7c93d9d58d2116426ad5b9de55116a37ff0
 SHA512:
-  metadata.gz: 62d41a194185eb19b3b121c6d0a8b1ed85447d04babe386514c324b23959bea596f274fa97770579367ac76aa064c1477d210769ec6c8423c51c49bb7dce3c23
-  data.tar.gz: fd379c47ab834014b71609296e192364e79a0f74b8fbc6eade77bdd629fe5336012bbc68864f2a1027fc4c78ee8daf87c2f5b7d8573c0d1f7e3c557636dfe948
+  metadata.gz: 2b5398a3e02ebae7efb82c6582d08762e40dba67bd8d6b5420d2a4f4bdb79d09ee525c22b1c50a8f41b0b44a791c916f9255838b0316a4780349cd96eddc9950
+  data.tar.gz: 31604b518d7d6bd7097d557e187302b9d5846f1564e5a77f1774164d14cefd0549540c2a7e83298f7079c7f6a7518917ec96579efd59d3eab5dd408ac0624093

data/.gitignore

@@ -17,3 +17,5 @@
 
 *.gem
 /Gemfile.lock
+
+/gemfiles/*.lock

data/.ruby-version

@@ -1 +1 @@
-ruby-2.5.1
+2.7.0

data/.travis.yml

@@ -1,7 +1,10 @@
 ---
+sudo: false
+language: ruby
+cache:
+  bundler: true
 env:
   global:
-  - JRUBY_OPTS="-Xcli.debug=true --debug"
   - CC_TEST_REPORTER_ID=954687c8cc4840dccb8887a7bf1f1f6ea463f6c20c02f20186945ab17995e0ba
 
 before_script:
@@ -20,13 +23,17 @@ before_install:
 - gem install bundler -v 1.16.5
 
 install:
-- bundle install
-
-bundler_args: --no-deployment --jobs 3 --retry 3
+  - bundle install --path=${BUNDLE_PATH:-vendor/bundle} --no-deployment --jobs 3 --retry 3
 
-language: ruby
-cache: bundler
-rvm:
-- 2.3.7
-- 2.4.4
-- 2.5.1
+jobs:
+  include:
+    - rvm: ruby-2.3.8
+      gemfile: gemfiles/ruby_2.3.gemfile
+    - rvm: ruby-2.4.9
+      gemfile: gemfiles/ruby_2.4.gemfile
+    - rvm: ruby-2.5.7
+      gemfile: gemfiles/ruby_2.5.gemfile
+    - rvm: ruby-2.6.5
+      gemfile: gemfiles/ruby_2.6.gemfile
+    - rvm: ruby-2.7.0
+      gemfile: gemfiles/ruby_2.7.gemfile

data/Appraisals

@@ -0,0 +1,24 @@
+appraise "ruby_2.3" do
+  gem "rubocop", "0.77.0"
+  gem 'rubocop-minitest'
+end
+
+appraise "ruby_2.4" do
+  gem "rubocop", "0.77.0"
+  gem 'rubocop-minitest'
+end
+
+appraise "ruby_2.5" do
+  gem "rubocop"
+  gem 'rubocop-minitest'
+end
+
+appraise "ruby_2.6" do
+  gem "rubocop"
+  gem 'rubocop-minitest'
+end
+
+appraise "ruby_2.7" do
+  gem "rubocop"
+  gem 'rubocop-minitest'
+end

data/README.md

@@ -4,11 +4,12 @@ SilentStream is an extraction of some parts of ActiveSupport's Kernel Reporting
 
 Since July 2014 `silence_stream`, `silence_stderr`, `capture`, `silence`, and `quietly` have been deprecated because they are not thread safe.  See that discussion in the [PR where it all went down](https://github.com/rails/rails/pull/13392). I rely on them a lot in *single threaded* code, and so I plan to keep them alive.  With the exception of `silence`, which was just an alias of `capture`.
 
-This gem was taken out of Rails but it is *not* Rails dependent.  The extraction was total (**even the tests**!), and this is now a pure Ruby library, which can be used in any Ruby project without encumbrances.
+This gem was taken out of Rails but it is *not* Rails dependent.  The extraction was total (**even the tests**!), and this is now a pure Ruby library, which can be used in any Ruby project without encumbrances.  *This gem has no runtime dependencies*.
 
 | Project                 |  SilentStream |
 |------------------------ | ----------------------- |
 | gem name                |  [silent_stream](https://rubygems.org/gems/silent_stream) |
+| compatibility           |  Ruby 2.3, 2.4, 2.5, 2.6, 2.7 |
 | license                 |  [![License: MIT](https://img.shields.io/badge/License-MIT-green.svg)](https://opensource.org/licenses/MIT) |
 | download rank           |  [![Downloads Today](https://img.shields.io/gem/rd/silent_stream.svg)](https://github.com/pboling/silent_stream) |
 | version                 |  [![Version](https://img.shields.io/gem/v/silent_stream.svg)](https://rubygems.org/gems/silent_stream) |
@@ -47,11 +48,33 @@ Or install it yourself as:
 
 ## Usage
 
-Usage:
+Four standard methods you may be familiar with from ActiveSupport's previous implementation are provided:
+
+```
+silence_stderr
+silence_stream
+capture
+quietly
+```
+
+They are direct replicas, *except* not mixed into `Kernel` or `Object`, so in order to use them you must mix them into your classes or modules.
+
+```
+class Bogosity
+  include SilentStream::Extracted # allows use at instance level
+  extend SilentStream::Extracted # allows use at class level
+  # or
+  include SilentStream # access everything, and add #silence_all method, see below
+end
+```
+
+In addition there is a `silence_all` method that is a useful wrapper that can be easily instrumented (turned off and on) with an ENV variable switch.
+
+Including the `SilentStream` namespace fully gives access to this enhanced method, as well as the extracted methods above, and also makes everything available at the class and instance levels.
 
 ```ruby
 class Bogosity
-  include SilentStream # allows use at instance or class level
+  include SilentStream # allows use of any method at instance or class level
 
   def silent
     silence_all(true) do
@@ -69,7 +92,9 @@ class Bogosity
   end
 end
 ```
+
 And run
+
 ```
 >> Bogosity.new.silent # has no output
 => nil
@@ -78,6 +103,29 @@ play that funky music
 => nil
 ```
 
+## Use in Specs / Tests
+
+Make the methods avaialble:
+```
+RSpec.configure do |conf|
+  conf.include SilentStream
+end
+```
+
+Then add a test on output:
+```
+it 'has output' do
+  output = capture(:stdout) { subject.request(:get, '/success') }
+  logs = [
+      'INFO -- request: GET https://api.example.com/success',
+      'INFO -- response: Status 200'
+  ]
+  expect(output).to include(*logs)
+end
+```
+
+See it in practice in the [specs for the oauth2 gem](https://github.com/oauth-xx/oauth2/blob/master/spec/oauth2/client_spec.rb#L193)
+
 ## 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.

data/gemfiles/ruby_2.3.gemfile

@@ -0,0 +1,8 @@
+# This file was generated by Appraisal
+
+source "https://rubygems.org"
+
+gem "rubocop", "0.77.0"
+gem "rubocop-minitest"
+
+gemspec path: "../"

data/gemfiles/ruby_2.4.gemfile

@@ -0,0 +1,8 @@
+# This file was generated by Appraisal
+
+source "https://rubygems.org"
+
+gem "rubocop", "0.77.0"
+gem "rubocop-minitest"
+
+gemspec path: "../"

data/gemfiles/ruby_2.5.gemfile

@@ -0,0 +1,8 @@
+# This file was generated by Appraisal
+
+source "https://rubygems.org"
+
+gem "rubocop"
+gem "rubocop-minitest"
+
+gemspec path: "../"

data/gemfiles/ruby_2.6.gemfile

@@ -0,0 +1,8 @@
+# This file was generated by Appraisal
+
+source "https://rubygems.org"
+
+gem "rubocop"
+gem "rubocop-minitest"
+
+gemspec path: "../"

data/gemfiles/ruby_2.7.gemfile

@@ -0,0 +1,8 @@
+# This file was generated by Appraisal
+
+source "https://rubygems.org"
+
+gem "rubocop"
+gem "rubocop-minitest"
+
+gemspec path: "../"

data/lib/silent_stream.rb

@@ -23,26 +23,44 @@ module SilentStream
     #
     # This method is not thread-safe.
     def silence_all(switch = true, temporary_level = Logger::ERROR, logger = nil)
-      if !switch || ENV['NO_SILENCE'] == 'true'
+      if !switch || silent_stream_no_silence
         yield
       else
         begin
-          logger ||= defined?(Rails) ? Rails.logger : nil
-          logger && (old_logger_level = logger.level || true) && (logger.level = temporary_level)
+          logger ||= silent_stream_logger
+          old_logger_level = silent_stream_reset_logger_level(logger, temporary_level)
           # silence STDOUT (like puts)
           silence_stream(STDOUT) do
             yield
           end
         ensure
-          logger && (logger.level = old_logger_level)
+          silent_stream_reset_logger_level(logger, old_logger_level)
         end
       end
     end
+
+    private
+
+    def silent_stream_no_silence
+      ENV['NO_SILENCE'] == 'true'
+    end
+
+    def silent_stream_logger
+      defined?(Rails) ? Rails.logger : nil
+    end
+
+    # returns previous logger's level
+    def silent_stream_reset_logger_level(logger, temporary_level)
+      logger && (old_logger_level = logger.level || true) && (logger.level = temporary_level)
+      old_logger_level
+    end
   end
 
   # Extracted from:
   # https://github.com/rails/rails/blob/4-2-stable/activesupport/lib/active_support/core_ext/kernel/reporting.rb
   module Extracted
+    SILENT_STREAM_NULL_DEVICE = defined?(IO::NULL) ? IO::NULL : Gem.win_platform? ? 'NUL:' : '/dev/null'
+
     # This method is not thread-safe.
     def silence_stderr
       silence_stream(STDERR) { yield }
@@ -59,7 +77,11 @@ module SilentStream
     # This method is not thread-safe.
     def silence_stream(stream)
       old_stream = stream.dup
-      stream.reopen(windows_os_test ? 'NUL:' : '/dev/null')
+      begin
+        stream.reopen(SILENT_STREAM_NULL_DEVICE, 'a+')
+      rescue Exception => e
+        stream.puts "[SilentStream] Unable to silence. #{e.class}: #{e.message}"
+      end
       stream.sync = true
       yield
     ensure
@@ -119,15 +141,15 @@ module SilentStream
 
     private
 
-    WINDOWS_REGEXP = /mswin|mingw/
-    REGEXP_HAS_MATCH = Gem::Version.new(RUBY_VERSION) >= Gem::Version.new('2.4')
+    SILENT_STREAM_WINDOWS_REGEXP = /mswin|mingw/.freeze
+    SILENT_STREAM_REGEXP_HAS_MATCH = Gem::Version.new(RUBY_VERSION) >= Gem::Version.new('2.4')
     def windows_os_test
       # When available, in Ruby 2.4+, we use Regexp#match? which does not update
       #   the $~ global object and may be 3x faster than alternative match tests
-      if REGEXP_HAS_MATCH
-        WINDOWS_REGEXP.match?(RbConfig::CONFIG['host_os'])
+      if SILENT_STREAM_REGEXP_HAS_MATCH
+        SILENT_STREAM_WINDOWS_REGEXP.match?(RbConfig::CONFIG['host_os'])
       else
-        WINDOWS_REGEXP =~ (RbConfig::CONFIG['host_os'])
+        SILENT_STREAM_WINDOWS_REGEXP =~ (RbConfig::CONFIG['host_os'])
       end
     end
   end

data/lib/silent_stream/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module SilentStream
-  VERSION = '1.0.5'
+  VERSION = '1.0.6'
 end

data/silent_stream.gemspec

@@ -55,15 +55,13 @@ Gem::Specification.new do |spec|
   spec.require_paths = ['lib']
   spec.license       = 'MIT'
 
-  if RUBY_VERSION < '1.9.3'
-    spec.add_development_dependency 'rake', '>= 10.4'
-  else
-    spec.add_development_dependency 'rake'
-  end
-  spec.add_development_dependency 'bundler', '~> 1.16'
-  spec.add_development_dependency 'minitest', '~> 5.10'
+  spec.add_development_dependency 'rake'
+  spec.add_development_dependency 'appraisal'
+  spec.add_development_dependency 'bundler'
+  spec.add_development_dependency 'minitest', '>= 5.10'
   spec.add_development_dependency 'minitest-reporters'
   spec.add_development_dependency 'mocha'
-  spec.add_development_dependency 'simplecov', '~> 0.16'
-  spec.add_development_dependency 'test-unit', '~> 3.2'
+  spec.add_development_dependency 'simplecov', '>= 0.16'
+  spec.add_development_dependency 'test-unit', '>= 3.2'
+  spec.add_development_dependency 'wwtd'
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: silent_stream
 version: !ruby/object:Gem::Version
-  version: 1.0.5
+  version: 1.0.6
 platform: ruby
 authors:
 - Jeremy Daer
@@ -33,7 +33,7 @@ authors:
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2018-10-10 00:00:00.000000000 Z
+date: 2020-02-25 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rake
@@ -49,32 +49,46 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
+- !ruby/object:Gem::Dependency
+  name: appraisal
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: bundler
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '1.16'
+        version: '0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '1.16'
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: minitest
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
         version: '5.10'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
         version: '5.10'
 - !ruby/object:Gem::Dependency
@@ -109,30 +123,44 @@ dependencies:
   name: simplecov
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
         version: '0.16'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
         version: '0.16'
 - !ruby/object:Gem::Dependency
   name: test-unit
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
         version: '3.2'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
         version: '3.2'
+- !ruby/object:Gem::Dependency
+  name: wwtd
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
 description: ActiveSupport Kernel Reporting Detritus with a few enhancements
 email:
 - peter.boling@gmail.com
@@ -144,6 +172,7 @@ files:
 - ".rubocop.yml"
 - ".ruby-version"
 - ".travis.yml"
+- Appraisals
 - CODE_OF_CONDUCT.md
 - Gemfile
 - LICENSE
@@ -151,6 +180,11 @@ files:
 - Rakefile
 - bin/console
 - bin/setup
+- gemfiles/ruby_2.3.gemfile
+- gemfiles/ruby_2.4.gemfile
+- gemfiles/ruby_2.5.gemfile
+- gemfiles/ruby_2.6.gemfile
+- gemfiles/ruby_2.7.gemfile
 - lib/silent_stream.rb
 - lib/silent_stream/version.rb
 - silent_stream.gemspec
@@ -173,8 +207,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubyforge_project: 
-rubygems_version: 2.7.7
+rubygems_version: 3.1.2
 signing_key: 
 specification_version: 4
 summary: ActiveSupport's Stream Silencing - Without ActiveSupport