Class: Rackup::Server

Inherits:
Object
  • Object
show all
Defined in:
lib/rackup/server.rb

Defined Under Namespace

Classes: Options

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(options = nil) ⇒ Server

Options may include:

  • :app

    a rack application to run (overrides :config and :builder)

  • :builder

    a string to evaluate a Rack::Builder from

  • :config

    a rackup configuration file path to load (.ru)

  • :environment

    this selects the middleware that will be wrapped around
your application. Default options available are:
  - development: CommonLogger, ShowExceptions, and Lint
  - deployment: CommonLogger
  - none: no extra middleware
note: when the server is a cgi server, CommonLogger is not included.

  • :server

    choose a specific Rackup::Handler, e.g. cgi, fcgi, webrick

  • :daemonize

    if truthy, the server will daemonize itself (fork, detach, etc)
if :noclose, the server will not close STDOUT/STDERR

  • :pid

    path to write a pid file after daemonize

  • :Host

    the host address to bind to (used by supporting Rackup::Handler)

  • :Port

    the port to bind to (used by supporting Rackup::Handler)

  • :AccessLog

    webrick access log options (or supporting Rackup::Handler)

  • :debug

    turn on debug output ($DEBUG = true)

  • :warn

    turn on warnings ($-w = true)

  • :include

    add given paths to $LOAD_PATH

  • :require

    require the given libraries

Additional options for profiling app initialization include:

  • :heapfile

    location for ObjectSpace.dump_all to write the output to

  • :profile_file

    location for CPU/Memory (StackProf) profile output (defaults to a tempfile)

  • :profile_mode

    StackProf profile mode (cpu|wall|object)



230
231
232
233
234
235
236
237
238
239
240
241
 
# File 'lib/rackup/server.rb', line 230

def initialize(options = nil)
  @ignore_options = []

  if options
    @use_default_options = false
    @options = options
    @app = options[:app] if options[:app]
  else
    @use_default_options = true
    @options = parse_options(ARGV)
  end
end

Instance Attribute Details

#options ⇒ Object 



243
244
245
246
 
# File 'lib/rackup/server.rb', line 243

def options
  merged_options = @use_default_options ? default_options.merge(@options) : @options
  merged_options.reject { |k, v| @ignore_options.include?(k) }
end

Class Method Details

.default_middleware_by_environment ⇒ Object 



273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
 
# File 'lib/rackup/server.rb', line 273

def default_middleware_by_environment
  m = Hash.new {|h, k| h[k] = []}
  m["deployment"] = [
    [Rack::ContentLength],
    logging_middleware,
    [Rack::TempfileReaper]
  ]
  m["development"] = [
    [Rack::ContentLength],
    logging_middleware,
    [Rack::ShowExceptions],
    [Rack::Lint],
    [Rack::TempfileReaper]
  ]

  m
end

.logging_middleware ⇒ Object 



267
268
269
270
271
 
# File 'lib/rackup/server.rb', line 267

def logging_middleware
  lambda { |server|
    /CGI/.match?(server.server.name) || server.options[:quiet] ? nil : [Rack::CommonLogger, $stderr]
  }
end

.middleware ⇒ Object 



291
292
293
 
# File 'lib/rackup/server.rb', line 291

def middleware
  default_middleware_by_environment
end

.start(options = nil) ⇒ Object

Start a new rack server (like running rackup). This will parse ARGV and provide standard ARGV rackup options, defaulting to load ‘config.ru’.

Providing an options hash will prevent ARGV parsing and will not include any default options.

This method can be used to very easily launch a CGI application, for example:

Rack::Server.start(
  :app => lambda do |e|
    [200, {'content-type' => 'text/html'}, ['hello world']]
  end,
  :server => 'cgi'
)

Further options available here are documented on Rack::Server#initialize



181
182
183
 
# File 'lib/rackup/server.rb', line 181

def self.start(options = nil)
  new(options).start
end

Instance Method Details

#app ⇒ Object 



262
263
264
 
# File 'lib/rackup/server.rb', line 262

def app
  @app ||= options[:builder] ? build_app_from_string : build_app_and_options_from_config
end

#default_options ⇒ Object 



248
249
250
251
252
253
254
255
256
257
258
259
260
 
# File 'lib/rackup/server.rb', line 248

def default_options
  environment  = ENV['RACK_ENV'] || 'development'
  default_host = environment == 'development' ? 'localhost' : '0.0.0.0'

  {
    environment: environment,
    pid: nil,
    Port: 9292,
    Host: default_host,
    AccessLog: [],
    config: "config.ru"
  }
end

#middleware ⇒ Object 



296
297
298
 
# File 'lib/rackup/server.rb', line 296

def middleware
  self.class.middleware
end

#server ⇒ Object 



344
345
346
 
# File 'lib/rackup/server.rb', line 344

def server
  @_server ||= Handler.get(options[:server]) || Handler.default
end

#start(&block) ⇒ Object 



300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
 
# File 'lib/rackup/server.rb', line 300

def start(&block)
  if options[:warn]
    $-w = true
  end

  if includes = options[:include]
    $LOAD_PATH.unshift(*includes)
  end

  Array(options[:require]).each do |library|
    require library
  end

  if options[:debug]
    $DEBUG = true
    require 'pp'
    p options[:server]
    pp wrapped_app
    pp app
  end

  check_pid! if options[:pid]

  # Touch the wrapped app, so that the config.ru is loaded before
  # daemonization (i.e. before chdir, etc).
  handle_profiling(options[:heapfile], options[:profile_mode], options[:profile_file]) do
    wrapped_app
  end

  daemonize_app if options[:daemonize]

  write_pid if options[:pid]

  trap(:INT) do
    if server.respond_to?(:shutdown)
      server.shutdown
    else
      exit
    end
  end

  server.run(wrapped_app, **options, &block)
end