scmd 0.0.1

data/.gitignore

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

data/Gemfile

@@ -0,0 +1,7 @@
+source "http://rubygems.org"
+
+# Specify your gem's dependencies in scmd.gemspec
+gemspec
+
+gem 'bundler', '~>1.1'
+gem 'rake',    '~>0.9.2'

data/LICENSE

@@ -0,0 +1,22 @@
+Copyright (c) 2012 <TODO: copyright holders>
+
+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,72 @@
+# Scmd
+
+Wrapper to `open4` for running system commands.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+    gem 'scmd'
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install scmd
+
+## Usage
+
+Create a command object:
+
+```ruby
+cmd = Scmd.new("echo hi")
+
+cmd.to_s    #=> "echo hi"
+cmd.inspect #=> #<Scmd::Command:0x83220514 @cmd_str="echo hi" @exitcode=nil>
+
+cmd.pid      #=> nil
+cmd.exitcode #=> nil
+cmd.stdout   #=> ''
+cmd.stderr   #=> ''
+```
+
+Run it:
+
+```ruby
+cmd.run
+```
+
+Results:
+
+```ruby
+# written to the cmd instance
+cmd.pid      #=> 12345
+cmd.exitcode #=> 0
+cmd.stdout   #=> 'hi'
+cmd.stderr   #=> ''
+
+# the cmd instance is returned by `run` for chaining as well
+cmd.run.stdout #=> 'hi'
+```
+
+Some helpers:
+
+```ruby
+puts cmd.stderr if !cmd.success?
+```
+
+Raise an exception if not successful with `run!`:
+
+```ruby
+Scmd.new("cd /path/that/does/not/exist").run! #=> Scmd::Command::Failure
+```
+
+## Contributing
+
+1. Fork it
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Commit your changes (`git commit -am 'Added some feature'`)
+4. Push to the branch (`git push origin my-new-feature`)
+5. Create new Pull Request

data/Rakefile

@@ -0,0 +1,8 @@
+#!/usr/bin/env rake
+
+require 'assert/rake_tasks'
+Assert::RakeTasks.install
+
+require 'bundler/gem_tasks'
+
+task :default => :build

data/lib/scmd.rb

@@ -0,0 +1,9 @@
+require 'scmd/command'
+
+module Scmd
+
+  def self.new(*args, &block)
+    Command.new(*args, &block)
+  end
+
+end

data/lib/scmd/command.rb

@@ -0,0 +1,63 @@
+# Scmd::Command is a base wrapper for handling system commands. Initialize it
+# with with a string specifying the command to execute.  You can then run the
+# command and inspect its results.  It can be used as is, or inherited from to
+# create a more custom command wrapper.
+#
+# Notes:
+# * Uses `open4`. Open4 is more reliable for actually getting the subprocesses
+#   exit code (compared to `open3`).
+# * The inspect method is overwritten to only display the name of the class and
+#   the command string. This is to help reduce ridiculous inspect strings due to
+#   result data that is stored in instance variables.
+# * See the README.md for a walkthrough of the API.
+
+require 'open4'
+
+module Scmd
+  class Command
+
+    class Failure < RuntimeError; end
+
+    attr_reader :cmd_str
+    attr_reader :pid, :exitcode, :stdout, :stderr
+
+    def initialize(cmd_str)
+      @cmd_str = cmd_str
+      reset_results
+    end
+
+    def success?; @exitcode == 0; end
+    def to_s; @cmd_str.to_s; end
+    def inspect
+      "#<#{self.class}:0x#{self.object_id.to_s(16)} @cmd_str=#{self.cmd_str.inspect} @exitcode=#{@exitcode.inspect}>"
+    end
+
+    def run
+      run! rescue Failure
+      self
+    end
+
+    def run!
+      begin
+        status = Open4::popen4(@cmd_str) do |pid, stdin, stdout, stderr|
+          @pid =  pid.to_i
+          @stdout += stdout.read.strip
+          @stderr += stderr.read.strip
+        end
+        @exitcode = status.to_i
+      rescue Errno::ENOENT => err
+        @exitcode = -1
+        @stderr   = err.message
+      end
+
+      raise Failure, @stderr if !success?
+      self
+    end
+
+    def reset_results
+      @pid = @exitcode = nil
+      @stdout = @stderr = ''
+    end
+
+  end
+end

data/lib/scmd/version.rb

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

data/scmd.gemspec

@@ -0,0 +1,21 @@
+# -*- encoding: utf-8 -*-
+require File.expand_path('../lib/scmd/version', __FILE__)
+
+Gem::Specification.new do |gem|
+  gem.name        = "scmd"
+  gem.version     = Scmd::VERSION
+  gem.description = %q{Wrapper to `open4` for running system commands.}
+  gem.summary     = %q{Wrapper to `open4` for running system commands.}
+
+  gem.authors     = ["Kelly Redding and Team Insight"]
+  gem.email       = ["appdev@reelfx.com"]
+  gem.homepage    = "http://github.com/teaminsight/scmd"
+
+  gem.files         = `git ls-files`.split("\n")
+  gem.test_files    = `git ls-files -- {test,spec,features}/*`.split("\n")
+  gem.executables   = `git ls-files -- bin/*`.split("\n").map{ |f| File.basename(f) }
+  gem.require_paths = ["lib"]
+
+  gem.add_development_dependency("assert")
+  gem.add_dependency("open4")
+end

data/test/command_tests.rb

@@ -0,0 +1,57 @@
+require "assert"
+require 'scmd/command'
+
+class CommandTests < Assert::Context
+  desc "a command"
+  setup do
+    @success_cmd = Scmd::Command.new("echo hi")
+    @failure_cmd = Scmd::Command.new("cd /path/that/does/not/exist")
+  end
+  subject { @success_cmd }
+
+  should have_readers :cmd_str, :pid, :exitcode, :stdout, :stderr
+  should have_instance_methods :run, :run!
+
+  should "know and return its cmd string" do
+    assert_equal "echo hi", subject.cmd_str
+    assert_equal "echo hi", subject.to_s
+  end
+
+  should "default its result values" do
+    assert_nil subject.pid
+    assert_nil subject.exitcode
+    assert_equal '', subject.stdout
+    assert_equal '', subject.stderr
+  end
+
+  should "run the command and set appropriate result data" do
+    @success_cmd.run
+
+    assert_not_nil @success_cmd.pid
+    assert_equal 0, @success_cmd.exitcode
+    assert @success_cmd.success?
+    assert_equal 'hi', @success_cmd.stdout
+    assert_equal '', @success_cmd.stderr
+
+    @failure_cmd.run
+
+    assert_not_nil @failure_cmd.pid
+    assert_not_equal 0, @failure_cmd.exitcode
+    assert_not @failure_cmd.success?
+    assert_equal '', @failure_cmd.stdout
+    assert_not_equal '', @failure_cmd.stderr
+  end
+
+  should "raise an exception on `run!` and a non-zero exitcode" do
+    assert_raises Scmd::Command::Failure do
+      @failure_cmd.run!
+    end
+  end
+
+  should "return itself on `run`, `run!`" do
+    assert_equal @success_cmd, @success_cmd.run
+    assert_equal @success_cmd, @success_cmd.run!
+    assert_equal @failure_cmd, @failure_cmd.run
+  end
+
+end

data/test/helper.rb

@@ -0,0 +1,5 @@
+# this file is automatically required in when you require 'assert' in your tests
+# put test helpers here
+
+# add root dir to the load path
+$LOAD_PATH.unshift(File.expand_path("../..", __FILE__))

data/test/irb.rb

@@ -0,0 +1,9 @@
+require 'assert/setup'
+
+# this file is required in when the 'irb' rake test is run.
+# b/c 'assert/setup' is required above, the test helper will be
+# required in as well.
+
+# put any IRB setup code here
+
+require 'scmd'

data/test/scmd_tests.rb

@@ -0,0 +1,14 @@
+require "assert"
+require 'scmd'
+
+class ScmdTest < Assert::Context
+  desc "Scmd"
+  subject { Scmd }
+
+  should have_instance_method :new
+
+  should "build a `Command` with the `new` method" do
+    assert_kind_of Scmd::Command, subject.new('echo hi')
+  end
+
+end

metadata

@@ -0,0 +1,108 @@
+--- !ruby/object:Gem::Specification 
+name: scmd
+version: !ruby/object:Gem::Version 
+  hash: 29
+  prerelease: 
+  segments: 
+  - 0
+  - 0
+  - 1
+  version: 0.0.1
+platform: ruby
+authors: 
+- Kelly Redding and Team Insight
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2012-08-18 00:00:00 Z
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  type: :development
+  requirement: &id001 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 3
+        segments: 
+        - 0
+        version: "0"
+  name: assert
+  version_requirements: *id001
+  prerelease: false
+- !ruby/object:Gem::Dependency 
+  type: :runtime
+  requirement: &id002 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 3
+        segments: 
+        - 0
+        version: "0"
+  name: open4
+  version_requirements: *id002
+  prerelease: false
+description: Wrapper to `open4` for running system commands.
+email: 
+- appdev@reelfx.com
+executables: []
+
+extensions: []
+
+extra_rdoc_files: []
+
+files: 
+- .gitignore
+- Gemfile
+- LICENSE
+- README.md
+- Rakefile
+- lib/scmd.rb
+- lib/scmd/command.rb
+- lib/scmd/version.rb
+- scmd.gemspec
+- test/command_tests.rb
+- test/helper.rb
+- test/irb.rb
+- test/scmd_tests.rb
+homepage: http://github.com/teaminsight/scmd
+licenses: []
+
+post_install_message: 
+rdoc_options: []
+
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      hash: 3
+      segments: 
+      - 0
+      version: "0"
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      hash: 3
+      segments: 
+      - 0
+      version: "0"
+requirements: []
+
+rubyforge_project: 
+rubygems_version: 1.8.11
+signing_key: 
+specification_version: 3
+summary: Wrapper to `open4` for running system commands.
+test_files: 
+- test/command_tests.rb
+- test/helper.rb
+- test/irb.rb
+- test/scmd_tests.rb