blue-shell 0.2.2 → 0.3.0

data/lib/blue-shell.rb

@@ -1,3 +1,19 @@
+module BlueShell
+  class << self
+    attr_accessor :timeout
+
+    def with_timeout(timeout)
+      old_timeout = self.timeout
+      self.timeout = timeout
+      yield
+    ensure
+      self.timeout = old_timeout
+    end
+  end
+
+  self.timeout = 30
+end
+
 require 'blue-shell/errors'
 require 'blue-shell/matchers'
 require 'blue-shell/matchers/exit_code_matcher'

data/lib/blue-shell/buffered_reader_expector.rb

@@ -9,7 +9,7 @@ module BlueShell
       @output = ""
     end
 
-    def expect(pattern, timeout = 5)
+    def expect(pattern)
       case pattern
         when String
           pattern = Regexp.new(Regexp.quote(pattern))
@@ -18,7 +18,7 @@ module BlueShell
           raise TypeError, "unsupported pattern class: #{pattern.class}"
       end
 
-      result, buffer = read_pipe(timeout, pattern)
+      result, buffer = read_pipe(BlueShell.timeout, pattern)
 
       @output << buffer
 

data/lib/blue-shell/matchers.rb

@@ -1,7 +1,7 @@
 module BlueShell
   module Matchers
-    def say(expected_output, timeout = 30)
-      OutputMatcher.new(expected_output, timeout)
+    def say(expected_output)
+      OutputMatcher.new(expected_output)
     end
 
     alias :have_output :say

data/lib/blue-shell/matchers/exit_code_matcher.rb

@@ -9,7 +9,7 @@ module BlueShell
         raise Errors::InvalidInputError unless runner.respond_to?(:exit_code)
 
         begin
-          Timeout.timeout(5) do
+          Timeout.timeout(BlueShell.timeout) do
             @actual_code = runner.exit_code
           end
 

data/lib/blue-shell/matchers/output_matcher.rb

@@ -1,16 +1,13 @@
 module BlueShell
   module Matchers
     class OutputMatcher
-      attr_reader :timeout
-
-      def initialize(expected_output, timeout = 30)
+      def initialize(expected_output)
         @expected_output = expected_output
-        @timeout = timeout
       end
 
       def matches?(runner)
         raise Errors::InvalidInputError unless runner.respond_to?(:expect)
-        @matched = runner.expect(@expected_output, @timeout)
+        @matched = runner.expect(@expected_output)
         @full_output = runner.output
         !!@matched
       end

data/lib/blue-shell/runner.rb

@@ -3,6 +3,10 @@ require 'timeout'
 
 module BlueShell
   class Runner
+    class << self
+      alias_method :run, :new
+    end
+
     def initialize(*args)
       @stdout, slave = PTY.open
       system('stty raw', :in => slave)
@@ -15,20 +19,20 @@ module BlueShell
       if block_given?
         yield self
       else
-        wait_for_exit()
+        wait_for_exit
       end
     end
 
-    class << self
-      alias_method :run, :new
+    def with_timeout(timeout, &block)
+      BlueShell.with_timeout(timeout, &block)
     end
 
-    def expect(matcher, timeout = 30)
+    def expect(matcher)
       case matcher
       when Hash
-        expect_branches(matcher, timeout)
+        expect_branches(matcher)
       else
-        @expector.expect(matcher, timeout)
+        @expector.expect(matcher)
       end
     end
 
@@ -52,12 +56,12 @@ module BlueShell
       @stdin.puts
     end
 
-    def exit_code(timeout = 5)
+    def exit_code
       return @code if @code
 
       code = nil
       begin
-        Timeout.timeout(timeout) do
+        Timeout.timeout(BlueShell.timeout) do
           _, code = Process.waitpid2(@pid)
         end
       rescue Timeout::Error
@@ -97,9 +101,9 @@ module BlueShell
 
     private
 
-    def expect_branches(branches, timeout)
+    def expect_branches(branches)
       branch_names = /#{branches.keys.collect { |k| Regexp.quote(k) }.join('|')}/
-      expected = @expector.expect(branch_names, timeout)
+      expected = @expector.expect(branch_names)
       return unless expected
 
       data = expected.first.match(/(#{branch_names})$/)

data/lib/blue-shell/version.rb

@@ -1,3 +1,3 @@
 module BlueShell
-  VERSION = "0.2.2".freeze
+  VERSION = "0.3.0".freeze
 end

data/spec/matchers/output_matcher_spec.rb

@@ -4,9 +4,10 @@ module BlueShell
   module Matchers
     describe OutputMatcher, :ruby19 => true do
       let(:expected_output) { "expected_output" }
-      let(:timeout) { 1 }
 
-      subject { OutputMatcher.new(expected_output, timeout) }
+      subject { OutputMatcher.new(expected_output) }
+
+      before { BlueShell.stub(:timeout).and_return(1) }
 
       describe "#matches?" do
         context "with something that isn't a runner" do

data/spec/matchers_spec.rb

@@ -12,14 +12,6 @@ module BlueShell
       it "has synonyms" do
         have_output("").should be_a(Matchers::OutputMatcher)
       end
-
-      context "with an explicit timeout" do
-        it "returns an ExpectOutputMatcher" do
-          matcher = say("", 30)
-          matcher.should be_a(Matchers::OutputMatcher)
-          matcher.timeout.should == 30
-        end
-      end
     end
 
     describe "#have_exited_with" do

data/spec/runner_spec.rb

@@ -3,9 +3,17 @@ require 'tempfile'
 
 module BlueShell
   describe Runner do
-    let(:timeout) { 1 }
+    around do |example|
+      begin
+        old_timeout = BlueShell.timeout
+        BlueShell.timeout = 1
+        example.call
+      ensure
+        BlueShell.timeout = old_timeout
+      end
+    end
 
-    describe "running a command" do
+    describe ".run" do
       let(:file) do
         file = Tempfile.new('blue-shell-runner')
         sleep 1 # wait one second to make sure touching the file does something measurable
@@ -18,6 +26,22 @@ module BlueShell
         BlueShell::Runner.run("touch -a #{file.path}")
         file.stat.atime.should > file.stat.mtime
       end
+
+      context "wrapped by BlueShell.with_timeout" do
+        it "uses the given timeout" do
+          expect {
+            BlueShell.with_timeout(3) do
+              BlueShell::Runner.run("sleep 2")
+            end
+          }.to_not raise_error
+
+          expect {
+            BlueShell.with_timeout(1) do
+              BlueShell::Runner.run("sleep 2")
+            end
+          }.to raise_error(Timeout::Error)
+        end
+      end
     end
 
     describe "#success? and #successful?" do
@@ -56,7 +80,7 @@ module BlueShell
       context "when the expected output never shows up" do
         it "returns nil" do
           BlueShell::Runner.run("echo the spanish inquisition") do |runner|
-            expect(runner.expect("something else", 0.5)).to be_nil
+            expect(runner.expect("something else")).to be_nil
           end
         end
       end
@@ -132,7 +156,7 @@ module BlueShell
         context "and none of them match" do
           it "returns nil when none of the branches match" do
             BlueShell::Runner.run("echo not_a_number") do |runner|
-              expect(runner.expect({"1" => proc { 1 }}, timeout)).to be_nil
+              expect(runner.expect({"1" => proc { 1 }})).to be_nil
             end
           end
         end
@@ -219,8 +243,10 @@ module BlueShell
       end
 
       context "when the command doesn't finish within the timeout" do
+        before { BlueShell.stub(:timeout).and_return(3) }
+
         it "raises a timeout error" do
-          BlueShell::Runner.run("sleep 10") do |runner|
+          BlueShell::Runner.run("sleep 4") do |runner|
             expect { runner.exit_code }.to raise_error(Timeout::Error)
           end
         end
@@ -231,12 +257,6 @@ module BlueShell
           end
         end
       end
-
-      it "uses the given timeout" do
-        BlueShell::Runner.run("sleep 2") do |runner|
-          expect { runner.exit_code(1) }.to raise_error(Timeout::Error)
-        end
-      end
     end
 
     context "#exited?" do
@@ -246,5 +266,25 @@ module BlueShell
         end
       end
     end
+
+    describe "#with_timeout" do
+      it "uses the given timeout" do
+        BlueShell::Runner.run("sleep 2") do |runner|
+          expect {
+            runner.with_timeout(3) do
+              runner.exit_code
+            end
+          }.to_not raise_error
+        end
+
+        BlueShell::Runner.run("sleep 2") do |runner|
+          expect {
+            runner.with_timeout(1) do
+              runner.exit_code
+            end
+          }.to raise_error(Timeout::Error)
+        end
+      end
+    end
   end
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: blue-shell
 version: !ruby/object:Gem::Version
-  version: 0.2.2
+  version: 0.3.0
   prerelease: 
 platform: ruby
 authors:
@@ -10,7 +10,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-08-13 00:00:00.000000000 Z
+date: 2013-12-17 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rspec
@@ -93,7 +93,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 1.8.25
+rubygems_version: 1.8.23
 signing_key: 
 specification_version: 3
 summary: Friendly command-line test runner and matchers for shell scripting in ruby