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
Instance Attribute Summary collapse
-
#add_autoload_paths_to_load_path ⇒ Object
Returns the value of attribute add_autoload_paths_to_load_path.
-
#allow_concurrency ⇒ Object
Returns the value of attribute allow_concurrency.
-
#api_only ⇒ Object
Returns the value of attribute api_only.
-
#asset_host ⇒ Object
Returns the value of attribute asset_host.
-
#assume_ssl ⇒ Object
Returns the value of attribute assume_ssl.
-
#autoflush_log ⇒ Object
Returns the value of attribute autoflush_log.
-
#beginning_of_week ⇒ Object
Returns the value of attribute beginning_of_week.
-
#broadcast_log_level ⇒ Object
readonly
:nodoc:.
-
#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.
-
#content_security_policy_nonce_directives ⇒ Object
Returns the value of attribute content_security_policy_nonce_directives.
-
#content_security_policy_nonce_generator ⇒ Object
Returns the value of attribute content_security_policy_nonce_generator.
-
#content_security_policy_report_only ⇒ Object
Returns the value of attribute content_security_policy_report_only.
-
#credentials ⇒ Object
Returns the value of attribute credentials.
- #debug_exception_response_format ⇒ Object
-
#disable_sandbox ⇒ Object
Returns the value of attribute disable_sandbox.
-
#dom_testing_default_html_version ⇒ Object
Returns the value of attribute dom_testing_default_html_version.
-
#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.
-
#host_authorization ⇒ Object
Returns the value of attribute host_authorization.
-
#hosts ⇒ Object
Returns the value of attribute hosts.
-
#loaded_config_version ⇒ Object
readonly
Returns the value of attribute loaded_config_version.
-
#log_file_size ⇒ Object
Returns the value of attribute log_file_size.
-
#log_formatter ⇒ Object
Returns the value of attribute log_formatter.
-
#log_level ⇒ Object
Returns the value of attribute log_level.
-
#log_tags ⇒ Object
Returns the value of attribute log_tags.
-
#logger ⇒ Object
Returns the value of attribute logger.
-
#precompile_filter_parameters ⇒ Object
Returns the value of attribute precompile_filter_parameters.
-
#public_file_server ⇒ Object
Returns the value of attribute public_file_server.
-
#railties_order ⇒ Object
Returns the value of attribute railties_order.
-
#rake_eager_load ⇒ Object
Returns the value of attribute rake_eager_load.
-
#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.
-
#require_master_key ⇒ Object
Returns the value of attribute require_master_key.
-
#sandbox_by_default ⇒ Object
Returns the value of attribute sandbox_by_default.
-
#server_timing ⇒ Object
Returns the value of attribute server_timing.
-
#session_options ⇒ Object
Returns the value of attribute session_options.
-
#silence_healthcheck_path ⇒ Object
Returns the value of attribute silence_healthcheck_path.
-
#ssl_options ⇒ Object
Returns the value of attribute ssl_options.
-
#time_zone ⇒ Object
Returns the value of attribute time_zone.
-
#x ⇒ Object
Returns the value of attribute x.
-
#yjit ⇒ Object
Returns the value of attribute yjit.
Attributes inherited from Engine::Configuration
#autoload_once_paths, #autoload_paths, #default_scope, #eager_load_paths, #javascript_path, #middleware, #root, #route_set_class
Instance Method Summary collapse
- #annotations ⇒ Object
- #autoload_lib(ignore:) ⇒ Object
- #autoload_lib_once(ignore:) ⇒ Object
- #colorize_logging ⇒ Object
- #colorize_logging=(val) ⇒ Object
-
#content_security_policy(&block) ⇒ Object
Configures the ActionDispatch::ContentSecurityPolicy.
-
#database_configuration ⇒ Object
Loads and returns the entire raw configuration of database from values stored in
config/database.yml
. - #default_log_file ⇒ Object
- #enable_reloading ⇒ Object
- #enable_reloading=(value) ⇒ Object
-
#initialize ⇒ Configuration
constructor
A new instance of Configuration.
-
#inspect ⇒ Object
:nodoc:.
-
#load_database_yaml ⇒ Object
Load the
config/database.yml
to create the Rake tasks for multiple databases without loading the environment and filling in the environment specific configuration values. -
#load_defaults(target_version) ⇒ Object
Loads default configuration values for a target version.
- #paths ⇒ Object
-
#permissions_policy(&block) ⇒ Object
Configures the ActionDispatch::PermissionsPolicy.
- #reloading_enabled? ⇒ Boolean
- #secret_key_base ⇒ Object
- #secret_key_base=(new_secret_key_base) ⇒ Object
-
#session_store(new_session_store = nil, **options) ⇒ Object
Specifies what class to use to store the session.
-
#session_store? ⇒ Boolean
:nodoc:.
Methods inherited from Engine::Configuration
#all_autoload_once_paths, #all_autoload_paths, #all_eager_load_paths, #generators
Methods inherited from Railtie::Configuration
#after_initialize, #after_routes_loaded, #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.
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 |
# File 'lib/rails/application/configuration.rb', line 30 def initialize(*) super self.encoding = Encoding::UTF_8 @allow_concurrency = nil @consider_all_requests_local = false @filter_parameters = [] @filter_redirect = [] @helpers_paths = [] if Rails.env.development? @hosts = ActionDispatch::HostAuthorization::ALLOWED_HOSTS_IN_DEVELOPMENT + ENV["RAILS_DEVELOPMENT_HOSTS"].to_s.split(",").map(&:strip) else @hosts = [] end @host_authorization = {} @public_file_server = ActiveSupport::OrderedOptions.new @public_file_server.enabled = true @public_file_server.index_name = "index" @assume_ssl = false @force_ssl = false @ssl_options = {} @session_store = nil @time_zone = "UTC" @beginning_of_week = :monday @log_level = :debug @log_file_size = nil @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 @silence_healthcheck_path = nil @eager_load = nil @secret_key_base = nil @api_only = false @debug_exception_response_format = nil @x = Custom.new @content_security_policy = nil @content_security_policy_report_only = false @content_security_policy_nonce_generator = nil @content_security_policy_nonce_directives = nil @require_master_key = false @loaded_config_version = nil @credentials = ActiveSupport::InheritableOptions.new(credentials_defaults) @disable_sandbox = false @sandbox_by_default = false @add_autoload_paths_to_load_path = true @permissions_policy = nil @rake_eager_load = false @server_timing = false @dom_testing_default_html_version = :html4 @yjit = false end |
Dynamic Method Handling
This class handles dynamic methods through the method_missing method in the class Rails::Railtie::Configuration
Instance Attribute Details
#add_autoload_paths_to_load_path ⇒ Object
Returns the value of attribute add_autoload_paths_to_load_path.
14 15 16 |
# File 'lib/rails/application/configuration.rb', line 14 def add_autoload_paths_to_load_path @add_autoload_paths_to_load_path end |
#allow_concurrency ⇒ Object
Returns the value of attribute allow_concurrency.
14 15 16 |
# File 'lib/rails/application/configuration.rb', line 14 def allow_concurrency @allow_concurrency end |
#api_only ⇒ Object
Returns the value of attribute api_only.
28 29 30 |
# File 'lib/rails/application/configuration.rb', line 28 def api_only @api_only end |
#asset_host ⇒ Object
Returns the value of attribute asset_host.
14 15 16 |
# File 'lib/rails/application/configuration.rb', line 14 def asset_host @asset_host end |
#assume_ssl ⇒ Object
Returns the value of attribute assume_ssl.
14 15 16 |
# File 'lib/rails/application/configuration.rb', line 14 def assume_ssl @assume_ssl end |
#autoflush_log ⇒ Object
Returns the value of attribute autoflush_log.
14 15 16 |
# File 'lib/rails/application/configuration.rb', line 14 def autoflush_log @autoflush_log end |
#beginning_of_week ⇒ Object
Returns the value of attribute beginning_of_week.
14 15 16 |
# File 'lib/rails/application/configuration.rb', line 14 def beginning_of_week @beginning_of_week end |
#broadcast_log_level ⇒ Object (readonly)
:nodoc:
388 389 390 |
# File 'lib/rails/application/configuration.rb', line 388 def broadcast_log_level @broadcast_log_level end |
#cache_classes ⇒ Object
Returns the value of attribute cache_classes.
14 15 16 |
# File 'lib/rails/application/configuration.rb', line 14 def cache_classes @cache_classes end |
#cache_store ⇒ Object
Returns the value of attribute cache_store.
14 15 16 |
# File 'lib/rails/application/configuration.rb', line 14 def cache_store @cache_store end |
#consider_all_requests_local ⇒ Object
Returns the value of attribute consider_all_requests_local.
14 15 16 |
# File 'lib/rails/application/configuration.rb', line 14 def consider_all_requests_local @consider_all_requests_local end |
#console ⇒ Object
Returns the value of attribute console.
14 15 16 |
# File 'lib/rails/application/configuration.rb', line 14 def console @console end |
#content_security_policy_nonce_directives ⇒ Object
Returns the value of attribute content_security_policy_nonce_directives.
14 15 16 |
# File 'lib/rails/application/configuration.rb', line 14 def content_security_policy_nonce_directives @content_security_policy_nonce_directives end |
#content_security_policy_nonce_generator ⇒ Object
Returns the value of attribute content_security_policy_nonce_generator.
14 15 16 |
# File 'lib/rails/application/configuration.rb', line 14 def content_security_policy_nonce_generator @content_security_policy_nonce_generator end |
#content_security_policy_report_only ⇒ Object
Returns the value of attribute content_security_policy_report_only.
14 15 16 |
# File 'lib/rails/application/configuration.rb', line 14 def content_security_policy_report_only @content_security_policy_report_only end |
#credentials ⇒ Object
Returns the value of attribute credentials.
14 15 16 |
# File 'lib/rails/application/configuration.rb', line 14 def credentials @credentials end |
#debug_exception_response_format ⇒ Object
390 391 392 |
# File 'lib/rails/application/configuration.rb', line 390 def debug_exception_response_format @debug_exception_response_format || :default end |
#disable_sandbox ⇒ Object
Returns the value of attribute disable_sandbox.
14 15 16 |
# File 'lib/rails/application/configuration.rb', line 14 def disable_sandbox @disable_sandbox end |
#dom_testing_default_html_version ⇒ Object
Returns the value of attribute dom_testing_default_html_version.
14 15 16 |
# File 'lib/rails/application/configuration.rb', line 14 def dom_testing_default_html_version @dom_testing_default_html_version end |
#eager_load ⇒ Object
Returns the value of attribute eager_load.
14 15 16 |
# File 'lib/rails/application/configuration.rb', line 14 def eager_load @eager_load end |
#encoding ⇒ Object
Returns the value of attribute encoding.
28 29 30 |
# File 'lib/rails/application/configuration.rb', line 28 def encoding @encoding end |
#exceptions_app ⇒ Object
Returns the value of attribute exceptions_app.
14 15 16 |
# File 'lib/rails/application/configuration.rb', line 14 def exceptions_app @exceptions_app end |
#file_watcher ⇒ Object
Returns the value of attribute file_watcher.
14 15 16 |
# File 'lib/rails/application/configuration.rb', line 14 def file_watcher @file_watcher end |
#filter_parameters ⇒ Object
Returns the value of attribute filter_parameters.
14 15 16 |
# File 'lib/rails/application/configuration.rb', line 14 def filter_parameters @filter_parameters end |
#filter_redirect ⇒ Object
Returns the value of attribute filter_redirect.
14 15 16 |
# File 'lib/rails/application/configuration.rb', line 14 def filter_redirect @filter_redirect end |
#force_ssl ⇒ Object
Returns the value of attribute force_ssl.
14 15 16 |
# File 'lib/rails/application/configuration.rb', line 14 def force_ssl @force_ssl end |
#helpers_paths ⇒ Object
Returns the value of attribute helpers_paths.
14 15 16 |
# File 'lib/rails/application/configuration.rb', line 14 def helpers_paths @helpers_paths end |
#host_authorization ⇒ Object
Returns the value of attribute host_authorization.
14 15 16 |
# File 'lib/rails/application/configuration.rb', line 14 def @host_authorization end |
#hosts ⇒ Object
Returns the value of attribute hosts.
14 15 16 |
# File 'lib/rails/application/configuration.rb', line 14 def hosts @hosts end |
#loaded_config_version ⇒ Object (readonly)
Returns the value of attribute loaded_config_version.
28 29 30 |
# File 'lib/rails/application/configuration.rb', line 28 def loaded_config_version @loaded_config_version end |
#log_file_size ⇒ Object
Returns the value of attribute log_file_size.
14 15 16 |
# File 'lib/rails/application/configuration.rb', line 14 def log_file_size @log_file_size end |
#log_formatter ⇒ Object
Returns the value of attribute log_formatter.
14 15 16 |
# File 'lib/rails/application/configuration.rb', line 14 def log_formatter @log_formatter end |
#log_level ⇒ Object
Returns the value of attribute log_level.
28 29 30 |
# File 'lib/rails/application/configuration.rb', line 28 def log_level @log_level end |
#log_tags ⇒ Object
Returns the value of attribute log_tags.
14 15 16 |
# File 'lib/rails/application/configuration.rb', line 14 def @log_tags end |
#logger ⇒ Object
Returns the value of attribute logger.
14 15 16 |
# File 'lib/rails/application/configuration.rb', line 14 def logger @logger end |
#precompile_filter_parameters ⇒ Object
Returns the value of attribute precompile_filter_parameters.
14 15 16 |
# File 'lib/rails/application/configuration.rb', line 14 def precompile_filter_parameters @precompile_filter_parameters end |
#public_file_server ⇒ Object
Returns the value of attribute public_file_server.
14 15 16 |
# File 'lib/rails/application/configuration.rb', line 14 def public_file_server @public_file_server end |
#railties_order ⇒ Object
Returns the value of attribute railties_order.
14 15 16 |
# File 'lib/rails/application/configuration.rb', line 14 def railties_order @railties_order end |
#rake_eager_load ⇒ Object
Returns the value of attribute rake_eager_load.
14 15 16 |
# File 'lib/rails/application/configuration.rb', line 14 def rake_eager_load @rake_eager_load end |
#relative_url_root ⇒ Object
Returns the value of attribute relative_url_root.
14 15 16 |
# File 'lib/rails/application/configuration.rb', line 14 def relative_url_root @relative_url_root end |
#reload_classes_only_on_change ⇒ Object
Returns the value of attribute reload_classes_only_on_change.
14 15 16 |
# File 'lib/rails/application/configuration.rb', line 14 def reload_classes_only_on_change @reload_classes_only_on_change end |
#require_master_key ⇒ Object
Returns the value of attribute require_master_key.
14 15 16 |
# File 'lib/rails/application/configuration.rb', line 14 def require_master_key @require_master_key end |
#sandbox_by_default ⇒ Object
Returns the value of attribute sandbox_by_default.
14 15 16 |
# File 'lib/rails/application/configuration.rb', line 14 def sandbox_by_default @sandbox_by_default end |
#server_timing ⇒ Object
Returns the value of attribute server_timing.
14 15 16 |
# File 'lib/rails/application/configuration.rb', line 14 def server_timing @server_timing end |
#session_options ⇒ Object
Returns the value of attribute session_options.
14 15 16 |
# File 'lib/rails/application/configuration.rb', line 14 def @session_options end |
#silence_healthcheck_path ⇒ Object
Returns the value of attribute silence_healthcheck_path.
14 15 16 |
# File 'lib/rails/application/configuration.rb', line 14 def silence_healthcheck_path @silence_healthcheck_path end |
#ssl_options ⇒ Object
Returns the value of attribute ssl_options.
14 15 16 |
# File 'lib/rails/application/configuration.rb', line 14 def @ssl_options end |
#time_zone ⇒ Object
Returns the value of attribute time_zone.
14 15 16 |
# File 'lib/rails/application/configuration.rb', line 14 def time_zone @time_zone end |
#x ⇒ Object
Returns the value of attribute x.
14 15 16 |
# File 'lib/rails/application/configuration.rb', line 14 def x @x end |
#yjit ⇒ Object
Returns the value of attribute yjit.
14 15 16 |
# File 'lib/rails/application/configuration.rb', line 14 def yjit @yjit end |
Instance Method Details
#annotations ⇒ Object
561 562 563 |
# File 'lib/rails/application/configuration.rb', line 561 def annotations Rails::SourceAnnotationExtractor::Annotation end |
#autoload_lib(ignore:) ⇒ Object
471 472 473 474 475 476 477 478 479 480 481 |
# File 'lib/rails/application/configuration.rb', line 471 def autoload_lib(ignore:) lib = root.join("lib") # Set as a string to have the same type as default autoload paths, for # consistency. autoload_paths << lib.to_s eager_load_paths << lib.to_s ignored_abspaths = Array.wrap(ignore).map { lib.join(_1) } Rails.autoloaders.main.ignore(ignored_abspaths) end |
#autoload_lib_once(ignore:) ⇒ Object
483 484 485 486 487 488 489 490 491 492 493 |
# File 'lib/rails/application/configuration.rb', line 483 def autoload_lib_once(ignore:) lib = root.join("lib") # Set as a string to have the same type as default autoload paths, for # consistency. autoload_once_paths << lib.to_s eager_load_paths << lib.to_s ignored_abspaths = Array.wrap(ignore).map { lib.join(_1) } Rails.autoloaders.once.ignore(ignored_abspaths) end |
#colorize_logging ⇒ Object
495 496 497 |
# File 'lib/rails/application/configuration.rb', line 495 def colorize_logging ActiveSupport::LogSubscriber.colorize_logging end |
#colorize_logging=(val) ⇒ Object
499 500 501 502 |
# File 'lib/rails/application/configuration.rb', line 499 def colorize_logging=(val) ActiveSupport::LogSubscriber.colorize_logging = val generators.colorize_logging = val end |
#content_security_policy(&block) ⇒ Object
Configures the ActionDispatch::ContentSecurityPolicy.
566 567 568 569 570 571 572 |
# File 'lib/rails/application/configuration.rb', line 566 def content_security_policy(&block) if block_given? @content_security_policy = ActionDispatch::ContentSecurityPolicy.new(&block) else @content_security_policy end end |
#database_configuration ⇒ Object
Loads and returns the entire raw configuration of database from values stored in config/database.yml
.
434 435 436 437 438 439 440 441 442 443 444 445 446 447 448 449 450 451 452 453 454 455 456 457 458 459 460 461 462 463 464 465 466 467 468 469 |
# File 'lib/rails/application/configuration.rb', line 434 def database_configuration path = paths["config/database"].existent.first yaml = Pathname.new(path) if path config = if yaml&.exist? loaded_yaml = ActiveSupport::ConfigurationFile.parse(yaml) if (shared = loaded_yaml.delete("shared")) loaded_yaml.each do |env, config| if config.is_a?(Hash) && config.values.all?(Hash) if shared.is_a?(Hash) && shared.values.all?(Hash) config.map do |name, sub_config| sub_config.reverse_merge!(shared[name]) end else config.map do |name, sub_config| sub_config.reverse_merge!(shared) end end else config.reverse_merge!(shared) end end end Hash.new(shared).merge(loaded_yaml) 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 => e raise e, "Cannot load database configuration:\n#{e.}", e.backtrace end |
#default_log_file ⇒ Object
583 584 585 586 587 588 589 590 591 592 593 |
# File 'lib/rails/application/configuration.rb', line 583 def default_log_file path = paths["log"].first unless File.exist? File.dirname path FileUtils.mkdir_p File.dirname path end f = File.open path, "a" f.binmode f.sync = autoflush_log # if true make sure every write flushes f end |
#enable_reloading ⇒ Object
360 361 362 |
# File 'lib/rails/application/configuration.rb', line 360 def enable_reloading !cache_classes end |
#enable_reloading=(value) ⇒ Object
364 365 366 |
# File 'lib/rails/application/configuration.rb', line 364 def enable_reloading=(value) self.cache_classes = !value end |
#inspect ⇒ Object
:nodoc:
595 596 597 |
# File 'lib/rails/application/configuration.rb', line 595 def inspect # :nodoc: "#<#{self.class.name}:#{'%#016x' % (object_id << 1)}>" end |
#load_database_yaml ⇒ Object
Load the config/database.yml
to create the Rake tasks for multiple databases without loading the environment and filling in the environment specific configuration values.
Do not use this method, use #database_configuration instead.
416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 |
# File 'lib/rails/application/configuration.rb', line 416 def load_database_yaml # :nodoc: if path = paths["config/database"].existent.first require "rails/application/dummy_config" original_rails_config = Rails.application.config begin Rails.application.config = DummyConfig.new(original_rails_config) ActiveSupport::ConfigurationFile.parse(Pathname.new(path)) ensure Rails.application.config = original_rails_config end else {} end end |
#load_defaults(target_version) ⇒ Object
Loads default configuration values for a target version. This includes defaults for versions prior to the target version. See the configuration guide for the default values associated with a particular version.
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 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 |
# File 'lib/rails/application/configuration.rb', line 92 def load_defaults(target_version) # To introduce a change in behavior, follow these steps: # 1. Add an accessor on the target object (e.g. the ActiveJob class for # global Active Job config). # 2. Set a default value there preserving existing behavior for existing # applications. # 3. Implement the behavior change based on the config value. # 4. In the section below corresponding to the next release of Rails, # configure the default value. # 5. Add a commented out section in the `new_framework_defaults` to # configure the default value again. # 6. Update the guide in `configuring.md`. # To remove configurable deprecated behavior, follow these steps: # 1. Update or remove the entry in the guides. # 2. Remove the references below. # 3. Remove the legacy code paths and config check. # 4. Remove the config accessor. case target_version.to_s when "5.0" if respond_to?(:action_controller) action_controller.per_form_csrf_tokens = true action_controller.forgery_protection_origin_check = true end if respond_to?(:active_support) active_support.to_time_preserves_timezone = :offset end if respond_to?(:active_record) active_record.belongs_to_required_by_default = true end self. = { hsts: { subdomains: true } } when "5.1" load_defaults "5.0" if respond_to?(:assets) assets.unknown_asset_fallback = false end if respond_to?(:action_view) action_view.form_with_generates_remote_forms = true end when "5.2" load_defaults "5.1" if respond_to?(:active_record) active_record.cache_versioning = true end if respond_to?(:action_dispatch) action_dispatch. = true end if respond_to?(:active_support) active_support. = true active_support.hash_digest_class = OpenSSL::Digest::SHA1 end if respond_to?(:action_controller) action_controller.default_protect_from_forgery = true end if respond_to?(:action_view) action_view.form_with_generates_ids = true end when "6.0" load_defaults "5.2" if respond_to?(:action_view) action_view.default_enforce_utf8 = false end if respond_to?(:action_dispatch) action_dispatch. = true end if respond_to?(:action_mailer) action_mailer.delivery_job = "ActionMailer::MailDeliveryJob" end if respond_to?(:active_storage) active_storage.queues.analysis = :active_storage_analysis active_storage.queues.purge = :active_storage_purge end if respond_to?(:active_record) active_record.collection_cache_versioning = true end when "6.1" load_defaults "6.0" if respond_to?(:active_record) active_record.has_many_inversing = true end if respond_to?(:active_job) active_job.retry_jitter = 0.15 end if respond_to?(:action_dispatch) action_dispatch. = :lax action_dispatch.ssl_default_redirect_status = 308 end if respond_to?(:action_view) action_view.form_with_generates_remote_forms = false action_view.preload_links_header = true end if respond_to?(:active_storage) active_storage.track_variants = true active_storage.queues.analysis = nil active_storage.queues.purge = nil end if respond_to?(:action_mailbox) action_mailbox.queues.incineration = nil action_mailbox.queues.routing = nil end if respond_to?(:action_mailer) action_mailer.deliver_later_queue_name = nil end ActiveSupport.utc_to_local_returns_utc_offset_times = true when "7.0" load_defaults "6.1" if respond_to?(:action_dispatch) action_dispatch.default_headers = { "X-Frame-Options" => "SAMEORIGIN", "X-XSS-Protection" => "0", "X-Content-Type-Options" => "nosniff", "X-Download-Options" => "noopen", "X-Permitted-Cross-Domain-Policies" => "none", "Referrer-Policy" => "strict-origin-when-cross-origin" } action_dispatch. = :json end if respond_to?(:action_view) action_view. = true action_view.apply_stylesheet_media_default = false end if respond_to?(:active_support) active_support.hash_digest_class = OpenSSL::Digest::SHA256 active_support.key_generator_hash_digest_class = OpenSSL::Digest::SHA256 active_support.cache_format_version = 7.0 active_support.executor_around_test_case = true end if respond_to?(:action_mailer) action_mailer.smtp_timeout = 5 end if respond_to?(:active_storage) active_storage.video_preview_arguments = "-vf 'select=eq(n\\,0)+eq(key\\,1)+gt(scene\\,0.015),loop=loop=-1:size=2,trim=start_frame=1'" \ " -frames:v 1 -f image2" active_storage.variant_processor = :vips active_storage.multiple_file_field_include_hidden = true end if respond_to?(:active_record) active_record.verify_foreign_keys_for_fixtures = true active_record.partial_inserts = false active_record.automatic_scope_inversing = true end if respond_to?(:action_controller) action_controller.raise_on_open_redirects = true action_controller.wrap_parameters_by_default = true end when "7.1" load_defaults "7.0" self.add_autoload_paths_to_load_path = false self.precompile_filter_parameters = true self.dom_testing_default_html_version = defined?(Nokogiri::HTML5) ? :html5 : :html4 if Rails.env.local? self.log_file_size = 100 * 1024 * 1024 end if respond_to?(:active_record) active_record.run_commit_callbacks_on_first_saved_instances_in_transaction = false active_record.sqlite3_adapter_strict_strings_by_default = true active_record. = :sqlcommenter active_record.raise_on_assign_to_attr_readonly = true active_record.belongs_to_required_validates_foreign_key = false active_record.before_committed_on_all_records = true active_record.default_column_serializer = nil active_record.encryption.hash_digest_class = OpenSSL::Digest::SHA256 active_record.encryption.support_sha1_for_non_deterministic_encryption = false active_record.marshalling_format_version = 7.1 active_record.run_after_transaction_callbacks_in_order_defined = true active_record.generate_secure_token_on = :initialize end if respond_to?(:action_dispatch) action_dispatch.default_headers = { "X-Frame-Options" => "SAMEORIGIN", "X-XSS-Protection" => "0", "X-Content-Type-Options" => "nosniff", "X-Permitted-Cross-Domain-Policies" => "none", "Referrer-Policy" => "strict-origin-when-cross-origin" } action_dispatch.debug_exception_log_level = :error end if respond_to?(:active_support) active_support.cache_format_version = 7.1 active_support. = :json_allow_marshal active_support. = true active_support.raise_on_invalid_cache_expiration_time = true end if respond_to?(:action_view) require "action_view/helpers" action_view.sanitizer_vendor = Rails::HTML::Sanitizer.best_supported_vendor end if respond_to?(:action_text) require "action_view/helpers" action_text.sanitizer_vendor = Rails::HTML::Sanitizer.best_supported_vendor end when "7.2" load_defaults "7.1" self.yjit = true if respond_to?(:active_storage) active_storage.web_image_content_types = %w( image/png image/jpeg image/gif image/webp ) end if respond_to?(:active_record) active_record.postgresql_adapter_decode_dates = true active_record. = true end when "8.0" load_defaults "7.2" if respond_to?(:active_support) active_support.to_time_preserves_timezone = :zone end if respond_to?(:action_dispatch) action_dispatch.strict_freshness = true end Regexp.timeout ||= 1 else raise "Unknown version #{target_version.to_s.inspect}" end @loaded_config_version = target_version end |
#paths ⇒ Object
396 397 398 399 400 401 402 403 404 405 406 407 408 409 |
# File 'lib/rails/application/configuration.rb', line 396 def paths @paths ||= begin paths = super paths.add "config/database", with: "config/database.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 |
#permissions_policy(&block) ⇒ Object
Configures the ActionDispatch::PermissionsPolicy.
575 576 577 578 579 580 581 |
# File 'lib/rails/application/configuration.rb', line 575 def (&block) if block_given? @permissions_policy = ActionDispatch::PermissionsPolicy.new(&block) else @permissions_policy end end |
#reloading_enabled? ⇒ Boolean
356 357 358 |
# File 'lib/rails/application/configuration.rb', line 356 def reloading_enabled? enable_reloading end |
#secret_key_base ⇒ Object
504 505 506 507 508 509 510 511 512 |
# File 'lib/rails/application/configuration.rb', line 504 def secret_key_base @secret_key_base || begin self.secret_key_base = if generate_local_secret? generate_local_secret else ENV["SECRET_KEY_BASE"] || Rails.application.credentials.secret_key_base end end end |
#secret_key_base=(new_secret_key_base) ⇒ Object
514 515 516 517 518 519 520 521 522 523 524 |
# File 'lib/rails/application/configuration.rb', line 514 def secret_key_base=(new_secret_key_base) if new_secret_key_base.nil? && generate_local_secret? @secret_key_base = generate_local_secret elsif new_secret_key_base.is_a?(String) && new_secret_key_base.present? @secret_key_base = new_secret_key_base elsif new_secret_key_base raise ArgumentError, "`secret_key_base` for #{Rails.env} environment must be a type of String`" else raise ArgumentError, "Missing `secret_key_base` for '#{Rails.env}' environment, set this string with `bin/rails credentials:edit`" end end |
#session_store(new_session_store = nil, **options) ⇒ Object
Specifies what class to use to store the session. Possible values are :cache_store
, :cookie_store
, :mem_cache_store
, a custom store, or :disabled
. :disabled
tells Rails not to deal with sessions.
Additional options will be set as session_options
:
config.session_store :cookie_store, key: "_your_app_session"
config. # => {key: "_your_app_session"}
If a custom store is specified as a symbol, it will be resolved to the ActionDispatch::Session
namespace:
# use ActionDispatch::Session::MyCustomStore as the session store
config.session_store :my_custom_store
541 542 543 544 545 546 547 548 549 550 551 552 553 554 555 |
# File 'lib/rails/application/configuration.rb', line 541 def session_store(new_session_store = nil, **) if new_session_store @session_store = new_session_store @session_options = || {} else case @session_store when :disabled nil when Symbol ActionDispatch::Session.resolve_store(@session_store) else @session_store end end end |
#session_store? ⇒ Boolean
:nodoc:
557 558 559 |
# File 'lib/rails/application/configuration.rb', line 557 def session_store? # :nodoc: @session_store end |