Module: Rails::Generators::ModelHelpers

Included in:
ModelGenerator
Defined in:
railties/lib/rails/generators/model_helpers.rb

Overview

:nodoc:

Constant Summary collapse

PLURAL_MODEL_NAME_WARN_MESSAGE =
"[WARNING] The model name '%s' was recognized as a plural, using the singular '%s' instead. " \
"Override with --force-plural or setup custom inflection rules for this noun before running the generator."
IRREGULAR_MODEL_NAME_WARN_MESSAGE =
<<~WARNING
[WARNING] Rails cannot recover singular form from its plural form '%s'.
Please setup custom inflection rules for this noun before running the generator in config/initializers/inflections.rb.
WARNING
INFLECTION_IMPOSSIBLE_ERROR_MESSAGE =
<<~ERROR
Rails cannot recover the underscored form from its camelcase form '%s'.
Please use an underscored name instead, either '%s' or '%s'.
Or setup custom inflection rules for this noun before running the generator in config/initializers/inflections.rb.
ERROR

Class Method Summary collapse

Instance Method Summary collapse

Class Method Details

.included(base) ⇒ Object

:nodoc:


21
22
23
# File 'railties/lib/rails/generators/model_helpers.rb', line 21

def self.included(base) # :nodoc:
  base.class_option :force_plural, type: :boolean, default: false, desc: "Forces the use of the given model name"
end

Instance Method Details

#initialize(args, *_options) ⇒ Object


25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
# File 'railties/lib/rails/generators/model_helpers.rb', line 25

def initialize(args, *_options)
  super
  if plural_model_name?(name) && !options[:force_plural]
    singular = name.singularize
    unless ModelHelpers.skip_warn
      say PLURAL_MODEL_NAME_WARN_MESSAGE % [name, singular]
    end
    name.replace singular
    assign_names!(name)
  end
  if inflection_impossible?(name)
    option1 = name.singularize.underscore
    option2 = name.pluralize.underscore.singularize
    raise Error, INFLECTION_IMPOSSIBLE_ERROR_MESSAGE % [name, option1, option2]
  end
  if irregular_model_name?(name) && ! ModelHelpers.skip_warn
    say IRREGULAR_MODEL_NAME_WARN_MESSAGE % [name.pluralize]
  end
  ModelHelpers.skip_warn = true
end