1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
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
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
|
module Rails
# 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!
#
#
class Railtie
include Initializable
# 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
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
def self.subscriber(subscriber)
Rails::Subscriber.add(plugin_name, subscriber)
end
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
|
