simple_shell 1.0.1 → 1.1.0

data/README.rdoc

@@ -55,9 +55,20 @@ provides you with a sub shell for location shifts
 lets you specify the environment
 
   shell = SimpleShell.new(Dir.pwd, { 'MY_ENV' => 'my env' })
-  shell.echo '${MY_ENV}'
+  shell.do "echo ${MY_ENV}"
   => 'my env'
 
+Provides parameter escaping
+
+  shell = SimpleShell.new(Dir.pwd, { 'MY_ENV' => "You wont see me" })
+  shell.echo '${MY_ENV}'
+  => '${MY_ENV}'
+
+  shell.ls "-la", "/path/to/list"
+  => total 87694
+  => drwxr-xr-x 106 john   doe       45056 Jan 15 08:43 ./
+  => ...
+
 == Contributing to SimpleShell
 
 * Check out the latest master to make sure the feature hasn't been implemented or the bug hasn't been fixed yet.

data/VERSION

@@ -1 +1 @@
-1.0.1
+1.1.0

data/lib/simple_shell.rb

@@ -16,8 +16,20 @@ require 'open3'
 #  end
 #  puts commands.first.out
 #
+# === Handling stdout and stderr
+#
+#   shell = SimpleShell.new
+#   shell.stdout_handler = ->(line) {
+#     do_something(line)
+#   }
+#
+#   shell.do("./long_running.sh")
+#
+# Off course the same goes for ```shell.stderr_handler```
+#
 class SimpleShell
-  attr_reader :commands
+  attr_reader :commands, :base, :env
+  attr_accessor :stdout_handler, :stderr_handler
 
   def self.noisy
     @noisy ||= false
@@ -76,7 +88,7 @@ class SimpleShell
   def system(*args, &block)
     command = nil
     Dir.chdir(@base) do
-      command = Command.new(@base, @env)
+      command = Command.new(self)
       command.execute(*args, &block)
     end
 
@@ -113,9 +125,10 @@ class SimpleShell
   class Command
     attr_reader :out, :err, :S
 
-    def initialize(base, env={})
-      @base = base
-      @env  = env
+    def initialize(shell)
+      @shell = shell
+      @base  = shell.base
+      @env   = shell.env || {}
 
       @out = ""
       @err = ""
@@ -126,16 +139,34 @@ class SimpleShell
       $stderr.puts("#{@env} #{command}, #{args}, #{@base}") if SimpleShell.noisy
 
       Open3.popen3(@env, "#{command}", *(args.collect { |a| "#{a}" }) , :chdir => @base) do |stdin, stdout, stderr, thread|
+
+        threads = []
+        if @shell.stdout_handler
+          threads << Thread.new(@shell.stdout_handler, stdout) do |handler, io|
+            while(line = io.gets)
+              handler.call(line)
+            end
+          end
+        end
+
+        if @shell.stderr_handler
+          threads << Thread.new(@shell.stderr_handler, stderr) do |handler, io|
+            while(line = io.gets)
+              handler.call(line)
+            end
+          end
+        end
+
         if block_given?
           yield stdin
         end
 
         stdin.close
 
-        # TODO : perhaps use blocks to put stuff into stdin
+        threads.collect(&:join)
 
-        @out = stdout.read.chomp
-        @err = stderr.read.chomp
+        @out = @shell.stdout_handler ? nil : stdout.read.chomp
+        @err = @shell.stderr_handler ? nil : stderr.read.chomp
         @S   = thread.value rescue 0
       end
     end

data/simple_shell.gemspec

@@ -5,11 +5,11 @@
 
 Gem::Specification.new do |s|
   s.name = "simple_shell"
-  s.version = "1.0.1"
+  s.version = "1.1.0"
 
   s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
   s.authors = ["Hartog C. de Mik"]
-  s.date = "2012-02-06"
+  s.date = "2013-01-15"
   s.description = "A very simple, smart & elegant shell operations gem"
   s.email = "hartog@organisedminds.com"
   s.extra_rdoc_files = [
@@ -28,12 +28,15 @@ Gem::Specification.new do |s|
     "lib/simple_shell.rb",
     "simple_shell.gemspec",
     "spec/simple_shell_spec.rb",
-    "spec/spec_helper.rb"
+    "spec/spec_helper.rb",
+    "spec/support/echo.sh",
+    "spec/support/echo_stderr.sh",
+    "spec/support/long_running.sh"
   ]
   s.homepage = "http://github.com/coffeeaddict/simple_shell"
   s.licenses = ["MIT"]
   s.require_paths = ["lib"]
-  s.rubygems_version = "1.8.10"
+  s.rubygems_version = "1.8.11"
   s.summary = "A very simple shell operations gem"
 
   if s.respond_to? :specification_version then

data/spec/simple_shell_spec.rb

@@ -1,5 +1,11 @@
 require File.expand_path(File.dirname(__FILE__) + '/spec_helper')
 
+class Float
+  def at_least?(x)
+    self >= x
+  end
+end
+
 describe SimpleShell do
   let (:shell) { SimpleShell.new }
 
@@ -62,6 +68,9 @@ describe SimpleShell do
   it "should be settable to noisy" do
     SimpleShell.noisy = true
     SimpleShell.noisy.should be_true
+
+    SimpleShell.noisy = false
+    SimpleShell.noisy.should be_false
   end
 
   it "should allow for environment setting" do
@@ -71,4 +80,56 @@ describe SimpleShell do
     shell = SimpleShell.new()
     shell.printenv.out.should_not =~ /my environment/
   end
+
+  it "should capture stdout" do
+    res = shell.do("./spec/support/echo.sh")
+    res.out.should == "hello\nworld"
+  end
+
+  it "should capture stderr" do
+    res = shell.do("./spec/support/echo_stderr.sh")
+    res.err.should == "goodbye\nworld"
+  end
+
+
+  describe "Handlers" do
+    it "should pass captured lines on stdout" do
+      buffer  = []
+      shell.stdout_handler = ->(line) {
+        buffer << line
+      }
+
+      res = shell.echo "hello\nworld"
+      res.out.should be_nil
+      res.err.should be_empty
+
+      buffer.count.should == 2
+    end
+
+    it "should pass captured lines on stderr" do
+      buffer  = []
+      shell.stderr_handler = ->(line) {
+        buffer << line
+      }
+
+      res = shell.do "./spec/support/echo_stderr.sh"
+      res.out.should be_empty
+      res.err.should be_nil
+
+      buffer.count.should == 2
+    end
+
+    it "should wait for long running processes" do
+      buffer = []
+      shell.stdout_handler = ->(line) {
+        buffer << line
+      }
+
+      start = Time.now
+      shell.do "./spec/support/long_running.sh"
+
+      (Time.now - start).should be_at_least 2
+      buffer.count.should == 3
+    end
+  end
 end

data/spec/spec_helper.rb

@@ -8,5 +8,5 @@ require 'simple_shell'
 Dir["#{File.dirname(__FILE__)}/support/**/*.rb"].each {|f| require f}
 
 RSpec.configure do |config|
-  
+  config.tty = true
 end

data/spec/support/echo.sh

@@ -0,0 +1,3 @@
+#!/bin/sh
+
+echo "hello\nworld"

data/spec/support/echo_stderr.sh

@@ -0,0 +1,3 @@
+#!/bin/sh
+
+echo "goodbye\nworld" >&2

data/spec/support/long_running.sh

@@ -0,0 +1,7 @@
+#!/bin/sh
+
+echo "i am"
+sleep 1
+echo "a long running"
+sleep 1
+echo "process"

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: simple_shell
 version: !ruby/object:Gem::Version
-  version: 1.0.1
+  version: 1.1.0
   prerelease: 
 platform: ruby
 authors:
@@ -9,11 +9,11 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2012-02-06 00:00:00.000000000Z
+date: 2013-01-15 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rspec
-  requirement: &89359440 !ruby/object:Gem::Requirement
+  requirement: &21277180 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
@@ -21,10 +21,10 @@ dependencies:
         version: 2.8.0
   type: :development
   prerelease: false
-  version_requirements: *89359440
+  version_requirements: *21277180
 - !ruby/object:Gem::Dependency
   name: rdoc
-  requirement: &89359170 !ruby/object:Gem::Requirement
+  requirement: &21308340 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
@@ -32,10 +32,10 @@ dependencies:
         version: '3.12'
   type: :development
   prerelease: false
-  version_requirements: *89359170
+  version_requirements: *21308340
 - !ruby/object:Gem::Dependency
   name: bundler
-  requirement: &89358920 !ruby/object:Gem::Requirement
+  requirement: &21306480 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
@@ -43,10 +43,10 @@ dependencies:
         version: 1.0.0
   type: :development
   prerelease: false
-  version_requirements: *89358920
+  version_requirements: *21306480
 - !ruby/object:Gem::Dependency
   name: jeweler
-  requirement: &89358670 !ruby/object:Gem::Requirement
+  requirement: &21304760 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
@@ -54,10 +54,10 @@ dependencies:
         version: 1.8.3
   type: :development
   prerelease: false
-  version_requirements: *89358670
+  version_requirements: *21304760
 - !ruby/object:Gem::Dependency
   name: rcov
-  requirement: &89358390 !ruby/object:Gem::Requirement
+  requirement: &21302760 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -65,7 +65,7 @@ dependencies:
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: *89358390
+  version_requirements: *21302760
 description: A very simple, smart & elegant shell operations gem
 email: hartog@organisedminds.com
 executables: []
@@ -86,6 +86,9 @@ files:
 - simple_shell.gemspec
 - spec/simple_shell_spec.rb
 - spec/spec_helper.rb
+- spec/support/echo.sh
+- spec/support/echo_stderr.sh
+- spec/support/long_running.sh
 homepage: http://github.com/coffeeaddict/simple_shell
 licenses:
 - MIT
@@ -101,7 +104,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
       version: '0'
       segments:
       - 0
-      hash: 737581693
+      hash: -4461510089210425580
 required_rubygems_version: !ruby/object:Gem::Requirement
   none: false
   requirements:
@@ -110,7 +113,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 1.8.10
+rubygems_version: 1.8.11
 signing_key: 
 specification_version: 3
 summary: A very simple shell operations gem