Class: Sinatra::Base
- Inherits:
-
Object
- Object
- Sinatra::Base
- Defined in:
- lib/sinatra/base.rb
Overview
Base class for all Sinatra applications and middleware.
Direct Known Subclasses
Constant Summary collapse
- URI_INSTANCE =
URI::Parser.new
- CALLERS_TO_IGNORE =
:nodoc:
[ # :nodoc: %r{/sinatra(/(base|main|show_exceptions))?\.rb$}, # all sinatra code %r{lib/tilt.*\.rb$}, # all tilt code /^\(.*\)$/, # generated code %r{rubygems/(custom|core_ext/kernel)_require\.rb$}, # rubygems require hacks /active_support/, # active_support require hacks %r{bundler(/(?:runtime|inline))?\.rb}, # bundler require hacks /<internal:/, # internal in ruby >= 1.9.2 %r{zeitwerk/kernel\.rb} # Zeitwerk kernel#require decorator ].freeze
Constants included from Helpers
Helpers::ETAG_KINDS, Helpers::MULTIPART_FORM_DATA_REPLACEMENT_TABLE
Class Attribute Summary collapse
-
.errors ⇒ Object
readonly
Returns the value of attribute errors.
-
.filters ⇒ Object
readonly
Returns the value of attribute filters.
-
.on_start_callback ⇒ Object
readonly
Returns the value of attribute on_start_callback.
-
.on_stop_callback ⇒ Object
readonly
Returns the value of attribute on_stop_callback.
-
.routes ⇒ Object
readonly
Returns the value of attribute routes.
-
.templates ⇒ Object
readonly
Returns the value of attribute templates.
Instance Attribute Summary collapse
-
#app ⇒ Object
Returns the value of attribute app.
-
#env ⇒ Object
Returns the value of attribute env.
-
#params ⇒ Object
Returns the value of attribute params.
-
#request ⇒ Object
Returns the value of attribute request.
-
#response ⇒ Object
Returns the value of attribute response.
-
#template_cache ⇒ Object
readonly
Returns the value of attribute template_cache.
Class Method Summary collapse
-
.add_filter(type, path = /.*/, **options, &block) ⇒ Object
add a filter.
-
.after(path = /.*/, **options, &block) ⇒ Object
Define an after filter; runs after all requests within the same context as route handlers and may access/modify the request and response.
-
.before(path = /.*/, **options, &block) ⇒ Object
Define a before filter; runs before all requests within the same context as route handlers and may access/modify the request and response.
-
.build(app) ⇒ Object
Creates a Rack::Builder instance with all the middleware set up and the given +app+ as end point.
- .call(env) ⇒ Object
-
.caller_files ⇒ Object
Like Kernel#caller but excluding certain magic entries and without line / method information; the resulting array contains filenames only.
- .callers_to_ignore ⇒ Object
-
.condition(name = "#{caller.first[/`.*'/]} condition", &block) ⇒ Object
Add a route condition.
-
.configure(*envs) {|_self| ... } ⇒ Object
Set configuration options for Sinatra and/or the app.
- .delete(path, opts = {}, &block) ⇒ Object
- .development? ⇒ Boolean
-
.disable(*opts) ⇒ Object
Same as calling
set :option, false
for each of the given options. -
.enable(*opts) ⇒ Object
Same as calling
set :option, true
for each of the given options. -
.error(*codes, &block) ⇒ Object
Define a custom error handler.
-
.extensions ⇒ Object
Extension modules registered on this class and all superclasses.
-
.get(path, opts = {}, &block) ⇒ Object
Defining a
GET
handler also automatically defines aHEAD
handler. - .head(path, opts = {}, &block) ⇒ Object
-
.helpers(*extensions, &block) ⇒ Object
Makes the methods defined in the block and in the Modules given in
extensions
available to the handlers and templates. -
.inline_templates=(file = nil) ⇒ Object
Load embedded templates from the file; uses the caller's FILE when no file is specified.
-
.layout(name = :layout, &block) ⇒ Object
Define the layout template.
- .link(path, opts = {}, &block) ⇒ Object
-
.middleware ⇒ Object
Middleware used in this class and all superclasses.
-
.mime_type(type, value = nil) ⇒ Object
Lookup or register a mime type in Rack's mime registry.
-
.mime_types(type) ⇒ Object
provides all mime types matching type, including deprecated types: mime_types :html # => ['text/html'] mime_types :js # => ['application/javascript', 'text/javascript'].
-
.new(*args, &block) ⇒ Object
Create a new instance of the class fronted by its middleware pipeline.
-
.not_found(&block) ⇒ Object
Sugar for
error(404) { ... }
. - .on_start(&on_start_callback) ⇒ Object
- .on_stop(&on_stop_callback) ⇒ Object
- .options(path, opts = {}, &block) ⇒ Object
- .patch(path, opts = {}, &block) ⇒ Object
- .post(path, opts = {}, &block) ⇒ Object
- .production? ⇒ Boolean
-
.prototype ⇒ Object
The prototype instance used to process requests.
- .public=(value) ⇒ Object
- .public_dir ⇒ Object
- .public_dir=(value) ⇒ Object
- .put(path, opts = {}, &block) ⇒ Object
-
.quit! ⇒ Object
(also: stop!)
Stop the self-hosted server if running.
-
.register(*extensions, &block) ⇒ Object
Register an extension.
-
.reset! ⇒ Object
Removes all routes, filters, middleware and extension hooks from the current class (not routes/filters/... defined by its superclass).
-
.run!(options = {}, &block) ⇒ Object
(also: start!)
Run the Sinatra app as a self-hosted server using Puma, Falcon, or WEBrick (in that order).
-
.running? ⇒ Boolean
Check whether the self-hosted server is running or not.
-
.set(option, value = (not_set = true), ignore_setter = false, &block) ⇒ Object
Sets an option to the given value.
-
.settings ⇒ Object
Access settings defined with Base.set.
-
.template(name, &block) ⇒ Object
Define a named template.
- .test? ⇒ Boolean
- .unlink(path, opts = {}, &block) ⇒ Object
-
.use(middleware, *args, &block) ⇒ Object
Use the specified Rack middleware.
Instance Method Summary collapse
-
#call(env) ⇒ Object
Rack call interface.
-
#call!(env) ⇒ Object
:nodoc:.
-
#forward ⇒ Object
Forward the request to the downstream app -- middleware only.
-
#halt(*response) ⇒ Object
Exit the current block, halts any further processing of the request, and returns the specified response.
-
#initialize(app = nil, **_kwargs) {|_self| ... } ⇒ Base
constructor
A new instance of Base.
-
#new! ⇒ Object
Create a new instance without middleware in front of it.
-
#pass(&block) ⇒ Object
Pass control to the next matching route.
-
#settings ⇒ Object
Access settings defined with Base.set.
Methods included from Templates
#asciidoc, #builder, #erb, #find_template, #haml, #liquid, #markaby, #markdown, #nokogiri, #rabl, #rdoc, #sass, #scss, #slim, #yajl
Methods included from Helpers
#attachment, #back, #bad_request?, #body, #cache_control, #client_error?, #content_type, #error, #etag, #expires, #headers, #informational?, #last_modified, #logger, #mime_type, #not_found, #not_found?, #redirect, #redirect?, #send_file, #server_error?, #session, #status, #stream, #success?, #time_for, #uri
Constructor Details
#initialize(app = nil, **_kwargs) {|_self| ... } ⇒ Base
Returns a new instance of Base.
975 976 977 978 979 980 981 |
# File 'lib/sinatra/base.rb', line 975 def initialize(app = nil, **_kwargs) super() @app = app @template_cache = TemplateCache.new @pinned_response = nil # whether a before! filter pinned the content-type yield self if block_given? end |
Class Attribute Details
.errors ⇒ Object (readonly)
Returns the value of attribute errors.
1280 1281 1282 |
# File 'lib/sinatra/base.rb', line 1280 def errors @errors end |
.filters ⇒ Object (readonly)
Returns the value of attribute filters.
1280 1281 1282 |
# File 'lib/sinatra/base.rb', line 1280 def filters @filters end |
.on_start_callback ⇒ Object (readonly)
Returns the value of attribute on_start_callback.
1280 1281 1282 |
# File 'lib/sinatra/base.rb', line 1280 def on_start_callback @on_start_callback end |
.on_stop_callback ⇒ Object (readonly)
Returns the value of attribute on_stop_callback.
1280 1281 1282 |
# File 'lib/sinatra/base.rb', line 1280 def on_stop_callback @on_stop_callback end |
.routes ⇒ Object (readonly)
Returns the value of attribute routes.
1280 1281 1282 |
# File 'lib/sinatra/base.rb', line 1280 def routes @routes end |
.templates ⇒ Object (readonly)
Returns the value of attribute templates.
1280 1281 1282 |
# File 'lib/sinatra/base.rb', line 1280 def templates @templates end |
Instance Attribute Details
#app ⇒ Object
Returns the value of attribute app.
972 973 974 |
# File 'lib/sinatra/base.rb', line 972 def app @app end |
#env ⇒ Object
Returns the value of attribute env.
972 973 974 |
# File 'lib/sinatra/base.rb', line 972 def env @env end |
#params ⇒ Object
Returns the value of attribute params.
972 973 974 |
# File 'lib/sinatra/base.rb', line 972 def params @params end |
#request ⇒ Object
Returns the value of attribute request.
972 973 974 |
# File 'lib/sinatra/base.rb', line 972 def request @request end |
#response ⇒ Object
Returns the value of attribute response.
972 973 974 |
# File 'lib/sinatra/base.rb', line 972 def response @response end |
#template_cache ⇒ Object (readonly)
Returns the value of attribute template_cache.
973 974 975 |
# File 'lib/sinatra/base.rb', line 973 def template_cache @template_cache end |
Class Method Details
.add_filter(type, path = /.*/, **options, &block) ⇒ Object
add a filter
1469 1470 1471 |
# File 'lib/sinatra/base.rb', line 1469 def add_filter(type, path = /.*/, **, &block) filters[type] << compile!(type, path, block, **) end |
.after(path = /.*/, **options, &block) ⇒ Object
Define an after filter; runs after all requests within the same context as route handlers and may access/modify the request and response.
1464 1465 1466 |
# File 'lib/sinatra/base.rb', line 1464 def after(path = /.*/, **, &block) add_filter(:after, path, **, &block) end |
.before(path = /.*/, **options, &block) ⇒ Object
Define a before filter; runs before all requests within the same context as route handlers and may access/modify the request and response.
1457 1458 1459 |
# File 'lib/sinatra/base.rb', line 1457 def before(path = /.*/, **, &block) add_filter(:before, path, **, &block) end |
.build(app) ⇒ Object
Creates a Rack::Builder instance with all the middleware set up and the given +app+ as end point.
1624 1625 1626 1627 1628 1629 1630 |
# File 'lib/sinatra/base.rb', line 1624 def build(app) builder = Rack::Builder.new setup_default_middleware builder setup_middleware builder builder.run app builder end |
.call(env) ⇒ Object
1632 1633 1634 |
# File 'lib/sinatra/base.rb', line 1632 def call(env) synchronize { prototype.call(env) } end |
.caller_files ⇒ Object
Like Kernel#caller but excluding certain magic entries and without line / method information; the resulting array contains filenames only.
1638 1639 1640 |
# File 'lib/sinatra/base.rb', line 1638 def caller_files cleaned_caller(1).flatten end |
.callers_to_ignore ⇒ Object
1282 1283 1284 |
# File 'lib/sinatra/base.rb', line 1282 def callers_to_ignore CALLERS_TO_IGNORE end |
.condition(name = "#{caller.first[/`.*'/]} condition", &block) ⇒ Object
Add a route condition. The route is considered non-matching when the block returns false.
1483 1484 1485 |
# File 'lib/sinatra/base.rb', line 1483 def condition(name = "#{caller.first[/`.*'/]} condition", &block) @conditions << generate_method(name, &block) end |
.configure(*envs) {|_self| ... } ⇒ Object
Set configuration options for Sinatra and/or the app. Allows scoping of settings for certain environments.
1550 1551 1552 |
# File 'lib/sinatra/base.rb', line 1550 def configure(*envs) yield self if envs.empty? || envs.include?(environment.to_sym) end |
.delete(path, opts = {}, &block) ⇒ Object
1514 |
# File 'lib/sinatra/base.rb', line 1514 def delete(path, opts = {}, &block) route 'DELETE', path, opts, &block end |
.development? ⇒ Boolean
1544 |
# File 'lib/sinatra/base.rb', line 1544 def development?; environment == :development end |
.disable(*opts) ⇒ Object
Same as calling set :option, false
for each of the given options.
1370 1371 1372 |
# File 'lib/sinatra/base.rb', line 1370 def disable(*opts) opts.each { |key| set(key, false) } end |
.enable(*opts) ⇒ Object
Same as calling set :option, true
for each of the given options.
1365 1366 1367 |
# File 'lib/sinatra/base.rb', line 1365 def enable(*opts) opts.each { |key| set(key, true) } end |
.error(*codes, &block) ⇒ Object
Define a custom error handler. Optionally takes either an Exception class, or an HTTP status code to specify which errors should be handled.
1377 1378 1379 1380 1381 1382 1383 |
# File 'lib/sinatra/base.rb', line 1377 def error(*codes, &block) args = compile! 'ERROR', /.*/, block codes = codes.flat_map(&method(:Array)) codes << Exception if codes.empty? codes << Sinatra::NotFound if codes.include?(404) codes.each { |c| (@errors[c] ||= []) << args } end |
.extensions ⇒ Object
Extension modules registered on this class and all superclasses.
1305 1306 1307 1308 1309 1310 1311 |
# File 'lib/sinatra/base.rb', line 1305 def extensions if superclass.respond_to?(:extensions) (@extensions + superclass.extensions).uniq else @extensions end end |
.get(path, opts = {}, &block) ⇒ Object
Defining a GET
handler also automatically defines
a HEAD
handler.
1502 1503 1504 1505 1506 1507 1508 |
# File 'lib/sinatra/base.rb', line 1502 def get(path, opts = {}, &block) conditions = @conditions.dup route('GET', path, opts, &block) @conditions = conditions route('HEAD', path, opts, &block) end |
.head(path, opts = {}, &block) ⇒ Object
1516 |
# File 'lib/sinatra/base.rb', line 1516 def head(path, opts = {}, &block) route 'HEAD', path, opts, &block end |
.helpers(*extensions, &block) ⇒ Object
Makes the methods defined in the block and in the Modules given
in extensions
available to the handlers and templates
1528 1529 1530 1531 |
# File 'lib/sinatra/base.rb', line 1528 def helpers(*extensions, &block) class_eval(&block) if block_given? include(*extensions) if extensions.any? end |
.inline_templates=(file = nil) ⇒ Object
Load embedded templates from the file; uses the caller's FILE when no file is specified.
1403 1404 1405 1406 1407 1408 1409 1410 1411 1412 1413 1414 1415 1416 1417 1418 1419 1420 1421 1422 1423 1424 1425 1426 1427 1428 1429 1430 1431 1432 1433 |
# File 'lib/sinatra/base.rb', line 1403 def inline_templates=(file = nil) file = (caller_files.first || File.($0)) if file.nil? || file == true begin io = ::IO.respond_to?(:binread) ? ::IO.binread(file) : ::IO.read(file) app, data = io.gsub("\r\n", "\n").split(/^__END__$/, 2) rescue Errno::ENOENT app, data = nil end return unless data encoding = if app && app =~ /([^\n]*\n)?#[^\n]*coding: *(\S+)/m $2 else settings.default_encoding end lines = app.count("\n") + 1 template = nil force_encoding data, encoding data.each_line do |line| lines += 1 if line =~ /^@@\s*(.*\S)\s*$/ template = force_encoding(String.new, encoding) templates[$1.to_sym] = [template, file, lines] elsif template template << line end end end |
.layout(name = :layout, &block) ⇒ Object
Define the layout template. The block must return the template source.
1397 1398 1399 |
# File 'lib/sinatra/base.rb', line 1397 def layout(name = :layout, &block) template name, &block end |
.link(path, opts = {}, &block) ⇒ Object
1522 |
# File 'lib/sinatra/base.rb', line 1522 def link(path, opts = {}, &block) route 'LINK', path, opts, &block end |
.middleware ⇒ Object
Middleware used in this class and all superclasses.
1314 1315 1316 1317 1318 1319 1320 |
# File 'lib/sinatra/base.rb', line 1314 def middleware if superclass.respond_to?(:middleware) superclass.middleware + @middleware else @middleware end end |
.mime_type(type, value = nil) ⇒ Object
Lookup or register a mime type in Rack's mime registry.
1436 1437 1438 1439 1440 1441 1442 1443 1444 |
# File 'lib/sinatra/base.rb', line 1436 def mime_type(type, value = nil) return type if type.nil? return type.to_s if type.to_s.include?('/') type = ".#{type}" unless type.to_s[0] == '.' return Rack::Mime.mime_type(type, nil) unless value Rack::Mime::MIME_TYPES[type] = value end |
.mime_types(type) ⇒ Object
provides all mime types matching type, including deprecated types: mime_types :html # => ['text/html'] mime_types :js # => ['application/javascript', 'text/javascript']
1449 1450 1451 1452 |
# File 'lib/sinatra/base.rb', line 1449 def mime_types(type) type = mime_type type type =~ %r{^application/(xml|javascript)$} ? [type, "text/#{$1}"] : [type] end |
.new(*args, &block) ⇒ Object
Create a new instance of the class fronted by its middleware pipeline. The object is guaranteed to respond to #call but may not be an instance of the class new was called on.
1616 1617 1618 1619 |
# File 'lib/sinatra/base.rb', line 1616 def new(*args, &block) instance = new!(*args, &block) Wrapper.new(build(instance).to_app, instance) end |
.not_found(&block) ⇒ Object
Sugar for error(404) { ... }
1386 1387 1388 |
# File 'lib/sinatra/base.rb', line 1386 def not_found(&block) error(404, &block) end |
.on_start(&on_start_callback) ⇒ Object
1473 1474 1475 |
# File 'lib/sinatra/base.rb', line 1473 def on_start(&on_start_callback) @on_start_callback = on_start_callback end |
.on_stop(&on_stop_callback) ⇒ Object
1477 1478 1479 |
# File 'lib/sinatra/base.rb', line 1477 def on_stop(&on_stop_callback) @on_stop_callback = on_stop_callback end |
.options(path, opts = {}, &block) ⇒ Object
1518 |
# File 'lib/sinatra/base.rb', line 1518 def (path, opts = {}, &block) route 'OPTIONS', path, opts, &block end |
.patch(path, opts = {}, &block) ⇒ Object
1520 |
# File 'lib/sinatra/base.rb', line 1520 def patch(path, opts = {}, &block) route 'PATCH', path, opts, &block end |
.post(path, opts = {}, &block) ⇒ Object
1512 |
# File 'lib/sinatra/base.rb', line 1512 def post(path, opts = {}, &block) route 'POST', path, opts, &block end |
.production? ⇒ Boolean
1545 |
# File 'lib/sinatra/base.rb', line 1545 def production?; environment == :production end |
.prototype ⇒ Object
The prototype instance used to process requests.
1606 1607 1608 |
# File 'lib/sinatra/base.rb', line 1606 def prototype @prototype ||= new end |
.public=(value) ⇒ Object
1487 1488 1489 1490 |
# File 'lib/sinatra/base.rb', line 1487 def public=(value) warn_for_deprecation ':public is no longer used to avoid overloading Module#public, use :public_folder or :public_dir instead' set(:public_folder, value) end |
.public_dir ⇒ Object
1496 1497 1498 |
# File 'lib/sinatra/base.rb', line 1496 def public_dir public_folder end |
.public_dir=(value) ⇒ Object
1492 1493 1494 |
# File 'lib/sinatra/base.rb', line 1492 def public_dir=(value) self.public_folder = value end |
.put(path, opts = {}, &block) ⇒ Object
1510 |
# File 'lib/sinatra/base.rb', line 1510 def put(path, opts = {}, &block) route 'PUT', path, opts, &block end |
.quit! ⇒ Object Also known as: stop!
Stop the self-hosted server if running.
1562 1563 1564 1565 1566 1567 1568 1569 1570 1571 1572 |
# File 'lib/sinatra/base.rb', line 1562 def quit! return unless running? # Use Thin's hard #stop! if available, otherwise just #stop. running_server.respond_to?(:stop!) ? running_server.stop! : running_server.stop warn '== Sinatra has ended his set (crowd applauds)' unless set :running_server, nil set :handler_name, nil on_stop_callback.call unless on_stop_callback.nil? end |
.register(*extensions, &block) ⇒ Object
Register an extension. Alternatively take a block from which an extension will be created and registered on the fly.
1535 1536 1537 1538 1539 1540 1541 1542 |
# File 'lib/sinatra/base.rb', line 1535 def register(*extensions, &block) extensions << Module.new(&block) if block_given? @extensions += extensions extensions.each do |extension| extend extension extension.registered(self) if extension.respond_to?(:registered) end end |
.reset! ⇒ Object
Removes all routes, filters, middleware and extension hooks from the current class (not routes/filters/... defined by its superclass).
1288 1289 1290 1291 1292 1293 1294 1295 1296 1297 1298 1299 1300 1301 1302 |
# File 'lib/sinatra/base.rb', line 1288 def reset! @conditions = [] @routes = {} @filters = { before: [], after: [] } @errors = {} @middleware = [] @prototype = nil @extensions = [] @templates = if superclass.respond_to?(:templates) Hash.new { |_hash, key| superclass.templates[key] } else {} end end |
.run!(options = {}, &block) ⇒ Object Also known as: start!
Run the Sinatra app as a self-hosted server using Puma, Falcon, or WEBrick (in that order). If given a block, will call with the constructed handler once we have taken the stage.
1579 1580 1581 1582 1583 1584 1585 1586 1587 1588 1589 1590 1591 1592 1593 1594 1595 1596 |
# File 'lib/sinatra/base.rb', line 1579 def run!( = {}, &block) return if running? set handler = Rack::Handler.pick(server) handler_name = handler.name.gsub(/.*::/, '') server_settings = settings.respond_to?(:server_settings) ? settings.server_settings : {} server_settings.merge!(Port: port, Host: bind) begin start_server(handler, server_settings, handler_name, &block) rescue Errno::EADDRINUSE warn "== Someone is already performing on port #{port}!" raise ensure quit! end end |
.running? ⇒ Boolean
Check whether the self-hosted server is running or not.
1601 1602 1603 |
# File 'lib/sinatra/base.rb', line 1601 def running? running_server? end |
.set(option, value = (not_set = true), ignore_setter = false, &block) ⇒ Object
Sets an option to the given value. If the value is a proc, the proc will be called every time the option is accessed.
1324 1325 1326 1327 1328 1329 1330 1331 1332 1333 1334 1335 1336 1337 1338 1339 1340 1341 1342 1343 1344 1345 1346 1347 1348 1349 1350 1351 1352 1353 1354 1355 1356 1357 1358 1359 1360 1361 1362 |
# File 'lib/sinatra/base.rb', line 1324 def set(option, value = (not_set = true), ignore_setter = false, &block) raise ArgumentError if block && !not_set if block value = block not_set = false end if not_set raise ArgumentError unless option.respond_to?(:each) option.each { |k, v| set(k, v) } return self end if respond_to?("#{option}=") && !ignore_setter return __send__("#{option}=", value) end setter = proc { |val| set option, val, true } getter = proc { value } case value when Proc getter = value when Symbol, Integer, FalseClass, TrueClass, NilClass getter = value.inspect when Hash setter = proc do |val| val = value.merge val if Hash === val set option, val, true end end define_singleton("#{option}=", setter) define_singleton(option, getter) define_singleton("#{option}?", "!!#{option}") unless method_defined? "#{option}?" self end |
.settings ⇒ Object
Access settings defined with Base.set.
1011 1012 1013 |
# File 'lib/sinatra/base.rb', line 1011 def self.settings self end |
.template(name, &block) ⇒ Object
Define a named template. The block must return the template source.
1391 1392 1393 1394 |
# File 'lib/sinatra/base.rb', line 1391 def template(name, &block) filename, line = caller_locations.first templates[name] = [block, filename, line.to_i] end |
.test? ⇒ Boolean
1546 |
# File 'lib/sinatra/base.rb', line 1546 def test?; environment == :test end |
.unlink(path, opts = {}, &block) ⇒ Object
1524 |
# File 'lib/sinatra/base.rb', line 1524 def unlink(path, opts = {}, &block) route 'UNLINK', path, opts, &block end |
.use(middleware, *args, &block) ⇒ Object
Use the specified Rack middleware
1555 1556 1557 1558 |
# File 'lib/sinatra/base.rb', line 1555 def use(middleware, *args, &block) @prototype = nil @middleware << [middleware, args, block] end |
Instance Method Details
#call(env) ⇒ Object
Rack call interface.
984 985 986 |
# File 'lib/sinatra/base.rb', line 984 def call(env) dup.call!(env) end |
#call!(env) ⇒ Object
:nodoc:
988 989 990 991 992 993 994 995 996 997 998 999 1000 1001 1002 1003 1004 1005 1006 1007 1008 |
# File 'lib/sinatra/base.rb', line 988 def call!(env) # :nodoc: @env = env @params = IndifferentHash.new @request = Request.new(env) @response = Response.new @pinned_response = nil template_cache.clear if settings.reload_templates invoke { dispatch! } invoke { error_block!(response.status) } unless @env['sinatra.error'] unless @response['Content-Type'] if Array === body && body[0].respond_to?(:content_type) content_type body[0].content_type elsif (default = settings.default_content_type) content_type default end end @response.finish end |
#forward ⇒ Object
Forward the request to the downstream app -- middleware only.
1035 1036 1037 1038 1039 1040 1041 1042 1043 |
# File 'lib/sinatra/base.rb', line 1035 def forward raise 'downstream app not set' unless @app.respond_to? :call status, headers, body = @app.call env @response.status = status @response.body = body @response.headers.merge! headers nil end |
#halt(*response) ⇒ Object
Exit the current block, halts any further processing of the request, and returns the specified response.
1022 1023 1024 1025 |
# File 'lib/sinatra/base.rb', line 1022 def halt(*response) response = response.first if response.length == 1 throw :halt, response end |
#new! ⇒ Object
Create a new instance without middleware in front of it.
1611 |
# File 'lib/sinatra/base.rb', line 1611 alias new! new |
#pass(&block) ⇒ Object
Pass control to the next matching route. If there are no more matching routes, Sinatra will return a 404 response.
1030 1031 1032 |
# File 'lib/sinatra/base.rb', line 1030 def pass(&block) throw :pass, block end |
#settings ⇒ Object
Access settings defined with Base.set.
1016 1017 1018 |
# File 'lib/sinatra/base.rb', line 1016 def settings self.class.settings end |