kommando 0.0.21 → 0.0.22

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 28bb48c41521e414b25f99f504388d7f487540e7
-  data.tar.gz: c5a621a4d4e123a1e384662d8beac09eafd3c289
+  metadata.gz: 5d04e223cee14a391a08470955f57eaa63009148
+  data.tar.gz: 58629080acfb3bc56c0f071283a652ea90ebacd5
 SHA512:
-  metadata.gz: dac7252e7d4af6dc8ceeeff7c53a2b087e193ca2f9a87c2a5b44d9287bf3a65a883495845e87122ce9860e574e72a90722017264c5885af520087457a124ff85
-  data.tar.gz: 36802a54834ad364b2addabf3ea8679c801c82b3f68090c129cd5b9a0b32ddad8d198b35b229143619df6072e91995b1625601a2cee997886195afeab5d39d02
+  metadata.gz: bebe0fa396b5e2be603e7454550e11a1098135df56c0e9529bd7bc6a0a2213789146147d36043eff7877a0ff8080fb4d0ec2c2b7dacff2202862d57b45f4d348
+  data.tar.gz: 5b6f6f11dae84848a166d9b9ee76150659d1d29feda6f91263b4e3c394e9e92d174a395c94f3ccd8cb3ef66479b8dde9c4a41c5797904b98ee58be66781443f5

data/.ruby-version

@@ -1 +1 @@
-2.3.0
+2.3.3

data/CHANGELOG.md

@@ -1,5 +1,13 @@
 # CHANGELOG
 
+## 0.0.22
+- FEAT: Global whens with `Kommando.when :timeout block` and clearing with `Kommando.when = nil`
+- FEAT: Context available with `k.when :timeout do |kontextual_k|` and `Kommando.when :timeout |kontextual_k|`
+- FEAT: Global timeout with `Kommando.timeout = 1` and `puts Kommando.timeout`
+- FEAT: Callback `k.when :success` if command was run and exited with zero status
+- FEAT: Callback `k.when :failed` if command did not run or exited with non-zero status
+- FIX: `Kommando.puts` shorthand did not return an instance
+
 ## 0.0.21
 - FEAT: `k.in.write` as an alias for `k.in <<`
 - FEAT: `k.in.writeln` as an shorthand for `k.in.write "lol\r"`

data/examples/shorthands.rb

@@ -11,3 +11,47 @@ k.wait
 raise "err" unless k.out == "hello"
 
 Kommando.puts "$ echo ok"
+
+k = Kommando.puts "$ sleep 10", {
+  timeout: 0.00001
+}
+
+k.when :timeout do
+  puts "did timeout as expected."
+end
+
+Kommando.timeout = 0.0001
+k = Kommando.new "$ sleep 10"
+k.when :timeout do
+  puts "did timeout as expected with global timeout #{Kommando.timeout}"
+end
+k.run
+
+
+Kommando.timeout = 0.0002
+Kommando.when :timeout do
+  puts "Global when timeout 1"
+end
+Kommando.when :timeout do
+  puts "Global when timeout 2"
+end
+
+Kommando.run "$ sleep 10"
+
+Kommando.timeout = nil
+Kommando.when = nil
+
+Kommando.when :success do
+  puts "succes callback"
+end
+
+Kommando.when :failed do
+  puts "failed callback"
+end
+
+Kommando.when :exit do
+  puts "exit callback"
+end
+
+Kommando.run "$ exit 0"
+Kommando.run "$ exit 1"

data/examples/thread_leak.rb

@@ -1,22 +1,29 @@
 require "./lib/kommando"
 
-last_k = nil
+Kommando.timeout = 0.1
+Kommando.when :timeout do |k|
+  print "t"
+  puts k.inspect
+  exit 1
+end
+
 100.times do
-  last_k = Kommando.run "uptime", {
-    timeout: 0.1
-  }
-  last_k.when :timeout do
-    print "t"
-    puts last_k.out
-  end
+  Kommando.run "uptime"
   print "."
 end
 
-puts ""
+3.times do
+  unless Thread.list.count == 1
+    print "w(#{Thread.list.count})"
+    sleep 0.01
+  else
+    break
+  end
+end
+
 unless Thread.list.count == 1
   puts Thread.list.map(&:inspect).join("\n")
-  puts last_k.out
-  raise "Thread leak"
-
+  raise "Thread leak: #{Thread.list.count}"
 end
+
 puts "ok"

data/examples/when.rb

@@ -92,3 +92,28 @@ end
 delta = (Time.now-started).round(1)
 raise "sleep does not work (delta is: #{delta})" unless delta == 0.5
 puts "end"
+
+
+k = Kommando.new "$ sleep 2", {
+  timeout: 0.01
+}
+k.when :timeout do |kk|
+  puts kk.inspect
+end
+
+k.run
+
+puts "-- Global --"
+
+Kommando.timeout = 0.01
+Kommando.when :timeout do |ks|
+  puts ks.inspect
+end
+Kommando.run "$ sleep 2"
+
+puts "--"
+Kommando.when :success do |ks|
+  puts "out: #{ks.out}"
+end
+
+Kommando.run "uptime"

data/lib/kommando.rb

@@ -8,6 +8,9 @@ require_relative "kommando/when"
 
 class Kommando
   class << self
+    @@timeout = nil
+    @@whens = nil
+
     def run(cmd, opts={})
       k = Kommando.new cmd, opts
       k.run
@@ -24,6 +27,25 @@ class Kommando
       k = Kommando.new cmd, opts
       k.run
       Kernel.puts k.out
+      k
+    end
+
+    def timeout
+      @@timeout
+    end
+
+    def timeout=(value)
+      @@timeout=value
+    end
+
+
+    def when(event_name, &block)
+      @@whens ||= Kommando::When.new
+      @@whens.register event_name, block
+    end
+
+    def when=(w)
+      @@whens = w
     end
   end
 
@@ -43,7 +65,10 @@ class Kommando
       opts[:timeout]
     elsif opts[:timeout].class == Fixnum
       opts[:timeout].to_f
+    else
+      @timeout = @@timeout
     end
+
     @timeout_happened = false
     @kill_happened = false
     @rescue_happened = false
@@ -75,7 +100,15 @@ class Kommando
     @matcher_buffer = ""
 
     @whens = {}
-    @when = When.new
+    @when = When.new(self)
+
+    if @@whens
+      @@whens.instance_variable_get("@whens").each_pair do |event_name, blocks|
+        blocks.each do |block|
+          @when.register event_name, block
+        end
+      end
+    end
   end
 
   def run_async
@@ -254,6 +287,11 @@ class Kommando
 
     @when.fire :timeout if @timeout_happened
     @when.fire :exit
+    if @code == 0
+      @when.fire :success
+    else
+      @when.fire :failed
+    end
 
     debug "run returning true"
     true
@@ -307,6 +345,7 @@ class Kommando
   def raise_after_callbacks(exception)
     @when.fire :error
     @when.fire :exit
+    @when.fire :failed
     raise exception
   end
 

data/lib/kommando/version.rb

@@ -1,3 +1,3 @@
 class Kommando
-  VERSION = "0.0.21"
+  VERSION = "0.0.22"
 end

data/lib/kommando/when.rb

@@ -1,7 +1,8 @@
 class Kommando::When
-  VALID_EVENTS = :start, :retry, :timeout, :error, :exit
+  VALID_EVENTS = :start, :retry, :timeout, :error, :exit, :success, :failed
 
-  def initialize
+  def initialize(parent=nil)
+    @parent = parent
     @whens = {}
     @fired = []
   end
@@ -36,7 +37,11 @@ class Kommando::When
       debug "firing cbs for #{event_name_as_sym}"
       blocks.each do |block|
         debug "firing cb for #{event_name_as_sym}"
-        block.call
+        if @parent
+          block.call(@parent)
+        else
+          block.call
+        end
         debug "fired cb for #{event_name_as_sym}"
       end
     else

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: kommando
 version: !ruby/object:Gem::Version
-  version: 0.0.21
+  version: 0.0.22
 platform: ruby
 authors:
 - Matti Paksula
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2016-10-16 00:00:00.000000000 Z
+date: 2016-12-07 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -197,7 +197,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.5.1
+rubygems_version: 2.5.2
 signing_key: 
 specification_version: 4
 summary: Command runner with expect-like features