Module: Puppeteer::EventCallbackable

Included in:
Browser, BrowserContext, CDPSession, ChromeTargetManager, Connection, FrameManager, Locator, NetworkManager, Page, WebWorker
Defined in:
lib/puppeteer/event_callbackable.rb

Defined Under Namespace

Classes: EventListeners

Instance Method Summary collapse

Instance Method Details

#add_event_listener(event_name, &block) ⇒ Object Also known as: on 



35
36
37
38
 
# File 'lib/puppeteer/event_callbackable.rb', line 35

def add_event_listener(event_name, &block)
  @event_listeners ||= {}
  (@event_listeners[event_name] ||= EventListeners.new).add(&block)
end

#emit_event(event_name, *args, **kwargs) ⇒ Object 



77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
 
# File 'lib/puppeteer/event_callbackable.rb', line 77

def emit_event(event_name, *args, **kwargs)
  @event_callbackable_handlers ||= {}
  @event_listeners ||= {}

  if kwargs.empty?
    # In Ruby's specification (version < 2.7),
    # `method(:x).call(*args, **kwargs)` is equivalent to `x(*args, {})`
    # It often causes unexpected ArgumentError.
    #
    # ----------------
    # def greet
    #   puts 'Hello!'
    # end
    #
    # def call_me(*args, **kwargs)
    #   greet(*args, **kwargs) # => 'Hello!'
    #
    #   method(:greet).call(*args, **kwargs) # => `greet': wrong number of arguments (given 1, expected 0) (ArgumentError)
    # end
    #
    # call_me
    # ----------------
    #
    # This behavior is really annoying, and should be avoided, because we often want to set event handler as below:
    #
    # `on_event 'Some.Event.awesome', &method(:handle_awesome_event)`
    #
    # So Let's avoid it by checking kwargs.
    @event_callbackable_handlers[event_name]&.call(*args)
    @event_listeners[event_name]&.each do |proc|
      proc.call(*args)
    end
  else
    @event_callbackable_handlers[event_name]&.call(*args, **kwargs)
    @event_listeners[event_name]&.each do |proc|
      proc.call(*args, **kwargs)
    end
  end

  event_name
end

#observe_first(event_name, &block) ⇒ Object Also known as: once 



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

def observe_first(event_name, &block)
  listener_id = add_event_listener(event_name) do |*args, **kwargs|
    if kwargs.empty?
      block.call(*args)
    else
      block.call(*args, **kwargs)
    end
    remove_event_listener(listener_id)
  end
end

#off(event_name_or_id, listener = nil, &block) ⇒ Object 



42
43
44
45
46
47
48
49
 
# File 'lib/puppeteer/event_callbackable.rb', line 42

def off(event_name_or_id, listener = nil, &block)
  listener ||= block
  if listener
    (@event_listeners ||= {})[event_name_or_id]&.delete_by_handler(listener)
  else
    remove_event_listener(event_name_or_id)
  end
end

#on_event(event_name, &block) ⇒ Object 



72
73
74
75
 
# File 'lib/puppeteer/event_callbackable.rb', line 72

def on_event(event_name, &block)
  @event_callbackable_handlers ||= {}
  @event_callbackable_handlers[event_name] = block
end

#remove_event_listener(*id_args) ⇒ Object 



51
52
53
54
55
56
57
 
# File 'lib/puppeteer/event_callbackable.rb', line 51

def remove_event_listener(*id_args)
  (@event_listeners ||= {}).each do |event_name, listeners|
    id_args.each do |id|
      listeners.delete(id)
    end
  end
end