Class: Merb::Router::Behavior

Inherits:
Object
  • Object
show all
Defined in:
lib/merb-slices/router_ext.rb

Instance Method Summary collapse

Instance Method Details

#add_slice(slice_module, options = {}) {|ns| ... } ⇒ Behaviour

Note:

If a slice has no routes at all, the activate hook won’t be executed.

Note:

Normally you should specify the slice_module using a String or Symbol this ensures that your module can be removed from the router at runtime.

Add a Slice in a router namespace

Parameters:

  • slice_module (String, Symbol, Module) —

    A Slice module to mount.

  • options (Hash, String) (defaults to: {}) —

    Optional hash, set :path if you want to override what appears on the url.

Yields:

  • A new Behavior instance is yielded in the block for nested routes - runs before the slice routes are setup.

Yield Parameters:

  • ns (Behavior) —

    The namespace behavior object.

Returns:

  • (Behaviour) —

    The current router context.



40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
 
# File 'lib/merb-slices/router_ext.rb', line 40

def add_slice(slice_module, options = {}, &block)
  if Merb::Slices.exists?(slice_module)
    options = { :path => options } if options.is_a?(String)
    slice_module = Object.full_const_get(slice_module.to_s) if slice_module.class.in?(String, Symbol)
    namespace = options[:namespace] || slice_module.to_s.snake_case
    options[:path] ||= slice_module[:path_prefix] || options[:namespace] || slice_module.identifier
    options[:default_routes] = true unless options.key?(:default_routes)
    options[:prepend_routes] = block if block_given?
    slice_module[:path_prefix] = options[:path]
    Merb.logger.info!("Mounting slice #{slice_module} at /#{options[:path]}")
    
    # setup routes - capture the slice's routes for easy reference
    slice_module.routes, slice_module.named_routes = Merb::Router.capture do
      self.namespace(namespace.to_sym, options.except(:default_routes, :prepend_routes, :append_routes)) do |ns|
        options[:prepend_routes].call(ns) if options[:prepend_routes].respond_to?(:call)
        slice_module.setup_router(ns)     # setup the routes from the slice itself
        options[:append_routes].call(ns)  if options[:append_routes].respond_to?(:call)
        ns.default_routes(options[:params] || {}) if options[:default_routes]
      end
    end
  else 
    Merb.logger.info!("Skipped adding slice #{slice_module} to router...")
  end
  self
end

#all_slices(config = {}) {|ns| ... } ⇒ Object Also known as: add_slices

Note:

The block is yielded for each slice individually.

Add all known slices to the router

By combining this with Merb::Slices.activate_by_file and Merb::Slices.deactivate one can enable/disable slices at runtime, without restarting your app.

Examples:

r.all_slices(‘BlogSlice’ => ‘blog’, ‘ForumSlice’ => { :path => ‘forum’ })

Parameters:

  • config (Hash) (defaults to: {}) —

    Optional hash, mapping slice module names to their settings; set :path (or use a string) if you want to override what appears on the url.

Yields:

  • A new Behavior instance is yielded in the block for nested routes.

Yield Parameters:

  • ns (Behavior) —

    The namespace behavior object.



21
22
23
 
# File 'lib/merb-slices/router_ext.rb', line 21

def all_slices(config = {}, &block)
  Merb::Slices.slice_names.each { |module_name| add_slice(module_name, config[module_name] || {}, &block) }
end

#slice(slice_module, options = {}, &block) ⇒ Object

Insert a slice directly into the current router context.

This will still setup a namespace, but doesn’t set a path prefix.



69
70
71
 
# File 'lib/merb-slices/router_ext.rb', line 69

def slice(slice_module, options = {}, &block)
  add_slice(slice_module, options.merge(:path => ''), &block)
end