mohawk 0.2.1 → 0.3

data/Changelog

@@ -1,3 +1,8 @@
+===	Version 0.3 / 2014-05-23
+*		Enhancements
+		*	bumping uia dependency to speed up element access when they do not have
+		a window handle (i.e. SelectList items, Table rows, etc.)
+
 ===	Version 0.2.1 / 2014-05-14
 *   Enhancements
     *   bumped uia dependency to make menu item selection faster

data/lib/mohawk/accessors.rb

@@ -16,6 +16,19 @@ module Mohawk
       end
     end
 
+    def required_controls(*controls)
+      define_method(:wait_until_present) do
+        controls.each do |control|
+          super()
+          begin
+            wait_until { send("#{control}_view").exist? }
+          rescue Mohawk::Waiter::WaitTimeout
+            raise "Control #{control} was not found on the #{self.class} screen"
+          end
+        end
+      end
+    end
+
     #
     # Defines a locator indicating a child container that is a descendant of
     # the top-level window
@@ -358,6 +371,9 @@ module Mohawk
       define_method("#{name}_items") do
         adapter.tab_control(locator).items
       end
+      define_method("#{name}_view") do
+        adapter.tab_control(locator)
+      end
     end
 
     def control(name, locator)

data/lib/mohawk/adapters/uia/text_box.rb

@@ -22,7 +22,11 @@ module Mohawk
         end
 
         def clear
-          set ''
+          if is_value?
+            set ''
+          else
+            send_keys [:control, :home], [:control, :shift, :end], :backspace
+          end
         end
 
         private

data/lib/mohawk/adapters/uia/window.rb

@@ -14,11 +14,7 @@ module Mohawk
         end
 
         def element
-          @element ||= Uia.find_element(@locator)
-          if @element && @container
-            @element = @element.find(@container) || @element
-          end
-          @element
+          @element ||= locate_element
         end
 
         def send_keys(*keys)
@@ -40,7 +36,7 @@ module Mohawk
         end
 
         def handle
-          element.handle
+          (locate_element && element.handle) || 0
         end
 
         def title
@@ -52,12 +48,21 @@ module Mohawk
         end
 
         def present?
-          element != nil
+          locate_element != nil
         end
 
         def wait_until_present
           wait_until { element }
         end
+
+        private
+        def locate_element
+          element = Uia.find_element(@locator)
+          if element && @container
+            element = element.find(@container) || element
+          end
+          element
+        end
       end
     end
   end

data/lib/mohawk/version.rb

@@ -1,3 +1,3 @@
 module Mohawk
-  VERSION = "0.2.1"
+  VERSION = "0.3"
 end

data/mohawk.gemspec

@@ -18,10 +18,10 @@ Gem::Specification.new do |gem|
   gem.test_files    = gem.files.grep(%r{^(test|spec|features)/})
   gem.require_paths = ["lib"]
 
-  gem.add_dependency 'uia', '~> 0.4'
+  gem.add_dependency 'uia', '>= 0.4.4'
   gem.add_dependency 'require_all'
   gem.add_dependency 'page_navigation', '>= 0.7'
-  gem.add_dependency 'childprocess', '~> 0.3.9'
+  gem.add_dependency 'childprocess', '~> 0.5'
 
   gem.add_development_dependency 'cucumber'
   gem.add_development_dependency 'rspec', '>= 2.12.0'

data/spec/lib/mohawk/button_spec.rb

@@ -0,0 +1,14 @@
+require 'spec_helper'
+
+describe 'buttons' do
+  Given(:main_form) { start_app }
+
+  context 'pressing' do
+    When { main_form.data_entry_form }
+    Then { expect(on(DataEntryForm)).to be_present }
+  end
+
+  context '#value' do
+    Then { main_form.data_entry_form_value == 'Data Entry Form' }
+  end
+end

data/spec/lib/mohawk/checkbox_spec.rb

@@ -0,0 +1,23 @@
+require 'spec_helper'
+
+describe 'checkboxes' do
+  Given(:main_screen) { start_app }
+
+  Then { main_screen.checkbox_value == 'checkBox' }
+  Then  { main_screen.checkbox_view.class == Mohawk::Adapters::UIA::CheckBox }
+
+  context 'setting' do
+    Given(:uncheck) { main_screen.checkbox = false }
+    Given(:check) { main_screen.checkbox = true }
+
+    context 'checking' do
+      When { check }
+      Then { main_screen.checkbox == true }
+    end
+
+    context 'un-checking' do
+      When { check; uncheck }
+      Then { main_screen.checkbox == false }
+    end
+  end
+end

data/spec/lib/mohawk/combo_box_spec.rb

@@ -0,0 +1,52 @@
+require 'spec_helper'
+
+describe 'combo boxes' do
+  Given(:main_form) { start_app }
+
+  context '#combo_box= / #combo_box' do
+    context 'by index' do
+      When { main_form.fruits = 2 }
+      Then { main_form.fruits == 'Coconut' }
+    end
+
+    context 'by value' do
+      When { main_form.fruits = 'Coconut' }
+      Then { main_form.fruits == 'Coconut' }
+    end
+
+    context 'by Regex' do
+      When { main_form.fruits = /[Or]an/ }
+      Then { main_form.fruits == 'Orange' }
+    end
+
+    context 'multi-select' do
+      Given { main_form.toggle_multi }
+      When { (0..2).each {|n| main_form.select_fruits_list n } }
+
+      Then { main_form.fruits_list_selections == ['Apple', 'Orange', 'Mango'] }
+
+      context '#clear_' do
+        context 'by index' do
+          When { main_form.clear_fruits_list 2 }
+          Then { main_form.fruits_list_selections == ['Apple', 'Orange'] }
+        end
+
+        context 'by value' do
+          When { main_form.clear_fruits_list 'Orange' }
+          Then { main_form.fruits_list_selections == ['Apple', 'Mango'] }
+        end
+
+        context 'by Regex' do
+          When { main_form.clear_fruits_list /p{2}/ }
+          Then { main_form.fruits_list_selections == ['Orange', 'Mango'] }
+        end
+      end
+    end
+  end
+
+  context 'list boxes' do
+    # ListBox controls are special with regard to raising events
+    When { main_form.fruits_list = 'Orange' }
+    Then { main_form.fruits_label == 'Orange' }
+  end
+end

data/spec/lib/mohawk/control_spec.rb

@@ -0,0 +1,17 @@
+require 'spec_helper'
+
+describe 'controls' do
+  Given(:main_screen) { start_app }
+
+  Then { main_screen.month_calendar_view.class == Mohawk::Adapters::UIA::ValueControl }
+
+  context '#control=' do
+    When { main_screen.month_calendar = '9/28/1979' }
+    Then { main_screen.month_calendar_value == '9/28/1979 12:00:00 AM' }
+  end
+
+  context '#click_' do
+    When { main_screen.click_about_control }
+    Then { on(About) != nil }
+  end
+end

data/spec/lib/mohawk/label_spec.rb

@@ -0,0 +1,8 @@
+require 'spec_helper'
+
+describe 'labels' do
+  Given(:main_screen) { start_app }
+
+  Then { main_screen.sample_label == 'This is a sample text' }
+  Then { main_screen.sample_label_view.class == Mohawk::Adapters::UIA::Control }
+end

data/spec/lib/mohawk/link_spec.rb

@@ -0,0 +1,16 @@
+require 'spec_helper'
+
+describe 'links' do
+  Given(:main_form) { start_app }
+
+  Then { main_form.link_label_view.class == Mohawk::Adapters::UIA::Control }
+
+  context '#link_text' do
+    Then { main_form.link_label_text == 'linkLabel1' }
+  end
+
+  context '#click_link' do
+    When { main_form.click_link_label }
+    Then { main_form.link_label_text == 'linkLabel1 (clicked 1 times)' }
+  end
+end

data/spec/lib/mohawk/menu_spec.rb

@@ -0,0 +1,20 @@
+require 'spec_helper'
+
+describe 'menus' do
+  Given(:main_form) { start_app }
+
+  context 'by text' do
+    When { main_form.menu_item_by_text }
+    Then { on(About).active? }
+  end
+
+  context 'by path' do
+    When { main_form.menu_item_by_path }
+    Then { on(About).active? }
+  end
+
+  context '#click_menu_item' do
+    When { main_form.click_menu_item_by_path }
+    Then { on(About).active? }
+  end
+end

data/spec/lib/mohawk/navigation_spec.rb

@@ -0,0 +1,25 @@
+require 'spec_helper'
+
+describe Mohawk::Navigation do
+  context '#on with extra info' do
+    When { start_app }
+    Then { on(MainForm, pid: Mohawk.app.pid).present? }
+  end
+
+  context '#navigate_to' do
+    Given do
+      Mohawk::Navigation.routes = {
+          :default => [
+              [MainForm, :about],
+              [About, :close],
+              [MainForm, :data_entry_form],
+              [DataEntryForm]
+          ]
+      }
+      start_app
+    end
+
+    When(:data_entry_form) { navigate_to(DataEntryForm) }
+    Then { expect(data_entry_form).to be_present }
+  end
+end

data/spec/lib/mohawk/radio_spec.rb

@@ -0,0 +1,22 @@
+require 'spec_helper'
+
+describe 'radio buttons' do
+  Given(:screen) do
+    start_app
+    on(Class.new do
+      include Mohawk
+      window title: /MainForm/
+
+      radio(:radio_one, id: 'radioButton1')
+      label(:status, id: 'radioButtonLabel')
+    end)
+  end
+
+  Then { screen.radio_one_view.class == Mohawk::Adapters::UIA::Radio }
+
+  context '#radio' do
+    When { screen.radio_one }
+    Then { screen.status == 'Option 1 selected' }
+    And { screen.radio_one? == true }
+  end
+end

data/spec/lib/mohawk/spinner_spec.rb

@@ -0,0 +1,31 @@
+require 'spec_helper'
+
+describe 'spinners' do
+  Given(:screen) do
+    start_app
+    on(Class.new do
+      include Mohawk
+      window(title: /MainForm/)
+
+      spinner(:spinner, id: 'numericUpDown1')
+    end)
+  end
+
+  Then { screen.spinner_view.class == Mohawk::Adapters::UIA::Spinner }
+
+  context '#spinner=' do
+    When { screen.spinner = 50.8 }
+    Then { screen.spinner == 50.8 }
+  end
+
+  context '#increment_spinner' do
+    When { 5.times { screen.increment_spinner} }
+    Then { screen.spinner == 5.0 }
+  end
+
+  context '#decrement_spinner' do
+    Given { screen.spinner = 10.0 }
+    When { 3.times { screen.decrement_spinner } }
+    Then { screen.spinner == 7.0 }
+  end
+end

data/spec/lib/mohawk/text_spec.rb

@@ -0,0 +1,40 @@
+require 'spec_helper'
+
+describe 'text controls' do
+  Given(:main_form) { start_app }
+
+  Then { main_form.text_field_view.class == Mohawk::Adapters::UIA::TextBox }
+
+  context '#text= / #text' do
+    context 'edit controls' do
+      When { main_form.text_field = 'text we set it to' }
+      Then { main_form.text_field == 'text we set it to' }
+    end
+
+    context 'multi-line text fields' do
+      When { main_form.multiline_text_field = 'multi-line text we set it to' }
+      Then { main_form.multiline_text_field == 'multi-line text we set it to' }
+    end
+  end
+
+  context '#clear_text' do
+    context 'edit controls' do
+      Given { main_form.text_field = 'text to be cleared' }
+      When { main_form.clear_text_field }
+      Then { main_form.text_field == '' }
+    end
+
+    context 'multi-line text fields' do
+      Given { main_form.multiline_text_field = 'multiline text to be cleared' }
+      When { main_form.clear_multiline_text_field }
+      Then { main_form.multiline_text_field == '' }
+    end
+  end
+
+  context '#enter_text' do
+    context 'masked edit controls' do
+      When { main_form.enter_masked_text_field 'abc12345willnotgoin6789' }
+      Then { main_form.masked_text_field == '123-45-6789' }
+    end
+  end
+end

data/spec/lib/mohawk/tree_view_spec.rb

@@ -0,0 +1,54 @@
+require 'spec_helper'
+
+describe 'tree views' do
+  Given(:main_screen) { start_app }
+
+  Then { main_screen.tree_view_view.class == Mohawk::Adapters::UIA::TreeView }
+
+  context '#tree_view=' do
+    context 'by index' do
+      When { main_screen.tree_view = 1 }
+      Then { main_screen.tree_view == 'Parent Two' }
+    end
+
+    context 'by value' do
+      When { main_screen.tree_view = 'Parent Two' }
+      Then { main_screen.tree_view == 'Parent Two' }
+    end
+  end
+
+  context '#tree_view_items' do
+    Then { main_screen.tree_view_items == ['Parent One', 'Parent Two'] }
+  end
+
+  context '#expand/collapse_tree_view' do
+    Given(:original_items) { ['Parent One', 'Parent Two'] }
+    Given(:expected_items) { ['Parent One', 'Child 1', 'Child 2', 'Parent Two'] }
+
+    context 'by index' do
+      When { main_screen.expand_tree_view_item 0 }
+
+      context 'expand' do
+        Then { main_screen.tree_view_items ==  expected_items}
+      end
+
+      context 'collapse' do
+        When { main_screen.collapse_tree_view_item 0 }
+        Then { main_screen.tree_view_items == original_items }
+      end
+    end
+
+    context 'by value' do
+      When { main_screen.expand_tree_view_item 'Parent One' }
+
+      context 'expand' do
+        Then { main_screen.tree_view_items ==  expected_items}
+      end
+
+      context 'collapse' do
+        When { main_screen.collapse_tree_view_item 'Parent One' }
+        Then { main_screen.tree_view_items ==  original_items}
+      end
+    end
+  end
+end

data/spec/lib/mohawk/window_spec.rb

@@ -0,0 +1,84 @@
+require 'spec_helper'
+
+describe Mohawk::Adapters::UIA::Window do
+  Given(:main_form) { start_app }
+  Given!(:not_created_form) { MainForm.new }
+  Given(:about) { main_form.about; on(About) }
+
+  context 'container' do
+    Given(:container) do
+      start_app
+      on(Class.new do
+        include Mohawk
+        window(title: /MainForm/)
+        parent(id: 'numericUpDown')
+      end)
+    end
+
+    Then { container.adapter.window.title == 'linkLabel1' }
+  end
+
+  context 'children_only' do
+    Given(:limit_scope) do
+      start_app.data_grid_view
+      on(Class.new do
+        include Mohawk
+        window(title: /DataGridViewForm/, children_only: true)
+
+        button(:close, :value => 'Close')
+      end)
+    end
+
+    When(:time_it_took) { Benchmark.measure { limit_scope.close } }
+    Then { time_it_took.real < 2 }
+  end
+
+  context '#active?' do
+    Then { not_created_form.active? == false }
+    Then { main_form.active? == true }
+
+    context 'inactive --> active' do
+      Given { about }
+      When { about.close; Mohawk::Waiter.wait_until { !about.present? } }
+      Then { not_created_form.active? == true }
+    end
+
+    context 'active --> inactive' do
+      Given { expect(main_form).to be_active }
+      When { about }
+      Then { main_form.active? == false }
+    end
+  end
+
+  context '#present?' do
+    Then { about.present? == true }
+
+    context 'closing / opening' do
+      When { about.close }
+      Then { about.present? == false }
+    end
+  end
+
+  context '#exist?' do
+    Then { not_created_form.exist? == false }
+
+    context 'not there --> there' do
+      When { start_app }
+      Then { not_created_form.exist? == true }
+    end
+
+    context 'there --> not there' do
+      Given { main_form }
+      When { main_form.close }
+      Then { main_form.exist? == false }
+    end
+  end
+
+  context '#has_text?' do
+    Then { expect(main_form).to have_text 'Assorted UI Elements' }
+  end
+
+  context '#wait_for_control' do
+    Then { main_form.wait_for_control value: 'Data Entry Form' }
+  end
+end

data/spec/lib/mohawk_spec.rb

@@ -103,6 +103,31 @@ describe Mohawk do
     end
   end
 
+  context '#required_controls' do
+    Given { start_app; Mohawk.timeout = 1 }
+    Given(:has_controls) do
+      Class.new do
+        include Mohawk
+        window title: /MainForm/
+        required_controls :about, :data_grid_view
+        button(:about, value: 'About')
+        button(:data_grid_view, value: 'Data Grid View')
+      end
+    end
+    Given(:missing_controls) do
+      Class.new do
+        include Mohawk
+        window title: /MainForm/
+        required_controls :something
+
+        button(:something, id: 'notThere')
+      end
+    end
+
+    Then { on(has_controls) != nil }
+    Then { expect { on(missing_controls) }.to raise_error /Control something was not found on the #<Class:0x.*> screen/ }
+  end
+
   context Mohawk::Adapters do
     Given(:screen) { TestScreen.new }
     Given(:window) { double('window').as_null_object }

data/spec/screens/about.rb

@@ -0,0 +1,7 @@
+class About
+  include Mohawk
+  window title: 'About'
+
+  button(:close, id: 'Close')
+  tabs(:tab, id: 'tabControl1')
+end

data/spec/screens/data_entry_form.rb

@@ -0,0 +1,4 @@
+class DataEntryForm
+  include Mohawk
+  window title: 'DataEntryForm'
+end

data/spec/screens/main_form.rb

@@ -0,0 +1,32 @@
+class MainForm
+  include Mohawk
+  window title: /MainForm/
+
+  text(:text_field, id: 'textField')
+  text(:masked_text_field, :id => 'maskedTextBox')
+  text(:multiline_text_field, id: 'multiLineTextField')
+
+  button(:close, id: 'Close')
+  button(:about, id: 'aboutButton')
+  button(:data_entry_form, value: 'Data Entry Form')
+  button(:data_grid_view, value: 'Data Grid View')
+  button(:toggle_multi, value: 'Toggle Multi-Select')
+
+  checkbox(:checkbox, id: 'checkBox')
+
+  combo_box(:fruits, id: 'FruitsComboBox')
+  select_list(:fruits_list, id: 'FruitListBox')
+
+  tree_view(:tree_view, id: 'treeView')
+
+  label(:sample_label, id: 'label1')
+  label(:fruits_label, :id => 'fruitsLabel')
+
+  link(:link_label, id: 'linkLabel1')
+
+  menu_item(:menu_item_by_path, path: ['File', 'Roundabout Way', 'To', 'About'])
+  menu_item(:menu_item_by_text, text: 'About')
+
+  control(:month_calendar, id: 'automatableMonthCalendar1')
+  control(:about_control, id: 'aboutButton')
+end

data/spec/spec_helper.rb

@@ -4,8 +4,26 @@ $LOAD_PATH.unshift(File.join(File.dirname(__FILE__), '..', 'lib'))
 require 'rspec'
 require 'rspec/mocks'
 require 'rspec-given'
-require 'ffi_stub'
 require 'mohawk'
 require 'coveralls'
+require 'benchmark'
+
+require 'require_all'
+require_rel 'screens'
 
 Coveralls.wear!
+
+include Mohawk::Navigation
+
+def start_app
+  Mohawk.app_path = 'features/support/WindowsForms.exe'
+  Mohawk.start
+  on(MainForm)
+end
+
+RSpec.configure do |config|
+  config.after(:each) do
+    Mohawk.stop if Mohawk.app
+    Mohawk.timeout = 60
+  end
+end

data/spec/tabs_spec.rb

@@ -0,0 +1,26 @@
+require 'spec_helper'
+
+describe 'tabs' do
+  Given(:screen) { start_app.about; on(About) }
+
+  Then { screen.tab == 'Info' }
+  Then { screen.tab_items == ['Info', 'Other Info'] }
+  Then { screen.tab_view.class == Mohawk::Adapters::UIA::TabControl }
+
+  context '#select_tab' do
+    context 'by index' do
+      When { screen.tab = 1 }
+      Then { screen.tab == 'Other Info' }
+    end
+
+    context 'by value' do
+      When { screen.tab = 'Other Info' }
+      When { screen.tab == 'Other Info' }
+    end
+
+    context 'by Regex' do
+      When { screen.tab = /[Oo]th/ }
+      Then { screen.tab == 'Other Info' }
+    end
+  end
+end