Class: Puma::UserFileDefaultOptions

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

Overview

A class used for storing “leveled” configuration options.

In this class any “user” specified options take precedence over any “file” specified options, take precedence over any “default” options.

User input is preferred over “defaults”:

user_options    = { foo: "bar" }
default_options = { foo: "zoo" }
options = UserFileDefaultOptions.new(user_options, default_options)
puts options[:foo]
# => "bar"

All values can be accessed via `all_of`

puts options.all_of(:foo)
# => ["bar", "zoo"]

A “file” option can be set. This config will be preferred over “default” options but will defer to any available “user” specified options.

user_options    = { foo: "bar" }
default_options = { rackup: "zoo.rb" }
options = UserFileDefaultOptions.new(user_options, default_options)
options.file_options[:rackup] = "sup.rb"
puts options[:rackup]
# => "sup.rb"

The “default” options can be set via procs. These are resolved during runtime via calls to `finalize_values`

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(user_options, default_options) ⇒ UserFileDefaultOptions

Returns a new instance of UserFileDefaultOptions.


48
49
50
51
52
# File 'lib/puma/configuration.rb', line 48

def initialize(user_options, default_options)
  @user_options    = user_options
  @file_options    = {}
  @default_options = default_options
end

Instance Attribute Details

#default_optionsObject (readonly)

Returns the value of attribute default_options


54
55
56
# File 'lib/puma/configuration.rb', line 54

def default_options
  @default_options
end

#file_optionsObject (readonly)

Returns the value of attribute file_options


54
55
56
# File 'lib/puma/configuration.rb', line 54

def file_options
  @file_options
end

#user_optionsObject (readonly)

Returns the value of attribute user_options


54
55
56
# File 'lib/puma/configuration.rb', line 54

def user_options
  @user_options
end

Instance Method Details

#[](key) ⇒ Object


56
57
58
# File 'lib/puma/configuration.rb', line 56

def [](key)
  fetch(key)
end

#[]=(key, value) ⇒ Object


60
61
62
# File 'lib/puma/configuration.rb', line 60

def []=(key, value)
  user_options[key] = value
end

#all_of(key) ⇒ Object


72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
# File 'lib/puma/configuration.rb', line 72

def all_of(key)
  user    = user_options[key]
  file    = file_options[key]
  default = default_options[key]

  user    = [user]    unless user.is_a?(Array)
  file    = [file]    unless file.is_a?(Array)
  default = [default] unless default.is_a?(Array)

  user.compact!
  file.compact!
  default.compact!

  user + file + default
end

#fetch(key, default_value = nil) ⇒ Object


64
65
66
67
68
69
70
# File 'lib/puma/configuration.rb', line 64

def fetch(key, default_value = nil)
  return user_options[key]    if user_options.key?(key)
  return file_options[key]    if file_options.key?(key)
  return default_options[key] if default_options.key?(key)

  default_value
end

#finalize_valuesObject


88
89
90
91
92
93
94
# File 'lib/puma/configuration.rb', line 88

def finalize_values
  @default_options.each do |k,v|
    if v.respond_to? :call
      @default_options[k] = v.call
    end
  end
end