README

   1 MerbEMart
   2 =========
   3
   4 A slice for the Merb framework.
   5
   6 ------------------------------------------------------------------------------
   7
   8 Instructions for installation:
   9
  10 file: config/init.rb
  11
  12 # add the slice as a regular dependency
  13
  14 dependency 'merb-E-mart'
  15
  16 # if needed, configure which slices to load and in which order
  17
  18 Merb::Plugins.config[:merb_slices] = { :queue => ["MerbEMart", ...] }
  19
  20 # optionally configure the plugins in a before_app_loads callback
  21
  22 Merb::BootLoader.before_app_loads do
  23
  24   Merb::Slices::config[:merb_E_mart] = { ... }
  25
  26 end
  27
  28 file: config/router.rb
  29
  30 # example: /merb-E-mart/:controller/:action/:id
  31
  32 r.add_slice(:MerbEMart)
  33
  34 # example: /foo/:controller/:action/:id
  35
  36 r.add_slice(:MerbEMart, 'foo') # same as :path => 'foo'
  37
  38 # example: /:lang/:controller/:action/:id (with :a param set)
  39
  40 r.add_slice(:MerbEMart, :path => ':lang', :params => { :a => 'b' })
  41
  42 # example: /:controller/:action/:id
  43
  44 r.slice(:MerbEMart)
  45
  46 Normally you should also run the following rake task:
  47
  48 rake slices:merb_E_mart:install
  49
  50 ------------------------------------------------------------------------------
  51
  52 You can put your application-level overrides in:
  53
  54 host-app/slices/merb-E-mart/app - controllers, models, views ...
  55
  56 Templates are located in this order:
  57
  58 1. host-app/slices/merb-E-mart/app/views/*
  59 2. gems/merb-E-mart/app/views/*
  60 3. host-app/app/views/*
  61
  62 You can use the host application's layout by configuring the
  63 merb-E-mart slice in a before_app_loads block:
  64
  65 Merb::Slices.config[:merb_E_mart] = { :layout => :application }
  66
  67 By default :merb_E_mart is used. If you need to override
  68 stylesheets or javascripts, just specify your own files in your layout
  69 instead/in addition to the ones supplied (if any) in
  70 host-app/public/slices/merb-E-mart.
  71
  72 In any case don't edit those files directly as they may be clobbered any time
  73 rake merb_E_mart:install is run.
  74
  75 ------------------------------------------------------------------------------
  76
  77 About Slices
  78 ================
  79
  80 Merb-Slices is a Merb plugin for using and creating application 'slices' which
  81 help you modularize your application. Usually these are reuseable extractions
  82 from your main app. In effect, a Slice is just like a regular Merb MVC
  83 application, both in functionality as well as in structure.
  84
  85 When you generate a Slice stub structure, a module is setup to serve as a
  86 namespace for your controller, models, helpers etc. This ensures maximum
  87 encapsulation. You could say a Slice is a mixture between a Merb plugin (a
  88 Gem) and a Merb application, reaping the benefits of both.
  89
  90 A host application can 'mount' a Slice inside the router, which means you have
  91 full over control how it integrates. By default a Slice's routes are prefixed
  92 by its name (a router :namespace), but you can easily provide your own prefix
  93 or leave it out, mounting it at the root of your url-schema. You can even
  94 mount a Slice multiple times and give extra parameters to customize an
  95 instance's behaviour.
  96
  97 A Slice's Application controller uses controller_for_slice to setup slice
  98 specific behaviour, which mainly affects cascaded view handling. Additionaly,
  99 this method is available to any kind of controller, so it can be used for
 100 Merb Mailer too for example.
 101
 102 There are many ways which let you customize a Slice's functionality and
 103 appearance without ever touching the Gem-level code itself. It's not only easy
 104 to add template/layout overrides, you can also add/modify controllers, models
 105 and other runtime code from within the host application.
 106
 107 To create your own Slice run this (somewhere outside of your merb app):
 108
 109 $ merb-gen slice <your-lowercase-slice-name>