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.



21
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
 
# File '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

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.



9
10
11
 
# File 'lib/rails/application/configuration.rb', line 9

def allow_concurrency
  @allow_concurrency
end

#api_only ⇒ Object

Returns the value of attribute api_only.



19
20
21
 
# File 'lib/rails/application/configuration.rb', line 19

def api_only
  @api_only
end

#asset_host ⇒ Object

Returns the value of attribute asset_host.



9
10
11
 
# File 'lib/rails/application/configuration.rb', line 9

def asset_host
  @asset_host
end

#autoflush_log ⇒ Object

Returns the value of attribute autoflush_log.



9
10
11
 
# File 'lib/rails/application/configuration.rb', line 9

def autoflush_log
  @autoflush_log
end

#beginning_of_week ⇒ Object

Returns the value of attribute beginning_of_week.



9
10
11
 
# File 'lib/rails/application/configuration.rb', line 9

def beginning_of_week
  @beginning_of_week
end

#cache_classes ⇒ Object

Returns the value of attribute cache_classes.



9
10
11
 
# File 'lib/rails/application/configuration.rb', line 9

def cache_classes
  @cache_classes
end

#cache_store ⇒ Object

Returns the value of attribute cache_store.



9
10
11
 
# File 'lib/rails/application/configuration.rb', line 9

def cache_store
  @cache_store
end

#consider_all_requests_local ⇒ Object

Returns the value of attribute consider_all_requests_local.



9
10
11
 
# File 'lib/rails/application/configuration.rb', line 9

def consider_all_requests_local
  @consider_all_requests_local
end

#console ⇒ Object

Returns the value of attribute console.



9
10
11
 
# File 'lib/rails/application/configuration.rb', line 9

def console
  @console
end

#eager_load ⇒ Object

Returns the value of attribute eager_load.



9
10
11
 
# File 'lib/rails/application/configuration.rb', line 9

def eager_load
  @eager_load
end

#enable_dependency_loading ⇒ Object

Returns the value of attribute enable_dependency_loading.



9
10
11
 
# File 'lib/rails/application/configuration.rb', line 9

def enable_dependency_loading
  @enable_dependency_loading
end

#encoding ⇒ Object

Returns the value of attribute encoding.



19
20
21
 
# File 'lib/rails/application/configuration.rb', line 19

def encoding
  @encoding
end

#exceptions_app ⇒ Object

Returns the value of attribute exceptions_app.



9
10
11
 
# File 'lib/rails/application/configuration.rb', line 9

def exceptions_app
  @exceptions_app
end

#file_watcher ⇒ Object

Returns the value of attribute file_watcher.



9
10
11
 
# File 'lib/rails/application/configuration.rb', line 9

def file_watcher
  @file_watcher
end

#filter_parameters ⇒ Object

Returns the value of attribute filter_parameters.



9
10
11
 
# File 'lib/rails/application/configuration.rb', line 9

def filter_parameters
  @filter_parameters
end

#filter_redirect ⇒ Object

Returns the value of attribute filter_redirect.



9
10
11
 
# File 'lib/rails/application/configuration.rb', line 9

def filter_redirect
  @filter_redirect
end

#force_ssl ⇒ Object

Returns the value of attribute force_ssl.



9
10
11
 
# File 'lib/rails/application/configuration.rb', line 9

def force_ssl
  @force_ssl
end

#helpers_paths ⇒ Object

Returns the value of attribute helpers_paths.



9
10
11
 
# File 'lib/rails/application/configuration.rb', line 9

def helpers_paths
  @helpers_paths
end

#log_formatter ⇒ Object

Returns the value of attribute log_formatter.



9
10
11
 
# File 'lib/rails/application/configuration.rb', line 9

def log_formatter
  @log_formatter
end

#log_level ⇒ Object

Returns the value of attribute log_level.



9
10
11
 
# File 'lib/rails/application/configuration.rb', line 9

def log_level
  @log_level
end

#log_tags ⇒ Object

Returns the value of attribute log_tags.



9
10
11
 
# File 'lib/rails/application/configuration.rb', line 9

def log_tags
  @log_tags
end

#logger ⇒ Object

Returns the value of attribute logger.



9
10
11
 
# File 'lib/rails/application/configuration.rb', line 9

def logger
  @logger
end

#public_file_server ⇒ Object

Returns the value of attribute public_file_server.



9
10
11
 
# File 'lib/rails/application/configuration.rb', line 9

def public_file_server
  @public_file_server
end

#railties_order ⇒ Object

Returns the value of attribute railties_order.



9
10
11
 
# File 'lib/rails/application/configuration.rb', line 9

def railties_order
  @railties_order
end

#read_encrypted_secrets ⇒ Object

Returns the value of attribute read_encrypted_secrets.



9
10
11
 
# File 'lib/rails/application/configuration.rb', line 9

def read_encrypted_secrets
  @read_encrypted_secrets
end

#relative_url_root ⇒ Object

Returns the value of attribute relative_url_root.



9
10
11
 
# File 'lib/rails/application/configuration.rb', line 9

def relative_url_root
  @relative_url_root
end

#reload_classes_only_on_change ⇒ Object

Returns the value of attribute reload_classes_only_on_change.



9
10
11
 
# File 'lib/rails/application/configuration.rb', line 9

def reload_classes_only_on_change
  @reload_classes_only_on_change
end

#secret_key_base ⇒ Object

Returns the value of attribute secret_key_base.



9
10
11
 
# File 'lib/rails/application/configuration.rb', line 9

def secret_key_base
  @secret_key_base
end

#secret_token ⇒ Object

Returns the value of attribute secret_token.



9
10
11
 
# File 'lib/rails/application/configuration.rb', line 9

def secret_token
  @secret_token
end

#session_options ⇒ Object

Returns the value of attribute session_options.



9
10
11
 
# File 'lib/rails/application/configuration.rb', line 9

def session_options
  @session_options
end

#ssl_options ⇒ Object

Returns the value of attribute ssl_options.



9
10
11
 
# File 'lib/rails/application/configuration.rb', line 9

def ssl_options
  @ssl_options
end

#time_zone ⇒ Object

Returns the value of attribute time_zone.



9
10
11
 
# File 'lib/rails/application/configuration.rb', line 9

def time_zone
  @time_zone
end

#x ⇒ Object

Returns the value of attribute x.



9
10
11
 
# File 'lib/rails/application/configuration.rb', line 9

def x
  @x
end

Instance Method Details

#annotations ⇒ Object 



191
192
193
 
# File 'lib/rails/application/configuration.rb', line 191

def annotations
  SourceAnnotationExtractor::Annotation
end

#colorize_logging ⇒ Object 



151
152
153
 
# File 'lib/rails/application/configuration.rb', line 151

def colorize_logging
  ActiveSupport::LogSubscriber.colorize_logging
end

#colorize_logging=(val) ⇒ Object 



155
156
157
158
 
# File 'lib/rails/application/configuration.rb', line 155

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

#database_configuration ⇒ Object

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



126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
 
# File '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 ⇒ Object 



100
101
102
 
# File 'lib/rails/application/configuration.rb', line 100

def debug_exception_response_format
  @debug_exception_response_format || :default
end

#debug_exception_response_format=(value) ⇒ Object 



104
105
106
 
# File 'lib/rails/application/configuration.rb', line 104

def debug_exception_response_format=(value)
  @debug_exception_response_format = value
end

#load_defaults(target_version) ⇒ Object 



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
 
# File '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 ⇒ Object 



108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
 
# File '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) ⇒ Object 



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
 
# File '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

#session_store? ⇒ Boolean

:nodoc:

Returns:

  • (Boolean) 


187
188
189
 
# File 'lib/rails/application/configuration.rb', line 187

def session_store? #:nodoc:
  @session_store
end