Class: Rails::Application::Configuration
- Inherits:
-
Engine::Configuration
- Object
- Railtie::Configuration
- Engine::Configuration
- Rails::Application::Configuration
- Defined in:
- lib/rails/application/configuration.rb
Defined Under Namespace
Classes: Custom
Constant Summary collapse
- SERVE_STATIC_ASSETS_DEPRECATION_MESSAGE =
:nodoc:
<<-MSG.squish The configuration option `config.serve_static_assets` has been renamed to `config.serve_static_files` to clarify its role (it merely enables serving everything in the `public` folder and is unrelated to the asset pipeline). The `serve_static_assets` alias will be removed in Rails 5.0. Please migrate your configuration files accordingly. MSG
Instance Attribute Summary collapse
-
#allow_concurrency ⇒ Object
Returns the value of attribute allow_concurrency.
-
#asset_host ⇒ Object
Returns the value of attribute asset_host.
-
#assets ⇒ Object
Returns the value of attribute assets.
-
#autoflush_log ⇒ Object
Returns the value of attribute autoflush_log.
-
#beginning_of_week ⇒ Object
Returns the value of attribute beginning_of_week.
-
#cache_classes ⇒ Object
Returns the value of attribute cache_classes.
-
#cache_store ⇒ Object
Returns the value of attribute cache_store.
-
#consider_all_requests_local ⇒ Object
Returns the value of attribute consider_all_requests_local.
-
#console ⇒ Object
Returns the value of attribute console.
-
#eager_load ⇒ Object
Returns the value of attribute eager_load.
-
#encoding ⇒ Object
Returns the value of attribute encoding.
-
#exceptions_app ⇒ Object
Returns the value of attribute exceptions_app.
-
#file_watcher ⇒ Object
Returns the value of attribute file_watcher.
-
#filter_parameters ⇒ Object
Returns the value of attribute filter_parameters.
-
#filter_redirect ⇒ Object
Returns the value of attribute filter_redirect.
-
#force_ssl ⇒ Object
Returns the value of attribute force_ssl.
-
#helpers_paths ⇒ Object
Returns the value of attribute helpers_paths.
-
#log_formatter ⇒ Object
Returns the value of attribute log_formatter.
-
#log_tags ⇒ Object
Returns the value of attribute log_tags.
-
#logger ⇒ Object
Returns the value of attribute logger.
-
#railties_order ⇒ Object
Returns the value of attribute railties_order.
-
#relative_url_root ⇒ Object
Returns the value of attribute relative_url_root.
-
#reload_classes_only_on_change ⇒ Object
Returns the value of attribute reload_classes_only_on_change.
-
#secret_key_base ⇒ Object
Returns the value of attribute secret_key_base.
-
#secret_token ⇒ Object
Returns the value of attribute secret_token.
-
#serve_static_files ⇒ Object
Returns the value of attribute serve_static_files.
-
#session_options ⇒ Object
Returns the value of attribute session_options.
-
#ssl_options ⇒ Object
Returns the value of attribute ssl_options.
-
#static_cache_control ⇒ Object
Returns the value of attribute static_cache_control.
-
#time_zone ⇒ Object
Returns the value of attribute time_zone.
-
#x ⇒ Object
Returns the value of attribute x.
Attributes inherited from Engine::Configuration
#autoload_once_paths, #autoload_paths, #eager_load_paths, #middleware, #root
Instance Method Summary collapse
- #annotations ⇒ Object
- #colorize_logging ⇒ Object
- #colorize_logging=(val) ⇒ Object
-
#database_configuration ⇒ Object
Loads and returns the entire raw configuration of database from values stored in ‘config/database.yml`.
-
#has_explicit_log_level? ⇒ Boolean
:nodoc:.
-
#initialize ⇒ Configuration
constructor
A new instance of Configuration.
- #log_level ⇒ Object
- #log_level=(level) ⇒ Object
- #paths ⇒ Object
- #serve_static_assets ⇒ Object
- #serve_static_assets=(value) ⇒ Object
- #session_store(*args) ⇒ Object
Methods inherited from Engine::Configuration
Methods inherited from Railtie::Configuration
#after_initialize, #app_generators, #app_middleware, #before_configuration, #before_eager_load, #before_initialize, #eager_load_namespaces, eager_load_namespaces, #respond_to?, #to_prepare, #to_prepare_blocks, #watchable_dirs, #watchable_files
Constructor Details
#initialize ⇒ Configuration
Returns a new instance of Configuration.
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 |
# File 'lib/rails/application/configuration.rb', line 22 def initialize(*) super self.encoding = "utf-8" @allow_concurrency = nil @consider_all_requests_local = false @filter_parameters = [] @filter_redirect = [] @helpers_paths = [] @serve_static_files = true @static_cache_control = nil @force_ssl = false @ssl_options = {} @session_store = :cookie_store @session_options = {} @time_zone = "UTC" @beginning_of_week = :monday @has_explicit_log_level = false @log_level = nil @middleware = app_middleware @generators = app_generators @cache_store = [ :file_store, "#{root}/tmp/cache/" ] @railties_order = [:all] @relative_url_root = ENV["RAILS_RELATIVE_URL_ROOT"] @reload_classes_only_on_change = true @file_watcher = ActiveSupport::FileUpdateChecker @exceptions_app = nil @autoflush_log = true @log_formatter = ActiveSupport::Logger::SimpleFormatter.new @eager_load = nil @secret_token = nil @secret_key_base = nil @x = Custom.new @assets = ActiveSupport::OrderedOptions.new @assets.enabled = true @assets.paths = [] @assets.precompile = [ Proc.new { |path, fn| fn =~ /app\/assets/ && !%w(.js .css).include?(File.extname(path)) }, /(?:\/|\\|\A)application\.(css|js)$/ ] @assets.prefix = "/assets" @assets.version = '1.0' @assets.debug = false @assets.compile = true @assets.digest = false @assets.cache_store = [ :file_store, "#{root}/tmp/cache/assets/#{Rails.env}/" ] @assets.js_compressor = nil @assets.css_compressor = nil @assets.logger = nil end |
Dynamic Method Handling
This class handles dynamic methods through the method_missing method in the class Rails::Railtie::Configuration
Instance Attribute Details
#allow_concurrency ⇒ Object
Returns the value of attribute allow_concurrency.
11 12 13 |
# File 'lib/rails/application/configuration.rb', line 11 def allow_concurrency @allow_concurrency end |
#asset_host ⇒ Object
Returns the value of attribute asset_host.
11 12 13 |
# File 'lib/rails/application/configuration.rb', line 11 def asset_host @asset_host end |
#assets ⇒ Object
Returns the value of attribute assets.
11 12 13 |
# File 'lib/rails/application/configuration.rb', line 11 def assets @assets end |
#autoflush_log ⇒ Object
Returns the value of attribute autoflush_log.
11 12 13 |
# File 'lib/rails/application/configuration.rb', line 11 def autoflush_log @autoflush_log end |
#beginning_of_week ⇒ Object
Returns the value of attribute beginning_of_week.
11 12 13 |
# File 'lib/rails/application/configuration.rb', line 11 def beginning_of_week @beginning_of_week end |
#cache_classes ⇒ Object
Returns the value of attribute cache_classes.
11 12 13 |
# File 'lib/rails/application/configuration.rb', line 11 def cache_classes @cache_classes end |
#cache_store ⇒ Object
Returns the value of attribute cache_store.
11 12 13 |
# File 'lib/rails/application/configuration.rb', line 11 def cache_store @cache_store end |
#consider_all_requests_local ⇒ Object
Returns the value of attribute consider_all_requests_local.
11 12 13 |
# File 'lib/rails/application/configuration.rb', line 11 def consider_all_requests_local @consider_all_requests_local end |
#console ⇒ Object
Returns the value of attribute console.
11 12 13 |
# File 'lib/rails/application/configuration.rb', line 11 def console @console end |
#eager_load ⇒ Object
Returns the value of attribute eager_load.
11 12 13 |
# File 'lib/rails/application/configuration.rb', line 11 def eager_load @eager_load end |
#encoding ⇒ Object
Returns the value of attribute encoding.
20 21 22 |
# File 'lib/rails/application/configuration.rb', line 20 def encoding @encoding end |
#exceptions_app ⇒ Object
Returns the value of attribute exceptions_app.
11 12 13 |
# File 'lib/rails/application/configuration.rb', line 11 def exceptions_app @exceptions_app end |
#file_watcher ⇒ Object
Returns the value of attribute file_watcher.
11 12 13 |
# File 'lib/rails/application/configuration.rb', line 11 def file_watcher @file_watcher end |
#filter_parameters ⇒ Object
Returns the value of attribute filter_parameters.
11 12 13 |
# File 'lib/rails/application/configuration.rb', line 11 def filter_parameters @filter_parameters end |
#filter_redirect ⇒ Object
Returns the value of attribute filter_redirect.
11 12 13 |
# File 'lib/rails/application/configuration.rb', line 11 def filter_redirect @filter_redirect end |
#force_ssl ⇒ Object
Returns the value of attribute force_ssl.
11 12 13 |
# File 'lib/rails/application/configuration.rb', line 11 def force_ssl @force_ssl end |
#helpers_paths ⇒ Object
Returns the value of attribute helpers_paths.
11 12 13 |
# File 'lib/rails/application/configuration.rb', line 11 def helpers_paths @helpers_paths end |
#log_formatter ⇒ Object
Returns the value of attribute log_formatter.
11 12 13 |
# File 'lib/rails/application/configuration.rb', line 11 def log_formatter @log_formatter end |
#log_tags ⇒ Object
Returns the value of attribute log_tags.
11 12 13 |
# File 'lib/rails/application/configuration.rb', line 11 def @log_tags end |
#logger ⇒ Object
Returns the value of attribute logger.
11 12 13 |
# File 'lib/rails/application/configuration.rb', line 11 def logger @logger end |
#railties_order ⇒ Object
Returns the value of attribute railties_order.
11 12 13 |
# File 'lib/rails/application/configuration.rb', line 11 def railties_order @railties_order end |
#relative_url_root ⇒ Object
Returns the value of attribute relative_url_root.
11 12 13 |
# File 'lib/rails/application/configuration.rb', line 11 def relative_url_root @relative_url_root end |
#reload_classes_only_on_change ⇒ Object
Returns the value of attribute reload_classes_only_on_change.
11 12 13 |
# File 'lib/rails/application/configuration.rb', line 11 def reload_classes_only_on_change @reload_classes_only_on_change end |
#secret_key_base ⇒ Object
Returns the value of attribute secret_key_base.
11 12 13 |
# File 'lib/rails/application/configuration.rb', line 11 def secret_key_base @secret_key_base end |
#secret_token ⇒ Object
Returns the value of attribute secret_token.
11 12 13 |
# File 'lib/rails/application/configuration.rb', line 11 def secret_token @secret_token end |
#serve_static_files ⇒ Object
Returns the value of attribute serve_static_files.
11 12 13 |
# File 'lib/rails/application/configuration.rb', line 11 def serve_static_files @serve_static_files end |
#session_options ⇒ Object
Returns the value of attribute session_options.
11 12 13 |
# File 'lib/rails/application/configuration.rb', line 11 def @session_options end |
#ssl_options ⇒ Object
Returns the value of attribute ssl_options.
11 12 13 |
# File 'lib/rails/application/configuration.rb', line 11 def @ssl_options end |
#static_cache_control ⇒ Object
Returns the value of attribute static_cache_control.
11 12 13 |
# File 'lib/rails/application/configuration.rb', line 11 def static_cache_control @static_cache_control end |
#time_zone ⇒ Object
Returns the value of attribute time_zone.
11 12 13 |
# File 'lib/rails/application/configuration.rb', line 11 def time_zone @time_zone end |
#x ⇒ Object
Returns the value of attribute x.
11 12 13 |
# File 'lib/rails/application/configuration.rb', line 11 def x @x end |
Instance Method Details
#annotations ⇒ Object
186 187 188 |
# File 'lib/rails/application/configuration.rb', line 186 def annotations SourceAnnotationExtractor::Annotation end |
#colorize_logging ⇒ Object
135 136 137 |
# File 'lib/rails/application/configuration.rb', line 135 def colorize_logging ActiveSupport::LogSubscriber.colorize_logging end |
#colorize_logging=(val) ⇒ Object
139 140 141 142 |
# File 'lib/rails/application/configuration.rb', line 139 def colorize_logging=(val) ActiveSupport::LogSubscriber.colorize_logging = val self.generators.colorize_logging = val end |
#database_configuration ⇒ Object
Loads and returns the entire raw configuration of database from values stored in ‘config/database.yml`.
97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 |
# File 'lib/rails/application/configuration.rb', line 97 def database_configuration path = paths["config/database"].existent.first yaml = Pathname.new(path) if path config = if yaml && yaml.exist? require "yaml" require "erb" YAML.load(ERB.new(yaml.read).result) || {} elsif ENV['DATABASE_URL'] # Value from ENV['DATABASE_URL'] is set to default database connection # by Active Record. {} else raise "Could not load database configuration. No such file - #{paths["config/database"].instance_variable_get(:@paths)}" end config rescue Psych::SyntaxError => e raise "YAML syntax error occurred while parsing #{paths["config/database"].first}. " \ "Please note that YAML must be consistently indented using spaces. Tabs are not allowed. " \ "Error: #{e.}" rescue => e raise e, "Cannot load `Rails.application.database_configuration`:\n#{e.}", e.backtrace end |
#has_explicit_log_level? ⇒ Boolean
:nodoc:
122 123 124 |
# File 'lib/rails/application/configuration.rb', line 122 def has_explicit_log_level? # :nodoc: @has_explicit_log_level end |
#log_level ⇒ Object
131 132 133 |
# File 'lib/rails/application/configuration.rb', line 131 def log_level @log_level ||= (Rails.env.production? ? :info : :debug) end |
#log_level=(level) ⇒ Object
126 127 128 129 |
# File 'lib/rails/application/configuration.rb', line 126 def log_level=(level) @has_explicit_log_level = !!(level) @log_level = level end |
#paths ⇒ Object
79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 |
# File 'lib/rails/application/configuration.rb', line 79 def paths @paths ||= begin paths = super paths.add "config/database", with: "config/database.yml" paths.add "config/secrets", with: "config/secrets.yml" paths.add "config/environment", with: "config/environment.rb" paths.add "lib/templates" paths.add "log", with: "log/#{Rails.env}.log" paths.add "public" paths.add "public/javascripts" paths.add "public/stylesheets" paths.add "tmp" paths end end |
#serve_static_assets ⇒ Object
153 154 155 156 |
# File 'lib/rails/application/configuration.rb', line 153 def serve_static_assets ActiveSupport::Deprecation.warn SERVE_STATIC_ASSETS_DEPRECATION_MESSAGE serve_static_files end |
#serve_static_assets=(value) ⇒ Object
158 159 160 161 |
# File 'lib/rails/application/configuration.rb', line 158 def serve_static_assets=(value) ActiveSupport::Deprecation.warn SERVE_STATIC_ASSETS_DEPRECATION_MESSAGE self.serve_static_files = value end |
#session_store(*args) ⇒ Object
163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 |
# File 'lib/rails/application/configuration.rb', line 163 def session_store(*args) if args.empty? case @session_store when :disabled nil when :active_record_store begin ActionDispatch::Session::ActiveRecordStore rescue NameError raise "`ActiveRecord::SessionStore` is extracted out of Rails into a gem. " \ "Please add `activerecord-session_store` to your Gemfile to use it." end when Symbol ActionDispatch::Session.const_get(@session_store.to_s.camelize) else @session_store end else @session_store = args.shift @session_options = args.shift || {} end end |