@@ -1,5 +1,72 @@ Installation ============ + +Instructions for installation: + +file: config/init.rb + +# add the slice as a regular dependency + +dependency 'merb-E-mart' + +# if needed, configure which slices to load and in which order + +Merb::Plugins.config[:merb_slices] = { :queue => ["MerbEMart", ...] } + +# optionally configure the plugins in a before_app_loads callback + +Merb::BootLoader.before_app_loads do + + Merb::Slices::config[:merb_E_mart] = { ... } + +end + +file: config/router.rb + +# example: /merb-E-mart/:controller/:action/:id + +r.add_slice(:MerbEMart) + +# example: /foo/:controller/:action/:id + +r.add_slice(:MerbEMart, 'foo') # same as :path => 'foo' + +# example: /:lang/:controller/:action/:id (with :a param set) + +r.add_slice(:MerbEMart, :path => ':lang', :params => { :a => 'b' }) + +# example: /:controller/:action/:id + +r.slice(:MerbEMart) + +Normally you should also run the following rake task: + +rake slices:merb_E_mart:install + +------------------------------------------------------------------------------ + +You can put your application-level overrides in: + +host-app/slices/merb-E-mart/app - controllers, models, views ... + +Templates are located in this order: + +1. host-app/slices/merb-E-mart/app/views/* +2. gems/merb-E-mart/app/views/* +3. host-app/app/views/* + +You can use the host application's layout by configuring the +merb-E-mart slice in a before_app_loads block: + +Merb::Slices.config[:merb_E_mart] = { :layout => :application } + +By default :merb_E_mart is used. If you need to override +stylesheets or javascripts, just specify your own files in your layout +instead/in addition to the ones supplied (if any) in +host-app/public/slices/merb-E-mart. + +In any case don't edit those files directly as they may be clobbered any time +rake merb_E_mart:install is run. Dependencies ------------ @@ -48,10 +115,3 @@ To run all specs: You can also run individual groups of specs. To see tasks available to you: rake -T - -Installation ------------- - -Like any other Merb application, to startup the application: - - merb INSTALL @@ -1,112 +1,5 @@ MerbEMart ========= -Please see also README.markdown. - -A slice for the Merb framework. - ------------------------------------------------------------------------------- - -Instructions for installation: - -file: config/init.rb - -# add the slice as a regular dependency - -dependency 'merb-E-mart' - -# if needed, configure which slices to load and in which order - -Merb::Plugins.config[:merb_slices] = { :queue => ["MerbEMart", ...] } - -# optionally configure the plugins in a before_app_loads callback - -Merb::BootLoader.before_app_loads do - - Merb::Slices::config[:merb_E_mart] = { ... } - -end - -file: config/router.rb - -# example: /merb-E-mart/:controller/:action/:id - -r.add_slice(:MerbEMart) - -# example: /foo/:controller/:action/:id - -r.add_slice(:MerbEMart, 'foo') # same as :path => 'foo' - -# example: /:lang/:controller/:action/:id (with :a param set) - -r.add_slice(:MerbEMart, :path => ':lang', :params => { :a => 'b' }) - -# example: /:controller/:action/:id - -r.slice(:MerbEMart) - -Normally you should also run the following rake task: - -rake slices:merb_E_mart:install - ------------------------------------------------------------------------------- - -You can put your application-level overrides in: - -host-app/slices/merb-E-mart/app - controllers, models, views ... - -Templates are located in this order: - -1. host-app/slices/merb-E-mart/app/views/* -2. gems/merb-E-mart/app/views/* -3. host-app/app/views/* - -You can use the host application's layout by configuring the -merb-E-mart slice in a before_app_loads block: - -Merb::Slices.config[:merb_E_mart] = { :layout => :application } - -By default :merb_E_mart is used. If you need to override -stylesheets or javascripts, just specify your own files in your layout -instead/in addition to the ones supplied (if any) in -host-app/public/slices/merb-E-mart. - -In any case don't edit those files directly as they may be clobbered any time -rake merb_E_mart:install is run. - ------------------------------------------------------------------------------- - -About Slices -================ - -Merb-Slices is a Merb plugin for using and creating application 'slices' which -help you modularize your application. Usually these are reuseable extractions -from your main app. In effect, a Slice is just like a regular Merb MVC -application, both in functionality as well as in structure. - -When you generate a Slice stub structure, a module is setup to serve as a -namespace for your controller, models, helpers etc. This ensures maximum -encapsulation. You could say a Slice is a mixture between a Merb plugin (a -Gem) and a Merb application, reaping the benefits of both. - -A host application can 'mount' a Slice inside the router, which means you have -full over control how it integrates. By default a Slice's routes are prefixed -by its name (a router :namespace), but you can easily provide your own prefix -or leave it out, mounting it at the root of your url-schema. You can even -mount a Slice multiple times and give extra parameters to customize an -instance's behaviour. - -A Slice's Application controller uses controller_for_slice to setup slice -specific behaviour, which mainly affects cascaded view handling. Additionaly, -this method is available to any kind of controller, so it can be used for -Merb Mailer too for example. - -There are many ways which let you customize a Slice's functionality and -appearance without ever touching the Gem-level code itself. It's not only easy -to add template/layout overrides, you can also add/modify controllers, models -and other runtime code from within the host application. - -To create your own Slice run this (somewhere outside of your merb app): - -$ merb-gen slice <your-lowercase-slice-name> - +Merb eMart is an *open-source e-commerce engine* slice for the Merb framework. +Please see README.markdown. README @@ -1,19 +1,27 @@ Merb eMart README ================= -Merb eMart is an *open-source e-commerce application*, developed on top of the -recent Ruby-language Merb MVC framework. Although Merb eMart is designed for -e-commerce sites of all sizes, the speed and scalability of the Merb framework -make it scalable even for large online vendors. +Merb eMart is an *open-source e-commerce engine*, developed on top of the recent +Ruby-language, Merb MVC framework. It takes advantage of the Merb's slices +plugin, allowing you to incorporate the engine into a customized e-commerce +solution. -In addition to Merb framework, the following technologies and frameworks -provide a foundation for Merb eMart: +Performance +----------- - * **DataMapper** (bleeding-edge 0.9), for object relation mapping (ORM) and - persistence. - * **RSpec**, for behavio(u)r driven development (BDD). +_Mom and Pop?.. or Big Box?_ + +A key goal for the Merb eMart engine is performance. Although Merb eMart is +designed for e-commerce sites of all sizes, the speed and scalability of the +Merb and DataMapper frameworks make it scalable even for large online vendors. + +The following technologies and frameworks provide a foundation for Merb eMart: + + * **Merb**, for Model-View-Controller. + * **DataMapper**, for object relation mapping (ORM) and persistence. * **ActiveMerchant**, for Credit Card, payment and shipping processing. as well as attachmerb\_fu, merb\_paginate. + * **RSpec**, for behavio(u)r driven development (BDD). See INSTALL or the project wiki for a full list of dependencies. @@ -24,6 +32,41 @@ instead be a its own implementation of an e-commerce engine, trying to match the feature sets other e-commerce applications, but taking advantages of the unique features of Merb and DataMapper. +About Slices +------------ + +Merb-Slices is a Merb plugin for using and creating application 'slices' which +help you modularize your application. Usually these are reuseable extractions +from your main app. In effect, a Slice is just like a regular Merb MVC +application, both in functionality as well as in structure. + +When you generate a Slice stub structure, a module is setup to serve as a +namespace for your controller, models, helpers etc. This ensures maximum +encapsulation. You could say a Slice is a mixture between a Merb plugin (a +Gem) and a Merb application, reaping the benefits of both. + +A host application can 'mount' a Slice inside the router, which means you have +full over control how it integrates. By default a Slice's routes are prefixed +by its name (a router :namespace), but you can easily provide your own prefix +or leave it out, mounting it at the root of your url-schema. You can even +mount a Slice multiple times and give extra parameters to customize an +instance's behaviour. + +A Slice's Application controller uses controller\_for\_slice to setup slice +specific behaviour, which mainly affects cascaded view handling. Additionaly, +this method is available to any kind of controller, so it can be used for +Merb Mailer too for example. + +There are many ways which let you customize a Slice's functionality and +appearance without ever touching the Gem-level code itself. It's not only easy +to add template/layout overrides, you can also add/modify controllers, models +and other runtime code from within the host application. + +Installation and Setup +---------------------- + +Please see the INSTALL file for details on getting up and running with Merb eMart. + Developer Notes --------------- @@ -52,11 +95,6 @@ The following additional mirrors are available: git://repo.or.cz/merb_mart.git http://repo.or.cz/r/merb_mart.git -Installation and Setup ----------------------- - -Please see the INSTALL file for details on getting up and running with Merb eMart. - Copyright and License --------------------- README.markdown @@ -3,28 +3,20 @@ require 'spec/rake/spectask' require 'merb-core/version' require 'merb-core/test/tasks/spectasks' -PLUGIN = "merb_e_mart" -NAME = "merb_e_mart" -AUTHOR = "Your Name" -EMAIL = "Your Email" -HOMEPAGE = "http://merbivore.com/" -SUMMARY = "Merb Slice that provides ..." -VERSION = "0.9.4" - spec = Gem::Specification.new do |s| - s.name = NAME - s.version = VERSION - s.platform = Gem::Platform::RUBY - s.has_rdoc = true - s.extra_rdoc_files = ["README", "GPL-LICENSE", 'TODO'] - s.summary = SUMMARY - s.description = s.summary - s.author = AUTHOR - s.email = EMAIL - s.homepage = HOMEPAGE + s.name = 'merb_e_mart' + s.version = '0.0.1' + s.platform = Gem::Platform::RUBY + s.has_rdoc = true + s.extra_rdoc_files = ["README.markdown", "GPL-LICENSE", 'TODO'] + s.summary = 'An open-source e-commerce engine slice for the Merb framework' + s.description = s.summary + s.author = 'Alex Coles' + s.email = 'alex@alexcolesportfolio.com' + s.homepage = 'http://github.com/myabc/merb_mart/tree/master' + s.require_path = 'lib' + s.files = %w(GPL-LICENSE README.markdown Rakefile TODO) + Dir.glob("{lib,spec,app,public}/**/*") s.add_dependency('merb-slices', '>= 0.9.4') - s.require_path = 'lib' - s.files = %w(LICENSE README Rakefile TODO) + Dir.glob("{lib,spec,app,public}/**/*") end Rake::GemPackageTask.new(spec) do |pkg| Rakefile @@ -3,14 +3,14 @@ %head %title= @title unless @title.nil? %meta{ :content => "text/html; charset=utf-8", "http-equiv" => "content-type" } - %meta{ :generator => "MerbMart" } + %meta{ :generator => "Merb eMart" } = css_include_tag :master = include_required_css = include_required_js %body #container #header - %h1 MerbMart + %h1 Merb eMart #navigation %ul %li @@ -18,5 +18,5 @@ #content = catch_content :for_layout #footer - %p Powered by MerbMart, Merb and DataMapper. + %p Powered by Merb eMart, Merb and DataMapper. %p Copyright &copy; 2008, Alex Coles. app/views/layout/application.html.haml @@ -1 +1 @@ -This is the frontpage of the MerbMart store. +This is the frontpage of the Merb eMart store. app/views/store/index.html.haml bb986e0a00a0fc807c96cb669ccfb5dad5c5318b Alex Coles alexbcoles@mac.com http://github.com/myabc/merb_mart/commit/409c08cc360d93260ad69a173f0516b77e8f9588 409c08cc360d93260ad69a173f0516b77e8f9588 2008-05-31T06:49:57-07:00 2008-05-31T06:49:57-07:00 Updating Rakefile and README docs. * Moving README content into README.markdown, INSTALL docs * Renaming project to Merb eMart in HAML templates. 90dd4df867365f248f6405fd5a3b87886aa8fc6a Alex Coles alexbcoles@mac.com