модуль Rails::Generators
Константы
- DEFAULT_ALIASES
- DEFAULT_OPTIONS
- RAILS_DEV_PATH
-
Нам необходимо хранить RAILS_DEV_PATH в константе, иначе путь может измениться в Ruby 1.8.7 при использовании FileUtils.cd.
- RESERVED_NAMES
Публичные методы класса
# File railties/lib/rails/generators.rb, line 115
def api_only!
hide_namespaces "assets", "helper", "css", "js"
options[:rails].merge!(
api: true,
assets: false,
helper: false,
template_engine: nil
)
if ARGV.first == "mailer"
options[:rails].merge!(template_engine: :erb)
end
end Настройка генераторов для приложений только для API. В основном скрывает всё, что обычно связано с браузером, например, генераторы активов и миграций сессий, и полностью отключает помощники и активы, чтобы генераторы, такие как scaffold, не создавали их.
# File railties/lib/rails/generators.rb, line 107
def fallbacks
@fallbacks ||= {}
end Хранит настроенные резервные генераторы. Если разработчик плагина хочет, чтобы группа генераторов переходила на другую группу в случае отсутствия генераторов, он может добавить резервную копию.
Например, shoulda считается test_framework и является расширением test_unit. Однако большая часть генераторов shoulda похожа на генераторы test_unit.
Shoulda затем может указать генераторам искать генераторы test_unit, когда некоторые из них недоступны, добавив резервную копию:
Rails::Generators.fallbacks[:shoulda] = :test_unit
# File railties/lib/rails/generators.rb, line 178
def help(command = "generate")
puts "Usage: rails #{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_generators
end Показать сообщение справки с доступными генераторами.
Возвращает массив имен пространств генераторов, которые скрыты. Имена пространств генераторов могут быть скрыты по различным причинам. Некоторые из них алиасированы, например, «rails:migration», и их можно вызывать с более коротким именем «migration», другие являются частными для других генераторов, например, «css:scaffold».
# File railties/lib/rails/generators.rb, line 172 def hide_namespaces(*namespaces) hidden_namespaces.concat(namespaces) end
# File railties/lib/rails/generators.rb, line 265
def 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?(&:required?)
klass.start(args, config)
else
options = sorted_groups.flat_map(&:last)
suggestions = options.sort_by { |suggested| levenshtein_distance(namespace.to_s, suggested) }.first(3)
msg = "Could not find generator '#{namespace}'. "
msg << "Maybe you meant #{ suggestions.map { |s| "'#{s}'" }.to_sentence(last_word_connector: " or ", locale: :en) }\n"
msg << "Run `rails generate --help` for more options."
puts msg
end
end Принимает имя пространства, аргументы и поведение для вызова генератора. Используется в качестве точки входа по умолчанию для команд generate, destroy и update.
# File railties/lib/rails/generators.rb, line 131 def no_color! Thor::Base.shell = Thor::Shell::Basic end
Удалить цвет из вывода.
# File railties/lib/rails/generators.rb, line 199
def print_generators
sorted_groups.each { |b, n| print_list(b, n) }
end # File railties/lib/rails/generators.rb, line 194 def public_namespaces lookup! subclasses.map(&:namespace) end
# File railties/lib/rails/generators.rb, line 203
def sorted_groups
namespaces = public_namespaces
namespaces.sort!
groups = Hash.new { |h, k| h[k] = [] }
namespaces.each do |namespace|
base = namespace.split(":").first
groups[base] << namespace
end
rails = groups.delete("rails")
rails.map! { |n| n.sub(/^rails:/, "") }
rails.delete("app")
rails.delete("plugin")
rails.delete("encrypted_secrets")
hidden_namespaces.each { |n| groups.delete(n.to_s) }
[[ "rails", rails ]] + groups.sort.to_a
end Приватные методы класса
# File railties/lib/rails/generators.rb, line 303 def command_type # :doc: @command_type ||= "generator" end
# File railties/lib/rails/generators.rb, line 311
def file_lookup_paths # :doc:
@file_lookup_paths ||= [ "{#{lookup_paths.join(',')}}", "**", "*_generator.rb" ]
end # File railties/lib/rails/generators.rb, line 307 def lookup_paths # :doc: @lookup_paths ||= %w( rails/generators generators ) end
# File railties/lib/rails/generators.rb, line 282
def print_list(base, namespaces) # :doc:
namespaces = namespaces.reject { |n| hidden_namespaces.include?(n) }
super
end
© 2004–2018 David Heinemeier Hansson
Licensed under the MIT License.