Class: AutomationObject::Driver::Driver

Inherits:
Base
  • Object
show all
Defined in:
lib/automation_object/driver/driver.rb

Overview

Driver adapter interface Adapters should meet this interface standard

Instance Attribute Summary

Attributes inherited from Base

#adapter

Instance Method Summary collapse

Methods inherited from Base

#initialize

Constructor Details

This class inherits a constructor from AutomationObject::Driver::Base

Instance Method Details

#accept_prompt ⇒ Object

Accept prompt either in browser or mobile



75
76
77
 
# File 'lib/automation_object/driver/driver.rb', line 75

def accept_prompt
  adapter.accept_prompt
end

#back ⇒ void

This method returns an undefined value.

Go back



42
43
44
 
# File 'lib/automation_object/driver/driver.rb', line 42

def back
  adapter.back
end

#browser? ⇒ Boolean

Check if browser, more useful for Appium but can be generic here

Returns:

  • (Boolean) —

    whether or not browser is being used



86
87
88
 
# File 'lib/automation_object/driver/driver.rb', line 86

def browser?
  adapter.browser?
end

#close ⇒ void

This method returns an undefined value.

Close current window



92
93
94
 
# File 'lib/automation_object/driver/driver.rb', line 92

def close
  adapter.close
end

#dismiss_prompt ⇒ Object

Dismiss the prompt



80
81
82
 
# File 'lib/automation_object/driver/driver.rb', line 80

def dismiss_prompt
  adapter.dismiss_prompt
end

#document_complete? ⇒ Boolean

Run script in browser to check if document in JS is complete

Returns:

  • (Boolean) —

    document is complete



116
117
118
 
# File 'lib/automation_object/driver/driver.rb', line 116

def document_complete?
  adapter.document_complete?
end

#execute_script(script) ⇒ Object?

Parameters:

  • script (String) —

    JS to run

Returns:

  • (Object, nil) 


122
123
124
 
# File 'lib/automation_object/driver/driver.rb', line 122

def execute_script(script)
  adapter.execute_script(script)
end

#exists?(selector_type, selector_path) ⇒ Boolean

Returns exists or not

Parameters:

  • selector_type (Symbol) —

    selector type (:css, :xpath, etc...)

  • selector_path (String) —

    path to element

Returns:

  • (Boolean) —

    exists or not



56
57
58
 
# File 'lib/automation_object/driver/driver.rb', line 56

def exists?(selector_type, selector_path)
  adapter.exists?(selector_type, selector_path)
end

#find_element(selector_type, selector_path) ⇒ AutomationObject::Driver::Element

Returns element

Parameters:

  • selector_type (Symbol) —

    selector type, :css, :xpath, etc...

  • selector_path (String) —

    path to element

Returns:



63
64
65
 
# File 'lib/automation_object/driver/driver.rb', line 63

def find_element(selector_type, selector_path)
  adapter.find_element(selector_type, selector_path)
end

#find_elements(selector_type, selector_path) ⇒ Array<AutomationObject::Driver::Element>

Returns elements

Parameters:

  • selector_type (Symbol) —

    selector type, :css, :xpath, etc...

  • selector_path (String) —

    path to element

Returns:



70
71
72
 
# File 'lib/automation_object/driver/driver.rb', line 70

def find_elements(selector_type, selector_path)
  adapter.find_elements(selector_type, selector_path)
end

#forward ⇒ void

This method returns an undefined value.

Go forward



36
37
38
 
# File 'lib/automation_object/driver/driver.rb', line 36

def forward
  adapter.forward
end

#get(url) ⇒ void

This method returns an undefined value.

Navigates current window to a given url

Parameters:

  • url (String) —

    navigate to the following url



18
19
20
 
# File 'lib/automation_object/driver/driver.rb', line 18

def get(url)
  adapter.get(url)
end

#inner_window_height ⇒ Float

Returns inner window height

Returns:

  • (Float) —

    inner window height



132
133
134
 
# File 'lib/automation_object/driver/driver.rb', line 132

def inner_window_height
  adapter.inner_window_height
end

#quit ⇒ Object

Destroy the driver



137
138
139
 
# File 'lib/automation_object/driver/driver.rb', line 137

def quit
  adapter.quit
end

#refresh ⇒ void

This method returns an undefined value.

Refreshes current window



30
31
32
 
# File 'lib/automation_object/driver/driver.rb', line 30

def refresh
  adapter.refresh
end

#scroll_position ⇒ Point

Returns x,y scroll position

Returns:

  • (Point) —

    x,y scroll position



127
128
129
 
# File 'lib/automation_object/driver/driver.rb', line 127

def scroll_position
  adapter.scroll_position
end

#title ⇒ String

Get the title of the document

Returns:



24
25
26
 
# File 'lib/automation_object/driver/driver.rb', line 24

def title
  adapter.title
end

#wait(timeout = nil) ⇒ void

This method returns an undefined value.

Set timeout wait

Parameters:

  • timeout (Integer) (defaults to: nil) —

    the timeout in seconds



49
50
51
 
# File 'lib/automation_object/driver/driver.rb', line 49

def wait(timeout = nil)
  adapter.wait(timeout)
end

#window_handle ⇒ String

Current window handle

Returns:



104
105
106
 
# File 'lib/automation_object/driver/driver.rb', line 104

def window_handle
  adapter.window_handle
end

#window_handle=(handle_value) ⇒ Object

Set current window handle to, will switch windows

Parameters:

  • handle_value (String) —

    window handle value



110
111
112
 
# File 'lib/automation_object/driver/driver.rb', line 110

def window_handle=(handle_value)
  adapter.window_handle = handle_value
end

#window_handles ⇒ Array<String>

Window Handles

Returns:

  • (Array<String>) —

    array of window handle ids



98
99
100
 
# File 'lib/automation_object/driver/driver.rb', line 98

def window_handles
  adapter.window_handles
end