awesome_spawn 1.0.0 → 1.1.0

data/README.md

@@ -11,6 +11,7 @@ AwesomeSpawn is a module that provides some useful features over Ruby's Kernel.s
 Some additional features include...
 
 - Parameter passing as a Hash or associative Array sanitizing them to prevent command line injection.
+- Ability to pass the contents of stdin as a String.
 - Results returned as an object giving access to the output stream, error stream, and exit status.
 - Optionally raising an exception when exit status is not 0.
 

data/lib/awesome_spawn.rb

@@ -31,26 +31,35 @@ module AwesomeSpawn
   #   result.exit_status  # => 1
   #
   # @example With parameters sanitized
-  #   result = AwesomeSpawn.run('echo', :params => {"--out" => "; rm /some/file"})
+  #   result = AwesomeSpawn.run('echo', :params => {:out => "; rm /some/file"})
   #   # => #<AwesomeSpawn::CommandResult:0x007ff64baa6650 @exit_status=0>
   #   result.command_line
   #   # => "echo --out \\;\\ rm\\ /some/file"
   #
+  # @example With data to be passed on stdin
+  #   result = AwesomeSpawn.run('cat', :in_data => "line1\nline2")
+  #   => #<AwesomeSpawn::CommandResult:0x007fff05b0ab10 @exit_status=0>
+  #   result.output
+  #   => "line1\nline2"
+  #
   # @param [String] command The command to run
-  # @param [Hash] options The options for running the command
+  # @param [Hash] options The options for running the command.  Also accepts any
+  #   option that can be passed to Kernel.spawn, except `:out` and `:err`.
   # @option options [Hash,Array] :params The command line parameters. See
-  #   {#build_command_line} for how to specify params. Alternate key
-  #   `:parameters`.
-  # @option options [String] :chdir see the `:chdir` parameter for Kernel.spawn
+  #   {#build_command_line} for how to specify params.
+  # @option options [String] :in_data Data to be passed on stdin.  If this option
+  #   is specified you cannot specify `:in`.
   #
   # @raise [NoSuchFileError] if the `command` is not found
   # @return [CommandResult] the output stream, error stream, and exit status
   # @see http://ruby-doc.org/core/Kernel.html#method-i-spawn Kernel.spawn
   def run(command, options = {})
-    params = options[:params] || options[:parameters]
-
-    launch_params = {}
-    launch_params[:chdir] = options[:chdir] if options[:chdir]
+    raise ArgumentError, "options cannot contain :out" if options.include?(:out)
+    raise ArgumentError, "options cannot contain :err" if options.include?(:err)
+    raise ArgumentError, "options cannot contain :in if :in_data is specified" if options.include?(:in) && options.include?(:in_data)
+    options = options.dup
+    params  = options.delete(:params)
+    in_data = options.delete(:in_data)
 
     output        = ""
     error         = ""
@@ -58,7 +67,7 @@ module AwesomeSpawn
     command_line  = build_command_line(command, params)
 
     begin
-      output, error = launch(command_line, launch_params)
+      output, error = launch(command_line, in_data, options)
       status = exitstatus
     ensure
       output ||= ""
@@ -99,11 +108,15 @@ module AwesomeSpawn
   # @param [String] command The command to run
   # @param [Hash,Array] params Optional command line parameters. They can
   #   be passed as a Hash or associative Array. The values are sanitized to
-  #   prevent command line injection.
+  #   prevent command line injection.  Keys as symbols are prefixed with `--`,
+  #   and `_` is replaced with `-`.
   #
+  #   - `{:key => "value"}`            generates `--key value`
   #   - `{"--key" => "value"}`         generates `--key value`
+  #   - `{:key= => "value"}`           generates `--key=value`
   #   - `{"--key=" => "value"}`        generates `--key=value`
-  #   - `{"--key" => nil}`             generates `--key`
+  #   - `{:key_name => "value"}`       generates `--key-name value`
+  #   - `{:key => nil}`                generates `--key`
   #   - `{"-f" => ["file1", "file2"]}` generates `-f file1 file2`
   #   - `{nil => ["file1", "file2"]}`  generates `file1 file2`
   #
@@ -118,12 +131,22 @@ module AwesomeSpawn
   def sanitize(params)
     return [] if params.nil? || params.empty?
     params.collect do |k, v|
-      v = case v
-          when Array;    v.collect {|i| i.to_s.shellescape}
-          when NilClass; v
-          else           v.to_s.shellescape
-          end
-      [k, v]
+      [sanitize_key(k), sanitize_value(v)]
+    end
+  end
+
+  def sanitize_key(key)
+    case key
+    when Symbol then "--#{key.to_s.tr("_", "-")}"
+    else             key
+    end
+  end
+
+  def sanitize_value(value)
+    case value
+    when Array    then value.collect { |i| i.to_s.shellescape }
+    when NilClass then value
+    else               value.to_s.shellescape
     end
   end
 
@@ -139,20 +162,34 @@ module AwesomeSpawn
   # http://stackoverflow.com/questions/13829830/ruby-process-spawn-stdout-pipe-buffer-size-limit/13846146#13846146
   THREAD_SYNC_KEY = "#{self.name}-exitstatus"
 
-  def launch(command, spawn_options = {})
+  def launch(command, in_data, spawn_options = {})
     out_r, out_w = IO.pipe
     err_r, err_w = IO.pipe
-    pid = Kernel.spawn(command, {:err => err_w, :out => out_w}.merge(spawn_options))
-    wait_for_process(pid, out_w, err_w)
+    in_r,  in_w  = IO.pipe if in_data
+
+    spawn_options[:out] = out_w
+    spawn_options[:err] = err_w
+    spawn_options[:in]  = in_r if in_data
+
+    pid = Kernel.spawn(command, spawn_options)
+
+    write_to_input(in_w, in_data) if in_data
+    wait_for_process(pid, out_w, err_w, in_r)
     wait_for_pipes(out_r, err_r)
   end
 
-  def wait_for_process(pid, out_w, err_w)
+  def write_to_input(in_w, in_data)
+    in_w.write(in_data)
+    in_w.close
+  end
+
+  def wait_for_process(pid, out_w, err_w, in_r)
     self.exitstatus = :not_done
     Thread.new(Thread.current) do |parent_thread|
       _, status = Process.wait2(pid)
       out_w.close
       err_w.close
+      in_r.close if in_r
       parent_thread[THREAD_SYNC_KEY] = status.exitstatus
     end
   end

data/lib/awesome_spawn/version.rb

@@ -1,3 +1,3 @@
 module AwesomeSpawn
-  VERSION = "1.0.0"
+  VERSION = "1.1.0"
 end

data/spec/awesome_spawn_spec.rb

@@ -6,11 +6,13 @@ describe AwesomeSpawn do
 
   let(:params) do
     {
-      "--user"  => "bob",
-      "--pass"  => "P@$sw0^& |<>/-+*d%",
-      "--db"    => nil,
-      "--desc=" => "Some Description",
-      nil       => ["pkg1", "some pkg"]
+      "--user"     => "bob",
+      "--pass"     => "P@$sw0^& |<>/-+*d%",
+      "--db"       => nil,
+      "--desc="    => "Some Description",
+      :symkey      => nil,
+      :symkey_dash => nil,
+      nil          => ["pkg1", "some pkg"]
     }
   end
 
@@ -19,21 +21,28 @@ describe AwesomeSpawn do
   end
 
   shared_examples_for "run" do
-    context "parameters" do
+    context "options" do
       before do
         subject.stub(:exitstatus => 0)
       end
 
-      it "won't modify caller params" do
+      it ":params won't be modified" do
         orig_params = params.dup
         subject.stub(:launch)
         subject.send(run_method, "true", :params => params)
         expect(orig_params).to eq(params)
       end
 
-      it "supports spawn's chdir option" do
-        subject.should_receive(:launch).once.with("true", {:chdir => ".."})
-        subject.send(run_method, "true", :chdir => "..")
+      it ":in_data cannot be passed with :in" do
+        expect { subject.send(run_method, "true", :in_data => "XXXXX", :in => "/dev/null") } .to raise_error(ArgumentError)
+      end
+
+      it ":out is not supported" do
+        expect { subject.send(run_method, "true", :out => "/dev/null") }.to raise_error(ArgumentError)
+      end
+
+      it ":err is not supported" do
+        expect { subject.send(run_method, "true", :err => "/dev/null") }.to raise_error(ArgumentError)
       end
     end
 
@@ -66,6 +75,20 @@ describe AwesomeSpawn do
         expect { subject.send(run_method, "XXXXX --user=bob") }.to raise_error(Errno::ENOENT, "No such file or directory - XXXXX")
       end
 
+      context "with option" do
+        it ":chdir" do
+          result = subject.send(run_method, "pwd", :chdir => "..")
+          expect(result.exit_status).to  eq(0)
+          expect(result.output.chomp).to eq(File.expand_path("..", Dir.pwd))
+        end
+
+        it ":in_data" do
+          result = subject.send(run_method, "cat", :in_data => "line1\nline2")
+          expect(result.exit_status).to eq(0)
+          expect(result.output).to      eq("line1\nline2")
+        end
+      end
+
       context "#exit_status" do
         it "command ok exit ok" do
           expect(subject.send(run_method, "true").exit_status).to eq(0)
@@ -113,7 +136,27 @@ describe AwesomeSpawn do
   context ".build_command_line" do
     it "sanitizes crazy params" do
       cl = subject.build_command_line("true", modified_params)
-      expect(cl).to eq "true --user bob --pass P@\\$sw0\\^\\&\\ \\|\\<\\>/-\\+\\*d\\% --db --desc=Some\\ Description pkg1 some\\ pkg --pool 123 --pool 456"
+      expect(cl).to eq "true --user bob --pass P@\\$sw0\\^\\&\\ \\|\\<\\>/-\\+\\*d\\% --db --desc=Some\\ Description --symkey --symkey-dash pkg1 some\\ pkg --pool 123 --pool 456"
+    end
+
+    it "handles Symbol keys" do
+      cl = subject.build_command_line("true", :abc => "def")
+      expect(cl).to eq "true --abc def"
+    end
+
+    it "handles Symbol keys with tailing '='" do
+      cl = subject.build_command_line("true", :abc= => "def")
+      expect(cl).to eq "true --abc=def"
+    end
+
+    it "handles Symbol keys with underscore" do
+      cl = subject.build_command_line("true", :abc_def => "ghi")
+      expect(cl).to eq "true --abc-def ghi"
+    end
+
+    it "handles Symbol keys with underscore and tailing '='" do
+      cl = subject.build_command_line("true", :abc_def= => "ghi")
+      expect(cl).to eq "true --abc-def=ghi"
     end
 
     it "sanitizes Fixnum array param value" do

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: awesome_spawn
 version: !ruby/object:Gem::Version
-  version: 1.0.0
+  version: 1.1.0
   prerelease: 
 platform: ruby
 authors:
@@ -12,7 +12,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-01-04 00:00:00.000000000 Z
+date: 2014-02-03 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -151,18 +151,12 @@ required_ruby_version: !ruby/object:Gem::Requirement
   - - ! '>='
     - !ruby/object:Gem::Version
       version: '0'
-      segments:
-      - 0
-      hash: -1223152174146401530
 required_rubygems_version: !ruby/object:Gem::Requirement
   none: false
   requirements:
   - - ! '>='
     - !ruby/object:Gem::Version
       version: '0'
-      segments:
-      - 0
-      hash: -1223152174146401530
 requirements: []
 rubyforge_project: 
 rubygems_version: 1.8.23