rautomation 0.2.1 → 0.3.0

data/History.rdoc

@@ -1,3 +1,7 @@
+=== Version 0.3.0 / 2010-12-18
+
+* added Ffi adapter specific method Window#child which searches for child windows and popups
+
 === Version 0.2.1 / 2010-12-17
 
 * added yard options for documentation

data/README.rdoc

@@ -70,10 +70,12 @@ about that matter - or even better, follow the instructions at "How to create a
 1. Fork the project.
 2. Create entry point file to lib/rautomation/adapter which should load all adapter specific files.
 3. Add `autoload` statement into lib/rautomation/adapter/helper.rb for that file.
-4. Copy button.rb, text_field.rb and window.rb from some of the existing adapter's directory.
-5. Add spec data for your adapter into spec/spec_helper DATA constant.
-6. Use environment variable __RAUTOMATION_ADAPTER__ to point to that adapter.
-7. Start coding and spec-ing.
+4. Create a directory for your adapter's specific code into lib/rautomation/adapter
+5. Copy button.rb, text_field.rb and window.rb from some of the existing adapter's directory.
+6. Add spec data for your adapter into spec/spec_helper DATA constant.
+7. Use environment variable __RAUTOMATION_ADAPTER__ to point to that adapter.
+8. Start coding and spec-ing until as much of possible of the public API is satisfied.
+9. Make me a pull request.
 
 Don't forget to fix the documentation for that adapter also!
 

data/VERSION

@@ -1 +1 @@
-0.2.1
+0.3.0

data/lib/rautomation/adapter/ffi/constants.rb

@@ -23,6 +23,9 @@ module RAutomation
         # keybd_event constants
         KEYEVENTF_EXTENDEDKEY = 0x1
         KEYEVENTF_KEYUP = 0x2
+
+        # GetWindow constants
+        GW_ENABLEDPOPUP = 6
       end
     end
   end

data/lib/rautomation/adapter/ffi/functions.rb

@@ -55,6 +55,8 @@ module RAutomation
                         [:long], :int
         attach_function :_set_control_focus, :SetFocus,
                         [:long], :long
+        attach_function :get_window, :GetWindow,
+                        [:long, :uint], :long
 
         # kernel32
         attach_function :open_process, :OpenProcess,
@@ -72,6 +74,8 @@ module RAutomation
             title.read_string
           end
 
+          alias_method :control_title, :window_title
+
           def window_text(hwnd)
             found_text = ""
             window_callback = FFI::Function.new(:bool, [:long, :pointer], {:convention => :stdcall}) do |child_hwnd, _|
@@ -82,6 +86,8 @@ module RAutomation
             found_text
           end
 
+          alias_method :control_text, :window_text
+
           def window_hwnd(locators)
             find_hwnd(locators) do |hwnd|
               window_visible(hwnd) && !window_text(hwnd).empty? &&
@@ -89,6 +95,20 @@ module RAutomation
             end
           end
 
+          def child_window_locators(parent_hwnd, locators)
+            child_hwnd = locators[:hwnd] || child_hwnd(parent_hwnd, locators)
+            if child_hwnd
+              locators.merge!(:hwnd => child_hwnd)
+            else
+              popup_hwnd = get_window(parent_hwnd, Constants::GW_ENABLEDPOPUP)
+              if popup_hwnd != parent_hwnd
+                popup_properties = window_properties(popup_hwnd, locators)
+                locators.merge!(:hwnd => popup_hwnd) if locators_match?(locators, popup_properties)
+              end
+            end
+            locators
+          end
+
           def window_pid(hwnd)
             pid = FFI::MemoryPointer.new :int
             window_thread_process_id(hwnd, pid)
@@ -132,6 +152,8 @@ module RAutomation
             end
           end
 
+          alias_method :child_hwnd, :control_hwnd
+
           def control_value(control_hwnd)
             text_for(control_hwnd)
           end

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

@@ -133,6 +133,14 @@ module RAutomation
           Functions.respond_to?(name) ? Functions.send(name, *args) : super
         end
 
+        # Creates the child window object.
+        # @note This is an Ffi adapter specific method, not part of the public API
+        # @param (see Window#initialize)
+        # @return [RAutomation::Window] child window, popup or regular window.
+        def child(locators)
+          RAutomation::Window.new Functions.child_window_locators(hwnd, locators)
+        end
+        
       end
     end
   end

data/rautomation.gemspec

@@ -5,11 +5,11 @@
 
 Gem::Specification.new do |s|
   s.name = %q{rautomation}
-  s.version = "0.2.1"
+  s.version = "0.3.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-17}
+  s.date = %q{2010-12-18}
   s.description = %q{RAutomation is a small and easy to use library for helping out to automate windows and their controls
 for automated testing.
 

data/spec/button_spec.rb

@@ -6,8 +6,8 @@ describe RAutomation::Button do
             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)
+    expect {RAutomation::Window.new(:title => "non-existing-window").button(:value => "Something")}.
+            to raise_exception(RAutomation::UnknownWindowException)
   end
 
   it "#value" do
@@ -15,8 +15,8 @@ describe RAutomation::Button do
             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)
+    expect {RAutomation::Window.new(:title => SpecHelper::DATA[:window2_title]).button(:value => "non-existent-button").value}.
+            to raise_exception(RAutomation::UnknownButtonException)
   end
 
   it "#exists?" do
@@ -28,8 +28,8 @@ 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)
+    expect {window.button(:value => "non-existent-button").click}.
+            to raise_exception(RAutomation::UnknownButtonException)
 
     button = window.button(:value => SpecHelper::DATA[:window2_button_text])
     button.should exist

data/spec/spec_helper.rb

@@ -3,6 +3,13 @@ require 'rautomation'
 require 'rspec'
 
 module SpecHelper
+  # @private
+  def adapter
+    ENV["RAUTOMATION_ADAPTER"] && ENV["RAUTOMATION_ADAPTER"].to_sym || RAutomation::Adapter::Helper.default_adapter
+  end
+
+  module_function :adapter
+
   # Since adapters are different then the windows to be tested
   # might be different also.
   #
@@ -57,7 +64,7 @@ module SpecHelper
                   # Adapter internal method invocation for getting title of window2
                   :title_proc => lambda {|win| win.window_title(win.hwnd)}
           }
-  }[ENV["RAUTOMATION_ADAPTER"] && ENV["RAUTOMATION_ADAPTER"].to_sym || RAutomation::Adapter::Helper.default_adapter]
+  }[adapter]
 end
 
 RSpec.configure do |config|

data/spec/text_field_spec.rb

@@ -6,9 +6,9 @@ describe RAutomation::TextField do
             text_field(:class => SpecHelper::DATA[:window2_text_field_class]).should exist
 
     RAutomation::Window.wait_timeout = 0.1
-    lambda {RAutomation::Window.new(:title => "non-existent-window").
+    expect {RAutomation::Window.new(:title => "non-existent-window").
             text_field(:class => SpecHelper::DATA[:window2_text_field_class])}.
-            should raise_exception(RAutomation::UnknownWindowException)
+            to raise_exception(RAutomation::UnknownWindowException)
   end
 
   it "#set" do
@@ -16,8 +16,8 @@ describe RAutomation::TextField do
     window.text_field(:class => SpecHelper::DATA[:window2_text_field_class]).set "hello!"
 
     RAutomation::Window.wait_timeout = 0.1
-    lambda {window.text_field(:class => "non-existing-field").set "hello!"}.
-            should raise_exception(RAutomation::UnknownTextFieldException)
+    expect {window.text_field(:class => "non-existing-field").set "hello!"}.
+            to raise_exception(RAutomation::UnknownTextFieldException)
   end
 
   it "#clear"do
@@ -29,8 +29,8 @@ describe RAutomation::TextField do
     field.value.should be_empty
 
     RAutomation::Window.wait_timeout = 0.1
-    lambda {window.text_field(:class => "non-existent-field").clear}.
-            should raise_exception(RAutomation::UnknownTextFieldException)
+    expect {window.text_field(:class => "non-existent-field").clear}.
+            to raise_exception(RAutomation::UnknownTextFieldException)
   end
 
   it "#value" do
@@ -40,8 +40,8 @@ describe RAutomation::TextField do
     field.value.should == "hello!"
 
     RAutomation::Window.wait_timeout = 0.1
-    lambda {window.text_field(:class => "non-existent-field").value}.
-            should raise_exception(RAutomation::UnknownTextFieldException)
+    expect {window.text_field(:class => "non-existent-field").value}.
+            to raise_exception(RAutomation::UnknownTextFieldException)
   end
 
   it "#exists?" do

data/spec/window_spec.rb

@@ -36,8 +36,8 @@ 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)
+    expect {RAutomation::Window.new(:title => "non-existing-window").visible?}.
+            to raise_exception(RAutomation::UnknownWindowException)
   end
 
   it "#present?"do
@@ -48,15 +48,15 @@ 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)
+    expect {RAutomation::Window.new(:title => "non-existing-window").hwnd}.
+            to 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)
+    expect {RAutomation::Window.new(:title => "non-existing-window").title}.
+            to raise_exception(RAutomation::UnknownWindowException)
   end
 
   it "#activate & #active?" do
@@ -71,35 +71,44 @@ 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)
+    expect {RAutomation::Window.new(:title => "non-existing-window").text}.
+            to 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)
+    expect {RAutomation::Window.new(:title => "non-existing-window").maximize}.
+            to raise_exception(RAutomation::UnknownWindowException)
   end
 
-  it "#minimize && #minimized?" do
+  it "#minimize & #minimized?" do
     window = RAutomation::Window.new(:title => SpecHelper::DATA[:window1_title])
     window.should_not be_minimized
     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?}.
-            should raise_exception(RAutomation::UnknownWindowException)
+    expect {RAutomation::Window.new(:title => "non-existing-window").minimize}.
+            to raise_exception(RAutomation::UnknownWindowException)
+    expect {RAutomation::Window.new(:title => "non-existing-window").minimized?}.
+            to raise_exception(RAutomation::UnknownWindowException)
   end
 
   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)
+    expect {RAutomation::Window.new(:title => "non-existing-window").restore}.
+            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
@@ -114,8 +123,8 @@ describe RAutomation::Window do
     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)
+    expect {RAutomation::Window.new(:title => "non-existing-window").send_keys("123")}.
+            to raise_exception(RAutomation::UnknownWindowException)
   end
 
   it "#close" do
@@ -124,7 +133,7 @@ describe RAutomation::Window do
     window.close
     window.should_not exist
 
-    lambda {RAutomation::Window.new(:title => "non-existing-window").close}.
-            should_not raise_exception
+    expect {RAutomation::Window.new(:title => "non-existing-window").close}.
+            to_not raise_exception
   end
 end

metadata

@@ -1,13 +1,13 @@
 --- !ruby/object:Gem::Specification 
 name: rautomation
 version: !ruby/object:Gem::Version 
-  hash: 21
+  hash: 19
   prerelease: false
   segments: 
   - 0
-  - 2
-  - 1
-  version: 0.2.1
+  - 3
+  - 0
+  version: 0.3.0
 platform: ruby
 authors: 
 - Jarmo Pertman
@@ -15,7 +15,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2010-12-17 00:00:00 +02:00
+date: 2010-12-18 00:00:00 +02:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency