em-systemcommand 0.0.5 → 1.0.0

data/em-systemcommand.gemspec

@@ -18,6 +18,8 @@ Gem::Specification.new do |gem|
   gem.add_development_dependency 'rspec'
   gem.add_development_dependency 'guard'
   gem.add_development_dependency 'guard-rspec'
+  gem.add_development_dependency 'rake'
 
+  gem.add_dependency 'escape'
   gem.add_dependency 'eventmachine'
 end

data/lib/em-systemcommand.rb

@@ -3,6 +3,7 @@ require 'open3'
 require "em-systemcommand/version"
 require "em-systemcommand/pipe"
 require "em-systemcommand/pipe_handler"
+require "em-systemcommand/builder"
 
 module EventMachine
   class SystemCommand
@@ -17,14 +18,36 @@ module EventMachine
 
     def initialize *args, &block
       @pipes = {}
+      @command = EM::SystemCommand::Builder.new *args
 
-      stdin, stdout, stderr, @wait_thr = Open3.popen3 *args
+      @execution_proc = block
+    end
+
+    def self.execute *args, &block
+      sys_cmd = EM::SystemCommand.new *args, &block
+      sys_cmd.execute
+    end
+
+    # Executes the command
+    def execute &block
+      raise 'Previous process still exists' unless pipes.empty?
+
+      # clear callbacks
+      @callbacks = []
+      @errbacks = []
+
+      stdin, stdout, stderr, @wait_thr = Open3.popen3 @command.to_s
 
       @stdin  = attach_pipe_handler :stdin, stdin
       @stdout = attach_pipe_handler :stdout, stdout
       @stderr = attach_pipe_handler :stderr, stderr
 
-      yield self if block_given?
+      if block
+        block.call self
+      elsif @execution_proc
+        @execution_proc.call self
+      end
+      self
     end
 
     def pid

data/lib/em-systemcommand/builder.rb

@@ -0,0 +1,65 @@
+require 'escape'
+
+module EventMachine
+  class SystemCommand
+    class Builder
+
+      def initialize *args
+        unless args.length > 0
+          raise "You have to provide at least one argument as command"
+        end
+        @arr = args
+      end
+
+      def add opt, val = nil
+        if opt.is_a?(Array)
+          opt.each do |element|
+            add *element
+          end
+        else
+          if val
+            @arr << [ opt, val ]
+          else
+            @arr << opt
+          end
+        end
+        self
+      end
+      alias :<< :add
+
+      ##
+      # Returns the command string
+      def to_s
+        cmd = @arr.shift
+        @arr.each do |arg|
+          if arg.is_a?(Array)
+            param = arg.shift
+            param = param.to_s if param.is_a?(Symbol)
+            if param =~ /^\-{1,2}(.*)/
+              param = $1
+            end
+            value = arg.shift
+            if param.length == 1
+              cmd << ' ' << "-#{param} #{Escape.shell_single_word(value)}"
+            else
+              cmd << ' ' << "--#{param}=#{Escape.shell_single_word(value)}"
+            end
+          elsif arg.is_a?(Symbol)
+            arg = arg.to_s
+            if arg.length == 1
+              cmd << ' ' << "-#{arg}"
+            else
+              cmd << ' ' << "--#{arg}"
+            end
+          elsif arg.strip =~ /^\-/
+            cmd << ' ' << arg
+          else
+            cmd << ' ' << Escape.shell_single_word(arg)
+          end
+        end
+        cmd
+      end
+
+    end
+  end
+end

data/lib/em-systemcommand/pipe_handler.rb

@@ -14,7 +14,6 @@ module EventMachine
       end
 
       module ClassMethods
-
         def pipe_handler name, klass
           pipe_handlers[name] = klass
         end
@@ -30,7 +29,6 @@ module EventMachine
             stderr: EM::SystemCommand::Pipe
           }
         end
-
       end
     end
   end

data/lib/em-systemcommand/version.rb

@@ -1,5 +1,5 @@
 module Em
   module Systemcommand
-    VERSION = "0.0.5"
+    VERSION = "1.0.0"
   end
 end

data/spec/em-systemcommand/builder_spec.rb

@@ -0,0 +1,91 @@
+# -*- coding: utf-8 -*-
+require 'spec_helper'
+
+describe EM::SystemCommand::Builder do
+  before :all do
+    @cmd = EM::SystemCommand::Builder.new 'ffmpeg'
+  end
+
+  describe '.new' do
+    it 'should take multiple arguments' do
+      b = EM::SystemCommand::Builder.new 'echo', 'Irgendwas'
+      b.to_s.should == 'echo Irgendwas'
+    end
+  end
+
+
+  describe '#add' do
+    before :each do
+      @cmd = EM::SystemCommand::Builder.new 'echo'
+    end
+
+    it 'should add options' do
+      @cmd << :n
+      @cmd.to_s.should == 'echo -n'
+    end
+
+    it 'should add parameters' do
+      @cmd.add :creative, 'not'
+      @cmd.add :a, 'b'
+      @cmd.add '--something', 'weird$'
+      @cmd.to_s.should == "echo --creative=not -a b --something='weird$'"
+    end
+
+    it 'should add arguments' do
+      @cmd << "A long text. It´s got some $pecial Characters like \" or '. Yeah, so be it"
+      @cmd.to_s.should == "echo 'A long text. It´s got some $pecial Characters like \" or '\\''. Yeah, so be it'"
+    end
+
+    it 'should add an array' do
+      @cmd << [
+               [:foo, 'bar'],
+               '-a',
+               :b,
+               'Something'
+              ]
+      @cmd.to_s.should == 'echo --foo=bar -a -b Something'
+    end
+
+    it 'should be chainable' do
+      @cmd << :p << 'Something else'
+      @cmd.to_s.should == "echo -p 'Something else'"
+    end
+  end
+
+  describe '#to_s' do
+    it 'should escape argument strings' do
+      EM::SystemCommand::Builder.new('echo', 'Irgendwas"$').to_s.
+        should == "echo 'Irgendwas\"$'"
+    end
+
+    it 'should not escape symbol options' do
+      EM::SystemCommand::Builder.new('echo', :n, 'Irgendwas"$').to_s.
+        should == "echo -n 'Irgendwas\"$'"
+    end
+
+    it 'should not escape symbol long parameter names' do
+      EM::SystemCommand::Builder.new('echo', [:creative, 'not$'], 'Irgendwas"$').to_s.
+        should == "echo --creative='not$' 'Irgendwas\"$'"
+    end
+
+    it 'should not escape symbol short parameter names' do
+      EM::SystemCommand::Builder.new('echo', [:a, 'not$'], 'Irgendwas"$').to_s.
+        should == "echo -a 'not$' 'Irgendwas\"$'"
+    end
+
+    it 'should not escape long parameters' do
+      EM::SystemCommand::Builder.new('echo', ['--creative', 'not$'], 'Irgendwas"$').to_s.
+        should == "echo --creative='not$' 'Irgendwas\"$'"
+    end
+
+    it 'should not escape short parameters' do
+      EM::SystemCommand::Builder.new('echo', ['-a', 'not$'], 'Irgendwas"$').to_s.
+        should == "echo -a 'not$' 'Irgendwas\"$'"
+    end
+
+    it 'should not escape arguments' do
+      EM::SystemCommand::Builder.new('echo', '-n', 'Irgendwas"$').to_s.
+        should == "echo -n 'Irgendwas\"$'"
+    end
+  end
+end

data/spec/em-systemcommand/pipe_spec.rb

@@ -5,7 +5,7 @@ describe 'Pipe' do
   context '#receive_data' do
     it 'should correctly do a carriage return in the output buffer' do
       EM.run do
-        EM::SystemCommand.new %q{ruby -e '$stdout.sync = true; print "12345\r"; puts "321"; print "123"; print "\r3210"; exit 0;'} do |on|
+        EM::SystemCommand.execute %q{ruby -e '$stdout.sync = true; print "12345\r"; puts "321"; print "123"; print "\r3210"; exit 0;'} do |on|
           on.success do |process|
             EM.stop_event_loop
             process.stdout.output.should == "32145\n3210"
@@ -20,7 +20,7 @@ describe 'Pipe' do
     it 'should be called on data' do
       received = []
       EM.run do
-        EM::SystemCommand.new %q{echo -n "123123";} do |on|
+        EM::SystemCommand.execute %q{echo -n "123123";} do |on|
           on.stdout.data do |data|
             received << data
           end
@@ -36,7 +36,7 @@ describe 'Pipe' do
     it 'should be called once even when there is a linebreak' do
       received = []
       EM.run do
-        EM::SystemCommand.new %Q{echo "123\n456"} do |on|
+        EM::SystemCommand.execute %Q{echo "123\n456"} do |on|
           on.stdout.data do |data|
             received << data
           end
@@ -55,7 +55,7 @@ describe 'Pipe' do
     it 'should be called on readline' do
       received = []
       EM.run do
-        EM::SystemCommand.new 'echo "123"; echo "456"' do |on|
+        EM::SystemCommand.execute 'echo "123"; echo "456"' do |on|
           on.stdout.line do |data|
             received << data
           end
@@ -71,7 +71,7 @@ describe 'Pipe' do
     it 'should be called on carriage return' do
       received = []
       EM.run do
-        EM::SystemCommand.new %q{ruby -e '$stdout.sync = true; print "123\r"; print "456\r"; exit 0;'} do |on|
+        EM::SystemCommand.execute %q{ruby -e '$stdout.sync = true; print "123\r"; print "456\r"; exit 0;'} do |on|
           on.stdout.line do |data|
             received << data
           end
@@ -91,7 +91,7 @@ describe 'Pipe' do
     it 'should be called on receive data' do
       received = []
       EM.run do
-        EM::SystemCommand.new %q{ruby -e '$stdout.sync = true; puts "123"; puts "456"; exit 0'} do |on|
+        EM::SystemCommand.execute %q{ruby -e '$stdout.sync = true; puts "123"; puts "456"; exit 0'} do |on|
           on.stdout.update do |data|
             received << data
           end
@@ -107,7 +107,7 @@ describe 'Pipe' do
     it 'should be called on carriage return'do
       received = []
       EM.run do
-        EM::SystemCommand.new %q{ruby -e '$stdout.sync = true; print "123\r"; sleep 0.1; print "456\r"; exit 0;'} do |on|
+        EM::SystemCommand.execute %q{ruby -e '$stdout.sync = true; print "123\r"; sleep 0.1; print "456\r"; exit 0;'} do |on|
           on.stdout.update do |data|
             received << data
           end
@@ -127,7 +127,7 @@ describe 'Pipe' do
     it 'should match in lines on receive_line' do
       received = []
       EM.run do
-        EM::SystemCommand.new 'echo "-123-"; echo "-456-"' do |on|
+        EM::SystemCommand.execute 'echo "-123-"; echo "-456-"' do |on|
           on.stdout.match /-([0-9]+)-/, in: :line do |match, number|
             received << number
           end
@@ -143,7 +143,7 @@ describe 'Pipe' do
     it 'should match in output buffer on receive_update' do
       received = []
       EM.run do
-        EM::SystemCommand.new %q{ruby -e '$stdout.sync = true; print "-123-\r"; sleep 0.1; print "-456-\r"; exit 0'} do |on|
+        EM::SystemCommand.execute %q{ruby -e '$stdout.sync = true; print "-123-\r"; sleep 0.1; print "-456-\r"; exit 0'} do |on|
           on.stdout.match /-([0-9]+)-/, in: :output do |match, number|
             received << number
           end

data/spec/em-systmcommand_spec.rb

@@ -2,10 +2,10 @@ require 'spec_helper'
 
 describe EM::SystemCommand do
 
-  it 'should call a success callback when process succeeds' do
+  it 'should call a success callback when process succeeds'  do
     called = false
     EM.run do
-      EM::SystemCommand.new 'exit 0;' do |on|
+      EM::SystemCommand.execute 'exit 0;' do |on|
         on.success do |ps|
           called = true
         end
@@ -19,11 +19,15 @@ describe EM::SystemCommand do
 
   it 'should take a success callback with process as parameter' do
     EM.run do
-      EM::SystemCommand.new 'exit 0;' do |on|
+      EM::SystemCommand.execute 'exit 0;' do |on|
         on.success do |ps|
           EM.stop_event_loop
           ps.should be_a EM::SystemCommand
         end
+
+        on.failure do |ps|
+          EM.stop_event_loop
+        end
       end
     end
   end
@@ -31,7 +35,7 @@ describe EM::SystemCommand do
   it 'should call a failure callback when process fails' do
     called = false
     EM.run do
-      EM::SystemCommand.new 'echo "123"; exit 1;' do |on|
+      EM::SystemCommand.execute 'echo "123"; exit 1;' do |on|
         on.failure do |ps|
           called = true
         end
@@ -45,7 +49,7 @@ describe EM::SystemCommand do
 
   it 'should take a failure callback with process as parameter' do
     EM.run do
-      EM::SystemCommand.new 'exit 1;' do |on|
+      EM::SystemCommand.execute 'exit 1;' do |on|
         on.failure do |ps|
           EM.stop_event_loop
           ps.should be_a EM::SystemCommand
@@ -56,7 +60,7 @@ describe EM::SystemCommand do
 
   it 'should have stdin pipe' do
     EM.run do
-      ps = EM::SystemCommand.new 'echo "123"; exit 1;'
+      ps = EM::SystemCommand.execute 'echo "123"; exit 1;'
       ps.stdin.should be_a EM::SystemCommand::Pipe
       EM.stop_event_loop
     end
@@ -64,7 +68,7 @@ describe EM::SystemCommand do
 
   it 'should have stdout pipe' do
     EM.run do
-      ps = EM::SystemCommand.new 'echo "123"; exit 1;'
+      ps = EM::SystemCommand.execute 'echo "123"; exit 1;'
       ps.stdout.should be_a EM::SystemCommand::Pipe
       EM.stop_event_loop
     end
@@ -72,7 +76,7 @@ describe EM::SystemCommand do
 
   it 'should have stderr pipe' do
     EM.run do
-      ps = EM::SystemCommand.new 'echo "123"; exit 1;'
+      ps = EM::SystemCommand.execute 'echo "123"; exit 1;'
       ps.stderr.should be_a EM::SystemCommand::Pipe
       EM.stop_event_loop
     end
@@ -90,7 +94,5 @@ describe EM::SystemCommand do
         stderr: EM::SystemCommand::Pipe
       }
     end
-
   end
-
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: em-systemcommand
 version: !ruby/object:Gem::Version
-  version: 0.0.5
+  version: 1.0.0
   prerelease: 
 platform: ruby
 authors:
@@ -9,11 +9,11 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2012-05-14 00:00:00.000000000 Z
+date: 2012-05-24 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rspec
-  requirement: &18462820 !ruby/object:Gem::Requirement
+  requirement: !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -21,10 +21,15 @@ dependencies:
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: *18462820
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: guard
-  requirement: &18461760 !ruby/object:Gem::Requirement
+  requirement: !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -32,10 +37,31 @@ dependencies:
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: *18461760
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: guard-rspec
-  requirement: &18460700 !ruby/object:Gem::Requirement
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -43,10 +69,31 @@ dependencies:
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: *18460700
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: escape
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: eventmachine
-  requirement: &18477240 !ruby/object:Gem::Requirement
+  requirement: !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -54,7 +101,12 @@ dependencies:
         version: '0'
   type: :runtime
   prerelease: false
-  version_requirements: *18477240
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
 description: ! '`em-systemcommand` is a simple abstraction for invoking system commands
   and handling their output easily with eventmachine.'
 email:
@@ -73,9 +125,11 @@ files:
 - Rakefile
 - em-systemcommand.gemspec
 - lib/em-systemcommand.rb
+- lib/em-systemcommand/builder.rb
 - lib/em-systemcommand/pipe.rb
 - lib/em-systemcommand/pipe_handler.rb
 - lib/em-systemcommand/version.rb
+- spec/em-systemcommand/builder_spec.rb
 - spec/em-systemcommand/pipe_spec.rb
 - spec/em-systmcommand_spec.rb
 - spec/spec_helper.rb
@@ -91,19 +145,26 @@ required_ruby_version: !ruby/object:Gem::Requirement
   - - ! '>='
     - !ruby/object:Gem::Version
       version: '0'
+      segments:
+      - 0
+      hash: 1884745858443868072
 required_rubygems_version: !ruby/object:Gem::Requirement
   none: false
   requirements:
   - - ! '>='
     - !ruby/object:Gem::Version
       version: '0'
+      segments:
+      - 0
+      hash: 1884745858443868072
 requirements: []
 rubyforge_project: 
-rubygems_version: 1.8.17
+rubygems_version: 1.8.24
 signing_key: 
 specification_version: 3
 summary: Sweeter popen3 for EventMachine.
 test_files:
+- spec/em-systemcommand/builder_spec.rb
 - spec/em-systemcommand/pipe_spec.rb
 - spec/em-systmcommand_spec.rb
 - spec/spec_helper.rb