2009-06-23 17:10:42 +00:00
|
|
|
require 'generators/actions'
|
2009-06-21 08:06:02 +00:00
|
|
|
|
2009-06-16 15:10:40 +00:00
|
|
|
module Rails
|
|
|
|
module Generators
|
2009-06-25 13:45:15 +00:00
|
|
|
DEFAULTS = {
|
|
|
|
:test_framework => 'test_unit',
|
2009-06-26 18:24:52 +00:00
|
|
|
:template_engine => 'erb',
|
|
|
|
:helper => true
|
2009-06-25 13:45:15 +00:00
|
|
|
}
|
|
|
|
|
2009-06-23 18:42:29 +00:00
|
|
|
class Error < Thor::Error
|
|
|
|
end
|
|
|
|
|
2009-06-16 15:10:40 +00:00
|
|
|
class Base < Thor::Group
|
|
|
|
include Rails::Generators::Actions
|
|
|
|
include Thor::Actions
|
|
|
|
|
|
|
|
# Automatically sets the source root based on the class name.
|
|
|
|
#
|
|
|
|
def self.source_root
|
2009-06-23 17:27:46 +00:00
|
|
|
@source_root ||= File.expand_path(File.join(File.dirname(__FILE__), base_name, generator_name, 'templates'))
|
2009-06-23 12:42:59 +00:00
|
|
|
end
|
|
|
|
|
2009-06-25 11:46:19 +00:00
|
|
|
# Tries to get the description from a USAGE file one folder above the source
|
|
|
|
# root otherwise uses a default description.
|
|
|
|
#
|
|
|
|
def self.desc(description=nil)
|
|
|
|
return super if description
|
|
|
|
usage = File.join(source_root, "..", "USAGE")
|
|
|
|
|
|
|
|
@desc ||= if File.exist?(usage)
|
|
|
|
File.read(usage)
|
|
|
|
else
|
|
|
|
"Description:\n Create #{base_name.humanize.downcase} files for #{generator_name} generator."
|
|
|
|
end
|
|
|
|
end
|
|
|
|
|
2009-06-24 13:33:38 +00:00
|
|
|
# Convenience method to get the namespace from the class name. It's the
|
|
|
|
# same as Thor default except that the Generator at the end of the class
|
|
|
|
# is removed.
|
2009-06-23 12:42:59 +00:00
|
|
|
#
|
2009-06-25 11:46:19 +00:00
|
|
|
def self.namespace(name=nil)
|
|
|
|
return super if name
|
|
|
|
@namespace ||= "#{base_name}:generators:#{generator_name}"
|
2009-06-16 15:10:40 +00:00
|
|
|
end
|
2009-06-17 17:23:42 +00:00
|
|
|
|
2009-06-26 18:26:10 +00:00
|
|
|
# Invoke a generator based on the value supplied by the user to the
|
|
|
|
# given option named "name". A class option is created when this method
|
|
|
|
# is invoked and you can set a hash to customize it, although type and
|
|
|
|
# default values cannot be given.
|
|
|
|
#
|
|
|
|
# ==== Examples
|
|
|
|
#
|
|
|
|
# class ControllerGenerator < Rails::Generators::Base
|
|
|
|
# invoke_for :test_framework, :aliases => "-t"
|
|
|
|
# end
|
|
|
|
#
|
|
|
|
# The example above will create a test framework option and will invoke
|
|
|
|
# a generator based on the user supplied value.
|
|
|
|
#
|
|
|
|
# For example, if the user invoke the controller generator as:
|
|
|
|
#
|
|
|
|
# ruby script/generate controller Account --test-framework=test_unit
|
|
|
|
#
|
|
|
|
# The controller generator will then invoke "test_unit:generators:controller".
|
|
|
|
# If it can't be found it then tries to invoke only "test_unit".
|
|
|
|
#
|
|
|
|
# This allows any test framework to hook into Rails as long as it
|
|
|
|
# provides a "test_framework:generators:controller" generator.
|
|
|
|
#
|
|
|
|
# Finally, if the user don't want to use any test framework, he can do:
|
|
|
|
#
|
|
|
|
# ruby script/generate controller Account --skip-test-framework
|
|
|
|
#
|
|
|
|
# Or similarly:
|
|
|
|
#
|
|
|
|
# ruby script/generate controller Account --no-test-framework
|
|
|
|
#
|
|
|
|
def self.invoke_for(*names)
|
|
|
|
default_options = names.extract_options!
|
|
|
|
|
|
|
|
names.each do |name|
|
|
|
|
options = default_options.dup
|
|
|
|
options[:desc] ||= "#{name.to_s.humanize} to be used"
|
|
|
|
options[:banner] ||= "NAME"
|
|
|
|
options[:aliases] ||= "-" + name.to_s.gsub(/_framework$/, '').split('_').last[0,1]
|
|
|
|
|
|
|
|
class_option name, options.merge!(:type => :default, :default => DEFAULTS[name])
|
|
|
|
|
|
|
|
class_eval <<-METHOD, __FILE__, __LINE__
|
|
|
|
def invoke_#{name}
|
|
|
|
return unless options[#{name.inspect}]
|
|
|
|
|
|
|
|
klass = Rails::Generators.find_by_namespace(options[#{name.inspect}],
|
|
|
|
nil, self.class.generator_name)
|
|
|
|
|
|
|
|
if klass
|
|
|
|
invoke klass
|
|
|
|
else
|
|
|
|
task = "\#{options[#{name.inspect}]}:generators:\#{self.class.generator_name}"
|
|
|
|
say "Could not find and invoke '\#{task}'."
|
|
|
|
end
|
|
|
|
end
|
|
|
|
METHOD
|
|
|
|
end
|
|
|
|
end
|
|
|
|
|
|
|
|
# Invoke a generator with the given name if the user requires it. The
|
|
|
|
# difference to invoke_for is that the class option here is boolean
|
|
|
|
# and the generator invoked is not based on user input.
|
|
|
|
#
|
|
|
|
# A class option is created when this method is invoked and you can set
|
|
|
|
# a hash to customize it, although type and default values cannot be
|
|
|
|
# given.
|
|
|
|
#
|
|
|
|
# ==== Examples
|
|
|
|
#
|
|
|
|
# class ControllerGenerator < Rails::Generators::Base
|
|
|
|
# invoke_if :webrat, :aliases => "-w"
|
|
|
|
# end
|
|
|
|
#
|
|
|
|
# The example above will create a helper option and will be invoked
|
|
|
|
# when the user requires so:
|
|
|
|
#
|
|
|
|
# ruby script/generate controller Account --webrat
|
|
|
|
#
|
|
|
|
# The controller generator will then try to invoke the following generators:
|
|
|
|
#
|
|
|
|
# "rails:generators:webrat", "webrat:generators:controller", "webrat"
|
|
|
|
#
|
|
|
|
def self.invoke_if(*names)
|
|
|
|
default_options = names.extract_options!
|
|
|
|
|
|
|
|
names.each do |name|
|
|
|
|
options = default_options.dup
|
|
|
|
options[:desc] ||= "Indicates when to use #{name.to_s.humanize}"
|
|
|
|
options[:aliases] ||= "-" + name.to_s.last[0,1]
|
|
|
|
|
|
|
|
class_option name, options.merge!(:type => :boolean, :default => DEFAULTS[name] || false)
|
|
|
|
|
|
|
|
class_eval <<-METHOD, __FILE__, __LINE__
|
|
|
|
def invoke_#{name}
|
|
|
|
return unless options[#{name.inspect}]
|
|
|
|
|
|
|
|
klass = Rails::Generators.find_by_namespace(#{name.inspect},
|
|
|
|
self.class.base_name, self.class.generator_name)
|
|
|
|
|
|
|
|
if klass
|
|
|
|
invoke klass
|
|
|
|
else
|
|
|
|
say "Could not find and invoke '#{name.inspect}'."
|
|
|
|
end
|
|
|
|
end
|
|
|
|
METHOD
|
|
|
|
end
|
|
|
|
end
|
|
|
|
|
2009-06-23 17:27:46 +00:00
|
|
|
protected
|
2009-06-21 07:34:32 +00:00
|
|
|
|
2009-06-26 08:40:02 +00:00
|
|
|
# Check whether the given class names are already taken by user
|
|
|
|
# application or Ruby on Rails.
|
2009-06-25 09:56:18 +00:00
|
|
|
#
|
|
|
|
def class_collisions(*class_names)
|
|
|
|
return unless behavior == :invoke
|
|
|
|
|
|
|
|
class_names.flatten.each do |class_name|
|
|
|
|
class_name = class_name.to_s
|
|
|
|
next if class_name.strip.empty?
|
|
|
|
|
|
|
|
# Split the class from its module nesting
|
|
|
|
nesting = class_name.split('::')
|
|
|
|
last_name = nesting.pop
|
|
|
|
|
|
|
|
# Hack to limit const_defined? to non-inherited on 1.9
|
|
|
|
extra = []
|
|
|
|
extra << false unless Object.method(:const_defined?).arity == 1
|
|
|
|
|
|
|
|
# Extract the last Module in the nesting
|
|
|
|
last = nesting.inject(Object) do |last, nest|
|
|
|
|
break unless last.const_defined?(nest, *extra)
|
|
|
|
last.const_get(nest)
|
|
|
|
end
|
|
|
|
|
|
|
|
if last && last.const_defined?(last_name.camelize, *extra)
|
|
|
|
raise Error, "The name '#{class_name}' is either already used in your application " <<
|
|
|
|
"or reserved by Ruby on Rails. Please choose an alternative and run " <<
|
|
|
|
"this generator again."
|
|
|
|
end
|
|
|
|
end
|
|
|
|
end
|
|
|
|
|
2009-06-23 17:27:46 +00:00
|
|
|
# Use Rails default banner.
|
|
|
|
#
|
|
|
|
def self.banner
|
|
|
|
"#{$0} #{generator_name} #{self.arguments.map(&:usage).join(' ')} [options]"
|
|
|
|
end
|
2009-06-23 12:42:59 +00:00
|
|
|
|
2009-06-24 13:33:38 +00:00
|
|
|
# Sets the base_name taking into account the current class namespace.
|
2009-06-23 17:27:46 +00:00
|
|
|
#
|
2009-06-25 11:46:19 +00:00
|
|
|
def self.base_name
|
2009-06-24 13:33:38 +00:00
|
|
|
@base_name ||= self.name.split('::').first.underscore
|
2009-06-23 12:42:59 +00:00
|
|
|
end
|
2009-06-21 07:34:32 +00:00
|
|
|
|
2009-06-23 17:27:46 +00:00
|
|
|
# Removes the namespaces and get the generator name. For example,
|
|
|
|
# Rails::Generators::MetalGenerator will return "metal" as generator name.
|
|
|
|
#
|
|
|
|
def self.generator_name
|
|
|
|
@generator_name ||= begin
|
2009-06-23 18:42:29 +00:00
|
|
|
klass_name = self.name.split('::').last
|
2009-06-23 17:27:46 +00:00
|
|
|
klass_name.gsub!(/Generator$/, '')
|
|
|
|
klass_name.underscore
|
|
|
|
end
|
|
|
|
end
|
2009-06-17 21:07:19 +00:00
|
|
|
|
2009-06-23 17:27:46 +00:00
|
|
|
# Small macro to add ruby as an option to the generator with proper
|
|
|
|
# default value plus an instance helper method called shebang.
|
|
|
|
#
|
|
|
|
def self.add_shebang_option!
|
|
|
|
require 'rbconfig'
|
|
|
|
default = File.join(Config::CONFIG['bindir'], Config::CONFIG['ruby_install_name'])
|
2009-06-17 21:07:19 +00:00
|
|
|
|
2009-06-23 17:27:46 +00:00
|
|
|
class_option :ruby, :type => :string, :aliases => "-r", :default => default,
|
2009-06-24 13:33:38 +00:00
|
|
|
:desc => "Path to the Ruby binary of your choice", :banner => "PATH"
|
2009-06-23 17:27:46 +00:00
|
|
|
|
2009-06-23 17:45:50 +00:00
|
|
|
no_tasks do
|
|
|
|
define_method :shebang do
|
2009-06-23 17:27:46 +00:00
|
|
|
"#!#{options[:ruby] || "/usr/bin/env ruby"}"
|
|
|
|
end
|
2009-06-17 21:07:19 +00:00
|
|
|
end
|
|
|
|
end
|
|
|
|
|
|
|
|
end
|
2009-06-16 15:10:40 +00:00
|
|
|
end
|
|
|
|
end
|