mohawk 0.0.1 → 0.0.2

data/Changelog

@@ -1,3 +1,20 @@
+=== Version 0.2 / 2012-12-26
+* Enhancements
+  * Added the following Mohawk module methods:
+    * active?
+    * has_text?
+    * present?
+    * wait_until
+    * wait_until_present
+  * Added more accessors for working with the following controls:
+    * label
+    * menu_item
+    * table
+    * tree_view
+  * Added method to text accessor to simulate typing into a field (helpful for masked edit controls)
+  * Enhanced navigation to wait until the Window is present before working with it
+  * Added aliases for table, combo_box and tree_view accessors
+
 === Version 0.1 / 2012-11-07
 Initial release with support for text, button, combo, radio and checkbox
 controls

data/Gemfile

@@ -1,7 +1,3 @@
 source 'http://rubygems.org'
 
-gem 'cucumber'
-gem 'rspec'
-gem 'rake'
-gem 'rautomation'
-gem 'childprocess'
+gemspec

data/README.md

@@ -18,6 +18,35 @@ Or install it yourself as:
 
     $ gem install mohawk
 
+## Example
+
+### Defining a screen
+
+```ruby
+require 'mohawk'
+
+class LoginScreen
+  include Mohawk
+  window(:title => /Login/)
+
+  text(:username, :id => "UserNameField")
+  text(:password, :id => "PasswordField")
+  
+  button(:login, :value => "Login")
+end
+```
+
+### Using the Page-Object
+```ruby
+World(Mohawk::Navigation)
+
+on(LoginScreen) do |screen|
+  screen.username = "levi"
+  screen.password = "secret"
+  screen.login
+end
+```
+
 ## Contributing
 
 1. Fork it

data/features/label.feature

@@ -0,0 +1,4 @@
+Feature: Working with label controls
+
+Scenario: Getting the value of the control
+	Then I know that the "label control" has the value "This is a sample text"

data/features/menu.feature

@@ -0,0 +1,5 @@
+Feature:  Working with menu items
+
+Scenario: Selecting an item from the menu
+  When I select the menu item in the path "File | Roundabout Way | To | About"
+  Then I should see the "About" window

data/features/mohawk.feature

@@ -0,0 +1,14 @@
+Feature:  Using Mohawk
+
+Scenario: Determining if a window exists
+  When we are using the "MainScreen"
+  Then the window should exist
+
+Scenario: Determining if a window is active
+  When we are using the "MainScreen"
+  Then we know that the window is active
+
+@wip
+Scenario: Determining if a window has text
+  When we are using the "MainScreen"
+  Then we can confirm the window has the text "Assorted UI Elements"

data/features/step_definitions/label_steps.rb

@@ -0,0 +1,3 @@
+Then /^I know that the "(.*?)" has the value "(.*?)"$/ do |name, value|
+	on(MainScreen).send(name.to_field).should eq(value)
+end

data/features/step_definitions/menu_steps.rb

@@ -0,0 +1,5 @@
+When /^I select the menu item in the path "(.*?)"$/ do |menu_path|        
+  menu_item_method = menu_path.gsub(/ (\| )?/, "_").downcase
+  on(MainScreen).send menu_item_method
+end                                                                  
+

data/features/step_definitions/mohawk_steps.rb

@@ -0,0 +1,15 @@
+When /^we are using the "(.*?)"$/ do |expected_screen|
+  @screen = on(expected_screen.to_class)
+end
+
+Then /^the window should exist$/ do
+  @screen.should exist
+end
+
+Then /^we know that the window is active$/ do
+  @screen.should be_active
+end
+
+Then /^we can confirm the window has the text "(.*?)"$/ do |what_text|   
+  @screen.should have_text(what_text)
+end                                                                 

data/features/step_definitions/table_steps.rb

@@ -0,0 +1,23 @@
+When /^we are observing the people table$/ do
+  on(MainScreen).data_entry_form_button
+  on(DataEntryForm).should be_active
+end
+
+Then /^the table row information should look like the following:$/ do |row_items|
+  row_items.map_column!("row") { |r| r.to_i }
+  row_items.map_headers!("text" => :text, "row" => :row)
+  on(DataEntryForm).people_rows.should eq row_items.hashes
+end
+
+When /^we select the table row with index "(.*?)"$/ do |row_index|
+  on(DataEntryForm).people = row_index.to_i
+end
+
+Then /^the row with index "(.*?)" should be selected$/ do |which_row|
+  on(DataEntryForm).people_row(which_row.to_i).should be_selected
+end
+
+Then /^the row with index "(.*?)" should look like the following:$/ do |which_row, table|
+  actual_cells = on(DataEntryForm).people_row(which_row.to_i).cells
+  actual_cells.should eq table.rows.first
+end

data/features/step_definitions/text_steps.rb

@@ -2,6 +2,10 @@ When /^I set the "(.*)" to the value "(.*)"$/ do |name, value|
   on(MainScreen).send "#{name.to_field}=", value
 end
 
+When /^I enter into "(.*?)" the values "(.*?)"$/ do |name, value|
+  on(MainScreen).send "enter_#{name.to_field}", value
+end
+
 When /^I clear the "(.*)"$/ do |name|
   on(MainScreen).send "clear_#{name.to_field}"
 end

data/features/step_definitions/tree_view_steps.rb

@@ -0,0 +1,31 @@
+When /^I select the item with index "(.*?)" in the TreeView$/ do |which_index|
+  on(MainScreen).tree_view = which_index.to_i
+end
+
+When /^I select the item "(.*?)" in the TreeView$/ do |expected_value|
+  on(MainScreen).tree_view = expected_value
+end
+
+Then /^the selected TreeView value should be "(.*?)"$/ do |expected_value|
+  on(MainScreen).tree_view.should eq expected_value
+end
+
+Then /^the available tree items should be:$/ do |tree_items|
+  on(MainScreen).tree_view_items.should eq tree_items.rows.flatten
+end
+
+When /^I expand the tree item with index "(.*?)"$/ do |which_index|
+  on(MainScreen).expand_tree_view_item which_index.to_i
+end
+
+When /^I expand the tree item "(.*?)"$/ do |which_item|
+  on(MainScreen).expand_tree_view_item which_item
+end
+
+When /^I collapse the tree item with index "(.*?)"$/ do |which_index|      
+  on(MainScreen).collapse_tree_view_item which_index.to_i
+end                                                                 
+
+When /^I collapse the tree item "(.*?)"$/ do |which_item|      
+  on(MainScreen).collapse_tree_view_item which_item
+end                                                                 

data/features/support/screens/data_entry_form.rb

@@ -0,0 +1,6 @@
+class DataEntryForm
+  include Mohawk
+  window(:title => /DataEntry/)
+
+  table(:people, :id => "personListView")
+end

data/features/support/screens/main_screen.rb

@@ -3,8 +3,12 @@ class MainScreen
   window(:title => /MainFormWindow/)
 
   text(:text_field, :id => "textField")
+  text(:masked_text_field, :id => "maskedTextBox")
   button(:data_entry_form_button, :value => "Data Entry Form")
   combo_box(:fruits, :id => "FruitsComboBox")
   checkbox(:first_checkbox, :id =>  "checkBox")
   radio(:first_radio, :id => "radioButton1")
+  label(:label_control, :id => "label1")
+  menu_item(:file_roundabout_way_to_about, :path => ["File", "Roundabout Way", "To", "About"])
+  tree_view(:tree_view, :id => "treeView")
 end

data/features/support/string.rb

@@ -2,4 +2,8 @@ class String
   def to_field
     self.gsub(/ /, "_").downcase
   end
+
+  def to_class
+    Object.const_get self
+  end
 end

data/features/table.feature

@@ -0,0 +1,19 @@
+Feature:  Working with tables
+
+Background:
+  Given we are observing the people table
+
+Scenario: Selecting a row by index
+  When we select the table row with index "1"
+  Then the row with index "1" should be selected
+
+Scenario: Rows have cells
+  Then the row with index "0" should look like the following:
+    | Name      | Date of Birth | State |
+    | John Doe  | 12/15/1967    | FL    |
+
+Scenario: Retrieving the row values
+  Then the table row information should look like the following:
+    | text      | row |
+    | John Doe  | 0   | 
+    | Anna Doe  | 1   |

data/features/text.feature

@@ -8,3 +8,7 @@ Scenario: Clearing text
   When I set the "text field" to the value "Text to be cleared"
   And I clear the "text field"
   Then the "text field" should be ""
+
+Scenario: Entering text
+  When I enter into "masked text field" the values "abc12345willnotgoin6789"
+  Then the "masked text field" should be "123-45-6789"

data/features/tree_view.feature

@@ -0,0 +1,49 @@
+Feature:  Working with TreeView controls
+
+Scenario: Selecting an item by index
+  When I select the item with index "1" in the TreeView
+  Then the selected TreeView value should be "Parent Two"
+
+Scenario: Selecting an item by value
+  When I select the item "Parent Two" in the TreeView
+  Then the selected TreeView value should be "Parent Two"
+
+Scenario: Can reveal the available items
+  Then the available tree items should be:
+  | Tree Items  |
+  | Parent One  |
+  | Parent Two  |
+
+Scenario: Expanding items by index
+  When I expand the tree item with index "0"
+  Then the available tree items should be:
+  | Tree Items  |
+  | Parent One  |
+  | Child 1     |
+  | Child 2     |
+  | Parent Two  |
+
+Scenario: Expanding items by value
+  When I expand the tree item "Parent One"
+  Then the available tree items should be:
+  | Tree Items  |
+  | Parent One  |
+  | Child 1     |
+  | Child 2     |
+  | Parent Two  |
+
+Scenario: Collapsing items by index
+  When I expand the tree item "Parent One"
+  And I collapse the tree item with index "0"
+  Then the available tree items should be:
+  | Tree Items  |
+  | Parent One  |
+  | Parent Two  |
+
+Scenario: Collapsing items by value
+  When I expand the tree item "Parent One"
+  And I collapse the tree item "Parent One"
+  Then the available tree items should be:
+  | Tree Items  |
+  | Parent One  |
+  | Parent Two  |

data/lib/mohawk.rb

@@ -4,8 +4,12 @@ require "mohawk/accessors"
 require "mohawk/accessors/button"
 require "mohawk/accessors/checkbox"
 require "mohawk/accessors/combo"
+require "mohawk/accessors/label"
+require "mohawk/accessors/menu_item"
 require "mohawk/accessors/radio"
+require "mohawk/accessors/table"
 require "mohawk/accessors/text"
+require "mohawk/accessors/tree_view"
 require "mohawk/navigation"
 require "mohawk/adapters/uia_adapter"
 
@@ -21,8 +25,45 @@ module Mohawk
     @adapter = Mohawk::Adapters::UiaAdapter.new(which_window)
   end 
 
+  #
+  # Returns whether or not the window exists
+  #
   def exist?
     adapter.window.exist?
   end
 
+  #
+  # Returns whether or not the window is active
+  #
+  def active?
+    adapter.window.active?
+  end
+
+  #
+  # Returns whether or not the window is present
+  #
+  def present?
+    adapter.window.present?
+  end
+
+  #
+  # Waits until the window is present
+  #
+  def wait_until_present
+    adapter.window.wait_until_present
+  end
+
+  #
+  # Waits until the block returns true
+  #
+  def wait_until(timeout=RAutomation::Window.wait_timeout, &block)
+    RAutomation::WaitHelper.wait_until timeout, &block
+  end
+
+  #
+  # Indicates if the window has text or not
+  #
+  def has_text?(text_to_find)
+    adapter.window.text.include? text_to_find
+  end
 end

data/lib/mohawk/accessors.rb

@@ -1,11 +1,32 @@
 module Mohawk
   module Accessors
+    
+    #
+    # Defines the locator indicating the top-level window that will be used
+    # to find controls in the page
+    #
+    # @example
+    #   window(:title => /Title of Some Window/)
+    #
+    # @param  [Hash]  locator for the top-level window that hosts the page
+    #
     def window(locator)
       define_method("which_window") do
         locator
       end
     end
     
+    #
+    # Generates methods to enter text into a text field, get its value
+    # and clear the text field
+    #
+    # @example
+    #   text(:first_name, :id => 'textFieldId')
+    #   # will generate 'first_name', 'first_name=' and 'clear_first_name' methods
+    #
+    # @param  [String]  the name used for the generated methods
+    # @param  [Hash]  locator for how the text is found
+    #
     def text(name, locator)
       define_method("#{name}") do 
         adapter.text(locator).value
@@ -16,8 +37,22 @@ module Mohawk
       define_method("clear_#{name}") do
         adapter.text(locator).clear
       end
+      define_method("enter_#{name}") do |text|
+        adapter.text(locator).enter text
+      end
     end
-
+    
+    #
+    # Generates methods to click on a button as well as get the value of 
+    # the button text
+    #
+    # @example
+    #   button(:close, :value => '&Close')
+    #   # will generate 'close' and 'close_value' methods
+    #
+    # @param  [String]  the name used for the generated methods
+    # @param  [Hash]  locator for how the button is found
+    #
     def button(name, locator)
       define_method("#{name}") do |&block|
         adapter.button(locator).click &block
@@ -27,6 +62,22 @@ module Mohawk
       end
     end
 
+    #
+    # Generates methods to get the value of a combo box, set the selected
+    # item by both index and value as well as to see the available options
+    #
+    # @example
+    #   combo_box(:status, :id => 'statusComboBox')
+    #   # will generate 'status', 'status=' and 'status_options' methods
+    #
+    # @param  [String]  the name used for the generated methods
+    # @param  [Hash]  locator for how the combo box is found
+    #
+    # === Aliases
+    # * combobox
+    # * dropdown / drop_down
+    # * select_list
+    #
     def combo_box(name, locator)
       define_method("#{name}") do
         adapter.combo(locator).value
@@ -39,6 +90,17 @@ module Mohawk
       end
     end
 
+    #
+    # Generates methods to get/set the value of a checkbox as well as
+    # to get the text value of the control
+    #
+    # @example
+    #   checkbox(:include, :id => 'checkBoxId')
+    #   # will generate 'include', 'include=' and 'include_value' methods
+    #
+    # @param  [String]  the name used for the generated methods
+    # @param  [Hash]  locator for how the checkbox is found
+    #
     def checkbox(name, locator)
       define_method("#{name}") do
         adapter.checkbox(locator).checked?
@@ -51,6 +113,17 @@ module Mohawk
       end
     end
 
+    #
+    # Generates methods to set a radio button as well as see if one
+    # is selected
+    #
+    # @example
+    #   radio(:morning, :id => 'morningRadio')
+    #   # will generate 'morning' and 'morning?' methods
+    #
+    # @param  [String]  the name used for the generated methods
+    # @param  [Hash]  locator for how the radio is found
+    #
     def radio(name, locator)
       define_method("#{name}") do
         adapter.radio(locator).set
@@ -59,5 +132,113 @@ module Mohawk
         adapter.radio(locator).set?
       end
     end
+
+    #
+    # Generates methods to get the value of a label control
+    #
+    # @example
+    #   label(:login_info, :id => 'loginInfoLabel')
+    #   # will generate a 'login_info' method
+    #
+    # @param  [String]  the name used for the generated methods
+    # @param  [Hash]  locator for how the label is found
+    #
+    def label(name, locator)
+      define_method("#{name}") do
+        adapter.label(locator).value
+      end
+    end
+
+    # Generates methods to work with menu items
+    #
+    # @example
+    #   menu_item(:some_menu_item, :path => ["Path", "To", "A", "Menu Item"])
+    #   # will generate a 'some_menu_item' method to select a menu item
+    #
+    # @param  [String]  the name used for the generated methods
+    # @param  [Hash]  locator for how the label is found
+    #
+    def menu_item(name, locator)
+      define_method("#{name}") do
+        adapter.menu_item(locator).select
+      end
+    end
+
+    # Generates methods for working with table or list view controls
+    #
+    # @example
+    #   table(:some_table, :id => "tableId")
+    #   # will generate 'some_table=', 'some_table_rows' and 'some_table_row(item)' methods to
+    #   # select a table item, return all of the rows as well as return an individual row
+    #
+    # @param  [String]  the name used for the generated methods
+    # @param  [Hash]  locator for how the label is found
+    #
+    # === Aliases
+    # * listview
+    # * list_view
+    #
+    def table(name, locator)
+      define_method("#{name}=") do |which_item|
+        adapter.table(locator).select which_item
+      end
+      define_method("#{name}_rows") do
+        adapter.table(locator).rows
+      end
+      define_method("#{name}_row") do |which_row|
+        adapter.table(locator).row which_row
+      end
+      define_method("#{name}_view") do
+        adapter.table(locator).view
+      end
+    end
+
+    # Generates methods for working with tree view controls
+    #
+    # @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 
+    #   # items, expand an item (index or string) and collapse an item (index or string)
+    #
+    # @param  [String]  the name used for the generated methods
+    # @param  [Hash]  locator for how the label is found
+    #
+    # === Aliases
+    # * treeview
+    # * tree
+    #
+    def tree_view(name, locator)
+      define_method("#{name}") do
+        adapter.tree_view(locator).value
+      end
+      define_method("#{name}=") do |which_item|
+        adapter.tree_view(locator).select which_item
+      end
+      define_method("#{name}_items") do
+        adapter.tree_view(locator).items
+      end
+      define_method("expand_#{name}_item") do |which_item|
+        adapter.tree_view(locator).expand which_item
+      end
+      define_method("collapse_#{name}_item") do |which_item|
+        adapter.tree_view(locator).collapse which_item
+      end
+    end
+
+    # combo_box aliases
+    alias_method :combobox, :combo_box
+    alias_method :dropdown, :combo_box
+    alias_method :drop_down, :combo_box
+    alias_method :select_list, :combo_box
+
+    # table aliases
+    alias_method :listview, :table
+    alias_method :list_view, :table
+
+    # tree_view aliases
+    alias_method :treeview, :tree_view
+    alias_method :tree, :tree_view
+
   end
 end