require 'generators/actions' module Rails module Generators class Error < Thor::Error end 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 @source_root ||= File.expand_path(File.join(File.dirname(__FILE__), base_name, generator_name, 'templates')) end # 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. # def self.namespace(name=nil) #:nodoc: if name super else @namespace ||= "#{base_name}:generators:#{generator_name}" end end protected # Check whether the given class names are already taken by Ruby or Rails. # In the future, expand to check other namespaces such as the rest of # the user's app. # 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 # Use Rails default banner. # def self.banner "#{$0} #{generator_name} #{self.arguments.map(&:usage).join(' ')} [options]" end # Sets the base_name taking into account the current class namespace. # def self.base_name #:nodoc: @base_name ||= self.name.split('::').first.underscore end # 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 klass_name = self.name.split('::').last klass_name.gsub!(/Generator$/, '') klass_name.underscore end end # 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']) class_option :ruby, :type => :string, :aliases => "-r", :default => default, :desc => "Path to the Ruby binary of your choice", :banner => "PATH" no_tasks do define_method :shebang do "#!#{options[:ruby] || "/usr/bin/env ruby"}" end end end # Small macro to add test_framework option and invoke it. # def self.add_and_invoke_test_framework_option! class_option :test_framework, :type => :string, :aliases => "-t", :default => "test_unit", :desc => "Test framework to be invoked by this generator", :banner => "NAME" define_method :invoke_test_framework do return unless options[:test_framework] name = "#{options[:test_framework]}:generators:#{self.class.generator_name}" begin invoke name rescue Thor::UndefinedTaskError say "Could not find and invoke '#{name}'." end end end # Small macro to add template engine option and invoke it. # def self.add_and_invoke_template_engine_option! class_option :template_engine, :type => :string, :aliases => "-e", :default => "erb", :desc => "Template engine to be invoked by this generator", :banner => "NAME" define_method :invoke_template_engine do return unless options[:template_engine] name = "#{options[:template_engine]}:generators:#{self.class.generator_name}" begin invoke name rescue Thor::UndefinedTaskError say "Could not find and invoke '#{name}'." end end end end end end