merb-slices 0.9.7 → 0.9.8

data/spec/merb-slice_spec.rb

@@ -1,7 +1,101 @@
 require File.dirname(__FILE__) + '/spec_helper'
 
-describe "merb-slices" do
-  it "should do nothing" do
-    true.should == true
+describe Merb::Slices do
+  
+  before(:all) do
+    # Add the slice to the search path
+    Merb::Plugins.config[:merb_slices][:auto_register] = true
+    Merb::Plugins.config[:merb_slices][:search_path]   = File.dirname(__FILE__) / 'slices'
+    
+    Merb.start(
+      :testing => true, 
+      :adapter => 'runner', 
+      :environment => ENV['MERB_ENV'] || 'test',
+      :merb_root => Merb.root
+    )
   end
+  
+  before :all do
+    Merb::Router.prepare do 
+      all_slices
+    end
+  end
+  
+  after :all do
+    Merb::Router.reset!
+  end
+  
+  it "should be registered in Merb::Slices.slices" do
+    Merb::Slices.slices.should include(FullTestSlice)
+    Merb::Slices.slices.should include(ThinTestSlice)
+    Merb::Slices.slices.should include(VeryThinTestSlice)
+  end
+  
+end
+
+describe "The Merb::Router::Behavior methods" do
+    
+  before(:all) do
+    # Add the slice to the search path
+    Merb::Plugins.config[:merb_slices][:auto_register] = true
+    Merb::Plugins.config[:merb_slices][:search_path]   = File.dirname(__FILE__) / 'slices'
+
+    Merb.start(
+      :testing => true, 
+      :adapter => 'runner', 
+      :environment => ENV['MERB_ENV'] || 'test',
+      :merb_root => Merb.root
+    )
+  end
+  
+  before :all do
+    Merb::Router.prepare do 
+      add_slice(:FullTestSlice, :path_prefix => 'full') do |scope|
+        scope.match('/dashboard').to(:controller => 'main', :action => 'index').name(:dashboard)
+      end
+      add_slice(:thin_test_slice, 'thin') # shortcut for :path => 'thin'
+      slice(:very_thin_test_slice, :name_prefix => 'awesome', :params => { :foo => 'bar' })
+    end    
+  end
+  
+  after :all do
+    Merb::Router.reset!
+  end
+  
+  it "should add a slice's routes and provide access to the namespace through a block using #add_slice" do
+    Merb::Router.named_routes[:full_test_slice_default].inspect.should == '/full/:controller(/:action(/:id))(.:format)'
+    Merb::Router.named_routes[:full_test_slice_home].inspect.should == '/full/'
+    Merb::Router.named_routes[:full_test_slice_index].inspect.should == '/full/index(.:format)'
+    Merb::Router.named_routes[:full_test_slice_dashboard].inspect.should == '/full/dashboard'
+    
+    Merb::Router.named_routes[:full_test_slice_default].should == FullTestSlice.named_routes[:default]
+    Merb::Router.named_routes[:full_test_slice_index].should == FullTestSlice.named_routes[:index]
+    Merb::Router.named_routes[:full_test_slice_dashboard].should == FullTestSlice.named_routes[:dashboard]
+  end
+  
+  it "should add a slice's routes and provide a shortcut for setting the url prefix/path using #add_slice" do
+    Merb::Router.named_routes[:thin_test_slice_default].inspect.should == '/thin/:controller(/:action(/:id))(.:format)'
+    Merb::Router.named_routes[:thin_test_slice_default].should == ThinTestSlice.named_routes[:default]
+  end
+  
+  it "should mount a slice directly at the root using #slice" do
+    Merb::Router.named_routes[:awesome_default].inspect.should == '/:controller(/:action(/:id))(.:format)'
+    Merb::Router.named_routes[:awesome_default].should == VeryThinTestSlice.named_routes[:default]
+  end
+  
+  it "should allow default params to be set on a route" do
+    Merb::Router.named_routes[:awesome_default].params[:foo].should == '"bar"'
+  end
+  
+  it "enable url() and slice_url() respectively" do
+    controller = dispatch_to(FullTestSlice::Main, 'index')
+    controller.url(:full_test_slice_index, :format => 'html').should == '/full/index.html'
+    controller.slice_url(:full_test_slice, :index, :format => 'html').should == '/full/index.html'
+    controller.slice_url(:index, :format => 'html').should == '/full/index.html'
+    
+    controller.url(:full_test_slice_dashboard).should == '/full/dashboard'
+    controller.slice_url(:full_test_slice, :dashboard).should == '/full/dashboard'
+    controller.slice_url(:dashboard).should == '/full/dashboard'
+  end
+  
 end

data/spec/slice_generator_spec.rb

@@ -2,10 +2,22 @@ require File.dirname(__FILE__) + '/spec_helper'
 
 describe Merb::Generators::SliceGenerator do
   
-  it "should invoke the full generator by default"
+  it "should invoke the full generator by default" do
+    generator = Merb::Generators::SliceGenerator.new('/tmp', { :pretend => true }, 'testing')
+    generator.invoke!
+    generator.invocations.first.class.should == Merb::Generators::FullSliceGenerator
+  end
   
-  it "should invoke the flat generator if flat is true"
+  it "should invoke the flat generator if --thin is set" do
+    generator = Merb::Generators::SliceGenerator.new('/tmp', { :pretend => true, :thin => true }, 'testing')
+    generator.invoke!
+    generator.invocations.first.class.should == Merb::Generators::ThinSliceGenerator
+  end
   
-  it "should invoke the very flat generator if very flat is true"
+  it "should invoke the very flat generator if --very-thin is set" do
+    generator = Merb::Generators::SliceGenerator.new('/tmp', { :pretend => true, :very_thin => true }, 'testing')
+    generator.invoke!
+    generator.invocations.first.class.should == Merb::Generators::VeryThinSliceGenerator
+  end
   
 end

data/spec/slices/full-test-slice/LICENSE

@@ -0,0 +1,20 @@
+Copyright (c) 2008 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/spec/slices/full-test-slice/README

@@ -0,0 +1,170 @@
+FullTestSlice
+=============
+
+A slice for the Merb framework.
+
+------------------------------------------------------------------------------
+
+full-test-slice
+|-- LICENSE
+|-- README
+|-- Rakefile [1]
+|-- TODO
+|-- app [2]
+|   |-- controllers
+|   |   |-- application.rb
+|   |   `-- main.rb
+|   |-- helpers
+|   |   `-- application_helper.rb
+|   `-- views
+|       |-- layout
+|       |   `-- full-test-slice.html.erb [3]
+|       `-- main
+|           `-- index.html.erb
+|-- lib
+|   |-- full-test-slice
+|   |   |-- merbtasks.rb [4]
+|   |   `-- slicetasks.rb [5]
+|   `-- full-test-slice.rb [6]
+|-- log
+|   `-- merb_test.log
+|-- public [7]
+|   |-- javascripts 
+|   |   `-- master.js
+|   `-- stylesheets
+|       `-- master.css
+|-- spec [8]
+|   |-- full-test-slice_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[:full_test_slice][: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:full_test_slice: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:full_test_slice:stubs to
+   get started with the override stubs. Also, slices:full_test_slice:patch will
+   copy over views to override in addition to the files found in /stubs.
+   
+
+To see all available tasks for FullTestSlice run:
+
+rake -T slices:full_test_slice
+
+------------------------------------------------------------------------------
+
+Instructions for installation:
+
+file: config/init.rb
+
+# add the slice as a regular dependency
+
+dependency 'full-test-slice'
+
+# if needed, configure which slices to load and in which order
+
+Merb::Plugins.config[:merb_slices] = { :queue => ["FullTestSlice", ...] }
+
+# optionally configure the plugins in a before_app_loads callback
+
+Merb::BootLoader.before_app_loads do
+  
+  Merb::Slices::config[:full_test_slice][:option] = value
+  
+end
+
+file: config/router.rb
+
+# example: /full_test_slice/:controller/:action/:id
+
+add_slice(:FullTestSlice)
+
+# example: /foo/:controller/:action/:id
+
+add_slice(:FullTestSlice, 'foo') # same as :path => 'foo'
+
+# example: /:lang/:controller/:action/:id (with :a param set)
+
+add_slice(:FullTestSlice, :path => ':lang', :params => { :a => 'b' })
+
+# example: /:controller/:action/:id
+
+slice(:FullTestSlice)
+
+Normally you should also run the following rake task:
+
+rake slices:full_test_slice:install
+
+------------------------------------------------------------------------------
+
+You can put your application-level overrides in:
+
+host-app/slices/full-test-slice/app - controllers, models, views ...
+
+Templates are located in this order:
+
+1. host-app/slices/full-test-slice/app/views/*
+2. gems/full-test-slice/app/views/*
+3. host-app/app/views/*
+
+You can use the host application's layout by configuring the
+full-test-slice slice in a before_app_loads block:
+
+Merb::Slices.config[:full_test_slice] = { :layout => :application }
+
+By default :full_test_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/full-test-slice.
+
+In any case don't edit those files directly as they may be clobbered any time
+rake full_test_slice: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/spec/slices/full-test-slice/Rakefile

@@ -0,0 +1,67 @@
+require 'rubygems'
+require 'rake/gempackagetask'
+require 'spec/rake/spectask'
+
+require 'merb-core'
+require 'merb-core/tasks/merb'
+require 'merb-core/test/tasks/spectasks'
+
+GEM_NAME = "full-test-slice"
+AUTHOR = "Your Name"
+EMAIL = "Your Email"
+HOMEPAGE = "http://merbivore.com/"
+SUMMARY = "Merb Slice that provides ..."
+GEM_VERSION = "0.9.8"
+
+spec = Gem::Specification.new do |s|
+  s.rubyforge_project = 'merb'
+  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 = SUMMARY
+  s.description = s.summary
+  s.author = AUTHOR
+  s.email = EMAIL
+  s.homepage = HOMEPAGE
+  s.add_dependency('merb-slices', '>= 0.9.8')
+  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 the gem"
+task :install do
+  Merb::RakeHelper.install(GEM_NAME, :version => GEM_VERSION)
+end
+
+desc "Uninstall the gem"
+task :uninstall do
+  Merb::RakeHelper.uninstall(GEM_NAME, :version => GEM_VERSION)
+end
+
+desc "Create a gemspec file"
+task :gemspec do
+  File.open("#{GEM_NAME}.gemspec", "w") do |file|
+    file.puts spec.to_ruby
+  end
+end
+
+desc "Run all examples (or a specific spec with TASK=xxxx)"
+Spec::Rake::SpecTask.new('spec') do |t|
+  t.spec_opts  = ["-cfs"]
+  t.spec_files = begin
+    if ENV["TASK"] 
+      ENV["TASK"].split(',').map { |task| "spec/**/#{task}_spec.rb" }
+    else
+      FileList['spec/**/*_spec.rb']
+    end
+  end
+end
+
+desc 'Default: run spec examples'
+task :default => 'spec'

data/spec/slices/full-test-slice/TODO

@@ -0,0 +1,15 @@
+TODO:
+
+- Fix FullTestSlice.description and FullTestSlice.version
+- Fix LICENSE with your name
+- Fix Rakefile with your name and contact info
+- Add your code to lib/full-test-slice.rb
+- Add your Merb rake tasks to lib/full-test-slice/merbtasks.rb
+
+Remove anything that you don't need:
+
+- app/controllers/main.rb FullTestSlice::Main controller
+- app/views/layout/full-test-slice.html.erb
+- spec/controllers/main_spec.rb controller specs
+- public/* any public files
+- stubs/* any stub files

data/spec/slices/full-test-slice/app/controllers/application.rb

@@ -0,0 +1,5 @@
+class FullTestSlice::Application < Merb::Controller
+  
+  controller_for_slice
+  
+end

data/spec/slices/full-test-slice/app/controllers/main.rb

@@ -0,0 +1,7 @@
+class FullTestSlice::Main < FullTestSlice::Application
+  
+  def index
+    render
+  end
+  
+end

data/spec/slices/full-test-slice/app/helpers/application_helper.rb

@@ -0,0 +1,64 @@
+module Merb
+  module FullTestSlice
+    module ApplicationHelper
+      
+      # @param *segments<Array[#to_s]> Path segments to append.
+      #
+      # @return <String> 
+      #  A path relative to the public directory, with added segments.
+      def image_path(*segments)
+        public_path_for(:image, *segments)
+      end
+      
+      # @param *segments<Array[#to_s]> Path segments to append.
+      #
+      # @return <String> 
+      #  A path relative to the public directory, with added segments.
+      def javascript_path(*segments)
+        public_path_for(:javascript, *segments)
+      end
+      
+      # @param *segments<Array[#to_s]> Path segments to append.
+      #
+      # @return <String> 
+      #  A path relative to the public directory, with added segments.
+      def stylesheet_path(*segments)
+        public_path_for(:stylesheet, *segments)
+      end
+      
+      # Construct a path relative to the public directory
+      # 
+      # @param <Symbol> The type of component.
+      # @param *segments<Array[#to_s]> Path segments to append.
+      #
+      # @return <String> 
+      #  A path relative to the public directory, with added segments.
+      def public_path_for(type, *segments)
+        ::FullTestSlice.public_path_for(type, *segments)
+      end
+      
+      # Construct an app-level path.
+      # 
+      # @param <Symbol> The type of component.
+      # @param *segments<Array[#to_s]> Path segments to append.
+      #
+      # @return <String> 
+      #  A path within the host application, with added segments.
+      def app_path_for(type, *segments)
+        ::FullTestSlice.app_path_for(type, *segments)
+      end
+      
+      # Construct a slice-level path.
+      # 
+      # @param <Symbol> The type of component.
+      # @param *segments<Array[#to_s]> Path segments to append.
+      #
+      # @return <String> 
+      #  A path within the slice source (Gem), with added segments.
+      def slice_path_for(type, *segments)
+        ::FullTestSlice.slice_path_for(type, *segments)
+      end
+      
+    end
+  end
+end