merb-slices 0.9.4

data/Generators

@@ -0,0 +1,4 @@
+scope 'merb-gen' do
+  dir = File.join(File.dirname(__FILE__), 'lib', 'generators/')
+  Merb.add_generators dir + 'base', dir + 'full', dir + 'thin', dir + 'very_thin'
+end

data/LICENSE

@@ -0,0 +1,20 @@
+Copyright (c) 2008 Fabien Franzen <info@loobmedia.com>
+
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+"Software"), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
+LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
+WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/README

@@ -0,0 +1,102 @@
+Merb-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>
+
+------------------------------------------------------------------------------
+
+Instructions for installation of an imaginary 'BlogSlice' slice:
+
+file: config/init.rb
+
+# add the slice as a regular dependency
+
+dependency 'blog-slice'
+
+# if needed, configure which slices to load and in which order
+
+Merb::Plugins.config[:merb_slices] = { :queue => ["BlogSlice", ...] }
+
+# optionally configure the plugins in a before_app_loads callback
+
+Merb::BootLoader.before_app_loads do
+  
+  Merb::Slices::config[:blog_slice] = { ... }
+  
+end
+
+file: config/router.rb
+
+# example: /blog-slice/:controller/:action/:id
+
+r.add_slice(:BlogSlice)
+
+# example: /foo/:controller/:action/:id
+
+r.add_slice(:BlogSlice, 'foo') # same as :path => 'foo'
+
+# example: /:lang/:controller/:action/:id (with :a param set)
+
+r.add_slice(:BlogSlice, :path => ':lang', :params => { :a => 'b' })
+
+# example: /:controller/:action/:id
+
+r.slice(:BlogSlice)
+
+Normally you should also run the following rake task:
+
+rake slices:blog_slice:install
+
+------------------------------------------------------------------------------
+
+You can put your application-level overrides in:
+
+host-app/slices/blog-slice/app - controllers, models, views ...
+
+Templates are located in this order:
+
+1. host-app/slices/blog-slice/app/views/*
+2. gems/blog-slice/app/views/*
+3. host-app/app/views/*
+
+You can use the host application's layout by configuring the
+blog-slice slice in a before_app_loads block:
+
+Merb::Slices.config[:blog_slice] = { :layout => :application }
+
+By default :blog_slice 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/blog-slice.
+
+In any case don't edit those files directly as they may be clobbered any time
+rake blog_slice:install is run.

data/Rakefile

@@ -0,0 +1,65 @@
+require 'rubygems'
+require 'rake/gempackagetask'
+require "extlib"
+require 'merb-core/tasks/merb_rake_helper'
+require "spec/rake/spectask"
+
+##############################################################################
+# Package && release
+##############################################################################
+RUBY_FORGE_PROJECT  = "merb"
+PROJECT_URL         = "http://merbivore.com"
+PROJECT_SUMMARY     = "Merb-Slices is a Merb plugin for using and creating application 'slices' which help you modularize your application."
+PROJECT_DESCRIPTION = PROJECT_SUMMARY
+
+GEM_AUTHOR = "Fabien Franzen"
+GEM_EMAIL  = "info@fabien.be"
+
+GEM_NAME    = "merb-slices"
+PKG_BUILD   = ENV['PKG_BUILD'] ? '.' + ENV['PKG_BUILD'] : ''
+GEM_VERSION = (Merb::MORE_VERSION rescue "0.9.4") + PKG_BUILD
+
+RELEASE_NAME    = "REL #{GEM_VERSION}"
+
+require "extlib/tasks/release"
+
+spec = Gem::Specification.new do |s|
+  s.rubyforge_project = RUBY_FORGE_PROJECT
+  s.name = GEM_NAME
+  s.version = GEM_VERSION
+  s.platform = Gem::Platform::RUBY
+  s.has_rdoc = true
+  s.extra_rdoc_files = ["README", "LICENSE", 'TODO']
+  s.summary = PROJECT_SUMMARY
+  s.description = PROJECT_DESCRIPTION
+  s.author = GEM_AUTHOR
+  s.email = GEM_EMAIL
+  s.homepage = PROJECT_URL
+  s.add_dependency('merb-core', '>= 0.9.4')
+  s.require_path = 'lib'
+  s.files = %w(LICENSE README Rakefile Generators TODO) + Dir.glob("{lib,spec}/**/*")
+end
+
+Rake::GemPackageTask.new(spec) do |pkg|
+  pkg.gem_spec = spec
+end
+
+desc "Install the gem"
+task :install => [:package] do
+  sh %{#{sudo} gem install #{install_home} pkg/#{GEM_NAME}-#{GEM_VERSION} --no-update-sources}
+end
+
+namespace :jruby do
+
+  desc "Run :package and install the resulting .gem with jruby"
+  task :install => :package do
+    sh %{#{sudo} jruby -S gem install #{install_home} pkg/#{GEM_NAME}-#{GEM_VERSION}.gem --no-rdoc --no-ri}
+  end
+
+end
+
+desc "Run all specs"
+Spec::Rake::SpecTask.new("specs") do |t|
+  t.spec_opts = ["--format", "specdoc", "--colour"]
+  t.spec_files = Dir["spec/**/*_spec.rb"].sort
+end

data/lib/generators/base.rb

@@ -0,0 +1,21 @@
+module Merb::Generators
+  
+  class SliceGenerator < Generator
+    
+    option :thin, :as => :boolean, :desc => 'Generates a thin slice'
+    option :very_thin, :as => :boolean, :desc => 'Generates an even thinner slice'
+    
+    desc <<-DESC
+      Generates a merb slice.
+    DESC
+    
+    first_argument :name, :required => true
+    
+    invoke :full_slice, :thin => nil, :very_thin => nil
+    invoke :thin_slice, :thin => true
+    invoke :very_thin_slice, :very_thin => true
+  end
+  
+  add :slice, SliceGenerator
+  
+end

data/lib/generators/full.rb

@@ -0,0 +1,21 @@
+module Merb::Generators
+  
+  class FullSliceGenerator < NamedGenerator
+
+    def self.source_root
+      File.join(File.dirname(__FILE__), 'templates', 'full')
+    end
+    
+    glob!
+    
+    first_argument :name, :required => true
+    
+    def destination_root
+      File.join(@destination_root, base_name)
+    end
+    
+  end
+  
+  add_private :full_slice, FullSliceGenerator
+  
+end

data/lib/generators/templates/full/LICENSE

@@ -0,0 +1,20 @@
+Copyright (c) <%= Time.now.year %> YOUR NAME
+
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+"Software"), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
+LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
+WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/lib/generators/templates/full/README

@@ -0,0 +1,170 @@
+<%= module_name %>
+<%= "=" * module_name.size %>
+
+A slice for the Merb framework.
+
+------------------------------------------------------------------------------
+
+<%= base_name %>
+|-- LICENSE
+|-- README
+|-- Rakefile [1]
+|-- TODO
+|-- app [2]
+|   |-- controllers
+|   |   |-- application.rb
+|   |   `-- main.rb
+|   |-- helpers
+|   |   `-- application_helper.rb
+|   `-- views
+|       |-- layout
+|       |   `-- <%= base_name %>.html.erb [3]
+|       `-- main
+|           `-- index.html.erb
+|-- lib
+|   |-- <%= base_name %>
+|   |   |-- merbtasks.rb [4]
+|   |   `-- slicetasks.rb [5]
+|   `-- <%= base_name %>.rb [6]
+|-- log
+|   `-- merb_test.log
+|-- public [7]
+|   |-- javascripts 
+|   |   `-- master.js
+|   `-- stylesheets
+|       `-- master.css
+|-- spec [8]
+|   |-- <%= base_name %>_spec.rb
+|   |-- controllers
+|   |   `-- main_spec.rb
+|   `-- spec_helper.rb
+`-- stubs [9]
+    `-- app
+        `-- controllers
+            |-- application.rb
+            `-- main.rb
+
+
+1. Rake tasks to package/install the gem - edit this to modify the manifest.
+2. The slice application: controllers, models, helpers, views.
+3. The default layout, as specified in Merb::Slices::config[:<%= symbol_name %>][:layout]
+   change this to :application to use the app's layout.
+4. Standard rake tasks available to your application.
+5. Your custom application rake tasks.
+6. The main slice file - contains all slice setup logic/config.
+7. Public assets you (optionally) install using rake slices:<%= symbol_name %>:install
+8. Specs for basis slice behaviour - you usually adapt these for your slice.
+9. Stubs of classes/views/files for the end-user to override - usually these 
+   mimic the files in app/ and/or public/; use rake slices:<%= symbol_name %>:stubs to
+   get started with the override stubs. Also, slices:<%= symbol_name %>:patch will
+   copy over views to override in addition to the files found in /stubs.
+   
+
+To see all available tasks for <%= module_name %> run:
+
+rake -T slices:<%= symbol_name %>
+
+------------------------------------------------------------------------------
+
+Instructions for installation:
+
+file: config/init.rb
+
+# add the slice as a regular dependency
+
+dependency '<%= base_name %>'
+
+# if needed, configure which slices to load and in which order
+
+Merb::Plugins.config[:merb_slices] = { :queue => ["<%= module_name %>", ...] }
+
+# optionally configure the plugins in a before_app_loads callback
+
+Merb::BootLoader.before_app_loads do
+  
+  Merb::Slices::config[:<%= symbol_name %>][:option] = value
+  
+end
+
+file: config/router.rb
+
+# example: /<%= symbol_name %>/:controller/:action/:id
+
+r.add_slice(:<%= module_name %>)
+
+# example: /foo/:controller/:action/:id
+
+r.add_slice(:<%= module_name %>, 'foo') # same as :path => 'foo'
+
+# example: /:lang/:controller/:action/:id (with :a param set)
+
+r.add_slice(:<%= module_name %>, :path => ':lang', :params => { :a => 'b' })
+
+# example: /:controller/:action/:id
+
+r.slice(:<%= module_name %>)
+
+Normally you should also run the following rake task:
+
+rake slices:<%= symbol_name %>:install
+
+------------------------------------------------------------------------------
+
+You can put your application-level overrides in:
+
+host-app/slices/<%= base_name %>/app - controllers, models, views ...
+
+Templates are located in this order:
+
+1. host-app/slices/<%= base_name %>/app/views/*
+2. gems/<%= base_name %>/app/views/*
+3. host-app/app/views/*
+
+You can use the host application's layout by configuring the
+<%= base_name %> slice in a before_app_loads block:
+
+Merb::Slices.config[:<%= symbol_name %>] = { :layout => :application }
+
+By default :<%= symbol_name %> 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/<%= base_name %>.
+
+In any case don't edit those files directly as they may be clobbered any time
+rake <%= symbol_name %>: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>

data/lib/generators/templates/full/Rakefile

@@ -0,0 +1,48 @@
+require 'rubygems'
+require 'rake/gempackagetask'
+require 'spec/rake/spectask'
+require 'merb-core/version'
+require 'merb-core/test/tasks/spectasks'
+require 'merb-core/tasks/merb_rake_helper'
+
+NAME = "<%= base_name %>"
+AUTHOR = "Your Name"
+EMAIL = "Your Email"
+HOMEPAGE = "http://merbivore.com/"
+SUMMARY = "Merb Slice that provides ..."
+GEM_VERSION = "<%= Merb::VERSION %>"
+
+spec = Gem::Specification.new do |s|
+  s.rubyforge_project = 'merb'
+  s.name = NAME
+  s.version = GEM_VERSION
+  s.platform = Gem::Platform::RUBY
+  s.has_rdoc = true
+  s.extra_rdoc_files = ["README", "LICENSE", 'TODO']
+  s.summary = SUMMARY
+  s.description = s.summary
+  s.author = AUTHOR
+  s.email = EMAIL
+  s.homepage = HOMEPAGE
+  s.add_dependency('merb-slices', '>= <%= Merb::VERSION %>')
+  s.require_path = 'lib'
+  s.files = %w(LICENSE README Rakefile TODO) + Dir.glob("{lib,spec,app,public,stubs}/**/*")
+end
+
+Rake::GemPackageTask.new(spec) do |pkg|
+  pkg.gem_spec = spec
+end
+
+desc "Install <%= module_name %> as a gem"
+task :install => [:package] do
+  sh %{#{sudo} gem install pkg/#{NAME}-#{GEM_VERSION} --no-update-sources}
+end
+
+namespace :jruby do
+
+  desc "Run :package and install the resulting .gem with jruby"
+  task :install => :package do
+    sh %{#{sudo} jruby -S gem install #{install_home} pkg/#{NAME}-#{GEM_VERSION}.gem --no-rdoc --no-ri}
+  end
+  
+end