class Pry::Hooks

Implements a hooks system for Pry. A hook is a callable that is associated with an event. A number of events are currently provided by Pry, these include: `:when_started`, `:before_session`, `:after_session`. A hook must have a name, and is connected with an event by the `Pry::Hooks#add_hook` method.

@example Adding a hook for the `:before_session` event.

Pry.config.hooks.add_hook(:before_session, :say_hi) do
  puts "hello"
end

Attributes

hooks[R]

Public Class Methods

default() click to toggle source
# File lib/pry/hooks.rb, line 15
def self.default
  hooks = new
  hooks.add_hook(:before_session, :default) do |_out, _target, pry_instance|
    next if pry_instance.quiet?

    pry_instance.run_command('whereami --quiet')
  end
  hooks
end
new() click to toggle source
# File lib/pry/hooks.rb, line 25
def initialize
  @hooks = Hash.new { |h, k| h[k] = [] }
end

Public Instance Methods

add_hook(event_name, hook_name, callable = nil, &block) click to toggle source

Add a new hook to be executed for the `event_name` event. @param [Symbol] event_name The name of the event. @param [Symbol] hook_name The name of the hook. @param [#call] callable The callable. @yield The block to use as the callable (if no `callable` provided). @return [Pry:Hooks] The receiver.

# File lib/pry/hooks.rb, line 81
def add_hook(event_name, hook_name, callable = nil, &block)
  event_name = event_name.to_s

  # do not allow duplicates, but allow multiple `nil` hooks
  # (anonymous hooks)
  if hook_exists?(event_name, hook_name) && !hook_name.nil?
    raise ArgumentError, "Hook with name '#{hook_name}' already defined!"
  end

  raise ArgumentError, "Must provide a block or callable." if !block && !callable

  # ensure we only have one anonymous hook
  @hooks[event_name].delete_if { |h, _k| h.nil? } if hook_name.nil?

  if block
    @hooks[event_name] << [hook_name, block]
  elsif callable
    @hooks[event_name] << [hook_name, callable]
  end

  self
end
clear_event_hooks(event_name) click to toggle source

Clear all hooks functions for a given event.

@param [String] event_name The name of the event. @return [void]

# File lib/pry/hooks.rb, line 165
def clear_event_hooks(event_name)
  @hooks[event_name.to_s] = []
end
delete_hook(event_name, hook_name) click to toggle source

@param [Symbol] event_name The name of the event. @param [Symbol] hook_name The name of the hook.

to delete.

@return [#call] The deleted hook.

# File lib/pry/hooks.rb, line 147
def delete_hook(event_name, hook_name)
  deleted_callable = nil

  @hooks[event_name.to_s].delete_if do |current_hook_name, callable|
    if current_hook_name == hook_name
      deleted_callable = callable
      true
    else
      false
    end
  end
  deleted_callable
end
errors() click to toggle source
# File lib/pry/hooks.rb, line 39
def errors
  @errors ||= []
end
exec_hook(event_name, *args, &block) click to toggle source

Execute the list of hooks for the `event_name` event. @param [Symbol] event_name The name of the event. @param [Array] args The arguments to pass to each hook function. @return [Object] The return value of the last executed hook.

# File lib/pry/hooks.rb, line 108
def exec_hook(event_name, *args, &block)
  @hooks[event_name.to_s].map do |_hook_name, callable|
    begin
      callable.call(*args, &block)
    rescue RescuableException => e
      errors << e
      e
    end
  end.last
end
get_hook(event_name, hook_name) click to toggle source

@param [Symbol] event_name The name of the event. @param [Symbol] hook_name The name of the hook @return [#call] a specific hook for a given event.

# File lib/pry/hooks.rb, line 128
def get_hook(event_name, hook_name)
  hook = @hooks[event_name.to_s].find do |current_hook_name, _callable|
    current_hook_name == hook_name
  end
  hook.last if hook
end
get_hooks(event_name) click to toggle source

@param [Symbol] event_name The name of the event. @return [Hash] The hash of hook names / hook functions. @note Modifying the returned hash does not alter the hooks, use `add_hook`/`delete_hook` for that.

# File lib/pry/hooks.rb, line 139
def get_hooks(event_name)
  Hash[@hooks[event_name.to_s]]
end
hook_count(event_name) click to toggle source

@param [Symbol] event_name The name of the event. @return [Fixnum] The number of hook functions for `event_name`.

# File lib/pry/hooks.rb, line 121
def hook_count(event_name)
  @hooks[event_name.to_s].size
end
hook_exists?(event_name, hook_name) click to toggle source

@param [Symbol] event_name Name of the event. @param [Symbol] hook_name Name of the hook. @return [Boolean] Whether the hook by the name `hook_name`.

# File lib/pry/hooks.rb, line 172
def hook_exists?(event_name, hook_name)
  @hooks[event_name.to_s].map(&:first).include?(hook_name)
end
initialize_copy(_orig) click to toggle source

Ensure that duplicates have their @hooks object.

# File lib/pry/hooks.rb, line 30
def initialize_copy(_orig)
  hooks_dup = @hooks.dup
  @hooks.each do |k, v|
    hooks_dup[k] = v.dup
  end

  @hooks = hooks_dup
end
merge(other) click to toggle source

@example

hooks = Pry::Hooks.new.add_hook(:before_session, :say_hi) { puts "hi!" }
Pry::Hooks.new.merge(hooks)

@param [Pry::Hooks] other The `Pry::Hooks` instance to merge @return [Pry::Hooks] a new `Pry::Hooks` instance containing a merge of the

contents of two `Pry:Hooks` instances.
# File lib/pry/hooks.rb, line 69
def merge(other)
  dup.tap do |v|
    v.merge!(other)
  end
end
merge!(other) click to toggle source

Destructively merge the contents of two `Pry:Hooks` instances.

@param [Pry::Hooks] other The `Pry::Hooks` instance to merge @return [Pry:Hooks] The receiver. @see merge

# File lib/pry/hooks.rb, line 48
def merge!(other)
  @hooks.merge!(other.dup.hooks) do |_key, array, other_array|
    temp_hash = {}
    output = []

    (array + other_array).reverse_each do |pair|
      temp_hash[pair.first] ||= output.unshift(pair)
    end

    output
  end

  self
end