command_utils 0.0.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 55fdf974b8fe587df928b134b85230d1e2444658
+  data.tar.gz: 0972d50cb9c28dddfbf24e1fe2af7fd91efe716e
+SHA512:
+  metadata.gz: 1cf38a61eea8bc39a2a4a229f90e74642e3d6022514215ec7d0093f70cb1761299a5ca901b4ae0af46954afa05bdda0c940003d561c5c2c611123df535050095
+  data.tar.gz: 74ed7398ded2e1cc63041a832ccdb9d7ecefd2a230a0a04921095ec38028c518b50181339744a72a253a816ae79a69bbbb8acdb989f21d99514ce26211976fe7

data/lib/command_utils/non_zero_status.rb

@@ -0,0 +1,18 @@
+class CommandUtils
+
+  # Raised when executed command does not return 0
+  class NonZeroStatus < RuntimeError
+
+    # Command exit status
+    attr_accessor :status
+    # Command as passed to Process#spawn
+    attr_accessor :command
+
+    def initialize message, status, command
+      super message
+      @status, @command = status, command
+    end
+
+  end
+
+end

data/lib/command_utils.rb

@@ -0,0 +1,86 @@
+require_relative 'command_utils/non_zero_status'
+
+# Class to assist calling external commands, while processing its output and return code.
+# All methods which execute given command, raise NonZeroStatus if its return is not 0.
+class CommandUtils
+
+  # Takes command in same format supported by Process#spawn
+  def initialize *command
+    @command = command
+  end
+
+  # Execute command, yielding to given block, each time there is output.
+  # stream:: either +:stdout+ or +:stderr+.
+  # data:: data read from respective stream.
+  def each_output # :yields: stream, data
+    run do
+      loop do
+        io_list = [@stdout_read, @stderr_read].keep_if{|io| not io.closed?}
+        break if io_list.empty?
+        IO.select(io_list).first.each do |io|
+          if io.eof?
+            io.close
+            next
+          end
+          label = case io
+          when @stdout_read
+            :stdout
+          when @stderr_read
+            :stderr
+          end
+          yield label, io.read
+        end
+      end
+    end
+  end
+
+  # Execute command, logging its output to given Logger object.
+  # Must receive a hash, containing at least:
+  # +:logger+:: Logger instance.
+  # +:stdout_level+:: Logger level to log stdout.
+  # +:stderr_level+:: Logger level to log stderr.
+  # and optionally:
+  # +:stdout_prefix+:: Prefix to use for all stdout messages.
+  # +:stderr_prefix+:: Prefix to use for all stderr messages.
+  def logger_exec options
+    logger = options[:logger]
+    each_output do |stream, data|
+      level = options["#{stream}_level".to_sym]
+      prefix = options["#{stream}_prefix".to_sym]
+      logger.send(level, "#{prefix}#{data}")
+    end
+  end
+
+  private
+
+  def run
+    spawn
+    yield
+    process_status
+  end
+
+  def spawn
+    @stdout_read, @stdout_write = IO.pipe
+    @stderr_read, @stderr_write = IO.pipe
+    @pid = Process.spawn(
+      *@command,
+      in: :close,
+      out: @stdout_write.fileno,
+      err: @stderr_write.fileno,
+      close_others: true,
+      )
+    @stdout_write.close
+    @stderr_write.close
+  end
+
+  def process_status
+    Process.wait @pid
+    unless (status = $?.exitstatus) == 0
+      raise NonZeroStatus.new(
+        "Command exited with #{status}.",
+        status,
+        @command
+        )
+    end
+  end
+end

metadata

@@ -0,0 +1,94 @@
+--- !ruby/object:Gem::Specification
+name: command_utils
+version: !ruby/object:Gem::Version
+  version: 0.0.0
+platform: ruby
+authors:
+- Fabio Pugliese Ornellas
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2015-04-02 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.2'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.2'
+- !ruby/object:Gem::Dependency
+  name: guard-rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '4.5'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '4.5'
+- !ruby/object:Gem::Dependency
+  name: guard-rdoc
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.0'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 1.0.3
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.0'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 1.0.3
+description: This Gem will help you call external commands, process its stdout and
+  stderr, to your own fit, and at the end, validate its return code.
+email: fabio.ornellas@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- lib/command_utils.rb
+- lib/command_utils/non_zero_status.rb
+homepage: https://github.com/fornellas/command_utils
+licenses:
+- GPL
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.4.5
+signing_key: 
+specification_version: 4
+summary: Simple Gem to assist running external commands an processing its outputs.
+test_files: []