rautomation 0.3.0 → 0.4.0

data/History.rdoc

@@ -1,3 +1,9 @@
+=== Version 0.4.0 / 2010-12-23
+
+* allow to search windows without text (like empty Notepad window for example).
+* added possibility to use block for #click to specify successful clicking condition.
+* renamed :ffi adapter to :win_ffi because FFI may be used on other platforms too.
+
 === Version 0.3.0 / 2010-12-18
 
 * added Ffi adapter specific method Window#child which searches for child windows and popups

data/VERSION

@@ -1 +1 @@
-0.3.0
+0.4.0

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

@@ -27,7 +27,7 @@ module RAutomation
           extract(locators)
         end
 
-        # @see RAutomation::Button#click 
+        # @see RAutomation::Button#click
         def click
           clicked = false
           wait_until do
@@ -37,7 +37,7 @@ module RAutomation
                     Window.autoit.ControlClick(@window.locator_hwnd, "", @locators) == 1 &&
                     clicked = true # is clicked at least once
 
-            clicked && !exists?
+            block_given? ? yield : clicked && !exists?
           end
         end
 
@@ -53,4 +53,4 @@ module RAutomation
       end
     end
   end
-end
+end

data/lib/rautomation/adapter/autoit/window.rb

@@ -51,11 +51,11 @@ module RAutomation
         end
 
         # Retrieves handle of the window.
-        # @note Searches only for visible windows with having some text at all.
+        # @note Searches only for visible windows.
         # @see RAutomation::Window#hwnd
         def hwnd
           @hwnd ||= @@autoit.WinList(@locators, @locator_text).pop.compact.
-                  find {|handle| w = self.class.new(:hwnd => handle.hex); w.visible? && !w.text.empty?}.
+                  find {|handle| self.class.new(:hwnd => handle.hex).visible?}.
                   hex rescue nil
         end
 
@@ -165,4 +165,4 @@ module RAutomation
       end
     end
   end
-end
+end

data/lib/rautomation/adapter/helper.rb

@@ -1,7 +1,7 @@
 module RAutomation
   module Adapter
     autoload :Autoit, File.dirname(__FILE__) + "/autoit.rb"
-    autoload :Ffi, File.dirname(__FILE__) + "/ffi.rb"
+    autoload :WinFfi, File.dirname(__FILE__) + "/win_ffi.rb"
 
     module Helper
       extend self
@@ -11,7 +11,7 @@ module RAutomation
       def default_adapter
         case RUBY_PLATFORM
           when /mswin|msys|mingw32/
-            :ffi
+            :win_ffi
           else
             raise "unsupported platform for RAutomation: #{RUBY_PLATFORM}"
         end

data/lib/rautomation/adapter/win_ffi.rb

@@ -0,0 +1,12 @@
+begin
+  gem "ffi", "0.6.3"
+rescue Gem::LoadError
+  raise Gem::LoadError, "Unable to load FFI gem. Install it with:\n\tgem install ffi -v 0.6.3"
+end
+require "ffi"
+require File.dirname(__FILE__) + "/win_ffi/constants"
+require File.dirname(__FILE__) + "/win_ffi/functions"
+require File.dirname(__FILE__) + "/win_ffi/locators"
+require File.dirname(__FILE__) + "/win_ffi/window"
+require File.dirname(__FILE__) + "/win_ffi/button"
+require File.dirname(__FILE__) + "/win_ffi/text_field"

data/lib/rautomation/adapter/{ffi → win_ffi}/button.rb

@@ -1,6 +1,6 @@
 module RAutomation
   module Adapter
-    module Ffi
+    module WinFfi
       class Button
         include WaitHelper
         include Locators
@@ -29,7 +29,8 @@ module RAutomation
                     Functions.set_control_focus(hwnd) &&
                     Functions.control_click(hwnd) &&
                     clicked = true # is clicked at least once
-            clicked && !exists?
+
+            block_given? ? yield : clicked && !exists?
           end
         end
 
@@ -46,4 +47,4 @@ module RAutomation
       end
     end
   end
-end
+end

data/lib/rautomation/adapter/{ffi → win_ffi}/constants.rb

@@ -1,6 +1,6 @@
 module RAutomation
   module Adapter
-    module Ffi
+    module WinFfi
       # @private
       module Constants
         WM_GETTEXT = 0xD

data/lib/rautomation/adapter/{ffi → win_ffi}/functions.rb

@@ -1,6 +1,6 @@
 module RAutomation
   module Adapter
-    module Ffi
+    module WinFfi
       # @private
       module Functions
         extend FFI::Library
@@ -90,8 +90,7 @@ module RAutomation
 
           def window_hwnd(locators)
             find_hwnd(locators) do |hwnd|
-              window_visible(hwnd) && !window_text(hwnd).empty? &&
-                      locators_match?(locators, window_properties(hwnd, locators))
+              window_visible(hwnd) && locators_match?(locators, window_properties(hwnd, locators))
             end
           end
 
@@ -246,4 +245,4 @@ module RAutomation
       end
     end
   end
-end
+end

data/lib/rautomation/adapter/{ffi → win_ffi}/locators.rb

@@ -1,6 +1,6 @@
 module RAutomation
   module Adapter
-    module Ffi
+    module WinFfi
       # @private
       module Locators
 

data/lib/rautomation/adapter/{ffi → win_ffi}/text_field.rb

@@ -1,6 +1,6 @@
 module RAutomation
   module Adapter
-    module Ffi
+    module WinFfi
       class TextField
         include WaitHelper
         include Locators

data/lib/rautomation/adapter/{ffi → win_ffi}/window.rb

@@ -1,6 +1,6 @@
 module RAutomation
   module Adapter
-    module Ffi
+    module WinFfi
       class Window
         include WaitHelper
         include Locators
@@ -26,7 +26,7 @@ module RAutomation
         end
 
         # Retrieves handle of the window.
-        # @note Searches only for visible windows with having some text at all.
+        # @note Searches only for visible windows.
         # @see RAutomation::Window#hwnd
         def hwnd
           @hwnd ||= Functions.window_hwnd(@locators)
@@ -134,7 +134,10 @@ module RAutomation
         end
 
         # Creates the child window object.
-        # @note This is an Ffi adapter specific method, not part of the public API
+        # @note This is an WinFfi adapter specific method, not part of the public API
+        # @example
+        #   RAutomation::Window.new(:title => /Windows Internet Explorer/i).
+        #     child(:title => /some popup/)
         # @param (see Window#initialize)
         # @return [RAutomation::Window] child window, popup or regular window.
         def child(locators)
@@ -144,4 +147,4 @@ module RAutomation
       end
     end
   end
-end
+end

data/lib/rautomation/button.rb

@@ -8,11 +8,19 @@ module RAutomation
       @button = @window.button(@locators)
     end
 
-    # Performs a click on the Button.
+    # Performs a click on the button.
+    # By default click is considered successful if the button doesn't exist after clicking (e.g. window has closed)
+    # @yield [button] optional block specifying successful clicking condition.
+    # @yieldparam [Button] button which is being clicked on.
+    # @yieldreturn [Boolean] true if clicking on the button is successful, false otherwise.
     # @raise [UnknownButtonException] if the button doesn't exist.
     def click
       wait_until_exists
-      @button.click
+      if block_given?
+        @button.click {yield self}
+      else
+        @button.click
+      end
     end
 
     # Retrieves the value (text) of the button, usually the visible text.
@@ -34,9 +42,9 @@ module RAutomation
     private
 
     def wait_until_exists
-      WaitHelper.wait_until(RAutomation::Window.wait_timeout) {exists?}
+      WaitHelper.wait_until {exists?}
     rescue WaitHelper::TimeoutError
       raise UnknownButtonException, "Button #{@locators.inspect} doesn't exist on window #{@window.locators.inspect}!"
     end
   end
-end
+end

data/lib/rautomation/text_field.rb

@@ -42,9 +42,9 @@ module RAutomation
     private
 
     def wait_until_exists
-      WaitHelper.wait_until(RAutomation::Window.wait_timeout) {exists?}
+      WaitHelper.wait_until {exists?}
     rescue WaitHelper::TimeoutError
       raise UnknownTextFieldException, "Text field #{@locators.inspect} doesn't exist on window #{@window.locators.inspect}!" unless exists?
     end
   end
-end
+end

data/lib/rautomation/wait_helper.rb

@@ -8,7 +8,7 @@ module RAutomation
 
     # @private
     # Wait until the block evaluates to true or times out.
-    def wait_until(timeout = 60, &block)
+    def wait_until(timeout = Window.wait_timeout, &block)
       end_time = ::Time.now + timeout
 
       until ::Time.now > end_time
@@ -20,4 +20,4 @@ module RAutomation
       raise TimeoutError, "timed out after #{timeout} seconds"
     end
   end
-end
+end

data/lib/rautomation/window.rb

@@ -37,8 +37,8 @@ module RAutomation
     # It is also possible to change the default adapter by using environment variable called
     # __RAUTOMATION_ADAPTER__
     #
-    # @note This constructor doesn't ensure window's existance.
-    # @note Window to be searched for has to be visible.
+    # @note This constructor doesn't check for window's existance.
+    # @note Only visible Windows are supported.
     # @param [Hash] locators for the window.
     def initialize(locators)
       @adapter = locators.delete(:adapter) || ENV["RAUTOMATION_ADAPTER"] && ENV["RAUTOMATION_ADAPTER"].to_sym || default_adapter
@@ -191,7 +191,7 @@ module RAutomation
     private
 
     def wait_until_exists
-      WaitHelper.wait_until(RAutomation::Window.wait_timeout) {exists?}
+      WaitHelper.wait_until {exists?}
     rescue WaitHelper::TimeoutError
       raise UnknownWindowException, "Window with locator #{@window.locators.inspect} doesn't exist!" unless exists?
     end
@@ -201,4 +201,4 @@ module RAutomation
     end
 
   end
-end
+end

data/rautomation.gemspec

@@ -5,11 +5,11 @@
 
 Gem::Specification.new do |s|
   s.name = %q{rautomation}
-  s.version = "0.3.0"
+  s.version = "0.4.0"
 
   s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
   s.authors = ["Jarmo Pertman"]
-  s.date = %q{2010-12-18}
+  s.date = %q{2010-12-23}
   s.description = %q{RAutomation is a small and easy to use library for helping out to automate windows and their controls
 for automated testing.
 
@@ -35,25 +35,26 @@ RAutomation provides:
      "VERSION",
      "ext/AutoItX/AutoItX.chm",
      "ext/AutoItX/AutoItX3.dll",
-     "lib/rautomation.rb",
+     "lib/RAutomation.rb",
      "lib/rautomation/adapter/autoit.rb",
      "lib/rautomation/adapter/autoit/button.rb",
      "lib/rautomation/adapter/autoit/locators.rb",
      "lib/rautomation/adapter/autoit/text_field.rb",
      "lib/rautomation/adapter/autoit/window.rb",
-     "lib/rautomation/adapter/ffi.rb",
-     "lib/rautomation/adapter/ffi/button.rb",
-     "lib/rautomation/adapter/ffi/constants.rb",
-     "lib/rautomation/adapter/ffi/functions.rb",
-     "lib/rautomation/adapter/ffi/locators.rb",
-     "lib/rautomation/adapter/ffi/text_field.rb",
-     "lib/rautomation/adapter/ffi/window.rb",
      "lib/rautomation/adapter/helper.rb",
+     "lib/rautomation/adapter/win_ffi.rb",
+     "lib/rautomation/adapter/win_ffi/button.rb",
+     "lib/rautomation/adapter/win_ffi/constants.rb",
+     "lib/rautomation/adapter/win_ffi/functions.rb",
+     "lib/rautomation/adapter/win_ffi/locators.rb",
+     "lib/rautomation/adapter/win_ffi/text_field.rb",
+     "lib/rautomation/adapter/win_ffi/window.rb",
      "lib/rautomation/button.rb",
      "lib/rautomation/text_field.rb",
      "lib/rautomation/wait_helper.rb",
      "lib/rautomation/window.rb",
      "rautomation.gemspec",
+     "spec/adapter/win_ffi/window_spec.rb",
      "spec/button_spec.rb",
      "spec/spec_helper.rb",
      "spec/test.html",
@@ -66,7 +67,8 @@ RAutomation provides:
   s.rubygems_version = %q{1.3.7}
   s.summary = %q{Automate windows and their controls through user-friendly API with Ruby}
   s.test_files = [
-    "spec/button_spec.rb",
+    "spec/adapter/win_ffi/window_spec.rb",
+     "spec/button_spec.rb",
      "spec/spec_helper.rb",
      "spec/text_field_spec.rb",
      "spec/window_spec.rb"

data/spec/adapter/win_ffi/window_spec.rb

@@ -0,0 +1,20 @@
+require "spec_helper"
+
+describe "WinFfi::Window", :if => SpecHelper.adapter == :win_ffi 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 "#child" do
+    window = RAutomation::Window.new(:title => /Internet Explorer$/i)
+    window.should exist
+    child = window.child(:title => SpecHelper::DATA[:window2_title])
+    child.should exist
+    child.title.should == SpecHelper::DATA[:window2_title]
+    child.text.should include(SpecHelper::DATA[:window2_text])
+  end
+end

data/spec/button_spec.rb

@@ -1,4 +1,4 @@
-require File.expand_path(File.dirname(__FILE__) + '/spec_helper')
+require 'spec_helper'
 
 describe RAutomation::Button do
   it "#button" do
@@ -31,10 +31,29 @@ describe RAutomation::Button do
     expect {window.button(:value => "non-existent-button").click}.
             to raise_exception(RAutomation::UnknownButtonException)
 
+    RAutomation::Window.wait_timeout = 60
     button = window.button(:value => SpecHelper::DATA[:window2_button_text])
     button.should exist
     button.click
     button.should_not exist
     window.should_not exist
   end
-end
+
+  it "#click with a block for defining successful click" do
+    window = RAutomation::Window.new(:title => SpecHelper::DATA[:window2_title])
+    RAutomation::Window.wait_timeout = 5
+    button = window.button(:value => SpecHelper::DATA[:window2_button_text])
+    expect {button.click {false}}.
+            to raise_exception(RAutomation::WaitHelper::TimeoutError)
+    button.should_not exist
+    window.should_not exist
+
+    RAutomation::Window.wait_timeout = 10
+    window = RAutomation::Window.new(:title => SpecHelper::DATA[:window2_title])
+    button = window.button(:value => SpecHelper::DATA[:window2_button_text])
+    button.should exist
+    button.click {|button| !button.exists? && !window.exists?}
+    button.should_not exist
+    window.should_not exist
+  end
+end

data/spec/spec_helper.rb

@@ -42,7 +42,7 @@ module SpecHelper
                   :title_proc => lambda {|win| win.WinGetTitle("[TITLE:Explorer User Prompt]")}
           },
           # This adapter needs Windows OS with Internet Explorer installed into 'c:\program files\internet explorer'.
-          :ffi => {
+          :win_ffi => {
                   # Path to some binary, which opens up a window, what can be
                   # minimized, maximized, activated, closed and etc.
                   :window1 => "mspaint",

data/spec/test.html

@@ -3,11 +3,13 @@
     <title>RAutomation testing page</title>
     <script type="text/javascript">
         function showPrompt() {
-            prompt("Where do you want to go today?");
+          if (prompt("Where do you want to go today?")) {
+            showPrompt();
+          }
         }
     </script>
 </head>
 <body onload="setTimeout(showPrompt, 1000)">
 <h1>RAutomation testing page</h1>
 </body>
-</html>
+</html>

data/spec/text_field_spec.rb

@@ -1,4 +1,4 @@
-require File.expand_path(File.dirname(__FILE__) + '/spec_helper')
+require 'spec_helper'
 
 describe RAutomation::TextField do
   it "#text_field" do
@@ -50,4 +50,4 @@ describe RAutomation::TextField do
     field.should exist
     window.text_field(:class => "non-existent-field").should_not exist
   end
-end
+end

data/spec/window_spec.rb

@@ -1,4 +1,4 @@
-require File.expand_path(File.dirname(__FILE__) + '/spec_helper')
+require 'spec_helper'
 
 describe RAutomation::Window do
   before :all do
@@ -102,15 +102,6 @@ describe RAutomation::Window do
             to raise_exception(RAutomation::UnknownWindowException)
   end
 
-  it "#child", :if => SpecHelper.adapter == :ffi do
-    window = RAutomation::Window.new(:title => /Windows Internet Explorer/i)
-    window.should exist
-    child = window.child(:title => SpecHelper::DATA[:window2_title])
-    child.should exist
-    child.title.should == SpecHelper::DATA[:window2_title]
-    child.text.should include(SpecHelper::DATA[:window2_text])
-  end
-
   it "#method_missing" do
     win = RAutomation::Window.new(:title => SpecHelper::DATA[:window2_title])
     SpecHelper::DATA[:title_proc].call(win).should == SpecHelper::DATA[:window2_title]

metadata

@@ -1,13 +1,13 @@
 --- !ruby/object:Gem::Specification 
 name: rautomation
 version: !ruby/object:Gem::Version 
-  hash: 19
+  hash: 15
   prerelease: false
   segments: 
   - 0
-  - 3
+  - 4
   - 0
-  version: 0.3.0
+  version: 0.4.0
 platform: ruby
 authors: 
 - Jarmo Pertman
@@ -15,7 +15,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2010-12-18 00:00:00 +02:00
+date: 2010-12-23 00:00:00 +02:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency 
@@ -62,25 +62,26 @@ files:
 - VERSION
 - ext/AutoItX/AutoItX.chm
 - ext/AutoItX/AutoItX3.dll
-- lib/rautomation.rb
+- lib/RAutomation.rb
 - lib/rautomation/adapter/autoit.rb
 - lib/rautomation/adapter/autoit/button.rb
 - lib/rautomation/adapter/autoit/locators.rb
 - lib/rautomation/adapter/autoit/text_field.rb
 - lib/rautomation/adapter/autoit/window.rb
-- lib/rautomation/adapter/ffi.rb
-- lib/rautomation/adapter/ffi/button.rb
-- lib/rautomation/adapter/ffi/constants.rb
-- lib/rautomation/adapter/ffi/functions.rb
-- lib/rautomation/adapter/ffi/locators.rb
-- lib/rautomation/adapter/ffi/text_field.rb
-- lib/rautomation/adapter/ffi/window.rb
 - lib/rautomation/adapter/helper.rb
+- lib/rautomation/adapter/win_ffi.rb
+- lib/rautomation/adapter/win_ffi/button.rb
+- lib/rautomation/adapter/win_ffi/constants.rb
+- lib/rautomation/adapter/win_ffi/functions.rb
+- lib/rautomation/adapter/win_ffi/locators.rb
+- lib/rautomation/adapter/win_ffi/text_field.rb
+- lib/rautomation/adapter/win_ffi/window.rb
 - lib/rautomation/button.rb
 - lib/rautomation/text_field.rb
 - lib/rautomation/wait_helper.rb
 - lib/rautomation/window.rb
 - rautomation.gemspec
+- spec/adapter/win_ffi/window_spec.rb
 - spec/button_spec.rb
 - spec/spec_helper.rb
 - spec/test.html
@@ -121,6 +122,7 @@ signing_key:
 specification_version: 3
 summary: Automate windows and their controls through user-friendly API with Ruby
 test_files: 
+- spec/adapter/win_ffi/window_spec.rb
 - spec/button_spec.rb
 - spec/spec_helper.rb
 - spec/text_field_spec.rb

data/lib/rautomation/adapter/ffi.rb

@@ -1,12 +0,0 @@
-begin
-  gem "ffi", "0.6.3"
-rescue Gem::LoadError
-  raise Gem::LoadError, "Unable to load FFI gem. Install it with:\n\tgem install ffi -v 0.6.3"
-end
-require "ffi"
-require File.dirname(__FILE__) + "/ffi/constants"
-require File.dirname(__FILE__) + "/ffi/functions"
-require File.dirname(__FILE__) + "/ffi/locators"
-require File.dirname(__FILE__) + "/ffi/window"
-require File.dirname(__FILE__) + "/ffi/button"
-require File.dirname(__FILE__) + "/ffi/text_field"