Module: Symbiont::Page

Includes:
Helpers
Defined in:
lib/symbiont/pages.rb

Instance Method Summary collapse

Instance Method Details

#asserted_title ⇒ Object 



34
35
36
 
# File 'lib/symbiont/pages.rb', line 34

def asserted_title
  self.class.asserted_title
end

#asserted_url ⇒ Object 



26
27
28
 
# File 'lib/symbiont/pages.rb', line 26

def asserted_url
  self.class.asserted_url
end

#clear_cookies ⇒ Object Also known as: remove_cookies 



75
76
77
 
# File 'lib/symbiont/pages.rb', line 75

def clear_cookies
  browser.cookies.clear
end

#get_cookie(name) ⇒ Object 



66
67
68
69
70
71
72
73
 
# File 'lib/symbiont/pages.rb', line 66

def get_cookie(name)
  for cookie in browser.cookies.to_a
    if cookie[:name] == name
      return cookie[:value]
    end
  end
  nil
end

#has_correct_title? ⇒ Boolean

Returns:

  • (Boolean) 


16
17
18
19
 
# File 'lib/symbiont/pages.rb', line 16

def has_correct_title?
  no_title_is_provided if asserted_title.nil?
  !(browser.title.match(asserted_title)).nil?
end

#has_correct_url? ⇒ Boolean

Returns:

  • (Boolean) 


11
12
13
14
 
# File 'lib/symbiont/pages.rb', line 11

def has_correct_url?
  no_url_matches_is_provided if url_match.nil?
  !(browser.url =~ url_match).nil?
end

#markup ⇒ Object Also known as: html 



42
43
44
 
# File 'lib/symbiont/pages.rb', line 42

def markup
  browser.html
end

#refresh ⇒ Object Also known as: refresh_page 



79
80
81
 
# File 'lib/symbiont/pages.rb', line 79

def refresh
  browser.refresh
end

#run_script(script, *args) ⇒ Object Also known as: execute_script 



62
63
64
 
# File 'lib/symbiont/pages.rb', line 62

def run_script(script, *args)
  browser.execute_script(script, *args)
end

#screenshot(file) ⇒ Object Also known as: save_screenshot 



58
59
60
 
# File 'lib/symbiont/pages.rb', line 58

def screenshot(file)
  browser.wd.save_screenshot(file)
end

#text ⇒ Object Also known as: page_text 



46
47
48
 
# File 'lib/symbiont/pages.rb', line 46

def text
  browser.text
end

#title ⇒ Object Also known as: page_title 



50
51
52
 
# File 'lib/symbiont/pages.rb', line 50

def title
  browser.title
end

#url ⇒ Object Also known as: current_url, page_url 



38
39
40
 
# File 'lib/symbiont/pages.rb', line 38

def url
  browser.url
end

#url_match ⇒ Object 



30
31
32
 
# File 'lib/symbiont/pages.rb', line 30

def url_match
  self.class.url_match
end

#verified? ⇒ Boolean

Returns:

  • (Boolean) 


21
22
23
24
 
# File 'lib/symbiont/pages.rb', line 21

def verified?
  has_correct_url?
  has_correct_title?
end

#view ⇒ Object 



5
6
7
8
9
 
# File 'lib/symbiont/pages.rb', line 5

def view
  no_url_is_provided if asserted_url.nil?
  browser.goto(asserted_url)
  self
end

#visit(url) ⇒ Object Also known as: navigate_to, goto 



54
55
56
 
# File 'lib/symbiont/pages.rb', line 54

def visit(url)
  browser.goto(url)
end

#will_alert(&block) ⇒ String

Returns the message contained in the alert message box.

Parameters:

  • block (Proc) —

    the code that generates the alert

Returns:

  • (String) —

    the message contained in the alert message box



85
86
87
88
89
90
91
92
93
 
# File 'lib/symbiont/pages.rb', line 85

def will_alert(&block)
  yield
  value = nil
  if browser.alert.exists?
    value = browser.alert.text
    browser.alert.ok
  end
  value
end

#will_confirm(response, &block) ⇒ String

Returns the message contained in the confirmation message box.

Parameters:

  • response (Boolean) —

    true to accept the confirmation, false to cancel it

  • block (Proc) —

    the code that generates the confirmation

Returns:

  • (String) —

    the message contained in the confirmation message box



98
99
100
101
102
103
104
105
106
 
# File 'lib/symbiont/pages.rb', line 98

def will_confirm(response, &block)
  yield
  value = nil
  if browser.alert.exists?
    value = browser.alert.text
    response ? browser.alert.ok : browser.alert.close
  end
  value
end

#will_prompt(response, &block) ⇒ Hash

the value that the prompt had before the response was applied

Parameters:

  • response (String) —

    the value to be used in the prompt

  • block (Proc) —

    the code that generates the prompt

Returns:

  • (Hash) —

    :message for the prompt message, :default_value for



112
113
114
115
116
117
118
119
 
# File 'lib/symbiont/pages.rb', line 112

def will_prompt(response, &block)
  cmd = "window.prompt = function(text, value) {window.__lastWatirPrompt = {message: text, default_value: value}; return '#{response}';}"
  browser.wd.execute_script(cmd)
  yield
  result = browser.wd.execute_script('return window.__lastWatirPrompt')
  result && result.dup.each_key { |k| result[k.to_sym] = result.delete(k) }
  result
end

#within_modal(&block) ⇒ Object

Used to identify a web element as existing within an enclosing object like a modal dialog box. What this does is override the normal call to showModalDialog and opens a window instead. In order to use this new window, you have to attach to it.



138
139
140
141
142
143
144
145
146
147
148
 
# File 'lib/symbiont/pages.rb', line 138

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

#within_window(locator, &block) ⇒ Object Also known as: select_window, attach_to

Used to identify a web element or action on a web element as existing within an enclosing window object. The window can be referenced using either the title attribute of the window or a direct URL. The URL does not have to be the entire URL; it can just be a page name.

action on or within the window

Parameters:

  • locator (Hash) —

    the :title or :url of the window

  • block (Proc) —

    any code that should be executed as an



129
130
131
132
 
# File 'lib/symbiont/pages.rb', line 129

def within_window(locator, &block)
  identifier = {locator.keys.first => /#{Regexp.escape(locator.values.first)}/}
  browser.window(identifier).use(&block)
end