lackie 0.1.4 → 0.1.5

data/features/remote_control.feature

@@ -3,13 +3,14 @@ Feature: Remote Control
   As a client
   I want to surrender applications as javascript lackies
   
-  Scenario Outline: Remote Execution
+  Background:
     Given I have surrendered my web page as a lackie
+  
+  Scenario Outline: Remote Execution
     When  I tell the lackie to execute "<command>"
     Then  I should see a result with the value "<result>"
       
       Examples:
-      
       | command        | result             |
       | 1 + 1          | 2                  |
       | 2 + 2          | 4                  |
@@ -17,18 +18,25 @@ Feature: Remote Control
       | document.title | Lackie Example App |
     
   Scenario: Remote Execution Error
-    Given I have surrendered my web page as a lackie
     When  I tell the lackie to execute "(function() { throw 'whoopsie'; })()"
     Then  I should see an error with the message "whoopsie"
 
   Scenario: Remote Log
-    Given I have surrendered my web page as a lackie
     When  I tell the lackie to log "yipee"
     Then  I should see a result with the value "yipee"
     
   Scenario: Send Command Without Expecting A Result
-    Given I have surrendered my web page as a lackie
     When  I tell the lackie to send the command "window.foo = '123'"
     Then  I should see a result with the value "OK"
     When  I tell the lackie to execute "window.foo = 99"
-    Then  I should see a result with the value "99"
+    Then  I should see a result with the value "99"
+
+  Scenario: Await Result
+    When  I tell the lackie to execute "setTimeout(function() { window.foo = 666 }, 500)"
+    And   I await the result of "window.foo" to equal "666"
+    Then  I should not see an error
+    
+  Scenario: Await Result Timeout
+    When  I tell the lackie to execute "window.bar = 123"
+    When  I await the result of "window.bar" to equal "456"
+    Then  I should see an error with a message including "123" 

data/features/step_definitions/lackie_steps.rb

@@ -18,10 +18,29 @@ When /^I tell the lackie to send the command "([^"]*)"$/ do |script|
   @response = remote_control.send_command(script)
 end
 
+When /^I await the result of "([^"]*)" to equal "([^"]*)"$/ do |script, value|
+  begin
+    @response = remote_control.await(script, :timeout_seconds => 1) do |current_value|
+      current_value.to_s == value
+    end
+  rescue Lackie::AwaitError => e
+    @error = e
+  end
+end
+
 Then /^I should see a result with the value "([^\"]*)"$/ do |value|
   @response.to_s.should == value
 end
 
 Then /^I should see an error with the message "([^\"]*)"$/ do |message|
   @error.message.should == message
-end
+end
+
+Then /^I should not see an error$/ do
+  raise @error unless @error.nil?
+end
+
+Then /^I should see an error with a message including "([^"]*)"$/ do |string|
+  @error.should_not be_nil
+  @error.message.should =~ Regexp.new(string)
+end

data/lib/lackie.rb

@@ -2,7 +2,7 @@ lib = File.dirname(__FILE__)
 $:.unshift(lib) unless $:.include?(lib) || $:.include?(File.expand_path(lib))
 
 module Lackie
-  VERSION = '0.1.4'
+  VERSION = '0.1.5'
 end
 
 require 'lackie/remote_control'

data/lib/lackie/remote_control.rb

@@ -26,6 +26,22 @@ module Lackie
       end
     end
     
+    def await(expression, options={})
+      result = nil
+      begin
+        @poller.await("result matching expression: #{expression}", options) do
+          begin
+            result = exec(expression)
+          rescue TimeoutError => e
+          end
+          yield result
+        end
+      rescue TimeoutError => e
+        raise AwaitError.new(expression, result)
+      end
+      result
+    end
+    
     private
     
     def poll_for_result(command, options={})
@@ -56,8 +72,7 @@ module Lackie
   
   class ConnectionError < RuntimeError
     def initialize(url, inner)
-      @url = url
-      @inner = inner
+      @url, @inner = url, inner
     end
     
     def message
@@ -68,4 +83,16 @@ module Lackie
   
   class RemoteExecutionError < RuntimeError
   end
+  
+  class AwaitError < RuntimeError
+    def initialize(expression, result)
+      @expression, @result = expression, result
+    end
+    
+    def message
+      "Timed out awaiting the result of expression:\n" +
+      "#{@expression}\n" +
+      "The last result was:\n#{@result}"
+    end
+  end
 end

data/spec/lackie/remote_control_spec.rb

@@ -64,7 +64,7 @@ module Lackie
       lambda { @rc.log("oops") }.should raise_error("oops")
     end
     
-    it "reports a useful error when sending a command fails" do
+    it "raises when sending a command fails" do
       RestClient.should_receive(:post).with("http://host:555/lackie/eval", 'foo').and_raise "oops"
       begin
         @rc.exec("foo")
@@ -73,5 +73,35 @@ module Lackie
         e.message.should =~ /have you started a lackie server?/
       end
     end
+    
+    describe "#await" do
+      it "does not raise if the value eventually matches the block" do
+        responses = ["bar", "foo"].map do |result|
+          mock("stub_result_response", :body => { :value => result }.to_json)
+        end
+        RestClient.stub!(:get).with("http://host:555/lackie/result?cachebust").and_return {
+          responses.shift
+        }
+        lambda {
+          @rc.await("script") { |value| value == "foo" }
+        }.should_not raise_error
+      end
+      
+      it "raises if the value never matches the block" do
+        RestClient.stub!(:get).with("http://host:555/lackie/result?cachebust").and_return {
+          mock("stub_result_response", :body => '{"value":"oopsie"}')
+        }
+        begin
+          @rc.await("script") { |value| value == "bar" }
+        rescue Lackie::AwaitError => e
+          e.message.should =~ /oopsie/
+        end
+      end
+      
+      it "accepts an optional total number of seconds to wait" do
+        @poller.should_receive(:await).with("result matching expression: script", :timeout_seconds => 333)
+        @rc.await("script", :timeout_seconds => 333) { |value| value == "bar" }
+      end
+    end
   end
 end

metadata

@@ -1,13 +1,13 @@
 --- !ruby/object:Gem::Specification 
 name: lackie
 version: !ruby/object:Gem::Version 
-  hash: 19
+  hash: 17
   prerelease: false
   segments: 
   - 0
   - 1
-  - 4
-  version: 0.1.4
+  - 5
+  version: 0.1.5
 platform: ruby
 authors: 
 - Josh Chisholm
@@ -197,7 +197,7 @@ rubyforge_project:
 rubygems_version: 1.3.7
 signing_key: 
 specification_version: 3
-summary: lackie-0.1.4
+summary: lackie-0.1.5
 test_files: 
 - features/remote_control.feature
 - features/step_definitions/lackie_steps.rb