Module: Resque::Plugin

Extended by:
Plugin
Included in:
Plugin
Defined in:
lib/resque/plugin.rb

Constant Summary collapse

LintError =
Class.new(RuntimeError)

Instance Method Summary collapse

Instance Method Details

#after_hooks(job) ⇒ Object

Given an object, returns a list `after_perform` hook names.


37
38
39
# File 'lib/resque/plugin.rb', line 37

def after_hooks(job)
  job.methods.grep(/^after_perform/).sort
end

#around_hooks(job) ⇒ Object

Given an object, returns a list `around_perform` hook names.


32
33
34
# File 'lib/resque/plugin.rb', line 32

def around_hooks(job)
  job.methods.grep(/^around_perform/).sort
end

#before_hooks(job) ⇒ Object

Given an object, returns a list `before_perform` hook names.


27
28
29
# File 'lib/resque/plugin.rb', line 27

def before_hooks(job)
  job.methods.grep(/^before_perform/).sort
end

#failure_hooks(job) ⇒ Object

Given an object, returns a list `on_failure` hook names.


42
43
44
# File 'lib/resque/plugin.rb', line 42

def failure_hooks(job)
  job.methods.grep(/^on_failure/).sort
end

#lint(plugin) ⇒ Object

Ensure that your plugin conforms to good hook naming conventions.

Resque::Plugin.lint(MyResquePlugin)

10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
# File 'lib/resque/plugin.rb', line 10

def lint(plugin)
  hooks = before_hooks(plugin) + around_hooks(plugin) + after_hooks(plugin)

  hooks.each do |hook|
    if hook =~ /perform$/
      raise LintError, "#{plugin}.#{hook} is not namespaced"
    end
  end

  failure_hooks(plugin).each do |hook|
    if hook =~ /failure$/
      raise LintError, "#{plugin}.#{hook} is not namespaced"
    end
  end
end