Class: Ramaze::App

Inherits:
Object
  • Object
show all
Includes:
Innate::Optioned
Defined in:
lib/ramaze/app.rb

Overview

App is the superclass for applications and acts as their prototype when it comes to configuration.

An application consists of options, a location, and a list of objects. The objects are usually Controllers.

The options are inherited, the basics are set in Ramaze.options, from there to Ramaze::App.options, and finally into every instance of App.

This allows to collect Controllers of your application into a common group that can easily be used in other applications, while retaining the original options.

Every instance of App is mapped in AppMap, which is the default location to #call from Rack.

Additionally, every App can have custom locations for root/public/view/layout directories, which allows reuse beyond directory boundaries.

In contrast to Innate, where all Nodes share the same middleware, App also has a subset of middleware that handles serving static files, routes and rewrites.

To indicate that a Controller belongs to a specific application, you can pass a second argument to Controller::map

The App instance will be created for you and if you don't use any other applications in your code there is nothing else you have to do. Others can now come and simply reuse your code in their own applications.

There is some risk of name collisions if everybody calls their app :wiki, but given that you only use one foreign app of this kind might give less reason for concern.

If you still try to use two apps with the same name, you have to be careful, loading one first, renaming it, then loading the second one.

The naming of an App has no influence on any other aspects of dispatching or configuration.

Examples:

adding Controller to application

class WikiController < Ramaze::Controller
  map '/', :wiki
end

Constant Summary

APP_LIST = 
{}

Instance Attribute Summary (collapse)

Class Method Summary (collapse)

Instance Method Summary (collapse)

Methods included from Innate::Optioned

included

Constructor Details

- (App) initialize(name, location = nil)

Creates a new instance of the application and sets the name and location.

Parameters:

  • name (String) —

    The name of the application.

  • location (String) (defaults to: nil) —

    The location to which the application is mapped.

Author:

  • Michael Fellinger

Since:

  • 30-06-2009



105
106
107
108
109
110
111
112
113
 
# File 'lib/ramaze/app.rb', line 105

def initialize(name, location = nil)
  @name = name.to_sym
  @url_map = Innate::URLMap.new
  self.location = location if location

  APP_LIST[@name] = self

  @options = self.class.options.sub(@name)
end

Instance Attribute Details

- (Object) location

Returns the value of attribute location



71
72
73
 
# File 'lib/ramaze/app.rb', line 71

def location
  @location
end

- (Object) name (readonly)

Returns the value of attribute name



71
72
73
 
# File 'lib/ramaze/app.rb', line 71

def name
  @name
end

- (Object) options (readonly)

Returns the value of attribute options



71
72
73
 
# File 'lib/ramaze/app.rb', line 71

def options
  @options
end

- (Object) url_map (readonly)

Returns the value of attribute url_map



71
72
73
 
# File 'lib/ramaze/app.rb', line 71

def url_map
  @url_map
end

Class Method Details

+ (Ramaze::App) [](name)

Returns the application for the given name.

Parameters:

  • name (String) —

    The name of the application.

Returns:

Author:

  • Michael Fellinger



93
94
95
 
# File 'lib/ramaze/app.rb', line 93

def self.[](name)
  APP_LIST[name.to_sym]
end

+ (Ramaze::App) find_or_create(name, location = nil)

Finds or creates an application for the given name and URI.

Parameters:

  • name (String) —

    The name of the application.

  • location (String) (defaults to: nil) —

    The URI to which the app is mapped.

Returns:

Author:

  • Michael Fellinger



81
82
83
84
 
# File 'lib/ramaze/app.rb', line 81

def self.find_or_create(name, location = nil)
  location = '/' if location.nil? && name == :pristine
  self[name] || new(name, location)
end

Instance Method Details

- (Object) call(env)

Allows the application to be called as a Rack middleware.

Parameters:

  • env (Hash) —

    The environment hash.

Author:

  • Michael Fellinger

Since:

  • 30-06-2009



143
144
145
 
# File 'lib/ramaze/app.rb', line 143

def call(env)
  to_app.call(env)
end

- (Object) map(location, object)

Maps an object to the given URI.

Parameters:

  • location (String) —

    The URI to map the object to.

  • object (Object) —

    The object (usually a controller) to map to the URI.

Author:

  • Michael Fellinger

Since:

  • 30-06-2009



169
170
171
 
# File 'lib/ramaze/app.rb', line 169

def map(location, object)
  url_map.map(location, object)
end

- (Array) public_roots

Returns an array containing all the public directories for each root directory.

Returns:

  • (Array)

Author:

  • Michael Fellinger

Since:

  • 30-06-2009



193
194
195
196
 
# File 'lib/ramaze/app.rb', line 193

def public_roots
  roots, publics = [*options.roots], [*options.publics]
  roots.map{|root| publics.map{|public| ::File.join(root, public) }}.flatten
end

- (Object) sync

Syncs the instance of the current application with Ramaze::AppMap.

Author:

  • Michael Fellinger

Since:

  • 30-06-2009



121
122
123
 
# File 'lib/ramaze/app.rb', line 121

def sync
  AppMap.map(location, self)
end

- (Object) to(object)

Returns a URI to the given object.

Parameters:

  • object (Object) —

    An object for which to generate the URI.

Author:

  • Michael Fellinger

Since:

  • 30-06-2009



180
181
182
183
 
# File 'lib/ramaze/app.rb', line 180

def to(object)
  return unless mapped = url_map.to(object)
  [location, mapped].join('/').squeeze('/')
end

- (Rack::Cascade) to_app

Converts the application to a Rack compatible class.

Returns:

  • (Rack::Cascade)

Author:

  • Michael Fellinger

Since:

  • 30-06-2009



154
155
156
157
158
 
# File 'lib/ramaze/app.rb', line 154

def to_app
  files = Ramaze::Files.new(*public_roots)
  app = Current.new(Route.new(url_map), Rewrite.new(url_map))
  Rack::Cascade.new([files, app])
end