Class: Rails::Application::Configuration

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

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

#initializeConfiguration

Returns a new instance of Configuration.


20
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
56
57
58
59
60
61
62
63
64
65
# File 'railties/lib/rails/application/configuration.rb', line 20

def initialize(*)
  super
  self.encoding = "utf-8"
  @allow_concurrency             = nil
  @consider_all_requests_local   = false
  @filter_parameters             = []
  @filter_redirect               = []
  @helpers_paths                 = []
  @serve_static_assets           = true
  @static_cache_control          = nil
  @force_ssl                     = false
  @ssl_options                   = {}
  @session_store                 = :cookie_store
  @session_options               = {}
  @time_zone                     = "UTC"
  @beginning_of_week             = :monday
  @log_level                     = nil
  @middleware                    = app_middleware
  @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

  @assets = ActiveSupport::OrderedOptions.new
  @assets.enabled                  = true
  @assets.paths                    = []
  @assets.precompile               = [ Proc.new { |path, fn| fn =~ /app\/assets/ && !%w(.js .css).include?(File.extname(path)) },
                                       /(?:\/|\\|\A)application\.(css|js)$/ ]
  @assets.prefix                   = "/assets"
  @assets.version                  = '1.0'
  @assets.debug                    = false
  @assets.compile                  = true
  @assets.digest                   = false
  @assets.cache_store              = [ :file_store, "#{root}/tmp/cache/assets/#{Rails.env}/" ]
  @assets.js_compressor            = nil
  @assets.css_compressor           = nil
  @assets.logger                   = 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_concurrencyObject

Returns the value of attribute allow_concurrency


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

def allow_concurrency
  @allow_concurrency
end

#asset_hostObject

Returns the value of attribute asset_host


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

def asset_host
  @asset_host
end

#assetsObject

Returns the value of attribute assets


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

def assets
  @assets
end

#autoflush_logObject

Returns the value of attribute autoflush_log


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

def autoflush_log
  @autoflush_log
end

#beginning_of_weekObject

Returns the value of attribute beginning_of_week


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

def beginning_of_week
  @beginning_of_week
end

#cache_classesObject

Returns the value of attribute cache_classes


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

def cache_classes
  @cache_classes
end

#cache_storeObject

Returns the value of attribute cache_store


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

def cache_store
  @cache_store
end

#consider_all_requests_localObject

Returns the value of attribute consider_all_requests_local


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

def consider_all_requests_local
  @consider_all_requests_local
end

#consoleObject

Returns the value of attribute console


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

def console
  @console
end

#eager_loadObject

Returns the value of attribute eager_load


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

def eager_load
  @eager_load
end

#encodingObject

Returns the value of attribute encoding


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

def encoding
  @encoding
end

#exceptions_appObject

Returns the value of attribute exceptions_app


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

def exceptions_app
  @exceptions_app
end

#file_watcherObject

Returns the value of attribute file_watcher


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

def file_watcher
  @file_watcher
end

#filter_parametersObject

Returns the value of attribute filter_parameters


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

def filter_parameters
  @filter_parameters
end

#filter_redirectObject

Returns the value of attribute filter_redirect


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

def filter_redirect
  @filter_redirect
end

#force_sslObject

Returns the value of attribute force_ssl


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

def force_ssl
  @force_ssl
end

#helpers_pathsObject

Returns the value of attribute helpers_paths


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

def helpers_paths
  @helpers_paths
end

#log_formatterObject

Returns the value of attribute log_formatter


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

def log_formatter
  @log_formatter
end

#log_levelObject


117
118
119
# File 'railties/lib/rails/application/configuration.rb', line 117

def log_level
  @log_level ||= Rails.env.production? ? :info : :debug
end

#log_tagsObject

Returns the value of attribute log_tags


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

def log_tags
  @log_tags
end

#loggerObject

Returns the value of attribute logger


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

def logger
  @logger
end

#railties_orderObject

Returns the value of attribute railties_order


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

def railties_order
  @railties_order
end

#relative_url_rootObject

Returns the value of attribute relative_url_root


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

def relative_url_root
  @relative_url_root
end

#reload_classes_only_on_changeObject

Returns the value of attribute reload_classes_only_on_change


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

def reload_classes_only_on_change
  @reload_classes_only_on_change
end

#secret_key_baseObject

Returns the value of attribute secret_key_base


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

def secret_key_base
  @secret_key_base
end

#secret_tokenObject

Returns the value of attribute secret_token


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

def secret_token
  @secret_token
end

#serve_static_assetsObject

Returns the value of attribute serve_static_assets


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

def serve_static_assets
  @serve_static_assets
end

#session_optionsObject

Returns the value of attribute session_options


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

def session_options
  @session_options
end

#ssl_optionsObject

Returns the value of attribute ssl_options


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

def ssl_options
  @ssl_options
end

#static_cache_controlObject

Returns the value of attribute static_cache_control


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

def static_cache_control
  @static_cache_control
end

#time_zoneObject

Returns the value of attribute time_zone


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

def time_zone
  @time_zone
end

Instance Method Details

#colorize_loggingObject


121
122
123
# File 'railties/lib/rails/application/configuration.rb', line 121

def colorize_logging
  ActiveSupport::LogSubscriber.colorize_logging
end

#colorize_logging=(val) ⇒ Object


125
126
127
128
# File 'railties/lib/rails/application/configuration.rb', line 125

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

#database_configurationObject

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


93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
# File 'railties/lib/rails/application/configuration.rb', line 93

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

  config = if 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 - #{yaml}"
  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

#pathsObject


75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
# File 'railties/lib/rails/application/configuration.rb', line 75

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

#session_store(*args) ⇒ Object


130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
# File 'railties/lib/rails/application/configuration.rb', line 130

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