Class: Watir::Browser

Inherits:
Object show all
Includes:
Container, HasWindow, Waitable
Defined in:
lib/watir/browser.rb,
lib/watir/extensions/nokogiri.rb

Overview

The main class through which you control the browser.

Constant Summary

Constants included from Atoms

Atoms::ATOMS

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Methods included from Waitable

#wait_until, #wait_until_present, #wait_while, #wait_while_present

Methods included from HasWindow

#window, #windows

Methods included from Container

#a, #abbr, #abbrs, #address, #addresses, #animate, #animate_motion, #animate_motions, #animate_transform, #animate_transforms, #animates, #area, #areas, #article, #articles, #as, #aside, #asides, #audio, #audios, #b, #base, #bases, #bdi, #bdis, #bdo, #bdos, #blockquote, #blockquotes, #body, #bodys, #br, #brs, #bs, #button, #buttons, #canvas, #canvases, #caption, #captions, #checkbox, #checkboxes, #circle, #circles, #cite, #cites, #code, #codes, #col, #colgroup, #colgroups, #cols, #cursor, #cursors, #data, #datalist, #datalists, #datas, #dd, #dds, #defs, #defss, #del, #dels, #desc, #descs, #details, #detailses, #dfn, #dfns, #dialog, #dialogs, #discard, #discards, #div, #divs, #dl, #dls, #dt, #dts, #element, #elements, #ellipse, #ellipses, #em, #embed, #embeds, #ems, #extract_selector, #field_set, #field_sets, #fieldset, #fieldsets, #figcaption, #figcaptions, #figure, #figures, #file_field, #file_fields, #font, #fonts, #footer, #footers, #foreign_object, #foreign_objects, #form, #forms, #frame, #frames, #frameset, #framesets, #g, #gs, #h1, #h1s, #h2, #h2s, #h3, #h3s, #h4, #h4s, #h5, #h5s, #h6, #h6s, #head, #header, #headers, #heads, #hgroup, #hgroups, #hidden, #hiddens, #hr, #hrs, #htmls, #i, #iframe, #iframes, #image, #images, #img, #imgs, #input, #inputs, #ins, #inses, #is, #kbd, #kbds, #keygen, #keygens, #label, #labels, #legend, #legends, #li, #line, #linear_gradient, #linear_gradients, #lines, #link, #links, #lis, #main, #mains, #map, #maps, #mark, #marker, #markers, #marks, #menu, #menuitem, #menuitems, #menus, #mesh_gradient, #mesh_gradients, #mesh_patch, #mesh_patches, #mesh_row, #mesh_rows, #meta, #metadata, #metadatas, #metas, #meter, #meters, #mpath, #mpaths, #nav, #navs, #noscript, #noscripts, #object, #objects, #ol, #ols, #optgroup, #optgroups, #option, #options, #output, #outputs, #p, #param, #params, #path, #paths, #pattern, #patterns, #polygon, #polygons, #polyline, #polylines, #pre, #pres, #progress, #progresses, #ps, #q, #qs, #radial_gradient, #radial_gradients, #radio, #radios, #rect, #rects, #rp, #rps, #rt, #rts, #rubies, #ruby, #s, #samp, #samps, #script, #scripts, #section, #sections, #select, #select_list, #select_lists, #selects, #set, #sets, #small, #smalls, #source, #sources, #span, #spans, #ss, #stop, #stops, #strong, #strongs, #style, #styles, #sub, #subs, #summaries, #summary, #sup, #sups, #svg, #svgs, #switch, #switches, #symbol, #symbols, #table, #tables, #tbody, #tbodys, #td, #tds, #template, #templates, #text_field, #text_fields, #text_path, #text_paths, #textarea, #textareas, #tfoot, #tfoots, #th, #thead, #theads, #ths, #time, #times, #titles, #tr, #track, #tracks, #trs, #tspan, #tspans, #u, #ul, #uls, #us, #use, #uses, #var, #vars, #video, #videos, #view, #views, #wbr, #wbrs

Methods included from Atoms

load

Methods included from XpathSupport

downcase, escape

Constructor Details

#initialize(browser = :chrome, *args) ⇒ Browser

Creates a Watir::Browser instance.



43
44
45
46
47
48
49
50
51
52
53
54
55
56
# File 'lib/watir/browser.rb', line 43

def initialize(browser = :chrome, *args)
  case browser
  when ::Symbol, String
    @driver = Selenium::WebDriver.for browser.to_sym, *args
  when Selenium::WebDriver::Driver
    @driver = browser
  else
    raise ArgumentError, "expected Symbol or Selenium::WebDriver::Driver, got #{browser.class}"
  end

  @after_hooks = AfterHooks.new(self)
  @current_frame  = nil
  @closed = false
end

Instance Attribute Details

#after_hooksObject (readonly)

Returns the value of attribute after_hooks



13
14
15
# File 'lib/watir/browser.rb', line 13

def after_hooks
  @after_hooks
end

#driverObject (readonly) Also known as: wd

Returns the value of attribute driver



12
13
14
# File 'lib/watir/browser.rb', line 12

def driver
  @driver
end

Class Method Details

.start(url, browser = :chrome, *args) ⇒ Watir::Browser

Creates a Watir::Browser instance and goes to URL.

Examples:

browser = Watir::Browser.start "www.google.com", :chrome
#=> #<Watir::Browser:0x..fa45a499cb41e1752 url="http://www.google.com" title="Google">


28
29
30
31
32
33
# File 'lib/watir/browser.rb', line 28

def start(url, browser = :chrome, *args)
  b = new(browser, *args)
  b.goto url

  b
end

Instance Method Details

#alertWatir::Alert

Handles JavaScript alerts, confirms and prompts.



194
195
196
# File 'lib/watir/browser.rb', line 194

def alert
  Alert.new(self)
end

#assert_existsObject Also known as: wait_for_exists, wait_for_present

This method is part of a private API. You should avoid using this method if possible, as it may be removed or be changed in the future.

Protocol shared with Watir::Element



308
309
310
311
312
313
314
315
316
317
# File 'lib/watir/browser.rb', line 308

def assert_exists
  if @closed
    raise Exception::Error, "browser was closed"
  elsif !window.present?
    raise Exception::NoMatchingWindowFoundException, "browser window was closed"
  else
    driver.switch_to.default_content
    true
  end
end

#backObject

Navigates back in history.



88
89
90
# File 'lib/watir/browser.rb', line 88

def back
  @driver.navigate.back
end

#browserObject



321
322
323
# File 'lib/watir/browser.rb', line 321

def browser
  self
end

#closeObject Also known as: quit

Closes browser.



135
136
137
138
139
# File 'lib/watir/browser.rb', line 135

def close
  return if @closed
  @driver.quit
  @closed = true
end

#cookiesWatir::Cookies

Handles cookies.



148
149
150
# File 'lib/watir/browser.rb', line 148

def cookies
  @cookies ||= Cookies.new driver.manage
end

#execute_script(script, *args) ⇒ Object

Executes JavaScript snippet.

If you are going to use the value snippet returns, make sure to use `return` explicitly.

Examples:

Check that Ajax requests are completed with jQuery

browser.execute_script("return jQuery.active") == 0
#=> true


257
258
259
260
261
262
# File 'lib/watir/browser.rb', line 257

def execute_script(script, *args)
  args.map! { |e| e.kind_of?(Watir::Element) ? e.wd : e }
  returned = @driver.execute_script(script, *args)

  wrap_elements_in(self, returned)
end

#exist?Boolean Also known as: exists?

Returns true if browser is not closed and false otherwise.



294
295
296
297
298
299
# File 'lib/watir/browser.rb', line 294

def exist?
  assert_exists
  true
rescue Exception::NoMatchingWindowFoundException, Exception::Error
  false
end

#forwardObject

Navigates forward in history.



96
97
98
# File 'lib/watir/browser.rb', line 96

def forward
  @driver.navigate.forward
end

#goto(uri) ⇒ String

Goes to the given URL.

Examples:

browser.goto "watir.github.io"


75
76
77
78
79
80
81
82
# File 'lib/watir/browser.rb', line 75

def goto(uri)
  uri = "http://#{uri}" unless uri =~ URI.regexp

  @driver.navigate.to uri
  @after_hooks.run

  uri
end

#htmlString

Returns HTML code of current page.



183
184
185
186
# File 'lib/watir/browser.rb', line 183

def html
  # use body.html instead?
  @driver.page_source
end

#inspectObject Also known as: selector_string



58
59
60
61
62
# File 'lib/watir/browser.rb', line 58

def inspect
  '#<%s:0x%x url=%s title=%s>' % [self.class, hash*2, url.inspect, title.inspect]
rescue
  '#<%s:0x%x closed=%s>' % [self.class, hash*2, @closed.to_s]
end

#nameSymbol

Returns browser name.

Examples:

browser = Watir::Browser.new :chrome
browser.name
#=> :chrome


163
164
165
# File 'lib/watir/browser.rb', line 163

def name
  @driver.browser
end

#ready_stateString

Returns readyState of document.



229
230
231
# File 'lib/watir/browser.rb', line 229

def ready_state
  execute_script 'return document.readyState'
end

#refreshObject

Refreshes current page.



202
203
204
205
# File 'lib/watir/browser.rb', line 202

def refresh
  @driver.navigate.refresh
  @after_hooks.run
end

#screenshotWatir::Screenshot

Handles screenshots of current pages.



284
285
286
# File 'lib/watir/browser.rb', line 284

def screenshot
  Screenshot.new driver
end

#send_keys(*args) ⇒ Object

Sends sequence of keystrokes to currently active element.

Examples:

browser.goto "www.google.com"
browser.send_keys "Watir", :return


274
275
276
# File 'lib/watir/browser.rb', line 274

def send_keys(*args)
  @driver.switch_to.active_element.send_keys(*args)
end

#statusString

Returns the text of status bar.



239
240
241
# File 'lib/watir/browser.rb', line 239

def status
  execute_script "return window.status;"
end

#textString

Returns text of page body.



173
174
175
# File 'lib/watir/browser.rb', line 173

def text
  body.text
end

#titleString

Returns title of current page.

Examples:

browser.goto "watir.github.io"
browser.title
#=> "Watir is... – Watir Project – Watir stands for Web Application Testing In Ruby. It facilitates the writing of automated tests by mimicking the behavior of a user interacting with a website."


127
128
129
# File 'lib/watir/browser.rb', line 127

def title
  @driver.title
end

#urlString

Returns URL of current page.

Examples:

browser.goto "watir.github.io"
browser.url
#=> "http://watir.github.io/"


111
112
113
114
# File 'lib/watir/browser.rb', line 111

def url
  assert_exists
  @driver.current_url
end

#wait(timeout = 5) ⇒ Object

Waits until readyState of document is complete.

Examples:

browser.wait

Raises:



217
218
219
220
221
# File 'lib/watir/browser.rb', line 217

def wait(timeout = 5)
  wait_until(timeout: timeout, message: "waiting for document.readyState == 'complete'") do
    ready_state == "complete"
  end
end