shellshot 0.4.0 → 0.4.1

data/README.rdoc

@@ -5,13 +5,13 @@ http://dekaft.underlog.org
 
 == DESCRIPTION:
 
-A small library dealing with the obscurities of shell commands, piping and timeouts. 
+A small library dealing with the obscurities of shell commands, piping and timeouts.
 Most of the stuff comes from bad experience in http://beanstalkapp.com.
 
 == FEATURES/PROBLEMS:
 
 The whole thing would probably not work in Windows. Not my first time I guess.
-
+The capture of the output hangs if large amount of text is passed (tests captured it at ~10k chars). If you need larger amounts of text, write them in a temp file somewhere.
 == SYNOPSIS:
 
     # Basic usage
@@ -22,15 +22,20 @@ The whole thing would probably not work in Windows. Not my first time I guess.
     Shellshot.exec "ruby -e %q[ruby -e "puts 'Hello World'"], :stdout => '/tmp/out', :stderr => '/tmp/err'
     Shellshot.exec "ruby -e %q[ruby -e "puts 'Hello World'"], :stdall => '/tmp/all'
 
-    # Timeout 
-    begin 
+    # Silence standard outputs. false works for stdout, stderr, and stdall
+    Shellshot.exec "ruby -e %q[ruby -e "puts 'Hello World'"], :stdout => false
+
+    # Timeout
+    begin
       Shellshot.exec "ruby -e 'sleep 10000'", :timeout => 2 # seconds
     rescue Timeout::Error => e
-      # ... 
+      # ...
     end
 
 
 == HISTORY:
+- 0.4.0 Capture stds with pipes
+- 0.3.0 Raise error on abnormal exits
 - 0.2.0 Switched to SystemTimer (*not* system_timer) for timeouts. The original was not working after all. Fixed one comment stating the wrong unit.
 - 0.1.0 Initial release.
 

data/Rakefile

@@ -7,7 +7,7 @@ begin
     gem.name = "shellshot"
     gem.summary = %Q{ruby proxy handling the complexities of system invocations}
     gem.description = %Q{
-      A small library dealing with the obscurities of shell commands, piping and timeouts. 
+      A small library dealing with the obscurities of shell commands, piping and timeouts.
       Most of the stuff comes from bad experience in http://beanstalkapp.com.
     }
     gem.email = "underlog@gmail.com"
@@ -52,3 +52,12 @@ Rake::RDocTask.new do |rdoc|
   rdoc.rdoc_files.include('README*')
   rdoc.rdoc_files.include('lib/**/*.rb')
 end
+
+require 'ruby-prof/task'
+desc "run the profile tests"
+Rake::TestTask.new(:profile) do |t|
+  t.libs << "profile"
+  t.pattern = 'profile/*_profile.rb'
+  t.verbose = true
+  t.warning = false
+end

data/VERSION

@@ -1 +1 @@
-0.4.0
+0.4.1

data/lib/shellshot.rb

@@ -36,7 +36,7 @@ module Shellshot
     end
 
     def stderr_contents
-      unless stderr_defined?
+      @stderr_contents ||= unless stderr_defined?
         @stderr_wr.close
         contents = @stderr_rd.read
         @stderr_rd.close
@@ -47,7 +47,7 @@ module Shellshot
     end
 
     def stdout_contents
-      unless stdout_defined?
+      @stdout_contents ||= unless stdout_defined?
         @stdout_wr.close
         contents = @stdout_rd.read
         @stdout_rd.close
@@ -82,11 +82,11 @@ module Shellshot
     end
 
     def stderr_location
-      stdall_location || options[:stderr]
+      stdall_location || (options[:stderr] == false ? null_location : options[:stderr])
     end
 
     def stdout_location
-      stdall_location || options[:stdout]
+      stdall_location || (options[:stdout] == false ? null_location : options[:stdout])
     end
 
     def stderr_descriptor
@@ -104,15 +104,15 @@ module Shellshot
     end
 
     def stderr_defined?
-      !!stderr_location
+      !stderr_location.nil?
     end
 
     def stdout_defined?
-      !!stdout_location
+      !stdout_location.nil?
     end
 
     def stdall_location
-      options[:stdall]
+      options[:stdall] == false ? null_location : options[:stdall]
     end
 
     def close_reading_pipes
@@ -125,6 +125,10 @@ module Shellshot
       @stdout_rd, @stdout_wr = IO.pipe unless stdout_defined?
     end
 
+    def null_location
+      "/dev/null"
+    end
+
   end
 
   def self.exec(command, options = {})

data/profile/profile_helper.rb

@@ -0,0 +1,8 @@
+require File.expand_path(
+    File.join(File.dirname(__FILE__), %w[.. lib shellshot]))
+
+require 'rubygems'
+require 'test/unit'
+require 'ruby-prof'
+require 'ruby-debug'
+

data/profile/shellshot_profile.rb

@@ -0,0 +1,41 @@
+require File.expand_path(File.dirname(__FILE__) + '/profile_helper')
+
+class ShellshotProfile < Test::Unit::TestCase
+
+  def setup
+    RubyProf.measure_mode = RubyProf::WALL_TIME
+  end
+
+  def benchmark(title, &block)
+    puts "#{title} \n"
+    time = Benchmark.measure &block
+    puts "Time spent: #{time.to_s.squeeze.strip} \n"
+  end
+
+  def cmd
+    %q[ruby -e '10000.times { puts "a" }']
+  end
+
+  def test_builtin_exec
+    profile "system" do
+      system("#{cmd} > /dev/null")
+    end
+  end
+
+  def test_executing_large_stdout
+    profile "Shellshot" do
+      Shellshot.exec cmd #, :stdout => '/dev/null'
+    end
+  end
+
+  def profile(name, &block)
+    time = Benchmark.measure do
+      result = RubyProf.profile &block
+      printer = RubyProf::FlatPrinter.new(result)
+      puts "\n#== #{name} ==\n"
+      printer.print(STDOUT, :min_percent => 10)
+    end
+    puts "Time spent: #{time.to_s.squeeze.strip} \n"
+  end
+
+end

data/shellshot.gemspec

@@ -5,13 +5,13 @@
 
 Gem::Specification.new do |s|
   s.name = %q{shellshot}
-  s.version = "0.4.0"
+  s.version = "0.4.1"
 
   s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
   s.authors = ["Petyo Ivanov"]
-  s.date = %q{2009-12-16}
+  s.date = %q{2010-01-06}
   s.description = %q{
-      A small library dealing with the obscurities of shell commands, piping and timeouts. 
+      A small library dealing with the obscurities of shell commands, piping and timeouts.
       Most of the stuff comes from bad experience in http://beanstalkapp.com.
     }
   s.email = %q{underlog@gmail.com}
@@ -27,6 +27,8 @@ Gem::Specification.new do |s|
      "Rakefile",
      "VERSION",
      "lib/shellshot.rb",
+     "profile/profile_helper.rb",
+     "profile/shellshot_profile.rb",
      "shellshot.gemspec",
      "spec/shellshot_spec.rb",
      "spec/spec_helper.rb"

data/spec/shellshot_spec.rb

@@ -43,6 +43,20 @@ describe Shellshot do
     cmd.stderr_contents.should == "test"
   end
 
+  it "should discard stdout and stderr if false passed" do
+    cmd = Shellshot::Command.new
+    cmd.exec %q[ruby -e '$stderr << "test"; $stdout << "test"'], :stdout => false, :stderr => false
+    cmd.stderr_contents.should == ""
+    cmd.stdout_contents.should == ""
+  end
+
+  it "should discard stdout and stderr if stdall = false" do
+    cmd = Shellshot::Command.new
+    cmd.exec %q[ruby -e '$stderr << "test"; $stdout << "test"'], :stdall => false
+    cmd.stderr_contents.should == ""
+    cmd.stdout_contents.should == ""
+  end
+
 end
 
 # EOF

data/spec/spec_helper.rb

@@ -1,4 +1,3 @@
-
 require File.expand_path(
     File.join(File.dirname(__FILE__), %w[.. lib shellshot]))
 
@@ -6,7 +5,7 @@ require 'tmpdir'
 require 'rubygems'
 require 'ruby-debug'
 
-Spec::Matchers.define :be_a_file do 
+Spec::Matchers.define :be_a_file do
   match do |path|
     File.exists?(path)
   end
@@ -28,7 +27,7 @@ end
 
 Spec::Runner.configure do |config|
   config.before(:each) do
-    @tmpdir = Dir.mktmpdir 
+    @tmpdir = Dir.mktmpdir
     Dir.chdir(@tmpdir)
   end
 

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification 
 name: shellshot
 version: !ruby/object:Gem::Version 
-  version: 0.4.0
+  version: 0.4.1
 platform: ruby
 authors: 
 - Petyo Ivanov
@@ -9,7 +9,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2009-12-16 00:00:00 +02:00
+date: 2010-01-06 00:00:00 +02:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency 
@@ -32,7 +32,7 @@ dependencies:
       - !ruby/object:Gem::Version 
         version: "0"
     version: 
-description: "\n      A small library dealing with the obscurities of shell commands, piping and timeouts. \n      Most of the stuff comes from bad experience in http://beanstalkapp.com.\n    "
+description: "\n      A small library dealing with the obscurities of shell commands, piping and timeouts.\n      Most of the stuff comes from bad experience in http://beanstalkapp.com.\n    "
 email: underlog@gmail.com
 executables: []
 
@@ -49,6 +49,8 @@ files:
 - Rakefile
 - VERSION
 - lib/shellshot.rb
+- profile/profile_helper.rb
+- profile/shellshot_profile.rb
 - shellshot.gemspec
 - spec/shellshot_spec.rb
 - spec/spec_helper.rb