merb-slices 0.9.7 → 0.9.8

data/spec/slices/very-thin-test-slice/Rakefile

@@ -0,0 +1,43 @@
+require 'rubygems'
+require 'rake/gempackagetask'
+
+require 'merb-core'
+require 'merb-core/tasks/merb'
+
+GEM_NAME = "very-thin-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 application.rb) + Dir.glob("{lib,spec,app,public,stubs,views}/**/*")
+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

data/spec/slices/very-thin-test-slice/TODO

@@ -0,0 +1,7 @@
+TODO:
+
+- Fix VeryThinTestSlice.description and VeryThinTestSlice.version
+- Fix LICENSE with your name
+- Fix Rakefile with your name and contact info
+- Add your code to lib/very-thin-test-slice.rb
+- Add your Merb rake tasks to lib/very-thin-test-slice/merbtasks.rb

data/spec/slices/very-thin-test-slice/application.rb

@@ -0,0 +1,36 @@
+module VeryThinTestSlice
+  
+  # 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)
+      ::VeryThinTestSlice.public_path_for(type, *segments)
+    end
+    
+    # Construct an app-level path.
+    def app_path_for(type, *segments)
+      ::VeryThinTestSlice.app_path_for(type, *segments)
+    end
+    
+    # Construct a slice-level path
+    def slice_path_for(type, *segments)
+      ::VeryThinTestSlice.slice_path_for(type, *segments)
+    end
+    
+  end
+  
+  class Main < Application
+    
+    def index
+      render "#{slice.description} (v. #{slice.version})"
+    end
+    
+  end
+  
+end

data/spec/slices/very-thin-test-slice/lib/very-thin-test-slice.rb

@@ -0,0 +1,89 @@
+if defined?(Merb::Plugins)
+
+  $:.unshift File.dirname(__FILE__)
+
+  load_dependency 'merb-slices'
+  Merb::Plugins.add_rakefiles "very-thin-test-slice/merbtasks", "very-thin-test-slice/slicetasks"
+
+  # Register the Slice for the current host application
+  Merb::Slices::register(__FILE__)
+  
+  # Slice configuration - set this in a before_app_loads callback.
+  Merb::Slices::config[:very_thin_test_slice][:foo] ||= :bar
+  
+  # All Slice code is expected to be namespaced inside a module
+  module VeryThinTestSlice
+    
+    # Slice metadata
+    self.description = "VeryThinTestSlice is a very 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(VeryThinTestSlice)
+    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 :very_thin_test_slice_
+    #   to avoid potential conflicts with global named routes.
+    def self.setup_router(scope)
+    end
+    
+    # This sets up a very 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(: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 VeryThinTestSlice
+  #
+  # Use VeryThinTestSlice.push_path and VeryThinTestSlice.push_app_path
+  # to set paths to very-thin-test-slice-level and app-level paths. Example:
+  #
+  # VeryThinTestSlice.push_path(:application, VeryThinTestSlice.root)
+  # VeryThinTestSlice.push_app_path(:application, Merb.root / 'slices' / 'very-thin-test-slice')
+  # ...
+  #
+  # Any component path that hasn't been set will default to VeryThinTestSlice.root
+  #
+  # For a very thin slice we just add application.rb and :public locations.
+  VeryThinTestSlice.setup_default_structure!
+  
+  # Add dependencies for other VeryThinTestSlice classes below. Example:
+  # dependency "very-thin-test-slice/other"
+  
+end

data/spec/slices/very-thin-test-slice/lib/very-thin-test-slice/merbtasks.rb

@@ -0,0 +1,103 @@
+namespace :slices do
+  namespace :very_thin_test_slice do
+  
+    desc "Install VeryThinTestSlice"
+    task :install => [:preflight, :setup_directories, :copy_assets, :migrate]
+    
+    desc "Test for any dependencies"
+    task :preflight do # see slicetasks.rb
+    end
+  
+    desc "Setup directories"
+    task :setup_directories do
+      puts "Creating directories for host application"
+      VeryThinTestSlice.mirrored_components.each do |type|
+        if File.directory?(VeryThinTestSlice.dir_for(type))
+          if !File.directory?(dst_path = VeryThinTestSlice.app_dir_for(type))
+            relative_path = dst_path.relative_path_from(Merb.root)
+            puts "- creating directory :#{type} #{File.basename(Merb.root) / relative_path}"
+            mkdir_p(dst_path)
+          end
+        end
+      end
+    end
+    
+    desc "Copy stub files to host application"
+    task :stubs do
+      puts "Copying stubs for VeryThinTestSlice - resolves any collisions"
+      copied, preserved = VeryThinTestSlice.mirror_stubs!
+      puts "- no files to copy" if copied.empty? && preserved.empty?
+      copied.each { |f| puts "- copied #{f}" }
+      preserved.each { |f| puts "! preserved override as #{f}" }
+    end
+    
+    desc "Copy stub files and views to host application"
+    task :patch => [ "stubs", "freeze:views" ]
+  
+    desc "Copy public assets to host application"
+    task :copy_assets do
+      puts "Copying assets for VeryThinTestSlice - resolves any collisions"
+      copied, preserved = VeryThinTestSlice.mirror_public!
+      puts "- no files to copy" if copied.empty? && preserved.empty?
+      copied.each { |f| puts "- copied #{f}" }
+      preserved.each { |f| puts "! preserved override as #{f}" }
+    end
+    
+    desc "Migrate the database"
+    task :migrate do # see slicetasks.rb
+    end
+    
+    desc "Freeze VeryThinTestSlice into your app (only very-thin-test-slice/app)" 
+    task :freeze => [ "freeze:app" ]
+
+    namespace :freeze do
+      
+      desc "Freezes VeryThinTestSlice by installing the gem into application/gems"
+      task :gem do
+        ENV["GEM"] ||= "very-thin-test-slice"
+        Rake::Task['slices:install_as_gem'].invoke
+      end
+      
+      desc "Freezes VeryThinTestSlice by copying all files from very-thin-test-slice/app to your application"
+      task :app do
+        puts "Copying all very-thin-test-slice/app files to your application - resolves any collisions"
+        copied, preserved = VeryThinTestSlice.mirror_app!
+        puts "- no files to copy" if copied.empty? && preserved.empty?
+        copied.each { |f| puts "- copied #{f}" }
+        preserved.each { |f| puts "! preserved override as #{f}" }
+      end
+      
+      desc "Freeze all views into your application for easy modification" 
+      task :views do
+        puts "Copying all view templates to your application - resolves any collisions"
+        copied, preserved = VeryThinTestSlice.mirror_files_for :view
+        puts "- no files to copy" if copied.empty? && preserved.empty?
+        copied.each { |f| puts "- copied #{f}" }
+        preserved.each { |f| puts "! preserved override as #{f}" }
+      end
+      
+      desc "Freeze all models into your application for easy modification" 
+      task :models do
+        puts "Copying all models to your application - resolves any collisions"
+        copied, preserved = VeryThinTestSlice.mirror_files_for :model
+        puts "- no files to copy" if copied.empty? && preserved.empty?
+        copied.each { |f| puts "- copied #{f}" }
+        preserved.each { |f| puts "! preserved override as #{f}" }
+      end
+      
+      desc "Freezes VeryThinTestSlice as a gem and copies over very-thin-test-slice/app"
+      task :app_with_gem => [:gem, :app]
+      
+      desc "Freezes VeryThinTestSlice by unpacking all files into your application"
+      task :unpack do
+        puts "Unpacking VeryThinTestSlice files to your application - resolves any collisions"
+        copied, preserved = VeryThinTestSlice.unpack_slice!
+        puts "- no files to copy" if copied.empty? && preserved.empty?
+        copied.each { |f| puts "- copied #{f}" }
+        preserved.each { |f| puts "! preserved override as #{f}" }
+      end
+      
+    end
+    
+  end
+end

data/spec/slices/very-thin-test-slice/lib/very-thin-test-slice/slicetasks.rb

@@ -0,0 +1,18 @@
+namespace :slices do
+  namespace :very_thin_test_slice do 
+    
+    # add your own very-thin-test-slice tasks here
+    
+    # implement this to test for structural/code dependencies
+    # like certain directories or availability of other files
+    desc "Test for any dependencies"
+    task :preflight do
+    end
+    
+    # implement this to perform any database related setup steps
+    desc "Migrate the database"
+    task :migrate do
+    end
+    
+  end
+end

data/spec/spec_helper.rb

@@ -1,9 +1,34 @@
-$TESTING=true
 $:.push File.join(File.dirname(__FILE__), '..', 'lib')
 
 require 'rubygems'
 require 'merb-gen'
+require 'merb-slices'
+
 require 'generators/base'
 require 'generators/full'
 require 'generators/thin'
-require 'generators/very_thin'
+require 'generators/very_thin'
+
+module Merb
+  module Test
+    module SliceHelper
+      
+      def current_slice_root=(path)
+        @current_slice_root = File.expand_path(path)
+      end
+      
+      # The absolute path to the current slice
+      def current_slice_root
+        @current_slice_root || File.expand_path(File.dirname(__FILE__))
+      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/spec/thin_slice_generator_spec.rb

@@ -1,14 +1,36 @@
 require File.dirname(__FILE__) + '/spec_helper'
 
+slices_path = File.dirname(__FILE__) / 'slices'
+
 describe Merb::Generators::ThinSliceGenerator do
   
   describe "templates" do
     
+    before(:all) { FileUtils.rm_rf(slices_path / 'testing-thin') rescue nil }
+    after(:all)  { FileUtils.rm_rf(slices_path / 'testing-thin') rescue nil }
+    
     before do
-      @generator = Merb::Generators::ThinSliceGenerator.new('/tmp', {}, 'testing')
+      @generator = Merb::Generators::ThinSliceGenerator.new(slices_path, {}, 'testing-thin')
     end
     
-    it "should create a number of templates"
+    it "should create a number of templates" do
+      @generator.invoke!
+      files = Dir[slices_path / 'testing-thin' / '**' / '*'].map do |path| 
+        path.relative_path_from(slices_path)
+      end
+      expected = [
+        "testing-thin/application.rb", "testing-thin/lib", "testing-thin/lib/testing-thin", 
+        "testing-thin/lib/testing-thin/merbtasks.rb", "testing-thin/lib/testing-thin/slicetasks.rb", 
+        "testing-thin/lib/testing-thin.rb", "testing-thin/LICENSE", "testing-thin/public", 
+        "testing-thin/public/javascripts", "testing-thin/public/javascripts/master.js", 
+        "testing-thin/public/stylesheets", "testing-thin/public/stylesheets/master.css", 
+        "testing-thin/Rakefile", "testing-thin/README", "testing-thin/stubs", 
+        "testing-thin/stubs/application.rb", "testing-thin/TODO", "testing-thin/views", 
+        "testing-thin/views/layout", "testing-thin/views/layout/testing_thin.html.erb", 
+        "testing-thin/views/main", "testing-thin/views/main/index.html.erb"
+      ]
+      files.should == expected
+    end
     
     it "should render templates successfully" do
       lambda { @generator.render! }.should_not raise_error

data/spec/thin_slice_spec.rb

@@ -0,0 +1,139 @@
+require File.dirname(__FILE__) + '/spec_helper'
+
+slices_path = File.dirname(__FILE__) / 'slices'
+
+describe "A thin slice" do
+    
+  before(:all) do
+    self.current_slice_root = slices_path / 'thin-test-slice'
+    
+    # Uncomment this re-generate the slice
+    
+    # FileUtils.rm_rf(slices_path / 'thin-test-slice') rescue nil
+    # generator = Merb::Generators::ThinSliceGenerator.new(slices_path, {}, 'thin-test-slice')
+    # generator.invoke!
+    
+    # Add the slice to the search path
+    Merb::Plugins.config[:merb_slices][:auto_register] = true
+    Merb::Plugins.config[:merb_slices][:search_path]   = slices_path
+    
+    Merb.start(
+      :testing => true, 
+      :adapter => 'runner', 
+      :environment => ENV['MERB_ENV'] || 'test',
+      :merb_root => Merb.root
+    )
+  end
+  
+  # Uncomment this re-generate the slice
+  
+  # after(:all) do
+  #   FileUtils.rm_rf(slices_path / 'thin-test-slice') rescue nil
+  # end
+  
+  before :all do
+    Merb::Router.prepare { add_slice(:thin_test_slice) }
+  end
+  
+  after :all do
+    Merb::Router.reset!
+  end
+  
+  it "should be registered in Merb::Slices.slices" do
+    Merb::Slices.slices.should include(ThinTestSlice)
+  end
+  
+  it "should be registered in Merb::Slices.paths" do
+    Merb::Slices.paths[ThinTestSlice.name].should == current_slice_root
+  end
+  
+  it "should have an :identifier property" do
+    ThinTestSlice.identifier.should == "thin-test-slice"
+  end
+  
+  it "should have an :identifier_sym property" do
+    ThinTestSlice.identifier_sym.should == :thin_test_slice
+  end
+  
+  it "should have a :root property" do
+    ThinTestSlice.root.should == Merb::Slices.paths[ThinTestSlice.name]
+    ThinTestSlice.root_path('app').should == current_slice_root / 'app'
+  end
+  
+  it "should have a :file property" do
+    ThinTestSlice.file.should == current_slice_root / 'lib' / 'thin-test-slice.rb'
+  end
+  
+  it "should have metadata properties" do
+    ThinTestSlice.description.should == "ThinTestSlice is a thin Merb slice!"
+    ThinTestSlice.version.should == "0.0.1"
+    ThinTestSlice.author.should == "YOUR NAME"
+  end
+  
+  it "should have a :named_routes property" do
+    ThinTestSlice.named_routes[:default].should be_kind_of(Merb::Router::Route)
+  end
+  
+  it "should have a :layout config option set" do
+    ThinTestSlice.config[:layout].should == :thin_test_slice
+  end
+  
+  it "should have a dir_for method" do
+    app_path = ThinTestSlice.dir_for(:application)
+    app_path.should == current_slice_root
+    [:view].each do |type|
+      ThinTestSlice.dir_for(type).should == app_path / "#{type}s"
+    end
+    public_path = ThinTestSlice.dir_for(:public)
+    public_path.should == current_slice_root / 'public'
+    [:stylesheet, :javascript, :image].each do |type|
+      ThinTestSlice.dir_for(type).should == public_path / "#{type}s"
+    end
+  end
+  
+  it "should have a app_dir_for method" do
+    root_path = ThinTestSlice.app_dir_for(:root)
+    root_path.should == Merb.root / 'slices' / 'thin-test-slice'
+    app_path = ThinTestSlice.app_dir_for(:application)
+    app_path.should == root_path 
+    [:view].each do |type|
+      ThinTestSlice.app_dir_for(type).should == app_path / "#{type}s"
+    end
+    public_path = ThinTestSlice.app_dir_for(:public)
+    public_path.should == Merb.dir_for(:public) / 'slices' / 'thin-test-slice'
+    [:stylesheet, :javascript, :image].each do |type|
+      ThinTestSlice.app_dir_for(type).should == public_path / "#{type}s"
+    end
+  end
+  
+  it "should have a public_dir_for method" do
+    public_path = ThinTestSlice.public_dir_for(:public)
+    public_path.should == '/slices' / 'thin-test-slice'
+    [:stylesheet, :javascript, :image].each do |type|
+      ThinTestSlice.public_dir_for(type).should == public_path / "#{type}s"
+    end
+  end
+  
+  it "should have a public_path_for method" do
+    public_path = ThinTestSlice.public_dir_for(:public)
+    ThinTestSlice.public_path_for("path", "to", "file").should == public_path / "path" / "to" / "file"
+    [:stylesheet, :javascript, :image].each do |type|
+      ThinTestSlice.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
+    ThinTestSlice.app_path_for("path", "to", "file").should == ThinTestSlice.app_dir_for(:root) / "path" / "to" / "file"
+    ThinTestSlice.app_path_for(:controller, "path", "to", "file").should == ThinTestSlice.app_dir_for(:controller) / "path" / "to" / "file"
+  end
+  
+  it "should have a slice_path_for method" do
+    ThinTestSlice.slice_path_for("path", "to", "file").should == ThinTestSlice.dir_for(:root) / "path" / "to" / "file"
+    ThinTestSlice.slice_path_for(:controller, "path", "to", "file").should == ThinTestSlice.dir_for(:controller) / "path" / "to" / "file"
+  end
+  
+  it "should keep a list of path component types to use when copying files" do
+    (ThinTestSlice.mirrored_components & ThinTestSlice.slice_paths.keys).length.should == ThinTestSlice.mirrored_components.length
+  end
+    
+end