Overview
Utopia is a web application framework built on top of Rack.
module Content
-
class BuilderA builder for rendering Utopia content that extends XRB::Builder with Utopia-specific functionality.
-
class UnbalancedTagErrorThis error is raised if a tag doesn't match up when parsing.
-
class DocumentA single request through content middleware. We use a struct to hide instance varibles since we instance_exec within this context.
-
class LinkRepresents a link to some content with associated metadata.
-
class Links-
class ResolverRepresents a list of
class Utopia::Content::Linkinstances relating to the structure of the content. They are formed from thelinks.yamlfile and the actual directory structure on disk.
-
class SymbolicHashA hash which forces all keys to be symbols and fails with KeyError when strings are used.
-
class MarkupParserProvides a high level interface for parsing markup.
-
class ParsedTagA tag generated by parsing markup.
-
class UnbalancedTagErrorThe name of a closing tag fails to match up with the corresponding opening tag.
-
-
class MiddlewareA middleware which serves dynamically generated content based on markup files.
-
Provider -
module NamespaceA namespace which contains tags which can be rendered within a
class Utopia::Content::Document. -
class NodeRepresents an immutable node within the content hierarchy.
-
class ResponseA basic content response, including useful defaults for typical HTML5 content.
-
module TagsTags which provide intrinsic behaviour within the content middleware.
-
tagInvokes a node and renders a single node to the output stream.
-
module Controller
A middleware which loads controller classes and invokes functionality based on the requested path.
-
module ActionsA controller layer which invokes functinality based on the request path.
-
class ActionA nested action lookup hash table.
-
module ClassMethodsExposed to the controller class.
-
-
class BaseThe base implementation of a controller class.
-
class Middleware -
module RespondA controller layer which provides a convenient way to respond to different requested content types. The order in which you add converters matters, as it determines how the incoming Accept: header is mapped, e.g. the first converter is also defined as matching the media range /.
-
module Handlers -
class Responder -
module RewriteThis controller layer rewrites the path before executing controller actions. When the rule matches, the supplied block is executed.
-
class RuleA abstract rule which can match against a request path.
-
class ExtractPrefixRuleA rule which extracts a prefix pattern from the request path.
-
class RewriterRewrite a request path based on a set of defined rules.
-
module ClassMethodsExposed to the controller class.
-
-
class VariablesProvides a stack-based instance variable lookup mechanism. It can flatten a stack of controllers into a single hash.
module Exceptions
Middleware for handling exceptional situations.
-
class HandlerA middleware which catches exceptions and performs an internal redirect.
-
class MailerA middleware which catches all exceptions raised from the app it wraps and sends a useful email with the exception, stacktrace, and contents of the environment.
module Extensions
-
module ArraySplit -
module TimeDateComparisonProvides comparison operator extensions.
-
module DateTimeComparisonProvides comparison operator extensions.
module HTTP
HTTP protocol implementation.
-
class StatusA small HTTP status wrapper that verifies the status code within a given range.
class ImportMap
Represents an import map for JavaScript modules with support for URI and relative path resolution.
-
class BuilderBuilder class for constructing import maps with scoped base URIs.
module Localization
A middleware which attempts to find localized content.
-
class Middleware -
class WrapperA wrapper to provide easy access to locale related data in the request.
class Path
Represents a path as an array of path components. Useful for efficient URL manipulation.
-
class MatcherPerforms structured, efficient, matches against
class Utopia::Pathinstances. Supports regular expressions, type-casts and constants.-
class MatchDataThe result of matching against a
class Utopia::Path.
-
module Redirection
A middleware which assists with redirecting from one path to another.
-
class RequestFailureAn error handler fails to redirect to a valid page.
-
class ErrorsA middleware which performs internal redirects based on error status codes.
-
class ClientRedirectA basic client-side redirect.
-
class DirectoryIndexRedirect urls that end with a
/, e.g. directories. -
class RewriteRewrite requests that match the given pattern to a single destination.
-
class MovedRewrite requests that match the given pattern to a new prefix.
module Session
-
class LazyHashA simple hash table which fetches it's values only when required.
-
class MiddlewareA middleware which provides a secure client-side session storage using a private symmetric encrpytion key.
-
class Serialization
class Setup
Used for setting up a Utopia web application, typically via config/environment.rb
class Shell
This is designed to be used with the corresponding bake task.
module Static
A middleware which serves static files from the specified root directory.
-
class LocalFileRepresents a local file on disk which can be served directly, or passed upstream to sendfile.
-
class MiddlewareA middleware which serves static files from the specified root directory.
-
Provider -
class MimeTypeLoaderA class to assist with loading mime-type metadata.