komenda 0.0.4 → 0.1.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 7e9f8fb8dbfd89bfe6f02a03ab9b9916152cd9a1
-  data.tar.gz: ccd5136b7c00ee0da50df39d6845985242d0c414
+  metadata.gz: 1dc95e01539e2ccbbc00044df4c47da92578c9c3
+  data.tar.gz: 72b97381c230e7bb19d7507c495c6c3abc311a57
 SHA512:
-  metadata.gz: 936da7f196c29f3d145731f74ac98e29344c0478c506dcd45aecdb8ef717fbe37f2b9049c07feefa3d2201f5874a07efb8a6d5b6747bea16082cc6686a67d92a
-  data.tar.gz: c968d4eeafd91c117e94a4de47eb2399136f8e560a119dc00aefa55f32dce2336353dc7d9dd2349e38d9d0bfd2631d4378bd923cfe0dae8b4329bc318ec64232
+  metadata.gz: 2d2edf563c747a5816d878a0a972880a1da1b27275ba54bbbf9c3432841532aba04fbffce3f0da2d68ac35fdd4a6c1e697f9bac1b5560ae35c15f73b6bf97796
+  data.tar.gz: 440e085f88b4324f055ce0b5a222e6efd083acaf01efa6b83fae13be65067509b0d380e16bcd158e118ee87ad3d7b7fe02e81f4c92f02005e835c84299853d4f

data/README.md

@@ -1,6 +1,9 @@
-Komenda [![Build Status](https://travis-ci.org/cargomedia/komenda.svg)](https://travis-ci.org/cargomedia/komenda)
+Komenda
 =======
-Komenda is a convenience wrapper around `Open3` to run shell commands in Ruby.
+Komenda is a convenience wrapper to run shell commands in Ruby.
+
+[![Build Status](https://img.shields.io/travis/cargomedia/komenda/master.svg)](https://travis-ci.org/cargomedia/komenda)
+[![Gem Version](https://img.shields.io/gem/v/komenda.svg)](https://rubygems.org/gems/komenda)
 
 Usage
 -----

data/lib/komenda.rb

@@ -1,12 +1,11 @@
 require 'open3'
-require 'event_emitter'
+require 'events'
 
 require 'komenda/process_builder'
 require 'komenda/process'
 require 'komenda/result'
 
 module Komenda
-
   # @param [String] command
   # @param [Hash] options
   # @return [Komenda::Process]
@@ -22,5 +21,4 @@ module Komenda
     process_builder = Komenda::ProcessBuilder.new(command, options)
     process_builder.create.run
   end
-
 end

data/lib/komenda/process.rb

@@ -1,16 +1,14 @@
 module Komenda
   class Process
-
     attr_reader :output
 
-    include EventEmitter
+    include Events::Emitter
 
     # @param [ProcessBuilder] process_builder
     def initialize(process_builder)
       @process_builder = process_builder
-      @output = {:stdout => '', :stderr => '', :combined => ''}
-      @exit_status = nil
-      @thread = nil
+      @output = { stdout: '', stderr: '', combined: '' }
+      @exit_status = @thread = @pid = nil
 
       on(:stdout) { |data| @output[:stdout] += data }
       on(:stderr) { |data| @output[:stderr] += data }
@@ -22,88 +20,107 @@ module Komenda
 
     # @return [Thread]
     def start
-      raise 'Already started' if is_started?
+      fail 'Already started' if started?
       @thread = Thread.new { run_process(@process_builder) }
     end
 
     # @return [Komenda::Result]
     def wait_for
-      raise 'Process not started' unless is_started?
+      fail 'Process not started' unless started?
       @thread.join
       result
     end
 
     # @return [Komenda::Result]
     def run
-      start unless is_started?
+      start unless started?
       wait_for
     end
 
+    # @return [Integer]
+    def pid
+      fail 'No PID available' if @pid.nil?
+      @pid
+    end
+
+    # @param [Integer, String]
+    def kill(signal = 'TERM')
+      ::Process.kill(signal, pid)
+    end
+
     # @return [TrueClass, FalseClass]
     def running?
-      raise 'Process not started' unless is_started?
-      @thread.alive?
+      started? && !@pid.nil? && @thread.alive?
     end
 
     # @return [Komenda::Result]
     def result
-      raise 'Process not started' unless is_started?
-      raise 'Process not finished' unless is_finished?
+      fail 'Process not started' unless started?
+      fail 'Process not finished' unless finished?
       Komenda::Result.new(@output, @exit_status)
     end
 
     private
 
     # @return [TrueClass, FalseClass]
-    def is_started?
+    def started?
       !@thread.nil?
     end
 
     # @return [TrueClass, FalseClass]
-    def is_finished?
+    def finished?
       !@exit_status.nil?
     end
 
     # @param [ProcessBuilder] process_builder
     def run_process(process_builder)
-      begin
-        if process_builder.cwd.nil?
-          run_popen3(process_builder)
-        else
-          Dir.chdir(process_builder.cwd) { run_popen3(process_builder) }
-        end
-      rescue Exception => exception
-        emit(:error, exception)
-        raise exception
+      if process_builder.cwd.nil?
+        run_popen3(process_builder)
+      else
+        Dir.chdir(process_builder.cwd) { run_popen3(process_builder) }
       end
+    rescue Exception => exception
+      emit(:error, exception)
+      raise exception
     end
 
     # @param [ProcessBuilder] process_builder
     def run_popen3(process_builder)
       Open3.popen3(process_builder.env, *process_builder.command) do |stdin, stdout, stderr, wait_thr|
+        @pid = wait_thr.pid
         stdin.close
-
-        streams_read_open = [stdout, stderr]
-        begin
-          streams_read_available, _, _ = IO.select(streams_read_open)
-
-          streams_read_available.each do |stream|
-            if stream.eof?
-              stream.close
-              streams_read_open.delete(stream)
-            else
-              data = stream.readpartial(4096)
-              emit(:stdout, data) if stdout === stream
-              emit(:stderr, data) if stderr === stream
-              emit(:output, data)
-            end
-          end
-        end until streams_read_open.empty?
-
+        read_streams([stdout, stderr]) do |data, stream|
+          emit(:output, data)
+          emit(:stdout, data) if stdout == stream
+          emit(:stderr, data) if stderr == stream
+        end
         @exit_status = wait_thr.value
         emit(:exit, result)
       end
     end
 
+    # @param [Array<IO>] streams
+    def read_streams(streams)
+      select_streams(streams) do |stream|
+        if stream.eof?
+          stream.close
+        else
+          data = stream.readpartial(4096)
+          yield(data, stream)
+        end
+      end
+    end
+
+    # @param [Array<IO>] streams
+    def select_streams(streams)
+      loop do
+        streams_available, = IO.select(streams)
+        streams_available.each do |stream|
+          yield(stream)
+        end
+        streams.reject!(&:closed?)
+        break if streams.empty?
+      end
+    end
   end
 end

data/lib/komenda/process_builder.rb

@@ -1,6 +1,5 @@
 module Komenda
   class ProcessBuilder
-
     attr_reader :command
     attr_reader :env
     attr_reader :cwd
@@ -10,16 +9,16 @@ module Komenda
     # @param [Hash] options
     def initialize(command, options = {})
       defaults = {
-        :env => ENV.to_hash,
-        :cwd => nil,
-        :events => {},
+        env: ENV.to_hash,
+        cwd: nil,
+        events: {}
       }
       options = defaults.merge(options)
 
-      @command = command.is_a?(Array) ? command.map { |v| String(v) } : String(command)
-      @env = Hash[options[:env].to_hash.map { |k, v| [String(k), String(v)] }]
-      @cwd = options[:cwd].nil? ? nil : String(options[:cwd])
-      @events = Hash[options[:events].to_hash.map { |k, v| [k.to_sym, v.to_proc] }]
+      self.command = command
+      self.env = options[:env]
+      self.cwd = options[:cwd]
+      self.events = options[:events]
     end
 
     # @return [Komenda::Process]
@@ -27,5 +26,28 @@ module Komenda
       Komenda::Process.new(self)
     end
 
+    # @param [String, Array<String>] command
+    def command=(command)
+      if command.is_a?(Array)
+        @command = command.map { |v| String(v) }
+      else
+        @command = String(command)
+      end
+    end
+
+    # @param [Hash] env
+    def env=(env)
+      @env = Hash[env.to_hash.map { |k, v| [String(k), String(v)] }]
+    end
+
+    # @param [String] cwd
+    def cwd=(cwd = nil)
+      @cwd = cwd.nil? ? nil : String(cwd)
+    end
+
+    # @param [Hash<Symbol, Proc>]
+    def events=(events)
+      @events = Hash[events.to_hash.map { |k, v| [k.to_sym, v.to_proc] }]
+    end
   end
 end

data/lib/komenda/result.rb

@@ -1,6 +1,5 @@
 module Komenda
   class Result
-
     # @param [Hash] output
     # @option output_streams [String] :stdout
     # @option output_streams [String] :stderr
@@ -35,6 +34,5 @@ module Komenda
     def pid
       @status.pid
     end
-
   end
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: komenda
 version: !ruby/object:Gem::Version
-  version: 0.0.4
+  version: 0.1.1
 platform: ruby
 authors:
 - Cargo Media
@@ -9,22 +9,22 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-11-27 00:00:00.000000000 Z
+date: 2015-12-30 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
-  name: event_emitter
+  name: events
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0.2'
+        version: 0.9.8
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0.2'
+        version: 0.9.8
 - !ruby/object:Gem::Dependency
   name: bundler
   requirement: !ruby/object:Gem::Requirement
@@ -67,6 +67,34 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '2.0'
+- !ruby/object:Gem::Dependency
+  name: rspec-wait
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.0.8
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.0.8
+- !ruby/object:Gem::Dependency
+  name: rubocop
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.35'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.35'
 description: Convenience wrapper around `Open3` to run shell commands in Ruby.
 email: hello@cargomedia.ch
 executables: []
@@ -99,7 +127,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.4.8
+rubygems_version: 2.5.0
 signing_key: 
 specification_version: 4
 summary: Convenience wrapper around `Open3` to run shell commands in Ruby.