Class: Rack::Server

Inherits:
Object
  • Object
show all
Defined in:
lib/rack/server.rb,
lib/rack/server/options.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



60
61
62
63
 
# File 'lib/rack/server.rb', line 60

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

Instance Attribute Details

#options ⇒ Object 



65
66
67
 
# File 'lib/rack/server.rb', line 65

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

Class Method Details

.default_middleware_by_environment ⇒ Object 



93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
 
# File 'lib/rack/server.rb', line 93

def self.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_middleware ⇒ Object 



87
88
89
90
91
 
# File 'lib/rack/server.rb', line 87

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

.middleware ⇒ Object 



113
114
115
 
# File 'lib/rack/server.rb', line 113

def self.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



22
23
24
 
# File 'lib/rack/server.rb', line 22

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

Instance Method Details

#app ⇒ Object 



83
84
85
 
# File 'lib/rack/server.rb', line 83

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

#default_options ⇒ Object 



69
70
71
72
73
74
75
76
77
78
79
80
81
 
# File 'lib/rack/server.rb', line 69

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 



117
118
119
 
# File 'lib/rack/server.rb', line 117

def middleware
  self.class.middleware
end

#server ⇒ Object 



163
164
165
 
# File 'lib/rack/server.rb', line 163

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

#start(&block) ⇒ Object 



121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
 
# File 'lib/rack/server.rb', line 121

def start(&block)
  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, &block
end