Class: Rack::Server
- Defined in:
- lib/rubypitaya/app-template/vendor/bundle/ruby/3.1.0/gems/rack-2.2.5/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 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.
- #middleware ⇒ Object
- #server ⇒ Object
- #start(&block) ⇒ Object
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 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
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)
215 216 217 218 219 220 221 222 223 224 225 226 227 |
# File 'lib/rubypitaya/app-template/vendor/bundle/ruby/3.1.0/gems/rack-2.2.5/lib/rack/server.rb', line 215 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
229 230 231 232 |
# File 'lib/rubypitaya/app-template/vendor/bundle/ruby/3.1.0/gems/rack-2.2.5/lib/rack/server.rb', line 229 def = @use_default_options ? .merge(@options) : @options .reject { |k, v| @ignore_options.include?(k) } end |
Class Method Details
.default_middleware_by_environment ⇒ Object
259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 |
# File 'lib/rubypitaya/app-template/vendor/bundle/ruby/3.1.0/gems/rack-2.2.5/lib/rack/server.rb', line 259 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
253 254 255 256 257 |
# File 'lib/rubypitaya/app-template/vendor/bundle/ruby/3.1.0/gems/rack-2.2.5/lib/rack/server.rb', line 253 def logging_middleware lambda { |server| /CGI/.match?(server.server.name) || server.[:quiet] ? nil : [Rack::CommonLogger, $stderr] } end |
.middleware ⇒ Object
277 278 279 |
# File 'lib/rubypitaya/app-template/vendor/bundle/ruby/3.1.0/gems/rack-2.2.5/lib/rack/server.rb', line 277 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
167 168 169 |
# File 'lib/rubypitaya/app-template/vendor/bundle/ruby/3.1.0/gems/rack-2.2.5/lib/rack/server.rb', line 167 def self.start( = nil) new().start end |
Instance Method Details
#app ⇒ Object
248 249 250 |
# File 'lib/rubypitaya/app-template/vendor/bundle/ruby/3.1.0/gems/rack-2.2.5/lib/rack/server.rb', line 248 def app @app ||= [:builder] ? build_app_from_string : end |
#default_options ⇒ Object
234 235 236 237 238 239 240 241 242 243 244 245 246 |
# File 'lib/rubypitaya/app-template/vendor/bundle/ruby/3.1.0/gems/rack-2.2.5/lib/rack/server.rb', line 234 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
282 283 284 |
# File 'lib/rubypitaya/app-template/vendor/bundle/ruby/3.1.0/gems/rack-2.2.5/lib/rack/server.rb', line 282 def middleware self.class.middleware end |
#server ⇒ Object
330 331 332 333 334 335 336 337 338 339 340 341 |
# File 'lib/rubypitaya/app-template/vendor/bundle/ruby/3.1.0/gems/rack-2.2.5/lib/rack/server.rb', line 330 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(&block) ⇒ Object
286 287 288 289 290 291 292 293 294 295 296 297 298 299 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 |
# File 'lib/rubypitaya/app-template/vendor/bundle/ruby/3.1.0/gems/rack-2.2.5/lib/rack/server.rb', line 286 def start(&block) if [:warn] $-w = true end if includes = [:include] $LOAD_PATH.unshift(*includes) end Array([:require]).each do |library| 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). handle_profiling([:heapfile], [:profile_mode], [:profile_file]) do wrapped_app end 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, **, &block) end |