2009-12-31 21:11:54 +00:00
|
|
|
module Rails
|
2010-01-19 08:05:42 +00:00
|
|
|
# Railtie is the core of the Rails Framework and provides all the hooks and
|
|
|
|
# methods you need to link your plugin into Rails.
|
|
|
|
#
|
|
|
|
# What Railtie does is make every component of Rails a "plugin" and creates
|
|
|
|
# an API that exposes all the powers that the builtin components need
|
|
|
|
# to any plugin author.
|
|
|
|
#
|
|
|
|
# In fact, every major component of Rails (Action Mailer, Action Controller,
|
|
|
|
# Action View, Active Record and Active Resource) are all now just plain
|
|
|
|
# old plugins.
|
|
|
|
#
|
|
|
|
# Developing a plugin for Rails does not _require_ any implementation of
|
|
|
|
# Railtie, there is no fixed rule, but as a guideline, if your plugin works
|
|
|
|
# by just being required before Rails boots, then there is no need for you
|
|
|
|
# to hook into Railtie, but if you need to interact with the Rails framework
|
|
|
|
# during boot, or after boot, then Railtie is what you need to do that
|
|
|
|
# interaction.
|
|
|
|
#
|
|
|
|
# For example, the following would need you to implement Railtie in your
|
|
|
|
# plugin:
|
|
|
|
#
|
|
|
|
# * creating initializers (including route insertion)
|
|
|
|
# * modifying the render path (think HAML et al)
|
|
|
|
# * adding Rails config.* keys to the environment
|
|
|
|
# * setting up a subscriber to the Rails +ActiveSupport::Notifications+
|
|
|
|
# * adding global Rake tasks into rails
|
|
|
|
# * setting up a default configuration for the Application
|
|
|
|
#
|
|
|
|
# Railtie gives you a central place to connect into the Rails framework. If you
|
|
|
|
# find yourself writing plugin code that is having to monkey patch parts of the
|
|
|
|
# Rails framework to achieve something, there is probably a better, more elegant
|
|
|
|
# way to do it through Railtie, if there isn't, then you have found a lacking
|
|
|
|
# feature of Railtie, please lodge a ticket.
|
|
|
|
#
|
|
|
|
# Implementing Railtie in your plugin is done with the following:
|
|
|
|
#
|
|
|
|
# * Create a class Railtie which inherits from Rails::Railtie and is namespaced
|
|
|
|
# to your plugin
|
|
|
|
#
|
|
|
|
# module MyPlugin
|
|
|
|
# class Railtie < Rails::Railtie
|
|
|
|
# end
|
|
|
|
# end
|
|
|
|
#
|
|
|
|
# * Require your own plugin as well as rails in this file.
|
|
|
|
#
|
|
|
|
# require 'my_plugin'
|
|
|
|
# require 'rails'
|
|
|
|
#
|
|
|
|
# module MyPlugin
|
|
|
|
# class Railtie < Rails::Railtie
|
|
|
|
# end
|
|
|
|
# end
|
|
|
|
#
|
|
|
|
# * Give your plugin a unique name
|
|
|
|
#
|
|
|
|
# require 'my_plugin'
|
|
|
|
# require 'rails'
|
|
|
|
#
|
|
|
|
# module MyPlugin
|
|
|
|
# class Railtie < Rails::Railtie
|
|
|
|
# plugin_name :my_plugin
|
|
|
|
# end
|
|
|
|
# end
|
|
|
|
#
|
|
|
|
# * Then start implementing the components of Railtie you need to
|
|
|
|
# get your plugin working!
|
|
|
|
#
|
|
|
|
#
|
2009-12-31 21:11:54 +00:00
|
|
|
class Railtie
|
|
|
|
include Initializable
|
|
|
|
|
2010-01-19 08:05:42 +00:00
|
|
|
# Pass in the name of your plugin. This is passed in as an underscored symbol.
|
|
|
|
#
|
|
|
|
# module MyPlugin
|
|
|
|
# class Railtie < Rails::Railtie
|
|
|
|
# plugin_name :my_plugin
|
|
|
|
# end
|
|
|
|
# end
|
2009-12-31 21:11:54 +00:00
|
|
|
def self.plugin_name(plugin_name = nil)
|
|
|
|
@plugin_name ||= name.demodulize.underscore
|
|
|
|
@plugin_name = plugin_name if plugin_name
|
|
|
|
@plugin_name
|
|
|
|
end
|
|
|
|
|
|
|
|
def self.inherited(klass)
|
|
|
|
@plugins ||= []
|
|
|
|
@plugins << klass unless klass == Plugin
|
|
|
|
end
|
|
|
|
|
|
|
|
def self.plugins
|
|
|
|
@plugins
|
|
|
|
end
|
|
|
|
|
|
|
|
def self.plugin_names
|
|
|
|
plugins.map { |p| p.plugin_name }
|
|
|
|
end
|
|
|
|
|
|
|
|
def self.config
|
|
|
|
Configuration.default
|
|
|
|
end
|
|
|
|
|
2010-01-12 12:27:24 +00:00
|
|
|
def self.subscriber(subscriber)
|
|
|
|
Rails::Subscriber.add(plugin_name, subscriber)
|
|
|
|
end
|
|
|
|
|
2009-12-31 21:11:54 +00:00
|
|
|
def self.rake_tasks(&blk)
|
|
|
|
@rake_tasks ||= []
|
|
|
|
@rake_tasks << blk if blk
|
|
|
|
@rake_tasks
|
|
|
|
end
|
|
|
|
|
|
|
|
def rake_tasks
|
|
|
|
self.class.rake_tasks
|
|
|
|
end
|
|
|
|
|
|
|
|
def load_tasks
|
|
|
|
return unless rake_tasks
|
|
|
|
rake_tasks.each { |blk| blk.call }
|
|
|
|
end
|
|
|
|
end
|
|
|
|
end
|