scmd 1.1.0 → 2.0.0

data/README.md

@@ -24,12 +24,12 @@ Create a command object:
 cmd = Scmd.new("echo hi")
 
 cmd.to_s    #=> "echo hi"
-cmd.inspect #=> #<Scmd::Command:0x83220514 @cmd_str="echo hi" @exitcode=nil>
+cmd.inspect #=> #<Scmd::Command:0x83220514 @cmd_str="echo hi" @exitstatus=nil>
 
-cmd.pid      #=> nil
-cmd.exitcode #=> nil
-cmd.stdout   #=> ''
-cmd.stderr   #=> ''
+cmd.pid        #=> nil
+cmd.exitstatus #=> nil
+cmd.stdout     #=> ''
+cmd.stderr     #=> ''
 ```
 
 Run it:
@@ -42,10 +42,10 @@ Results:
 
 ```ruby
 # written to the cmd instance
-cmd.pid      #=> 12345
-cmd.exitcode #=> 0
-cmd.stdout   #=> 'hi'
-cmd.stderr   #=> ''
+cmd.pid        #=> 12345
+cmd.exitstatus #=> 0
+cmd.stdout     #=> 'hi'
+cmd.stderr     #=> ''
 
 # the cmd instance is returned by `run` for chaining as well
 cmd.run.stdout #=> 'hi'

data/lib/scmd/command.rb

@@ -2,66 +2,82 @@
 # 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'
+require 'posix-spawn'
 
 module Scmd
-  class Command
 
-    class Failure < RuntimeError; end
+  class RunError < ::RuntimeError
+    def initialize(stderr, called_from)
+      super(stderr)
+      set_backtrace(called_from)
+    end
+  end
+
+  class Command
 
     attr_reader :cmd_str
-    attr_reader :pid, :exitcode, :stdout, :stderr
+    attr_reader :pid, :exitstatus, :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 reset_results
+      @pid = @exitstatus = nil
+      @stdout = @stderr = ''
+    end
+
+    def success?
+      @exitstatus == 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}>"
+      reference = '0x0%x' % (self.object_id << 1)
+      "#<#{self.class}:#{reference}"\
+      " @cmd_str=#{self.cmd_str.inspect}"\
+      " @exitstatus=#{@exitstatus.inspect}>"
     end
 
     def run(input=nil)
-      run!(input) rescue Failure
+      run!(input) rescue RunError
       self
     end
 
     def run!(input=nil)
+      called_from = caller
+
       begin
-        status = Open4::popen4(@cmd_str) do |pid, stdin, stdout, stderr|
-          if !input.nil?
-            [*input].each{|line| stdin.puts line.to_s}
-            stdin.close
-          end
-          @pid =  pid.to_i
-          @stdout += stdout.read.strip
-          @stderr += stderr.read.strip
+        pid, stdin, stdout, stderr = POSIX::Spawn::popen4(@cmd_str)
+        if !input.nil?
+          [*input].each{|line| stdin.puts line.to_s}
+          stdin.close
         end
-        @exitcode = status.to_i
+        @pid     = pid.to_i
+        @stdout += stdout.read.strip
+        @stderr += stderr.read.strip
       rescue Errno::ENOENT => err
-        @exitcode = -1
-        @stderr   = err.message
+        @exitstatus = -1
+        @stderr     = err.message
+      ensure
+        [stdin, stdout, stderr].each{|io| io.close if !io.closed?}
+        ::Process::waitpid(pid)
+
+        # `$?` is a thread-safe predefined variable that returns the exit status
+        # of the last child process to terminate:
+        # http://phrogz.net/ProgrammingRuby/language.html#predefinedvariables
+        @exitstatus ||= $?.exitstatus
+
+        raise RunError.new(@stderr, called_from) if !success?
       end
 
-      raise Failure, @stderr if !success?
       self
     end
 
-    def reset_results
-      @pid = @exitcode = nil
-      @stdout = @stderr = ''
-    end
-
   end
 end

data/lib/scmd/version.rb

@@ -1,3 +1,3 @@
 module Scmd
-  VERSION = "1.1.0"
+  VERSION = "2.0.0"
 end

data/scmd.gemspec

@@ -4,11 +4,11 @@ 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.description = %q{Build and run system commands.}
+  gem.summary     = %q{Build and run system commands.}
 
-  gem.authors     = ["Kelly Redding"]
-  gem.email       = ["kelly@kellyredding.com"]
+  gem.authors     = ["Kelly Redding", "Collin Redding"]
+  gem.email       = ["kelly@kellyredding.com", "collin.redding@me.com"]
   gem.homepage    = "http://github.com/redding/scmd"
 
   gem.files         = `git ls-files`.split("\n")
@@ -17,5 +17,5 @@ Gem::Specification.new do |gem|
   gem.require_paths = ["lib"]
 
   gem.add_development_dependency("assert")
-  gem.add_dependency("open4")
+  gem.add_dependency("posix-spawn")
 end

data/test/command_tests.rb

@@ -11,7 +11,7 @@ module Scmd
     end
     subject { @success_cmd }
 
-    should have_readers :cmd_str, :pid, :exitcode, :stdout, :stderr
+    should have_readers :cmd_str, :pid, :exitstatus, :stdout, :stderr
     should have_instance_methods :run, :run!
 
     should "know and return its cmd string" do
@@ -21,7 +21,7 @@ module Scmd
 
     should "default its result values" do
       assert_nil subject.pid
-      assert_nil subject.exitcode
+      assert_nil subject.exitstatus
       assert_equal '', subject.stdout
       assert_equal '', subject.stderr
     end
@@ -30,7 +30,7 @@ module Scmd
       @success_cmd.run
 
       assert_not_nil @success_cmd.pid
-      assert_equal 0, @success_cmd.exitcode
+      assert_equal 0, @success_cmd.exitstatus
       assert @success_cmd.success?
       assert_equal 'hi', @success_cmd.stdout
       assert_equal '', @success_cmd.stderr
@@ -38,16 +38,22 @@ module Scmd
       @failure_cmd.run
 
       assert_not_nil @failure_cmd.pid
-      assert_not_equal 0, @failure_cmd.exitcode
+      assert_not_equal 0, @failure_cmd.exitstatus
       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
+    should "raise an exception with proper backtrace on `run!`" do
+      err = begin;
         @failure_cmd.run!
+      rescue Exception => err
+        err
       end
+
+      assert_kind_of Scmd::RunError, err
+      assert_includes 'No such file or directory', err.message
+      assert_includes 'test/command_tests.rb:', err.backtrace.first
     end
 
     should "return itself on `run`, `run!`" do

metadata

@@ -1,25 +1,27 @@
 --- !ruby/object:Gem::Specification 
 name: scmd
 version: !ruby/object:Gem::Version 
-  hash: 19
+  hash: 15
   prerelease: 
   segments: 
-  - 1
-  - 1
+  - 2
   - 0
-  version: 1.1.0
+  - 0
+  version: 2.0.0
 platform: ruby
 authors: 
 - Kelly Redding
+- Collin Redding
 autorequire: 
 bindir: bin
 cert_chain: []
 
-date: 2012-10-16 00:00:00 Z
+date: 2012-11-08 00:00:00 Z
 dependencies: 
 - !ruby/object:Gem::Dependency 
   name: assert
-  version_requirements: &id001 !ruby/object:Gem::Requirement 
+  prerelease: false
+  requirement: &id001 !ruby/object:Gem::Requirement 
     none: false
     requirements: 
     - - ">="
@@ -29,11 +31,11 @@ dependencies:
         - 0
         version: "0"
   type: :development
-  requirement: *id001
-  prerelease: false
+  version_requirements: *id001
 - !ruby/object:Gem::Dependency 
-  name: open4
-  version_requirements: &id002 !ruby/object:Gem::Requirement 
+  name: posix-spawn
+  prerelease: false
+  requirement: &id002 !ruby/object:Gem::Requirement 
     none: false
     requirements: 
     - - ">="
@@ -43,11 +45,11 @@ dependencies:
         - 0
         version: "0"
   type: :runtime
-  requirement: *id002
-  prerelease: false
-description: Wrapper to `open4` for running system commands.
+  version_requirements: *id002
+description: Build and run system commands.
 email: 
 - kelly@kellyredding.com
+- collin.redding@me.com
 executables: []
 
 extensions: []
@@ -97,12 +99,13 @@ required_rubygems_version: !ruby/object:Gem::Requirement
 requirements: []
 
 rubyforge_project: 
-rubygems_version: 1.8.24
+rubygems_version: 1.8.15
 signing_key: 
 specification_version: 3
-summary: Wrapper to `open4` for running system commands.
+summary: Build and run system commands.
 test_files: 
 - test/command_tests.rb
 - test/helper.rb
 - test/irb.rb
 - test/scmd_tests.rb
+has_rdoc: