Class: Textus::Hooks::Registry

Inherits:
Object
  • Object
show all
Defined in:
lib/textus/hooks/registry.rb

Constant Summary collapse

EVENTS = 
{
  # RPC: exactly 1 handler per name; return value flows into store; failure aborts.
  resolve_intake: { mode: :rpc, args: %i[store config args] },
  transform_rows: { mode: :rpc, args: %i[store rows config] },
  validate: { mode: :rpc, args: %i[store] },

  # Pub-sub: 0..N handlers per event; return discarded; failure logged to audit.
  entry_put: { mode: :pubsub, args: %i[store key envelope] },
  entry_deleted: { mode: :pubsub, args: %i[store key] },
  entry_refreshed: { mode: :pubsub, args: %i[store key envelope change] },
  entry_renamed: { mode: :pubsub, args: %i[store key from_key to_key envelope] },
  build_completed: { mode: :pubsub, args: %i[store key envelope sources] },
  proposal_accepted: { mode: :pubsub, args: %i[store key target_key] },
  proposal_rejected: { mode: :pubsub, args: %i[store key target_key] },
  file_published: { mode: :pubsub, args: %i[store key envelope source target] },
  store_loaded: { mode: :pubsub, args: %i[store] },
  refresh_started: { mode: :pubsub, args: %i[store key mode] },
  refresh_failed: { mode: :pubsub, args: %i[store key error_class error_message] },
  refresh_backgrounded: { mode: :pubsub, args: %i[store key started_at budget_ms] },
}.freeze

Instance Method Summary collapse

Constructor Details

#initialize(dispatcher: nil) ⇒ Registry

Returns a new instance of Registry.



25
26
27
28
29
 
# File 'lib/textus/hooks/registry.rb', line 25

def initialize(dispatcher: nil)
  @rpc        = Hash.new { |h, k| h[k] = {} }   # event => { name => callable }
  @pubsub     = Hash.new { |h, k| h[k] = [] }   # event => [{name:, callable:, keys:}]
  @dispatcher = dispatcher
end

Instance Method Details

#listeners(event, key:) ⇒ Object 



55
56
57
 
# File 'lib/textus/hooks/registry.rb', line 55

def listeners(event, key:)
  @pubsub[event.to_sym].select { |h| h[:keys].nil? || matches_any?(h[:keys], key) }
end

#pubsub_handlers(event) ⇒ Object 



60
 
# File 'lib/textus/hooks/registry.rb', line 60

def pubsub_handlers(event) = @pubsub[event.to_sym]

#register(event, name, keys: nil, &blk) ⇒ Object 



31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
 
# File 'lib/textus/hooks/registry.rb', line 31

def register(event, name, keys: nil, &blk)
  event_sym = event.to_sym
  spec = EVENTS[event_sym] or raise UsageError.new("unknown event: #{event}")
  shape_check!(event_sym, spec, blk)
  name = name.to_sym

  case spec[:mode]
  when :rpc
    raise UsageError.new("#{event_sym} '#{name}' already registered") if @rpc[event_sym].key?(name)

    @rpc[event_sym][name] = blk
  when :pubsub
    raise UsageError.new("#{event_sym} hook '#{name}' already registered") if @pubsub[event_sym].any? { |h| h[:name] == name }

    @pubsub[event_sym] << { name: name, callable: blk, keys: keys }
    @dispatcher&.subscribe(event_sym, name, keys: keys, &blk)
  end
end

#rpc_callable(event, name) ⇒ Object 



50
51
52
53
 
# File 'lib/textus/hooks/registry.rb', line 50

def rpc_callable(event, name)
  @rpc[event.to_sym][name.to_sym] or
    raise UsageError.new("unknown #{event}: #{name}")
end

#rpc_names(event) ⇒ Object 



59
 
# File 'lib/textus/hooks/registry.rb', line 59

def rpc_names(event) = @rpc[event.to_sym].keys