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:



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

def _request
  @_request
end

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

:nodoc:



268
269
270
 
# File 'lib/roda.rb', line 268

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.



238
239
240
241
242
243
244
 
# File 'lib/roda.rb', line 238

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'



249
250
251
 
# File 'lib/roda.rb', line 249

def env
  @_request.env
end

#initialize(env) ⇒ Object

Create a request and response of the appropriate class



228
229
230
231
232
 
# File 'lib/roda.rb', line 228

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



260
261
262
 
# File 'lib/roda.rb', line 260

def opts
  self.class.opts
end

#session ⇒ Object

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

session # => {}



276
277
278
 
# File 'lib/roda.rb', line 276

def session
  @_request.session
end