Require this rather than autoloading it so we can be sure the default template gets registered
VERSION | = | '1.1.3'.freeze |
environment | -> | env |
:api: public | ||
started | -> | started? |
:api: public |
adapter | [RW] | :api: public |
environment | [RW] | :api: public |
environment_info | [RW] | :api: private |
exiting | [R] | |
klass_hashes | [RW] | Set up default variables under Merb |
load_paths | [RW] | :api: private |
orm | [RW] | Set up default variables under Merb |
started | [RW] | :api: private |
template_engine | [RW] | Set up default variables under Merb |
test_framework | [RW] | Set up default variables under Merb |
*generators: | Generator paths to add to the list of generators. |
Recommended way to add Generator load paths for plugin authors.
:api: public
Any specific outgoing headers should be included here. These are not the content-type header but anything in addition to it. transform_method should be set to a symbol of the method used to transform a resource into this mime type. For example for the :xml mime type an object might be transformed by calling :to_xml, or for the :js mime type, :to_json. If there is no transform method, use nil.
Adding a mime-type adds a render_type method that sets the content type and calls render.
By default this does: def render_all, def render_yaml, def render_text, def render_html, def render_xml, def render_js, and def render_yaml
key<Symbol>: | The name of the mime-type. This is used by the provides API |
transform_method<~to_s>: | The associated method to call on objects to convert them to the appropriate mime-type. For instance, :json would use :to_json as its transform_method. |
mimes<Array[String]>: | A list of possible values sent in the Accept header, such as text/html, that should be associated with this content-type. |
new_response_headers<Hash>: | The response headers to set for the the mime type. For example: ‘Content-Type’ => ‘application/json; charset=utf-8’; As a shortcut for the common charset option, use :charset => ‘utf-8’, which will be correctly appended to the mimetype itself. |
&block: | a block which recieves the current controller when the format |
is set (in the controller's #content_type method)
nil
:api: public
*rakefiles: | Rakefile paths to add to the list of Rakefiles. |
Recommended way to add Rakefiles load path for plugins authors.
:api: public
Hash{String => Symbol}: | A hash mapping Content-Type values to the mime type key of the appropriate entry in available_mime_types |
:api: public
Returns a hash of the available mime types.
Hash{Symbol => Hash{Symbol => Object}}: | The available mime types. |
Each entry corresponds to a call to add_mime_type, having the mime type key (:html, :xml, :json, etc.) as the key and a hash containing the following entries:
:accepts # the mime types that will be recognized by this entry :transform_method # the method called on an object to convert it to content of this type (such as to_json) :content_type # the value set to the "Content-Type" HTTP header when this mime is sent in a response :response_headers # sent in a response using this content type :default_quality # the scale factor used in describing content type preference :response_block # the block to be called with the controller when a request responds to this mime type
:api: public
Boolean: | True if Merb is running as an application with bundled gems. |
Bundling required gems makes your application independent from the environment it runs in. It is a good practice to freeze application framework and gems and is very useful when application is run in some sort of sandbox, for instance, shared hosting with preconfigured gems.
:api: public
If block was given configures using the block.
&block: | Configuration parameter block, see example below. |
Hash: | The current configuration. |
See Merb::GlobalHelpers.load_config for configuration options list.
Merb.config do beer "good" hashish :foo => "bar" environment "development" log_level "debug" use_mutex false exception_details true reload_classes true reload_time 0.5 end
:api: public
RegExp: | Regular expression against which deferred actions are matched by Rack application handler. |
Concatenates :deferred_actions configuration option values.
:api: public
type<Symbol>: | The type of path to retrieve directory for, e.g. :view. |
String: | The directory for the requested type. |
:api: public
Ask the question about which environment you‘re in.
env<Symbol, String>: | Name of the environment to query |
Merb.env #=> production Merb.env?(:production) #=> true Merb.env?(:development) #=> false
:api: public
Perform a hard Exit. Print a backtrace to the merb logger before exiting if verbose is enabled.
:api: private
Array(String): | Paths generators are loaded from |
Recommended way to find out what paths generators are loaded from.
:api: public
type<Symbol>: | The type of path to retrieve glob for, e.g. :view. |
String: | The pattern with which to match files within the type directory. |
:api: public
Load configuration and assign the logger.
options<Hash>: | Options to pass on to the Merb config. |
:host<String>: | host to bind to, default is 0.0.0.0. |
:port<Fixnum>: | port to run Merb application on, default is 4000. |
:adapter<String>: | name of Rack adapter to use, default is "runner" |
:rackup<String>: | name of Rack init file to use, default is "rack.rb" |
:reload_classes<Boolean>: | whether Merb should reload classes on each request, default is true |
:environment<String>: | name of environment to use, default is development |
:merb_root<String>: | Merb application root, default is Dir.pwd |
:use_mutex<Boolean>: | turns action dispatch synchronization on or off, default is on (true) |
:log_delimiter<String>: | what Merb logger uses as delimiter between message sections, default is " ~ " |
:log_auto_flush<Boolean>: | whether the log should automatically flush after new messages are added, defaults to true. |
:log_stream<IO>: | IO handle for logger. Defaults to STDOUT. |
:log_file<String>: | File path for logger. Overrides :log_stream. |
:log_level<Symbol>: | logger level, default is :info |
:disabled_components<Array[Symbol]>: | array of disabled component names, for instance, to disable json gem, specify :json. Default is empty array. |
:deferred_actions<Array(Symbol, String)]>: | names of actions that should be deferred no matter what controller they belong to. Default is empty array. |
Some of these options come from command line on Merb application start, some of them are set in Merb init file or environment-specific.
:api: public
Load all basic dependencies (selected BootLoaders only). This sets up Merb framework component paths (directories for models, controllers, etc) using framework.rb or default layout, loads init file and dependencies specified in it and runs before_app_loads hooks.
options<Hash>: | Options to pass on to the Merb config. |
:api: public
String: | The path to the log file. If this Merb instance is running as a daemon this will return STDOUT. |
When Merb.testing? the port is modified to become :test - this keeps this special environment situation from ending up in the memoized @streams just once, thereby never taking changes into account again. Now, it will be memoized as :test - and just logging to merb_test.log.
:api: public
Merge environment settings
This can allow you to have a "localdev" environment that runs like your "development".
OR
A "staging" environment that runs identical to your "production" environment.
From any environment config file (ie, development.rb, custom.rb, localdev.rb, etc).
staging.rb: Merb.merge_env "production" # We want to use all the settings production uses Merb::Config.use do |c| c[:log_level] = "debug" # except we want debug log level c[:log_stream] = @some_io # and log to this IO handle c[:exception_details] = true # and we want to see exception details end
env<~String>: | Environment to run like |
use_db<~Boolean>: | Should Merb use the merged environments DB connection |
Defaults to +false+
:api: public
key<Symbol>: | The key that represents the mime-type. |
Symbol: | The transform method for the mime type, e.g. :to_json. |
ArgumentError: | The requested mime type is not valid. |
:api: private
Returns the default ORM for this application. For instance, :datamapper.
<Symbol>: | default ORM. |
:api: public
This is the mechanism for setting up your application layout. There are three application layouts in Merb:
app/models for models app/mailers for mailers (special type of controllers) app/parts for parts, Merb components app/views for templates app/controllers for controller lib for libraries
application.rb for models, controllers, mailers, etc config/init.rb for initialization and router configuration config/framework.rb for framework and dependencies configuration views for views
application and configs are contained within a single file.
Autoloading for lib uses an empty glob by default. If you want to have your libraries under lib use autoload, add the following to Merb init file:
Merb.push_path(:lib, Merb.root / "lib", "**/*.rb") # glob set explicity.
Then lib/magicwand/lib/magicwand.rb with MagicWand module will be autoloaded when you first access that constant.
This method gives you a way to build up your own application structure, for instance, to reflect the structure Rails uses to simplify transition of legacy application, you can set it up like this:
Merb.push_path(:model, Merb.root / "app" / "models", "**/*.rb") Merb.push_path(:mailer, Merb.root / "app" / "models", "**/*.rb") Merb.push_path(:controller, Merb.root / "app" / "controllers", "**/*.rb") Merb.push_path(:view, Merb.root / "app" / "views", "**/*.rb")
type<Symbol>: | The type of path being registered (i.e. :view) |
path<String>: | The full path |
file_glob<String>: | A glob that will be used to autoload files under the path. Defaults to "**/*.rb". |
:api: public
Array(String): | Paths Rakefiles are loaded from. |
Recommended way to find out what paths Rakefiles are loaded from.
:api: public
Reload application and framework classes. See Merb::BootLoader::ReloadClasses for details.
:api: public
Removes a MIME-type from the mime-type list.
key<Symbol>: | The key that represents the mime-type to remove. |
(Boolean, Hash{Symbol => Object}): | If it was present, the old specification of the MIME-type. Same structure |
as a value in Merb.available_mime_types. False if the key was not present.
:all is the key for */*; It can‘t be removed.
:api: public
Removes given types of application components from load path Merb uses for autoloading.
*args<Array(Symbol)>: | component(s) names, for instance, :views, :models |
Using this combined with Merb::GlobalHelpers.push_path you can make your Merb application use legacy Rails application components.
Merb.root = "path/to/legacy/app/root" Merb.remove_paths(:mailer) Merb.push_path(:mailer, Merb.root / "app" / "models", "**/*.rb")
Will make Merb use app/models for mailers just like Ruby on Rails does.
:api: public
*path: | The relative path (or list of path components) to a directory under the root of the application. |
String: | The full path including the root. |
Merb.root = "/home/merb/app" Merb.path("images") # => "/home/merb/app/images" Merb.path("views", "admin") # => "/home/merb/app/views/admin"
@public
Returns the default template engine for this application. For instance :haml.
<Symbol>: | default template engine. |
:api: public
Returns the default test framework for this application. For instance :rspec.
<Symbol>: | default test framework. |
:api: public
Install a signal handler for a given signal unless signals have been disabled with Merb.disable(:signals)
signal: | The name of the signal to install a handler for. |
&block: | The block to be run when the given signal is received. |
:api: public