buff-shell_out 0.1.0

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/.ruby-version

@@ -0,0 +1 @@
+1.9.3-p429

data/.travis.yml

@@ -0,0 +1,7 @@
+script: "bundle exec thor spec"
+language: ruby
+rvm:
+  - 1.9.2
+  - 1.9.3
+  - 2.0.0
+  - jruby-19mode

data/CONTRIBUTING.md

@@ -0,0 +1,24 @@
+# Contributing
+
+## Running tests
+
+### Install prerequisites
+
+Install the latest version of [Bundler](http://gembundler.com)
+
+    $ gem install bundler
+
+Clone the project
+
+    $ git clone git://github.com/RiotGames/buff-shell_out.git
+
+and run:
+
+    $ cd buff-shell_out
+    $ bundle install
+
+Bundler will install all gems and their dependencies required for testing and developing.
+
+### Running unit (RSpec) tests
+
+    $ bundle exec guard start

data/Gemfile

@@ -0,0 +1,3 @@
+source 'https://rubygems.org'
+
+gemspec

data/Guardfile

@@ -0,0 +1,15 @@
+notification :off
+
+guard "spork" do
+  watch('Gemfile')
+  watch('spec/spec_helper.rb')     { :rspec }
+  watch(%r{^spec/support/.+\.rb$}) { :rspec }
+end
+
+guard "rspec", cli: "--color --drb --format Fuubar", all_on_start: false, all_after_pass: false do
+  watch(%r{^spec/.+_spec\.rb$})
+
+  watch(%r{^lib/(.+)\.rb$})          { |m| "spec/#{m[1]}_spec.rb" }
+  watch('spec/spec_helper.rb')       { "spec" }
+  watch(%r{^spec/support/.+\.rb$})   { "spec" }
+end

data/LICENSE

@@ -0,0 +1,15 @@
+Copyright 2012-2013 Riot Games
+
+    Jamie Winsor (<reset@riotgames.com>)
+
+Licensed under the Apache License, Version 2.0 (the "License");
+you may not use this file except in compliance with the License.
+You may obtain a copy of the License at
+
+    http://www.apache.org/licenses/LICENSE-2.0
+
+Unless required by applicable law or agreed to in writing, software
+distributed under the License is distributed on an "AS IS" BASIS,
+WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+See the License for the specific language governing permissions and
+limitations under the License.

data/README.md

@@ -0,0 +1,44 @@
+# Buff::ShellOut
+[![Gem Version](https://badge.fury.io/rb/buff-shell_out.png)](http://badge.fury.io/rb/buff-shell_out)
+[![Build Status](https://travis-ci.org/RiotGames/buff-shell_out.png?branch=master)](https://travis-ci.org/RiotGames/buff-shell_out)
+
+Buff up your code with a mixin for issuing shell commands and collecting the output
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+    gem 'buff-shell_out'
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install buff-shell_out
+
+## Usage
+
+Using it as a mixin
+
+    require 'buff/shell_out'
+
+    class PowerUp
+      include Buff::ShellOut
+    end
+
+    power_up = PowerUp.new
+    power_up.shell_out("ls") #=> <#Buff::ShellOut::Response @exitstatus=0, @stdout="...", @stderr="...">
+
+Using it as a module
+
+    require 'buff/shell_out'
+
+    Buff::ShellOut.shell_out("ls") #=> <#Buff::ShellOut::Response @exitstatus=0, @stdout="...", @stderr="...">
+
+# Authors and Contributors
+
+* Jamie Winsor (<reset@riotgames.com>)
+
+Thank you to all of our [Contributors](https://github.com/RiotGames/buff-shell_out/graphs/contributors), testers, and users.

data/Thorfile

@@ -0,0 +1,43 @@
+# encoding: utf-8
+$:.push File.expand_path("../lib", __FILE__)
+
+require 'bundler'
+require 'bundler/setup'
+require 'buff/shell_out/version'
+require 'buff/ruby_engine'
+
+class Default < Thor
+  extend Buff::RubyEngine
+
+  unless jruby?
+    require 'thor/rake_compat'
+
+    include Thor::RakeCompat
+    Bundler::GemHelper.install_tasks
+
+    desc "build", "Build buff-shell_out-#{Buff::ShellOut::VERSION}.gem into the pkg directory"
+    def build
+      Rake::Task["build"].execute
+    end
+
+    desc "install", "Build and install buff-shell_out-#{Buff::ShellOut::VERSION}.gem into system gems"
+    def install
+      Rake::Task["install"].execute
+    end
+
+    desc "release", "Create tag v#{Buff::ShellOut::VERSION} and build and push buff-shell_out-#{Buff::ShellOut::VERSION}.gem to Rubygems"
+    def release
+      Rake::Task["release"].execute
+    end
+  end
+
+  class Spec < Thor
+    namespace :spec
+    default_task :unit
+
+    desc "unit", "run the project's unit tests"
+    def unit
+      exec "rspec --color --format=documentation spec"
+    end
+  end
+end

data/buff-shell_out.gemspec

@@ -0,0 +1,33 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'buff/shell_out/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "buff-shell_out"
+  spec.version       = Buff::ShellOut::VERSION
+  spec.authors       = ["Jamie Winsor"]
+  spec.email         = ["reset@riotgames.com"]
+  spec.description   = %q{A mixin for issuing shell commands and collecting the output}
+  spec.summary       = %q{Buff up your code with a mixin for issuing shell commands and collecting the output}
+  spec.homepage      = "https://github.com/RiotGames/buff-shell_out"
+  spec.license       = "Apache 2.0"
+
+  spec.files         = `git ls-files`.split($/)
+  spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
+  spec.test_files    = spec.files.grep(%r{^spec/})
+  spec.require_paths = ["lib"]
+  spec.required_ruby_version = ">= 1.9.2"
+
+  spec.add_dependency "buff-ruby_engine", "~> 0.1.0"
+
+  spec.add_development_dependency "thor", "~> 0.18.0"
+  spec.add_development_dependency "bundler", "~> 1.3"
+  spec.add_development_dependency "rake"
+  spec.add_development_dependency "rspec"
+  spec.add_development_dependency "fuubar"
+  spec.add_development_dependency "guard"
+  spec.add_development_dependency "guard-rspec"
+  spec.add_development_dependency "guard-spork"
+  spec.add_development_dependency "spork"
+end

data/lib/buff-shell_out.rb

@@ -0,0 +1 @@
+require_relative 'buff/shell_out'

data/lib/buff/shell_out.rb

@@ -0,0 +1,63 @@
+require 'tempfile'
+require 'buff/ruby_engine'
+
+# A Ruby platform agnostic way of executing shell commands on the local system
+module Buff
+  module ShellOut
+    require_relative 'shell_out/version'
+    require_relative 'shell_out/response'
+
+    include Buff::RubyEngine
+    extend self
+
+    # Executes the given shell command on the local system
+    #
+    # @param [String] command
+    #   The command to execute
+    #
+    # @return [ShellOut::Response]
+    def shell_out(command)
+      process_status, out, err = jruby? ? jruby_out(command) : mri_out(command)
+      Response.new(process_status, out, err)
+    end
+
+    private
+
+      # @param [String] command
+      #   The command to execute
+      def mri_out(command)
+        out, err = Tempfile.new('mixin.shell_out.stdout'), Tempfile.new('mixin.shell_out.stderr')
+
+        begin
+          pid         = Process.spawn(command, out: out.to_i, err: err.to_i)
+          pid, status = Process.waitpid2(pid)
+          exitstatus  = status.exitstatus
+        rescue Errno::ENOENT => ex
+          exitstatus = 127
+          out.write("")
+          err.write("command not found: #{command}")
+        end
+
+        out.close
+        err.close
+
+        [ exitstatus, File.read(out), File.read(err) ]
+      end
+
+      # @param [String] command
+      #   The command to execute
+      def jruby_out(command)
+        out, err = StringIO.new, StringIO.new
+        $stdout, $stderr = out, err
+        system(command)
+
+        exitstatus = $?.exitstatus
+        out.rewind
+        err.rewind
+
+        [ exitstatus, out.read, err.read ]
+      ensure
+        $stdout, $stderr = STDOUT, STDERR
+      end
+  end
+end

data/lib/buff/shell_out/response.rb

@@ -0,0 +1,30 @@
+module Buff
+  module ShellOut
+    class Response
+      # @return [Fixnum]
+      attr_reader :exitstatus
+      # @return [String]
+      attr_reader :stdout
+      # @return [String]
+      attr_reader :stderr
+
+      # @param [Fixnum] exitstatus
+      # @param [String] stdout
+      # @param [String] stderr
+      def initialize(exitstatus, stdout, stderr)
+        @exitstatus = exitstatus
+        @stdout     = stdout
+        @stderr     = stderr
+      end
+
+      def success?
+        exitstatus == 0
+      end
+
+      def error?
+        !success?
+      end
+      alias_method :failure?, :error?
+    end
+  end
+end

data/lib/buff/shell_out/version.rb

@@ -0,0 +1,5 @@
+module Buff
+  module ShellOut
+    VERSION = "0.1.0"
+  end
+end

data/spec/buff/shell_out/response_spec.rb

@@ -0,0 +1,5 @@
+require 'spec_helper'
+
+describe Buff::ShellOut::Response do
+  pending
+end

data/spec/buff/shell_out_spec.rb

@@ -0,0 +1,37 @@
+require 'spec_helper'
+
+describe Buff::ShellOut do
+  describe "#shell_out" do
+    let(:command) { "ls" }
+
+    subject(:result) { described_class.shell_out(command) }
+
+    it "returns a ShellOut::Response" do
+      expect(result).to be_a(described_class::Response)
+    end
+
+    its(:stdout) { should be_a(String) }
+    its(:stderr) { should be_a(String) }
+    its(:exitstatus) { should be_a(Fixnum) }
+    its(:success?) { should be_true }
+    its(:error?) { should be_false }
+
+    context "when on MRI" do
+      before { described_class.stub(jruby?: false) }
+
+      it "delegates to #mri_out" do
+        described_class.should_receive(:mri_out).with(command)
+        result
+      end
+    end
+
+    context "when on JRuby" do
+      before { described_class.stub(jruby?: true) }
+
+      it "delegates to #jruby_out" do
+        described_class.should_receive(:jruby_out).with(command)
+        result
+      end
+    end
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,27 @@
+$LOAD_PATH.unshift File.expand_path('../../lib', __FILE__)
+
+require 'rspec'
+require 'buff/ruby_engine'
+
+def setup_rspec
+  RSpec.configure do |config|
+    config.expect_with :rspec do |c|
+      c.syntax = :expect
+    end
+
+    config.mock_with :rspec
+    config.treat_symbols_as_metadata_keys_with_true_values = true
+    config.filter_run focus: true
+    config.run_all_when_everything_filtered = true
+  end
+end
+
+if Buff::RubyEngine.jruby?
+  require 'buff/shell_out'
+  setup_rspec
+else
+  require 'spork'
+
+  Spork.prefork { setup_rspec }
+  Spork.each_run { require 'buff/shell_out' }
+end

metadata

@@ -0,0 +1,230 @@
+--- !ruby/object:Gem::Specification
+name: buff-shell_out
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+  prerelease: 
+platform: ruby
+authors:
+- Jamie Winsor
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2013-06-11 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: buff-ruby_engine
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 0.1.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 0.1.0
+- !ruby/object:Gem::Dependency
+  name: thor
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 0.18.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 0.18.0
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.3'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.3'
+- !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: fuubar
+  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: guard
+  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: guard-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: guard-spork
+  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: spork
+  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: A mixin for issuing shell commands and collecting the output
+email:
+- reset@riotgames.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- .ruby-version
+- .travis.yml
+- CONTRIBUTING.md
+- Gemfile
+- Guardfile
+- LICENSE
+- README.md
+- Thorfile
+- buff-shell_out.gemspec
+- lib/buff-shell_out.rb
+- lib/buff/shell_out.rb
+- lib/buff/shell_out/response.rb
+- lib/buff/shell_out/version.rb
+- spec/buff/shell_out/response_spec.rb
+- spec/buff/shell_out_spec.rb
+- spec/spec_helper.rb
+homepage: https://github.com/RiotGames/buff-shell_out
+licenses:
+- Apache 2.0
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: 1.9.2
+required_rubygems_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+      segments:
+      - 0
+      hash: 3711137622216531874
+requirements: []
+rubyforge_project: 
+rubygems_version: 1.8.23
+signing_key: 
+specification_version: 3
+summary: Buff up your code with a mixin for issuing shell commands and collecting
+  the output
+test_files:
+- spec/buff/shell_out/response_spec.rb
+- spec/buff/shell_out_spec.rb
+- spec/spec_helper.rb