merb-slices 0.9.7 → 0.9.8

data/README

@@ -58,19 +58,19 @@ file: config/router.rb
 
 # example: /blog-slice/:controller/:action/:id
 
-r.add_slice(:BlogSlice)
+add_slice(:BlogSlice)
 
 # example: /foo/:controller/:action/:id
 
-r.add_slice(:BlogSlice, 'foo') # same as :path => 'foo'
+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' })
+add_slice(:BlogSlice, :path => ':lang', :params => { :a => 'b' })
 
 # example: /:controller/:action/:id
 
-r.slice(:BlogSlice)
+slice(:BlogSlice)
 
 Normally you should also run the following rake task:
 

data/Rakefile

@@ -17,7 +17,7 @@ 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.7") + PKG_BUILD
+GEM_VERSION = (Merb::MORE_VERSION rescue "0.9.8") + PKG_BUILD
 
 RELEASE_NAME    = "REL #{GEM_VERSION}"
 
@@ -35,9 +35,11 @@ spec = Gem::Specification.new do |s|
   s.author = GEM_AUTHOR
   s.email = GEM_EMAIL
   s.homepage = PROJECT_URL
-  s.add_dependency('merb-core', '>= 0.9.7')
+  s.add_dependency('merb-core', '>= 0.9.8')
   s.require_path = 'lib'
   s.files = %w(LICENSE README Rakefile Generators TODO) + Dir.glob("{lib,spec}/**/*")
+  s.bindir = "bin"
+  s.executables = %w( slice )
 end
 
 Rake::GemPackageTask.new(spec) do |pkg|
@@ -45,21 +47,33 @@ Rake::GemPackageTask.new(spec) do |pkg|
 end
 
 desc "Install the gem"
-task :install => [:package] do
-  sh install_command(GEM_NAME, GEM_VERSION)
+task :install do
+  Merb::RakeHelper.install(GEM_NAME, :version => GEM_VERSION)
 end
 
-namespace :jruby do
+desc "Uninstall the gem"
+task :uninstall do
+  Merb::RakeHelper.uninstall(GEM_NAME, :version => GEM_VERSION)
+end
 
-  desc "Run :package and install the resulting .gem with jruby"
-  task :install => :package do
-    sh jinstall_command(GEM_NAME, GEM_VERSION)
+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 specs"
-Spec::Rake::SpecTask.new("specs") do |t|
-  t.spec_opts = ["--format", "specdoc", "--colour"]
-  t.spec_files = Dir["spec/**/*_spec.rb"].sort
+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/TODO

@@ -1,2 +1 @@
-Leverage new routing features:
-- better name_prefix handling .name(..., prefix)
+- Add specs for dynamic loading/unloading of slices

data/bin/slice

@@ -0,0 +1,77 @@
+#!/usr/bin/env ruby
+
+__DIR__ = Dir.pwd
+
+require 'rubygems'
+require 'merb-core'
+require 'merb-slices'
+
+slice_name = File.basename(__DIR__)
+
+Merb::Config.use { |c|
+  c[:framework]           = { :public => [Merb.root / "public", nil] }
+  c[:session_store]       = 'none'
+  c[:exception_details]   = true
+}
+
+if File.exists?(slice_file = File.join(__DIR__, 'lib', "#{slice_name}.rb"))
+  Merb::BootLoader.before_app_loads do
+    # See Merb::Slices::ModuleMixin - $SLICE_MODULE is used as a flag
+    $SLICE_MODULE = Merb::Slices.filename2module(slice_file)
+    require slice_file
+    Merb::Router.prepare do 
+      slice($SLICE_MODULE)
+      slice_id = slice_name.gsub('-', '_').to_sym
+      slice_routes = Merb::Slices.named_routes[slice_id] || {}
+    
+      # Setup a / root path matching route - try several defaults
+      route = slice_routes[:home] || slice_routes[:index]
+      if route
+        params = route.params.inject({}) do |hsh,(k,v)|
+          hsh[k] = v.gsub("\"", '') if k == :controller || k == :action
+          hsh
+        end
+        match('/').to(params)
+      else
+        match('/').to(:controller => 'merb_slices', :action => 'index')
+      end
+    end
+  end
+else
+  puts "No slice found (expected: #{slice_name})"
+  exit
+end
+
+class MerbSlices < Merb::Controller
+  
+  def index
+    html = "<h1>#{slice.name}</h1><p>#{slice.description}</p>"  
+    html << "<h2>Routes</h2><ul>"
+    sorted_names = slice.named_routes.keys.map { |k| [k.to_s, k] }.sort_by { |pair| pair.first }
+    sorted_names.each do |_, name|
+      if name != :default && (route = slice.named_routes[name])
+        if name == :index
+          html << %Q[<li><a href="#{url(route.name)}" title="visit #{name}">#{name}: #{route.inspect}</a></li>]
+        else
+          html << %Q[<li>#{name}: #{route.inspect}</li>]
+        end
+      end
+    end
+    html << "</ul>"
+    html
+  end
+  
+  private
+  
+  def slice
+    @slice ||= Merb::Slices.slices.first
+  end
+  
+end
+
+ARGV.push '-H' if ARGV[0] && ARGV[0] =~ /^[^-]/
+unless %w[-a --adapter -i --irb-console -r --script-runner].any? { |o| ARGV.index(o) }
+  ARGV.push *%w[-a mongrel]
+end
+
+Merb.start

data/lib/generators/templates/common/Rakefile

@@ -1,9 +1,10 @@
 require 'rubygems'
 require 'rake/gempackagetask'
-require 'merb-core/version'
-require 'merb-core/tasks/merb_rake_helper'
 
-NAME = "<%= base_name %>"
+require 'merb-core'
+require 'merb-core/tasks/merb'
+
+GEM_NAME = "<%= base_name %>"
 AUTHOR = "Your Name"
 EMAIL = "Your Email"
 HOMEPAGE = "http://merbivore.com/"
@@ -12,7 +13,7 @@ GEM_VERSION = "<%= Merb::VERSION %>"
 
 spec = Gem::Specification.new do |s|
   s.rubyforge_project = 'merb'
-  s.name = NAME
+  s.name = GEM_NAME
   s.version = GEM_VERSION
   s.platform = Gem::Platform::RUBY
   s.has_rdoc = true
@@ -31,16 +32,19 @@ 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}
+desc "Install the gem"
+task :install do
+  Merb::RakeHelper.install(GEM_NAME, :version => GEM_VERSION)
 end
 
-namespace :jruby do
+desc "Uninstall the gem"
+task :uninstall do
+  Merb::RakeHelper.uninstall(GEM_NAME, :version => GEM_VERSION)
+end
 
-  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}
+desc "Create a gemspec file"
+task :gemspec do
+  File.open("#{GEM_NAME}.gemspec", "w") do |file|
+    file.puts spec.to_ruby
   end
-  
 end

data/lib/generators/templates/full/README

@@ -90,19 +90,19 @@ file: config/router.rb
 
 # example: /<%= symbol_name %>/:controller/:action/:id
 
-r.add_slice(:<%= module_name %>)
+add_slice(:<%= module_name %>)
 
 # example: /foo/:controller/:action/:id
 
-r.add_slice(:<%= module_name %>, 'foo') # same as :path => 'foo'
+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' })
+add_slice(:<%= module_name %>, :path => ':lang', :params => { :a => 'b' })
 
 # example: /:controller/:action/:id
 
-r.slice(:<%= module_name %>)
+slice(:<%= module_name %>)
 
 Normally you should also run the following rake task:
 

data/lib/generators/templates/full/Rakefile

@@ -1,11 +1,12 @@
 require 'rubygems'
 require 'rake/gempackagetask'
 require 'spec/rake/spectask'
-require 'merb-core/version'
-require 'merb-core/tasks/merb_rake_helper'
+
+require 'merb-core'
+require 'merb-core/tasks/merb'
 require 'merb-core/test/tasks/spectasks'
 
-NAME = "<%= base_name %>"
+GEM_NAME = "<%= base_name %>"
 AUTHOR = "Your Name"
 EMAIL = "Your Email"
 HOMEPAGE = "http://merbivore.com/"
@@ -14,7 +15,7 @@ GEM_VERSION = "<%= Merb::VERSION %>"
 
 spec = Gem::Specification.new do |s|
   s.rubyforge_project = 'merb'
-  s.name = NAME
+  s.name = GEM_NAME
   s.version = GEM_VERSION
   s.platform = Gem::Platform::RUBY
   s.has_rdoc = true
@@ -33,16 +34,34 @@ 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}
+desc "Install the gem"
+task :install do
+  Merb::RakeHelper.install(GEM_NAME, :version => GEM_VERSION)
 end
 
-namespace :jruby do
+desc "Uninstall the gem"
+task :uninstall do
+  Merb::RakeHelper.uninstall(GEM_NAME, :version => GEM_VERSION)
+end
 
-  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}
+desc "Create a gemspec file"
+task :gemspec do
+  File.open("#{GEM_NAME}.gemspec", "w") do |file|
+    file.puts spec.to_ruby
   end
-  
-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/lib/generators/templates/full/config/init.rb

@@ -0,0 +1,43 @@
+#
+# ==== Standalone <%= module_name %> configuration
+# 
+# This configuration/environment file is only loaded by bin/slice, which can be 
+# used during development of the slice. It has no effect on this slice being
+# loaded in a host application. To run your slice in standalone mode, just
+# run 'slice' from its directory. The 'slice' command is very similar to
+# the 'merb' command, and takes all the same options, including -i to drop 
+# into an irb session for example.
+#
+# The usual Merb configuration directives and init.rb setup methods apply,
+# including use_orm and before_app_loads/after_app_loads.
+#
+# If you need need different configurations for different environments you can 
+# even create the specific environment file in config/environments/ just like
+# in a regular Merb application. 
+#
+# In fact, a slice is no different from a normal # Merb application - it only
+# differs by the fact that seamlessly integrates into a so called 'host'
+# application, which in turn can override or finetune the slice implementation
+# code and views.
+#
+
+Merb::Config.use do |c|
+
+  # Sets up a custom session id key which is used for the session persistence
+  # cookie name.  If not specified, defaults to '_session_id'.
+  # c[:session_id_key] = '_session_id'
+  
+  # The session_secret_key is only required for the cookie session store.
+  c[:session_secret_key]  = '<%= SHA1.new(rand(100000000000).to_s).to_s %>'
+  
+  # There are various options here, by default Merb comes with 'cookie', 
+  # 'memory', 'memcache' or 'container'.  
+  # You can of course use your favorite ORM instead: 
+  # 'datamapper', 'sequel' or 'activerecord'.
+  c[:session_store] = 'cookie'
+  
+  # When running a slice standalone, you're usually developing it,
+  # so enable template reloading by default.
+  c[:reload_templates] = true
+  
+end

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

@@ -53,7 +53,9 @@ if defined?(Merb::Plugins)
     #   to avoid potential conflicts with global named routes.
     def self.setup_router(scope)
       # example of a named route
-      scope.match('/index.:format').to(:controller => 'main', :action => 'index').name(:<%= symbol_name %>_index)
+      scope.match('/index(.:format)').to(:controller => 'main', :action => 'index').name(:index)
+      # the slice is mounted at /<%= base_name %> - note that it comes before default_routes
+      scope.match('/').to(:controller => 'main', :action => 'index').name(:home)
     end
     
   end

data/lib/generators/templates/full/spec/%base_name%_spec.rb

@@ -2,129 +2,18 @@ require File.dirname(__FILE__) + '/spec_helper'
 
 describe "<%= module_name %> (module)" do
   
-  it "should have proper specs"
-  
-  # 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 be registered in Merb::Slices.slices" do
-    Merb::Slices.slices.should include(<%= module_name %>)
-  end
-  
-  it "should be registered in Merb::Slices.paths" do
-    Merb::Slices.paths[<%= module_name %>.name].should == current_slice_root
-  end
-  
-  it "should have an :identifier property" do
-    <%= module_name %>.identifier.should == "<%= base_name %>"
-  end
-  
-  it "should have an :identifier_sym property" do
-    <%= module_name %>.identifier_sym.should == :<%= symbol_name %>
-  end
-  
-  it "should have a :root property" do
-    <%= module_name %>.root.should == Merb::Slices.paths[<%= module_name %>.name]
-    <%= module_name %>.root_path('app').should == current_slice_root / 'app'
-  end
-  
-  it "should have a :file property" do
-    <%= module_name %>.file.should == current_slice_root / 'lib' / '<%= base_name %>.rb'
-  end
-  
-  it "should have metadata properties" do
-    <%= module_name %>.description.should == "<%= module_name %> is a chunky Merb slice!"
-    <%= module_name %>.version.should == "0.0.1"
-    <%= module_name %>.author.should == "YOUR NAME"
-  end
+  # Implement your <%= module_name %> specs here
   
-  it "should have :routes and :named_routes properties" do
-    <%= module_name %>.routes.should_not be_empty
-    <%= module_name %>.named_routes[:<%= symbol_name %>_index].should be_kind_of(Merb::Router::Route)
-  end
-
-  it "should have an url helper method for slice-specific routes" do
-    <%= module_name %>.url(:controller => 'main', :action => 'show', :format => 'html').should == "/<%= base_name %>/main/show.html"
-    <%= module_name %>.url(:<%= symbol_name %>_index, :format => 'html').should == "/<%= base_name %>/index.html"
-  end
-  
-  it "should have a config property (Hash)" do
-    <%= module_name %>.config.should be_kind_of(Hash)
-  end
-  
-  it "should have bracket accessors as shortcuts to the config" do
-    <%= module_name %>[:foo] = 'bar'
-    <%= module_name %>[:foo].should == 'bar'
-    <%= module_name %>[:foo].should == <%= module_name %>.config[:foo]
-  end
-  
-  it "should have a :layout config option set" do
-    <%= module_name %>.config[:layout].should == :<%= symbol_name %>
-  end
-  
-  it "should have a dir_for method" do
-    app_path = <%= module_name %>.dir_for(:application)
-    app_path.should == current_slice_root / 'app'
-    [:view, :model, :controller, :helper, :mailer, :part].each do |type|
-      <%= module_name %>.dir_for(type).should == app_path / "#{type}s"
-    end
-    public_path = <%= module_name %>.dir_for(:public)
-    public_path.should == current_slice_root / 'public'
-    [:stylesheet, :javascript, :image].each do |type|
-      <%= module_name %>.dir_for(type).should == public_path / "#{type}s"
-    end
-  end
-  
-  it "should have a app_dir_for method" do
-    root_path = <%= module_name %>.app_dir_for(:root)
-    root_path.should == Merb.root / 'slices' / '<%= base_name %>'
-    app_path = <%= module_name %>.app_dir_for(:application)
-    app_path.should == root_path / 'app'
-    [:view, :model, :controller, :helper, :mailer, :part].each do |type|
-      <%= module_name %>.app_dir_for(type).should == app_path / "#{type}s"
-    end
-    public_path = <%= module_name %>.app_dir_for(:public)
-    public_path.should == Merb.dir_for(:public) / 'slices' / '<%= base_name %>'
-    [:stylesheet, :javascript, :image].each do |type|
-      <%= module_name %>.app_dir_for(type).should == public_path / "#{type}s"
-    end
-  end
-  
-  it "should have a public_dir_for method" do
-    public_path = <%= module_name %>.public_dir_for(:public)
-    public_path.should == '/slices' / '<%= base_name %>'
-    [:stylesheet, :javascript, :image].each do |type|
-      <%= module_name %>.public_dir_for(type).should == public_path / "#{type}s"
-    end
-  end
-  
-  it "should have a public_path_for method" do
-    public_path = <%= module_name %>.public_dir_for(:public)
-    <%= module_name %>.public_path_for("path", "to", "file").should == public_path / "path" / "to" / "file"
-    [:stylesheet, :javascript, :image].each do |type|
-      <%= module_name %>.public_path_for(type, "path", "to", "file").should == public_path / "#{type}s" / "path" / "to" / "file"
-    end
-  end
-  
-  it "should have a app_path_for method" do
-    <%= module_name %>.app_path_for("path", "to", "file").should == <%= module_name %>.app_dir_for(:root) / "path" / "to" / "file"
-    <%= module_name %>.app_path_for(:controller, "path", "to", "file").should == <%= module_name %>.app_dir_for(:controller) / "path" / "to" / "file"
-  end
+  it "should have proper specs"
   
-  it "should have a slice_path_for method" do
-    <%= module_name %>.slice_path_for("path", "to", "file").should == <%= module_name %>.dir_for(:root) / "path" / "to" / "file"
-    <%= module_name %>.slice_path_for(:controller, "path", "to", "file").should == <%= module_name %>.dir_for(:controller) / "path" / "to" / "file"
-  end
+  # To spec <%= module_name %> you need to hook it up to the router like this:
   
-  it "should keep a list of path component types to use when copying files" do
-    (<%= module_name %>.mirrored_components & <%= module_name %>.slice_paths.keys).length.should == <%= module_name %>.mirrored_components.length
-  end
+  # before :all do
+  #   Merb::Router.prepare { add_slice(:<%= module_name %>) } if standalone?
+  # end
+  # 
+  # after :all do
+  #   Merb::Router.reset! if standalone?
+  # end
   
 end