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 acess 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
    

137
138
139
# File 'lib/rack/server.rb', line 137

def initialize(options = nil)
  @options = options
end

Instance Attribute Details

#optionsObject


141
142
143
# File 'lib/rack/server.rb', line 141

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

Class Method Details

.middlewareObject


168
169
170
171
172
173
174
175
# File 'lib/rack/server.rb', line 168

def self.middleware
  @middleware ||= begin
    m = Hash.new {|h,k| h[k] = []}
    m["deployment"].concat  [lambda {|server| server.server.name =~ /CGI/ ? nil : [Rack::CommonLogger, $stderr] }]
    m["development"].concat m["deployment"] + [[Rack::ShowExceptions], [Rack::Lint]]
    m
  end
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


99
100
101
# File 'lib/rack/server.rb', line 99

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

Instance Method Details

#appObject


156
157
158
159
160
161
162
163
164
165
166
# File 'lib/rack/server.rb', line 156

def app
  @app ||= begin
    if !::File.exist? options[:config]
      abort "configuration #{options[:config]} not found"
    end

    app, options = Rack::Builder.parse_file(self.options[:config], opt_parser)
    self.options.merge! options
    app
  end
end

#default_optionsObject


145
146
147
148
149
150
151
152
153
154
# File 'lib/rack/server.rb', line 145

def default_options
  {
    :environment => "development",
    :pid         => nil,
    :Port        => 9292,
    :Host        => "0.0.0.0",
    :AccessLog   => [],
    :config      => "config.ru"
  }
end

#middlewareObject


177
178
179
# File 'lib/rack/server.rb', line 177

def middleware
  self.class.middleware
end

#serverObject


216
217
218
# File 'lib/rack/server.rb', line 216

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

#startObject


181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
# File 'lib/rack/server.rb', line 181

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

  if options[:warn]
    $-w = true
  end

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

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