subshell_command 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 6b9e241f2b624b8c996b0244c10fca264bbdc8b3
+  data.tar.gz: be8cfb27054a7768479f25be8262847ad0e75eb0
+SHA512:
+  metadata.gz: db2b64961d7ce148c2fadec3692415cf4205e7ac1c0c0b5f054571031a11d51baf75b4474be65c07cf1156d02a1a639c39d32b226b583881fc5fcc2ccef2416d
+  data.tar.gz: 9ec394754a459c78b5bc07d080c85a6dbbf8c459f8b997cde254952da4291fbfc7960f6bfde3636b5c62b2dd207cb000db569da970ff9546a843daf86270a6cf

data/.gitignore

@@ -0,0 +1,12 @@
+/.bundle/
+/.yardoc
+/Gemfile.lock
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+
+# rspec failure tracking
+.rspec_status

data/.rspec

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

data/.travis.yml

@@ -0,0 +1,5 @@
+sudo: false
+language: ruby
+rvm:
+  - 2.4.0
+before_install: gem install bundler -v 1.14.6

data/Gemfile

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

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2017 Alan Skorkin
+
+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,80 @@
+# SubshellCommand
+
+If, like me, you always forget when and how (and why) to use backticks or popen or whatever when trying to execute a shell command from within a ruby process, this should hopefully make life a little bit easier.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'subshell_command'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install subshell_command
+
+## Usage
+
+Simplest form:
+
+```ruby
+result = SubshellCommand.execute("ls -al")
+if result.success?
+  puts result.stdout_value
+else
+  puts result.stderr_value
+end
+```
+
+But we can do a little better with a block:
+
+```ruby
+SubshellCommand.execute("ls -al") do |o|
+  o.cmd = "pwd"                       # we can override the command
+  o.redirect_stderr_to_stdout = true  # we can pipe stderr to stdout
+  o.current_directory = "/"           # we can override the working directory
+  o.env = {                           # we can provide some extra env vars
+    FOO: "bar"
+  }    
+  o.on_success = ->(r) do             # we can provide a success callback
+    puts r.stdout_value
+  end
+  o.on_failure = ->(r) do             # we can provide a failure callback
+    puts r.stderr_value
+  end
+end
+```
+
+All of the above options have sensible defaults, so you can get away with:
+
+```ruby
+SubshellCommand.execute("ls -al") do |o|
+  o.on_success = ->(result) do             
+    puts result.stdout_value
+  end
+end
+```
+
+If all you care about is doing something when the command succeeds.
+
+Also all the code for this is in one file, which is on purpose, so if you'd rather not add an extra gem, just grab the file, dump it into your project and off you go.
+
+## 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/skorks/subshell_command.
+
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](http://opensource.org/licenses/MIT).

data/Rakefile

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

data/bin/console

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

@@ -0,0 +1,141 @@
+require "subshell_command/version"
+require "open3"
+
+module SubshellCommand
+  class Command
+    attr_reader :command_string
+    attr_reader :env_hash, :current_directory
+    attr_reader :success_callback, :failure_callback
+    attr_reader :redirect_stderr_to_stdout
+
+    def initialize(command_string)
+      @command_string = command_string
+      @env_hash = {}
+      @current_directory = Dir.pwd
+      @success_callback = ->{}
+      @failure_callback = ->{}
+      @redirect_stderr_to_stdout = false
+    end
+
+    def cmd=(command_string)
+      @command_string = command_string
+    end
+
+    def env=(env_hash)
+      @env_hash = env_hash
+    end
+
+    def current_directory=(directory_string)
+      @current_directory = directory_string
+    end
+
+    def on_success=(callback)
+      @success_callback = callback
+    end
+
+    def on_failure=(callback)
+      @failure_callback = callback
+    end
+
+    def redirect_stderr_to_stdout=(value)
+      @redirect_stderr_to_stdout = value
+    end
+  end
+
+  class Result
+    attr_accessor :success, :stdout_value, :stderr_value
+
+    def initialize
+      @success = nil
+      @stdout_value = nil
+      @stderr_value = nil
+    end
+
+    def success?
+      @success
+    end
+  end
+
+  class StandardOutputStreamsExecutor
+    attr_reader :command_object, :result
+
+    def initialize(command_object, result)
+      @command_object = command_object
+      @result = result
+    end
+
+    def execute
+      Open3.popen3(
+        command_object.env_hash,
+        command_object.command_string,
+        chdir: command_object.current_directory,
+      ) do |stdin, stdout, stderr, wait_thr|
+        exit_status = wait_thr.value
+        result.stdout_value = stdout.read
+        result.stderr_value = stderr.read
+        result.success = exit_status.success?
+      end
+    end
+  end
+
+  class CombinedOutputStreamsExecutor
+    attr_reader :command_object, :result
+
+    def initialize(command_object, result)
+      @command_object = command_object
+      @result = result
+    end
+
+    def execute
+      Open3.popen2e(
+        command_object.env_hash,
+        command_object.command_string,
+        chdir: command_object.current_directory,
+      ) do |stdin, output_streams, wait_thr|
+        exit_status = wait_thr.value
+        output_value = output_streams.read
+        result.stdout_value = output_value
+        result.stderr_value = output_value
+        result.success = exit_status.success?
+      end
+    end
+  end
+
+  class CommandExecutor
+    attr_reader :command_object
+
+    EXECUTORS = {
+      true => CombinedOutputStreamsExecutor,
+      false => StandardOutputStreamsExecutor,
+    }
+
+    def initialize(command_object)
+      @command_object = command_object
+    end
+
+    def execute
+      result = Result.new
+      EXECUTORS[command_object.redirect_stderr_to_stdout].new(command_object, result).execute
+      execute_callbacks(result)
+      result
+    end
+
+    private
+
+    def execute_callbacks(result)
+      if result.success?
+        command_object.success_callback.call(result)
+      else
+        command_object.failure_callback.call(result)
+      end
+    end
+  end
+
+  class << self
+    def execute(command_string = nil, &block)
+      command = Command.new(command_string)
+      block.call(command) if block_given?
+      CommandExecutor.new(command).execute
+    end
+  end
+end

data/subshell_command.gemspec

@@ -0,0 +1,28 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+
+Gem::Specification.new do |spec|
+  spec.name          = "subshell_command"
+  spec.version       = "0.1.0"
+  spec.authors       = ["Alan Skorkin"]
+  spec.email         = ["alan@skorks.com"]
+
+  spec.summary       = %q{Simpler way to execute shell commands from within ruby processes}
+  spec.description   = %q{If, like me, you always forget when and how (and why) to
+    use backticks or popen or whatever when trying to execute a shell command from
+    within a ruby process, this should hopefully make life a little bit easier.}
+  spec.homepage      = "https://github.com/skorks/subshell_command"
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files -z`.split("\x0").reject do |f|
+    f.match(%r{^(test|spec|features)/})
+  end
+  spec.bindir        = "exe"
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ["lib"]
+
+  spec.add_development_dependency "bundler", "~> 1.14"
+  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "rspec", "~> 3.0"
+end

metadata

@@ -0,0 +1,100 @@
+--- !ruby/object:Gem::Specification
+name: subshell_command
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Alan Skorkin
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2017-04-02 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.14'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.14'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+description: |-
+  If, like me, you always forget when and how (and why) to
+      use backticks or popen or whatever when trying to execute a shell command from
+      within a ruby process, this should hopefully make life a little bit easier.
+email:
+- alan@skorks.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- ".travis.yml"
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- lib/subshell_command.rb
+- subshell_command.gemspec
+homepage: https://github.com/skorks/subshell_command
+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.6.8
+signing_key: 
+specification_version: 4
+summary: Simpler way to execute shell commands from within ruby processes
+test_files: []