Scorched

• Home
• Documentation
  • Preface
  • Fundamentals
    • The Controller
    • Configuration
    • Routing
    • Requests and Responses
    • Filters
    • Middleware
    • Request and Session Data
    • Views
    • Sharing Request State
  • Further Reading
• API
• Code
• Tracker
• Discuss
• About

Configuration

Scorched includes a few configurable options out of the box. These all have common defaults, or are otherwise left intentionally blank to ensure the developer opts-in to any potentially undesirable or surprising behaviour.

There are two sets of configurables. Those which apply to views, and everything else. Each set of configuration options is a Scorched::Options instance. This allows configuration options to be inherited and subsequently overridden by child classes. This is handy in many instances, but a common requirement might be to change the view directory or default layout of some sub-controller.

Options

Each configuration is listed below, with the default value of each included. Note, development environment defaults may override the default values below.

• config[:auto_pass] = false - If no routes within the current controller match, automatically pass the request back to the outer controller without running any filters. This makes sub-controllers behave more like a kind-of route group.
• config[:cache_templates] = true - If true, caches compiled templates using Tilt::Cache.
• config[:logger] = false - Is currently only used for Rack::Logger.
• config[:show_exceptions] = false - If true, shows exceptions using Rack::ShowExceptions
• config[:show_http_error_pages] = false - If true, shows the default Scorched HTTP error page.
• config[:static_dir] = 'public'
  The directory Scorched should serve static files from. Should be set to false if the web server or some other middleware is serving static files.
• config[:strip_trailing_slash] = :redirect
  Controls how trailing forward slashes in requests are handled.
  • :redirect - Strips and redirects URL's ending in a forward slash. Note that for efficiency sake, the redirection takes place in the first controller that has this option set to :redirect, hence a sub-controller that otherwise matches the request will never be invoked, even if it sets :strip_trailing_slash to something other than :redirect.
  • :ignore - Internally ignores (pretends it doesn't exist) any trailing slash
  • false - Does nothing. Respects the presence of a trailing forward flash, as it would any other trailing character.

You can also configure the default options when rendering views by setting them on the render_defaults hash. The options specified here are merged with those provided when calling the render method, with the explicit options obviously taking precedence over the defaults.

Refer to the views page for more information.

Here is an example of the configuration options in action. A couple of different ways to set the options are shown. Refer to the API documentation for Scorched::Options for more information.

class MyApp < Scorched::Controller
  config[:static_dir] = '../public'
  render_defaults.merge!(
    dir: 'templates',
    layout: :main_layout
    engine: :haml
  )
end