rautomation 0.0.3 → 0.0.4

data/History.rdoc

@@ -1,3 +1,8 @@
+=== Version 0.0.4 / 2010-10-27
+
+ * most Window, Button and TextField methods wait until the object exists.
+     Use RAutomation::Window.wait_timeout= to set timeout before failing. Default is 60 seconds.
+
 === Version 0.0.3 / 2010-10-15
 
  * RAutomation didn't load AutoIt correctly if it wasn't installed before

data/VERSION

@@ -1 +1 @@
-0.0.3
+0.0.4

data/lib/rautomation/button.rb

@@ -11,7 +11,7 @@ module RAutomation
     #
     # Raises an UnknownButtonException if the Button itself doesn't exist.
     def click
-      assert_exists
+      wait_until_exists
       @button.click
     end
 
@@ -19,7 +19,7 @@ module RAutomation
     #
     # Raises an UnknownButtonException if the Button itself doesn't exist.
     def value
-      assert_exists
+      wait_until_exists
       @button.value
     end
 
@@ -32,8 +32,10 @@ module RAutomation
 
     private
 
-    def assert_exists
-      raise UnknownButtonException.new("Button '#{@locators.inspect}' doesn't exist on window '#{@window.locators.inspect}'!") unless exists?
+    def wait_until_exists
+      WaitHelper.wait_until(RAutomation::Window.wait_timeout) {exists?}
+    rescue WaitHelper::TimeoutError
+      raise UnknownButtonException.new("Button #{@locators.inspect} doesn't exist on window #{@window.locators.inspect}!")
     end
   end
 end

data/lib/rautomation/implementations/autoit/button.rb

@@ -11,7 +11,7 @@ module RAutomation
                 :value => :text
         }
 
-        # Possible locators are :value, :id, :class, :class_name and :instance.
+        # Possible locators are :text, :value, :id, :class, :class_name and :instance.
         def initialize(window, locators)
           @window = window
           extract(locators)

data/lib/rautomation/text_field.rb

@@ -11,7 +11,7 @@ module RAutomation
     #
     # Raises an UnknownTextFieldException if the TextField itself doesn't exist.
     def set(text)
-      assert_exists
+      wait_until_exists
       @text_field.set(text)
     end
 
@@ -19,7 +19,7 @@ module RAutomation
     #
     # Raises an UnknownTextFieldException if the TextField itself doesn't exist.
     def clear
-      assert_exists
+      wait_until_exists
       @text_field.clear
     end
 
@@ -27,7 +27,7 @@ module RAutomation
     #
     # Raises an UnknownTextFieldException if the TextField itself doesn't exist.
     def value
-      assert_exists
+      wait_until_exists
       @text_field.value
     end
 
@@ -40,8 +40,10 @@ module RAutomation
 
     private
 
-    def assert_exists
-      raise UnknownTextFieldException.new("Text field '#{@locators.inspect}' doesn't exist on window '#{@window.locators.inspect}'!") unless exists?
+    def wait_until_exists
+      WaitHelper.wait_until(RAutomation::Window.wait_timeout) {exists?}
+    rescue WaitHelper::TimeoutError
+      raise UnknownTextFieldException.new("Text field #{@locators.inspect} doesn't exist on window #{@window.locators.inspect}!") unless exists?
     end
   end
 end

data/lib/rautomation/window.rb

@@ -43,11 +43,24 @@ module RAutomation
       @window = @implementation.new(locators)
     end
 
+    class << self
+      # Timeout for waiting until object exists. If the timeout exceeds then an Exception is thrown.
+      @@wait_timeout = 60
+
+      def wait_timeout=(timeout)
+        @@wait_timeout = timeout
+      end
+
+      def wait_timeout
+        @@wait_timeout
+      end
+    end
+
     # Returns handle of the Window.
     #
     # This handle will be used internally for all operations.
     def hwnd
-      assert_exists
+      wait_until_exists
       @window.hwnd
     end
 
@@ -55,7 +68,7 @@ module RAutomation
     #
     # Raises an UnknownWindowException if the Window itself doesn't exist.
     def title
-      assert_exists
+      wait_until_exists
       @window.title
     end
 
@@ -73,7 +86,7 @@ module RAutomation
     #
     # Raises an UnknownWindowException if the Window itself doesn't exist.
     def text
-      assert_exists
+      wait_until_exists
       @window.text
     end
 
@@ -89,7 +102,7 @@ module RAutomation
     #
     # Raises an UnknownWindowException if the Window itself doesn't exist.
     def visible?
-      assert_exists
+      wait_until_exists
       @window.visible?
     end
 
@@ -102,7 +115,7 @@ module RAutomation
     #
     # Raises an UnknownWindowException if the Window itself doesn't exist.
     def maximize
-      assert_exists
+      wait_until_exists
       @window.maximize
     end
 
@@ -110,7 +123,7 @@ module RAutomation
     #
     # Raises an UnknownWindowException if the Window itself doesn't exist.
     def minimize
-      assert_exists
+      wait_until_exists
       @window.minimize
     end
 
@@ -118,7 +131,7 @@ module RAutomation
     #
     # Raises an UnknownWindowException if the Window itself doesn't exist.
     def minimized?
-      assert_exists
+      wait_until_exists
       @window.minimized?
     end
 
@@ -126,7 +139,7 @@ module RAutomation
     #
     # Raises an UnknownWindowException if the Window itself doesn't exist.
     def restore
-      assert_exists
+      wait_until_exists
       @window.restore
     end
 
@@ -134,7 +147,7 @@ module RAutomation
     #
     # Raises an UnknownWindowException if the Window itself doesn't exist.
     def send_keys(keys)
-      assert_exists
+      wait_until_exists
       @window.send_keys(keys)
     end
 
@@ -149,7 +162,7 @@ module RAutomation
     #
     # Raises an UnknownWindowException if the Window itself doesn't exist.
     def button(locators)
-      assert_exists
+      wait_until_exists
       Button.new(@window, locators)
     end
 
@@ -158,7 +171,7 @@ module RAutomation
     #
     # Raises an UnknownWindowException if the Window itself doesn't exist.
     def text_field(locators)
-      assert_exists
+      wait_until_exists
       TextField.new(@window, locators)
     end
 
@@ -169,8 +182,11 @@ module RAutomation
 
     private
 
-    def assert_exists
-      raise UnknownWindowException.new("Window with locator '#{@window.locators.inspect}' doesn't exist!") unless exists?
+    def wait_until_exists
+      WaitHelper.wait_until(RAutomation::Window.wait_timeout) {exists?}
+    rescue WaitHelper::TimeoutError
+      raise UnknownWindowException.new("Window with locator #{@window.locators.inspect} doesn't exist!") unless exists?
     end
+
   end
 end

data/rautomation.gemspec

@@ -5,11 +5,11 @@
 
 Gem::Specification.new do |s|
   s.name = %q{rautomation}
-  s.version = "0.0.3"
+  s.version = "0.0.4"
 
   s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
   s.authors = ["Jarmo Pertman"]
-  s.date = %q{2010-10-15}
+  s.date = %q{2010-10-27}
   s.description = %q{RAutomation tries to be a small and easy to use library for helping out to automate windows and their controls
 for automated testing.
 

data/spec/button_spec.rb

@@ -4,6 +4,8 @@ describe RAutomation::Button do
   it "#button" do
     RAutomation::Window.new(:title => SpecHelper::DATA[:window2_title]).
             button(:value => SpecHelper::DATA[:window2_button_text]).should exist
+
+    RAutomation::Window.wait_timeout = 0.1
     lambda {RAutomation::Window.new(:title => "non-existing-window").button(:value => "Something")}.
             should raise_exception(RAutomation::UnknownWindowException)
   end
@@ -11,6 +13,8 @@ describe RAutomation::Button do
   it "#value" do
     RAutomation::Window.new(:title => SpecHelper::DATA[:window2_title]).
             button(:value => SpecHelper::DATA[:window2_button_text]).value.should == SpecHelper::DATA[:window2_button_text]
+
+    RAutomation::Window.wait_timeout = 0.1
     lambda {RAutomation::Window.new(:title => SpecHelper::DATA[:window2_title]).button(:value => "non-existent-button").value}.
             should raise_exception(RAutomation::UnknownButtonException)
   end
@@ -23,6 +27,7 @@ describe RAutomation::Button do
 
   it "#click" do
     window = RAutomation::Window.new(:title => SpecHelper::DATA[:window2_title])
+    RAutomation::Window.wait_timeout = 0.1
     lambda{window.button(:value => "non-existent-button").click}.
             should raise_exception(RAutomation::UnknownButtonException)
 

data/spec/spec.opts

@@ -1 +1,2 @@
 --color
+--format n

data/spec/spec_helper.rb

@@ -40,10 +40,10 @@ Spec::Runner.configure do |config|
   config.before(:all) do
     @pid1 = IO.popen(SpecHelper::DATA[:window1]).pid
     @pid2 = IO.popen(SpecHelper::DATA[:window2] + " " + File.dirname(__FILE__) + "/test.html").pid
-    window1 = RAutomation::Window.new(:title => SpecHelper::DATA[:window1_title])
-    RAutomation::WaitHelper.wait_until(15) {window1.present?}
-    window2 = RAutomation::Window.new(:title => SpecHelper::DATA[:window2_title])
-    RAutomation::WaitHelper.wait_until(15) {window2.present?}
+  end
+
+  config.before(:each) do
+    RAutomation::Window.wait_timeout = 60
   end
 
   config.after(:all) do

data/spec/text_field_spec.rb

@@ -4,6 +4,8 @@ describe RAutomation::TextField do
   it "#text_field" do
     RAutomation::Window.new(:title => SpecHelper::DATA[:window2_title]).
             text_field(:class_name => SpecHelper::DATA[:window2_text_field_class_name]).should exist
+
+    RAutomation::Window.wait_timeout = 0.1
     lambda {RAutomation::Window.new(:title => "non-existent-window").
             text_field(:class_name => SpecHelper::DATA[:window2_text_field_class_name])}.
             should raise_exception(RAutomation::UnknownWindowException)
@@ -12,6 +14,8 @@ describe RAutomation::TextField do
   it "#set" do
     window = RAutomation::Window.new(:title => SpecHelper::DATA[:window2_title])
     window.text_field(:class_name => SpecHelper::DATA[:window2_text_field_class_name]).set "hello!"
+
+    RAutomation::Window.wait_timeout = 0.1
     lambda {window.text_field(:class_name => "non-existing-field").set "hello!"}.
             should raise_exception(RAutomation::UnknownTextFieldException)
   end
@@ -24,6 +28,7 @@ describe RAutomation::TextField do
     field.clear
     field.value.should be_empty
 
+    RAutomation::Window.wait_timeout = 0.1
     lambda {window.text_field(:class_name => "non-existent-field").clear}.
             should raise_exception(RAutomation::UnknownTextFieldException)
   end
@@ -34,6 +39,7 @@ describe RAutomation::TextField do
     field.set "hello!"
     field.value.should == "hello!"
 
+    RAutomation::Window.wait_timeout = 0.1
     lambda {window.text_field(:class_name => "non-existent-field").value}.
             should raise_exception(RAutomation::UnknownTextFieldException)
   end

data/spec/window_spec.rb

@@ -1,6 +1,14 @@
 require File.expand_path(File.dirname(__FILE__) + '/spec_helper')
 
 describe RAutomation::Window do
+  before :all do
+    window = RAutomation::Window.new(:title => SpecHelper::DATA[:window1_title])
+    RAutomation::WaitHelper.wait_until {window.present?}
+
+    window = RAutomation::Window.new(:title => SpecHelper::DATA[:window2_title])
+    RAutomation::WaitHelper.wait_until {window.present?}
+  end
+
   it "RAutomation::Window.implementation" do
     RAutomation::Window.new(:title => "random").implementation.should == (ENV["RAUTOMATION_IMPLEMENTATION"] || RAutomation::Implementations::Helper.default_implementation)
   end
@@ -27,6 +35,7 @@ describe RAutomation::Window do
 
   it "#visible?"do
     RAutomation::Window.new(:title => SpecHelper::DATA[:window1_title]).should be_visible
+    RAutomation::Window.wait_timeout = 0.1
     lambda{RAutomation::Window.new(:title => "non-existing-window").visible?}.
             should raise_exception(RAutomation::UnknownWindowException)
   end
@@ -38,12 +47,14 @@ describe RAutomation::Window do
 
   it "#hwnd" do
     RAutomation::Window.new(:title => SpecHelper::DATA[:window1_title]).hwnd.should be_a(Fixnum)
+    RAutomation::Window.wait_timeout = 0.1
     lambda {RAutomation::Window.new(:title => "non-existing-window").hwnd}.
             should raise_exception(RAutomation::UnknownWindowException)
   end
 
   it "#title" do
     RAutomation::Window.new(:title => SpecHelper::DATA[:window2_title]).title.should == SpecHelper::DATA[:window2_title]
+    RAutomation::Window.wait_timeout = 0.1
     lambda {RAutomation::Window.new(:title => "non-existing-window").title}.
             should raise_exception(RAutomation::UnknownWindowException)
   end
@@ -59,12 +70,14 @@ describe RAutomation::Window do
 
   it "#text" do
     RAutomation::Window.new(:title => SpecHelper::DATA[:window2_title]).text.should include(SpecHelper::DATA[:window2_text])
+    RAutomation::Window.wait_timeout = 0.1
     lambda {RAutomation::Window.new(:title => "non-existing-window").text}.
             should raise_exception(RAutomation::UnknownWindowException)
   end
 
   it "#maximize" do
     RAutomation::Window.new(:title => SpecHelper::DATA[:window1_title]).maximize
+    RAutomation::Window.wait_timeout = 0.1
     lambda {RAutomation::Window.new(:title => "non-existing-window").maximize}.
             should raise_exception(RAutomation::UnknownWindowException)
   end
@@ -75,6 +88,7 @@ describe RAutomation::Window do
     window.minimize
     window.should be_minimized
 
+    RAutomation::Window.wait_timeout = 0.1
     lambda {RAutomation::Window.new(:title => "non-existing-window").minimize}.
             should raise_exception(RAutomation::UnknownWindowException)
     lambda {RAutomation::Window.new(:title => "non-existing-window").minimized?}.
@@ -83,6 +97,7 @@ describe RAutomation::Window do
 
   it "#restore" do
     RAutomation::Window.new(:title => SpecHelper::DATA[:window1_title]).restore
+    RAutomation::Window.wait_timeout = 0.1
     lambda {RAutomation::Window.new(:title => "non-existing-window").restore}.
             should raise_exception(RAutomation::UnknownWindowException)
   end
@@ -93,6 +108,7 @@ describe RAutomation::Window do
     window.send_keys(SpecHelper::DATA[:window2_send_keys])
     RAutomation::WaitHelper.wait_until(15) {not window.exists?}
 
+    RAutomation::Window.wait_timeout = 0.1
     lambda {RAutomation::Window.new(:title => "non-existing-window").send_keys("123")}.
             should raise_exception(RAutomation::UnknownWindowException)
   end

metadata

@@ -1,13 +1,13 @@
 --- !ruby/object:Gem::Specification 
 name: rautomation
 version: !ruby/object:Gem::Version 
-  hash: 25
+  hash: 23
   prerelease: false
   segments: 
   - 0
   - 0
-  - 3
-  version: 0.0.3
+  - 4
+  version: 0.0.4
 platform: ruby
 authors: 
 - Jarmo Pertman
@@ -15,7 +15,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2010-10-15 00:00:00 +03:00
+date: 2010-10-27 00:00:00 +03:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency