class Rails::Application::Configuration
Attributes
add_autoload_paths_to_load_path[RW]
allow_concurrency[RW]
api_only[R]
asset_host[RW]
autoflush_log[RW]
autoloader[R]
beginning_of_week[RW]
cache_classes[RW]
cache_store[RW]
consider_all_requests_local[RW]
console[RW]
content_security_policy_nonce_directives[RW]
content_security_policy_nonce_generator[RW]
content_security_policy_report_only[RW]
credentials[RW]
debug_exception_response_format[W]
disable_sandbox[RW]
eager_load[RW]
enable_dependency_loading[RW]
encoding[R]
exceptions_app[RW]
file_watcher[RW]
filter_parameters[RW]
filter_redirect[RW]
force_ssl[RW]
helpers_paths[RW]
host_authorization[RW]
hosts[RW]
loaded_config_version[R]
log_formatter[RW]
log_level[RW]
log_tags[RW]
logger[RW]
public_file_server[RW]
railties_order[RW]
rake_eager_load[RW]
read_encrypted_secrets[RW]
relative_url_root[RW]
reload_classes_only_on_change[RW]
require_master_key[RW]
secret_key_base[RW]
session_options[RW]
ssl_options[RW]
time_zone[RW]
x[RW]
Public Class Methods
# File railties/lib/rails/application/configuration.rb, line 29 def initialize(*) super self.encoding = Encoding::UTF_8 @allow_concurrency = nil @consider_all_requests_local = false @filter_parameters = [] @filter_redirect = [] @helpers_paths = [] @hosts = Array(([".localhost", IPAddr.new("0.0.0.0/0"), IPAddr.new("::/0")] if Rails.env.development?)) @host_authorization = {} @public_file_server = ActiveSupport::OrderedOptions.new @public_file_server.enabled = true @public_file_server.index_name = "index" @force_ssl = false @ssl_options = {} @session_store = nil @time_zone = "UTC" @beginning_of_week = :monday @log_level = :debug @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_key_base = nil @api_only = false @debug_exception_response_format = nil @x = Custom.new @enable_dependency_loading = false @read_encrypted_secrets = false @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::OrderedOptions.new @credentials.content_path = default_credentials_content_path @credentials.key_path = default_credentials_key_path @autoloader = :classic @disable_sandbox = false @add_autoload_paths_to_load_path = true @permissions_policy = nil @rake_eager_load = false end
Calls superclass method
Rails::Engine::Configuration::new
Public Instance Methods
# File railties/lib/rails/application/configuration.rb, line 335 def annotations Rails::SourceAnnotationExtractor::Annotation end
# File railties/lib/rails/application/configuration.rb, line 219 def api_only=(value) @api_only = value generators.api_only = value @debug_exception_response_format ||= :api end
# File railties/lib/rails/application/configuration.rb, line 355 def autoloader=(autoloader) case autoloader when :classic @autoloader = autoloader when :zeitwerk require "zeitwerk" @autoloader = autoloader else raise ArgumentError, "config.autoloader may be :classic or :zeitwerk, got #{autoloader.inspect} instead" end end
# File railties/lib/rails/application/configuration.rb, line 295 def colorize_logging ActiveSupport::LogSubscriber.colorize_logging end
# File railties/lib/rails/application/configuration.rb, line 299 def colorize_logging=(val) ActiveSupport::LogSubscriber.colorize_logging = val generators.colorize_logging = val end
# File railties/lib/rails/application/configuration.rb, line 339 def content_security_policy(&block) if block_given? @content_security_policy = ActionDispatch::ContentSecurityPolicy.new(&block) else @content_security_policy end end
# File railties/lib/rails/application/configuration.rb, line 270 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 |_k, values| values.reverse_merge!(shared) 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.message}", e.backtrace end
Loads and returns the entire raw configuration of database from values stored in config/database.yml
.
# File railties/lib/rails/application/configuration.rb, line 226 def debug_exception_response_format @debug_exception_response_format || :default end
# File railties/lib/rails/application/configuration.rb, line 367 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
# File railties/lib/rails/application/configuration.rb, line 211 def encoding=(value) @encoding = value silence_warnings do Encoding.default_external = value Encoding.default_internal = value end end
# File railties/lib/rails/application/configuration.rb, line 81 def load_defaults(target_version) 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 ActiveSupport.to_time_preserves_timezone = true if respond_to?(:active_record) active_record.belongs_to_required_by_default = true end self.ssl_options = { 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.use_authenticated_cookie_encryption = true end if respond_to?(:active_support) active_support.use_authenticated_message_encryption = true active_support.hash_digest_class = ::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" self.autoloader = :zeitwerk if RUBY_ENGINE == "ruby" if respond_to?(:action_view) action_view.default_enforce_utf8 = false end if respond_to?(:action_dispatch) action_dispatch.use_cookies_with_metadata = 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 active_storage.replace_on_assign_to_many = true end if respond_to?(:active_record) active_record.collection_cache_versioning = true end when "6.1" load_defaults "6.0" self.autoloader = :zeitwerk if %w[ruby truffleruby].include?(RUBY_ENGINE) if respond_to?(:active_record) active_record.has_many_inversing = true active_record.legacy_connection_handling = false end if respond_to?(:active_storage) active_storage.track_variants = true end if respond_to?(:active_job) active_job.retry_jitter = 0.15 active_job.skip_after_callbacks_if_terminated = true end if respond_to?(:action_dispatch) action_dispatch.cookies_same_site_protection = :lax action_dispatch.ssl_default_redirect_status = 308 end if respond_to?(:action_controller) action_controller.urlsafe_csrf_tokens = true 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.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 else raise "Unknown version #{target_version.to_s.inspect}" end @loaded_config_version = target_version end
Loads default configurations. See the result of the method for each version.
# File railties/lib/rails/application/configuration.rb, line 232 def paths @paths ||= begin paths = super paths.add "config/database", with: "config/database.yml" paths.add "config/secrets", with: "config", glob: "secrets.yml{,.enc}" 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
Calls superclass method
Rails::Engine::Configuration#paths
# File railties/lib/rails/application/configuration.rb, line 347 def permissions_policy(&block) if block_given? @permissions_policy = ActionDispatch::PermissionsPolicy.new(&block) else @permissions_policy end end
# File railties/lib/rails/application/configuration.rb, line 304 def session_store(new_session_store = nil, **options) if new_session_store if new_session_store == :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 end @session_store = new_session_store @session_options = options || {} else case @session_store when :disabled nil when :active_record_store ActionDispatch::Session::ActiveRecordStore when Symbol ActionDispatch::Session.const_get(@session_store.to_s.camelize) else @session_store end end end
© 2004–2020 David Heinemeier Hansson
Licensed under the MIT License.