silent_stream 1.0.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: a36117bf0e8da5ba4a7563d908fc474b3f69f4535de21570c931e98f8a992c90
+  data.tar.gz: 976264c386c6e665bd526fdd55ea3e73f741596ba2b7b00970b14c1f0eee370a
+SHA512:
+  metadata.gz: e257e32783765a193285ff7879d37cce12e41597046938f49bd8319427af1d41471eda5381af6176ece99a7acfb7857d30eec83bf86442b04c11f8cb3a590d61
+  data.tar.gz: a707e58b9e6a791c0e42941045b2e14b551e618291b7c91adb88cf513992fa30e04e0e614de2a4c92cdaadf54d02b263a21c10eaad744ae2b19d68946dc2a29f

data/.gitignore

@@ -0,0 +1,19 @@
+/.bundle/
+/.yardoc
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+
+# rspec failure tracking
+.rspec_status
+
+.byebug_history
+
+# iCloud Drive
+.nosync
+
+*.gem
+/Gemfile.lock

data/.rspec

@@ -0,0 +1,3 @@
+--format documentation
+--color
+--require spec_helper

data/.rubocop.yml

@@ -0,0 +1,2 @@
+Layout/DotPosition:
+  EnforcedStyle: trailing

data/.ruby-version

@@ -0,0 +1 @@
+ruby-2.5.1

data/.travis.yml

@@ -0,0 +1,32 @@
+---
+env:
+  global:
+  - JRUBY_OPTS="-Xcli.debug=true --debug"
+  - CC_TEST_REPORTER_ID=954687c8cc4840dccb8887a7bf1f1f6ea463f6c20c02f20186945ab17995e0ba
+
+before_script:
+- curl -L https://codeclimate.com/downloads/test-reporter/test-reporter-latest-linux-amd64 > ./cc-test-reporter
+- chmod +x ./cc-test-reporter
+- ./cc-test-reporter before-build
+
+script:
+- bundle exec rake
+
+after_script:
+- ./cc-test-reporter after-build --exit-code $TRAVIS_TEST_RESULT
+
+before_install:
+- gem update --system
+- gem install bundler -v 1.16.5
+
+install:
+- bundle install
+
+bundler_args: --no-deployment --jobs 3 --retry 3
+
+language: ruby
+cache: bundler
+rvm:
+  - 2.3.7
+  - 2.4.4
+  - 2.5.1

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 peter.boling@gmail.com. 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 [http://contributor-covenant.org/version/1/4][version]
+
+[homepage]: http://contributor-covenant.org
+[version]: http://contributor-covenant.org/version/1/4/

data/Gemfile

@@ -0,0 +1,6 @@
+source 'https://rubygems.org'
+
+git_source(:github) { |repo_name| "https://github.com/#{repo_name}" }
+
+# Specify your gem's dependencies in silent_stream.gemspec
+gemspec

data/README.md

@@ -0,0 +1,126 @@
+# SilentStream
+
+Memoist is an extraction of some parts of ActiveSupport's Kernel Reporting Core Extentions.
+
+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, and this is now a pure Ruby library, which can be used in any Ruby project without encumbrances.
+
+| Project                 |  RequireBench |
+|------------------------ | ----------------------- |
+| gem name                |  [silent_stream](https://rubygems.org/gems/silent_stream) |
+| 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) |
+| continuous integration  |  [![Build Status](https://travis-ci.org/pboling/silent_stream.svg?branch=master)](https://travis-ci.org/pboling/silent_stream) |
+| test coverage           |  [![Test Coverage](https://api.codeclimate.com/v1/badges/ced7e39984dd9c27c528/test_coverage)](https://codeclimate.com/github/pboling/silent_stream/test_coverage) |
+| maintainability         |  [![Maintainability](https://api.codeclimate.com/v1/badges/ced7e39984dd9c27c528/maintainability)](https://codeclimate.com/github/pboling/silent_stream/maintainability) |
+| dependencies            |  [![Depfu](https://badges.depfu.com/badges/6633827ecc1ad3b5dd749b4ac822347b/count.svg)](https://depfu.com/github/pboling/silent_stream?project_id=5828) |
+| code triage             |  [![Open Source Helpers](https://www.codetriage.com/pboling/silent_stream/badges/users.svg)](https://www.codetriage.com/pboling/silent_stream) |
+| homepage                |  [on Github.com][homepage], [on Railsbling.com][blogpage] |
+| documentation           |  [on RDoc.info][documentation] |
+| Spread ~♡ⓛⓞⓥⓔ♡~      |  [🌍 🌎 🌏](https://about.me/peter.boling), [🍚](https://www.crowdrise.com/helprefugeeswithhopefortomorrowliberia/fundraiser/peterboling), [➕](https://plus.google.com/+PeterBoling/posts), [👼](https://angel.co/peter-boling), [🐛](https://www.topcoder.com/members/pboling/), [:shipit:](http://coderwall.com/pboling), [![Tweet Peter](https://img.shields.io/twitter/follow/galtzo.svg?style=social&label=Follow)](http://twitter.com/galtzo) |
+
+## NOTE
+
+One aspect of what this gem provides can be achieved with the Rails' built-in [`LoggerSilence`](https://github.com/rails/rails/blob/5-2-stable/activesupport/lib/active_support/logger_silence.rb), which is thread safe.  You will have to decide what is right for you!
+
+## Doing a Rails <= 4 to Rails >= 5 Upgrade?
+
+The reason for not keeping `silence` as it was in Rails 4, i.e. an alias of `capture`, is that the just mentioned `LoggerSilence` now uses this term, and it is shipping with Rails 5. I don't want to make this gem incompatible with Rails 5, so you will have to convert Rails <= 4 implementations that utilize `silence` over to `capture` when using this gem.  One further point of difference is this gem does not add the methods to `Kernel` or `Object`.  You can do that if you like via `include`.  By default this gem does not pollute anything, so you will need to `include SilentStream` in any class using these methods.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'silent_stream'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install silent_stream
+
+## Usage
+
+Usage:
+
+```ruby
+class Bogosity
+  include SilentStream # allows use at instance or class level
+
+  def silent
+    silence_all(true) do
+      puts "play that funky music"
+      Rails.logger.info "git jiggy with it"
+    end
+  end
+  class << self
+    def noise
+      silence_all(false) do
+        puts "play that funky music"
+        Rails.logger.info "git jiggy with it"
+      end
+    end
+  end
+end
+```
+And run
+```
+>> Bogosity.new.silent # has no output
+=> nil
+>> Bogosity.noise # is noisy
+play that funky music
+=> nil
+```
+
+## 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.
+
+To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in `version.rb`, and then run `bundle exec 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/pboling/silent_stream.
+
+## Code of Conduct
+
+Everyone interacting in the AnonymousActiveRecord project’s codebases, issue trackers, chat rooms and mailing lists is expected to follow the [code of conduct](https://github.com/pboling/silent_stream/blob/master/CODE_OF_CONDUCT.md).
+
+## Versioning
+
+This library aims to adhere to [Semantic Versioning 2.0.0][semver].
+Violations of this scheme should be reported as bugs. Specifically,
+if a minor or patch version is released that breaks backward
+compatibility, a new version should be immediately released that
+restores compatibility. Breaking changes to the public API will
+only be introduced with new major versions.
+
+As a result of this policy, you can (and should) specify a
+dependency on this gem using the [Pessimistic Version Constraint][pvc] with two digits of precision.
+
+For example:
+
+```ruby
+spec.add_dependency 'silent_stream', '~> 1.0'
+```
+
+## License
+
+* Copyright (c) 2018 [Peter H. Boling][peterboling] of [Rails Bling][railsbling]
+
+[![License: MIT](https://img.shields.io/badge/License-MIT-green.svg)](https://opensource.org/licenses/MIT)
+
+[license]: LICENSE
+[semver]: http://semver.org/
+[pvc]: http://guides.rubygems.org/patterns/#pessimistic-version-constraint
+[railsbling]: http://www.railsbling.com
+[peterboling]: http://www.peterboling.com
+[documentation]: http://rdoc.info/github/pboling/silent_stream/frames
+[homepage]: https://github.com/pboling/silent_stream/
+[blogpage]: http://www.railsbling.com/tags/silent_stream/

data/Rakefile

@@ -0,0 +1,7 @@
+require 'bundler/gem_tasks'
+
+task :default => [ :test ]
+
+task :test do
+  ruby '-Ilib tests/silent_stream_test.rb'
+end

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require 'bundler/setup'
+require 'silent_stream'
+
+# 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/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/silent_stream/version.rb

@@ -0,0 +1,3 @@
+module SilentStream
+  VERSION = '1.0.0'.freeze
+end

data/lib/silent_stream.rb

@@ -0,0 +1,115 @@
+require 'silent_stream/version'
+
+module SilentStream
+  def self.included(base)
+    base.send(:extend, Extracted)
+    base.send(:include, Extracted)
+    base.send(:extend, Enhanced)
+    base.send(:include, Enhanced)
+  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.
+    #
+    # This method is not thread-safe.
+    def silence_all(switch = true, temporary_level = Logger::ERROR, logger = nil)
+      if !switch || ENV['NO_SILENCE'] == 'true'
+        yield
+      else
+        begin
+          logger ||= defined?(Rails) ? Rails.logger : nil
+          logger && (old_logger_level = logger.level || true) && (logger.level = temporary_level)
+          # silence STDOUT (like puts)
+          silence_stream(STDOUT) do
+            yield
+          end
+        ensure
+          logger && (logger.level = old_logger_level)
+        end
+      end
+    end
+  end
+
+  # Extracted from:
+  # https://github.com/rails/rails/blob/4-2-stable/activesupport/lib/active_support/core_ext/kernel/reporting.rb
+  module Extracted
+    # This method is not thread-safe.
+    def silence_stderr
+      silence_stream(STDERR) { yield }
+    end
+
+    # Silences any stream for the duration of the block.
+    #
+    #   silence_stream(STDOUT) do
+    #     puts 'This will never be seen'
+    #   end
+    #
+    #   puts 'But this will'
+    #
+    # This method is not thread-safe.
+    def silence_stream(stream)
+      old_stream = stream.dup
+      stream.reopen(RbConfig::CONFIG['host_os'] =~ /mswin|mingw/ ? 'NUL:' : '/dev/null')
+      stream.sync = true
+      yield
+    ensure
+      stream.reopen(old_stream)
+      old_stream.close
+    end
+
+    # Captures the given stream and returns it:
+    #
+    #   stream = capture(:stdout) { puts 'notice' }
+    #   stream # => "notice\n"
+    #
+    #   stream = capture(:stderr) { warn 'error' }
+    #   stream # => "error\n"
+    #
+    # even for subprocesses:
+    #
+    #   stream = capture(:stdout) { system('echo notice') }
+    #   stream # => "notice\n"
+    #
+    #   stream = capture(:stderr) { system('echo error 1>&2') }
+    #   stream # => "error\n"
+    #
+    # This method is not thread-safe.
+    def capture(stream)
+      stream = stream.to_s
+      captured_stream = Tempfile.new(stream)
+      stream_io = eval("$#{stream}")
+      origin_stream = stream_io.dup
+      stream_io.reopen(captured_stream)
+
+      yield
+
+      stream_io.rewind
+      captured_stream.read
+    ensure
+      captured_stream.close
+      captured_stream.unlink
+      stream_io.reopen(origin_stream)
+    end
+    # silence is provided by the LoggerSilence concern that continues to be
+    # shipped with Rails, so not continuing with this alias.
+    # alias silence capture
+
+    # Silences both STDOUT and STDERR, even for subprocesses.
+    #
+    #   quietly { system 'bundle install' }
+    #
+    # This method is not thread-safe.
+    def quietly
+      silence_stream(STDOUT) do
+        silence_stream(STDERR) do
+          yield
+        end
+      end
+    end
+  end
+end

data/silent_stream.gemspec

@@ -0,0 +1,62 @@
+lib = File.expand_path('lib', __dir__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'silent_stream/version'
+
+Gem::Specification.new do |spec|
+authors = [
+  # Everyone who touched the files extracted from Rails:
+  ['jeremy',            'Jeremy Daer'],
+  ['dhh',               'David Heinemeier Hansson'],
+  ['pixeltrix',         'Andrew White'],
+  ['spastorino',        'Santiago Pastorino'],
+  ['sstephenson',       'Sam Stephenson'],
+  ['amatsuda',          'Akira Matsuda'],
+  ['Raphomet',          'Raphael Lee'],
+  ['rafaelfranca',      'Rafael França'],
+  ['mariovisic',        'Mario Visic'],
+  ['krekoten',          "Мар'ян Крекотень"],
+  ['lest',              'Sergey Nartimov'],
+  ['joshk',             'Josh Kalderimis'],
+  ['fxn',               'Xavier Noria'],
+  ['deivid-rodriguez',  'David Rodríguez'],
+  ['route',             'Dmitry Vorotilin'],
+  ['tenderlove',        'Aaron Patterson'],
+  ['guilleiguaran',     'Guillermo Iguaran'],
+  ['gazay',             'Alexey Gaziev'],
+  ['wycats',            'Yehuda Katz'],
+  ['tommeier',          'Tom Meier'],
+  ['lifo',              'Pratik Naik'],
+  ['charliesome',       'Charlie Somerville'],
+  ['atambo',            'Alex Tambellini'],
+  ['arthurnn',          'Arthur Nogueira Neves'],
+  ['anildigital',       'Anil Wadghule'],
+  # Author/Maintainer of this gem:
+  ['pboling',           'Peter Boling']
+]
+
+  spec.name          = 'silent_stream'
+  spec.version       = SilentStream::VERSION
+  spec.authors       = authors.map { |_gh, name| name }
+  spec.email         = ['peter.boling@gmail.com']
+
+  spec.summary       = 'ActiveSupport Kernel Reporting Detritus with a few enhancements'
+  spec.homepage      = 'https://github.com/pboling/silent_stream'
+
+  # 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(__dir__)) do
+    `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(tests|spec|features)/}) }
+  end
+  spec.bindir        = 'exe'
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ['lib']
+
+  if RUBY_VERSION < '1.9.3'
+    spec.add_development_dependency 'rake', '>= 10.4'
+  else
+    spec.add_development_dependency 'rake'
+  end
+  spec.add_development_dependency 'test-unit', '~> 3.2'
+  spec.add_development_dependency 'minitest', '~> 5.10'
+  spec.add_development_dependency 'bundler', '~> 1.16'
+end

metadata

@@ -0,0 +1,138 @@
+--- !ruby/object:Gem::Specification
+name: silent_stream
+version: !ruby/object:Gem::Version
+  version: 1.0.0
+platform: ruby
+authors:
+- Jeremy Daer
+- David Heinemeier Hansson
+- Andrew White
+- Santiago Pastorino
+- Sam Stephenson
+- Akira Matsuda
+- Raphael Lee
+- Rafael França
+- Mario Visic
+- Мар'ян Крекотень
+- Sergey Nartimov
+- Josh Kalderimis
+- Xavier Noria
+- David Rodríguez
+- Dmitry Vorotilin
+- Aaron Patterson
+- Guillermo Iguaran
+- Alexey Gaziev
+- Yehuda Katz
+- Tom Meier
+- Pratik Naik
+- Charlie Somerville
+- Alex Tambellini
+- Arthur Nogueira Neves
+- Anil Wadghule
+- Peter Boling
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2018-09-23 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rake
+  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: 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: 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
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.16'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.16'
+description: 
+email:
+- peter.boling@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- ".rubocop.yml"
+- ".ruby-version"
+- ".travis.yml"
+- CODE_OF_CONDUCT.md
+- Gemfile
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- lib/silent_stream.rb
+- lib/silent_stream/version.rb
+- silent_stream.gemspec
+homepage: https://github.com/pboling/silent_stream
+licenses: []
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.7.7
+signing_key: 
+specification_version: 4
+summary: ActiveSupport Kernel Reporting Detritus with a few enhancements
+test_files: []