scmd 2.3.1 → 3.0.0

data/README.md

@@ -94,6 +94,33 @@ Raise an exception if not successful with `run!`:
 Scmd.new("cd /path/that/does/not/exist").run! #=> Scmd::Command::Failure
 ```
 
+### Environment variables
+
+Pass environment variables:
+
+```ruby
+cmd = Scmd.new("echo $TEST_VAR", {
+  :env => {
+    'TEST_VAR' => 'hi'
+  }
+})
+```
+
+### Process spawn options
+
+Pass options:
+
+```ruby
+reader, writer = IO.pipe
+# this is an example that uses file descriptor redirection options
+cmd = Scmd.new("echo test 1>&#{writer.fileno}", {
+  :options => { writer => writer }
+})
+reader.gets # => "test\n"
+```
+
+For all the possible options see [posix-spawn](https://github.com/rtomayko/posix-spawn#status).
+
 ## Installation
 
 Add this line to your application's Gemfile:

data/lib/scmd/command.rb

@@ -14,12 +14,14 @@ module Scmd
     READ_CHECK_TIMEOUT   = 0.001 # seconds
     DEFAULT_STOP_TIMEOUT = 3     # seconds
 
-    attr_reader :cmd_str, :env
+    attr_reader :cmd_str, :env, :options
     attr_reader :pid, :exitstatus, :stdout, :stderr
 
-    def initialize(cmd_str, env = nil)
+    def initialize(cmd_str, opts = nil)
+      opts ||= {}
       @cmd_str = cmd_str
-      @env     = stringify_hash(env || {})
+      @env     = stringify_hash(opts[:env] || {})
+      @options = opts[:options] || {}
       reset_attrs
     end
 
@@ -131,7 +133,7 @@ module Scmd
       reset_attrs
       @stop_r, @stop_w = IO.pipe
       @read_output_thread = nil
-      @child_process = ChildProcess.new(@cmd_str, @env)
+      @child_process = ChildProcess.new(@cmd_str, @env, @options)
     end
 
     def teardown_run
@@ -165,8 +167,12 @@ module Scmd
 
       attr_reader :pid, :stdin, :stdout, :stderr
 
-      def initialize(cmd_str, env)
-        @pid, @stdin, @stdout, @stderr = *::POSIX::Spawn::popen4(env, cmd_str)
+      def initialize(cmd_str, env, options)
+        @pid, @stdin, @stdout, @stderr = *::POSIX::Spawn::popen4(
+          env,
+          cmd_str,
+          options
+        )
         @wait_pid, @wait_status = nil, nil
       end
 

data/lib/scmd/version.rb

@@ -1,3 +1,3 @@
 module Scmd
-  VERSION = "2.3.1"
+  VERSION = "3.0.0"
 end

data/scmd.gemspec

@@ -18,6 +18,6 @@ Gem::Specification.new do |gem|
   gem.test_files    = gem.files.grep(%r{^(test|spec|features)/})
   gem.require_paths = ["lib"]
 
-  gem.add_development_dependency("assert", ["~> 2.3"])
-  gem.add_dependency("posix-spawn", ["= 0.3.8"])
+  gem.add_development_dependency("assert", ["~> 2.15"])
+  gem.add_dependency("posix-spawn", ["~> 0.3.11"])
 end

data/test/system/command_tests.rb

@@ -159,15 +159,36 @@ class Scmd::Command
     desc "with environment variables"
     setup do
       @cmd = Scmd::Command.new("echo $SCMD_TEST_VAR", {
-        'SCMD_TEST_VAR' => 'test'
+        :env => { 'SCMD_TEST_VAR' => 'test' }
       })
     end
 
     should "use them when running the command" do
       @cmd.run
+      assert @cmd.success?
       assert_equal "test\n", @cmd.stdout
     end
 
   end
 
+  class WithOptionsTests < SystemTests
+    desc "with options"
+    setup do
+      @path = "/"
+      # `chdir` is the only one that reliably worked
+      @cmd = Scmd::Command.new("pwd", {
+        :options => { :chdir => @path }
+      })
+    end
+
+    should "use them when running the command" do
+      @cmd.run
+      assert @cmd.success?
+      # if the option didn't work or was ignored it would use this process' dir
+      assert_not_equal "#{Dir.pwd}\n", @cmd.stdout
+      assert_equal "#{@path}\n", @cmd.stdout
+    end
+
+  end
+
 end

data/test/unit/command_tests.rb

@@ -10,7 +10,7 @@ class Scmd::Command
     end
     subject { @cmd }
 
-    should have_readers :cmd_str, :env
+    should have_readers :cmd_str, :env, :options
     should have_readers :pid, :exitstatus, :stdout, :stderr
     should have_imeths :run, :run!
     should have_imeths :start, :wait, :stop, :kill
@@ -27,12 +27,16 @@ class Scmd::Command
 
     should "stringify its env hash" do
       cmd = Scmd::Command.new("echo $SCMD_TEST_VAR", {
-        :SCMD_TEST_VAR => 1
+        :env => { :SCMD_TEST_VAR => 1 }
       })
       expected = { 'SCMD_TEST_VAR' => '1' }
       assert_equal expected, cmd.env
     end
 
+    should "default its options to an empty hash" do
+      assert_equal({}, subject.options)
+    end
+
     should "default its result values" do
       assert_nil subject.pid
       assert_nil subject.exitstatus

metadata

@@ -1,13 +1,13 @@
 --- !ruby/object:Gem::Specification 
 name: scmd
 version: !ruby/object:Gem::Version 
-  hash: 1
+  hash: 7
   prerelease: 
   segments: 
-  - 2
   - 3
-  - 1
-  version: 2.3.1
+  - 0
+  - 0
+  version: 3.0.0
 platform: ruby
 authors: 
 - Kelly Redding
@@ -16,7 +16,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2014-08-01 00:00:00 Z
+date: 2015-10-12 00:00:00 Z
 dependencies: 
 - !ruby/object:Gem::Dependency 
   requirement: &id001 !ruby/object:Gem::Requirement 
@@ -24,30 +24,30 @@ dependencies:
     requirements: 
     - - ~>
       - !ruby/object:Gem::Version 
-        hash: 5
+        hash: 29
         segments: 
         - 2
-        - 3
-        version: "2.3"
-  version_requirements: *id001
+        - 15
+        version: "2.15"
   type: :development
   name: assert
+  version_requirements: *id001
   prerelease: false
 - !ruby/object:Gem::Dependency 
   requirement: &id002 !ruby/object:Gem::Requirement 
     none: false
     requirements: 
-    - - "="
+    - - ~>
       - !ruby/object:Gem::Version 
-        hash: 3
+        hash: 5
         segments: 
         - 0
         - 3
-        - 8
-        version: 0.3.8
-  version_requirements: *id002
+        - 11
+        version: 0.3.11
   type: :runtime
   name: posix-spawn
+  version_requirements: *id002
   prerelease: false
 description: Build and run system commands.
 email: 
@@ -109,7 +109,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
 requirements: []
 
 rubyforge_project: 
-rubygems_version: 1.8.29
+rubygems_version: 1.8.25
 signing_key: 
 specification_version: 3
 summary: Build and run system commands.