em-systemcommand 0.0.1

data/.gitignore

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

data/.rspec

@@ -0,0 +1,2 @@
+--color
+--format progress

data/.rvmrc

@@ -0,0 +1 @@
+rvm use --create --install 1.9.3@em-systemcommand

data/Gemfile

@@ -0,0 +1,4 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in em-systemcommand.gemspec
+gemspec

data/Guardfile

@@ -0,0 +1,15 @@
+guard 'rspec', :version => 2 do
+  watch(%r{^spec/.+_spec\.rb$})
+  watch(%r{^lib/(.+)\.rb$})     { |m| "spec/lib/#{m[1]}_spec.rb" }
+  watch('spec/spec_helper.rb')  { "spec" }
+
+  # Rails example
+  watch(%r{^app/(.+)\.rb$})                           { |m| "spec/#{m[1]}_spec.rb" }
+  watch(%r{^app/(.*)(\.erb|\.haml)$})                 { |m| "spec/#{m[1]}#{m[2]}_spec.rb" }
+  watch(%r{^app/controllers/(.+)_(controller)\.rb$})  { |m| ["spec/routing/#{m[1]}_routing_spec.rb", "spec/#{m[2]}s/#{m[1]}_#{m[2]}_spec.rb", "spec/acceptance/#{m[1]}_spec.rb"] }
+  watch(%r{^spec/support/(.+)\.rb$})                  { "spec" }
+  watch('config/routes.rb')                           { "spec/routing" }
+  watch('app/controllers/application_controller.rb')  { "spec/controllers" }
+  # Capybara request specs
+  watch(%r{^app/views/(.+)/.*\.(erb|haml)$})          { |m| "spec/requests/#{m[1]}_spec.rb" }
+end

data/LICENSE

@@ -0,0 +1,22 @@
+Copyright (c) 2012 Arthur Andersen
+
+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,86 @@
+# EM::SystemCommand
+
+`EM::SystemCommand` is an `popen3` abstraction for eventmachine to easily create subprocesses with eventmachine.
+The goal is to provide an easy way to invoke system commands and to read and handle their outputs. When creating an 
+`EM::SystemCommand` object its basically like a popen. It has `#stdin`, `#stdout` and `#stderr`.
+Which are related to `EM::Connection`.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+    gem 'em-systemcommand'
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install em-systemcommand
+
+## Usage
+
+To simply run a process you can instatiate an `EM::SystemCommand`
+object and set up the callbacks in the yielded block.
+
+    EM.run do
+      EM::SystemCommand 'my_command' do |on|
+        on.success do |ps|
+          puts "Success!"
+        end
+        
+        on.failure do |ps|
+          puts "Failure with status #{ps.status.exitstatus}"
+        end
+      end
+    end
+    
+When you want to retreive output, you can use the methods
+`#update`, `#line` and `#data` on a pipe object like so:
+
+    EM.run do
+      EM::SystemCommand 'my_command' do |on|
+        on.success do |ps|
+          puts "Success!"
+        end
+        
+        on.stdout.data do |data|
+          puts "Data: #{data}"
+        end
+        
+        on.stdout.line do |line|
+          puts "Line: #{line}"
+        end
+        
+        # `#output` gets the whole output buffer.
+        # This means, it has theoretically the screen you´d get when
+        # invoking the command in the shell. Although only \r is used.
+        on.stdout.update do |output|
+          puts output
+        end
+      end
+    end
+
+`Pipe` objects even have a nice convenient method `#match` which lets
+you match output against a regular expression:
+
+    EM.run do
+      EM::SystemCommand 'echo "25%\n"; sleep 1; echo "50%\n"; sleep 1; echo "75%\n"; sleep 1; echo "100%\n"; exit 0;' do |on|
+        on.success do |ps|
+          puts "Success!"
+        end
+        .
+        on.stdout.match /([0-9]+)%/, in: :line do |match, progress|
+          puts "Percentage: #{progress}"
+        end
+      end
+    end
+
+## 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,2 @@
+#!/usr/bin/env rake
+require "bundler/gem_tasks"

data/em-systemcommand.gemspec

@@ -0,0 +1,23 @@
+# -*- encoding: utf-8 -*-
+require File.expand_path('../lib/em-systemcommand/version', __FILE__)
+
+Gem::Specification.new do |gem|
+  gem.authors       = ["Arthur Andersen"]
+  gem.email         = ["leoc.git@gmail.com"]
+  gem.description   = %q{}
+  gem.summary       = %q{}
+  gem.homepage      = ""
+
+  gem.files         = `git ls-files`.split($\)
+  gem.executables   = gem.files.grep(%r{^bin/}).map{ |f| File.basename(f) }
+  gem.test_files    = gem.files.grep(%r{^(test|spec|features)/})
+  gem.name          = "em-systemcommand"
+  gem.require_paths = ["lib"]
+  gem.version       = Em::Systemcommand::VERSION
+
+  gem.add_development_dependency 'rspec'
+  gem.add_development_dependency 'guard'
+  gem.add_development_dependency 'guard-rspec'
+
+  gem.add_dependency 'eventmachine'
+end

data/lib/em-systemcommand/pipe.rb

@@ -0,0 +1,122 @@
+module EventMachine
+  class SystemCommand
+    class Pipe < EM::Connection
+
+      def initialize(master, name)
+        @master             = master
+        @name               = name
+        @master.pipes[name] = self
+        begin
+          @outputbuffer     = StringIO.new()
+        rescue Exception => e
+          puts "Uninitialized constant StringIO. This may happen when you forgot to use bundler. Use `bundle exec`."
+        end
+      end
+
+      def output
+        @outputbuffer.string
+      end
+
+      # Convenience method to create a callback that matches a regular expression
+      def match regexp, opt = {}, &block
+        opt = { in: :line }.merge opt
+        (opt[:in] == :output ? receive_update_callbacks : receive_line_callbacks) << lambda do |data|
+          if m = data.match(regexp)
+            block.call m.to_a
+          end
+        end
+      end
+
+      # Invoked when line was received
+      def receive_line line
+        receive_line_callbacks.each do |callback|
+          callback.call line
+        end
+      end
+
+      # Adds a callback for `receive_line` events.
+      def line &block
+        receive_line_callbacks << block
+      end
+
+      # Invoked when a line was written, but `\r` was received without
+      # a line-break in the end.
+      def receive_update line
+        receive_update_callbacks.each do |callback|
+          callback.call line
+        end
+      end
+
+      # Adds a callback for `receive_update` events.
+      def update &block
+        receive_update_callbacks << block
+      end
+
+      # Invoked when data was received.
+      def receive_data data
+        receive_data_callbacks.each do |callback|
+          callback.call data
+        end
+
+        @lt2_linebuffer ||= []
+
+        ix = data.index("\r")
+        if ix and data[ix+1] != "\n"
+          @lt2_linebuffer << data[0...ix]
+          ln = @lt2_linebuffer.join
+          @lt2_linebuffer.clear
+          @outputbuffer.print ln
+          @outputbuffer.pos -= ln.length
+          receive_line ln
+          receive_update @outputbuffer.string
+          receive_data data[(ix+1)..-1] # receive rest data
+        elsif ix = data.index("\n")
+          @lt2_linebuffer << data[0...ix]
+          ln = @lt2_linebuffer.join
+          @lt2_linebuffer.clear
+          ln.chomp!
+          @outputbuffer.puts ln
+          receive_line ln
+          receive_update @outputbuffer.string
+          receive_data data[(ix+1)..-1] # receive rest data
+        else
+          @lt2_linebuffer << data
+        end
+      end
+
+      # Adds a callback for `receive_data` events.
+      def data &block
+        receive_data_callbacks << block
+      end
+
+      # Close the attached IO object.
+      def close
+        begin
+          @io.close unless @io.closed?
+        rescue Exception => e
+          # ignore errors, when the io object might be closed already
+        end
+      end
+
+      # Invoked when the connection is terminated. Calls
+      # `unbind(@name)` on master.
+      def unbind
+        self.close
+        @master.unbind(@name)
+      end
+
+      private
+      def receive_line_callbacks
+        @receive_line_callbacks ||= []
+      end
+
+      def receive_update_callbacks
+        @receive_update_callbacks ||= []
+      end
+
+      def receive_data_callbacks
+        @receive_data_callbacks ||= []
+      end
+    end
+  end
+end

data/lib/em-systemcommand/pipe_handler.rb

@@ -0,0 +1,33 @@
+module EventMachine
+  class SystemCommand
+    module PipeHandler
+      def self.included(base)
+        base.extend(ClassMethods)
+      end
+
+      def attach_pipe_handler name, io_object
+        EM.attach(io_object, pipe_handler_class(name), self, name)
+      end
+
+      def pipe_handler_class name
+        self.class.pipe_handlers[name]
+      end
+
+      module ClassMethods
+
+        def pipe_handler name, klass
+          pipe_handlers[name] = klass
+        end
+
+        def pipe_handler_class name
+          pipe_handlers[name]
+        end
+
+        def pipe_handlers
+          @pipe_handlers ||= {}
+        end
+
+      end
+    end
+  end
+end

data/lib/em-systemcommand/version.rb

@@ -0,0 +1,5 @@
+module Em
+  module Systemcommand
+    VERSION = "0.0.1"
+  end
+end

data/lib/em-systemcommand.rb

@@ -0,0 +1,65 @@
+require 'open3'
+
+require "em-systemcommand/version"
+
+require "em-systemcommand/pipe"
+require "em-systemcommand/pipe_handler"
+
+module EventMachine
+  class SystemCommand
+    include EM::SystemCommand::PipeHandler
+    include EM::Deferrable
+
+    pipe_handler :stdin,  EM::SystemCommand::Pipe
+    pipe_handler :stdout, EM::SystemCommand::Pipe
+    pipe_handler :stderr, EM::SystemCommand::Pipe
+
+    attr_accessor :pipes, :stdin, :stdout, :stderr
+
+    def initialize *arguments
+
+      @pipes = {}
+
+      stdin, stdout, stderr, @wait_thr = Open3.popen3(*arguments)
+
+      @stdin  = attach_pipe_handler :stdin, stdin
+      @stdout = attach_pipe_handler :stdout, stdout
+      @stderr = attach_pipe_handler :stderr, stderr
+
+      yield self if block_given?
+
+    end
+
+    def pid
+      @wait_thr.pid
+    end
+
+    def status
+      @wait_thr.value
+    end
+
+    alias_method :success, :callback
+    alias_method :failure, :errback
+
+    def unbind name
+      pipes.delete name
+      if pipes.empty?
+        if status.exitstatus == 0
+          succeed
+        else
+          fail status
+        end
+      end
+    end
+
+    def kill signal = 'TERM', wait = false
+      Process.kill signal, self.pid
+      val = status if wait
+      @stdin.close
+      @stdout.close
+      @stderr.close
+      val
+    end
+
+  end
+end

data/spec/em-systmcommand_spec.rb

@@ -0,0 +1,59 @@
+require 'spec_helper'
+
+describe EM::SystemCommand do
+
+  it 'should take a success callback' do
+    called = false
+    EM.run do
+      EM::SystemCommand.new 'echo "123"; exit 0;' do |on|
+        on.success do |ps|
+          called = true
+        end
+      end
+
+      EM.assertions do
+        called.should == true
+      end
+    end
+  end
+
+  it 'should take a failure callback' do
+    called = false
+    EM.run do
+      EM::SystemCommand.new 'echo "123"; exit 1;' do |on|
+        on.failure do |ps|
+          called = true
+        end
+      end
+
+      EM.assertions do
+        called.should == true
+      end
+    end
+  end
+
+  it 'should have stdin pipe' do
+    EM.run do
+      ps = EM::SystemCommand.new 'echo "123"; exit 1;'
+      ps.stdin.should be_a EM::SystemCommand::Pipe
+      EM.stop_event_loop
+    end
+  end
+
+  it 'should have stdout pipe' do
+    EM.run do
+      ps = EM::SystemCommand.new 'echo "123"; exit 1;'
+      ps.stdout.should be_a EM::SystemCommand::Pipe
+      EM.stop_event_loop
+    end
+  end
+
+  it 'should have stderr pipe' do
+    EM.run do
+      ps = EM::SystemCommand.new 'echo "123"; exit 1;'
+      ps.stderr.should be_a EM::SystemCommand::Pipe
+      EM.stop_event_loop
+    end
+  end
+
+end

data/spec/spec_helper.rb

@@ -0,0 +1,24 @@
+# This file was generated by the `rspec --init` command. Conventionally, all
+# specs live under a `spec` directory, which RSpec adds to the `$LOAD_PATH`.
+# Require this file using `require "spec_helper.rb"` to ensure that it is only
+# loaded once.
+#
+# See http://rubydoc.info/gems/rspec-core/RSpec/Core/Configuration
+
+require 'eventmachine'
+require 'em-systemcommand'
+
+EventMachine.instance_eval do
+  def assertions time = 1
+    EM.add_timer(time) do
+      EM.stop_event_loop
+      yield
+    end
+  end
+end unless EM.respond_to?(:assertions)
+
+RSpec.configure do |config|
+  config.treat_symbols_as_metadata_keys_with_true_values = true
+  config.run_all_when_everything_filtered = true
+  config.filter_run :focus
+end

metadata

@@ -0,0 +1,112 @@
+--- !ruby/object:Gem::Specification
+name: em-systemcommand
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+  prerelease: 
+platform: ruby
+authors:
+- Arthur Andersen
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2012-05-03 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: &18939980 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: *18939980
+- !ruby/object:Gem::Dependency
+  name: guard
+  requirement: &18939560 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: *18939560
+- !ruby/object:Gem::Dependency
+  name: guard-rspec
+  requirement: &18939000 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: *18939000
+- !ruby/object:Gem::Dependency
+  name: eventmachine
+  requirement: &18938420 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: *18938420
+description: ''
+email:
+- leoc.git@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- .rspec
+- .rvmrc
+- Gemfile
+- Guardfile
+- LICENSE
+- README.md
+- Rakefile
+- em-systemcommand.gemspec
+- lib/em-systemcommand.rb
+- lib/em-systemcommand/pipe.rb
+- lib/em-systemcommand/pipe_handler.rb
+- lib/em-systemcommand/version.rb
+- spec/em-systmcommand_spec.rb
+- spec/spec_helper.rb
+homepage: ''
+licenses: []
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+      segments:
+      - 0
+      hash: -1466650369422800238
+required_rubygems_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+      segments:
+      - 0
+      hash: -1466650369422800238
+requirements: []
+rubyforge_project: 
+rubygems_version: 1.8.17
+signing_key: 
+specification_version: 3
+summary: ''
+test_files:
+- spec/em-systmcommand_spec.rb
+- spec/spec_helper.rb