Class: Rails::Application::Configuration

Inherits:
Engine::Configuration show all
Defined in:
lib/rails/application/configuration.rb

Defined Under Namespace

Classes: Custom

Instance Attribute Summary collapse

Attributes inherited from Engine::Configuration

#autoload_once_paths, #autoload_paths, #eager_load_paths, #middleware, #root

Instance Method Summary collapse

Methods inherited from Engine::Configuration

#generators

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.



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
 
# File 'lib/rails/application/configuration.rb', line 24

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
  @content_security_policy                 = nil
  @content_security_policy_report_only     = false
  @content_security_policy_nonce_generator = nil
  @require_master_key                      = false
  @loaded_config_version                   = 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

#api_only ⇒ Object

Returns the value of attribute api_only.



22
23
24
 
# File 'lib/rails/application/configuration.rb', line 22

def api_only
  @api_only
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

#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

#content_security_policy_nonce_generator ⇒ Object

Returns the value of attribute content_security_policy_nonce_generator.



11
12
13
 
# File 'lib/rails/application/configuration.rb', line 11

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.



11
12
13
 
# File 'lib/rails/application/configuration.rb', line 11

def content_security_policy_report_only
  @content_security_policy_report_only
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

#enable_dependency_loading ⇒ Object

Returns the value of attribute enable_dependency_loading.



11
12
13
 
# File 'lib/rails/application/configuration.rb', line 11

def enable_dependency_loading
  @enable_dependency_loading
end

#encoding ⇒ Object

Returns the value of attribute encoding.



22
23
24
 
# File 'lib/rails/application/configuration.rb', line 22

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

#loaded_config_version ⇒ Object (readonly)

Returns the value of attribute loaded_config_version.



22
23
24
 
# File 'lib/rails/application/configuration.rb', line 22

def loaded_config_version
  @loaded_config_version
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_level ⇒ Object

Returns the value of attribute log_level.



11
12
13
 
# File 'lib/rails/application/configuration.rb', line 11

def log_level
  @log_level
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
  @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

#public_file_server ⇒ Object

Returns the value of attribute public_file_server.



11
12
13
 
# File 'lib/rails/application/configuration.rb', line 11

def public_file_server
  @public_file_server
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

#read_encrypted_secrets ⇒ Object

Returns the value of attribute read_encrypted_secrets.



11
12
13
 
# File 'lib/rails/application/configuration.rb', line 11

def read_encrypted_secrets
  @read_encrypted_secrets
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

#require_master_key ⇒ Object

Returns the value of attribute require_master_key.



11
12
13
 
# File 'lib/rails/application/configuration.rb', line 11

def require_master_key
  @require_master_key
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

#session_options ⇒ Object

Returns the value of attribute session_options.



11
12
13
 
# File 'lib/rails/application/configuration.rb', line 11

def session_options
  @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
  @ssl_options
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 



237
238
239
 
# File 'lib/rails/application/configuration.rb', line 237

def annotations
  SourceAnnotationExtractor::Annotation
end

#colorize_logging ⇒ Object 



197
198
199
 
# File 'lib/rails/application/configuration.rb', line 197

def colorize_logging
  ActiveSupport::LogSubscriber.colorize_logging
end

#colorize_logging=(val) ⇒ Object 



201
202
203
204
 
# File 'lib/rails/application/configuration.rb', line 201

def colorize_logging=(val)
  ActiveSupport::LogSubscriber.colorize_logging = val
  generators.colorize_logging = val
end

#content_security_policy(&block) ⇒ Object 



241
242
243
244
245
246
247
 
# File 'lib/rails/application/configuration.rb', line 241

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.



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
 
# File 'lib/rails/application/configuration.rb', line 165

def database_configuration
  path = paths["config/database"].existent.first
  yaml = Pathname.new(path) if path

  config = if yaml && yaml.exist?
    require "yaml"
    require "erb"
    loaded_yaml = YAML.load(ERB.new(yaml.read).result) || {}
    shared = loaded_yaml.delete("shared")
    if 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 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 database configuration:\n#{e.message}", e.backtrace
end

#debug_exception_response_format ⇒ Object 



139
140
141
 
# File 'lib/rails/application/configuration.rb', line 139

def debug_exception_response_format
  @debug_exception_response_format || :default
end

#debug_exception_response_format=(value) ⇒ Object 



143
144
145
 
# File 'lib/rails/application/configuration.rb', line 143

def debug_exception_response_format=(value)
  @debug_exception_response_format = value
end

#load_defaults(target_version) ⇒ Object 



65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
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
 
# File 'lib/rails/application/configuration.rb', line 65

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
      # Remove the temporary load hook from SQLite3Adapter when this is removed
      ActiveSupport.on_load(:active_record_sqlite3adapter) do
        ActiveRecord::ConnectionAdapters::SQLite3Adapter.represent_boolean_as_integer = true
      end
    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.use_sha1_digests = true
    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
  else
    raise "Unknown version #{target_version.to_s.inspect}"
  end

  @loaded_config_version = target_version
end

#paths ⇒ Object 



147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
 
# File 'lib/rails/application/configuration.rb', line 147

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) ⇒ Object 



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
 
# File 'lib/rails/application/configuration.rb', line 206

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

#session_store? ⇒ Boolean

:nodoc:

Returns:

  • (Boolean) 


233
234
235
 
# File 'lib/rails/application/configuration.rb', line 233

def session_store? #:nodoc:
  @session_store
end