module Roda::RodaPlugins::Base::InstanceMethods

  1. lib/roda.rb

Instance methods for the Roda class.

In addition to the listed methods, the following two methods are available:


The instance of the request class related to this request. This is the same object yielded by Roda.route.


The instance of the response class related to this request.

Public Class methods


Create a request and response of the appropriate class

[show source]
    # File lib/roda.rb
481 def initialize(env)
482   klass = self.class
483   @_request =, env)
484   @_response =
485 end

Public Instance methods


Handle dispatching to the main route, catching :halt and handling the result of the block.

[show source]
    # File lib/roda.rb
489 def _roda_handle_main_route
490   catch(:halt) do
491     r = @_request
492     r.block_result(_roda_run_main_route(r))
493     @_response.finish
494   end
495 end

Treat the given block as a routing block, catching :halt if thrown by the block.

[show source]
    # File lib/roda.rb
499 def _roda_handle_route
500   catch(:halt) do
501     @_request.block_result(yield)
502     @_response.finish
503   end
504 end

Default implementation of the main route, usually overridden by Roda.route.

[show source]
    # File lib/roda.rb
508 def _roda_main_route(_)
509 end

Run the main route block with the request. Designed for extension by plugins

[show source]
    # File lib/roda.rb
513 def _roda_run_main_route(r)
514   _roda_main_route(r)
515 end

Deprecated method for the previous main route dispatch API.

[show source]
    # File lib/roda.rb
518 def call(&block)
519   # RODA4: Remove
520   catch(:halt) do
521     r = @_request
522     r.block_result(instance_exec(r, &block)) # Fallback
523     @_response.finish
524   end
525 end

The environment hash for the current request. Example:

env['REQUEST_METHOD'] # => 'GET'
[show source]
    # File lib/roda.rb
535 def env
536   @_request.env
537 end

The class-level options hash. This should probably not be modified at the instance level. Example:

Roda.plugin :render
Roda.route do |r|
[show source]
    # File lib/roda.rb
546 def opts
547   self.class.opts
548 end

The session hash for the current request. Raises RodaError if no session exists. Example:

session # => {}
[show source]
    # File lib/roda.rb
562 def session
563   @_request.session
564 end