W3cubDocs

/Ruby on Rails 5.1

class Rails::Application::Configuration

Parent:
Rails::Engine::Configuration

Attributes

allow_concurrency[RW]
api_only[R]
asset_host[RW]
autoflush_log[RW]
beginning_of_week[RW]
cache_classes[RW]
cache_store[RW]
consider_all_requests_local[RW]
console[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]
log_formatter[RW]
log_level[RW]
log_tags[RW]
logger[RW]
public_file_server[RW]
railties_order[RW]
read_encrypted_secrets[RW]
relative_url_root[RW]
reload_classes_only_on_change[RW]
secret_key_base[RW]
secret_token[RW]
session_options[RW]
ssl_options[RW]
time_zone[RW]
x[RW]

Public Class Methods

new(*) Show source
Calls superclass method Rails::Engine::Configuration.new
# File railties/lib/rails/application/configuration.rb, line 21
def initialize(*)
  super
  self.encoding                    = Encoding::UTF_8
  @allow_concurrency               = nil
  @consider_all_requests_local     = false
  @filter_parameters               = []
  @filter_redirect                 = []
  @helpers_paths                   = []
  @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_token                    = nil
  @secret_key_base                 = nil
  @api_only                        = false
  @debug_exception_response_format = nil
  @x                               = Custom.new
  @enable_dependency_loading       = false
  @read_encrypted_secrets          = false
end

Public Instance Methods

annotations() Show source
# File railties/lib/rails/application/configuration.rb, line 191
def annotations
  SourceAnnotationExtractor::Annotation
end
api_only=(value) Show source
# File railties/lib/rails/application/configuration.rb, line 93
def api_only=(value)
  @api_only = value
  generators.api_only = value

  @debug_exception_response_format ||= :api
end
colorize_logging() Show source
# File railties/lib/rails/application/configuration.rb, line 151
def colorize_logging
  ActiveSupport::LogSubscriber.colorize_logging
end
colorize_logging=(val) Show source
# File railties/lib/rails/application/configuration.rb, line 155
def colorize_logging=(val)
  ActiveSupport::LogSubscriber.colorize_logging = val
  generators.colorize_logging = val
end
database_configuration() Show source

Loads and returns the entire raw configuration of database from values stored in `config/database.yml`.

# File railties/lib/rails/application/configuration.rb, line 126
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.message}"
rescue => e
  raise e, "Cannot load `Rails.application.database_configuration`:\n#{e.message}", e.backtrace
end
debug_exception_response_format() Show source
# File railties/lib/rails/application/configuration.rb, line 100
def debug_exception_response_format
  @debug_exception_response_format || :default
end
debug_exception_response_format=(value) Show source
# File railties/lib/rails/application/configuration.rb, line 104
def debug_exception_response_format=(value)
  @debug_exception_response_format = value
end
encoding=(value) Show source
# File railties/lib/rails/application/configuration.rb, line 85
def encoding=(value)
  @encoding = value
  silence_warnings do
    Encoding.default_external = value
    Encoding.default_internal = value
  end
end
load_defaults(target_version) Show source
# File railties/lib/rails/application/configuration.rb, line 57
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

  else
    raise "Unknown version #{target_version.to_s.inspect}"
  end
end
paths() Show source
Calls superclass method Rails::Engine::Configuration#paths
# File railties/lib/rails/application/configuration.rb, line 108
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
session_store(new_session_store = nil, **options) Show source
# File railties/lib/rails/application/configuration.rb, line 160
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–2017 David Heinemeier Hansson
Licensed under the MIT License.