Class: Akephalos::Node

Inherits:
Object
  • Object
show all
Defined in:
lib/akephalos/node.rb

Overview

Akephalos::Node wraps HtmlUnit’s DOMNode class, providing a simple API for interacting with an element on the page.

Instance Method Summary collapse

Constructor Details

#initialize(node) ⇒ Node

Returns a new instance of Node.

Parameters:

  • node (HtmlUnit::DOMNode) 


7
8
9
10
 
# File 'lib/akephalos/node.rb', line 7

def initialize(node)
  @nodes = []
  @_node = node
end

Instance Method Details

#[](name) ⇒ String?

Return the value of the node’s attribute.

Parameters:

  • name (String) —

    attribute on node

Returns:

  • (String) —

    the value of the named attribute

  • (nil) —

    when the node does not have the named attribute



47
48
49
 
# File 'lib/akephalos/node.rb', line 47

def [](name)
  @_node.hasAttribute(name.to_s) ? @_node.getAttribute(name.to_s) : nil
end

#checked? ⇒ true, false

Returns whether the element is checked.

Returns:

  • (true, false) —

    whether the element is checked



13
14
15
16
17
18
19
 
# File 'lib/akephalos/node.rb', line 13

def checked?
  if @_node.respond_to?(:isChecked)
    @_node.isChecked
  else
    !! self[:checked]
  end
end

#click ⇒ Object

Click the node and then wait for any triggered JavaScript callbacks to fire.



166
167
168
169
 
# File 'lib/akephalos/node.rb', line 166

def click
  @_node.click
  @_node.getPage.getWebClient.waitForBackgroundJavaScriptStartingBefore(3000)
end

#file_input? ⇒ true, false

Returns whether the node is a file input.

Returns:

  • (true, false) —

    whether the node is a file input



107
108
109
 
# File 'lib/akephalos/node.rb', line 107

def file_input?
  tag_name == "input" && @_node.getAttribute("type") == "file"
end

#find(selector) ⇒ Array<Node>

Search for child nodes which match the given XPath selector.

Parameters:

  • selector (String) —

    an XPath selector

Returns:

  • (Array<Node>) —

    the matched nodes



175
176
177
178
179
 
# File 'lib/akephalos/node.rb', line 175

def find(selector)
  nodes = @_node.getByXPath(selector).map { |node| Node.new(node) }
  @nodes << nodes
  nodes
end

#fire_event(name) ⇒ Object

Fire a JavaScript event on the current node. Note that you should not prefix event names with “on”, so:

link.fire_event('mousedown')

Parameters:

  • JavaScript (String) —

    event name



139
140
141
 
# File 'lib/akephalos/node.rb', line 139

def fire_event(name)
  @_node.fireEvent(name)
end

#multiple_select? ⇒ true, false

Returns whether the node allows multiple-option selection (if the node is a select).

Returns:

  • (true, false) —

    whether the node allows multiple-option selection (if the node is a select).



102
103
104
 
# File 'lib/akephalos/node.rb', line 102

def multiple_select?
  !self[:multiple].nil?
end

#options ⇒ Array<Node>

Return the option elements for a select box.

Returns:

  • (Array<Node>) —

    the options



122
123
124
 
# File 'lib/akephalos/node.rb', line 122

def options
  @_node.getOptions.map { |node| Node.new(node) }
end

#selected? ⇒ true, false

for CSS.

Returns:

  • (true, false) —

    whether the node is selected to the user accounting



156
157
158
159
160
161
162
 
# File 'lib/akephalos/node.rb', line 156

def selected?
  if @_node.respond_to?(:isSelected)
    @_node.isSelected
  else
    !! self[:selected]
  end
end

#selected_options ⇒ Array<Node>

Return the selected option elements for a select box.

Returns:

  • (Array<Node>) —

    the selected options



129
130
131
 
# File 'lib/akephalos/node.rb', line 129

def selected_options
  @_node.getSelectedOptions.map { |node| Node.new(node) }
end

#tag_name ⇒ String

Returns the node’s tag name.

Returns:

  • (String) —

    the node’s tag name



144
145
146
 
# File 'lib/akephalos/node.rb', line 144

def tag_name
  @_node.getNodeName
end

#text ⇒ String

Returns a textual representation of this element that represents what would be visible to the user if this page was shown in a web browser. For example, a single-selection select element would return the currently selected value as text. Note: This will cleanup/reduce whitespace

Returns:

  • (String) —

    inner text of the node



27
28
29
 
# File 'lib/akephalos/node.rb', line 27

def text
  @_node.asText
end

#text_content ⇒ Object

Returns the raw text content of this node and its descendants…



32
33
34
 
# File 'lib/akephalos/node.rb', line 32

def text_content
  @_node.getTextContent
end

#type(value) ⇒ Object

Types each character into a text or input field.

Parameters:

  • value (String) —

    the string to type



95
96
97
98
99
 
# File 'lib/akephalos/node.rb', line 95

def type(value)
  value.each_char do |c|
    @_node.type(c)
  end
end

#unselect ⇒ true, false

Unselect an option.

Returns:

  • (true, false) —

    whether the unselection was successful



115
116
117
 
# File 'lib/akephalos/node.rb', line 115

def unselect
  @_node.setSelected(false)
end

#value ⇒ String+

Return the value of a form element. If the element is a select box and has “multiple” declared as an attribute, then all selected options will be returned as an array.

Returns:

  • (String, Array<String>) —

    the node’s value



56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
 
# File 'lib/akephalos/node.rb', line 56

def value
  case tag_name
  when "select"
    if self[:multiple]
      selected_options.map { |option| option.value }
    else
      selected_option = @_node.selected_options.first
      selected_option ? Node.new(selected_option).value : nil
    end
  when "option"
    self[:value] || text
  when "textarea"
    @_node.getText
  else
    self[:value]
  end
end

#value=(value) ⇒ Object

Set the value of the form input.

Parameters:

  • value (String) 


77
78
79
80
81
82
83
84
85
86
87
88
89
90
 
# File 'lib/akephalos/node.rb', line 77

def value=(value)
  case tag_name
  when "textarea"
    @_node.setText("")
    type(value)
  when "input"
    if file_input?
      @_node.setValueAttribute(value)
    else
      @_node.setValueAttribute("")
      type(value)
    end
  end
end

#visible? ⇒ true, false

for CSS.

Returns:

  • (true, false) —

    whether the node is visible to the user accounting



150
151
152
 
# File 'lib/akephalos/node.rb', line 150

def visible?
  @_node.isDisplayed
end

#xml ⇒ Object

Returns a string representation of the XML document from this element and all it’s children (recursively). The charset used is the current page encoding.



38
39
40
 
# File 'lib/akephalos/node.rb', line 38

def xml
  @_node.asXml
end

#xpath ⇒ String

Returns the XPath expression for this node.

Returns:

  • (String) —

    the XPath expression for this node



182
183
184
 
# File 'lib/akephalos/node.rb', line 182

def xpath
  @_node.getCanonicalXPath
end