Class: Rack::Server

Inherits:
Object
  • Object
show all
Defined in:
lib/rack/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)
  • :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 Rack::Handler, e.g. cgi, fcgi, webrick
  • :daemonize

    if true, the server will daemonize itself (fork, detach, etc)
  • :pid

    path to write a pid file after daemonize
  • :Host

    the host address to bind to (used by supporting Rack::Handler)
  • :Port

    the port to bind to (used by supporting Rack::Handler)
  • :AccessLog

    webrick access log options (or supporting Rack::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


184
185
186
187
# File 'lib/rack/server.rb', line 184

def initialize(options = nil)
  @options = options
  @app = options[:app] if options && options[:app]
end

Instance Attribute Details

#optionsObject



189
190
191
# File 'lib/rack/server.rb', line 189

def options
  @options ||= parse_options(ARGV)
end

Class Method Details

.default_middleware_by_environmentObject



218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
# File 'lib/rack/server.rb', line 218

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

  m
end

.logging_middlewareObject



212
213
214
215
216
# File 'lib/rack/server.rb', line 212

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

.middlewareObject



238
239
240
# File 'lib/rack/server.rb', line 238

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



146
147
148
# File 'lib/rack/server.rb', line 146

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

Instance Method Details

#appObject



207
208
209
# File 'lib/rack/server.rb', line 207

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

#default_optionsObject



193
194
195
196
197
198
199
200
201
202
203
204
205
# File 'lib/rack/server.rb', line 193

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

#middlewareObject



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

def middleware
  self.class.middleware
end

#serverObject



289
290
291
# File 'lib/rack/server.rb', line 289

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

#start(&blk) ⇒ Object



247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
# File 'lib/rack/server.rb', line 247

def start &blk
  if options[:warn]
    $-w = true
  end

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

  if library = options[:require]
    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).
  wrapped_app

  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, &blk
end