komenda 0.1.6 → 0.1.7

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 5776b8baf0623308ba5d91c4af70d4de9e6a63c6
-  data.tar.gz: de78e64e458c3d8efe96cecbb630c7e5fb6274b7
+  metadata.gz: 539e892cf6dd52f871008d73d4597f549c40664a
+  data.tar.gz: 6421357e13b63bb9e3c59f45532cd72b8e4ea4db
 SHA512:
-  metadata.gz: 1644ff0df3f0e8954c6e9b81a736ae37763dc4a8efd0dd78bcab82d43048020d409a44a2fdbb2e131376224465e441b2122efdd040c5b314bfe7f158b5b0d206
-  data.tar.gz: 82d702d169daebb599300567684df3272d8c5aa3cd3fcbdf0e1cee2fec22aff15a1a7ccca596a82801a3196e9d9f712942bffbcc4f0703fa8d080a5ad2069a40
+  metadata.gz: b9c596b3f1c0cf1c50630ca6044793f85be884fb78367b1250840d7f90626cef45a1610d1044cddcabfb3a47089720bac0dc792a7ba4787df0d2d58dcf47685d
+  data.tar.gz: 5d0bd13566dfc652623f33240611830c1cf0fa205ba355e8ac98af28c4530d64c494db093201b5b94792065d11ae76faa4340b19c0fc59e699b202391753ffb9

data/README.md

@@ -25,18 +25,25 @@ result.success? # => true
 result.pid      # => 32157
 ```
 The program and its arguments can be passed as an array:
-```ruby
+```ruby 
 result = Komenda.run(['echo', '-n', 'hello'])
 result.output   # => "hello"
 ```
 
-The `run()` method has a second argument `options`, which accepts these optional keys:
+### Run options
+The `run()` method has a second argument `options`.
+```ruby
+result = Komenda.run('date', fail_on_fail: true)
+```
+
+
+The following options can be configured:
 - **`env`** (Hash): Additional environment variables to set.
-- **`use_bundler_env`** (Boolean): Use the environment variable of the current [bundle](http://bundler.io/). Defaults to `false`.
+- **`use_bundler_env`** (Boolean): Use the [environment of the current bundle](http://www.cargomedia.ch/2016/03/18/reset-bundler-environment.html). Defaults to `false`.
 - **`cwd`** (String): Directory to change to before running the process.
 - **`fail_on_fail`** (Boolean): Whether to raise an error when the exit code is not "0". Defaults to `false`.
 
-### Advanced usage
+### Asynchronous running
 The `create()` method creates a `Process` which can be `run()` (or `start()`ed as a Thread).
 ```
 process = Komenda.create('date')
@@ -67,9 +74,3 @@ Run the tests:
 ```
 bundle exec rake spec
 ```
-
-TODO
-----
-Add options for:
-- Passing STDIN
-- Making `run()` fail when exit status is not '0'

data/lib/komenda/process.rb

@@ -20,16 +20,16 @@ module Komenda
 
     # @return [Thread]
     def start
-      fail 'Already started' if started?
+      raise 'Already started' if started?
       @thread = Thread.new { run_process(@process_builder) }
     end
 
     # @return [Komenda::Result]
     def wait_for
-      fail 'Process not started' unless started?
+      raise 'Process not started' unless started?
       @thread.join
       if @process_builder.fail_on_fail && !result.success?
-        fail "Process failed with exit status `#{result.exitstatus}` and output:\n#{result.output}"
+        raise "Process failed with exit status `#{result.exitstatus}` and output:\n#{result.output}"
       end
       result
     end
@@ -42,7 +42,7 @@ module Komenda
 
     # @return [Integer]
     def pid
-      fail 'No PID available' if @pid.nil?
+      raise 'No PID available' if @pid.nil?
       @pid
     end
 
@@ -58,8 +58,8 @@ module Komenda
 
     # @return [Komenda::Result]
     def result
-      fail 'Process not started' unless started?
-      fail 'Process not finished' unless finished?
+      raise 'Process not started' unless started?
+      raise 'Process not finished' unless finished?
       Komenda::Result.new(@output, @exit_status)
     end
 

data/lib/komenda/process_builder.rb

@@ -35,11 +35,11 @@ module Komenda
 
     # @param [String, Array<String>] command
     def command=(command)
-      if command.is_a?(Array)
-        @command = command.map { |v| String(v) }
-      else
-        @command = String(command)
-      end
+      @command = if command.is_a?(Array)
+                   command.map { |v| String(v) }
+                 else
+                   String(command)
+                 end
     end
 
     # @param [Hash] env
@@ -69,11 +69,11 @@ module Komenda
 
     # @return [Hash]
     def env_final
-      if !use_bundler_env && Object.const_defined?('Bundler')
-        env_original = bundler_clean_env
-      else
-        env_original = ENV.to_hash
-      end
+      env_original = if !use_bundler_env && Object.const_defined?('Bundler')
+                       bundler_clean_env
+                     else
+                       ENV.to_hash
+                     end
       env_original.merge(env)
     end
 

data/lib/komenda/result.rb

@@ -25,7 +25,7 @@ module Komenda
       @status.exitstatus
     end
 
-    alias_method :status, :exitstatus
+    alias status exitstatus
 
     def success?
       exitstatus == 0

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: komenda
 version: !ruby/object:Gem::Version
-  version: 0.1.6
+  version: 0.1.7
 platform: ruby
 authors:
 - Cargo Media
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2016-04-24 00:00:00.000000000 Z
+date: 2016-10-06 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: events
@@ -87,14 +87,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.35.0
+        version: 0.41.2
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.35.0
+        version: 0.41.2
 description: Convenience wrapper around `Open3` to run shell commands in Ruby.
 email: hello@cargomedia.ch
 executables: []
@@ -127,7 +127,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.6.2
+rubygems_version: 2.5.1
 signing_key: 
 specification_version: 4
 summary: Convenience wrapper around `Open3` to run shell commands in Ruby.