Spec-Zone.ru › Ruby on Rails 8.1

module Rails::Generators

Константы

DEFAULT_ALIASES
DEFAULT_OPTIONS

Открытые методы класса

api_only! () Показать исходный код
# File railties/lib/rails/generators.rb, line 116
def api_only!
  hide_namespaces "assets", "helper", "css", "js"

  options[:rails].merge!(
    api: true,
    assets: false,
    helper: false,
    template_engine: nil
  )

  options[:mailer] ||= {}
  options[:mailer][:template_engine] ||= :erb
end

Настраивает генераторы только для приложений API. По сути, скрывает всё, что обычно связано с браузером, например генераторы ресурсов и миграций сессий, а также полностью отключает хелперы и ресурсы, чтобы такие генераторы, как scaffold, не создавали их.

fallbacks () Показать исходный код
# File railties/lib/rails/generators.rb, line 108
def fallbacks
  @fallbacks ||= {}
end

Хранит настроенные резервные генераторы. Если разработчик плагина хочет, чтобы группа генераторов использовала другую группу в качестве резервной, когда нужные генераторы отсутствуют, он может добавить резервную группу.

Например, shoulda считается test_framework и является расширением test_unit. Однако большинство генераторов shoulda похожи на генераторы test_unit.

Поэтому shoulda может указать генераторам искать генераторы test_unit, если некоторые из них недоступны, добавив резервную группу:

Rails::Generators.fallbacks[:shoulda] = :test_unit
help (command = "generate") Показать исходный код
# File railties/lib/rails/generators.rb, line 172
def help(command = "generate")
  puts "Usage:"
  puts "  bin/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

Показывает справочное сообщение с доступными генераторами.

hidden_namespaces () Показать исходный код
# File railties/lib/rails/generators.rb, line 134
def hidden_namespaces
  @hidden_namespaces ||= begin
    orm      = options[:rails][:orm]
    test     = options[:rails][:test_framework]
    template = options[:rails][:template_engine]

    [
      "rails",
      "resource_route",
      "#{orm}:migration",
      "#{orm}:model",
      "#{test}:controller",
      "#{test}:helper",
      "#{test}:integration",
      "#{test}:system",
      "#{test}:mailer",
      "#{test}:model",
      "#{test}:scaffold",
      "#{test}:view",
      "#{test}:job",
      "#{template}:controller",
      "#{template}:scaffold",
      "#{template}:mailer",
      "action_text:install",
      "action_mailbox:install",
      "devcontainer"
    ].tap do |h|
      h << "test_unit" if test.to_s != "test_unit"
    end
  end
end

Возвращает массив скрытых пространств имён генераторов. Пространства имён генераторов могут быть скрыты по разным причинам. Некоторые из них имеют псевдонимы, например «rails:migration», и могут вызываться по сокращённому имени «migration».

hide_namespace (*namespaces)
Псевдоним для: hide_namespaces
hide_namespaces (*namespaces) Показать исходный код
# File railties/lib/rails/generators.rb, line 166
def hide_namespaces(*namespaces)
  hidden_namespaces.concat(namespaces)
end
Также имеет псевдоним: hide_namespace
invoke (namespace, args = ARGV, config = {}) Показать исходный код
# File railties/lib/rails/generators.rb, line 263
      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)
          run_after_generate_callback if config[:behavior] == :invoke
        else
          options = sorted_groups.flat_map(&:last)
          error = Command::CorrectableNameError.new("Could not find generator '#{namespace}'.", namespace, options)

          puts <<~MSG
            #{error.detailed_message}
            Run `bin/rails generate --help` for more options.
          MSG
          exit 1
        end
      end

Принимает пространство имён, аргументы и поведение для вызова генератора. Используется как точка входа по умолчанию для команд generate, destroy и update.

print_generators () Показать исходный код
# File railties/lib/rails/generators.rb, line 194
def print_generators
  sorted_groups.each { |b, n| print_list(b, n) }
end
public_namespaces () Показать исходный код
# File railties/lib/rails/generators.rb, line 189
def public_namespaces
  lookup!
  subclasses.map(&:namespace)
end
sorted_groups () Показать исходный код
# File railties/lib/rails/generators.rb, line 198
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.delete_prefix("rails:") }
  rails.delete("app")
  rails.delete("plugin")
  rails.delete("encrypted_file")
  rails.delete("encryption_key_file")
  rails.delete("master_key")
  rails.delete("credentials")
  rails.delete("db:system:change")

  hidden_namespaces.each { |n| groups.delete(n.to_s) }

  [[ "rails", rails ]] + groups.sort.to_a
end

Закрытые методы класса

command_type () Показать исходный код
# File railties/lib/rails/generators.rb, line 308
def command_type # :doc:
  @command_type ||= "generator"
end
file_lookup_paths () Показать исходный код
# File railties/lib/rails/generators.rb, line 316
def file_lookup_paths # :doc:
  @file_lookup_paths ||= [ "{#{lookup_paths.join(',')}}", "**", "*_generator.rb" ]
end
lookup_paths () Показать исходный код
# File railties/lib/rails/generators.rb, line 312
def lookup_paths # :doc:
  @lookup_paths ||= %w( rails/generators generators )
end
print_list (base, namespaces) Показать исходный код
# File railties/lib/rails/generators.rb, line 287
def print_list(base, namespaces) # :doc:
  namespaces = namespaces.reject { |n| hidden_namespaces.include?(n) }
  super
end
Вызывает метод суперкласса

© 2004–2021 David Heinemeier Hansson
Licensed under the MIT License.

Spec-Zone.ru

Настройки Оффлайн Что нового Помощь О нас
Spec-Zone .ru
спецификации, руководства, описания, API