kommando 0.0.12 → 0.0.13

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 8f31bfc50087990d25272c5bb0bd2d45967dfb70
-  data.tar.gz: 8ee8d780d34cc47e500bcb0479d7d9e80934c65b
+  metadata.gz: a4c723b5a14a2c459faa1541baf8191bd3d5e085
+  data.tar.gz: 933819bd35d6494959f5a3d1fd4d4fc871ba60c4
 SHA512:
-  metadata.gz: a4b6b2dc55fcbfbe5c95e270d7ce48424eaf1e6a46b57c7f002c3cda1fc51e3858e93f9f866fcd6801f134f0247e395551ce9b0b7cfb34dbecc8872bd06eaee7
-  data.tar.gz: 526e8c68a2543d69422d22904ccb3561dcddfbeefa4a64a45f0b9566caf045183a1c80d41e4e84bc98f60ff6fac7c00fe21f72f322831407637b9d2be8edeccf
+  metadata.gz: 8bae101165bffb3ebc49ace448bd297a5139f8d4265911d8283aa7dadd9db08277fade2934a03a618220eacf6398a5266ee0f94764e22b3a872fc4a311376821
+  data.tar.gz: 7e0a9e250d0979fb94ca4c4ef1331a3115056b414f358346a17c5ab9cfb49bf78439796c4f6ca80c3a5ff16b238b4c67a28789f86cec188ab34c45f8d1cab0a9

data/CHANGELOG.md

@@ -1,5 +1,13 @@
 # CHANGELOG
 
+## 0.0.13
+Shorthands for run and run_async, blocking until completed.
+
+ - FEAT: Immediate run with `Kommando.run "uptime", {}`
+ - FEAT: Immediate run_async with `Kommando.run_async "uptime", {}`
+ - FEAT: Block until command completes with `k.wait`
+ - EXAMPLES: `shorthands.rb` and `wait.rb`
+
 ## 0.0.12
 Support for matching out and running code on match.
 

data/examples/async.rb

@@ -1,8 +1,6 @@
 require "./lib/kommando"
 
-k = Kommando.new "sleep 0.5"
-k.run_async
-
+k = Kommando.run_async "sleep 0.5"
 puts "started in background"
 
 while (k.code == nil) do

data/examples/env.rb

@@ -1,12 +1,11 @@
 require "./lib/kommando"
 
-k = Kommando.new "$ echo $KOMMANDO_ENV1 $KOMMANDO_ENV2", {
+k = Kommando.run "$ echo $KOMMANDO_ENV1 $KOMMANDO_ENV2", {
   env: {
     KOMMANDO_ENV1: "hello",
     KOMMANDO_ENV2: "world"
   }
 }
-k.run
 
 raise "err" unless k.out == "hello world"
 puts k.out

data/examples/exit.rb

@@ -1,11 +1,9 @@
 require "./lib/kommando"
 
-failure = Kommando.new "false"
-failure.run
+failure = Kommando.run "false"
 
 puts "Failure error: #{failure.code}"
 
-success = Kommando.new "true"
-success.run
+success = Kommando.run "true"
 
 puts "Success error: #{success.code}"

data/examples/kill.rb

@@ -1,14 +1,10 @@
 require "./lib/kommando"
 
-k = Kommando.new "sleep 10"
-
-Thread.new do
-  puts "killer is waiting.."
-  sleep 1
-  k.kill
-  puts "..killed."
-end
-k.run
+k = Kommando.run_async "sleep 10"
+
+sleep 1
+k.kill
+puts "..killed."
 
 raise "not 137" unless k.code == 137
 

data/examples/live_output.rb

@@ -1,7 +1,5 @@
 require "./lib/kommando"
 
-k = Kommando.new "ping -c 3 127.0.0.1", {
+Kommando.run "ping -c 3 127.0.0.1", {
   output: true
 }
-
-k.run

data/examples/nano_match.rb

@@ -3,7 +3,7 @@ require "tempfile"
 
 scratch = Tempfile.new
 
-k = Kommando.new "nano scratch.path", {
+k = Kommando.new "nano #{scratch.path}", {
   output: true
 }
 k.out.on "GNU nano" do

data/examples/ping.rb

@@ -1,6 +1,4 @@
 require "./lib/kommando"
 
-k = Kommando.new "ping -c 3 google.com"
-k.run
-
+k = Kommando.run "ping -c 3 google.com"
 puts k.out

data/examples/shell.rb

@@ -1,7 +1,6 @@
 require "./lib/kommando"
 
-k = Kommando.new "$ echo 'hello\nworld' | rev | rev"
-k.run
+k = Kommando.run "$ echo 'hello\nworld' | rev | rev"
 
 raise "err" unless k.out == "hello\r\nworld"
 puts "shell says: #{k.out}"

data/examples/shorthands.rb

@@ -0,0 +1,13 @@
+require "./lib/kommando"
+
+k = Kommando.run "$ echo hello"
+raise "err" unless k.out == "hello"
+
+puts k.out
+
+k = Kommando.run_async "$ echo hello"
+k.wait
+
+raise "err" unless k.out == "hello"
+
+puts k.out

data/examples/stderr_to_out.rb

@@ -1,7 +1,6 @@
 require "./lib/kommando"
 
-k = Kommando.new "$ (>&2 echo 'err'); echo 'out'"
-k.run
+k = Kommando.run "$ (>&2 echo 'err'); echo 'out'"
 
 raise "err" unless k.out == "err\r\nout"
 puts k.out

data/examples/timeout.rb

@@ -1,10 +1,10 @@
 require "./lib/kommando"
 
 k = Kommando.new "sleep 2", {
-  timeout: 1
+  timeout: 0.5
 }
 k2 = Kommando.new "sleep 2", {
-  timeout: 1
+  timeout: 0.5
 }
 
 k.run

data/examples/uptime.rb

@@ -1,6 +1,5 @@
 require "./lib/kommando"
 
-k = Kommando.new "uptime"
-k.run
+k = Kommando.run "uptime"
 
 puts k.out

data/examples/wait.rb

@@ -0,0 +1,6 @@
+require "./lib/kommando"
+
+k = Kommando.run_async "sleep 0.5"
+raise "err" if k.code
+k.wait
+raise "err" unless k.code == 0

data/lib/kommando.rb

@@ -6,6 +6,19 @@ require_relative "kommando/version"
 require_relative "kommando/buffer"
 
 class Kommando
+  class << self
+    def run(cmd, opts={})
+      k = Kommando.new cmd, opts
+      k.run
+      k
+    end
+
+    def run_async(cmd, opts={})
+      k = Kommando.new cmd, opts
+      k.run_async
+      k
+    end
+  end
 
   def initialize(cmd, opts={})
     @cmd = cmd
@@ -227,4 +240,8 @@ class Kommando
   def in
     @stdin
   end
+
+  def wait
+    sleep 0.001 until @code
+  end
 end

data/lib/kommando/version.rb

@@ -1,3 +1,3 @@
 class Kommando
-  VERSION = "0.0.12"
+  VERSION = "0.0.13"
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: kommando
 version: !ruby/object:Gem::Version
-  version: 0.0.12
+  version: 0.0.13
 platform: ruby
 authors:
 - Matti Paksula
@@ -129,10 +129,12 @@ files:
 - examples/nano_match.rb
 - examples/ping.rb
 - examples/shell.rb
+- examples/shorthands.rb
 - examples/stderr_to_out.rb
 - examples/stdout_to_file.rb
 - examples/timeout.rb
 - examples/uptime.rb
+- examples/wait.rb
 - kommando.gemspec
 - lib/kommando.rb
 - lib/kommando/buffer.rb