merb-gen 0.9.3 → 0.9.4

data/README

@@ -17,5 +17,17 @@ To see what generators are available, run merb-gen generators.
 
 ==== Custom generators
 
-If you want to create your custom generators to use with Merb, and don't want to create a gem,
-you should put them in ~/.rubigen/merb_generators/.
+There are two ways of adding generators, depending on how the generators are intended to be used. The first way is by adding adding the generator via Merb.add_generators, and specifying the location of any generators.
+
+    Merb.add_generators File.join(File.dirname(__FILES__), 'generators', 'my_generator.rb')
+
+This method has some advantages:
+
+- it allows you to load generators only when your plugin is required in the application
+- it allows you to load generators from inside the application itself
+
+However, it also has a disadvantage: it is impossible this way to add generators whether the plugin is loaded or not, just by virtue of the gem being installed. This is where the second way comes in: A 'Generators' file is added to the root of the project (like a Rakefile), it should look something like this:
+
+    scope "merb-gen" do
+      Merb.add_generators File.join(File.dirname(__FILES__), 'generators', 'my_generator.rb')
+    end

data/Rakefile

@@ -1,49 +1,65 @@
 require 'rubygems'
 require 'rake/gempackagetask'
+require "extlib"
+require 'merb-core/tasks/merb_rake_helper'
+require "spec/rake/spectask"
 
-GEM = "merb-gen"
-VERSION = "0.9.3"
-AUTHOR = "Yehuda Katz"
-EMAIL = "wycats@gmail.com"
-HOMEPAGE = "http://www.merbivore.com"
-SUMMARY = "Merb More: Merb's Application and Plugin Generators"
+##############################################################################
+# Package && release
+##############################################################################
+RUBY_FORGE_PROJECT  = "merb"
+PROJECT_URL         = "http://merbivore.com"
+PROJECT_SUMMARY     = "Generators suite for Merb."
+PROJECT_DESCRIPTION = PROJECT_SUMMARY
+
+GEM_AUTHOR = "Jonas Nicklas"
+GEM_EMAIL  = "jonas.nicklas@gmail.com"
+
+GEM_NAME    = "merb-gen"
+PKG_BUILD   = ENV['PKG_BUILD'] ? '.' + ENV['PKG_BUILD'] : ''
+GEM_VERSION = (Merb::MORE_VERSION rescue "0.9.4") + PKG_BUILD
+
+RELEASE_NAME    = "REL #{GEM_VERSION}"
+
+require "extlib/tasks/release"
 
 spec = Gem::Specification.new do |s|
-  s.name = GEM
-  s.version = VERSION
+  s.rubyforge_project = RUBY_FORGE_PROJECT
+  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.summary = PROJECT_SUMMARY
+  s.description = PROJECT_DESCRIPTION
+  s.author = GEM_AUTHOR
+  s.email = GEM_EMAIL
+  s.homepage = PROJECT_URL
   s.bindir = "bin"
   s.executables = %w( merb-gen )
-    
-  # Uncomment this to add a dependency
-  s.add_dependency "merb-core", ">= 0.9.3"
-  s.add_dependency "rubigen", ">= 1.2.4"
-  
+
+  s.add_dependency "merb-core", ">= 0.9.4"
+  s.add_dependency "templater", ">= 0.1.4"
+
   s.require_path = 'lib'
-  s.autorequire = GEM
-  s.files = %w(LICENSE README Rakefile TODO) + 
-          Dir.glob("{lib,bin,spec,app_generators,merb_default_generators,merb_generators,rspec_generators,test_unit_generators}/**/*")
+  s.autorequire = GEM_NAME
+  s.files = %w(LICENSE README Rakefile TODO) + Dir.glob("{lib,bin,spec}/**/*")
 end
 
 Rake::GemPackageTask.new(spec) do |pkg|
   pkg.gem_spec = spec
 end
 
-install_home = ENV['GEM_HOME'] ? "-i #{ENV['GEM_HOME']}" : ""
+desc "Install the gem"
+task :install => [:package] do
+  sh %{#{sudo} gem install #{install_home} pkg/#{GEM_NAME}-#{GEM_VERSION} --no-update-sources}
+end
 
 namespace :jruby do
-  task :install do
-    sh %{sudo jruby -S gem install #{install_home} pkg/#{GEM}-#{VERSION} --no-update-sources}
+
+  desc "Run :package and install the resulting .gem with jruby"
+  task :install => :package do
+    sh %{#{sudo} jruby -S gem install #{install_home} pkg/#{GEM_NAME}-#{GEM_VERSION}.gem --no-rdoc --no-ri}
   end
-end
 
-task :install => [:package] do
-  sh %{sudo gem install #{install_home} pkg/#{GEM}-#{VERSION} --no-update-sources}
 end

data/TODO

@@ -0,0 +1,13 @@
+Merb-gen is now ported to templater, instead of rubigen. Some things are left to do, including:
+
+* Integrate with Merb::Config[:framework], so that stuff gets placed in the correct directories
+* Allow some system for plugins to add their own generators.
+* Move ORM specific templates/code into respective plugin (this requires a change in templater so that absolute paths can be specified for templates)
+* Move test_unit stuff into merb-test-unit
+* Move part controller generator into merb-parts
+* Automatically infer ORM and testing framework (this should be easy, really)
+* Add migration generators
+* Add generators for session migrations
+* Change ActiveRecord migrations to use new datestamp format
+
+* Fix remaining stuff in templater (see separate TODO)

data/bin/merb-gen

@@ -1,98 +1,10 @@
 #!/usr/bin/env ruby
 
-at_exit { exit }
+require 'rubygems'
+require 'merb-gen'
 
-command = ARGV.shift if %w(generate destroy update).include?(ARGV[0])
-
-%w(rubygems merb-core).each do |file|
-  require file
-end
-
-# start merb
-Merb.start :environment => 'development', :log_level => 'error'
-
-# remove dependency
-module Kernel
-  undef dependency if defined?(Kernel.dependency)
+Merb::BootLoader.after_app_loads do
+  Merb::Generators.run_cli(Dir.pwd, 'merb-gen', Merb::VERSION, ARGV)
 end
 
-%w(rubigen rubigen/scripts/generate rubigen/scripts/destroy 
-    rubigen/scripts/update fileutils find merb-gen).each do |file|
-  require file
-end
-
-app_help = <<-EOF
-  Application Generators:
-  To generate an application use one of the following
-  merb-gen app app_name             (for a standard application)
-  merb-gen app app_name --flat      (for a flattened application)
-  merb-gen app app_name --very-flat (for a single file application)
-  merb-gen plugin plugin_name   (creates a plugin gem skeleton)
-
-  Other Generators:
-  merb-gen generators
-  with no args will display all availble generators for the current configuration.
-EOF
-
-# merb-gen || merb-gen help || merb-gen help app || merb-gen app
-if ARGV.empty? || (ARGV[0] == "help" && ARGV.length == 1) || 
-  (ARGV[0] == "help" && ARGV[1] == "app") || (ARGV[0] == "app" && ARGV.length == 1)
-  puts app_help
-  
-# merb-gen generators
-elsif ARGV[0] == "generators"
-  # List all the Available Generators
-  RubiGen::Base.use_component_sources! Merb.generator_scope
-  RubiGen::Scripts::Generate.new.run([])
- 
-# merb-gen help foo
-elsif ARGV[0] && ARGV[0] == "help"
-  begin
-    RubiGen::Base.use_component_sources! Merb.generator_scope
-    RubiGen::Base.lookup(ARGV[1])
-    Merb::ComponentGenerator.run ARGV[1], ARGV[2..-1], ARGV[1], command || "generate"
-  rescue RubiGen::GeneratorError
-    # List all the Available Generators
-    RubiGen::Base.use_component_sources! Merb.generator_scope
-    RubiGen::Scripts::Generate.new.run([]) 
-  rescue => e
-    puts e.message
-  end
-
-# merb-gen app myapp
-elsif ARGV[0] && ARGV[0] == "app" && ARGV[1] && ARGV[1] !~ /^-/
-  app_type = case ARGV[2]
-  when "--flat"
-    "merb_flat"
-  when "--very-flat"
-    "merb_very_flat"
-  else
-    "merb"
-  end
-  Merb::ApplicationGenerator.run ARGV[1], ARGV[3..-1], app_type, command || "generate"
-      
-# merb-gen plugin foo
-elsif ARGV[0] && ARGV[0] == "plugin"
-  Merb::ApplicationGenerator.run ARGV[1], ARGV[2..-1], "merb_plugin", command || "generate"
-
-# merb-gen controller foo
-# merb-gen resource foo --test
-elsif ARGV[1] && ARGV[1] !~ /^-/
-  Merb::ComponentGenerator.run ARGV[1], ARGV[1..-1], ARGV.first, command || "generate"
-
-# catch all merb-gen -??? and display help instead of creating application in -???
-elsif ARGV[0] && ARGV[0] =~ /^-/
-  puts app_help
-
-else
-  begin
-    # May be a generator that takes no arguments.
-    RubiGen::Base.use_component_sources! Merb.generator_scope
-    RubiGen::Base.lookup(ARGV[0])
-    Merb::ComponentGenerator.run ARGV[0], ARGV[1..-1], ARGV.first, command || "generate"
-  rescue RubiGen::GeneratorError
-    puts app_help
-  rescue => e
-    puts e.message
-  end  
-end
+Merb.start :environment => 'development', :log_level => 'error'

data/lib/generators/controller.rb

@@ -0,0 +1,44 @@
+module Merb::Generators
+  
+  class ControllerGenerator < NamespacedGenerator
+
+    def self.source_root
+      File.join(super, 'component', 'controller')
+    end
+    
+    desc <<-DESC
+      Generates a new controller.
+    DESC
+    
+    option :testing_framework, :desc => 'Testing framework to use (one of: spec, test_unit)'
+    option :template_engine, :default => :erb, :desc => 'Template engine to use (one of: erb, haml, markaby, etc...)'
+    
+    first_argument :name, :required => true, :desc => "controller name"
+    
+    invoke :helper
+    
+    template :controller do
+      source('app/controllers/%file_name%.rb')
+      destination("app/controllers", base_path, "#{file_name}.rb")
+    end
+    
+    template :index_erb, :template_engine => :erb do
+      source('app/views/%file_name%/index.html.erb')
+      destination("app/views", base_path, "#{file_name}/index.html.erb")
+    end
+    
+    template :controller_spec, :testing_framework => :rspec do
+      source('spec/controllers/%file_name%_spec.rb')
+      destination("spec/controllers", base_path, "#{file_name}_spec.rb")
+    end
+    
+    template :controller_test_unit, :testing_framework => :test_unit do
+      source('test/controllers/%file_name%_test.rb')
+      destination("test/controllers", base_path, "#{file_name}_test.rb")
+    end
+    
+  end
+  
+  add :controller, ControllerGenerator
+  
+end

data/lib/generators/freezer.rb

@@ -0,0 +1,19 @@
+module Merb::Generators
+  
+  class FreezerGenerator < Generator
+
+    def self.source_root
+      File.join(super, 'component', 'freezer')
+    end
+    
+    desc <<-DESC
+      Generates Merb freezer scripts.
+    DESC
+    
+    template :freezer, 'script/frozen_merb', 'script/frozen_merb'
+    
+  end
+  
+  add :freezer, FreezerGenerator
+  
+end

data/lib/generators/helper.rb

@@ -0,0 +1,31 @@
+module Merb::Generators
+  
+  class HelperGenerator < NamespacedGenerator
+
+    def self.source_root
+      File.join(super, 'component', 'helper')
+    end
+    
+    desc <<-DESC
+      Generates a new helper.
+    DESC
+    
+    option :testing_framework, :desc => 'Testing framework to use (one of: spec, test_unit)'
+    
+    first_argument :name, :required => true, :desc => "helper name"
+    
+    template :helper do
+      source('app/helpers/%file_name%_helper.rb')
+      destination("app/helpers", base_path, "#{file_name}_helper.rb")
+    end
+    
+    template :helper_spec, :testing_framework => :rspec do
+      source('spec/helpers/%file_name%_helper_spec.rb')
+      destination("spec/helpers", base_path, "#{file_name}_helper_spec.rb")
+    end
+    
+  end
+  
+  add :helper, HelperGenerator
+  
+end

data/lib/generators/layout.rb

@@ -0,0 +1,27 @@
+module Merb::Generators
+  
+  class LayoutGenerator < NamedGenerator
+
+    def self.source_root
+      File.join(super, 'component', 'layout')
+    end
+    
+    desc <<-DESC
+      Generates a layout
+    DESC
+    
+    #option :testing_framework, :desc => 'Testing framework to use (one of: rspec, test_unit)'
+    option :template_engine, :default => :erb, :desc => 'Specify what template engine should be used (one of: erb, haml...)'
+    
+    first_argument :name, :required => true, :desc => "layout name"
+    
+    template :layout_erb, :template_engine => :erb do
+      source('app/views/layout/%file_name%.html.erb')
+      destination("app/views/layout/#{file_name}.html.erb")
+    end
+    
+  end
+  
+  add :layout, LayoutGenerator
+  
+end

data/lib/generators/merb.rb

@@ -0,0 +1,24 @@
+module Merb::Generators
+  
+  class MerbGenerator < Generator
+
+    option :testing_framework, :default => :rspec, :desc => 'Testing framework to use (one of: spec, test_unit)'
+    option :orm, :default => :none, :desc => 'Object-Relation Mapper to use (one of: none, activerecord, datamapper, sequel)'
+    option :flat, :as => :boolean, :desc => "Generate a flat application: one file + configs + templates directory."
+    option :very_flat, :as => :boolean, :desc => "Generate a very flat, Sinatra-like one file application."
+    
+    desc <<-DESC
+      Generates a merb application.
+    DESC
+    
+    first_argument :name, :required => true, :desc => "Application name"
+    
+    invoke :app_full, :flat => nil, :very_flat => nil
+    invoke :app_flat, :flat => true
+    invoke :app_very_flat, :very_flat => true
+
+  end
+  
+  add :app, MerbGenerator
+  
+end

data/lib/generators/merb/merb_flat.rb

@@ -0,0 +1,27 @@
+module Merb::Generators
+  
+  class MerbFlatGenerator < NamedGenerator
+    
+    def self.source_root
+      File.join(super, 'application', 'merb_flat')
+    end
+    
+    desc <<-DESC
+      This generates a flat merb application: all code but config files and
+      templates fits in one application. This is something in between Sinatra
+      and "regular" Merb application.
+    DESC
+    
+    first_argument :name, :required => true, :desc => "Application name"
+    
+    glob!
+    
+    def destination_root
+      File.join(@destination_root, base_name)
+    end
+    
+  end
+  
+  add_private :app_flat, MerbFlatGenerator
+  
+end

data/lib/generators/merb/merb_full.rb

@@ -0,0 +1,35 @@
+module Merb::Generators
+  
+  class MerbFullGenerator < NamedGenerator
+
+    def self.source_root
+      File.join(super, 'application', 'merb')
+    end
+    
+    option :testing_framework, :default => :rspec, 
+                               :desc => 'Testing framework to use (one of: spec, test_unit).'                               
+    option :orm, :default => :none, 
+                 :desc => 'Object-Relation Mapper to use (one of: none, activerecord, datamapper, sequel).'
+    
+    desc <<-DESC
+      This generates a Merb application with Ruby on Rails like structure.
+      Generator lets you configure your ORM and testing framework of choice.
+    DESC
+    
+    glob!
+    
+    first_argument :name, :required => true, :desc => "Application name"
+    
+    invoke :layout do |generator|
+      generator.new(destination_root, options, 'application')
+    end
+    
+    def destination_root
+      File.join(@destination_root, base_name)
+    end
+    
+  end
+  
+  add_private :app_full, MerbFullGenerator
+  
+end