module Roda::RodaPlugins::Base::ClassMethods

  1. lib/roda.rb

Class methods for the Roda class.


app [R]

The rack application that this class uses.

inherit_middleware [RW]

Whether middleware from the current class should be inherited by subclasses. True by default, should be set to false when using a design where the parent class accepts requests and uses run to dispatch the request to a subclass.

opts [R]

The settings/options hash for the current class.

route_block [R]

The route block that this class uses.

Public Instance methods

call (env)

Call the internal rack application with the given environment. This allows the class itself to be used as a rack application. However, for performance, it's better to use app to get direct access to the underlying rack app.

[show source]
# File lib/roda.rb, line 135
def call(env)
clear_middleware! ()

Clear the middleware stack

[show source]
# File lib/roda.rb, line 140
def clear_middleware!
expand_path (path, root=opts[:root])

Expand the given path, using the root argument as the base directory.

[show source]
# File lib/roda.rb, line 146
def expand_path(path, root=opts[:root])
  ::File.expand_path(path, root)
freeze ()

Freeze the internal state of the class, to avoid thread safety issues at runtime. It's optional to call this method, as nothing should be modifying the internal state at runtime anyway, but this makes sure an exception will be raised if you try to modify the internal state after calling this.

Note that freezing the class prevents you from subclassing it, mostly because it would cause some plugins to break.

[show source]
# File lib/roda.rb, line 157
def freeze
inherited (subclass)

When inheriting Roda, copy the shared data into the subclass, and setup the request and response subclasses.

[show source]
# File lib/roda.rb, line 165
def inherited(subclass)
  raise RodaError, "Cannot subclass a frozen Roda class" if frozen?
  subclass.instance_variable_set(:@inherit_middleware, @inherit_middleware)
  subclass.instance_variable_set(:@middleware, @inherit_middleware ? @middleware.dup : [])
  subclass.instance_variable_set(:@opts, opts.dup)
  subclass.opts.to_a.each do |k,v|
    if (v.is_a?(Array) || v.is_a?(Hash)) && !v.frozen?
      subclass.opts[k] = v.dup
  subclass.instance_variable_set(:@route_block, @route_block)
  request_class =
  request_class.roda_class = subclass
  request_class.match_pattern_cache =
  subclass.const_set(:RodaRequest, request_class)

  response_class =
  response_class.roda_class = subclass
  subclass.const_set(:RodaResponse, response_class)
plugin (plugin, *args, &block)

Load a new plugin into the current class. A plugin can be a module which is used directly, or a symbol represented a registered plugin which will be required and then used. Returns nil.

Roda.plugin PluginModule
Roda.plugin :csrf
[show source]
# File lib/roda.rb, line 195
def plugin(plugin, *args, &block)
  raise RodaError, "Cannot add a plugin to a frozen Roda class" if frozen?
  plugin = RodaPlugins.load_plugin(plugin) if plugin.is_a?(Symbol)
  plugin.load_dependencies(self, *args, &block) if plugin.respond_to?(:load_dependencies)
  include(plugin::InstanceMethods) if defined?(plugin::InstanceMethods)
  extend(plugin::ClassMethods) if defined?(plugin::ClassMethods)
  self::RodaRequest.send(:include, plugin::RequestMethods) if defined?(plugin::RequestMethods)
  self::RodaRequest.extend(plugin::RequestClassMethods) if defined?(plugin::RequestClassMethods)
  self::RodaResponse.send(:include, plugin::ResponseMethods) if defined?(plugin::ResponseMethods)
  self::RodaResponse.extend(plugin::ResponseClassMethods) if defined?(plugin::ResponseClassMethods)
  plugin.configure(self, *args, &block) if plugin.respond_to?(:configure)
route (&block)

Setup routing tree for the current Roda application, and build the underlying rack application using the stored middleware. Requires a block, which is yielded the request. By convention, the block argument should be named r. Example:

Roda.route do |r|
  r.root do

This should only be called once per class, and if called multiple times will overwrite the previous routing.

[show source]
# File lib/roda.rb, line 222
def route(&block)
  @route_block = block
use (*args, &block)

Add a middleware to use for the rack application. Must be called before calling route to have an effect. Example:

Roda.use Rack::ShowExceptions
[show source]
# File lib/roda.rb, line 231
def use(*args, &block)
  @middleware << [args, block].freeze