capture_output_streams 0.0.1

data/.gitignore

@@ -0,0 +1,19 @@
+.rbenv-gemsets
+.ruby-version
+*.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/.rspec

@@ -0,0 +1,2 @@
+--format documentation
+--color

data/.travis.yml

@@ -0,0 +1,3 @@
+language: ruby
+rvm:
+  - 1.9.3

data/Gemfile

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

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2014 Marc Sutter
+
+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,104 @@
+# CaptureOutputStreams
+
+Control output streams of third party gems or libraries.
+
+There are so many cool ruby gems and libraries out there. What if you want to use one of them in your cli application without having a way to capture or modify the output streams.
+
+While writing my own cli tool, i wanted to use the great [git-up](https://github.com/aanand/git-up) gem to update my local git branches.
+
+I also wanted to control and format the console output of my own cli tools, but the author of the git-up gem uses 'puts' and 'system' statement in his code and I did not want to alter his code.
+
+Here an example with the git-up gem.
+
+git-up is a command line utility, but I wanted to use it in my code.
+So, to sync a repo, one would do:
+
+```ruby
+[1] pry(main)> require 'git-up'
+=> true
+
+[2] pry(main)> GitUp.new.run([])
+Fetching origin
+master up to date
+=> nil
+```
+
+My repo is synced now, but the method is only returning nil and the outputs are directly pushed to the console.
+
+So if I want to hide the output from the console, I could do something like:
+
+```ruby
+[3] pry(main)> require 'capture_output_streams'
+=> true
+
+[4] pry(main)> cos = capture_output_streams {GitUp.new.run([])}
+=> #<struct  stdout="Fetching origin\n\e[1mmaster \e[0m\e[32mup to date\e[0m\n", stderr="">
+
+[5] pry(main)> cos.stdout
+=> "Fetching origin\n\e[1mmaster \e[0m\e[32mup to date\e[0m\n"
+
+[6] pry(main)> puts cos.stdout
+Fetching origin
+master up to date
+=> nil
+```
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+    gem 'capture_output_streams'
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install capture_output_streams
+
+## Usage
+
+Pass your code within a block to capture_output_streams, and you'll get a struct back with the output streams.
+
+a simple puts statment
+```ruby
+[1] pry(main)> require 'capture_output_streams'
+=> true
+
+[2] pry(main)> capture_output_streams { puts "hello world" }
+=> #<struct  stdout="hello world\n", stderr="">
+```
+
+a more complete example:
+```ruby
+[3] pry(main)> cos = capture_output_streams do
+[3] pry(main)*   system('date')
+[3] pry(main)*   puts "--------------------"
+[3] pry(main)*   $stderr.puts "im a failure"
+[3] pry(main)* end
+=> #<struct  stdout="Fri Nov 14 11:37:23 CET 2014\n--------------------\n", stderr="im a failure\n">
+
+[4] pry(main)> puts cos.stdout
+Fri Nov 14 11:37:23 CET 2014
+--------------------
+=> nil
+
+[5] pry(main)> puts cos.stderr
+im a failure
+=> nil
+```
+
+## Note
+The kernel system and backticks (``) methods are also dynamically mocked
+during the block code execution as they don't use $stdout.
+
+Open4 is used for these mockings.
+
+## Contributing
+
+1. Fork it ( http://github.com/msutter/capture_output_streams/fork )
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Commit your changes (`git commit -am 'Add some feature'`)
+4. Push to the branch (`git push origin my-new-feature`)
+5. Create new Pull Request

data/Rakefile

@@ -0,0 +1,6 @@
+require "bundler/gem_tasks"
+require "rspec/core/rake_task"
+
+RSpec::Core::RakeTask.new(:spec)
+
+task :default => :spec

data/capture_output_streams.gemspec

@@ -0,0 +1,28 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+
+require 'capture_output_streams/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "capture_output_streams"
+  spec.version       = CaptureOutputStreams::VERSION
+  spec.authors       = ["Marc Sutter"]
+  spec.email         = ["marc.sutter@swisscom.com"]
+  spec.summary       = %q{control output streams of third party gems or libraries}
+  spec.description   = %q{hide or reformat output streams of required third party code}
+  spec.homepage      = "https://github.com/msutter/capture_output_streams"
+  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_dependency "open4"
+
+  spec.add_development_dependency "bundler", "~> 1.5"
+  spec.add_development_dependency "rake"
+  spec.add_development_dependency "rspec"
+  spec.add_development_dependency "pry"
+end

data/lib/capture_output_streams.rb

@@ -0,0 +1,51 @@
+require 'open4'
+
+module CaptureOutputStreams
+
+  Kernel.module_eval do
+
+    def capture_output_streams(&block)
+      path = File.dirname(__FILE__)
+
+      # save original kernel methods
+      Kernel.module_eval do
+        alias_method :orig_system,    :system
+        alias_method :orig_backticks, :`
+      end
+
+      # save original output streams
+      original_stdout = $stdout
+      original_stderr = $stderr
+
+      # override original kernel methods
+      load File.join(path, 'capture_output_streams/system.rb')
+      load File.join(path, 'capture_output_streams/backticks.rb')
+
+      # override original output streams
+      $stdout = fake_stdout = StringIO.new
+      $stderr = fake_stderr = StringIO.new
+
+      begin
+        yield
+
+      ensure
+        # restore original kernel methods
+        Kernel.module_eval do
+          alias_method :system, :orig_system
+          alias_method :`,      :orig_backticks
+        end
+
+        # restore original output streams
+        $stdout = original_stdout
+        $stderr = original_stderr
+
+      end
+
+      capture = Struct.new :stdout, :stderr
+      capture.new(fake_stdout.string, fake_stderr.string)
+
+    end
+
+  end
+
+end

data/lib/capture_output_streams/backticks.rb

@@ -0,0 +1,36 @@
+module CaptureOutputStreams
+
+  Kernel.module_eval do
+
+    def `(*args)
+      command = args.join(' ')
+      status = Open4::popen4(command) do |pid, stdin, stdout, stderr|
+        @pid=pid
+        @stdin=command
+        @stdout=""
+        @stderr=""
+
+        while(line=stdout.gets)
+          @stdout+=line
+        end
+
+        while(line=stderr.gets)
+          @stderr+=line
+        end
+
+        unless @stdout.nil?
+          @stdout=@stdout.strip
+        end
+
+        unless @stderr.nil?
+          @stderr=@stderr.strip
+        end
+
+      end
+      @status = status.to_i
+      $stderr.puts @stderr unless @stderr.empty?
+      @stdout
+    end
+
+  end
+end

data/lib/capture_output_streams/system.rb

@@ -0,0 +1,37 @@
+module CaptureOutputStreams
+
+  Kernel.module_eval do
+
+    def system(*args)
+      command = args.join(' ')
+      status = Open4::popen4(command) do |pid, stdin, stdout, stderr|
+        @pid=pid
+        @stdin=command
+        @stdout=""
+        @stderr=""
+
+        while(line=stdout.gets)
+          @stdout+=line
+          $stdout.puts line
+        end
+
+        while(line=stderr.gets)
+          @stderr+=line
+          $stderr.puts line
+        end
+
+        unless @stdout.nil?
+          @stdout=@stdout.strip
+        end
+
+        unless @stderr.nil?
+          @stderr=@stderr.strip
+        end
+
+      end
+      @status = status.to_i
+      @status == 0 ? true : false
+    end
+
+  end
+end

data/lib/capture_output_streams/version.rb

@@ -0,0 +1,3 @@
+module CaptureOutputStreams
+  VERSION = "0.0.1"
+end

data/spec/capture_output_streams_spec.rb

@@ -0,0 +1,25 @@
+require 'spec_helper'
+
+describe CaptureOutputStreams do
+
+  it 'should have a version number' do
+    CaptureOutputStreams::VERSION.should_not be_nil
+  end
+
+  describe '.capture_output_streams' do
+
+    it 'should accept a block' do
+      expect {
+        capture_output_streams{}
+      }.to_not raise_error
+    end
+
+    it 'does not accept arguments' do
+      expect {
+        capture_output_streams(23)
+      }.to raise_error ArgumentError
+    end
+
+  end
+
+end

data/spec/spec_helper.rb

@@ -0,0 +1,2 @@
+$LOAD_PATH.unshift File.expand_path('../../lib', __FILE__)
+require 'capture_output_streams'

metadata

@@ -0,0 +1,142 @@
+--- !ruby/object:Gem::Specification
+name: capture_output_streams
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+  prerelease: 
+platform: ruby
+authors:
+- Marc Sutter
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2014-11-14 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: open4
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.5'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.5'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: pry
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+description: hide or reformat output streams of required third party code
+email:
+- marc.sutter@swisscom.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- .rspec
+- .travis.yml
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- capture_output_streams.gemspec
+- lib/capture_output_streams.rb
+- lib/capture_output_streams/backticks.rb
+- lib/capture_output_streams/system.rb
+- lib/capture_output_streams/version.rb
+- spec/capture_output_streams_spec.rb
+- spec/spec_helper.rb
+homepage: https://github.com/msutter/capture_output_streams
+licenses:
+- MIT
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 1.8.23
+signing_key: 
+specification_version: 3
+summary: control output streams of third party gems or libraries
+test_files:
+- spec/capture_output_streams_spec.rb
+- spec/spec_helper.rb