rautomation 0.7.3 → 0.8.0

data/lib/rautomation/adapter/ms_uia/menu.rb

@@ -0,0 +1,36 @@
+module RAutomation
+  module Adapter
+    module MsUia
+      class Menu
+        attr_reader :menu_items
+        attr_reader :window
+
+        def initialize(window, locator)
+          @menu_items = [] << locator[:text]
+          @window = window
+        end
+
+        def menu(locator)
+          @menu_items << locator[:text]
+          self
+        end
+
+        def exists?
+          UiaDll::menu_item_exists window.hwnd, *menu_items_arg
+        end
+
+        def open
+          error_info = FFI::MemoryPointer.new :char, 1024
+          UiaDll::select_menu_item window.hwnd, error_info, 1024, *menu_items_arg
+          error = error_info.get_string 0
+          raise error unless error.empty?
+        end
+
+        private
+        def menu_items_arg
+          menu_items.map {|s| [:string, s]}.flatten << :pointer << nil
+        end
+      end
+    end
+  end
+end

data/lib/rautomation/adapter/ms_uia/select_list.rb

@@ -15,23 +15,18 @@ module RAutomation
             @index       = index
           end
 
-          #todo - replace with UIA version
           def selected?
-            selected_idx = Functions.send_message(@select_list.control_hwnd, Constants::CB_GETCURSEL, 0, nil)
-            return false if selected_idx == Constants::CB_ERR
-            @text == Functions.retrieve_combobox_item_text(@select_list.control_hwnd, selected_idx)
+            @index == UiaDll::get_combobox_selected_index(@select_list.control_hwnd)
           end
 
-          #todo - replace with UIA version
           def select
             @select_list.assert_enabled
-            Functions.send_message(@select_list.control_hwnd, Constants::CB_SETCURSEL, @index, nil) != Constants::CB_ERR
+            UiaDll::select_combo_by_index @select_list.control_hwnd, @index
           end
 
           alias_method :set, :select
         end
 
-        #todo - replace with UIA version
         def initialize(window, locators)
           super
           @hwnd = Functions.control_hwnd(@window.hwnd, @locators)
@@ -42,7 +37,6 @@ module RAutomation
           UiaDll::set_value(list, value)
         end
 
-        #todo - replace with UIA version
         def options(options = {})
           items = []
 
@@ -64,7 +58,6 @@ module RAutomation
           selected_option ? selected_option.text : ""
         end
 
-        #todo - replace with UIA version
         def option(options)
           item_count.times do |item_no|
             item = Functions.retrieve_combobox_item_text(@hwnd, item_no)
@@ -79,7 +72,7 @@ module RAutomation
         end
 
         def select(index)
-          Functions.send_message(@hwnd, Constants::CB_SETCURSEL, index, nil) != Constants::CB_ERR
+          UiaDll::select_combo_by_index @hwnd, index
         end
 
         def list_item_height
@@ -110,9 +103,8 @@ module RAutomation
 
         private
 
-        #todo - replace with UIA version
         def item_count
-          Functions.send_message(@hwnd, Constants::CB_GETCOUNT, 0, nil)
+          UiaDll::get_combobox_count(@hwnd)
         end
 
       end

data/lib/rautomation/adapter/ms_uia/table.rb

@@ -1,15 +1,96 @@
 module RAutomation
   module Adapter
     module MsUia
+      class Cell
+        include Locators
+        attr_reader :row, :column, :hwnd
+
+        def initialize(window, locators)
+          @hwnd = window.hwnd
+          @locators = extract(locators)
+          @row = window.row
+          @column = @locators[:index] || 0
+        end
+
+        def exists?
+          UiaDll::data_item_exists hwnd, row, column
+        end
+
+        def value
+          UiaDll::cell_value_at hwnd, row, column
+        end
+
+        alias_method :text, :value
+        alias_method :index, :column
+      end
+
+      class Row
+        include Locators
+        extend ElementCollections
+        attr_reader :hwnd
+
+        has_many :cells
+
+        def cells(locators={})
+          Cells.new(self, locators).select do |cell|
+            Row.locators_match? locators, cell
+          end
+        end
+
+        def cell(locators={})
+          cells(locators).first
+        end
+
+        def initialize(window, locators)
+          @hwnd = window.hwnd
+          @locators = extract(locators)
+        end
+
+        def index
+          @locators[:index] || 0
+        end
+
+        def value
+          UiaDll::cell_value_at @hwnd, @locators[:index]
+        end
+
+        def exists?
+          UiaDll::data_item_exists(@hwnd, @locators[:index])
+        end
+
+        def self.locators_match?(locators, item)
+          locators.all? do |locator, value|
+            return item.value =~ value if value.is_a? Regexp
+            return item.send(locator) == value
+          end
+        end
+
+        alias_method :text, :value
+        alias_method :row, :index
+      end
+
       class Table < Control
         include WaitHelper
         include Locators
+        extend ElementCollections
+
+        has_many :rows
+
+        def row(locators={})
+          rows(locators).first
+        end
+
+        def rows(locators={})
+          Rows.new(self, locators).select do |row|
+            Row.locators_match? locators, row
+          end
+        end
 
         def strings
           rows = []
           header_columns = []
 
-          raise "Not a list control" unless UiaDll::current_control_type(uia_element) == Constants::UIA_LIST_CONTROL_TYPE
+          raise "Not a list control" unless of_type_table?
 
 
           children_count = count_children(uia_element)
@@ -49,27 +130,25 @@ module RAutomation
 #        end
 
         def select(index)
-          children = FFI::MemoryPointer.new :pointer, row_count
-
-          length = UiaDll::find_children(uia_element, children)
-
-          target_element = children.read_array_of_pointer(length)[index]
-
-          UiaDll::select(target_element)
+          UiaDll::select_data_item hwnd, index - 1
         end
 
         #todo - replace with UIA version
         def selected?(row)
-          state = Functions.get_table_row_state(Window.oleacc_module_handle, Functions.control_hwnd(@window.hwnd, @locators), row)
+          state = Functions.get_table_row_state(Window.oleacc_module_handle, hwnd, row)
           state & Constants::STATE_SYSTEM_SELECTED != 0
         end
 
         def row_count
-          UiaDll::find_children(uia_element, nil)
+          UiaDll::get_data_item_count hwnd
         end
 
         def exist?
-          super && matches_type?(Constants::UIA_LIST_CONTROL_TYPE)
+          super && of_type_table?
+        end
+
+        def of_type_table?
+          matches_type?(Constants::UIA_LIST_CONTROL_TYPE) || matches_type?(Constants::UIA_DATA_GRID_CONTROL_TYPE)
         end
 
         alias_method :exists?, :exist?

data/lib/rautomation/adapter/ms_uia/uia_dll.rb

@@ -52,12 +52,58 @@ module RAutomation
                         [:pointer], :bool
         attach_function :select, :RA_Select,
                         [:pointer], :int
-        attach_function :set_value, :RA_Set_Value,
-                        [:pointer, :pointer], :int
         attach_function :find_window_by_pid, :RA_FindWindowByPID,
                         [:int], :pointer
         attach_function :current_process_id, :RA_GetCurrentProcessId,
                         [:pointer], :int
+        attach_function :select_combo_by_index, :RA_SelectComboByIndex,
+                        [:long, :int], :bool
+        attach_function :set_value, :RA_SelectComboByValue,
+                        [:pointer, :pointer], :int
+        attach_function :select_menu_item, :RA_SelectMenuItem,
+                        [:long, :pointer, :int, :varargs], :void
+        attach_function :menu_item_exists, :RA_MenuItemExists,
+                        [:long, :varargs], :bool
+        attach_function :get_combobox_count, :RA_GetComboOptionsCount,
+                        [:long], :int
+        attach_function :get_combobox_value, :RA_GetComboValueByIndex,
+                        [:long, :int, :pointer, :int], :bool
+        attach_function :get_combobox_selected_index, :RA_GetSelectedComboIndex,
+                        [:long], :int
+        attach_function :get_data_item_count, :RA_GetDataItemCount,
+                        [:long], :int
+        attach_function :select_data_item, :RA_SelectDataItem,
+                        [:long, :int], :void
+        attach_function :expand_by_value, :RA_ExpandItemByValue,
+                        [:long, :string], :void
+        attach_function :expand_by_index, :RA_ExpandItemByIndex,
+                        [:long, :int], :void
+        attach_function :collapse_by_value, :RA_CollapseItemByValue,
+                        [:long, :string], :void
+        attach_function :collapse_by_index, :RA_CollapseItemByIndex,
+                        [:long, :int], :void
+        attach_function :data_item_exists_by_value, :RA_DataItemExistsByValue,
+                        [:long, :string], :bool
+        attach_function :RA_DataItemExists,
+                        [:long, :int, :int], :bool
+                        
+        attach_function :RA_CellValueAt,
+                        [:long, :int, :int, :pointer, :int], :void
+
+        attach_function :control_click, :RA_Click,
+                        [:long, :pointer, :int], :void
+        attach_function :control_mouse_click, :RA_PointAndClick,
+                        [:long, :pointer, :int], :void
+
+        def self.cell_value_at(hwnd, row, column=0)
+          string = FFI::MemoryPointer.new :char, 1024
+          RA_CellValueAt hwnd, row, column, string, 1024
+          string.read_string
+        end
+
+        def self.data_item_exists(hwnd, row, column=0)
+          RA_DataItemExists hwnd, row, column
+        end
       end
     end
   end

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

@@ -184,6 +184,12 @@ module RAutomation
           TextField.new(self, locator)
         end
 
+        # Returns a {Menu} object use to build a path to a menu item to open.
+        # @param [Hash] locator for the {Menu}.  Only :text is allowed.
+        def menu(locator)
+          Menu.new(self, locator)
+        end
+
         # Redirects all method calls not part of the public API to the {Functions} directly.
         # @see RAutomation::Window#method_missing
         def method_missing(name, *args)
@@ -369,7 +375,6 @@ module RAutomation
           release_key key
           key
         end
-
       end
     end
   end

data/lib/rautomation/adapter/ms_uia.rb

@@ -14,6 +14,7 @@ require File.dirname(__FILE__) + "/ms_uia/button_helper"
 require File.dirname(__FILE__) + "/ms_uia/control"
 require File.dirname(__FILE__) + "/ms_uia/button"
 require File.dirname(__FILE__) + "/ms_uia/checkbox"
+require File.dirname(__FILE__) + "/ms_uia/menu"
 require File.dirname(__FILE__) + "/ms_uia/radio"
 require File.dirname(__FILE__) + "/ms_uia/text_field"
 require File.dirname(__FILE__) + "/ms_uia/select_list"

data/spec/adapter/autoit/mouse_spec.rb

@@ -10,7 +10,7 @@ describe "AutoIt::Mouse", :if => SpecHelper.adapter == :autoit do
 
     window.maximize
     mouse = window.mouse
-    mouse.move :x => 60, :y => 45
+    mouse.move :x => 60, :y => 65
     mouse.click
 
     RAutomation::WaitHelper.wait_until {popup.present?}
@@ -33,7 +33,7 @@ describe "AutoIt::Mouse", :if => SpecHelper.adapter == :autoit do
     text_field.value.should == "start string"
 
     mouse = window.mouse
-    mouse.move :x => 146, :y => 103
+    mouse.move :x => 146, :y => 125
     mouse.press
     mouse.move :x => 194
     mouse.release

data/spec/adapter/ms_uia/functions_spec.rb

@@ -0,0 +1,39 @@
+require 'spec_helper'
+
+describe "MsUia::Functions", :if => SpecHelper.adapter == :ms_uia do
+  context "working with expandable / collapsable items" do
+    let(:tree_view) { RAutomation::Window.new(:title => "MainFormWindow").select_list(:id => "treeView") }
+
+    def options
+      tree_view.options.map &:text
+    end
+
+    it "can be expanded by value" do
+      options.should eq ["Parent One", "Parent Two"]
+      tree_view.expand "Parent One"
+      options.should eq ["Parent One", "Child 1", "Child 2", "Parent Two"]
+    end
+
+    it "can be expanded by index" do
+      options.should eq ["Parent One", "Parent Two"]
+      tree_view.expand 0
+      tree_view.expand 2
+      options.should eq ["Parent One", "Child 1", "Child 2", "Grandchild 1", "Parent Two"]
+    end
+
+    it "can be collapsed by value" do
+      tree_view.expand "Parent One"
+      options.should eq ["Parent One", "Child 1", "Child 2", "Parent Two"]
+      tree_view.collapse "Parent One"
+      options.should eq ["Parent One", "Parent Two"]
+    end
+
+    it "can be collapsed by index" do
+      tree_view.expand 0
+      options.should eq ["Parent One", "Child 1", "Child 2", "Parent Two"]
+      tree_view.collapse 0
+      options.should eq ["Parent One", "Parent Two"]
+    end
+  end
+
+end

data/spec/adapter/ms_uia/select_list_spec.rb

@@ -72,6 +72,32 @@ describe "MsUia::SelectList", :if => SpecHelper.adapter == :ms_uia do
     lambda { select_list.option(:text => "Apple").set }.should raise_error
   end
 
+  it "fires change event when the value is set" do
+
+    select_list = RAutomation::Window.new(:title => "MainFormWindow").select_list(:id => "FruitsComboBox")
+
+    select_list.option(:text => "Apple").should_not be_selected
+    select_list.set("Apple")
+    select_list.option(:text => "Apple").should be_selected
+
+    label = RAutomation::Window.new(:title => "MainFormWindow").label(:id => "fruitsLabel")
+    RAutomation::WaitHelper.wait_until { label.exist? }
+    label.value.should == "Apple"
+  end
+
+  it "fires change event when the index changes" do
+
+    select_list = RAutomation::Window.new(:title => "MainFormWindow").select_list(:id => "FruitsComboBox")
+    label = RAutomation::Window.new(:title => "MainFormWindow").label(:id => "fruitsLabel")
+
+    select_list.options[4].select
+    select_list.option(:text => "Passion Fruit").should be_selected
+    label.value.should == "Passion Fruit"
+
+    select_list.select 3
+    select_list.option(:text => "Orange").should be_selected
+    label.value.should == "Orange"
+  end
 
 #  it "control by focus" do
 #    window      = RAutomation::Window.new(:title => /MainFormWindow/i)
@@ -93,17 +119,4 @@ describe "MsUia::SelectList", :if => SpecHelper.adapter == :ms_uia do
 #    sleep 10
 #    box1.should == box2
 #  end
-
-#  it "fires change event when selected" do
-#
-#    select_list = RAutomation::Window.new(:title => "MainFormWindow").select_list(:id => "FruitsComboBox")
-#
-#    select_list.option(:text => "Apple").should_not be_selected
-#    select_list.set("Apple")
-#    select_list.option(:text => "Apple").should be_selected
-#
-#    label = RAutomation::Window.new(:title => "MainFormWindow").label(:id => "fruitsLabel")
-#    sleep 1
-#    label.value.should == "Apple"
-#  end
 end

data/spec/adapter/ms_uia/table_spec.rb

@@ -40,10 +40,104 @@ describe "MsUia::Table", :if => SpecHelper.adapter == :ms_uia do
   it "#select" do
     table = RAutomation::Window.new(:title => "DataEntryForm").table(:id => "personListView")
 
-    table.selected?(2).should == false
+    table.select(1)
+    table.should_not be_selected(2)
 
     table.select(2)
-    table.selected?(2).should == true
+    table.should be_selected(2)
+  end
+
+  it "#row_count" do
+    table = RAutomation::Window.new(:title => "DataEntryForm").table(:id => "personListView")
+    table.row_count.should eq(2)
+  end
+
+  context "#rows" do
+    let(:table) { RAutomation::Window.new(:title => "DataEntryForm").table(:id => "personListView") }
+
+    it "has rows" do
+      table.rows.size.should eq 2
+    end
+
+    it "have values" do
+      table.rows.map(&:value).should eq ["John Doe", "Anna Doe"]
+    end
+
+    it "values are also text" do
+      table.rows.map(&:text).should eq ["John Doe", "Anna Doe"]
+    end
+
+    context "locators" do
+      it "can locate by text" do
+        table.rows(:text => "Anna Doe").size.should eq 1
+      end
+
+      it "can locate by regex" do
+        table.rows(:text => /Doe/).size.should eq 2
+      end
+
+      it "can locate by index" do
+        table.rows(:index => 1).first.text.should eq "Anna Doe"
+      end
+
+      it "an index is also a row" do
+        table.rows(:row => 1).first.text.should eq "Anna Doe"
+      end
+    end
+
+    context "singular row" do
+      it "grabs the first by default" do
+        table.row.text.should eq "John Doe"
+      end
+
+      it "can haz locators too" do
+        table.row(:text => "Anna Doe").text.should eq "Anna Doe"
+      end
+    end
+
+    context "Row#cells" do
+      let(:row) { table.row }
+
+      it "has cells" do
+        row.cells.size.should eq 3
+      end
+      
+      it "cells have values" do
+        row.cells.map(&:value).should eq ["John Doe", "12/15/1967", "FL"]
+      end
+
+      it "values are also text" do
+        row.cells.map(&:text).should eq ["John Doe", "12/15/1967", "FL"]
+      end
+
+      context "locators" do
+        it "can locate by text" do
+          row.cells(:text => "FL").size.should eq 1
+        end
+
+        it "can locate by regex" do
+          row.cells(:text => /[JF]/).size.should eq 2
+        end
+
+        it "can locate by index" do
+          row.cells(:index => 1).first.text.should eq "12/15/1967"
+        end
+
+        it "an index is also a column" do
+          row.cells(:column => 1).first.text.should eq "12/15/1967"
+        end
+      end
+
+      context "singular cell" do
+        it "grabs the first by default" do
+          row.cell.text.should eq "John Doe"
+        end
+
+        it "can haz locators too" do
+          row.cell(:text => "FL").text.should eq "FL"
+        end
+      end
+    end
   end
 
 end

data/spec/adapter/ms_uia/window_spec.rb

@@ -40,6 +40,43 @@ describe "MsUia::Window", :if => SpecHelper.adapter == :ms_uia do
     end
   end
 
+  context "menu items" do
+    let(:about_box) { RAutomation::Window.new :title => "About" }
+
+    it "can select menu items" do
+      window.menu(:text => "File").menu(:text => "About").open
+      RAutomation::WaitHelper.wait_until { about_box.present? }
+    end
+
+    it "can select deep menu items" do
+      window.menu(:text => "File")
+            .menu(:text => "Roundabout Way")
+            .menu(:text => "About").open
+      RAutomation::WaitHelper.wait_until { about_box.present? }
+    end
+
+    it "raises when errors occur" do
+      lambda { window.menu(:text => "File").menu(:text => "Does Not Exist").open}.should raise_error
+    end
+
+    it "indicates if the menu item does not exist" do
+      begin
+        window.menu(:text => "File").menu(:text => "Should Not Exist").open
+        fail "Should have failed to find the menu item"
+      rescue Exception => e
+        e.message.should match /MenuItem with the text "Should Not Exist" does not exist/
+      end
+    end
+
+    it "knows when menu items exist" do
+      window.menu(:text => "File").menu(:text => "About").should exist
+    end
+
+    it "knows when menu items do not exist" do
+      window.menu(:text => "File").menu(:text => "Missing").should_not exist
+    end
+  end
+
 =begin
   it "control by focus" do
     window = RAutomation::Window.new(:title => /MainFormWindow/i)
@@ -54,17 +91,6 @@ describe "MsUia::Window", :if => SpecHelper.adapter == :ms_uia do
     box1.should == box2
   end
 
-  it "#child" do
-    window = RAutomation::Window.new(:title => /MainFormWindow/i)
-    window.should exist
-
-    # buttons are windows too. so let's find the button for now
-    child = window.child(:title => /About/i)
-    child.should exist
-    child.title.should == "&About"
-    #    child.text.should include "About"
-  end
-
   it "send tab keystrokes to move focus between elements" do
     window = RAutomation::Window.new(:title => /MainFormWindow/i)
     window.button(:value => "&About").set_focus

data/spec/adapter/win_32/mouse_spec.rb

@@ -10,7 +10,7 @@ describe "Win32::Mouse", :if => SpecHelper.adapter == :win_32 do
 
     window.maximize
     mouse = window.mouse
-    mouse.move :x => 60, :y => 45
+    mouse.move :x => 60, :y => 65
     mouse.click
 
     RAutomation::WaitHelper.wait_until {popup.present?}
@@ -33,7 +33,7 @@ describe "Win32::Mouse", :if => SpecHelper.adapter == :win_32 do
     text_field.value.should == "start string"
 
     mouse = window.mouse
-    mouse.move :x => 146, :y => 103
+    mouse.move :x => 146, :y => 125
     mouse.press
     mouse.move :x => 194
     mouse.release

data/spec/adapter/win_32/window_spec.rb

@@ -3,15 +3,6 @@ require "spec_helper"
 describe "Win32::Window", :if => SpecHelper.adapter == :win_32 do
   let(:window) {RAutomation::Window.new(:title => /MainFormWindow/i)}
 
-  it "#child" do
-    window.should exist
-
-    # buttons are windows too. so let's find the button for now
-    child = window.child(:title => /About/i)
-    child.should exist
-    child.title.should == "&About"
-  end
-
   context "#send_keys" do
     it "send tab keystrokes to move focus between elements" do
       window.button(:value => "&About").focus

data/spec/spec_helper.rb

@@ -28,7 +28,7 @@ module SpecHelper
           :autoit => {
                   # Path to some binary, which opens up a window, what can be
                   # minimized, maximized, activated, closed and etc.
-                  :window1 => "ext\\WindowsForms\\bin\\WindowsForms.exe",
+                  :window1 => "ext\\WindowsForms\\Release\\WindowsForms.exe",
                   :window2 => "calc",
                   :window2_title => /calc/i,
                   # Window 1 title, has to be a Regexp.
@@ -53,7 +53,7 @@ module SpecHelper
           :win_32 => {
                   # Path to some binary, which opens up a window, what can be
                   # minimized, maximized, activated, closed and etc.
-                  :window1 => "ext\\WindowsForms\\bin\\WindowsForms.exe",
+                  :window1 => "ext\\WindowsForms\\Release\\WindowsForms.exe",
                   :window2 => "calc",
                   :window2_title => /calc/i,
                   # Window 1 title, has to be a Regexp.
@@ -79,7 +79,7 @@ module SpecHelper
           :ms_uia => {
                   # Path to some binary, which opens up a window, what can be
                   # minimized, maximized, activated, closed and etc.
-                  :window1 => "ext\\WindowsForms\\bin\\WindowsForms.exe",
+                  :window1 => "ext\\WindowsForms\\Release\\WindowsForms.exe",
                   :window2 => "calc",
                   :window2_title => /calc/i,
                   # Window 1 title, has to be a Regexp.