Module: PageObject

Includes:

ElementLocators, LoadsPlatform, PagePopulator

Defined in:

lib/page-object.rb,
lib/page-object/version.rb,
lib/page-object/elements.rb,
lib/page-object/platforms.rb,
lib/page-object/accessors.rb,
lib/page-object/elements/div.rb,
lib/page-object/page_factory.rb,
lib/page-object/elements/span.rb,
lib/page-object/elements/form.rb,
lib/page-object/elements/link.rb,
lib/page-object/page_populator.rb,
lib/page-object/loads_platform.rb,
lib/page-object/elements/label.rb,
lib/page-object/elements/table.rb,
lib/page-object/elements/image.rb,
lib/page-object/nested_elements.rb,
lib/page-object/elements/button.rb,
lib/page-object/elements/option.rb,
lib/page-object/elements/element.rb,
lib/page-object/elements/heading.rb,
lib/page-object/element_locators.rb,
lib/page-object/javascript/jquery.rb,
lib/page-object/elements/paragraph.rb,
lib/page-object/elements/text_area.rb,
lib/page-object/elements/table_row.rb,
lib/page-object/elements/list_item.rb,
lib/page-object/elements/check_box.rb,
lib/page-object/elements/file_field.rb,
lib/page-object/elements/table_cell.rb,
lib/page-object/elements/text_field.rb,
lib/page-object/javascript/prototype.rb,
lib/page-object/elements/select_list.rb,
lib/page-object/elements/radio_button.rb,
lib/page-object/elements/hidden_field.rb,
lib/page-object/elements/ordered_list.rb,
lib/page-object/elements/unordered_list.rb,
lib/page-object/platforms/watir_webdriver.rb,
lib/page-object/javascript_framework_facade.rb,
lib/page-object/platforms/selenium_webdriver.rb,
lib/page-object/platforms/watir_webdriver/form.rb,
lib/page-object/platforms/watir_webdriver/table.rb,
lib/page-object/platforms/watir_webdriver/image.rb,
lib/page-object/platforms/selenium_webdriver/link.rb,
lib/page-object/platforms/watir_webdriver/element.rb,
lib/page-object/platforms/selenium_webdriver/form.rb,
lib/page-object/platforms/selenium_webdriver/image.rb,
lib/page-object/platforms/selenium_webdriver/table.rb,
lib/page-object/platforms/selenium_webdriver/button.rb,
lib/page-object/platforms/watir_webdriver/check_box.rb,
lib/page-object/platforms/watir_webdriver/text_area.rb,
lib/page-object/platforms/watir_webdriver/table_row.rb,
lib/page-object/platforms/watir_webdriver/file_field.rb,
lib/page-object/platforms/watir_webdriver/text_field.rb,
lib/page-object/platforms/selenium_webdriver/element.rb,
lib/page-object/platforms/watir_webdriver/page_object.rb,
lib/page-object/platforms/watir_webdriver/select_list.rb,
lib/page-object/platforms/selenium_webdriver/check_box.rb,
lib/page-object/platforms/selenium_webdriver/table_row.rb,
lib/page-object/platforms/watir_webdriver/ordered_list.rb,
lib/page-object/platforms/watir_webdriver/radio_button.rb,
lib/page-object/platforms/selenium_webdriver/text_area.rb,
lib/page-object/platforms/selenium_webdriver/text_field.rb,
lib/page-object/platforms/selenium_webdriver/file_field.rb,
lib/page-object/platforms/watir_webdriver/unordered_list.rb,
lib/page-object/platforms/selenium_webdriver/page_object.rb,
lib/page-object/platforms/selenium_webdriver/select_list.rb,
lib/page-object/platforms/selenium_webdriver/radio_button.rb,
lib/page-object/platforms/selenium_webdriver/ordered_list.rb,
lib/page-object/platforms/selenium_webdriver/unordered_list.rb,
lib/page-object/platforms/selenium_webdriver/surrogate_selenium_element.rb

Overview

class LoginPage
  include PageObject

  text_field(:username, :id => 'user')
  text_field(:password, :id => 'pass')
  button(:login, :value => 'Login')
end

...

browser = Watir::Browser.new :firefox
login_page = LoginPage.new(browser)
login_page.username = 'cheezy'
login_page.password = 'secret'
login_page.login

Defined Under Namespace

Modules: Accessors, ElementLocators, Elements, Javascript, JavascriptFrameworkFacade, LoadsPlatform, NestedElements, PageFactory, PagePopulator, Platforms

Constant Summary

VERSION =

"0.6.6"

Instance Attribute Summary (collapse)

• - (Watir::Browser or Selenium::WebDriver::Driver) browser readonly

  The platform browser passed to the constructor.

• - (PageObject::WatirPageObject or PageObject::SeleniumPageObject) platform readonly

  The platform page object.

Class Method Summary (collapse)

• + (Object) add_framework(key, framework)

  Add a new javascript framework to page-object.

• + (Object) included(cls)
• + (Object) javascript_framework=(framework)

  Set the javascript framework to use when determining number of ajax requests.

Instance Method Summary (collapse)

• - (String) alert(frame = nil, &block)

  Override the normal alert popup so it does not occurr.

• - (Object) attach_to_window(identifier, &block)

  Attach to a running window.

• - (Object) back

  Go back to the previous page.

• - (Object) clear_cookies

  Clear the cookies from the browser.

• - (String) confirm(response, frame = nil, &block)

  Override the normal confirm popup so it does not occurr.

• - (Object) current_url

  get the current page url.

• - (Object) element_with_focus

  Find the element that has focus on the page.

• - (Object) execute_script(script)

  Execute javascript on the browser.

• - (Object) forward

  Go forward to the next page.

• - (Object) html

  Returns the html of the current page.

• - (Object) in_frame(identifier, frame = nil, &block)

  Identify an element as existing within a frame or iframe.

• - (PageObject) initialize(browser, visit = false)

  Construct a new page object.

• - (Object) modal_dialog(&block)

  Override the normal showModalDialog call is it opens a window instead of a dialog.

• - (Object) navigate_to(url)

  navigate to the provided url.

• - (Hash) prompt(answer, frame = nil, &block)

  Override the normal promp popup so it does not occurr.

• - (Object) refresh

  Refresh to current page.

• - (Object) save_screenshot(file_name)

  Save the current screenshot to the provided url.

• - (Object) text

  Returns the text of the current page.

• - (Object) title

  Returns the title of the current page.

• - (Object) wait_for_ajax(timeout = 30, message = nil)

  Wait until there are no pending ajax requests.

• - (Object) wait_until(timeout = 30, message = nil, &block)

  Wait until the block returns true or times out.

Methods included from PagePopulator

#populate_page_with

Methods included from ElementLocators

#button_element, #button_elements, #cell_element, #cell_elements, #checkbox_element, #checkbox_elements, #div_element, #div_elements, #element, #file_field_element, #file_field_elements, #form_element, #form_elements, #h1_element, #h1_elements, #h2_element, #h2_elements, #h3_element, #h3_elements, #h4_element, #h4_elements, #h5_element, #h5_elements, #h6_element, #h6_elements, #hidden_field_element, #hidden_field_elements, #image_element, #image_elements, #label_element, #label_elements, #link_element, #link_elements, #list_item_element, #list_item_elements, #ordered_list_element, #ordered_list_elements, #paragraph_element, #paragraph_elements, #radio_button_element, #radio_button_elements, #select_list_element, #select_list_elements, #span_element, #span_elements, #table_element, #table_elements, #text_area_element, #text_area_elements, #text_field_element, #text_field_elements, #unordered_list_element, #unordered_list_elements

Methods included from LoadsPlatform

#load_platform

44
45
46

# File 'lib/page-object.rb', line 44

def browser
  @browser
end

46
47
48

# File 'lib/page-object.rb', line 46

def platform
  @platform
end

85
86
87

# File 'lib/page-object.rb', line 85

def self.add_framework(key, framework)
  PageObject::JavascriptFrameworkFacade.add_framework(key, framework)
end

63
64
65

# File 'lib/page-object.rb', line 63

def self.included(cls)
  cls.extend PageObject::Accessors
end

71
72
73

# File 'lib/page-object.rb', line 71

def self.javascript_framework=(framework)
  PageObject::JavascriptFrameworkFacade.framework = framework
end

message = @page.alert do
  @page.button_that_causes_alert
end

173
174
175

# File 'lib/page-object.rb', line 173

def alert(frame=nil, &block)
  platform.alert(frame, &block)
end

page.attach_to_window(:title => "other window's title")

278
279
280
281
282
283
284
285

# File 'lib/page-object.rb', line 278

def attach_to_window(identifier, &block)
  begin
    platform.attach_to_window(identifier, &block)
  rescue
    sleep 1
    platform.attach_to_window(identifier, &block)
  end
end

304
305
306

# File 'lib/page-object.rb', line 304

def back
  platform.back
end

318
319
320

# File 'lib/page-object.rb', line 318

def clear_cookies
  platform.clear_cookies
end

message = @popup.confirm(true) do
  @page.button_that_causes_confirm
end

190
191
192

# File 'lib/page-object.rb', line 190

def confirm(response, frame=nil, &block)
  platform.confirm(response, frame, &block)
end

92
93
94

# File 'lib/page-object.rb', line 92

def current_url
  platform.current_url
end

290
291
292

# File 'lib/page-object.rb', line 290

def element_with_focus
  platform.element_with_focus
end

215
216
217

# File 'lib/page-object.rb', line 215

def execute_script(script)
  platform.execute_script(script)
end

311
312
313

# File 'lib/page-object.rb', line 311

def forward
  platform.forward
end

115
116
117

# File 'lib/page-object.rb', line 115

def html
  platform.html
end

in_frame(:id => 'frame_id') do |frame|
  text_field_element(:id => 'fname', :frame => frame)
end

236
237
238

# File 'lib/page-object.rb', line 236

def in_frame(identifier, frame=nil, &block)
  platform.in_frame(identifier, frame, &block)
end

55
56
57
58
59
60

# File 'lib/page-object.rb', line 55

def initialize(browser, visit=false)
  @browser = browser
  include_platform_driver(browser)
  goto if visit && respond_to?(:goto)
  initialize_page if respond_to?(:initialize_page)
end

@page.modal_dialog do
  @page.action_that_spawns_the_modal
end

252
253
254
255
256
257
258
259
260
261
262
263

# File 'lib/page-object.rb', line 252

def modal_dialog(&block)
  script =
  %Q{
    window.showModalDialog = function(sURL, vArguments, sFeatures) {
      window.dialogArguments = vArguments;
      modalWin = window.open(sURL, 'modal', sFeatures);
      return modalWin;
    }
  }
  browser.execute_script script
  yield if block_given?
end

101
102
103

# File 'lib/page-object.rb', line 101

def navigate_to(url)
  platform.navigate_to(url)
end

message = @popup.prompt("Some Value") do
  @page.button_that_causes_prompt
end

208
209
210

# File 'lib/page-object.rb', line 208

def prompt(answer, frame=nil, &block)
  platform.prompt(answer, frame, &block)
end

297
298
299

# File 'lib/page-object.rb', line 297

def refresh
  platform.refresh
end

326
327
328

# File 'lib/page-object.rb', line 326

def save_screenshot(file_name)
  platform.save_screenshot file_name
end

108
109
110

# File 'lib/page-object.rb', line 108

def text
  platform.text
end

122
123
124

# File 'lib/page-object.rb', line 122

def title
  platform.title
end

151
152
153
154
155
156
157
158
159

# File 'lib/page-object.rb', line 151

def wait_for_ajax(timeout = 30, message = nil)
  end_time = ::Time.now + timeout
  until ::Time.now > end_time
    return if browser.execute_script(::PageObject::JavascriptFrameworkFacade.pending_requests) == 0
    sleep 0.5
  end
  message = "Timed out waiting for ajax requests to complete" unless message
  raise message
end

@page.wait_until(5, 'Success not found on page') do
  @page.text.include? 'Success'
end

138
139
140

# File 'lib/page-object.rb', line 138

def wait_until(timeout = 30, message = nil, &block)
  platform.wait_until(timeout, message, &block)
end