Module: Roda::RodaPlugins::Base::InstanceMethods

Defined in:
lib/roda.rb

Overview

Instance methods for the Roda class.

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

request

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

response

The instance of the response class related to this request.

Instance Attribute Summary collapse

Instance Method Summary collapse

Instance Attribute Details

#_request ⇒ Object (readonly) Also known as: request

:nodoc:



298
299
300
 
# File 'lib/roda.rb', line 298

def _request
  @_request
end

#_response ⇒ Object (readonly) Also known as: response

:nodoc:



302
303
304
 
# File 'lib/roda.rb', line 302

def _response
  @_response
end

Instance Method Details

#call(&block) ⇒ Object

instance_exec the route block in the scope of the receiver, with the related request. Catch :halt so that the route block can throw :halt at any point with the rack response to use.



272
273
274
275
276
277
278
 
# File 'lib/roda.rb', line 272

def call(&block)
  catch(:halt) do
    r = @_request
    r.block_result(instance_exec(r, &block))
    @_response.finish
  end
end

#env ⇒ Object

The environment hash for the current request. Example:

env['REQUEST_METHOD'] # => 'GET'



283
284
285
 
# File 'lib/roda.rb', line 283

def env
  @_request.env
end

#initialize(env) ⇒ Object

Create a request and response of the appropriate class



262
263
264
265
266
 
# File 'lib/roda.rb', line 262

def initialize(env)
  klass = self.class
  @_request = klass::RodaRequest.new(self, env)
  @_response = klass::RodaResponse.new
end

#opts ⇒ Object

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

Roda.plugin :render
Roda.route do |r|
  opts[:render_opts].inspect
end



294
295
296
 
# File 'lib/roda.rb', line 294

def opts
  self.class.opts
end

#session ⇒ Object

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

session # => {}



310
311
312
 
# File 'lib/roda.rb', line 310

def session
  @_request.session
end