mohawk 0.0.3 → 0.0.4

data/.gitmodules

@@ -0,0 +1,3 @@
+[submodule "mohawk-testing-app"]
+	path = mohawk-testing-app
+	url = git://github.com/leviwilson/mohawk-testing-app.git

data/Changelog

@@ -1,3 +1,8 @@
+=== Version 0.0.4 / 2013-05-24
+*	Enhancements
+	*	sped up table access when there are many rows
+	*	caches controls based on locator for quicker lookups
+
 === Version 0.0.3 / 2013-04-26
 * Enhancements
 	*	Bumped the RAutomation dependency so we can now interact with controls

data/Gemfile

@@ -1,3 +1,4 @@
 source 'http://rubygems.org'
 
+gem 'coveralls', require: false
 gemspec

data/README.md

@@ -1,6 +1,6 @@
 # Mohawk
-
 [![Build Status](https://travis-ci.org/leviwilson/mohawk.png)](https://travis-ci.org/leviwilson/mohawk)
+[![Coverage Status](https://coveralls.io/repos/leviwilson/mohawk/badge.png?branch=master)](https://coveralls.io/r/leviwilson/mohawk?branch=master)
 
 A gem to assist in building page-object like structures for testing Windows applications.
 

data/features/mohawk.feature

@@ -15,3 +15,7 @@ Scenario: Determining if a window has text
 Scenario: Waiting for a particular control
   When we are using the "MainScreen"
   Then we can wait for the control with a value of "Data Entry Form"
+
+Scenario: Specifying a parent container
+  When we are using the "ScreenWithContainer"
+  Then our parent is the container, not the main window

data/features/step_definitions/mohawk_steps.rb

@@ -16,4 +16,9 @@ end
 
 Then /^we can wait for the control with a value of "(.*?)"$/ do |value|   
   @screen.wait_for_control :value => value
-end                                                                      
+end
+
+Then /^our parent is the container, not the main window$/ do
+  @screen.adapter.window.title.should_not match(/MainForm/)
+  @screen.up_view.control_name.should eq('Forward')
+end

data/features/step_definitions/table_steps.rb

@@ -36,4 +36,18 @@ end
 
 Then /^the "(.*?)" for the row at index "(.*?)" is "(.*?)"$/ do |header, which_row, expected_value|
   on(DataEntryForm).people[which_row.to_i].send(header).should eq(expected_value)
-end                                                                               
+end
+
+When(/^there are a lot of records in a table$/) do
+  on(DataEntryForm) do |screen|
+    5.times { screen.add_more }
+  end
+end
+
+Then(/^the table count responds in a reasonable amount of time$/) do
+  Timeout.timeout(5.0) { on(DataEntryForm).people.count.should eq(252) }
+end
+
+Then(/^accessing the values in row "([^"]*)" should be snappy$/) do |which_row|
+  Timeout.timeout(5.0) { on(DataEntryForm).people[which_row.to_i].cells.should_not be_empty }
+end

data/features/support/screens/data_entry_form.rb

@@ -3,6 +3,7 @@ class DataEntryForm
   window(:title => /DataEntry/)
 
   table(:people, :id => "personListView")
+  button(:add_more, :value => 'Add Many')
 
   def wait_until_present
     super

data/features/support/screens/screen_with_container.rb

@@ -0,0 +1,8 @@
+class ScreenWithContainer
+  include Mohawk
+  window(:title => /MainForm/)
+  parent(:id => 'numericUpDown')
+
+  button(:up, :id => 'SmallIncrement')
+  button(:down, :id => 'SmallDecrement')
+end

data/features/table.feature

@@ -31,3 +31,11 @@ Scenario: Retrieving the headers
 
 Scenario: Retrieving a row value by its header
   Then the "date_of_birth" for the row at index "1" is "3/4/1975"
+
+Scenario: Working with lots of records counts
+  When there are a lot of records in a table
+  Then the table count responds in a reasonable amount of time
+
+Scenario: Working with a row when there are a lot of records
+  When there are a lot of records in a table
+  Then accessing the values in row "12" should be snappy

data/lib/mohawk/accessors/table.rb

@@ -18,11 +18,11 @@ module Mohawk
       end
 
       def [](row)
-        TableRow.new(self, view.row(:index => row))
+        TableRow.new(self, row)
       end
 
       def each
-        view.rows.map do |row|
+        view.row_count.times.map do |row|
           yield TableRow.new(self, row)
         end
       end

data/lib/mohawk/accessors/table_row.rb

@@ -1,13 +1,15 @@
 module Mohawk
   module Accessors
     class TableRow
+      include RAutomation::Adapter::MsUia
+
       attr_reader :row
 
-      def initialize(table, row)
-        @row = row
+      def initialize(table, row_index)
         @table = table
+        @row = Row.new(@table.view, :index => row_index)
       end
-      
+
       def selected?
         @table.view.selected? row.row
       end
@@ -23,7 +25,7 @@ module Mohawk
       def value_from_header(name)
         which_column = header_methods.index(name)
         raise ArgumentError, "#{name} column does not exist in #{header_methods}" if which_column.nil?
-        cells[which_column]
+        Cell.new(row, :index => which_column).text
       end
       
       def method_missing(name, *args)

data/lib/mohawk/accessors.rb

@@ -1,6 +1,6 @@
 module Mohawk
   module Accessors
-    
+
     #
     # Defines the locator indicating the top-level window that will be used
     # to find controls in the page
@@ -11,11 +11,26 @@ module Mohawk
     # @param  [Hash]  locator for the top-level window that hosts the page
     #
     def window(locator)
-      define_method("which_window") do
+      define_method(:which_window) do
         locator
       end
     end
-    
+
+    #
+    # Defines a locator indicating a child container that is a descendant of
+    # the top-level window
+    #
+    # @example
+    #   parent(:id => 'someOtherContainer')
+    #
+    # @param  [Hash]  locator for a more specific parent container
+    #
+    def parent(locator)
+      define_method(:parent_container) do
+        locator
+      end
+    end
+
     #
     # Generates methods to enter text into a text field, get its value
     # and clear the text field
@@ -28,7 +43,7 @@ module Mohawk
     # @param  [Hash]  locator for how the text is found
     #
     def text(name, locator)
-      define_method("#{name}") do 
+      define_method("#{name}") do
         adapter.text(locator).value
       end
       define_method("#{name}=") do |text|
@@ -44,9 +59,9 @@ module Mohawk
         adapter.text(locator).view
       end
     end
-    
+
     #
-    # Generates methods to click on a button as well as get the value of 
+    # Generates methods to click on a button as well as get the value of
     # the button text
     #
     # @example
@@ -239,7 +254,7 @@ module Mohawk
     # @example
     #   tree_view(:tree, :id => "treeId")
     #   # will generate 'tree', 'tree=', 'tree_items', 'expand_tree_item' and 'collapse_tree_item'
-    #   # methods to get the tree value, set the tree value (index or string), get all of the 
+    #   # methods to get the tree value, set the tree value (index or string), get all of the
     #   # items, expand an item (index or string) and collapse an item (index or string)
     #
     # @param  [String]  the name used for the generated methods

data/lib/mohawk/adapters/uia_adapter.rb

@@ -1,38 +1,55 @@
 module Mohawk
   module Adapters
     class UiaAdapter
-      attr_reader :window
-
-      def initialize(locator)
+      def initialize(locator, container=nil)
         @window = RAutomation::Window.new(locator.merge(:adapter => :ms_uia))
+        @container = container
+      end
+
+      def window
+        @actual_window ||= begin
+          if @container
+            control = @window.control(@container)
+            RAutomation::WaitHelper.wait_until { control.exist? }
+            @window = RAutomation::Window.new(:hwnd => control.hwnd, :adapter => :ms_uia)
+          end
+          @window
+        end
       end
 
       def combo(locator)
-        Mohawk::Accessors::Combo.new(self, locator)
+        @combos ||= {}
+        @combos[locator] ||= Mohawk::Accessors::Combo.new(self, locator)
       end
 
       def checkbox(locator)
-        Mohawk::Accessors::CheckBox.new(self, locator)
+        @checkbox ||= {}
+        @checkbox[locator] ||= Mohawk::Accessors::CheckBox.new(self, locator)
       end
 
       def text(locator)
-        Mohawk::Accessors::Text.new(self, locator)
+        @text_fields ||= {}
+        @text_fields[locator] ||= Mohawk::Accessors::Text.new(self, locator)
       end
 
       def button(locator)
-        Mohawk::Accessors::Button.new(self, locator)
+        @buttons ||= {}
+        @buttons[locator] ||= Mohawk::Accessors::Button.new(self, locator)
       end
 
       def radio(locator)
-        Mohawk::Accessors::Radio.new(self, locator)
+        @radios ||= {}
+        @radios[locator] ||= Mohawk::Accessors::Radio.new(self, locator)
       end
 	  
       def label(locator)
-        Mohawk::Accessors::Label.new(self, locator)
+        @labels ||= {}
+        @labels[locator] ||= Mohawk::Accessors::Label.new(self, locator)
       end
 
       def link(locator)
-        Mohawk::Accessors::Link.new(self, locator)
+        @links ||= {}
+        @links[locator] ||= Mohawk::Accessors::Link.new(self, locator)
       end
 
       def menu_item(locator)
@@ -40,15 +57,18 @@ module Mohawk
       end
 
       def table(locator)
-        Mohawk::Accessors::Table.new(self, locator)
+        @tables ||= {}
+        @tables[locator] ||= Mohawk::Accessors::Table.new(self, locator)
       end
 
       def tree_view(locator)
-        Mohawk::Accessors::TreeView.new(self, locator)
+        @trees ||= {}
+        @trees[locator] ||= Mohawk::Accessors::TreeView.new(self, locator)
       end
 
       def value_control(locator)
-        Mohawk::Accessors::Control.new(self, locator)
+        @controls ||= {}
+        @controls[locator] ||= Mohawk::Accessors::Control.new(self, locator)
       end
     end
   end

data/lib/mohawk/version.rb

@@ -1,3 +1,3 @@
 module Mohawk
-  VERSION = "0.0.3"
+  VERSION = "0.0.4"
 end

data/lib/mohawk.rb

@@ -17,8 +17,10 @@ module Mohawk
   end
 
   def initialize(extra={})
-    @adapter = Mohawk::Adapters::UiaAdapter.new(which_window.merge(extra))
-  end 
+    locator = [which_window.merge(extra)]
+    locator << parent_container if respond_to?(:parent_container)
+    @adapter = Mohawk::Adapters::UiaAdapter.new(*locator)
+  end
 
   #
   # Returns whether or not the window exists

data/mohawk.gemspec

@@ -17,7 +17,7 @@ Gem::Specification.new do |gem|
   gem.test_files    = gem.files.grep(%r{^(test|spec|features)/})
   gem.require_paths = ["lib"]
 
-  gem.add_dependency 'rautomation', '>= 0.9.1'
+  gem.add_dependency 'rautomation', '>= 0.9.2'
   gem.add_dependency 'require_all'
   gem.add_dependency 'page_navigation', '>= 0.7'
 
@@ -29,4 +29,5 @@ Gem::Specification.new do |gem|
   gem.add_development_dependency 'guard'
   gem.add_development_dependency 'guard-rspec'
   gem.add_development_dependency 'terminal-notifier-guard'
+  gem.add_development_dependency 'json', '~> 1.7.7'
 end

data/spec/ffi_stub.rb

@@ -0,0 +1,15 @@
+require 'ffi'
+
+module FFI
+  module Library
+    def ffi_lib(*names)
+    end
+
+    def ffi_libraries
+    end
+
+    def attach_function(name, func, args, returns = nil, options = nil)
+    end
+  end
+end
+

data/spec/lib/mohawk/accessors/table_spec.rb

@@ -1,5 +1,4 @@
 require 'spec_helper'
-require 'ffi'
 
 class TableScreen
   include Mohawk
@@ -21,19 +20,6 @@ class FakeTableRow
   end
 end
 
-module FFI
-  module Library
-    def ffi_lib(*names)
-    end
-
-    def ffi_libraries
-    end
-
-    def attach_function(name, func, args, returns = nil, options = nil)
-    end
-  end
-end
-
 describe Mohawk::Accessors::Table do
   let(:screen) { TableScreen.new }
   let(:window) { double("RAutomation Window") }
@@ -59,9 +45,12 @@ describe Mohawk::Accessors::Table do
     end
 
     it "has rows" do
-      fake_rows = [FakeTableRow.new("First Row", 0), FakeTableRow.new("Second Row", 1)]
-      expected_rows = fake_rows.map {|r| {:text => r.text, :row => r.row} }
-      table.should_receive(:rows).and_return(fake_rows)
+      first_row = FakeTableRow.new "First Row", 0
+      second_row = FakeTableRow.new "Second Row", 1
+      expected_rows = [first_row, second_row].map {|r| {:text => r.text, :row => r.row} }
+      table.should_receive(:row_count).and_return(2)
+      RAutomation::Adapter::MsUia::Row.should_receive(:new).with(table, :index => 0).and_return(first_row)
+      RAutomation::Adapter::MsUia::Row.should_receive(:new).with(table, :index => 1).and_return(second_row)
       screen.top.map(&:to_hash).should eq(expected_rows)
     end
 
@@ -80,7 +69,7 @@ describe Mohawk::Accessors::Table do
       let(:table_row) { double("RAutomation TableRow") }
 
       before(:each) do
-        table.should_receive(:row).with(:index => 0).and_return(table_row)
+        RAutomation::Adapter::MsUia::Row.should_receive(:new).with(table, :index => 0).and_return(table_row)
         table_row.stub(:row).and_return 0
       end
 
@@ -107,8 +96,10 @@ describe Mohawk::Accessors::Table do
       it "can get cell values by header name" do
         RAutomation::Adapter::MsUia::UiaDll.should_receive(:table_headers).and_return(["First Header", "Second Header"])
         table.should_receive(:search_information)
-        expected_cells = [FakeTableRow.new("Item 1", 0), FakeTableRow.new("Item 2", 1)]
-        table_row.should_receive(:cells).and_return(expected_cells)
+
+        expected_cell = double('RAutomation Cell')
+        expected_cell.should_receive(:text).and_return('Item 2')
+        RAutomation::Adapter::MsUia::Cell.should_receive(:new).with(table_row, :index => 1).and_return(expected_cell)
         screen.top[0].second_header.should eq("Item 2")
       end
 

data/spec/lib/mohawk/adapters/uia_adapter_spec.rb

@@ -0,0 +1,34 @@
+require 'spec_helper'
+
+class AnyScreen
+  include Mohawk
+  window(:title => /Some Title/)
+end
+
+RSpec::Matchers.define(:use_the_cached) do |control_type, the_alias=nil|
+  match do |screen|
+    screen.adapter.window.stub(the_alias || control_type).and_return(double('first control'), double('second control'))
+    first, second = 2.times.map { screen.adapter.send(control_type, :id => 'id') }
+    first.eql?(second)
+  end
+end
+
+describe Mohawk::Adapters::UiaAdapter do
+  subject(:screen) { AnyScreen.new }
+
+  let(:window) { double('RAutomation Window') }
+  before(:each) { RAutomation::Window.stub(:new).and_return(window) }
+
+  context 'caching controls' do
+    it { should use_the_cached(:combo, :select_list) }
+    it { should use_the_cached(:checkbox) }
+    it { should use_the_cached(:text, :text_field) }
+    it { should use_the_cached(:button) }
+    it { should use_the_cached(:radio) }
+    it { should use_the_cached(:label) }
+    it { should use_the_cached(:link, :label) }
+    it { should use_the_cached(:table) }
+    it { should use_the_cached(:tree_view, :select_list) }
+    it { should use_the_cached(:value_control) }
+  end
+end

data/spec/spec_helper.rb

@@ -2,4 +2,8 @@ $LOAD_PATH.unshift(File.dirname(__FILE__))
 $LOAD_PATH.unshift(File.join(File.dirname(__FILE__), '..', 'lib'))
 
 require 'rspec'
+require 'ffi_stub'
 require 'mohawk'
+require 'coveralls'
+
+Coveralls.wear!

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: mohawk
 version: !ruby/object:Gem::Version
-  version: 0.0.3
+  version: 0.0.4
   prerelease: 
 platform: ruby
 authors:
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-04-26 00:00:00.000000000 Z
+date: 2013-05-24 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rautomation
@@ -18,7 +18,7 @@ dependencies:
     requirements:
     - - ! '>='
       - !ruby/object:Gem::Version
-        version: 0.9.1
+        version: 0.9.2
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
@@ -26,7 +26,7 @@ dependencies:
     requirements:
     - - ! '>='
       - !ruby/object:Gem::Version
-        version: 0.9.1
+        version: 0.9.2
 - !ruby/object:Gem::Dependency
   name: require_all
   requirement: !ruby/object:Gem::Requirement
@@ -187,6 +187,22 @@ dependencies:
     - - ! '>='
       - !ruby/object:Gem::Version
         version: '0'
+- !ruby/object:Gem::Dependency
+  name: json
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 1.7.7
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 1.7.7
 description: High level wrapper around windows applications
 email:
 - levi@leviwilson.com
@@ -195,6 +211,7 @@ extensions: []
 extra_rdoc_files: []
 files:
 - .gitignore
+- .gitmodules
 - .travis.yml
 - Changelog
 - Gemfile
@@ -226,6 +243,7 @@ files:
 - features/step_definitions/table_steps.rb
 - features/step_definitions/text_steps.rb
 - features/step_definitions/tree_view_steps.rb
+- features/support/FizzWare.NBuilder.dll
 - features/support/WindowsForms.exe
 - features/support/app/WindowsForms/WindowsForms.sln
 - features/support/app/WindowsForms/WindowsForms/AboutBox.Designer.cs
@@ -256,6 +274,7 @@ files:
 - features/support/screens/about_screen.rb
 - features/support/screens/data_entry_form.rb
 - features/support/screens/main_screen.rb
+- features/support/screens/screen_with_container.rb
 - features/support/string.rb
 - features/table.feature
 - features/text.feature
@@ -279,6 +298,7 @@ files:
 - lib/mohawk/navigation.rb
 - lib/mohawk/version.rb
 - mohawk.gemspec
+- spec/ffi_stub.rb
 - spec/lib/mohawk/accessors/button_spec.rb
 - spec/lib/mohawk/accessors/checkbox_spec.rb
 - spec/lib/mohawk/accessors/combo_spec.rb
@@ -290,6 +310,7 @@ files:
 - spec/lib/mohawk/accessors/table_spec.rb
 - spec/lib/mohawk/accessors/text_spec.rb
 - spec/lib/mohawk/accessors/tree_view_spec.rb
+- spec/lib/mohawk/adapters/uia_adapter_spec.rb
 - spec/lib/mohawk_spec.rb
 - spec/lib/navigation_spec.rb
 - spec/spec_helper.rb
@@ -341,6 +362,7 @@ test_files:
 - features/step_definitions/table_steps.rb
 - features/step_definitions/text_steps.rb
 - features/step_definitions/tree_view_steps.rb
+- features/support/FizzWare.NBuilder.dll
 - features/support/WindowsForms.exe
 - features/support/app/WindowsForms/WindowsForms.sln
 - features/support/app/WindowsForms/WindowsForms/AboutBox.Designer.cs
@@ -371,10 +393,12 @@ test_files:
 - features/support/screens/about_screen.rb
 - features/support/screens/data_entry_form.rb
 - features/support/screens/main_screen.rb
+- features/support/screens/screen_with_container.rb
 - features/support/string.rb
 - features/table.feature
 - features/text.feature
 - features/tree_view.feature
+- spec/ffi_stub.rb
 - spec/lib/mohawk/accessors/button_spec.rb
 - spec/lib/mohawk/accessors/checkbox_spec.rb
 - spec/lib/mohawk/accessors/combo_spec.rb
@@ -386,6 +410,7 @@ test_files:
 - spec/lib/mohawk/accessors/table_spec.rb
 - spec/lib/mohawk/accessors/text_spec.rb
 - spec/lib/mohawk/accessors/tree_view_spec.rb
+- spec/lib/mohawk/adapters/uia_adapter_spec.rb
 - spec/lib/mohawk_spec.rb
 - spec/lib/navigation_spec.rb
 - spec/spec_helper.rb