Module: Watir

Defined in:

lib/test-factory/gem_ext.rb

Overview

We are extending Watir’s element methods here with the #fit method, which can be used with text fields, select lists, radio buttons, and checkboxes.

The purpose of #fit is to allow the creation, in your Data Object classes, of a minimal number of #edit methods (ideally only one) written as concisely as possible.

Without the #fit method, you would either have to write separate edit methods for every possible field you want to edit, or else your edit method would have to contain lots of repetitive conditional code to prevent making inadvertent updates to those fields that don’t need it.

Proper use of the #fit method requires following a particular coding pattern, however:

• In your Page Classes, define your text field, select list, radio button, and checkbox elements directly. Do not define #select, #set and/or #clear actions there.

• Your data object’s instance variables for radio buttons and checkboxes, when not nil, should have the values of :set or :clear. If they need to be something else, then define a Hash transform method to easily convert the custom values back to :set or :clear, then pass that transform to the #fit method.

• Always remember to end your #edit methods with the #set_options() method (a.k.a. #update_options), from the DataFactory module. It automatically takes care of updating your data object’s instance variables with any new values.

Example

Let’s take a look at how the proper use of #fit in your code can significantly clean things up, using a checkbox field for our example. Remember that #fit works with radio buttons, text fields, and select lists, too.

First, here’s some code written without using #fit, and using actions for the checkbox page objects, and a Data Object instance variable, @option, that is either “YES” or “NO”…

class MyPage < BasePage
  # ...
  action(:check_checkbox) { |b| b.checkbox(id: "checkbox").set }
  action(:clear_checkbox) { |b| b.checkbox(id: "checkbox").clear }
  # ...
end

class DataObject
  # ...
  def edit opts={}
    # ...
    if opts[:option] != @option
      on MyPage do |page|
        if opts[:option] == "NO"
          page.clear_checkbox
        else
          page.check_checkbox
        end
      end
      @option = opts[:option]
    end
    # ...
  end
  # ...
end

That’s just nasty! Your Page Class has two element definitions that are nearly identical. And the nested conditional in the Data Object’s #edit method hurts the eyes!

Now, let’s take that same code, but this time use the #fit method. We’ll assume that the data object’s @option instance variable will be :set, :clear, or nil, and end the #edit with the DataFactory’s #set_options helper method…

class MyPage < BasePage
  # ...
  element(:checkbox) { |b| b.checkbox(id: "checkbox") }
  # ...
end

class DataObject
  # ...
  def edit opts={}
    # ...
    on MyPage do |page|
      # ...
      page.checkbox.fit opts[:option]
      # ...
    end
    # ...
    update_options opts
  end
  # ...
end

Much cleaner!

The #fit method is designed to allow for other values than just :set or :clear. It will support ‘Yes’, ‘No’, ‘on’, ‘off’ (and it’s case insensitive), true, and false, as well. This way you don’t have to worry so much about making methods that transform from one type to another.

Defined Under Namespace

Modules: UserEditable Classes: CheckBox, Radio, Select