Skip to content

HTTPS clone URL

Subversion checkout URL

You can clone with
or
.
Download ZIP
Newer
Older
100644 296 lines (257 sloc) 10.405 kB
6690d66 @josevalim Rename config.cookie_secret to config.secret_token and pass it as con…
josevalim authored
1 require 'active_support/core_ext/hash/reverse_merge'
02c5137 @josevalim Add view paths to Engine setup.
josevalim authored
2 require 'fileutils'
b17e358 @josevalim Move configuration to subfolders.
josevalim authored
3 require 'rails/plugin'
2fde9d7 @josevalim Solve some pendencies.
josevalim authored
4 require 'rails/engine'
dc677f7 tests pass with requiring the frameworks in rails.rb
Carlhuda authored
5
accd9b4 @josh Restore "Start Rails::Application object
josh authored
6 module Rails
781d0a9 @josevalim Add docs for Railtie, Engine, Plugin and Application.
josevalim authored
7 # In Rails 3.0, a Rails::Application object was introduced which is nothing more than
8 # an Engine but with the responsibility of coordinating the whole boot process.
9 #
10 # == Initialization
11 #
12 # Rails::Application is responsible for executing all railties, engines and plugin
eb716f6 @mjankowski grammar/tense correction to rails application doc
mjankowski authored
13 # initializers. It also executes some bootstrap initializers (check
781d0a9 @josevalim Add docs for Railtie, Engine, Plugin and Application.
josevalim authored
14 # Rails::Application::Bootstrap) and finishing initializers, after all the others
15 # are executed (check Rails::Application::Finisher).
16 #
17 # == Configuration
18 #
19 # Besides providing the same configuration as Rails::Engine and Rails::Railtie,
20 # the application object has several specific configurations, for example
21 # "allow_concurrency", "cache_classes", "consider_all_requests_local", "filter_parameters",
9b19a6f @josevalim A few changes were done in this commit:
josevalim authored
22 # "logger", "reload_plugins" and so forth.
781d0a9 @josevalim Add docs for Railtie, Engine, Plugin and Application.
josevalim authored
23 #
24 # Check Rails::Application::Configuration to see them all.
25 #
26 # == Routes
27 #
28 # The application object is also responsible for holding the routes and reloading routes
29 # whenever the files change in development.
30 #
45e6028 @wycats Removing Metal from Rails 3.
wycats authored
31 # == Middlewares
781d0a9 @josevalim Add docs for Railtie, Engine, Plugin and Application.
josevalim authored
32 #
45e6028 @wycats Removing Metal from Rails 3.
wycats authored
33 # The Application is also responsible for building the middleware stack.
9cfeefb @wycats Reorganized initializers a bit to enable better hooks for common case…
wycats authored
34 #
27f0add @josevalim Improve docs for Rails::Application and add routes_reloader_hook and …
josevalim authored
35 # == Booting process
36 #
37 # The application is also responsible for setting up and executing the booting
38 # process. From the moment you require "config/application.rb" in your app,
39 # the booting process goes like this:
40 #
41 # 1) require "config/boot.rb" to setup load paths
42 # 2) require railties and engines
43 # 3) Define Rails.application as "class MyApp::Application < Rails::Application"
44 # 4) Run config.before_configuration callbacks
45 # 5) Load config/environments/ENV.rb
46 # 6) Run config.before_initialize callbacks
47 # 7) Run Railtie#initializer defined by railties, engines and application.
11aa167 @josevalim Revert "Provide a unique point for running initializers."
josevalim authored
48 # One by one, each engine sets up its load paths, routes and runs its config/initializers/* files.
49 # 9) Custom Railtie#initializers added by railties, engines and applications are executed
50 # 10) Build the middleware stack and run to_prepare callbacks
51 # 11) Run config.before_eager_load and eager_load if cache classes is true
52 # 12) Run config.after_initialize callbacks
27f0add @josevalim Improve docs for Rails::Application and add routes_reloader_hook and …
josevalim authored
53 #
7fcf859 @josevalim Massive cleanup in Railties and load stack.
josevalim authored
54 class Application < Engine
4f03603 @josevalim Break application.rb file in smaller chunks.
josevalim authored
55 autoload :Bootstrap, 'rails/application/bootstrap'
b17e358 @josevalim Move configuration to subfolders.
josevalim authored
56 autoload :Configuration, 'rails/application/configuration'
4f03603 @josevalim Break application.rb file in smaller chunks.
josevalim authored
57 autoload :Finisher, 'rails/application/finisher'
13d66cd @josevalim Extract Railtie load from application.
josevalim authored
58 autoload :Railties, 'rails/application/railties'
3049e64 @drogus Moved Rails::RoutesReloader to Rails::Application::RoutesReloader
drogus authored
59 autoload :RoutesReloader, 'rails/application/routes_reloader'
80130d1 @josevalim Extract routes reloading responsibilities from application and load t…
josevalim authored
60
e4d7e50 Moving more initializers into the application object
Carl Lerche authored
61 class << self
7fcf859 @josevalim Massive cleanup in Railties and load stack.
josevalim authored
62 def inherited(base)
2fde9d7 @josevalim Solve some pendencies.
josevalim authored
63 raise "You cannot have more than one Rails::Application" if Rails.application
7fcf859 @josevalim Massive cleanup in Railties and load stack.
josevalim authored
64 super
788fce2 @josevalim Create configurable modules and ensure that they are added only on di…
josevalim authored
65 Rails.application = base.instance
6f83a50 @fxn renames load_(once_)paths to autoload_(once_)paths in dependencies an…
fxn authored
66 Rails.application.add_lib_to_load_path!
9cfeefb @wycats Reorganized initializers a bit to enable better hooks for common case…
wycats authored
67 ActiveSupport.run_load_hooks(:before_configuration, base.instance)
e4d7e50 Moving more initializers into the application object
Carl Lerche authored
68 end
897164d Conceptually unify instance & global initializers
Yehuda Katz + Carl Lerche authored
69 end
6f6a589 Create the application object from config/environment.rb
Yehuda Katz + Carl Lerche authored
70
52e01fc @josevalim Everyone receives app as argument for consistency.
josevalim authored
71 attr_accessor :assets, :sandbox
72 alias_method :sandbox?, :sandbox
fa1d9a8 @josevalim Speed up development by only reloading classes if dependencies files …
josevalim authored
73 attr_reader :reloaders
52e01fc @josevalim Everyone receives app as argument for consistency.
josevalim authored
74
eedbf87 @drogus New way of generating urls for Application from Engine.
drogus authored
75 delegate :default_url_options, :default_url_options=, :to => :routes
76
44f0709 @tenderlove dealing with some -w warnings on startup
tenderlove authored
77 def initialize
78 super
79 @initialized = false
fa1d9a8 @josevalim Speed up development by only reloading classes if dependencies files …
josevalim authored
80 @reloaders = []
44f0709 @tenderlove dealing with some -w warnings on startup
tenderlove authored
81 end
82
9e081ca @josevalim Improve documentation for add_lib_to_load_paths!
josevalim authored
83 # This method is called just after an application inherits from Rails::Application,
84 # allowing the developer to load classes in lib and use them during application
85 # configuration.
86 #
87 # class MyApplication < Rails::Application
88 # require "my_backend" # in lib/my_backend
89 # config.i18n.backend = MyBackend
90 # end
91 #
92 # Notice this method takes into consideration the default root path. So if you
93 # are changing config.root inside your application definition or having a custom
94 # Rails application, you will need to add lib to $LOAD_PATH on your own in case
95 # you need to load files in lib/ during the application configuration as well.
6f83a50 @fxn renames load_(once_)paths to autoload_(once_)paths in dependencies an…
fxn authored
96 def add_lib_to_load_path! #:nodoc:
5a0d73f @josevalim Add lib to load paths when application is inherited to be able to loa…
josevalim authored
97 path = config.root.join('lib').to_s
98 $LOAD_PATH.unshift(path) if File.exists?(path)
99 end
100
9e081ca @josevalim Improve documentation for add_lib_to_load_paths!
josevalim authored
101 def require_environment! #:nodoc:
d649bf1 @josevalim Provide a cleaner syntax for paths configuration that does not rely o…
josevalim authored
102 environment = paths["config/environment"].existent.first
13d66cd @josevalim Extract Railtie load from application.
josevalim authored
103 require environment if environment
d982fe2 Replace reopening the class with App.configure as an alias to class_eval
Carlhuda authored
104 end
105
27f0add @josevalim Improve docs for Rails::Application and add routes_reloader_hook and …
josevalim authored
106 # Reload application routes regardless if they changed or not.
7b0c592 @josevalim reload_routes! is part of the public API and should not be removed.
josevalim authored
107 def reload_routes!
108 routes_reloader.reload!
109 end
110
27f0add @josevalim Improve docs for Rails::Application and add routes_reloader_hook and …
josevalim authored
111 def routes_reloader #:nodoc:
3049e64 @drogus Moved Rails::RoutesReloader to Rails::Application::RoutesReloader
drogus authored
112 @routes_reloader ||= RoutesReloader.new
80130d1 @josevalim Extract routes reloading responsibilities from application and load t…
josevalim authored
113 end
5f8e48c @josh Move route reloading into railties
josh authored
114
fa1d9a8 @josevalim Speed up development by only reloading classes if dependencies files …
josevalim authored
115 # Returns an array of file paths appended with a hash of directories-extensions
116 # suitable for ActiveSupport::FileUpdateChecker API.
117 def watchable_args
118 files = []
119 files.concat config.watchable_files
120
121 dirs = {}
122 dirs.merge! config.watchable_dirs
123 ActiveSupport::Dependencies.autoload_paths.each do |path|
124 dirs[path.to_s] = [:rb]
125 end
126
80256ab @josevalim FileUpdateChecker should be able to handle deleted files.
josevalim authored
127 [files, dirs]
27f0add @josevalim Improve docs for Rails::Application and add routes_reloader_hook and …
josevalim authored
128 end
129
130 # Initialize the application passing the given group. By default, the
131 # group is :default but sprockets precompilation passes group equals
132 # to assets if initialize_on_precompile is false to avoid booting the
133 # whole app.
134 def initialize!(group=:default) #:nodoc:
abeb0ff @drogus Ensure that Rails.application.initialize! is called only once
drogus authored
135 raise "Application has been already initialized." if @initialized
eb367af @josevalim `rake assets:precompile` loads the application but does not initializ…
josevalim authored
136 run_initializers(group, self)
abeb0ff @drogus Ensure that Rails.application.initialize! is called only once
drogus authored
137 @initialized = true
80130d1 @josevalim Extract routes reloading responsibilities from application and load t…
josevalim authored
138 self
5f8e48c @josh Move route reloading into railties
josh authored
139 end
140
27f0add @josevalim Improve docs for Rails::Application and add routes_reloader_hook and …
josevalim authored
141 # Load the application and its railties tasks and invoke the registered hooks.
142 # Check <tt>Rails::Railtie.rake_tasks</tt> for more info.
52e01fc @josevalim Everyone receives app as argument for consistency.
josevalim authored
143 def load_tasks(app=self)
788fce2 @josevalim Create configurable modules and ensure that they are added only on di…
josevalim authored
144 initialize_tasks
e461e1b @josevalim Ensure application rake tasks and generators are loaded after the one…
josevalim authored
145 super
13d66cd @josevalim Extract Railtie load from application.
josevalim authored
146 self
94bb331 @jeremy Shift more responsibility from application class to its singleton ins…
jeremy authored
147 end
148
27f0add @josevalim Improve docs for Rails::Application and add routes_reloader_hook and …
josevalim authored
149 # Load the application console and invoke the registered hooks.
150 # Check <tt>Rails::Railtie.console</tt> for more info.
52e01fc @josevalim Everyone receives app as argument for consistency.
josevalim authored
151 def load_console(app=self)
594b749 @josevalim Streamline generators initialization flow.
josevalim authored
152 initialize_console
52e01fc @josevalim Everyone receives app as argument for consistency.
josevalim authored
153 super
fa98eca @josevalim Add console hook to force ActiveRecord::Base to be loaded when consol…
josevalim authored
154 self
155 end
156
ea649de @franckverrot Rails.application#env_config is now public API. [Closes #1924]
franckverrot authored
157 # Rails.application.env_config stores some of the Rails initial environment parameters.
158 # Currently stores:
159 #
160 # * action_dispatch.parameter_filter" => config.filter_parameters,
161 # * action_dispatch.secret_token" => config.secret_token,
162 # * action_dispatch.show_exceptions" => config.action_dispatch.show_exceptions
163 #
164 # These parameters will be used by middlewares and engines to configure themselves.
165 #
a132229 @drogus Added ability to set asset_path for engines
drogus authored
166 def env_config
167 @env_config ||= super.merge({
6690d66 @josevalim Rename config.cookie_secret to config.secret_token and pass it as con…
josevalim authored
168 "action_dispatch.parameter_filter" => config.filter_parameters,
a132229 @drogus Added ability to set asset_path for engines
drogus authored
169 "action_dispatch.secret_token" => config.secret_token,
cd9d28d @lest middlewares should use logger from env
lest authored
170 "action_dispatch.show_exceptions" => config.action_dispatch.show_exceptions,
26e7400 @josevalim Fix diagnostics page for routing errors.
josevalim authored
171 "action_dispatch.show_detailed_exceptions" => config.consider_all_requests_local,
fe7d4f0 @lest put backtrace_cleaner to env
lest authored
172 "action_dispatch.logger" => Rails.logger,
173 "action_dispatch.backtrace_cleaner" => Rails.backtrace_cleaner
a132229 @drogus Added ability to set asset_path for engines
drogus authored
174 })
6d6ae08 Start moving the initializers into the application object
Carl Lerche authored
175 end
176
27f0add @josevalim Improve docs for Rails::Application and add routes_reloader_hook and …
josevalim authored
177 # Returns the ordered railties for this application considering railties_order.
178 def ordered_railties #:nodoc:
40b19e0 @drogus Allow to change engine's loading priority with config.railties_order=
drogus authored
179 @ordered_railties ||= begin
180 order = config.railties_order.map do |railtie|
181 if railtie == :main_app
182 self
183 elsif railtie.respond_to?(:instance)
184 railtie.instance
185 else
186 railtie
187 end
188 end
189
190 all = (railties.all - order)
191 all.push(self) unless all.include?(self)
192 order.push(:all) unless order.include?(:all)
193
194 index = order.index(:all)
195 order[index] = all
196 order.reverse.flatten
197 end
198 end
199
27f0add @josevalim Improve docs for Rails::Application and add routes_reloader_hook and …
josevalim authored
200 def initializers #:nodoc:
e9793c6 @spastorino Makes this code a bit more clear
spastorino authored
201 Bootstrap.initializers_for(self) +
202 super +
203 Finisher.initializers_for(self)
98240c4 @josevalim Get rid of initializers global and create i18n railtie.
josevalim authored
204 end
788fce2 @josevalim Create configurable modules and ensure that they are added only on di…
josevalim authored
205
27f0add @josevalim Improve docs for Rails::Application and add routes_reloader_hook and …
josevalim authored
206 def config #:nodoc:
32a5b49 @drogus Move singleton pattern to Railtie and remove Engine::Configurable and…
drogus authored
207 @config ||= Application::Configuration.new(find_root_with_flag("config.ru", Dir.pwd))
208 end
209
8496be7 @guilleiguaran Fixing Rails::Server#app under Rack::URLMap
guilleiguaran authored
210 def to_app
211 self
212 end
213
27f0add @josevalim Improve docs for Rails::Application and add routes_reloader_hook and …
josevalim authored
214 def helpers_paths #:nodoc:
fd86a1b @josevalim Rely on a public contract between railties instead of accessing railt…
josevalim authored
215 config.helpers_paths
216 end
217
2fe70c1 @josevalim Booya, sprockets now works from Engines.
josevalim authored
218 protected
219
220 alias :build_middleware_stack :app
612454e @josh Move sprockets initializers back to application
josh authored
221
fa1d9a8 @josevalim Speed up development by only reloading classes if dependencies files …
josevalim authored
222 def reload_dependencies?
223 config.reload_classes_only_on_change != true || reloaders.map(&:updated?).any?
224 end
225
19d8c8c @josevalim Remove the laziness from the middleware stack.
josevalim authored
226 def default_middleware_stack
227 ActionDispatch::MiddlewareStack.new.tap do |middleware|
2c0c4d7 @sikachu Add `config.force_ssl` configuration which will load `Rack::SSL` midd…
sikachu authored
228 if rack_cache = config.action_controller.perform_caching && config.action_dispatch.rack_cache
229 require "action_dispatch/http/rack_cache"
230 middleware.use ::Rack::Cache, rack_cache
231 end
254ab7d @wycats First pass at Rack::Cache
wycats authored
232
2c0c4d7 @sikachu Add `config.force_ssl` configuration which will load `Rack::SSL` midd…
sikachu authored
233 if config.force_ssl
234 require "rack/ssl"
cb5c39f @jsl Make the Rack::SSL middleware configurable
jsl authored
235 middleware.use ::Rack::SSL, config.ssl_options
2c0c4d7 @sikachu Add `config.force_ssl` configuration which will load `Rack::SSL` midd…
sikachu authored
236 end
eeb3246 Only add Rack::Cache to the middleware stack if config.action_control…
Sparky authored
237
e6369bc @drogus Application's assets should have higher priority than engine's ones
drogus authored
238 if config.serve_static_assets
1ca8123 @josevalim Add static_cache_control as configuration option and set a default fo…
josevalim authored
239 middleware.use ::ActionDispatch::Static, paths["public"].first, config.static_cache_control
e6369bc @drogus Application's assets should have higher priority than engine's ones
drogus authored
240 end
2c0c4d7 @sikachu Add `config.force_ssl` configuration which will load `Rack::SSL` midd…
sikachu authored
241
ea14396 @neerajdotname replace if ! with unless
neerajdotname authored
242 middleware.use ::Rack::Lock unless config.allow_concurrency
19d8c8c @josevalim Remove the laziness from the middleware stack.
josevalim authored
243 middleware.use ::Rack::Runtime
17a91a6 @dlee Logs should show overridden method; Issue 426
dlee authored
244 middleware.use ::Rack::MethodOverride
afde6fd @dhh Added X-Request-Id tracking and TaggedLogging to easily log that and …
dhh authored
245 middleware.use ::ActionDispatch::RequestId
c83d9a1 @josevalim Unify logger and taggedlogging middleware as both address logging con…
josevalim authored
246 middleware.use ::Rails::Rack::Logger, config.log_tags # must come after Rack::MethodOverride to properly log overridden methods
a9e8cf7 @lest add ActionController::Metal#show_detailed_exceptions?
lest authored
247 middleware.use ::ActionDispatch::ShowExceptions
750bb5c @josevalim Split ShowExceptions responsibilities in two middlewares.
josevalim authored
248 middleware.use ::ActionDispatch::DebugExceptions
19d8c8c @josevalim Remove the laziness from the middleware stack.
josevalim authored
249 middleware.use ::ActionDispatch::RemoteIp, config.action_dispatch.ip_spoofing_check, config.action_dispatch.trusted_proxies
750bb5c @josevalim Split ShowExceptions responsibilities in two middlewares.
josevalim authored
250
19ac034 @spastorino Don't use Rack::Sendfile middleware if x_sendfile_header is not present
spastorino authored
251 if config.action_dispatch.x_sendfile_header.present?
252 middleware.use ::Rack::Sendfile, config.action_dispatch.x_sendfile_header
253 end
750bb5c @josevalim Split ShowExceptions responsibilities in two middlewares.
josevalim authored
254
fa1d9a8 @josevalim Speed up development by only reloading classes if dependencies files …
josevalim authored
255 unless config.cache_classes
256 app = self
257 middleware.use ::ActionDispatch::Reloader, lambda { app.reload_dependencies? }
258 end
259
435bccd Replace AD::Callbacks.to_prepare with AD::Reloader.to_prepare
John Firebaugh authored
260 middleware.use ::ActionDispatch::Callbacks
19d8c8c @josevalim Remove the laziness from the middleware stack.
josevalim authored
261 middleware.use ::ActionDispatch::Cookies
262
263 if config.session_store
264 middleware.use config.session_store, config.session_options
265 middleware.use ::ActionDispatch::Flash
266 end
267
268 middleware.use ::ActionDispatch::ParamsParser
269 middleware.use ::ActionDispatch::Head
74dd8a3 @josevalim Move ETag and ConditionalGet logic from AD::Response to the middlewar…
josevalim authored
270 middleware.use ::Rack::ConditionalGet
271 middleware.use ::Rack::ETag, "no-cache"
2c0c4d7 @sikachu Add `config.force_ssl` configuration which will load `Rack::SSL` midd…
sikachu authored
272
273 if config.action_dispatch.best_standards_support
274 middleware.use ::ActionDispatch::BestStandardsSupport, config.action_dispatch.best_standards_support
275 end
19d8c8c @josevalim Remove the laziness from the middleware stack.
josevalim authored
276 end
277 end
278
27f0add @josevalim Improve docs for Rails::Application and add routes_reloader_hook and …
josevalim authored
279 def initialize_tasks #:nodoc:
e290835 @bilts Make Rake::DSL methods available within Railtie rake_tasks block
bilts authored
280 self.class.rake_tasks do
281 require "rails/tasks"
282 task :environment do
283 $rails_rake_task = true
284 require_environment!
285 end
788fce2 @josevalim Create configurable modules and ensure that they are added only on di…
josevalim authored
286 end
287 end
288
27f0add @josevalim Improve docs for Rails::Application and add routes_reloader_hook and …
josevalim authored
289 def initialize_console #:nodoc:
d54c778 @amatsuda always enable `pp` on the Rails console
amatsuda authored
290 require "pp"
fa98eca @josevalim Add console hook to force ActiveRecord::Base to be loaded when consol…
josevalim authored
291 require "rails/console/app"
292 require "rails/console/helpers"
293 end
accd9b4 @josh Restore "Start Rails::Application object
josh authored
294 end
17a91a6 @dlee Logs should show overridden method; Issue 426
dlee authored
295 end
Something went wrong with that request. Please try again.