Class: Ferrum::Node

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

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(page, target_id, node_id, description) ⇒ Node

Returns a new instance of Node.



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

def initialize(page, target_id, node_id, description)
  @page, @target_id = page, target_id
  @node_id, @description = node_id, description
  @tag_name = description["nodeName"].downcase
end

Instance Attribute Details

#description ⇒ Object (readonly)

Returns the value of attribute description.



5
6
7
 
# File 'lib/ferrum/node.rb', line 5

def description
  @description
end

#node_id ⇒ Object (readonly)

Returns the value of attribute node_id.



5
6
7
 
# File 'lib/ferrum/node.rb', line 5

def node_id
  @node_id
end

#page ⇒ Object (readonly)

Returns the value of attribute page.



5
6
7
 
# File 'lib/ferrum/node.rb', line 5

def page
  @page
end

#tag_name ⇒ Object (readonly)

Returns the value of attribute tag_name.



5
6
7
 
# File 'lib/ferrum/node.rb', line 5

def tag_name
  @tag_name
end

#target_id ⇒ Object (readonly)

Returns the value of attribute target_id.



5
6
7
 
# File 'lib/ferrum/node.rb', line 5

def target_id
  @target_id
end

Instance Method Details

#==(other) ⇒ Object 



101
102
103
104
105
106
107
 
# File 'lib/ferrum/node.rb', line 101

def ==(other)
  return false unless other.is_a?(Node)
  # We compare backendNodeId because once nodeId is sent to frontend backend
  # never returns same nodeId sending 0. In other words frontend is
  # responsible for keeping track of node ids.
  target_id == other.target_id && description["backendNodeId"] == other.description["backendNodeId"]
end

#at_css(selector) ⇒ Object 



64
65
66
 
# File 'lib/ferrum/node.rb', line 64

def at_css(selector)
  page.at_css(selector, within: self)
end

#at_xpath(selector) ⇒ Object 



60
61
62
 
# File 'lib/ferrum/node.rb', line 60

def at_xpath(selector)
  page.at_xpath(selector, within: self)
end

#attribute(name) ⇒ Object 



93
94
95
 
# File 'lib/ferrum/node.rb', line 93

def attribute(name)
  evaluate("this.getAttribute('#{name}')")
end

#blur ⇒ Object 



21
22
23
 
# File 'lib/ferrum/node.rb', line 21

def blur
  tap { evaluate("this.blur()") }
end

#click(mode: :left, keys: [], offset: {}) ⇒ Object

mode: (:left | :right | :double) keys: (:alt, (:ctrl | :control), (:meta | :command), :shift) offset: { :x, :y }



32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
 
# File 'lib/ferrum/node.rb', line 32

def click(mode: :left, keys: [], offset: {})
  x, y = find_position(offset[:x], offset[:y])
  modifiers = page.keyboard.modifiers(keys)

  case mode
  when :right
    page.mouse.move(x: x, y: y)
    page.mouse.down(button: :right, modifiers: modifiers)
    page.mouse.up(button: :right, modifiers: modifiers)
  when :double
    page.mouse.move(x: x, y: y)
    page.mouse.down(modifiers: modifiers, count: 2)
    page.mouse.up(modifiers: modifiers, count: 2)
  when :left
    page.mouse.click(x: x, y: y, modifiers: modifiers)
  end

  self
end

#css(selector) ⇒ Object 



72
73
74
 
# File 'lib/ferrum/node.rb', line 72

def css(selector)
  page.css(selector, within: self)
end

#evaluate(expression) ⇒ Object 



97
98
99
 
# File 'lib/ferrum/node.rb', line 97

def evaluate(expression)
  page.evaluate_on(node: self, expression: expression)
end

#find_position(offset_x = nil, offset_y = nil) ⇒ Object 



113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
 
# File 'lib/ferrum/node.rb', line 113

def find_position(offset_x = nil, offset_y = nil)
  quads = get_content_quads
  offset_x, offset_y = offset_x.to_i, offset_y.to_i

  if offset_x > 0 || offset_y > 0
    point = quads.first
    [point[:x] + offset_x, point[:y] + offset_y]
  else
    x, y = quads.inject([0, 0]) do |memo, point|
      [memo[0] + point[:x],
       memo[1] + point[:y]]
    end
    [x / 4, y / 4]
  end
end

#focus ⇒ Object 



17
18
19
 
# File 'lib/ferrum/node.rb', line 17

def focus
  tap { page.command("DOM.focus", nodeId: node_id) }
end

#hover ⇒ Object

Raises:



52
53
54
 
# File 'lib/ferrum/node.rb', line 52

def hover
  raise NotImplementedError
end

#inner_text ⇒ Object

FIXME: clear API for text and inner_text



81
82
83
 
# File 'lib/ferrum/node.rb', line 81

def inner_text
  evaluate("this.innerText")
end

#inspect ⇒ Object 



109
110
111
 
# File 'lib/ferrum/node.rb', line 109

def inspect
  %(#<#{self.class} @target_id=#{@target_id.inspect} @node_id=#{@node_id} @description=#{@description.inspect}>)
end

#node? ⇒ Boolean

Returns:

  • (Boolean) 


13
14
15
 
# File 'lib/ferrum/node.rb', line 13

def node?
  description["nodeType"] == 1 # nodeType: 3, nodeName: "#text" e.g.
end

#property(name) ⇒ Object 



89
90
91
 
# File 'lib/ferrum/node.rb', line 89

def property(name)
  evaluate("this['#{name}']")
end

#select_file(value) ⇒ Object 



56
57
58
 
# File 'lib/ferrum/node.rb', line 56

def select_file(value)
  page.command("DOM.setFileInputFiles", nodeId: node_id, files: Array(value))
end

#text ⇒ Object 



76
77
78
 
# File 'lib/ferrum/node.rb', line 76

def text
  evaluate("this.textContent")
end

#type(*keys) ⇒ Object 



25
26
27
 
# File 'lib/ferrum/node.rb', line 25

def type(*keys)
  tap { page.keyboard.type(*keys) }
end

#value ⇒ Object 



85
86
87
 
# File 'lib/ferrum/node.rb', line 85

def value
  evaluate("this.value")
end

#xpath(selector) ⇒ Object 



68
69
70
 
# File 'lib/ferrum/node.rb', line 68

def xpath(selector)
  page.xpath(selector, within: self)
end