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
-
#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.
-
#autoflush_log ⇒ Object
Returns the value of attribute autoflush_log.
-
#beginning_of_week ⇒ Object
Returns the value of attribute beginning_of_week.
-
#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.
-
#eager_load ⇒ Object
Returns the value of attribute eager_load.
-
#enable_dependency_loading ⇒ Object
Returns the value of attribute enable_dependency_loading.
-
#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.
-
#log_formatter ⇒ Object
Returns the value of attribute log_formatter.
- #log_level ⇒ Object
-
#log_tags ⇒ Object
Returns the value of attribute log_tags.
-
#logger ⇒ Object
Returns the value of attribute logger.
-
#public_file_server ⇒ Object
Returns the value of attribute public_file_server.
-
#railties_order ⇒ Object
Returns the value of attribute railties_order.
-
#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.
-
#secret_key_base ⇒ Object
Returns the value of attribute secret_key_base.
-
#secret_token ⇒ Object
Returns the value of attribute secret_token.
-
#session_options ⇒ Object
Returns the value of attribute session_options.
-
#ssl_options ⇒ Object
Returns the value of attribute ssl_options.
-
#static_cache_control ⇒ Object
Returns the value of attribute static_cache_control.
-
#time_zone ⇒ Object
Returns the value of attribute time_zone.
-
#x ⇒ Object
Returns the value of attribute x.
Attributes inherited from Engine::Configuration
#autoload_once_paths, #autoload_paths, #eager_load_paths, #middleware, #root
Instance Method Summary collapse
- #annotations ⇒ Object
- #colorize_logging ⇒ Object
- #colorize_logging=(val) ⇒ Object
-
#database_configuration ⇒ Object
Loads and returns the entire raw configuration of database from values stored in ‘config/database.yml`.
- #debug_exception_response_format ⇒ Object
- #debug_exception_response_format=(value) ⇒ Object
-
#initialize ⇒ Configuration
constructor
A new instance of Configuration.
- #paths ⇒ Object
- #serve_static_files ⇒ Object
- #serve_static_files=(value) ⇒ Object
- #session_store(*args) ⇒ Object
Methods inherited from Engine::Configuration
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 |
# File 'lib/rails/application/configuration.rb', line 24 def initialize(*) super self.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 = :cookie_store @session_options = {} @time_zone = "UTC" @beginning_of_week = :monday @log_level = 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 @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 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.
12 13 14 |
# File 'lib/rails/application/configuration.rb', line 12 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.
12 13 14 |
# File 'lib/rails/application/configuration.rb', line 12 def asset_host @asset_host end |
#autoflush_log ⇒ Object
Returns the value of attribute autoflush_log.
12 13 14 |
# File 'lib/rails/application/configuration.rb', line 12 def autoflush_log @autoflush_log end |
#beginning_of_week ⇒ Object
Returns the value of attribute beginning_of_week.
12 13 14 |
# File 'lib/rails/application/configuration.rb', line 12 def beginning_of_week @beginning_of_week end |
#cache_classes ⇒ Object
Returns the value of attribute cache_classes.
12 13 14 |
# File 'lib/rails/application/configuration.rb', line 12 def cache_classes @cache_classes end |
#cache_store ⇒ Object
Returns the value of attribute cache_store.
12 13 14 |
# File 'lib/rails/application/configuration.rb', line 12 def cache_store @cache_store end |
#consider_all_requests_local ⇒ Object
Returns the value of attribute consider_all_requests_local.
12 13 14 |
# File 'lib/rails/application/configuration.rb', line 12 def consider_all_requests_local @consider_all_requests_local end |
#console ⇒ Object
Returns the value of attribute console.
12 13 14 |
# File 'lib/rails/application/configuration.rb', line 12 def console @console end |
#eager_load ⇒ Object
Returns the value of attribute eager_load.
12 13 14 |
# File 'lib/rails/application/configuration.rb', line 12 def eager_load @eager_load end |
#enable_dependency_loading ⇒ Object
Returns the value of attribute enable_dependency_loading.
12 13 14 |
# File 'lib/rails/application/configuration.rb', line 12 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.
12 13 14 |
# File 'lib/rails/application/configuration.rb', line 12 def exceptions_app @exceptions_app end |
#file_watcher ⇒ Object
Returns the value of attribute file_watcher.
12 13 14 |
# File 'lib/rails/application/configuration.rb', line 12 def file_watcher @file_watcher end |
#filter_parameters ⇒ Object
Returns the value of attribute filter_parameters.
12 13 14 |
# File 'lib/rails/application/configuration.rb', line 12 def filter_parameters @filter_parameters end |
#filter_redirect ⇒ Object
Returns the value of attribute filter_redirect.
12 13 14 |
# File 'lib/rails/application/configuration.rb', line 12 def filter_redirect @filter_redirect end |
#force_ssl ⇒ Object
Returns the value of attribute force_ssl.
12 13 14 |
# File 'lib/rails/application/configuration.rb', line 12 def force_ssl @force_ssl end |
#helpers_paths ⇒ Object
Returns the value of attribute helpers_paths.
12 13 14 |
# File 'lib/rails/application/configuration.rb', line 12 def helpers_paths @helpers_paths end |
#log_formatter ⇒ Object
Returns the value of attribute log_formatter.
12 13 14 |
# File 'lib/rails/application/configuration.rb', line 12 def log_formatter @log_formatter end |
#log_level ⇒ Object
155 156 157 |
# File 'lib/rails/application/configuration.rb', line 155 def log_level @log_level ||= (Rails.env.production? ? :info : :debug) end |
#log_tags ⇒ Object
Returns the value of attribute log_tags.
12 13 14 |
# File 'lib/rails/application/configuration.rb', line 12 def @log_tags end |
#logger ⇒ Object
Returns the value of attribute logger.
12 13 14 |
# File 'lib/rails/application/configuration.rb', line 12 def logger @logger end |
#public_file_server ⇒ Object
Returns the value of attribute public_file_server.
12 13 14 |
# File 'lib/rails/application/configuration.rb', line 12 def public_file_server @public_file_server end |
#railties_order ⇒ Object
Returns the value of attribute railties_order.
12 13 14 |
# File 'lib/rails/application/configuration.rb', line 12 def railties_order @railties_order end |
#relative_url_root ⇒ Object
Returns the value of attribute relative_url_root.
12 13 14 |
# File 'lib/rails/application/configuration.rb', line 12 def relative_url_root @relative_url_root end |
#reload_classes_only_on_change ⇒ Object
Returns the value of attribute reload_classes_only_on_change.
12 13 14 |
# File 'lib/rails/application/configuration.rb', line 12 def reload_classes_only_on_change @reload_classes_only_on_change end |
#secret_key_base ⇒ Object
Returns the value of attribute secret_key_base.
12 13 14 |
# File 'lib/rails/application/configuration.rb', line 12 def secret_key_base @secret_key_base end |
#secret_token ⇒ Object
Returns the value of attribute secret_token.
12 13 14 |
# File 'lib/rails/application/configuration.rb', line 12 def secret_token @secret_token end |
#session_options ⇒ Object
Returns the value of attribute session_options.
12 13 14 |
# File 'lib/rails/application/configuration.rb', line 12 def @session_options end |
#ssl_options ⇒ Object
Returns the value of attribute ssl_options.
12 13 14 |
# File 'lib/rails/application/configuration.rb', line 12 def @ssl_options end |
#static_cache_control ⇒ Object
Returns the value of attribute static_cache_control.
22 23 24 |
# File 'lib/rails/application/configuration.rb', line 22 def static_cache_control @static_cache_control end |
#time_zone ⇒ Object
Returns the value of attribute time_zone.
12 13 14 |
# File 'lib/rails/application/configuration.rb', line 12 def time_zone @time_zone end |
#x ⇒ Object
Returns the value of attribute x.
12 13 14 |
# File 'lib/rails/application/configuration.rb', line 12 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
159 160 161 |
# File 'lib/rails/application/configuration.rb', line 159 def colorize_logging ActiveSupport::LogSubscriber.colorize_logging end |
#colorize_logging=(val) ⇒ Object
163 164 165 166 |
# File 'lib/rails/application/configuration.rb', line 163 def colorize_logging=(val) ActiveSupport::LogSubscriber.colorize_logging = val self.generators.colorize_logging = val end |
#database_configuration ⇒ Object
Loads and returns the entire raw configuration of database from values stored in ‘config/database.yml`.
130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 |
# File 'lib/rails/application/configuration.rb', line 130 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.}" rescue => e raise e, "Cannot load `Rails.application.database_configuration`:\n#{e.}", e.backtrace end |
#debug_exception_response_format ⇒ Object
104 105 106 |
# File 'lib/rails/application/configuration.rb', line 104 def debug_exception_response_format @debug_exception_response_format || :default end |
#debug_exception_response_format=(value) ⇒ Object
108 109 110 |
# File 'lib/rails/application/configuration.rb', line 108 def debug_exception_response_format=(value) @debug_exception_response_format = value end |
#paths ⇒ Object
112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 |
# File 'lib/rails/application/configuration.rb', line 112 def paths @paths ||= begin paths = super paths.add "config/database", with: "config/database.yml" paths.add "config/secrets", with: "config/secrets.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 |
#serve_static_files ⇒ Object
71 72 73 74 75 76 77 78 |
# File 'lib/rails/application/configuration.rb', line 71 def serve_static_files ActiveSupport::Deprecation.warn <<-eow.strip_heredoc `config.serve_static_files` is deprecated and will be removed in Rails 5.1. Please use `config.public_file_server.enabled` instead. eow @public_file_server.enabled end |
#serve_static_files=(value) ⇒ Object
80 81 82 83 84 85 86 87 |
# File 'lib/rails/application/configuration.rb', line 80 def serve_static_files=(value) ActiveSupport::Deprecation.warn <<-eow.strip_heredoc `config.serve_static_files` is deprecated and will be removed in Rails 5.1. Please use `config.public_file_server.enabled = #{value}` instead. eow @public_file_server.enabled = value end |
#session_store(*args) ⇒ Object
168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 |
# File 'lib/rails/application/configuration.rb', line 168 def session_store(*args) if args.empty? case @session_store when :disabled nil when :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 when Symbol ActionDispatch::Session.const_get(@session_store.to_s.camelize) else @session_store end else @session_store = args.shift @session_options = args.shift || {} end end |