123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315 |
- require 'active_support/core_ext/hash/reverse_merge'
- require 'fileutils'
- require 'rails/plugin'
- require 'rails/engine'
- module Rails
- # In Rails 3.0, a Rails::Application object was introduced which is nothing more than
- # an Engine but with the responsibility of coordinating the whole boot process.
- #
- # == Initialization
- #
- # Rails::Application is responsible for executing all railties, engines and plugin
- # initializers. It also executes some bootstrap initializers (check
- # Rails::Application::Bootstrap) and finishing initializers, after all the others
- # are executed (check Rails::Application::Finisher).
- #
- # == Configuration
- #
- # Besides providing the same configuration as Rails::Engine and Rails::Railtie,
- # the application object has several specific configurations, for example
- # "allow_concurrency", "cache_classes", "consider_all_requests_local", "filter_parameters",
- # "logger", "reload_plugins" and so forth.
- #
- # Check Rails::Application::Configuration to see them all.
- #
- # == Routes
- #
- # The application object is also responsible for holding the routes and reloading routes
- # whenever the files change in development.
- #
- # == Middlewares
- #
- # The Application is also responsible for building the middleware stack.
- #
- # == Booting process
- #
- # The application is also responsible for setting up and executing the booting
- # process. From the moment you require "config/application.rb" in your app,
- # the booting process goes like this:
- #
- # 1) require "config/boot.rb" to setup load paths
- # 2) require railties and engines
- # 3) Define Rails.application as "class MyApp::Application < Rails::Application"
- # 4) Run config.before_configuration callbacks
- # 5) Load config/environments/ENV.rb
- # 6) Run config.before_initialize callbacks
- # 7) Run Railtie#initializer defined by railties, engines and application.
- # One by one, each engine sets up its load paths, routes and runs its config/initializers/* files.
- # 9) Custom Railtie#initializers added by railties, engines and applications are executed
- # 10) Build the middleware stack and run to_prepare callbacks
- # 11) Run config.before_eager_load and eager_load if cache classes is true
- # 12) Run config.after_initialize callbacks
- #
- class Application < Engine
- autoload :Bootstrap, 'rails/application/bootstrap'
- autoload :Configuration, 'rails/application/configuration'
- autoload :Finisher, 'rails/application/finisher'
- autoload :Railties, 'rails/application/railties'
- autoload :RoutesReloader, 'rails/application/routes_reloader'
- class << self
- def inherited(base)
- raise "You cannot have more than one Rails::Application" if Rails.application
- super
- Rails.application = base.instance
- Rails.application.add_lib_to_load_path!
- ActiveSupport.run_load_hooks(:before_configuration, base.instance)
- end
- end
- attr_accessor :assets, :sandbox
- alias_method :sandbox?, :sandbox
- attr_reader :reloaders
- delegate :default_url_options, :default_url_options=, :to => :routes
- def initialize
- super
- @initialized = false
- @reloaders = []
- end
- # This method is called just after an application inherits from Rails::Application,
- # allowing the developer to load classes in lib and use them during application
- # configuration.
- #
- # class MyApplication < Rails::Application
- # require "my_backend" # in lib/my_backend
- # config.i18n.backend = MyBackend
- # end
- #
- # Notice this method takes into consideration the default root path. So if you
- # are changing config.root inside your application definition or having a custom
- # Rails application, you will need to add lib to $LOAD_PATH on your own in case
- # you need to load files in lib/ during the application configuration as well.
- def add_lib_to_load_path! #:nodoc:
- path = config.root.join('lib').to_s
- $LOAD_PATH.unshift(path) if File.exists?(path)
- end
- def require_environment! #:nodoc:
- environment = paths["config/environment"].existent.first
- require environment if environment
- end
- # Reload application routes regardless if they changed or not.
- def reload_routes!
- routes_reloader.reload!
- end
- def routes_reloader #:nodoc:
- @routes_reloader ||= RoutesReloader.new
- end
- # Returns an array of file paths appended with a hash of directories-extensions
- # suitable for ActiveSupport::FileUpdateChecker API.
- def watchable_args
- files = []
- files.concat config.watchable_files
- dirs = {}
- dirs.merge! config.watchable_dirs
- ActiveSupport::Dependencies.autoload_paths.each do |path|
- dirs[path.to_s] = [:rb]
- end
- [files, dirs]
- end
- # Initialize the application passing the given group. By default, the
- # group is :default but sprockets precompilation passes group equals
- # to assets if initialize_on_precompile is false to avoid booting the
- # whole app.
- def initialize!(group=:default) #:nodoc:
- raise "Application has been already initialized." if @initialized
- run_initializers(group, self)
- @initialized = true
- self
- end
- # Load the application and its railties tasks and invoke the registered hooks.
- # Check <tt>Rails::Railtie.rake_tasks</tt> for more info.
- def load_tasks(app=self)
- initialize_tasks
- super
- self
- end
- # Load the application console and invoke the registered hooks.
- # Check <tt>Rails::Railtie.console</tt> for more info.
- def load_console(app=self)
- initialize_console
- super
- self
- end
- # Rails.application.env_config stores some of the Rails initial environment parameters.
- # Currently stores:
- #
- # * action_dispatch.parameter_filter" => config.filter_parameters,
- # * action_dispatch.secret_token" => config.secret_token,
- # * action_dispatch.show_exceptions" => config.action_dispatch.show_exceptions
- #
- # These parameters will be used by middlewares and engines to configure themselves.
- #
- def env_config
- @env_config ||= super.merge({
- "action_dispatch.parameter_filter" => config.filter_parameters,
- "action_dispatch.secret_token" => config.secret_token,
- "action_dispatch.show_exceptions" => config.action_dispatch.show_exceptions,
- "action_dispatch.show_detailed_exceptions" => config.consider_all_requests_local,
- "action_dispatch.logger" => Rails.logger,
- "action_dispatch.backtrace_cleaner" => Rails.backtrace_cleaner
- })
- end
- # Returns the ordered railties for this application considering railties_order.
- def ordered_railties #:nodoc:
- @ordered_railties ||= begin
- order = config.railties_order.map do |railtie|
- if railtie == :main_app
- self
- elsif railtie.respond_to?(:instance)
- railtie.instance
- else
- railtie
- end
- end
- all = (railties.all - order)
- all.push(self) unless (all + order).include?(self)
- order.push(:all) unless order.include?(:all)
- index = order.index(:all)
- order[index] = all
- order.reverse.flatten
- end
- end
- def initializers #:nodoc:
- Bootstrap.initializers_for(self) +
- super +
- Finisher.initializers_for(self)
- end
- def config #:nodoc:
- @config ||= Application::Configuration.new(find_root_with_flag("config.ru", Dir.pwd))
- end
- def to_app
- self
- end
- def helpers_paths #:nodoc:
- config.helpers_paths
- end
- def call(env)
- env["ORIGINAL_FULLPATH"] = build_original_fullpath(env)
- super(env)
- end
- protected
- alias :build_middleware_stack :app
- def reload_dependencies?
- config.reload_classes_only_on_change != true || reloaders.map(&:updated?).any?
- end
- def default_middleware_stack
- ActionDispatch::MiddlewareStack.new.tap do |middleware|
- if rack_cache = config.action_controller.perform_caching && config.action_dispatch.rack_cache
- require "action_dispatch/http/rack_cache"
- middleware.use ::Rack::Cache, rack_cache
- end
- if config.force_ssl
- require "rack/ssl"
- middleware.use ::Rack::SSL, config.ssl_options
- end
- if config.serve_static_assets
- middleware.use ::ActionDispatch::Static, paths["public"].first, config.static_cache_control
- end
- middleware.use ::Rack::Lock unless config.allow_concurrency
- middleware.use ::Rack::Runtime
- middleware.use ::Rack::MethodOverride
- middleware.use ::ActionDispatch::RequestId
- middleware.use ::Rails::Rack::Logger, config.log_tags # must come after Rack::MethodOverride to properly log overridden methods
- middleware.use ::ActionDispatch::ShowExceptions, config.exceptions_app || ActionDispatch::PublicExceptions.new(Rails.public_path)
- middleware.use ::ActionDispatch::DebugExceptions
- middleware.use ::ActionDispatch::RemoteIp, config.action_dispatch.ip_spoofing_check, config.action_dispatch.trusted_proxies
- if config.action_dispatch.x_sendfile_header.present?
- middleware.use ::Rack::Sendfile, config.action_dispatch.x_sendfile_header
- end
- unless config.cache_classes
- app = self
- middleware.use ::ActionDispatch::Reloader, lambda { app.reload_dependencies? }
- end
- middleware.use ::ActionDispatch::Callbacks
- middleware.use ::ActionDispatch::Cookies
- if config.session_store
- if config.force_ssl && !config.session_options.key?(:secure)
- config.session_options[:secure] = true
- end
- middleware.use config.session_store, config.session_options
- middleware.use ::ActionDispatch::Flash
- end
- middleware.use ::ActionDispatch::ParamsParser
- middleware.use ::ActionDispatch::Head
- middleware.use ::Rack::ConditionalGet
- middleware.use ::Rack::ETag, "no-cache"
- if config.action_dispatch.best_standards_support
- middleware.use ::ActionDispatch::BestStandardsSupport, config.action_dispatch.best_standards_support
- end
- end
- end
- def initialize_tasks #:nodoc:
- self.class.rake_tasks do
- require "rails/tasks"
- task :environment do
- $rails_rake_task = true
- require_environment!
- end
- end
- end
- def initialize_console #:nodoc:
- require "pp"
- require "rails/console/app"
- require "rails/console/helpers"
- end
- def build_original_fullpath(env)
- path_info = env["PATH_INFO"]
- query_string = env["QUERY_STRING"]
- script_name = env["SCRIPT_NAME"]
- if query_string.present?
- "#{script_name}#{path_info}?#{query_string}"
- else
- "#{script_name}#{path_info}"
- end
- end
- end
- end
|