Module: Lightrail::Generators
- Defined in:
- lib/lightrail/generators.rb,
lib/lightrail/generators/base.rb,
lib/lightrail/generators/app_base.rb,
lib/lightrail/generators/app_generator.rb
Defined Under Namespace
Classes: AppBase, AppGenerator, Base, Error
Constant Summary collapse
- DEFAULT_ALIASES =
{ :rails => { :actions => '-a', :orm => '-o', :javascripts => '-j', :javascript_engine => '-je', :resource_controller => '-c', :scaffold_controller => '-c', :stylesheets => '-y', :stylesheet_engine => '-se', :template_engine => '-e', :test_framework => '-t' }, :test_unit => { :fixture_replacement => '-r', } }
- DEFAULT_OPTIONS =
{ :rails => { :assets => true, :force_plural => false, :helper => true, :integration_tool => nil, :javascripts => true, :javascript_engine => :js, :orm => false, :performance_tool => nil, :resource_controller => :controller, :scaffold_controller => :scaffold_controller, :stylesheets => true, :stylesheet_engine => :css, :test_framework => false, :template_engine => :erb } }
- RAILS_DEV_PATH =
We need to store the RAILS_DEV_PATH in a constant, otherwise the path can change in Ruby 1.8.7 when we FileUtils.cd.
File.("../../../../../..", File.dirname(__FILE__))
- RESERVED_NAMES =
%w[application destroy benchmarker profiler plugin runner test]
Class Method Summary collapse
-
.aliases ⇒ Object
:nodoc:.
-
.configure!(config) ⇒ Object
:nodoc:.
-
.fallbacks ⇒ Object
Hold configured generators fallbacks.
-
.find_by_namespace(name, base = nil, context = nil) ⇒ Object
Rails finds namespaces similar to thor, it only adds one rule:.
-
.help(command = 'generate') ⇒ Object
Show help message with available generators.
- .hidden_namespaces ⇒ Object
- .hide_namespaces(*namespaces) ⇒ Object (also: hide_namespace)
-
.invoke(namespace, args = ARGV, config = {}) ⇒ Object
Receives a namespace, arguments and the behavior to invoke the generator.
-
.no_color! ⇒ Object
Remove the color from output.
-
.options ⇒ Object
:nodoc:.
-
.subclasses ⇒ Object
Track all generators subclasses.
- .templates_path ⇒ Object
Class Method Details
.aliases ⇒ Object
:nodoc:
74 75 76 |
# File 'lib/lightrail/generators.rb', line 74 def self.aliases #:nodoc: @aliases ||= DEFAULT_ALIASES.dup end |
.configure!(config) ⇒ Object
:nodoc:
60 61 62 63 64 65 66 67 68 |
# File 'lib/lightrail/generators.rb', line 60 def self.configure!(config) #:nodoc: no_color! unless config.colorize_logging aliases.deep_merge! config.aliases .deep_merge! config. fallbacks.merge! config.fallbacks templates_path.concat config.templates templates_path.uniq! hide_namespaces(*config.hidden_namespaces) end |
.fallbacks ⇒ Object
Hold configured generators fallbacks. If a plugin developer wants a generator group to fallback to another group in case of missing generators, they can add a fallback.
For example, shoulda is considered a test_framework and is an extension of test_unit. However, most part of shoulda generators are similar to test_unit ones.
Shoulda then can tell generators to search for test_unit generators when some of them are not available by adding a fallback:
Rails::Generators.fallbacks[:shoulda] = :test_unit
95 96 97 |
# File 'lib/lightrail/generators.rb', line 95 def self.fallbacks @fallbacks ||= {} end |
.find_by_namespace(name, base = nil, context = nil) ⇒ Object
Rails finds namespaces similar to thor, it only adds one rule:
Generators names must end with “_generator.rb”. This is required because Rails looks in load paths and loads the generator just before it’s going to be used.
Examples
find_by_namespace :webrat, :rails, :integration
Will search for the following generators:
"rails:webrat", "webrat:integration", "webrat"
Notice that “rails:generators:webrat” could be loaded as well, what Rails looks for is the first and last parts of the namespace.
125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 |
# File 'lib/lightrail/generators.rb', line 125 def self.find_by_namespace(name, base=nil, context=nil) #:nodoc: lookups = [] lookups << "#{base}:#{name}" if base lookups << "#{name}:#{context}" if context unless base || context unless name.to_s.include?(?:) lookups << "#{name}:#{name}" lookups << "rails:#{name}" end lookups << "#{name}" end lookup(lookups) namespaces = Hash[subclasses.map { |klass| [klass.namespace, klass] }] lookups.each do |namespace| klass = namespaces[namespace] return klass if klass end invoke_fallbacks_for(name, base) || invoke_fallbacks_for(context, name) end |
.help(command = 'generate') ⇒ Object
Show help message with available generators.
204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 |
# File 'lib/lightrail/generators.rb', line 204 def self.help(command = 'generate') lookup! namespaces = subclasses.map{ |k| k.namespace } namespaces.sort! groups = Hash.new { |h,k| h[k] = [] } namespaces.each do |namespace| base = namespace.split(':').first groups[base] << namespace end puts "Usage: lightrail #{command} GENERATOR [args] [options]" puts puts "General options:" puts " -h, [--help] # Print generator's options and usage" puts " -p, [--pretend] # Run but do not make any changes" puts " -f, [--force] # Overwrite files that already exist" puts " -s, [--skip] # Skip files that already exist" puts " -q, [--quiet] # Suppress status output" puts puts "Please choose a generator below." puts # Print Rails defaults first. rails = groups.delete("rails") rails.map! { |n| n.sub(/^rails:/, '') } rails.delete("app") rails.delete("plugin_new") print_list("rails", rails) hidden_namespaces.each {|n| groups.delete(n.to_s) } groups.sort.each { |b, n| print_list(b, n) } end |
.hidden_namespaces ⇒ Object
163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 |
# File 'lib/lightrail/generators.rb', line 163 def self.hidden_namespaces @hidden_namespaces ||= begin orm = [:rails][:orm] test = [:rails][:test_framework] template = [:rails][:template_engine] css = [:rails][:stylesheet_engine] [ "rails", "#{orm}:migration", "#{orm}:model", "#{orm}:observer", "#{orm}:session_migration", "#{test}:controller", "#{test}:helper", "#{test}:integration", "#{test}:mailer", "#{test}:model", "#{test}:observer", "#{test}:scaffold", "#{test}:view", "#{test}:performance", "#{template}:controller", "#{template}:scaffold", "#{template}:mailer", "#{css}:scaffold", "#{css}:assets", "css:assets", "css:scaffold" ] end end |
.hide_namespaces(*namespaces) ⇒ Object Also known as: hide_namespace
197 198 199 |
# File 'lib/lightrail/generators.rb', line 197 def hide_namespaces(*namespaces) hidden_namespaces.concat(namespaces) end |
.invoke(namespace, args = ARGV, config = {}) ⇒ Object
Receives a namespace, arguments and the behavior to invoke the generator. It’s used as the default entry point for generate, destroy and update commands.
153 154 155 156 157 158 159 160 161 |
# File 'lib/lightrail/generators.rb', line 153 def self.invoke(namespace, args=ARGV, config={}) names = namespace.to_s.split(':') if klass = find_by_namespace(names.pop, names.any? && names.join(':')) args << "--help" if args.empty? && klass.arguments.any? { |a| a.required? } klass.start(args, config) else puts "Could not find generator #{namespace}." end end |
.no_color! ⇒ Object
Remove the color from output.
100 101 102 |
# File 'lib/lightrail/generators.rb', line 100 def self.no_color! Thor::Base.shell = Thor::Shell::Basic end |
.options ⇒ Object
:nodoc:
78 79 80 |
# File 'lib/lightrail/generators.rb', line 78 def self. #:nodoc: @options ||= DEFAULT_OPTIONS.dup end |
.subclasses ⇒ Object
Track all generators subclasses.
105 106 107 |
# File 'lib/lightrail/generators.rb', line 105 def self.subclasses @subclasses ||= [] end |
.templates_path ⇒ Object
70 71 72 |
# File 'lib/lightrail/generators.rb', line 70 def self.templates_path @templates_path ||= [] end |