merb-slices 0.9.4

data/lib/generators/templates/very_thin/lib/%base_name%/merbtasks.rb

@@ -0,0 +1,106 @@
+namespace :slices do
+  namespace :<%= symbol_name %> do
+  
+    desc "Install <%= module_name %>"
+    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"
+      [:application, :view, :model, :controller, :helper, :mailer, :part, :public].each do |type|
+        if File.directory?(<%= module_name %>.dir_for(type))
+          if !File.directory?(dst_path = <%= module_name %>.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 <%= module_name %> - resolves any collisions"
+      copied, preserved = <%= module_name %>.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 <%= module_name %> - resolves any collisions"
+      copied, preserved = <%= module_name %>.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 <%= module_name %> into your app (only <%= base_name %>/app)" 
+    task :freeze => [ "freeze:app" ]
+
+    namespace :freeze do
+      
+      desc "Freezes <%= module_name %> by installing the gem into application/gems using merb-freezer"
+      task :gem do
+        begin
+          Object.const_get(:Freezer).freeze(ENV["GEM"] || "<%= base_name %>", ENV["UPDATE"], ENV["MODE"] || 'rubygems')
+        rescue NameError
+          puts "! dependency 'merb-freezer' missing"
+        end
+      end
+      
+      desc "Freezes <%= module_name %> by copying all files from <%= base_name %>/app to your application"
+      task :app do
+        puts "Copying all <%= base_name %>/app files to your application - resolves any collisions"
+        copied, preserved = <%= module_name %>.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 = <%= module_name %>.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 = <%= module_name %>.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 <%= module_name %> as a gem and copies over <%= base_name %>/app"
+      task :app_with_gem => [:gem, :app]
+      
+      desc "Freezes <%= module_name %> by unpacking all files into your application"
+      task :unpack do
+        puts "Unpacking <%= module_name %> files to your application - resolves any collisions"
+        copied, preserved = <%= module_name %>.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/lib/generators/templates/very_thin/lib/%base_name%/slicetasks.rb

@@ -0,0 +1,18 @@
+namespace :slices do
+  namespace :<%= symbol_name %> do 
+    
+    # add your own <%= base_name %> 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/lib/generators/thin.rb

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

data/lib/generators/very_thin.rb

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

data/lib/merb-slices.rb

@@ -0,0 +1,126 @@
+require 'merb-slices/module'
+
+if defined?(Merb::Plugins)
+  
+  Merb::Plugins.add_rakefiles "merb-slices/merbtasks"
+  
+  Merb::Plugins.config[:merb_slices] ||= {}
+  
+  require "merb-slices/module_mixin"
+  require "merb-slices/controller_mixin"
+  require "merb-slices/router_ext"
+  
+  # Enable slice behaviour for any class inheriting from AbstractController.
+  # To use this call controller_for_slice in your controller class.
+  Merb::AbstractController.send(:include, Merb::Slices::ControllerMixin)
+  
+  # Load Slice classes before the app's classes are loaded.
+  #
+  # This allows the application to override/merge any slice-level classes.
+  class Merb::Slices::Loader < Merb::BootLoader
+
+    before LoadClasses
+
+    class << self
+
+      # Gather all slices from search path and gems and load their classes.
+      def run
+        Merb::Slices.register_slices_from_search_path! if auto_register?
+        Merb::Slices.each_slice { |slice| slice.load_slice }
+      end
+      
+      # Load a single file and its requirements.
+      #
+      # @param file<String> The file to load.
+      def load_file(file)
+        Merb::BootLoader::LoadClasses.load_file file
+      end
+      
+      # Remove a single file and the classes loaded by it from ObjectSpace.
+      #
+      # @param file<String> The file to load.
+      def remove_file(file)
+        Merb::BootLoader::LoadClasses.remove_file file
+      end
+        
+      # Load classes from given paths - using path/glob pattern.
+      #
+      # @param *paths <Array> Array of paths to load classes from - may contain glob pattern
+      def load_classes(*paths)
+        Merb::BootLoader::LoadClasses.load_classes paths
+      end
+    
+      # Reload the router - takes all_slices into account to load slices at runtime.
+      def reload_router!
+        Merb::BootLoader::LoadClasses.reload_router!
+      end
+      
+      # Slice-level paths for all loaded slices.
+      #
+      # @return <Array[String]> Any slice-level paths that have been loaded.
+      def slice_paths
+        paths = []
+        Merb::Slices.each_slice { |slice| paths += slice.collected_slice_paths }
+        paths
+      end
+      
+      # App-level paths for all loaded slices.
+      #
+      # @return <Array[String]> Any app-level paths that have been loaded.
+      def app_paths
+        paths = []
+        Merb::Slices.each_slice { |slice| paths += slice.collected_app_paths }
+        paths
+      end
+      
+      private
+      
+      # Whether slices from search paths should be registered automatically.
+      # Defaults to true if not explicitly set.
+      def auto_register?
+        Merb::Plugins.config[:merb_slices][:auto_register] || !Merb::Plugins.config[:merb_slices].key?(:auto_register)
+      end
+      
+    end
+
+  end
+  
+  # Call initialization method for each registered Slice.
+  #
+  # This is done just before the app's after_load_callbacks are run.
+  # The application has been practically loaded completely, letting
+  # the callbacks work with what has been loaded.
+  class Merb::Slices::Initialize < Merb::BootLoader
+  
+    before AfterAppLoads
+  
+    def self.run
+      Merb::Slices.each_slice do |slice|
+        Merb.logger.info!("Initializing slice '#{slice}' ...") 
+        slice.init if slice.respond_to?(:init)
+      end
+    end
+  
+  end
+  
+  # Call activation method for each registered Slice.
+  #
+  # This is done right after the app's after_load_callbacks are run.
+  # Any settings can be taken into account in the activation step.
+  #
+  # @note Activation will only take place if the slice has been routed;
+  #   this means you need have at least one slice route setup.
+  class Merb::Slices::Activate < Merb::BootLoader
+  
+    after AfterAppLoads
+  
+    def self.run
+      Merb::Slices.each_slice do |slice|
+        Merb.logger.info!("Activating slice '#{slice}' ...")
+        slice.activate if slice.respond_to?(:activate) && slice.routed?
+      end
+    end
+  
+  end
+  
+end

data/lib/merb-slices/controller_mixin.rb

@@ -0,0 +1,129 @@
+module Merb
+  module Slices
+    
+    module ControllerMixin
+      
+      def self.included(klass)
+        klass.extend ClassMethods
+      end
+      
+      module ClassMethods
+        
+        # Setup a controller to reference a slice and its template roots
+        #
+        # This method is available to any class inheriting from Merb::AbstractController;
+        # it enabled correct location of templates, as well as access to the slice module.
+        #
+        # @param slice_module<#to_s> The slice module to use; defaults to current module.
+        # @param options<Hash> 
+        #   Optional parameters to set which component path is used (defaults to :view) and
+        #   the :path option lets you specify a subdirectory of that component path.
+        #   When :layout is set, then this is used instead of the config's :layout setting.
+        #
+        # @example controller_for_slice # uses current module
+        # @example controller_for_slice SliceMod # defaults to :view templates and no subdirectory
+        # @example controller_for_slice :templates_for => :mailer, :path => 'views' # for Merb::Mailer
+        # @example controller_for_slice SliceMod, :templates_for => :mailer, :path => 'views' # for Merb::Mailer
+        def controller_for_slice(slice_module = nil, options = {})
+          options, slice_module = slice_module.merge(options), nil if slice_module.is_a?(Hash)
+          slice_module ||= self.name.split('::').first
+          options[:templates_for] = :view unless options.key?(:templates_for)
+          if slice_mod = Merb::Slices[slice_module.to_s]
+            # Include the instance methods
+            unless self.kind_of?(Merb::Slices::ControllerMixin::MixinMethods)
+              self.send(:extend, Merb::Slices::ControllerMixin::MixinMethods)
+            end
+            # Reference this controller's slice module
+            self.class_inheritable_accessor :slice
+            self.slice = slice_mod
+            # Setup template roots
+            if options[:templates_for]
+              self._template_root  = join_template_path(slice_mod.dir_for(options[:templates_for]), options[:path])
+              self._template_roots = []
+              # app-level app/views directory for shared and fallback views, layouts and partials
+              self._template_roots << [join_template_path(Merb.dir_for(options[:templates_for]), options[:path]), :_template_location] if Merb.dir_for(options[:templates_for])
+              # slice-level app/views for the standard supplied views
+              self._template_roots << [self._template_root, :_slice_template_location] 
+              # app-level slices/<slice>/app/views for specific overrides
+              self._template_roots << [join_template_path(slice_mod.app_dir_for(options[:templates_for]), options[:path]), :_slice_template_location]
+              # additional template roots for specific overrides (optional)
+              self._template_roots += Array(options[:template_roots]) if options[:template_roots]
+            end
+            # Set the layout for this slice controller
+            layout_for_slice(options[:layout])
+          end
+        end
+        
+        private
+        
+        def join_template_path(*segments)
+          File.join(*segments.compact)
+        end
+        
+      end
+      
+      module MixinMethods
+        
+        def self.extended(klass)
+          klass.send(:include, InstanceMethods)
+          klass.hide_action :slice
+        end
+        
+        # Use the slice's layout - defaults to underscored identifier.
+        #
+        # This is set for generated stubs that support layouts.
+        #
+        # @param layout<#to_s> The layout name to use.
+        def layout_for_slice(layout = nil)
+          layout(layout || self.slice.config[:layout]) if layout || self.slice.config.key?(:layout)
+        end
+        
+        module InstanceMethods
+      
+          # Reference this controller's slice module directly.
+          #
+          # @return <Module> A slice module.
+          def slice; self.class.slice; end
+          
+          # Generate a url - takes the slice's :path_prefix into account.
+          def slice_url(name, rparams={})
+            self.slice.url(name, rparams, { 
+              :controller => controller_name,
+              :action => action_name,
+              :format => params[:format]
+            })
+          end
+
+          private
+  
+          # This is called after the controller is instantiated to figure out where to
+          # for templates under the _template_root. This helps the controllers
+          # of a slice to locate templates without looking in a subdirectory with
+          # the name of the module. Instead it will just be app/views/controller/*
+          #
+          # @param context<#to_str> The controller context (the action or template name).
+          # @param type<#to_str> The content type. Defaults to nil.
+          # @param controller<#to_str> The name of the controller. Defaults to controller_name.
+          #
+          # @return <String> 
+          #   Indicating where to look for the template for the current controller,
+          #   context, and content-type.
+          def _slice_template_location(context, type = nil, controller = controller_name)
+            if controller && controller.include?('/')
+              # skip first segment if given (which is the module name)
+              segments = controller.split('/')
+              "#{segments[1,segments.length-1].join('/')}/#{context}.#{type}"
+            else
+              # default template location logic
+              _template_location(context, type, controller)
+            end
+          end
+          
+        end
+      
+      end
+
+    end
+    
+  end
+end

data/lib/merb-slices/merbtasks.rb

@@ -0,0 +1,19 @@
+desc "Show information on application slices"
+task :slices => [ "slices:list" ]
+
+namespace :slices do
+
+  desc "Get a suitable slices environment up"
+  task :env do
+    Merb::Slices.register_slices_from_search_path!
+  end
+
+  desc "List known slices for the current application"
+  task :list => [:env] do
+    puts "Application slices:\n"
+    Merb::Slices.each_slice do |slice|
+      puts "#{slice.name} (v. #{slice.version}) - #{slice.description}\n"
+    end    
+  end
+  
+end