Class: Puppeteer::CustomQueryHandler

Inherits:
Object
  • Object
show all
Defined in:
lib/puppeteer/custom_query_handler.rb

Instance Method Summary collapse

Constructor Details

#initialize(query_one: nil, query_all: nil) ⇒ CustomQueryHandler

Returns a new instance of CustomQueryHandler.

Parameters:

  • query_one (String) (defaults to: nil) —

    JS function (element: Element | Document, selector: string) => Element | null;

  • query_all (String) (defaults to: nil) —

    JS function (element: Element | Document, selector: string) => Element[] | NodeListOf<Element>;



4
5
6
7
 
# File 'lib/puppeteer/custom_query_handler.rb', line 4

def initialize(query_one: nil, query_all: nil)
  @query_one = query_one
  @query_all = query_all
end

Instance Method Details

#query_all(element, selector) ⇒ Object 



59
60
61
62
63
64
65
66
67
68
 
# File 'lib/puppeteer/custom_query_handler.rb', line 59

def query_all(element, selector)
  unless @query_all
    raise NotImplementedError.new("#{self.class}##{__method__} is not implemented.")
  end

  handles = element.evaluate_handle(@query_all, selector)
  properties = handles.properties
  handles.dispose
  properties.values.map(&:as_element).compact
end

#query_all_array(element, selector) ⇒ Object 



70
71
72
73
74
75
76
77
 
# File 'lib/puppeteer/custom_query_handler.rb', line 70

def query_all_array(element, selector)
  unless @query_all
    raise NotImplementedError.new("#{self.class}##{__method__} is not implemented.")
  end

  handles = element.evaluate_handle(@query_all, selector)
  handles.evaluate_handle('(res) => Array.from(res)')
end

#query_one(element, selector) ⇒ Object 



9
10
11
12
13
14
15
16
17
18
19
20
21
22
 
# File 'lib/puppeteer/custom_query_handler.rb', line 9

def query_one(element, selector)
  unless @query_one
    raise NotImplementedError.new("#{self.class}##{__method__} is not implemented.")
  end

  handle = element.evaluate_handle(@query_one, selector)
  element = handle.as_element

  if element
    return element
  end
  handle.dispose
  nil
end

#wait_for(element_or_frame, selector, visible: nil, hidden: nil, timeout: nil) ⇒ Object 



24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
 
# File 'lib/puppeteer/custom_query_handler.rb', line 24

def wait_for(element_or_frame, selector, visible: nil, hidden: nil, timeout: nil)
  case element_or_frame
  when Puppeteer::Frame
    frame = element_or_frame
    element = nil
  when Puppeteer::ElementHandle
    frame = element_or_frame.frame
    element = frame.puppeteer_world.adopt_handle(element_or_frame)
  else
    raise ArgumentError.new("element_or_frame must be a Frame or ElementHandle. #{element_or_frame.inspect}")
  end

  unless @query_one
    raise NotImplementedError.new("#{self.class}##{__method__} is not implemented.")
  end

  result = frame.puppeteer_world.send(:wait_for_selector_in_page,
    @query_one,
    element,
    selector,
    visible: visible,
    hidden: hidden,
    timeout: timeout,
  )

  element&.dispose

  if result.is_a?(Puppeteer::ElementHandle)
    result.frame.main_world.transfer_handle(result)
  else
    result&.dispose
    nil
  end
end