Class: Cinch::HandlerList

Inherits:
Object
  • Object
show all
Includes:
Enumerable
Defined in:
lib/cinch/handler_list.rb

Overview

Since:

  • 2.0.0

Instance Method Summary collapse

Constructor Details

#initialize ⇒ HandlerList

Returns a new instance of HandlerList.

Since:

  • 2.0.0



10
11
12
13
 
# File 'lib/cinch/handler_list.rb', line 10

def initialize
  @handlers = Hash.new {|h,k| h[k] = []}
  @mutex = Mutex.new
end

Instance Method Details

#dispatch(event, msg = nil, *arguments) ⇒ Array<Thread>

Parameters:

  • event (Symbol) —

    The event type

  • msg (Message, nil) (defaults to: nil) —

    The message which is responsible for and attached to the event, or nil.

  • arguments (Array) —

    A list of additional arguments to pass to event handlers

Returns:

  • (Array<Thread>)

Since:

  • 2.0.0



55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
 
# File 'lib/cinch/handler_list.rb', line 55

def dispatch(event, msg = nil, *arguments)
  threads = []

  if handlers = find(event, msg)
    already_run = Set.new
    handlers.each do |handler|
      next if already_run.include?(handler.block)
      already_run << handler.block
      # calling Message#match multiple times is not a problem
      # because we cache the result
      if msg
        captures = msg.match(handler.pattern.to_r(msg), event, handler.strip_colors).captures
      else
        captures = []
      end

      threads << handler.call(msg, captures, arguments)
    end
  end

  threads
end

#each {|handler| ... }

This method returns an undefined value.

Yields:

  • (handler) —

    Yields all registered handlers

Yield Parameters:

Since:

  • 2.0.0



81
82
83
 
# File 'lib/cinch/handler_list.rb', line 81

def each(&block)
  @handlers.values.flatten.each(&block)
end

#find(type, msg = nil) ⇒ Array<Handler>

This method is part of a private API. You should avoid using this method if possible, as it may be removed or be changed in the future.

Returns:

Since:

  • 2.0.0



35
36
37
38
39
40
41
42
43
44
45
46
47
 
# File 'lib/cinch/handler_list.rb', line 35

def find(type, msg = nil)
  if handlers = @handlers[type]
    if msg.nil?
      return handlers
    end

    handlers = handlers.select { |handler|
      msg.match(handler.pattern.to_r(msg), type, handler.strip_colors)
    }.group_by {|handler| handler.group}

    handlers.values_at(*(handlers.keys - [nil])).map(&:first) + (handlers[nil] || [])
  end
end

#register(handler) ⇒ Object

Since:

  • 2.0.0



15
16
17
18
19
20
 
# File 'lib/cinch/handler_list.rb', line 15

def register(handler)
  @mutex.synchronize do
    handler.bot.loggers.debug "[on handler] Registering handler with pattern `#{handler.pattern.inspect}`, reacting on `#{handler.event}`"
    @handlers[handler.event] << handler
  end
end

#stop_all ⇒ Object

This method is part of a private API. You should avoid using this method if possible, as it may be removed or be changed in the future.

Since:

  • 2.0.0



86
87
88
 
# File 'lib/cinch/handler_list.rb', line 86

def stop_all
  each { |h| h.stop }
end

#unregister(*handlers)

This method returns an undefined value.

Parameters:

See Also:

Since:

  • 2.0.0



25
26
27
28
29
30
31
 
# File 'lib/cinch/handler_list.rb', line 25

def unregister(*handlers)
  @mutex.synchronize do
    handlers.each do |handler|
      @handlers[handler.event].delete(handler)
    end
  end
end