module Utopia

Utopia is a web application framework built on top of Rack.

Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the “Software”), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED “AS IS”, WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.

Constants

Locale: A structured representation of locale based on RFC3066.
PAGES_PATH: The default pages path for {Utopia::Content} middleware.
VARIABLES_KEY: This is used for shared controller variables which get consumed by the content middleware.
VERSION

Public Class Methods

Path(path) click to toggle source

# File lib/utopia/path.rb, line 405
def self.Path(path)
        Path.create(path)
end

default_path(*arguments) click to toggle source

The same as {default_root} but returns an instance of {Path}. @return [Path] The path as requested.

# File lib/utopia/middleware.rb, line 42
def self.default_path(*arguments)
        Path[default_root(*arguments)]
end

default_root(subdirectory = PAGES_PATH, pwd = Dir.pwd) click to toggle source

The default root directory for middleware to operate within, e.g. the web-site directory. Convention over configuration. @param subdirectory [String] Appended to the default root to make a more specific path. @param pwd [String] The working directory for the current site.

# File lib/utopia/middleware.rb, line 36
def self.default_root(subdirectory = PAGES_PATH, pwd = Dir.pwd)
        File.expand_path(subdirectory, pwd)
end

setup(root = nil, **options) click to toggle source

You can call this method exactly once per process.

# File lib/utopia/setup.rb, line 135
def self.setup(root = nil, **options)
        if @setup
                raise RuntimeError, "Utopia already setup!"
        end
        
        # We extract the root from the caller of this method:
        if root.nil?
                config_root = File.dirname(caller[0])
                root = File.dirname(config_root)
        end
        
        @setup = Setup.new(root, **options)
        
        @setup.apply!
        
        return @setup
end