komenda 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: c3b17f1984f7f2f3ccab6d25a6ecd9e2714d6710
+  data.tar.gz: 6d845d8f6974ad2a53d66875e5a0a691459adc1d
+SHA512:
+  metadata.gz: 2442eed8d0dcc1acdb1f218e6ac219219dab35bc330d3747ffaf79d3282776a4a282c3e714644cc1f5878e3c5a34cd4fa2ddf1294150e8b30ee5e0decbc8a50a
+  data.tar.gz: f175f373cd17ff6e84debf25666d1f10584344d886a996059efb3af769345f1f4977bc68c0cffefc44456cb41936dcef5a92b1488e8478d6246b730f198b475a

data/LICENSE

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2015 Cargo Media
+
+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,28 @@
+Komenda [![Build Status](https://travis-ci.org/cargomedia/komenda.svg)](https://travis-ci.org/cargomedia/komenda)
+=======
+Komenda is a convenience wrapper around `Open3` to run shell commands in Ruby.
+
+Usage
+-----
+Run a command:
+```ruby
+Komenda.run("date")
+```
+
+The `run()` method will block until the sub process finished.
+
+It will expose the output and exit status as a `Komenda::Result` value:
+```ruby
+result = Komenda.run("date")
+result.stdout   # => "Tue Nov 26 14:45:03 EST 2013\n"
+result.stderr   # => ""
+result.output   # => "Tue Nov 26 14:45:03 EST 2013\n" (combined stdout + stderr)
+result.status   # => 0
+result.success? # => true
+result.pid      # => 32157
+```
+
+TODO
+----
+- `Komenda::Definition`: Allow to pass STDIN
+- `Komenda::Definition`: Allow to pass environment variables

data/lib/komenda.rb

@@ -0,0 +1,17 @@
+require 'open3'
+
+require 'komenda/definition'
+require 'komenda/runner'
+require 'komenda/result'
+
+module Komenda
+
+  # @param [String] cmd
+  # @return [Komenda::Result]
+  def self.run(cmd)
+    definition = Komenda::Definition.new(cmd)
+    runner = Komenda::Runner.new
+    runner.run(definition)
+  end
+
+end

data/lib/komenda/definition.rb

@@ -0,0 +1,12 @@
+module Komenda
+  class Definition
+
+    attr_reader :cmd
+
+    # @param [String] cmd
+    def initialize(cmd)
+      @cmd = cmd
+    end
+
+  end
+end

data/lib/komenda/result.rb

@@ -0,0 +1,40 @@
+module Komenda
+  class Result
+
+    # @param [Hash] output
+    # @option output_streams [String] :stdout
+    # @option output_streams [String] :stderr
+    # @param [Process::Status] status
+    def initialize(output, status)
+      @output = output
+      @status = status
+    end
+
+    def stdout
+      @output[:stdout]
+    end
+
+    def stderr
+      @output[:stderr]
+    end
+
+    def output
+      @output[:combined]
+    end
+
+    def exitstatus
+      @status.exitstatus
+    end
+
+    alias_method :status, :exitstatus
+
+    def success?
+      @status.success?
+    end
+
+    def pid
+      @status.pid
+    end
+
+  end
+end

data/lib/komenda/runner.rb

@@ -0,0 +1,37 @@
+module Komenda
+  class Runner
+
+    # @param [Komenda::Definition] definition
+    # @return [Komenda::Result]
+    def run(definition)
+      output = {:stdout => '', :stderr => '', :combined => ''}
+      status = nil
+
+      Open3.popen3(definition.cmd) do |stdin, stdout, stderr, wait_thr|
+        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)
+              output[:stdout] += data if stdout === stream
+              output[:stderr] += data if stderr === stream
+              output[:combined] += data
+            end
+          end
+        end until streams_read_open.empty?
+
+        status = wait_thr.value
+      end
+
+      Komenda::Result.new(output, status)
+    end
+
+  end
+end

metadata

@@ -0,0 +1,92 @@
+--- !ruby/object:Gem::Specification
+name: komenda
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- Cargo Media
+- njam
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2015-10-27 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.3'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.3'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.1'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.1'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.0'
+description: Convenience wrapper around `Open3` to run shell commands in Ruby.
+email: hello@cargomedia.ch
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- LICENSE
+- README.md
+- lib/komenda.rb
+- lib/komenda/definition.rb
+- lib/komenda/result.rb
+- lib/komenda/runner.rb
+homepage: https://github.com/cargomedia/komenda
+licenses:
+- MIT
+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.8
+signing_key: 
+specification_version: 4
+summary: Convenience wrapper around `Open3` to run shell commands in Ruby.
+test_files: []