Class: Plugins

Inherits:
Object
  • Object
show all
Defined in:
lib/baker/plugins.rb

Overview

Register a plugin with Baker call:

Baker.plugins.register(:trigger) do

# Your code here

end

The following triggers/hook types are availabe:

:before_options, :after_options     - before/after the command line options are processed
:before_load, :after_load           - before/after the baker file is loaded
:before_line                        - before the line is undergoing variable expansion. Will be called even for lines which are completed ([x])
:before_expansion, :after_expansion - before/after the line is undergoing variable expansion. This is only called for tasks :shell and :ruby
:before_execution                   - before the line is executed.
:after_execution                    - after the line is executed which includes printing error messages and marking the line as completed
:before_save, :after_save           - before/after the baker file is saved (which happens after each line with a task/command)
:all                                - all of the above

In the &block access is available to the following variables:

line, baker, command, context, action_type

You might want to filter based on the line.type if your plugin is active or not:

- :shell - shell command block
- :ruby - ruby code block
- :manual - manual task block
- :directive - directive block
- :nop - Text, comment, empty line

The &block can return any of the following:

- :exit or false           - abort processing and exit
- :skip                    - skip this block
- :ask                     - ask the user if they want to continue
- :continue, true or nil   - continue processing

Constant Summary collapse

ALL_TRIGGERS = 
[
  :before_options, :after_options,
  :before_load, :after_load, 
  :before_line, 
  :before_expansion, :after_expansion, 
  :before_execution, :after_execution, 
  :before_save, :after_save
]

Instance Method Summary collapse

Instance Method Details

#init ⇒ Object 



38
39
40
41
42
 
# File 'lib/baker/plugins.rb', line 38

def init
  Dir[File.dirname(__FILE__) + '/plugins/*.rb'].each do |file|
    require file
  end
end

#register(action_type, &block) ⇒ Object 



53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
 
# File 'lib/baker/plugins.rb', line 53

def register(action_type, &block)

  # Unroll arrays
  if action_type.is_a?(Array)
    action_type.each do |at| register(at, &block) end
    return
  end
  
  # Unroll :any
  action_type = :any if action_type == :all
  ALL_TRIGGERS.each do |at| register(at, &block) end if action_type == :any
   
  raise "Action type must be one of #{ALL_TRIGGERS.inspect} but is #{action_type}" unless ALL_TRIGGERS.include?(action_type)

  @plugins ||= {}
  @plugins[action_type] ||= []
  @plugins[action_type] << block
end

#run(action_type, baker:, line: nil, command: nil, context: nil) ⇒ Object

Runs all registered plugin with the given block_type and action_type

Returns: :continue, :skip, :ask



77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
 
# File 'lib/baker/plugins.rb', line 77

def run(action_type, baker:, line: nil, command: nil, context: nil)

  raise "Action type must be one of #{ALL_TRIGGERS.inspect} but is #{action_type}" unless ALL_TRIGGERS.include?(action_type)

  @plugins.dig(action_type)&.each do |block|

    # puts "Running plugin block: #{block.source_location[0]}:#{block.source_location[1]}" if baker.debug

    result = OpenStruct.new(line: line, baker: baker, command: command, context: context, action_type: action_type).instance_eval(&block)

    #  - :exit, :abort, false           - abort processing and exit
    #  - :skip                    - skip this block (skips all other plugins)
    #  - :ask                     - ask the user if they want to continue
    #  - :continue, true or nil   - continue processing
    case result
    when :exit, false, :abort
      exit(1)
    when :skip
      return :skip
    when :ask
      return :ask
    when :continue, true, nil
      next
    else 
      raise "Unknown return value #{result.inspect.split.first} from plugin block: #{block.source_location[0]}:#{block.source_location[1]}"
    end

  end
  return :continue
end