Class: Rails::Railtie

Inherits:
Object show all
Includes:
Initializable
Defined in:
railties/lib/rails/railtie.rb,
railties/lib/rails/railtie/configurable.rb,
railties/lib/rails/railtie/configuration.rb

Overview

Rails::Railtie is the core of the Rails framework and provides several hooks to extend Rails and/or modify the initialization process.

Every major component of Rails (Action Mailer, Action Controller, Active Record, etc.) implements a railtie. Each of them is responsible for their own initialization. This makes Rails itself absent of any component hooks, allowing other components to be used in place of any of the Rails defaults.

Developing a Rails extension does not require implementing a railtie, but if you need to interact with the Rails framework during or after boot, then a railtie is needed.

For example, an extension doing any of the following would need a railtie:

  • creating initializers

  • configuring a Rails framework for the application, like setting a generator

  • adding config.* keys to the environment

  • setting up a subscriber with ActiveSupport::Notifications

  • adding Rake tasks

Creating a Railtie

To extend Rails using a railtie, create a subclass of Rails::Railtie. This class must be loaded during the Rails boot process, and is conventionally called MyNamespace::Railtie.

The following example demonstrates an extension which can be used with or without Rails.

# lib/my_gem/railtie.rb
module MyGem
  class Railtie < Rails::Railtie
  end
end

# lib/my_gem.rb
require 'my_gem/railtie' if defined?(Rails)

Initializers

To add an initialization step to the Rails boot process from your railtie, just define the initialization code with the initializer macro:

class MyRailtie < Rails::Railtie
  initializer "my_railtie.configure_rails_initialization" do
    # some initialization behavior
  end
end

If specified, the block can also receive the application object, in case you need to access some application-specific configuration, like middleware:

class MyRailtie < Rails::Railtie
  initializer "my_railtie.configure_rails_initialization" do |app|
    app.middleware.use MyRailtie::Middleware
  end
end

Finally, you can also pass :before and :after as options to initializer, in case you want to couple it with a specific step in the initialization process.

Configuration

Railties can access a config object which contains configuration shared by all railties and the application:

class MyRailtie < Rails::Railtie
  # Customize the ORM
  config.app_generators.orm :my_railtie_orm

  # Add a to_prepare block which is executed once in production
  # and before each request in development.
  config.to_prepare do
    MyRailtie.setup!
  end
end

Loading Rake Tasks and Generators

If your railtie has Rake tasks, you can tell Rails to load them through the method rake_tasks:

class MyRailtie < Rails::Railtie
  rake_tasks do
    load 'path/to/my_railtie.tasks'
  end
end

By default, Rails loads generators from your load path. However, if you want to place your generators at a different location, you can specify in your railtie a block which will load them during normal generators lookup:

class MyRailtie < Rails::Railtie
  generators do
    require 'path/to/my_railtie_generator'
  end
end

Application and Engine

An engine is nothing more than a railtie with some initializers already set. And since Rails::Application is an engine, the same configuration described here can be used in both.

Be sure to look at the documentation of those specific classes for more information.

Defined Under Namespace

Modules: Configurable Classes: Configuration

Constant Summary collapse

ABSTRACT_RAILTIES =
%w(Rails::Railtie Rails::Engine Rails::Application)

Class Method Summary collapse

Instance Method Summary collapse

Methods included from Initializable

included, #initializers, #run_initializers

Constructor Details

#initializeRailtie

:nodoc:


202
203
204
205
206
# File 'railties/lib/rails/railtie.rb', line 202

def initialize #:nodoc:
  if self.class.abstract_railtie?
    raise "#{self.class.name} is abstract, you cannot instantiate it directly."
  end
end

Class Method Details

.abstract_railtie?Boolean

Returns:

  • (Boolean)

158
159
160
# File 'railties/lib/rails/railtie.rb', line 158

def abstract_railtie?
  ABSTRACT_RAILTIES.include?(name)
end

.configure(&block) ⇒ Object

Allows you to configure the railtie. This is the same method seen in Railtie::Configurable, but this module is no longer required for all subclasses of Railtie so we provide the class method here.


180
181
182
# File 'railties/lib/rails/railtie.rb', line 180

def configure(&block)
  instance.configure(&block)
end

.console(&blk) ⇒ Object


140
141
142
143
144
# File 'railties/lib/rails/railtie.rb', line 140

def console(&blk)
  @load_console ||= []
  @load_console << blk if blk
  @load_console
end

.generators(&blk) ⇒ Object


152
153
154
155
156
# File 'railties/lib/rails/railtie.rb', line 152

def generators(&blk)
  @generators ||= []
  @generators << blk if blk
  @generators
end

.inherited(base) ⇒ Object


128
129
130
131
132
# File 'railties/lib/rails/railtie.rb', line 128

def inherited(base)
  unless base.abstract_railtie?
    subclasses << base
  end
end

.instanceObject

Since Rails::Railtie cannot be instantiated, any methods that call instance are intended to be called only on subclasses of a Railtie.


169
170
171
# File 'railties/lib/rails/railtie.rb', line 169

def instance
  @instance ||= new
end

.railtie_name(name = nil) ⇒ Object


162
163
164
165
# File 'railties/lib/rails/railtie.rb', line 162

def railtie_name(name = nil)
  @railtie_name = name.to_s if name
  @railtie_name ||= generate_railtie_name(self.name)
end

.rake_tasks(&blk) ⇒ Object


134
135
136
137
138
# File 'railties/lib/rails/railtie.rb', line 134

def rake_tasks(&blk)
  @rake_tasks ||= []
  @rake_tasks << blk if blk
  @rake_tasks
end

.respond_to_missing?(*args) ⇒ Boolean

Returns:

  • (Boolean)

173
174
175
# File 'railties/lib/rails/railtie.rb', line 173

def respond_to_missing?(*args)
  instance.respond_to?(*args) || super
end

.runner(&blk) ⇒ Object


146
147
148
149
150
# File 'railties/lib/rails/railtie.rb', line 146

def runner(&blk)
  @load_runner ||= []
  @load_runner << blk if blk
  @load_runner
end

.subclassesObject


124
125
126
# File 'railties/lib/rails/railtie.rb', line 124

def subclasses
  @subclasses ||= []
end

Instance Method Details

#configObject

This is used to create the config object on Railties, an instance of Railtie::Configuration, that is used by Railties and Application to store related configuration.


215
216
217
# File 'railties/lib/rails/railtie.rb', line 215

def config
  @config ||= Railtie::Configuration.new
end

#configure(&block) ⇒ Object

:nodoc:


208
209
210
# File 'railties/lib/rails/railtie.rb', line 208

def configure(&block) #:nodoc:
  instance_eval(&block)
end

#railtie_namespaceObject

:nodoc:


219
220
221
# File 'railties/lib/rails/railtie.rb', line 219

def railtie_namespace #:nodoc:
  @railtie_namespace ||= self.class.parents.detect { |n| n.respond_to?(:railtie_namespace) }
end