rautomation 0.4.0 → 0.5.1

data/lib/rautomation/window.rb

@@ -1,13 +1,33 @@
 module RAutomation
-  class UnknownWindowException < RuntimeError
+  class UnknownElementException < RuntimeError
   end
-  class UnknownButtonException < RuntimeError
+  class UnknownWindowException < UnknownElementException
   end
-  class UnknownTextFieldException < RuntimeError
+  class UnknownButtonException < UnknownElementException
+  end
+  class UnknownTextFieldException < UnknownElementException
   end
 
   class Window
     include Adapter::Helper
+    extend ElementCollections
+
+    has_many :windows, :buttons, :text_fields
+
+    class << self
+      # @return [Windows] all windows. 
+      def windows
+        Windows.new(nil, {})
+      end
+    end
+    
+    # Retrieves all windows with similar locators to the current window.
+    # @param locators (see #initialize) 
+    # @return [Windows] all windows matching current window's _locators_ if no
+    #   explicit locators specified or windows matching the specified _locators_.
+    def windows(locators = @window.locators)
+      Windows.new(nil, locators)
+    end
 
     # Currently used {Adapter}.
     attr_reader :adapter
@@ -38,8 +58,9 @@ module RAutomation
     # __RAUTOMATION_ADAPTER__
     #
     # @note This constructor doesn't check for window's existance.
-    # @note Only visible Windows are supported.
-    # @param [Hash] locators for the window.
+    # @note Only visible windows are supported.
+    # @note If given _locators_ include :hwnd then every other possible _locator_ is ignored.
+    # @param [Hash] locators locators for the window.
     def initialize(locators)
       @adapter = locators.delete(:adapter) || ENV["RAUTOMATION_ADAPTER"] && ENV["RAUTOMATION_ADAPTER"].to_sym || default_adapter
       @window = Adapter.const_get(normalize(@adapter)).const_get(:Window).new(locators)
@@ -60,15 +81,18 @@ module RAutomation
       def wait_timeout
         @@wait_timeout
       end
+
     end
 
     # @return [Fixnum] handle of the window which is used internally for other methods.
+    # @raise [UnknownWindowException] if the window doesn't exist.
     def hwnd
       wait_until_exists
       @window.hwnd
     end
 
     # @return [Fixnum] process identifier (PID) of the window.
+    # @raise [UnknownWindowException] if the window doesn't exist.
     def pid
       wait_until_exists
       @window.pid

data/spec/adapter/win_ffi/checkbox_spec.rb

@@ -0,0 +1,29 @@
+require 'spec_helper'
+
+describe "WinFfi::Checkbox", :if => SpecHelper.adapter == :win_ffi do
+  it "#checkbox" do
+    RAutomation::Window.new(:title => "MainFormWindow").checkbox(:value => "checkBox").should exist
+
+    RAutomation::Window.wait_timeout = 0.1
+    expect {RAutomation::Window.new(:title => "non-existing-window").checkbox(:value => "Something")}.
+      to raise_exception(RAutomation::UnknownWindowException)
+  end
+
+  it "#set? & #set" do
+    checkbox = RAutomation::Window.new(:title => "MainFormWindow").checkbox(:value => "checkBox")
+    checkbox.should_not be_set
+
+    checkbox.set
+    checkbox.should be_set
+  end
+
+  it "#clear" do
+    checkbox = RAutomation::Window.new(:title => "MainFormWindow").checkbox(:value => "checkBox")
+    checkbox.set
+    checkbox.should be_set
+
+    checkbox.clear
+    checkbox.should_not be_set
+  end
+
+end

data/spec/adapter/win_ffi/radio_spec.rb

@@ -0,0 +1,21 @@
+require 'spec_helper'
+
+describe "WinFfi::RadioButton", :if => SpecHelper.adapter == :win_ffi do
+  it "#exist?" do
+    RAutomation::Window.new(:title => "MainFormWindow").radio(:value => "Option 1").should exist
+
+    RAutomation::Window.wait_timeout = 0.1
+    expect {RAutomation::Window.new(:title => "non-existent-window").
+            radio(:value => "Option 1")}.
+            to raise_exception(RAutomation::UnknownWindowException)
+  end
+
+  it "#set? & #set" do
+    radio = RAutomation::Window.new(:title => "MainFormWindow").radio(:value => "Option 1")
+    radio.should_not be_set
+
+    radio.set
+    radio.should be_set
+  end
+
+end

data/spec/adapter/win_ffi/select_list_spec.rb

@@ -0,0 +1,41 @@
+require 'spec_helper'
+
+describe "WinFfi::SelectList", :if => SpecHelper.adapter == :win_ffi do
+  it "#select_list" do
+    RAutomation::Window.new(:title => "MainFormWindow").select_list(:class => /COMBOBOX/i).should exist
+
+    RAutomation::Window.wait_timeout = 0.1
+    expect {RAutomation::Window.new(:title => "non-existent-window").
+            select_list(:class => /COMBOBOX/i)}.
+            to raise_exception(RAutomation::UnknownWindowException)
+  end
+
+  it "#options" do
+    select_list = RAutomation::Window.new(:title => "MainFormWindow").select_list(:class => /COMBOBOX/i)
+    select_list.options.size.should == 5
+
+    expected_options = ["Apple", "Caimito", "Coconut", "Orange", "Passion Fruit"]
+    select_list.options.map {|option| option.text}.should == expected_options
+  end
+
+  it "#selected? & #select" do
+    select_list = RAutomation::Window.new(:title => "MainFormWindow").select_list(:class => /COMBOBOX/i)
+    select_list.options(:text => "Apple")[0].should_not be_selected
+    select_list.options(:text => "Apple")[0].select.should be_true
+    select_list.options(:text => "Apple")[0].should be_selected
+  end
+
+  it "#value" do
+    select_list = RAutomation::Window.new(:title => "MainFormWindow").select_list(:class => /COMBOBOX/i)
+
+    #default empty state
+    select_list.value.should == ""
+
+    select_list.options(:text => "Apple")[0].select
+    select_list.value.should == "Apple"
+
+    select_list.options(:text => "Caimito")[0].select
+    select_list.value.should == "Caimito"
+  end
+
+end

data/spec/adapter/win_ffi/table_spec.rb

@@ -0,0 +1,20 @@
+require 'spec_helper'
+
+describe "WinFfi::Table", :if => SpecHelper.adapter == :win_ffi do
+  before :each do
+    window = RAutomation::Window.new(:title => "MainFormWindow")
+    window.button(:value => "Data Entry Form").click { RAutomation::Window.new(:title => "DataEntryForm").exists? }
+  end
+
+  it "#table" do
+    table = RAutomation::Window.new(:title => "DataEntryForm").table(:class => /SysListView32/i)
+    table.should exist
+    
+    RAutomation::Window.wait_timeout = 0.1
+    expect {RAutomation::Window.new(:title => "non-existent-window").
+            table(:class => /SysListView32/i)}.
+            to raise_exception(RAutomation::UnknownWindowException)
+  end
+
+end
+

data/spec/adapter/win_ffi/window_spec.rb

@@ -1,20 +1,14 @@
 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 = RAutomation::Window.new(:title => /MainFormWindow/i)
     window.should exist
-    child = window.child(:title => SpecHelper::DATA[:window2_title])
+
+    # buttons are windows too. so let's find the button for now
+    child = window.child(:title => /About/i)
     child.should exist
-    child.title.should == SpecHelper::DATA[:window2_title]
-    child.text.should include(SpecHelper::DATA[:window2_text])
+    child.title.should == "&About"
+    #    child.text.should include "About"
   end
 end

data/spec/button_spec.rb

@@ -2,57 +2,65 @@ require 'spec_helper'
 
 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.new(:title => SpecHelper::DATA[:window1_title]).
+      button(:value => "Close").should exist
 
     RAutomation::Window.wait_timeout = 0.1
     expect {RAutomation::Window.new(:title => "non-existing-window").button(:value => "Something")}.
-            to raise_exception(RAutomation::UnknownWindowException)
+      to raise_exception(RAutomation::UnknownWindowException)
   end
 
   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.new(:title => SpecHelper::DATA[:window1_title]).
+      button(:value => "Close").value.should == "Close"
 
     RAutomation::Window.wait_timeout = 0.1
-    expect {RAutomation::Window.new(:title => SpecHelper::DATA[:window2_title]).button(:value => "non-existent-button").value}.
-            to raise_exception(RAutomation::UnknownButtonException)
+    expect {RAutomation::Window.new(:title => SpecHelper::DATA[:window1_title]).button(:value => "non-existent-button").value}.
+      to raise_exception(RAutomation::UnknownButtonException)
   end
 
   it "#exists?" do
-    window = RAutomation::Window.new(:title => SpecHelper::DATA[:window2_title])
-    window.button(:value => SpecHelper::DATA[:window2_button_text]).should exist
+    window = RAutomation::Window.new(:title => SpecHelper::DATA[:window1_title])
+    window.button(:value => "Close").should exist
     window.button(:value => "non-existent-button").should_not exist
   end
 
-  it "#click" do
-    window = RAutomation::Window.new(:title => SpecHelper::DATA[:window2_title])
+  it "clicking non-existing button raises exception" do
+    window = RAutomation::Window.new(:title => SpecHelper::DATA[:window1_title])
     RAutomation::Window.wait_timeout = 0.1
     expect {window.button(:value => "non-existent-button").click}.
-            to raise_exception(RAutomation::UnknownButtonException)
+      to raise_exception(RAutomation::UnknownButtonException)
+  end
+
+  it "#click" do
+    window = RAutomation::Window.new(:title => SpecHelper::DATA[:window1_title])
 
-    RAutomation::Window.wait_timeout = 60
-    button = window.button(:value => SpecHelper::DATA[:window2_button_text])
+    button = window.button(:value => "Close")
     button.should exist
     button.click
+
     button.should_not exist
     window.should_not exist
   end
 
-  it "#click with a block for defining successful click" do
-    window = RAutomation::Window.new(:title => SpecHelper::DATA[:window2_title])
+  it "#click with a block for defining successful click returning false raises a TimeoutError" do
+    window = RAutomation::Window.new(:title => SpecHelper::DATA[:window1_title])
     RAutomation::Window.wait_timeout = 5
-    button = window.button(:value => SpecHelper::DATA[:window2_button_text])
+    button = window.button(:value => "Close")
     expect {button.click {false}}.
-            to raise_exception(RAutomation::WaitHelper::TimeoutError)
+      to raise_exception(RAutomation::WaitHelper::TimeoutError)
+
     button.should_not exist
     window.should_not exist
+  end
 
+  it "#click with a block for defining successful click returning true" do
     RAutomation::Window.wait_timeout = 10
-    window = RAutomation::Window.new(:title => SpecHelper::DATA[:window2_title])
-    button = window.button(:value => SpecHelper::DATA[:window2_button_text])
+    window = RAutomation::Window.new(:title => SpecHelper::DATA[:window1_title])
+    button = window.button(:value => "Close")
     button.should exist
     button.click {|button| !button.exists? && !window.exists?}
+
     button.should_not exist
     window.should_not exist
   end

data/spec/buttons_spec.rb

@@ -0,0 +1,21 @@
+require 'spec_helper'
+
+describe RAutomation::Buttons do
+
+  it "Window#buttons returns all buttons" do
+    SpecHelper::navigate_to_simple_elements
+
+    buttons = RAutomation::Window.new(:title => "SimpleElementsForm").buttons
+    buttons.size.should == 2
+    buttons.find_all {|b| b.value == 'button1'}.size.should == 1
+  end
+
+  it "Window#buttons with parameters returns all matching buttons" do
+    SpecHelper::navigate_to_simple_elements
+
+    buttons = RAutomation::Window.new(:title => "SimpleElementsForm").buttons(:value => 'button1')
+    buttons.size.should == 1
+    buttons.first.value.should == 'button1'
+  end
+
+end

data/spec/spec_helper.rb

@@ -8,7 +8,12 @@ module SpecHelper
     ENV["RAUTOMATION_ADAPTER"] && ENV["RAUTOMATION_ADAPTER"].to_sym || RAutomation::Adapter::Helper.default_adapter
   end
 
-  module_function :adapter
+  def navigate_to_simple_elements
+    main_window = RAutomation::Window.new(:title => "MainFormWindow")
+    main_window.button(:value => "Simple Elements").click { RAutomation::Window.new(:title => "SimpleElementsForm").present? }
+  end
+
+  module_function :adapter, :navigate_to_simple_elements
 
   # Since adapters are different then the windows to be tested
   # might be different also.
@@ -23,62 +28,66 @@ module SpecHelper
           :autoit => {
                   # Path to some binary, which opens up a window, what can be
                   # minimized, maximized, activated, closed and etc.
-                  :window1 => "mspaint",
+                  :window1 => "ext\\WindowsForms\\bin\\WindowsForms.exe",
+                  :window2 => "calc",
+                  :window2_title => /calc/i,
                   # Window 1 title, has to be a Regexp.
-                  :window1_title => /untitled - paint/i,
-                  # Path to some browser's binary.
-                  :window2 => '"c:\\program files\\internet explorer\\iexplore.exe"',
-                  # Window 2 title, has to be a String.
-                  :window2_title => "Explorer User Prompt",
-                  # Window 2 should have this text on it.
-                  :window2_text => "Where do you want to go today?",
+                  :window1_title => /FormWindow/i,
+                  :window1_full_title => 'MainFormWindow',
+                  # Window 1 should have this text on it.
+                  :window1_text => "This is a sample text",
                   # When sending ENTER on Window 2, then the window OK button should be pressed and Window 2 should be closed.
-                  :window2_send_keys => "{ENTER}",
-                  # Window 2 should have a button with the following text.
-                  :window2_button_text => "OK",
-                  # Window 2 should have a text field with the specified class name.
-                  :window2_text_field_class => "Edit",
+                  # "A" key
+                  :window1_send_keys => "A",
+                  :proc_after_send_keys => lambda do
+                    about_box = RAutomation::Window.new(:title => /About/i)
+                    RAutomation::WaitHelper.wait_until {about_box.present?}
+                  end,
+                  # Window 1 should have a button with the following text.
+                  :window1_button_text => "&About",
+                  # Window 1 should have a text field with the specified class name.
+                  :window1_text_field_class => "Edit",
                   # Adapter internal method invocation for getting title of window2
-                  :title_proc => lambda {|win| win.WinGetTitle("[TITLE:Explorer User Prompt]")}
+                  :title_proc => lambda {|win| win.WinGetTitle("[TITLE:MainFormWindow]")}
           },
-          # This adapter needs Windows OS with Internet Explorer installed into 'c:\program files\internet explorer'.
           :win_ffi => {
                   # Path to some binary, which opens up a window, what can be
                   # minimized, maximized, activated, closed and etc.
-                  :window1 => "mspaint",
+                  :window1 => "ext\\WindowsForms\\bin\\WindowsForms.exe",
+                  :window2 => "calc",
+                  :window2_title => /calc/i,
                   # Window 1 title, has to be a Regexp.
-                  :window1_title => /untitled - paint/i,
-                  # Path to some browser's binary.
-                  :window2 => '"c:\\program files\\internet explorer\\iexplore.exe"',
-                  # Window 2 title, has to be a String.
-                  :window2_title => "Explorer User Prompt",
-                  # Window 2 should have this text on it.
-                  :window2_text => "Where do you want to go today?",
+                  :window1_title => /FormWindow/i,
+                  :window1_full_title => 'MainFormWindow',
+                  # Window 1 should have this text on it.
+                  :window1_text => "This is a sample text",
                   # When sending ENTER on Window 2, then the window OK button should be pressed and Window 2 should be closed.
-                  # VK_RETURN
-                  :window2_send_keys => 0xD,
-                  # Window 2 should have a button with the following text.
-                  :window2_button_text => "OK",
-                  # Window 2 should have a text field with the specified class name.
-                  :window2_text_field_class => "Edit",
+                  # "A" key
+                  :window1_send_keys => 0x41,
+                  :proc_after_send_keys => lambda do
+                    about_box = RAutomation::Window.new(:title => /About/i)
+                    RAutomation::WaitHelper.wait_until {about_box.present?}
+                  end,
+                  # Window 1 should have a button with the following text.
+                  :window1_button_text => "&About",
+                  # Window 1 should have a text field with the specified class name.
+                  :window1_text_field_class => "Edit",
                   # Adapter internal method invocation for getting title of window2
                   :title_proc => lambda {|win| win.window_title(win.hwnd)}
           }
   }[adapter]
 end
 
-RSpec.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
-  end
 
+RSpec.configure do |config|
   config.before(:each) do
     RAutomation::Window.wait_timeout = 60
+
+    @pid1 = IO.popen(SpecHelper::DATA[:window1]).pid
+    RAutomation::WaitHelper.wait_until {RAutomation::Window.new(:pid => @pid1).present?}
   end
 
-  config.after(:all) do
+  config.after(:each) do
     Process.kill(9, @pid1) rescue nil
-    Process.kill(9, @pid2) rescue nil
   end
 end

data/spec/text_field_spec.rb

@@ -2,18 +2,18 @@ require 'spec_helper'
 
 describe RAutomation::TextField do
   it "#text_field" do
-    RAutomation::Window.new(:title => SpecHelper::DATA[:window2_title]).
-            text_field(:class => SpecHelper::DATA[:window2_text_field_class]).should exist
+    RAutomation::Window.new(:title => "MainFormWindow").
+            text_field(:class => /Edit/i).should exist
 
     RAutomation::Window.wait_timeout = 0.1
     expect {RAutomation::Window.new(:title => "non-existent-window").
-            text_field(:class => SpecHelper::DATA[:window2_text_field_class])}.
+            text_field(:class => "Edit")}.
             to raise_exception(RAutomation::UnknownWindowException)
   end
 
   it "#set" do
-    window = RAutomation::Window.new(:title => SpecHelper::DATA[:window2_title])
-    window.text_field(:class => SpecHelper::DATA[:window2_text_field_class]).set "hello!"
+    window = RAutomation::Window.new(:title => "MainFormWindow")
+    window.text_field(:class => /Edit/i).set "hello!"
 
     RAutomation::Window.wait_timeout = 0.1
     expect {window.text_field(:class => "non-existing-field").set "hello!"}.
@@ -21,8 +21,8 @@ describe RAutomation::TextField do
   end
 
   it "#clear"do
-    window = RAutomation::Window.new(:title => SpecHelper::DATA[:window2_title])
-    field = window.text_field(:class => SpecHelper::DATA[:window2_text_field_class])
+    window = RAutomation::Window.new(:title => "MainFormWindow")
+    field = window.text_field(:class => /Edit/i)
     field.set "hello!"
     field.value.should == "hello!"
     field.clear
@@ -34,8 +34,8 @@ describe RAutomation::TextField do
   end
 
   it "#value" do
-    window = RAutomation::Window.new(:title => SpecHelper::DATA[:window2_title])
-    field = window.text_field(:class => SpecHelper::DATA[:window2_text_field_class])
+    window = RAutomation::Window.new(:title => "MainFormWindow")
+    field = window.text_field(:class => /Edit/i)
     field.set "hello!"
     field.value.should == "hello!"
 
@@ -45,8 +45,8 @@ describe RAutomation::TextField do
   end
 
   it "#exists?" do
-    window = RAutomation::Window.new(:title => SpecHelper::DATA[:window2_title])
-    field = window.text_field(:class => SpecHelper::DATA[:window2_text_field_class])
+    window = RAutomation::Window.new(:title => "MainFormWindow")
+    field = window.text_field(:class => /Edit/i)
     field.should exist
     window.text_field(:class => "non-existent-field").should_not exist
   end