thorero-gen 0.9.4

data/templates/application/slice/full/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/templates/application/slice/full/README

@@ -0,0 +1,170 @@
+<%= module_name %>
+<%= "=" * module_name.size %>
+
+A slice for the Merb framework.
+
+------------------------------------------------------------------------------
+
+<%= base_name %>
+|-- LICENSE
+|-- README
+|-- Rakefile [1]
+|-- TODO
+|-- app [2]
+|   |-- controllers
+|   |   |-- application.rb
+|   |   `-- main.rb
+|   |-- helpers
+|   |   `-- application_helper.rb
+|   `-- views
+|       |-- layout
+|       |   `-- <%= underscored_name %>.html.erb [3]
+|       `-- main
+|           `-- index.html.erb
+|-- lib
+|   |-- <%= base_name %>
+|   |   |-- merbtasks.rb [4]
+|   |   `-- slicetasks.rb [5]
+|   `-- <%= base_name %>.rb [6]
+|-- log
+|   `-- merb_test.log
+|-- public [7]
+|   |-- javascripts 
+|   |   `-- master.js
+|   `-- stylesheets
+|       `-- master.css
+|-- spec [8]
+|   |-- <%= base_name %>_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[:<%= underscored_name %>][: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:<%= underscored_name %>: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:<%= underscored_name %>:stubs to
+   get started with the override stubs. Also, slices:<%= underscored_name %>:patch will
+   copy over views to override in addition to the files found in /stubs.
+   
+
+To see all available tasks for <%= module_name %> run:
+
+rake -T slices:<%= underscored_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[:<%= underscored_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:<%= underscored_name %>:install
+
+------------------------------------------------------------------------------
+
+You can put your application-level overrides in:
+
+host-app/slices/<%= base_name %>/app - controllers, models, views ...
+
+Templates are located in this order:
+
+1. host-app/slices/<%= base_name %>/app/views/*
+2. gems/<%= base_name %>/app/views/*
+3. host-app/app/views/*
+
+You can use the host application's layout by configuring the
+<%= base_name %> slice in a before_app_loads block:
+
+Merb::Slices.config[:<%= underscored_name %>] = { :layout => :application }
+
+By default :<%= underscored_name %> 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/<%= base_name %>.
+
+In any case don't edit those files directly as they may be clobbered any time
+rake <%= underscored_name %>: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/templates/application/slice/full/Rakefile

@@ -0,0 +1,48 @@
+require 'rubygems'
+require 'rake/gempackagetask'
+require 'spec/rake/spectask'
+require 'merb-core/version'
+require 'merb-core/test/tasks/spectasks'
+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) + Dir.glob("{lib,spec,app,public,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/templates/application/slice/full/TODO

@@ -0,0 +1,15 @@
+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
+
+Remove anything that you don't need:
+
+- app/controllers/main.rb <%= module_name %>::Main controller
+- app/views/layout/<%= underscored_name %>.html.erb
+- spec/controllers/main_spec.rb controller specs
+- public/* any public files
+- stubs/* any stub files

data/templates/application/slice/full/app/controllers/application.rb

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

data/templates/application/slice/full/app/controllers/main.rb

@@ -0,0 +1,7 @@
+class <%= module_name %>::Main < <%= module_name %>::Application
+  
+  def index
+    render
+  end
+  
+end

data/templates/application/slice/full/app/helpers/application_helper.rb

@@ -0,0 +1,64 @@
+module Merb
+  module <%= module_name %>
+    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)
+        ::<%= module_name %>.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)
+        ::<%= module_name %>.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)
+        ::<%= module_name %>.slice_path_for(type, *segments)
+      end
+      
+    end
+  end
+end

data/templates/application/slice/full/app/views/layout/%underscored_base_name%.html.erb

@@ -0,0 +1,16 @@
+<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Strict//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-strict.dtd">
+<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en-us" lang="en-us">
+  <head>
+    <meta http-equiv="content-type" content="text/html; charset=utf-8" />
+    <title>Fresh <%= module_name %> Slice</title>
+    <link href="<%%= public_path_for :stylesheet, 'master.css' %>" type="text/css" charset="utf-8" rel="stylesheet" media="all" />
+    <script src="<%%= public_path_for :javascript, 'master.js' %>" type="text/javascript" charset="utf-8"></script>
+  </head>
+  <!-- you can override this layout at slices/<%= base_name %>/app/views/layout/<%= underscored_name %>.html.erb -->
+  <body class="<%= base_name %>-slice">
+  <div id="container">
+	  <h1><%= module_name %> Slice</h1>
+    <div id="main"><%%= catch_content :for_layout %></div>
+  </div>
+  </body>
+</html>

data/templates/application/slice/full/app/views/main/index.html.erb

@@ -0,0 +1 @@
+<strong><%%= slice.description %></strong> (v. <%%= slice.version %>)

data/templates/application/slice/full/lib/%base_name%.rb

@@ -0,0 +1,78 @@
+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, so you can swicht to 
+  # the main application layout or no layout at all if needed.
+  # 
+  # Configuration options:
+  # :layout - the layout to use; defaults to :<%= underscored_name %>
+  # :mirror - which path component types to use on copy operations; defaults to all
+  Merb::Slices::config[:<%= underscored_name %>][:layout] ||= :<%= underscored_name %>
+  
+  # All Slice code is expected to be namespaced inside a module
+  module <%= module_name %>
+    
+    # Slice metadata
+    self.description = "<%= module_name %> is a chunky 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 :<%= underscored_name %>_
+    #   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(:<%= underscored_name %>_index)
+    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
+  #
+  # Or just call setup_default_structure! to setup a basic Merb MVC structure.
+  <%= module_name %>.setup_default_structure!
+  
+  # Add dependencies for other <%= module_name %> classes below. Example:
+  # dependency "<%= base_name %>/other"
+  
+end

data/templates/application/slice/full/lib/%base_name%/merbtasks.rb

@@ -0,0 +1,166 @@
+namespace :slices do
+  namespace :<%= underscored_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"
+      <%= module_name %>.mirrored_components.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
+    
+    desc "Run slice specs within the host application context"
+    task :spec => [ "spec:explain", "spec:default" ]
+    
+    namespace :spec do
+      
+      slice_root = File.expand_path(File.join(File.dirname(__FILE__), '..', '..'))
+      
+      task :explain do
+        puts "\nNote: By running <%= module_name %> specs inside the application context any\n" +
+             "overrides could break existing specs. This isn't always a problem,\n" +
+             "especially in the case of views. Use these spec tasks to check how\n" +
+             "well your application conforms to the original slice implementation."
+      end
+      
+      Spec::Rake::SpecTask.new('default') do |t|
+        t.spec_opts = ["--format", "specdoc", "--colour"]
+        t.spec_files = Dir["#{slice_root}/spec/**/*_spec.rb"].sort
+      end
+
+      desc "Run all model specs, run a spec for a specific Model with MODEL=MyModel"
+      Spec::Rake::SpecTask.new('model') do |t|
+        t.spec_opts = ["--format", "specdoc", "--colour"]
+        if(ENV['MODEL'])
+          t.spec_files = Dir["#{slice_root}/spec/models/**/#{ENV['MODEL']}_spec.rb"].sort
+        else
+          t.spec_files = Dir["#{slice_root}/spec/models/**/*_spec.rb"].sort
+        end
+      end
+
+      desc "Run all controller specs, run a spec for a specific Controller with CONTROLLER=MyController"
+      Spec::Rake::SpecTask.new('controller') do |t|
+        t.spec_opts = ["--format", "specdoc", "--colour"]
+        if(ENV['CONTROLLER'])
+          t.spec_files = Dir["#{slice_root}/spec/controllers/**/#{ENV['CONTROLLER']}_spec.rb"].sort
+        else    
+          t.spec_files = Dir["#{slice_root}/spec/controllers/**/*_spec.rb"].sort
+        end
+      end
+
+      desc "Run all view specs, run specs for a specific controller (and view) with CONTROLLER=MyController (VIEW=MyView)"
+      Spec::Rake::SpecTask.new('view') do |t|
+        t.spec_opts = ["--format", "specdoc", "--colour"]
+        if(ENV['CONTROLLER'] and ENV['VIEW'])
+          t.spec_files = Dir["#{slice_root}/spec/views/**/#{ENV['CONTROLLER']}/#{ENV['VIEW']}*_spec.rb"].sort
+        elsif(ENV['CONTROLLER'])
+          t.spec_files = Dir["#{slice_root}/spec/views/**/#{ENV['CONTROLLER']}/*_spec.rb"].sort
+        else
+          t.spec_files = Dir["#{slice_root}/spec/views/**/*_spec.rb"].sort
+        end
+      end
+
+      desc "Run all specs and output the result in html"
+      Spec::Rake::SpecTask.new('html') do |t|
+        t.spec_opts = ["--format", "html"]
+        t.libs = ['lib', 'server/lib' ]
+        t.spec_files = Dir["#{slice_root}/spec/**/*_spec.rb"].sort
+      end
+      
+    end
+    
+  end
+end