Class: Puma::Configuration

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

Defined Under Namespace

Classes: ConfigMiddleware, DSL

Constant Summary collapse

DefaultRackup = 
"config.ru"
DefaultTCPHost = 
"0.0.0.0"
DefaultTCPPort = 
9292

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(options) ⇒ Configuration

Returns a new instance of Configuration.



18
19
20
21
22
23
24
 
# File 'lib/puma/configuration.rb', line 18

def initialize(options)
  @options = options
  @options[:mode] ||= :http
  @options[:binds] ||= []
  @options[:on_restart] ||= []
  @options[:worker_boot] ||= []
end

Instance Attribute Details

#options ⇒ Object (readonly)

Returns the value of attribute options.



26
27
28
 
# File 'lib/puma/configuration.rb', line 26

def options
  @options
end

Class Method Details

.temp_path ⇒ Object 



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

def self.temp_path
  require 'tmpdir'

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

Instance Method Details

#app ⇒ Object

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



85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
 
# File 'lib/puma/configuration.rb', line 85

def app
  app = @options[:app]

  unless app
    unless File.exists?(rackup)
      raise "Missing rackup file '#{rackup}'"
    end

    app, options = Rack::Builder.parse_file rackup
    @options.merge! options

    options.each do |key,val|
      if key.to_s[0,4] == "bind"
        @options[:binds] << val
      end
    end
  end

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

    logger = @options[:logger] || STDOUT
    return TCPLogger.new(logger, app, @options[:quiet])
  end

  if !@options[:quiet] and @options[:environment] == "development"
    logger = @options[:logger] || STDOUT
    app = Rack::CommonLogger.new(app, logger)
  end

  return ConfigMiddleware.new(self, app)
end

#app_configured? ⇒ Boolean

Indicate if there is a properly configured app

Returns:

  • (Boolean) 


74
75
76
 
# File 'lib/puma/configuration.rb', line 74

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

#initialize_copy(other) ⇒ Object 



28
29
30
 
# File 'lib/puma/configuration.rb', line 28

def initialize_copy(other)
  @options = @options.dup
end

#load ⇒ Object 



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
 
# File 'lib/puma/configuration.rb', line 32

def load
  if path = @options[:config_file]
    DSL.new(@options)._load_from path
  end

  # Rakeup default option support
  if host = @options[:Host]
    port = @options[:Port] || DefaultTCPPort

    @options[:binds] << "tcp://#{host}:#{port}"
  end

  if @options[:binds].empty?
    @options[:binds] << "tcp://#{DefaultTCPHost}:#{DefaultTCPPort}"
  end

  if @options[:control_url] == "auto"
    path = Configuration.temp_path
    @options[:control_url] = "unix://#{path}"
    @options[:control_url_temp] = path
  end

  unless @options[:control_auth_token]
    setup_random_token
  end
end

#rackup ⇒ Object 



78
79
80
 
# File 'lib/puma/configuration.rb', line 78

def rackup
  @options[:rackup] || DefaultRackup
end

#setup_random_token ⇒ Object 



118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
 
# File 'lib/puma/configuration.rb', line 118

def setup_random_token
  begin
    require 'openssl'
  rescue LoadError
  end

  count = 16

  bytes = nil

  if defined? OpenSSL::Random
    bytes = OpenSSL::Random.random_bytes(count)
  elsif File.exists?("/dev/urandom")
    File.open("/dev/urandom") do |f|
      bytes = f.read(count)
    end
  end

  if bytes
    token = ""
    bytes.each_byte { |b| token << b.to_s(16) }
  else
    token = (0..count).to_a.map { rand(255).to_s(16) }.join
  end

  @options[:control_auth_token] = token
end