merb-slices 0.9.4

data/lib/generators/templates/full/spec/controllers/main_spec.rb

@@ -0,0 +1,61 @@
+require File.dirname(__FILE__) + '/../spec_helper'
+
+describe "<%= module_name %>::Main (controller)" do
+  
+  # Feel free to remove the specs below
+  
+  before :all do
+    Merb::Router.prepare { |r| r.add_slice(:<%= module_name %>) } if standalone?
+  end
+  
+  after :all do
+    Merb::Router.reset! if standalone?
+  end
+  
+  it "should have access to the slice module" do
+    controller = dispatch_to(<%= module_name %>::Main, :index)
+    controller.slice.should == <%= module_name %>
+    controller.slice.should == <%= module_name %>::Main.slice
+  end
+  
+  it "should have an index action" do
+    controller = dispatch_to(<%= module_name %>::Main, :index)
+    controller.status.should == 200
+    controller.body.should contain('<%= module_name %>')
+  end
+  
+  it "should work with the default route" do
+    controller = get("/<%= base_name %>/main/index")
+    controller.should be_kind_of(<%= module_name %>::Main)
+    controller.action_name.should == 'index'
+  end
+  
+  it "should work with the example named route" do
+    controller = get("/<%= base_name %>/index.html")
+    controller.should be_kind_of(<%= module_name %>::Main)
+    controller.action_name.should == 'index'
+  end
+  
+  it "should have routes in <%= module_name %>.routes" do
+    <%= module_name %>.routes.should_not be_empty
+  end
+  
+  it "should have a slice_url helper method for slice-specific routes" do
+    controller = dispatch_to(<%= module_name %>::Main, 'index')
+    controller.slice_url(:action => 'show', :format => 'html').should == "/<%= base_name %>/main/show.html"
+    controller.slice_url(:<%= symbol_name %>_index, :format => 'html').should == "/<%= base_name %>/index.html"
+  end
+  
+  it "should have helper methods for dealing with public paths" do
+    controller = dispatch_to(<%= module_name %>::Main, :index)
+    controller.public_path_for(:image).should == "/slices/<%= base_name %>/images"
+    controller.public_path_for(:javascript).should == "/slices/<%= base_name %>/javascripts"
+    controller.public_path_for(:stylesheet).should == "/slices/<%= base_name %>/stylesheets"
+  end
+  
+  it "should have a slice-specific _template_root" do
+    <%= module_name %>::Main._template_root.should == <%= module_name %>.dir_for(:view)
+    <%= module_name %>::Main._template_root.should == <%= module_name %>::Application._template_root
+  end
+
+end

data/lib/generators/templates/full/spec/spec_helper.rb

@@ -0,0 +1,44 @@
+require 'rubygems'
+require 'merb-core'
+require 'merb-slices'
+require 'spec'
+
+# Add <%= base_name %>.rb to the search path
+Merb::Plugins.config[:merb_slices][:auto_register] = true
+Merb::Plugins.config[:merb_slices][:search_path]   = File.join(File.dirname(__FILE__), '..', 'lib', '<%= base_name %>.rb')
+
+# Using Merb.root below makes sure that the correct root is set for
+# - testing standalone, without being installed as a gem and no host application
+# - testing from within the host application; its root will be used
+Merb.start_environment(
+  :testing => true, 
+  :adapter => 'runner', 
+  :environment => ENV['MERB_ENV'] || 'test',
+  :merb_root => Merb.root,
+  :session_store => 'memory'
+)
+
+module Merb
+  module Test
+    module SliceHelper
+      
+      # The absolute path to the current slice
+      def current_slice_root
+        @current_slice_root ||= File.expand_path(File.join(File.dirname(__FILE__), '..'))
+      end
+      
+      # Whether the specs are being run from a host application or standalone
+      def standalone?
+        Merb.root == ::<%= module_name %>.root
+      end
+      
+    end
+  end
+end
+
+Spec::Runner.configure do |config|
+  config.include(Merb::Test::ViewHelper)
+  config.include(Merb::Test::RouteHelper)
+  config.include(Merb::Test::ControllerHelper)
+  config.include(Merb::Test::SliceHelper)
+end

data/lib/generators/templates/full/stubs/app/controllers/application.rb

@@ -0,0 +1,2 @@
+class <%= module_name %>::Application < Merb::Controller
+end

data/lib/generators/templates/full/stubs/app/controllers/main.rb

@@ -0,0 +1,2 @@
+class <%= module_name %>::Main < <%= module_name %>::Application
+end

data/lib/generators/templates/thin/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/thin/README

@@ -0,0 +1,130 @@
+<%= module_name %>
+<%= "=" * module_name.size %>
+
+A thin slice for the Merb framework.
+
+------------------------------------------------------------------------------
+
+<%= base_name %>
+|-- LICENSE
+|-- README
+|-- Rakefile [1]
+|-- TODO
+|-- application.rb [2]
+|-- lib
+|   |-- <%= base_name %>
+|   |   |-- merbtasks.rb [3]
+|   |   `-- slicetasks.rb [4]
+|   `-- <%= base_name %>.rb [5]
+|-- public [6]
+|   |-- javascripts
+|   |   `-- master.js
+|   `-- stylesheets
+|       `-- master.css
+|-- stubs [7]
+|   `-- application.rb
+`-- views [8]
+    |-- layout
+    |   `-- <%= base_name %>.html.erb [9]
+    `-- main
+        `-- index.html.erb
+
+
+1. Rake tasks to package/install the gem - edit this to modify the manifest.
+2. The slice application in a single file: controllers, models, helper methods.
+3. Standard rake tasks available to your application.
+4. Your custom application rake tasks.
+5. The main slice file - contains all slice setup logic/config.
+6. Public assets you (optionally) install using rake slices:my_slice:install
+7. Stubs of classes/views/files for the end-user to override - usually these 
+   mimic the files in app/ and/or public/; use rake slices:<%= base_name %>:stubs to
+   get started with the override stubs. Also, slices:<%= base_name %>:patch will
+   copy over views to override in addition to the files found in /stubs.
+8. A thin slice stores its views seperately.
+9. The default layout, as specified in Merb::Slices::config[:my_slice][:layout]
+   change this to :application to use the app's layout.
+   
+   
+To see all available tasks for <%= module_name %> run:
+
+rake -T slices:<%= base_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: /<%= base_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
+
+------------------------------------------------------------------------------
+
+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/thin/Rakefile

@@ -0,0 +1,46 @@
+require 'rubygems'
+require 'rake/gempackagetask'
+require 'merb-core/version'
+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 application.rb) + Dir.glob("{lib,public,views,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

data/lib/generators/templates/thin/TODO

@@ -0,0 +1,7 @@
+TODO:
+
+- Fix <%= module_name %>.description and <%= module_name %>.version
+- Fix LICENSE with your name
+- Fix Rakefile with your name and contact info
+- Add your code to lib/<%= base_name %>.rb
+- Add your Merb rake tasks to lib/<%= base_name %>/merbtasks.rb

data/lib/generators/templates/thin/application.rb

@@ -0,0 +1,36 @@
+module <%= module_name %>
+  
+  # All Slice code is expected to be namespaced inside this module.
+  
+  class Application < Merb::Controller
+    
+    controller_for_slice
+    
+    private
+    
+    # Construct a path relative to the public directory
+    def public_path_for(type, *segments)
+      ::<%= module_name %>.public_path_for(type, *segments)
+    end
+    
+    # Construct an app-level path.
+    def app_path_for(type, *segments)
+      ::<%= module_name %>.app_path_for(type, *segments)
+    end
+    
+    # Construct a slice-level path
+    def slice_path_for(type, *segments)
+      ::<%= module_name %>.slice_path_for(type, *segments)
+    end
+    
+  end
+  
+  class Main < Application
+    
+    def index
+      render
+    end
+    
+  end
+  
+end

data/lib/generators/templates/thin/lib/%base_name%.rb

@@ -0,0 +1,93 @@
+if defined?(Merb::Plugins)
+
+  $:.unshift File.dirname(__FILE__)
+
+  load_dependency 'merb-slices'
+  Merb::Plugins.add_rakefiles "<%= base_name %>/merbtasks", "<%= base_name %>/slicetasks"
+
+  # Register the Slice for the current host application
+  Merb::Slices::register(__FILE__)
+  
+  # Slice configuration - set this in a before_app_loads callback.
+  # By default a Slice uses its own layout.
+  Merb::Slices::config[:<%= symbol_name %>][:layout] ||= :<%= symbol_name %>
+  
+  # All Slice code is expected to be namespaced inside a module
+  module <%= module_name %>
+    
+    # Slice metadata
+    self.description = "<%= module_name %> is a thin Merb slice!"
+    self.version = "0.0.1"
+    self.author = "YOUR NAME"
+    
+    # Stub classes loaded hook - runs before LoadClasses BootLoader
+    # right after a slice's classes have been loaded internally.
+    def self.loaded
+    end
+    
+    # Initialization hook - runs before AfterAppLoads BootLoader
+    def self.init
+    end
+    
+    # Activation hook - runs after AfterAppLoads BootLoader
+    def self.activate
+    end
+    
+    # Deactivation hook - triggered by Merb::Slices.deactivate(<%= module_name %>)
+    def self.deactivate
+    end
+    
+    # Setup routes inside the host application
+    #
+    # @param scope<Merb::Router::Behaviour>
+    #  Routes will be added within this scope (namespace). In fact, any 
+    #  router behaviour is a valid namespace, so you can attach
+    #  routes at any level of your router setup.
+    #
+    # @note prefix your named routes with :<%= symbol_name %>_
+    #   to avoid potential conflicts with global named routes.
+    def self.setup_router(scope)
+    end
+    
+    # This sets up a thin slice's structure.
+    def self.setup_default_structure!
+      self.push_app_path(:root, Merb.root / 'slices' / self.identifier, nil)
+      
+      self.push_path(:stub, root_path('stubs'), nil)
+      self.push_app_path(:stub, app_dir_for(:root), nil)
+      
+      self.push_path(:application, root, 'application.rb')
+      self.push_app_path(:application, app_dir_for(:root), 'application.rb')
+      
+      self.push_path(:view, dir_for(:application) / "views")
+      self.push_app_path(:view, app_dir_for(:application) / "views")
+      
+      self.push_path(:public, root_path('public'), nil)
+      self.push_app_path(:public, Merb.root / 'public' / 'slices' / self.identifier, nil)
+      
+      public_components.each do |component|
+        self.push_path(component, dir_for(:public) / "#{component}s", nil)
+        self.push_app_path(component, app_dir_for(:public) / "#{component}s", nil)
+      end
+    end
+    
+  end
+  
+  # Setup the slice layout for <%= module_name %>
+  #
+  # Use <%= module_name %>.push_path and <%= module_name %>.push_app_path
+  # to set paths to <%= base_name %>-level and app-level paths. Example:
+  #
+  # <%= module_name %>.push_path(:application, <%= module_name %>.root)
+  # <%= module_name %>.push_app_path(:application, Merb.root / 'slices' / '<%= base_name %>')
+  # ...
+  #
+  # Any component path that hasn't been set will default to <%= module_name %>.root
+  #
+  # For a thin slice we just add application.rb, :view and :public locations.
+  <%= module_name %>.setup_default_structure!
+  
+  # Add dependencies for other <%= module_name %> classes below. Example:
+  # dependency "<%= base_name %>/other"
+  
+end