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

Raises:

  • (NotImplementedError) 


73
74
75
76
77
78
79
80
81
82
83
84
 
# File 'lib/puppeteer/custom_query_handler.rb', line 73

def query_all(element, selector)
  if @query_all
    return query_all_with_query_all(element, selector)
  end

  if @query_one
    element_handle = query_one_with_query_one(element, selector)
    return element_handle ? [element_handle] : []
  end

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

#query_all_array(element, selector) ⇒ Object

Raises:

  • (NotImplementedError) 


86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
 
# File 'lib/puppeteer/custom_query_handler.rb', line 86

def query_all_array(element, selector)
  if @query_all
    handles = element.evaluate_handle(@query_all, selector)
    begin
      return handles.evaluate_handle('(res) => Array.from(res)')
    ensure
      handles.dispose
    end
  end

  if @query_one
    elements = query_all(element, selector)
    begin
      return element.execution_context.evaluate_handle('(...elements) => elements', *elements)
    ensure
      elements.each(&:dispose)
    end
  end

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

#query_one(element, selector) ⇒ Object

Raises:

  • (NotImplementedError) 


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

def query_one(element, selector)
  if @query_one
    return query_one_with_query_one(element, selector)
  end

  if @query_all
    elements = query_all_with_query_all(element, selector)
    return nil if elements.empty?

    first = elements.shift
    elements.each(&:dispose)
    return first
  end

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

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



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
58
59
60
61
62
63
64
65
66
67
68
69
70
71
 
# File 'lib/puppeteer/custom_query_handler.rb', line 26

def wait_for(element_or_frame, selector, visible: nil, hidden: nil, timeout: nil, polling: 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

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

    if result.is_a?(Puppeteer::ElementHandle)
      result.frame.main_world.transfer_handle(result)
    else
      result&.dispose
      nil
    end
  rescue => err
    wait_for_selector_error =
      if err.is_a?(Puppeteer::TimeoutError)
        Puppeteer::TimeoutError.new("Waiting for selector `#{selector}` failed")
      else
        Puppeteer::Error.new("Waiting for selector `#{selector}` failed")
      end
    wait_for_selector_error.cause = err
    raise wait_for_selector_error
  ensure
    element&.dispose
  end
end