Class: Rack::Server
- Inherits:
-
Object
- Object
- Rack::Server
- Defined in:
- lib/rack/server.rb
Defined Under Namespace
Classes: Options
Instance Attribute Summary collapse
Class Method Summary collapse
- .default_middleware_by_environment ⇒ Object
- .logging_middleware ⇒ Object
- .middleware ⇒ Object
-
.start(options = nil) ⇒ Object
Start a new rack server (like running rackup).
Instance Method Summary collapse
- #app ⇒ Object
- #default_options ⇒ Object
-
#initialize(options = nil) ⇒ Server
constructor
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.
- #middleware ⇒ Object
- #server ⇒ Object
- #start(&blk) ⇒ Object
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
185 186 187 188 189 190 191 192 193 194 195 196 197 |
# File 'lib/rack/server.rb', line 185 def initialize( = nil) @ignore_options = [] if @use_default_options = false @options = @app = [:app] if [:app] else argv = defined?(SPEC_ARGV) ? SPEC_ARGV : ARGV @use_default_options = true @options = (argv) end end |
Instance Attribute Details
#options ⇒ Object
199 200 201 202 |
# File 'lib/rack/server.rb', line 199 def = @use_default_options ? .merge(@options) : @options .reject { |k, v| @ignore_options.include?(k) } end |
Class Method Details
.default_middleware_by_environment ⇒ Object
229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 |
# File 'lib/rack/server.rb', line 229 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_middleware ⇒ Object
223 224 225 226 227 |
# File 'lib/rack/server.rb', line 223 def logging_middleware lambda { |server| server.server.name =~ /CGI/ || server.[:quiet] ? nil : [Rack::CommonLogger, $stderr] } end |
.middleware ⇒ Object
249 250 251 |
# File 'lib/rack/server.rb', line 249 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
147 148 149 |
# File 'lib/rack/server.rb', line 147 def self.start( = nil) new().start end |
Instance Method Details
#app ⇒ Object
218 219 220 |
# File 'lib/rack/server.rb', line 218 def app @app ||= [:builder] ? build_app_from_string : end |
#default_options ⇒ Object
204 205 206 207 208 209 210 211 212 213 214 215 216 |
# File 'lib/rack/server.rb', line 204 def 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
254 255 256 |
# File 'lib/rack/server.rb', line 254 def middleware self.class.middleware end |
#server ⇒ Object
300 301 302 303 304 305 306 307 308 309 310 311 |
# File 'lib/rack/server.rb', line 300 def server @_server ||= Rack::Handler.get([:server]) unless @_server @_server = Rack::Handler.default # We already speak FastCGI @ignore_options = [:File, :Port] if @_server.to_s == 'Rack::Handler::FastCGI' end @_server end |
#start(&blk) ⇒ Object
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 288 289 290 291 292 293 294 295 296 297 298 |
# File 'lib/rack/server.rb', line 258 def start &blk if [:warn] $-w = true end if includes = [:include] $LOAD_PATH.unshift(*includes) end if library = [:require] require library end if [:debug] $DEBUG = true require 'pp' p [:server] pp wrapped_app pp app end check_pid! if [:pid] # Touch the wrapped app, so that the config.ru is loaded before # daemonization (i.e. before chdir, etc). wrapped_app daemonize_app if [:daemonize] write_pid if [:pid] trap(:INT) do if server.respond_to?(:shutdown) server.shutdown else exit end end server.run wrapped_app, , &blk end |