Module: Sequel::Plugins::HookClassMethods

Defined in:
lib/sequel/plugins/hook_class_methods.rb

Overview

Sequel’s built-in hook_class_methods plugin is designed for backwards compatibility. Its use is not encouraged, it is recommended to use instance methods and super instead of this plugin. This plugin allows calling class methods with blocks to define hooks:

# Block only, can cause duplicate hooks if code is reloaded
before_save{self.created_at = Time.now}
# Block with tag, safe for reloading
before_save(:set_created_at){self.created_at = Time.now}
# Tag only, safe for reloading, calls instance method
before_save(:set_created_at)

Pretty much anything you can do with a hook class method, you can also do with an instance method instead (making sure to call super), which is the recommended way to add hooks in Sequel:

def before_save
  super
  self.created_at = Time.now
end

Usage:

# Allow use of hook class methods in all model subclasses (called before loading subclasses)
Sequel::Model.plugin :hook_class_methods

# Allow the use of hook class methods in the Album class
Album.plugin :hook_class_methods

Defined Under Namespace

Modules: ClassMethods, InstanceMethods

Class Method Summary collapse

Class Method Details

.apply(model) ⇒ Object

Set up the hooks instance variable in the model.



35
36
37
38
 
# File 'lib/sequel/plugins/hook_class_methods.rb', line 35

def self.apply(model)
  hooks = model.instance_variable_set(:@hooks, {})
  Model::HOOKS.each{|h| hooks[h] = []}
end