Module: Sequel::Plugins::HookClassMethods::ClassMethods

Module | Sequel::Plugins::HookClassMethods::ClassMethods
In: | lib/sequel/plugins/hook_class_methods.rb

### Methods

add_hook_type has_hooks? hook_blocks inherited

### Public Instance methods

add_hook_type(*hooks)

This adds a new hook type. It will define both a class method that you can use to add hooks, as well as an instance method that you can use to call all hooks of that type. The class method can be called with a symbol or a block or both. If a block is given and and symbol is not, it adds the hook block to the hook type. If a block and symbol are both given, it replaces the hook block associated with that symbol for a given hook type, or adds it if there is no hook block with that symbol for that hook type. If no block is given, it assumes the symbol specifies an instance method to call and adds it to the hook type.

If any hook block returns false, the instance method will return false immediately without running the rest of the hooks of that type.

It is recommended that you always provide a symbol to this method, for descriptive purposes. It‘s only necessary to do so when you are using a system that reloads code.

Example of usage:

     class MyModel
      define_hook :before_move_to
      before_move_to(:check_move_allowed){|o| o.allow_move?}
      def move_to(there)
        return if before_move_to == false
        # move MyModel object to there
      end
     end

[Source]

        # File lib/sequel/plugins/hook_class_methods.rb, line 64
    64:         def add_hook_type(*hooks)
    65:           Model::HOOKS.concat(hooks)
    66:           hooks.each do |hook|
    67:             @hooks[hook] = []
    68:             instance_eval("def #{hook}(method = nil, &block); add_hook(:#{hook}, method, &block) end", __FILE__, __LINE__)
    69:             class_eval("def #{hook}; run_hooks(:#{hook}); end", __FILE__, __LINE__)
    70:           end
    71:         end

has_hooks?(hook)

Returns true if there are any hook blocks for the given hook.

[Source]

        # File lib/sequel/plugins/hook_class_methods.rb, line 74
    74:         def has_hooks?(hook)
    75:           !@hooks[hook].empty?
    76:         end

hook_blocks(hook) {|v| ...}

Yield every block related to the given hook.

[Source]

        # File lib/sequel/plugins/hook_class_methods.rb, line 79
    79:         def hook_blocks(hook)
    80:           @hooks[hook].each{|k,v| yield v}
    81:         end

inherited(subclass)

Make a copy of the current class‘s hooks for the subclass.

[Source]

        # File lib/sequel/plugins/hook_class_methods.rb, line 84
    84:         def inherited(subclass)
    85:           super
    86:           hooks = subclass.instance_variable_set(:@hooks, {})
    87:           instance_variable_get(:@hooks).each{|k,v| hooks[k] = v.dup}
    88:         end

[Validate]