mute 1.0.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 9fbad050d8943b84c90dcba8296406c41ca1809e
+  data.tar.gz: bfcdd12c57f38d6a2e90eec60fa5a8b15292bd74
+SHA512:
+  metadata.gz: cdb324d79d6d71ffb34e2ab0f8b9ed512c0b6447ac7755ca1575944e9dff09abfb09f59fec32356adb155e366576fdede4ac115cf925cc3b8aef0e9d6fe2d343
+  data.tar.gz: 6e3a5625524e2a1b7d5ad0b7c5cfd97eb6769a3d1ce1597235a8e88c00ec3dbe7cecf798c4e7e97d592ac9a023806a33a1f3813556c776ff8e9be20a381ecc09

data/.gitignore

@@ -0,0 +1,17 @@
+*.gem
+*.rbc
+.bundle
+.config
+.yardoc
+Gemfile.lock
+InstalledFiles
+_yardoc
+coverage
+doc/
+lib/bundler/man
+pkg
+rdoc
+spec/reports
+test/tmp
+test/version_tmp
+tmp

data/.travis.yml

@@ -0,0 +1,4 @@
+language: ruby
+rvm:
+  - 2.0.0
+  - 1.9.3

data/CHANGELOG.md

@@ -0,0 +1,6 @@
+# Changelog
+
+##v1.0.0
+*2014-01-19*
+
+- Initial release

data/CONTRIBUTING.md

@@ -0,0 +1,13 @@
+# Contributing
+
+Want to contribute? Awesome! Thank you so much.
+
+## How?
+
+1. [Fork it](https://help.github.com/articles/fork-a-repo)
+2. Create a feature branch (`git checkout -b my-new-feature`)
+3. Commit changes, **with tests** (`git commit -am 'Add some feature'`)
+4. Run the tests (`bundle exec rake`)
+5. Push to the branch (`git push origin my-new-feature`)
+6. Create new [Pull
+   Request](https://help.github.com/articles/using-pull-requests)

data/Gemfile

@@ -0,0 +1,4 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in mute.gemspec
+gemspec

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2014 Chris Hunt
+
+MIT License
+
+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,79 @@
+[![Travis CI](https://travis-ci.org/chrishunt/mute.png)](https://travis-ci.org/chrishunt/mute)
+[![Coverage Status](https://coveralls.io/repos/chrishunt/mute/badge.png?branch=master)](https://coveralls.io/r/chrishunt/mute)
+[![Code Climate](https://codeclimate.com/github/chrishunt/mute.png)](https://codeclimate.com/github/chrishunt/mute)
+
+### Muting test suites since 2014
+
+![](https://raw2.github.com/chrishunt/mute/master/screenshot.png)
+
+## Usage
+
+Tired of seeing garbage printed to the screen during your test suite? Would you
+like to prove that your fancy custom Logger is actually working? `Mute` is here
+to help!
+
+`Mute` can be used to mute and capture standard out or standard error in your
+Ruby program. This is most useful in tests where output should be tested, not
+displayed.
+
+To capture standard out:
+
+```ruby
+require 'mute'
+
+output = Mute::IO.capture_stdout do
+  puts 'Hello World!'
+end
+
+puts output
+  #=> Hello World!
+```
+
+To capture standard error:
+
+```ruby
+require 'mute'
+
+output = Mute::IO.capture_stderr do
+  $stderr.puts 'Oops!'
+end
+
+puts output
+  #=> Oops!
+```
+
+Or use it in your test suite:
+
+```ruby
+require 'mute'
+
+describe MyLogger do
+  it 'prints the message to standard out' do
+    message = 'Hello World!'
+
+    output = Mute::IO.capture_stdout do
+      MyLogger.new.print message
+    end
+
+    expect(output).to include message
+  end
+end
+```
+
+## Installation
+
+```bash
+$ gem install mute
+```
+
+## Contributing
+Please see the [Contributing
+Document](https://github.com/chrishunt/mute/blob/master/CONTRIBUTING.md)
+
+## Changelog
+Please see the [Changelog
+Document](https://github.com/chrishunt/mute/blob/master/CHANGELOG.md)
+
+## License
+Copyright (C) 2014 Chris Hunt, [MIT
+License](https://github.com/chrishunt/mute/blob/master/LICENSE.txt)

data/Rakefile

@@ -0,0 +1,15 @@
+require 'bundler/gem_tasks'
+require 'rspec/core/rake_task'
+require 'cane/rake_task'
+require 'cane/hashcheck'
+
+RSpec::Core::RakeTask.new(:spec) do |t|
+  t.rspec_opts = '--color'
+end
+
+Cane::RakeTask.new(:quality) do |t|
+  t.use Cane::HashCheck
+end
+
+task default: :spec
+task default: :quality

data/lib/mute.rb

@@ -0,0 +1,2 @@
+require 'mute/version'
+require 'mute/io'

data/lib/mute/io.rb

@@ -0,0 +1,26 @@
+require 'stringio'
+
+module Mute
+  # Mutes and captures stdout and stderr IO streams
+  class IO
+    [:stdout, :stderr].each do |stream|
+      define_singleton_method("capture_#{stream}") do |&block|
+        capture stream, block
+      end
+    end
+
+    private
+
+    def self.capture(stream, block)
+      captured = StringIO.new
+      original = eval("$#{stream}")
+      eval "$#{stream} = captured"
+
+      block.call if block
+
+      captured.string
+    ensure
+      eval "$#{stream} = original"
+    end
+  end
+end

data/lib/mute/version.rb

@@ -0,0 +1,3 @@
+module Mute
+  VERSION = '1.0.0'
+end

data/mute.gemspec

@@ -0,0 +1,28 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'mute/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "mute"
+  spec.version       = Mute::VERSION
+  spec.authors       = ["Chris Hunt"]
+  spec.email         = ["c@chrishunt.co"]
+  spec.summary       = %q{Muting test suites since 2014}
+  spec.description   = %q{Muting test suites since 2014}
+  spec.homepage      = "https://github.com/chrishunt/mute"
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files -z`.split("\x0")
+  spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
+  spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
+  spec.require_paths = ["lib"]
+
+  spec.add_development_dependency 'bundler',        '~> 1.5'
+  spec.add_development_dependency 'cane',           '~> 2.6.1'
+  spec.add_development_dependency 'cane-hashcheck', '~> 1.2.0'
+  spec.add_development_dependency 'coveralls',      '~> 0.7.0'
+  spec.add_development_dependency 'pry',            '~> 0.9.12'
+  spec.add_development_dependency 'rake',           '~> 10.1.1'
+  spec.add_development_dependency 'rspec',          '~> 2.14.1'
+end

data/spec/mute/io_spec.rb

@@ -0,0 +1,62 @@
+require 'spec_helper'
+require 'mute/io'
+
+describe Mute::IO do
+  describe '.capture_stdout' do
+    it 'mutes stdout' do
+      expect($stdout).to_not receive(:puts)
+
+      described_class.capture_stdout do
+        puts 'hello'
+      end
+    end
+
+    it 'captures stdout' do
+      message = 'hello'
+
+      output = described_class.capture_stdout do
+        puts message
+      end
+
+      expect(output).to include message
+    end
+
+    it 'unmutes stdout when done' do
+      original = $stdout
+
+      described_class.capture_stdout do
+        puts 'hello'
+      end
+
+      expect($stdout).to eq original
+    end
+
+    it 'unmutes stdout when there is an exception' do
+      original = $stdout
+
+      expect {
+        described_class.capture_stdout do
+          raise StandardError.new('Oops')
+        end
+      }.to raise_error
+
+      expect($stdout).to eq original
+    end
+
+    it 'does not require a block' do
+      expect { described_class.capture_stdout }.to_not raise_error
+    end
+  end
+
+  describe '.capture_stderr' do
+    it 'captures stderr' do
+      message = 'oops'
+
+      output = described_class.capture_stderr do
+        $stderr.puts message
+      end
+
+      expect(output).to include message
+    end
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,3 @@
+require 'pry'
+require 'coveralls'
+Coveralls.wear!

metadata

@@ -0,0 +1,160 @@
+--- !ruby/object:Gem::Specification
+name: mute
+version: !ruby/object:Gem::Version
+  version: 1.0.0
+platform: ruby
+authors:
+- Chris Hunt
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2014-01-19 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.5'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.5'
+- !ruby/object:Gem::Dependency
+  name: cane
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 2.6.1
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 2.6.1
+- !ruby/object:Gem::Dependency
+  name: cane-hashcheck
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 1.2.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 1.2.0
+- !ruby/object:Gem::Dependency
+  name: coveralls
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 0.7.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 0.7.0
+- !ruby/object:Gem::Dependency
+  name: pry
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 0.9.12
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 0.9.12
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 10.1.1
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 10.1.1
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 2.14.1
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 2.14.1
+description: Muting test suites since 2014
+email:
+- c@chrishunt.co
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- .travis.yml
+- CHANGELOG.md
+- CONTRIBUTING.md
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- lib/mute.rb
+- lib/mute/io.rb
+- lib/mute/version.rb
+- mute.gemspec
+- screenshot.png
+- spec/mute/io_spec.rb
+- spec/spec_helper.rb
+homepage: https://github.com/chrishunt/mute
+licenses:
+- MIT
+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.0.3
+signing_key: 
+specification_version: 4
+summary: Muting test suites since 2014
+test_files:
+- spec/mute/io_spec.rb
+- spec/spec_helper.rb
+has_rdoc: