kommando 0.0.19 → 0.0.21

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 9bb1a31b4636721369778e57590b0bcff594d8e8
-  data.tar.gz: 3ce37c43a206f0b87a7ec360102023395e69fa6b
+  metadata.gz: 28bb48c41521e414b25f99f504388d7f487540e7
+  data.tar.gz: c5a621a4d4e123a1e384662d8beac09eafd3c289
 SHA512:
-  metadata.gz: 9e67343a7db57fd787b81efd27eba7632e7da95533a5fe909c4dcef57f6b221012e10f51fd3330aa0f99fdb976bedcbb18b2dc47aeb3845d72c6edfab77ec79e
-  data.tar.gz: c040fe6fd13d9053589d84df59406d619585ad3d65302b73a6346348419cbe53bd4b535530a98a8bfb4a87797e8f71049992dc025a9316a548b5ceb0012d1936
+  metadata.gz: dac7252e7d4af6dc8ceeeff7c53a2b087e193ca2f9a87c2a5b44d9287bf3a65a883495845e87122ce9860e574e72a90722017264c5885af520087457a124ff85
+  data.tar.gz: 36802a54834ad364b2addabf3ea8679c801c82b3f68090c129cd5b9a0b32ddad8d198b35b229143619df6072e91995b1625601a2cee997886195afeab5d39d02

data/CHANGELOG.md

@@ -1,5 +1,12 @@
 # CHANGELOG
 
+## 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"`
+
+## 0.0.20
+- FEAT: Run when callbacks immediately if the event already fired.
+
 ## 0.0.19
 Fixes Linux
 

data/README.md

@@ -2,6 +2,94 @@
 
 Command runner with expect-like features. Great for integration testing.
 
+## Usage
+
+### Automating GNU nano:
+
+```
+require "./lib/kommando"
+require "tempfile"
+
+scratch = Tempfile.new
+
+k = Kommando.new "nano #{scratch.path}", {
+  output: true
+}
+k.out.on "GNU nano" do
+  k.in << "hello\r"
+  k.in << "\x1B\x1Bx"
+
+  k.out.on "Save modified buffer" do
+    sleep 1
+    k.in << "y"
+
+    k.out.on "File Name to Write" do
+      sleep 1
+      k.in << "\r"
+    end
+  end
+end
+
+k.when "start" do
+  puts "Kommando started running nano"
+  sleep 2
+end
+
+k.when "exit" do
+  puts "Kommando finished"
+  sleep 1
+end
+
+k.run
+```
+
+### Shell scripting
+
+```
+require "./lib/kommando"
+
+script = '
+printf "new password: "
+read input1
+printf "password again: "
+read input2
+
+if [ "$input1" == "$input2" ]; then
+  printf "Are you sure that you want to change it? (y/N): "
+  read input3
+  if [ "$input3" == "y" ]; then
+    echo "changed"
+  else
+    echo "not changed"
+  fi
+else
+  echo "Passwords did not match"
+fi
+'
+
+k = Kommando.new "$ #{script}", {
+  output: true
+}
+
+k.out.on "new password:" do
+  k.in.write "lol\r"
+
+  k.out.on "password again:" do
+    k.in.writeln "lol"
+
+    k.out.on /want to change it\?/ do
+      k.in << "y\r"
+    end
+
+    k.out.on /Passwords did not match/ do
+      raise "this should never happen with that script."
+    end
+  end
+end
+
+k.run
+```
+
 ## Installation
 
 Add this line to your application's Gemfile:
@@ -18,9 +106,6 @@ Or install it yourself as:
 
     $ gem install kommando
 
-## Usage
-
-TODO: Write usage instructions here
 
 ## Development
 

data/bin/loop

@@ -0,0 +1,23 @@
+#!/usr/bin/env ruby
+
+require "./lib/kommando"
+
+while true do
+  k = Kommando.new "rake", {
+    timeout: 5
+  }
+
+  k.when :timeout do
+    print "t"
+    puts k.out
+  end
+  k.when :error do
+    print "e"
+  end
+
+  k.run
+
+  if k.code == 0
+    print "."
+  end
+end

data/examples/passwd.rb

@@ -0,0 +1,42 @@
+require "./lib/kommando"
+
+script = '
+printf "new password: "
+read input1
+printf "password again: "
+read input2
+
+if [ "$input1" == "$input2" ]; then
+  printf "Are you sure that you want to change it? (y/N): "
+  read input3
+  if [ "$input3" == "y" ]; then
+    echo "changed"
+  else
+    echo "not changed"
+  fi
+else
+  echo "Passwords did not match"
+fi
+'
+
+k = Kommando.new "$ #{script}", {
+  output: true
+}
+
+k.out.on "new password:" do
+  k.in.write "lol\r"
+
+  k.out.on "password again:" do
+    k.in.writeln "lol"
+
+    k.out.on /want to change it\?/ do
+      k.in << "y\r"
+    end
+
+    k.out.on /Passwords did not match/ do
+      raise "this should never happen with that script."
+    end
+  end
+end
+
+k.run

data/examples/stackprof.rb

@@ -0,0 +1,18 @@
+require "./lib/kommando"
+require 'stackprof'
+
+
+profile = StackProf.run(mode: :wall, out: 'tmp/stackprof-wall.dump', interval: 100) do
+  100.times {
+    Kommando.run "uptime"
+  }
+end
+
+profile = StackProf.run(mode: :cpu, out: 'tmp/stackprof-cpu.dump', interval: 100) do
+  100.times {
+    Kommando.run "uptime"
+  }
+end
+
+Kommando.puts "stackprof tmp/stackprof-wall.dump --text"
+Kommando.puts "stackprof tmp/stackprof-cpu.dump --text"

data/examples/thread_leak.rb

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

data/kommando.gemspec

@@ -25,4 +25,6 @@ Gem::Specification.new do |spec|
   spec.add_development_dependency "rspec-autotest", "~> 1.0"
   spec.add_development_dependency "ZenTest", "~> 4.11"
   spec.add_development_dependency "byebug"
+  spec.add_development_dependency "stackprof"
+  spec.add_development_dependency "trapper"
 end

data/lib/kommando.rb

@@ -88,7 +88,7 @@ class Kommando
     begin
       Process.kill('KILL', @pid)
     rescue Errno::ESRCH => ex
-      raise ex # see if happens
+      #raise ex # see if happens
     end
 
     @kill_happened = true
@@ -145,7 +145,10 @@ class Kommando
     end
 
     begin
+      debug "pty before spawn"
       make_pty_testable.spawn(command, *interpolated_args) do |stdout, stdin, pid|
+        debug "pty in spawn"
+
         @pid = pid
 
         if @output_file
@@ -153,25 +156,36 @@ class Kommando
           stdout_file.sync = true
         end
 
-        thread_stdin = Thread.new do
-          sleep 0.1 # allow program to start, do not write "in terminal"
-          while true do
-            break if @process_completed
-            # c = nil
-            # Timeout.timeout(1) do
-            c = @stdin.getc
-            #end
-
-            unless c
-              sleep 0.01
-              next
+        thread_stdin = nil
+        self.when :start do
+          thread_stdin = Thread.new do
+            while true do
+              break if @process_completed
+              # c = nil
+              # Timeout.timeout(1) do
+              c = @stdin.getc
+              #end
+
+              unless c
+                sleep 0.01
+                next
+              end
+
+              stdin.write c
             end
-
-            stdin.write c
           end
         end
 
-        @when.fire :start unless @start_fired
+
+        debug "thread_stdin started"
+
+        unless @start_fired
+          debug "when :start firing"
+          @when.fire :start
+          debug "when :start fired"
+        else
+          debug "when :start NOT fired, as :start has already been fired"
+        end
 
         if @timeout
           begin
@@ -186,7 +200,9 @@ class Kommando
           process_stdout(pid, stdout, stdout_file)
         end
         @process_completed = true
-
+        debug "thread_stdin joining"
+        thread_stdin.join
+        debug "thread_stdin joined"
         stdout_file.close if @output_file
       end
 
@@ -239,6 +255,7 @@ class Kommando
     @when.fire :timeout if @timeout_happened
     @when.fire :exit
 
+    debug "run returning true"
     true
   end
 
@@ -267,7 +284,13 @@ class Kommando
   end
 
   def wait
-    sleep 0.001 until @code
+    debug "k.wait starting"
+    exited = false
+    self.when :exit do
+      exited = true
+    end
+    sleep 0.0001 until exited
+    debug "k.wait done"
   end
 
   def when(event, &block)
@@ -276,6 +299,11 @@ class Kommando
 
   private
 
+  def debug(msg)
+    return unless ENV["DEBUG"]
+    print "|#{msg}"
+  end
+
   def raise_after_callbacks(exception)
     @when.fire :error
     @when.fire :exit
@@ -289,6 +317,7 @@ class Kommando
   def process_stdout(pid, stdout, stdout_file)
     flushing = false
     while true do
+      debug "process_stdout started"
       begin
         Process.getpgid(pid)
       rescue Errno::ESRCH => ex

data/lib/kommando/buffer.rb

@@ -18,6 +18,14 @@ class Kommando::Buffer
     @buffer << string
   end
 
+  def write(string)
+    self << string
+  end
+
+  def writeln(string)
+    self.write "#{string}\r"
+  end
+
   def getc
     @buffer.shift
   end

data/lib/kommando/version.rb

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

data/lib/kommando/when.rb

@@ -3,6 +3,7 @@ class Kommando::When
 
   def initialize
     @whens = {}
+    @fired = []
   end
 
   def register(event_name, block)
@@ -14,16 +15,32 @@ class Kommando::When
     else
       [block]
     end
+
+    if @fired.include? event_name_as_sym
+      debug "cb firing as #{event_name_as_sym} already fired."
+      block.call
+      debug "cb fired as #{event_name_as_sym} already fired."
+    else
+      debug "cb for #{event_name_as_sym} registered, not fired."
+    end
   end
 
   def fire(event_name)
     event_name_as_sym = event_name.to_sym
     validate_event_name(event_name_as_sym)
 
-    return unless blocks = @whens[event_name]
+    @fired << event_name_as_sym
+    debug "set #{event_name_as_sym} as fired"
 
-    blocks.each do |block|
-      block.call
+    if blocks = @whens[event_name]
+      debug "firing cbs for #{event_name_as_sym}"
+      blocks.each do |block|
+        debug "firing cb for #{event_name_as_sym}"
+        block.call
+        debug "fired cb for #{event_name_as_sym}"
+      end
+    else
+      debug "no cbs for #{event_name_as_sym}"
     end
   end
 
@@ -31,4 +48,9 @@ class Kommando::When
   def validate_event_name(event_name_as_sym)
     raise Kommando::Error, "When '#{event_name_as_sym}' is not known." unless VALID_EVENTS.include? event_name_as_sym
   end
+
+  def debug(msg)
+    return unless ENV["DEBUG"]
+    print "W#{msg}"
+  end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: kommando
 version: !ruby/object:Gem::Version
-  version: 0.0.19
+  version: 0.0.21
 platform: ruby
 authors:
 - Matti Paksula
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2016-07-21 00:00:00.000000000 Z
+date: 2016-10-16 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -94,6 +94,34 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
+- !ruby/object:Gem::Dependency
+  name: stackprof
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: trapper
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
 description: Great for integration testing.
 email:
 - matti.paksula@iki.fi
@@ -113,6 +141,7 @@ files:
 - Rakefile
 - bin/console
 - bin/e2e
+- bin/loop
 - bin/reinstall
 - bin/release
 - bin/setup
@@ -127,9 +156,11 @@ files:
 - examples/live_output.rb
 - examples/nano.rb
 - examples/nano_match.rb
+- examples/passwd.rb
 - examples/ping.rb
 - examples/shell.rb
 - examples/shorthands.rb
+- examples/stackprof.rb
 - examples/stderr_to_out.rb
 - examples/stdout_to_file.rb
 - examples/thread_leak.rb
@@ -145,6 +176,7 @@ files:
 - lib/kommando/when.rb
 - tests/forever_true.rb
 - tests/forever_uptime.rb
+- tmp/.gitkeep
 homepage: http://github.com/matti/kommando
 licenses:
 - MIT