Class: Puma::Configuration

Inherits:
Object
  • Object
show all
Includes:
ConfigDefault
Defined in:
lib/puma/configuration.rb

Overview

The main configuration class of Puma.

It can be initialized with a set of “user” options and “default” options. Defaults will be merged with `Configuration.puma_default_options`.

This class works together with 2 main other classes the `UserFileDefaultOptions` which stores configuration options in order so the precedence is that user set configuration wins over “file” based configuration wins over “default” configuration. These configurations are set via the `DSL` class. This class powers the Puma config file syntax and does double duty as a configuration DSL used by the `Puma::CLI` and Puma rack handler.

It also handles loading plugins.

> Note: `:port` and `:host` are not valid keys. By they time they make it to the

configuration options they are expected to be incorporated into a `:binds` key.
Under the hood the DSL maps `port` and `host` calls to `:binds`

config = Configuration.new({}) do |user_config, file_config, default_config|
  user_config.port 3003
end
config.load
puts config.options[:port]
# => 3003

It is expected that `load` is called on the configuration instance after setting config. This method expands any values in `config_file` and puts them into the correct configuration option hash.

Once all configuration is complete it is expected that `clamp` will be called on the instance. This will expand any procs stored under “default” values. This is done because an environment variable may have been modified while loading configuration files.

Defined Under Namespace

Classes: ConfigMiddleware

Constant Summary

Constants included from ConfigDefault

Puma::ConfigDefault::DefaultRackup, Puma::ConfigDefault::DefaultTCPHost, Puma::ConfigDefault::DefaultTCPPort, Puma::ConfigDefault::DefaultWorkerShutdownTimeout, Puma::ConfigDefault::DefaultWorkerTimeout

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(user_options = {}, default_options = {}, &block) ⇒ Configuration

Returns a new instance of Configuration.


131
132
133
134
135
136
137
138
139
140
141
142
143
# File 'lib/puma/configuration.rb', line 131

def initialize(user_options={}, default_options = {}, &block)
  default_options = self.puma_default_options.merge(default_options)

  @options     = UserFileDefaultOptions.new(user_options, default_options)
  @plugins     = PluginLoader.new
  @user_dsl    = DSL.new(@options.user_options, self)
  @file_dsl    = DSL.new(@options.file_options, self)
  @default_dsl = DSL.new(@options.default_options, self)

  if block
    configure(&block)
  end
end

Instance Attribute Details

#optionsObject (readonly)

Returns the value of attribute options


145
146
147
# File 'lib/puma/configuration.rb', line 145

def options
  @options
end

#pluginsObject (readonly)

Returns the value of attribute plugins


145
146
147
# File 'lib/puma/configuration.rb', line 145

def plugins
  @plugins
end

Class Method Details

.temp_pathObject


282
283
284
285
286
287
# File 'lib/puma/configuration.rb', line 282

def self.temp_path
  require 'tmpdir'

  t = (Time.now.to_f * 1000).to_i
  "#{Dir.tmpdir}/puma-status-#{t}-#{$$}"
end

Instance Method Details

#appObject

Load the specified rackup file, pull options from the rackup file, and set @app.


245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
# File 'lib/puma/configuration.rb', line 245

def app
  found = options[:app] || load_rackup

  if @options[:mode] == :tcp
    require 'puma/tcp_logger'

    logger = @options[:logger]
    quiet = !@options[:log_requests]
    return TCPLogger.new(logger, found, quiet)
  end

  if @options[:log_requests]
    require 'puma/commonlogger'
    logger = @options[:logger]
    found = CommonLogger.new(found, logger)
  end

  ConfigMiddleware.new(self, found)
end

#app_configured?Boolean

Indicate if there is a properly configured app

Returns:

  • (Boolean)

234
235
236
# File 'lib/puma/configuration.rb', line 234

def app_configured?
  @options[:app] || File.exist?(rackup)
end

#clampObject

Call once all configuration (included from rackup files) is loaded to flesh out any defaults


215
216
217
# File 'lib/puma/configuration.rb', line 215

def clamp
  @options.finalize_values
end

#config_filesObject


200
201
202
203
204
205
206
207
208
209
210
211
# File 'lib/puma/configuration.rb', line 200

def config_files
  files = @options.all_of(:config_files)

  return [] if files == ['-']
  return files if files.any?

  first_default_file = %W(config/puma/#{environment_str}.rb config/puma.rb).find do |f|
    File.exist?(f)
  end

  [first_default_file]
end

#configureObject


147
148
149
150
151
152
153
# File 'lib/puma/configuration.rb', line 147

def configure
  yield @user_dsl, @file_dsl, @default_dsl
ensure
  @user_dsl._offer_plugins
  @file_dsl._offer_plugins
  @default_dsl._offer_plugins
end

#environmentObject

Return which environment we're running in


266
267
268
# File 'lib/puma/configuration.rb', line 266

def environment
  @options[:environment]
end

#environment_strObject


270
271
272
# File 'lib/puma/configuration.rb', line 270

def environment_str
  environment.respond_to?(:call) ? environment.call : environment
end

#flattenObject


161
162
163
# File 'lib/puma/configuration.rb', line 161

def flatten
  dup.flatten!
end

#flatten!Object


165
166
167
168
# File 'lib/puma/configuration.rb', line 165

def flatten!
  @options = @options.flatten
  self
end

#initialize_copy(other) ⇒ Object


155
156
157
158
159
# File 'lib/puma/configuration.rb', line 155

def initialize_copy(other)
  @conf        = nil
  @cli_options = nil
  @options     = @options.dup
end

#loadObject


194
195
196
197
198
# File 'lib/puma/configuration.rb', line 194

def load
  config_files.each { |config_file| @file_dsl._load_from(config_file) }

  @options
end

#load_plugin(name) ⇒ Object


274
275
276
# File 'lib/puma/configuration.rb', line 274

def load_plugin(name)
  @plugins.create name
end

#puma_default_optionsObject


170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
# File 'lib/puma/configuration.rb', line 170

def puma_default_options
  {
    :min_threads => 0,
    :max_threads => 16,
    :log_requests => false,
    :debug => false,
    :binds => ["tcp://#{DefaultTCPHost}:#{DefaultTCPPort}"],
    :workers => 0,
    :daemon => false,
    :mode => :http,
    :worker_timeout => DefaultWorkerTimeout,
    :worker_boot_timeout => DefaultWorkerTimeout,
    :worker_shutdown_timeout => DefaultWorkerShutdownTimeout,
    :remote_address => :socket,
    :tag => method(:infer_tag),
    :environment => -> { ENV['RACK_ENV'] || ENV['RAILS_ENV'] || "development" },
    :rackup => DefaultRackup,
    :logger => STDOUT,
    :persistent_timeout => Const::PERSISTENT_TIMEOUT,
    :first_data_timeout => Const::FIRST_DATA_TIMEOUT,
    :raise_exception_on_sigterm => true
  }
end

#rackupObject


238
239
240
# File 'lib/puma/configuration.rb', line 238

def rackup
  @options[:rackup]
end

#run_hooks(key, arg) ⇒ Object


278
279
280
# File 'lib/puma/configuration.rb', line 278

def run_hooks(key, arg)
  @options.all_of(key).each { |b| b.call arg }
end