Class: Adhearsion::Plugin

Inherits:
Object show all
Defined in:
lib/adhearsion/plugin.rb,
lib/adhearsion/plugin/collection.rb,
lib/adhearsion/plugin/initializer.rb

Overview

Plugin is the core of extension of Adhearsion framework and provides the easiest path to add new functionality, configuration or modify the initialization process.

Its behavior is based on Rails::Railtie, so if you are familiar with Rails this will be easier for you to start using Adhearsion::Plugin, but of course no previous knowledge is required.

With an Adhearsion Plugin you can:

  • create initializers

  • add rake tasks to Adhearsion

  • add/modify configuration files

How to create your Adhearsion Plugin

Create a class that inherits from Adhearsion::Plugin within your plugin namespace. This class shall be loaded during your awesome Adhearsion application boot process.

# lib/my_plugin/plugin.rb
module MyPlugin
  class Plugin < Adhearsion::Plugin
  end
end

Execute a specific code while initializing Adhearison

module MyPlugin
  class Plugin < Adhearsion::Plugin
    init :my_plugin do
      logger.warn "I want to ensure my plugin is being loaded!!!"
    end
  end
end

As Rails::Railtie does, you can define the exact point when you want to load your plugin during the initialization process.

module MyPlugin
  class Plugin < Adhearsion::Plugin
    init :my_plugin, :after => :my_other_plugin do
      logger.warn "My Plugin depends on My Other Plugin, so it must be loaded after"
    end
  end
end

Defined Under Namespace

Classes: Collection, Initializer

Constant Summary collapse

METHODS_OPTIONS =
{:load => true, :scope => false}

Class Method Summary collapse

Class Method Details

.add(klass) ⇒ Object



235
236
237
# File 'lib/adhearsion/plugin.rb', line 235

def add(klass)
  klass.ancestors.include?(self) and subclasses << klass
end

.config(name = nil, &block) ⇒ Object

Class method that will be used by subclasses to configure the plugin

Parameters:

  • name (defaults to: nil)

    Symbol plugin config name



152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
# File 'lib/adhearsion/plugin.rb', line 152

def config(name = nil, &block)
  if name.nil?
    name = self.plugin_name
  else
    self.plugin_name = name
  end

  if block_given?
    opts = {}
    opts[:after] ||= configs.last.name unless configs.empty?
    ::Loquacious::Configuration.defaults_for plugin_name, &Proc.new
    initializer = Initializer.new(plugin_name, self, opts) do
      ::Loquacious.configuration_for plugin_name, &block
    end
    Adhearsion::Plugin.configs << initializer
  else
    ::Loquacious.configuration_for plugin_name
  end
end

.configsObject



195
196
197
# File 'lib/adhearsion/plugin.rb', line 195

def configs
  @configs ||= Collection.new
end

.configure_plugins(*args) ⇒ Object



176
177
178
179
180
# File 'lib/adhearsion/plugin.rb', line 176

def configure_plugins(*args)
  configs.tsort.each do |config|
    config.run(*args)
  end
end

.countObject



231
232
233
# File 'lib/adhearsion/plugin.rb', line 231

def count
  subclasses.length
end

.delete(plugin_name) ⇒ Object



239
240
241
242
# File 'lib/adhearsion/plugin.rb', line 239

def delete(plugin_name)
  plugin_name.ancestors.include?(self) and plugin_name = plugin_name.plugin_name
  subclasses.delete_if { |plugin| plugin.plugin_name.eql? plugin_name }
end

.delete_allObject



244
245
246
# File 'lib/adhearsion/plugin.rb', line 244

def delete_all
  @subclasses = nil
end

.generators(mapping) ⇒ Object

Register generator classes

Examples:

FooBar = Class.new Adhearsion::Plugin do
  generators :'my_plugin:foo_generator' => FooGenerator
end


121
122
123
124
125
# File 'lib/adhearsion/plugin.rb', line 121

def generators(mapping)
  mapping.each_pair do |name, klass|
    Generators.add_generator name, klass
  end
end

.init(name = nil, opts = {}, &block) ⇒ Object

Class method that will be used by subclasses to initialize the plugin

Parameters:

  • name (defaults to: nil)

    Symbol plugin initializer name

  • opts (defaults to: {})

    Hash

    • :before specify the plugin to be loaded before another plugin

    • :after specify the plugin to be loaded after another plugin



212
213
214
215
216
217
# File 'lib/adhearsion/plugin.rb', line 212

def init(name = nil, opts = {}, &block)
  name = plugin_name unless name
  block_given? or raise ArgumentError, "A block must be passed while defining the Plugin initialization process"
  opts[:after] ||= initializers.last.name unless initializers.empty? || initializers.find { |i| i.name == opts[:before] }
  Adhearsion::Plugin.initializers << Initializer.new(name, self, opts, &block)
end

.init_plugins(*args) ⇒ Object

Recursively initialization of all the loaded plugins



183
184
185
186
187
# File 'lib/adhearsion/plugin.rb', line 183

def init_plugins(*args)
  initializers.tsort.each do |initializer|
    initializer.run(*args)
  end
end

.initializersObject



199
200
201
# File 'lib/adhearsion/plugin.rb', line 199

def initializers
  @initializers ||= Collection.new
end

.load_tasksObject



106
107
108
109
110
111
# File 'lib/adhearsion/plugin.rb', line 106

def load_tasks
  container = Object.new.tap { |o| o.extend Rake::DSL if defined? Rake::DSL }
  tasks.each do |block|
    container.instance_eval(&block)
  end
end

.plugin_name(name = nil) ⇒ Object Also known as: app_name



136
137
138
139
140
141
142
# File 'lib/adhearsion/plugin.rb', line 136

def plugin_name(name = nil)
  if name.nil?
    @plugin_name ||= ActiveSupport::Inflector.underscore(self.name)
  else
    self.plugin_name = name
  end
end

.plugin_name=(name) ⇒ Object Also known as: app_name=



145
146
147
# File 'lib/adhearsion/plugin.rb', line 145

def plugin_name=(name)
  @plugin_name = name
end

.reset_rake_tasksObject



102
103
104
# File 'lib/adhearsion/plugin.rb', line 102

def reset_rake_tasks
  @@rake_tasks = []
end

.run(name = nil, opts = {}, &block) ⇒ Object

Class method that will be used by subclasses to run the plugin

Parameters:

  • name (defaults to: nil)

    Symbol plugin initializer name

  • opts (defaults to: {})

    Hash

    • :before specify the plugin to be loaded before another plugin

    • :after specify the plugin to be loaded after another plugin



224
225
226
227
228
229
# File 'lib/adhearsion/plugin.rb', line 224

def run(name = nil, opts = {}, &block)
  name = plugin_name unless name
  block_given? or raise ArgumentError, "A block must be passed while defining the Plugin run process"
  opts[:after] ||= runners.last.name unless runners.empty? || runners.find { |i| i.name == opts[:before] }
  Adhearsion::Plugin.runners << Initializer.new(name, self, opts, &block)
end

.run_plugins(*args) ⇒ Object



189
190
191
192
193
# File 'lib/adhearsion/plugin.rb', line 189

def run_plugins(*args)
  runners.tsort.each do |runner|
    runner.run(*args)
  end
end

.runnersObject



203
204
205
# File 'lib/adhearsion/plugin.rb', line 203

def runners
  @runners ||= Collection.new
end

.show_descriptionObject



172
173
174
# File 'lib/adhearsion/plugin.rb', line 172

def show_description
  ::Loquacious::Configuration.help_for plugin_name
end

.subclassesObject



127
128
129
# File 'lib/adhearsion/plugin.rb', line 127

def subclasses
  @subclasses ||= []
end

.tasksObject

Class method that allows any subclass (any Adhearsion plugin) to register rake tasks.

  • Example 1:

    FooBar = Class.new Adhearsion::Plugin do
      tasks do
        namespace :foo_bar do
          desc "Prints the FooBar plugin version"
          task :version do
            STDOUT.puts "FooBar plugin v0.1"
          end
        end
      end
    end
    
  • Example 2:

    FooBar = Class.new Adhearsion::Plugin do
      tasks do
        load "tasks/foo_bar.rake"
      end
    end
    
    = tasks/foo_bar.rake
    
     namespace :foo_bar do
       desc "Prints the FooBar plugin version"
       task :version do
         STDOUT.puts "FooBar plugin v0.1"
       end
     end
    


97
98
99
100
# File 'lib/adhearsion/plugin.rb', line 97

def tasks
  @@rake_tasks << Proc.new if block_given?
  @@rake_tasks
end