Class | ActiveSupport::Inflector::Inflections |
In: |
vendor/rails/activesupport/lib/active_support/inflector.rb
|
Parent: | Object |
A singleton instance of this class is yielded by Inflector.inflections, which can then be used to specify additional inflection rules. Examples:
ActiveSupport::Inflector.inflections do |inflect| inflect.plural /^(ox)$/i, '\1\2en' inflect.singular /^(ox)en/i, '\1' inflect.irregular 'octopus', 'octopi' inflect.uncountable "equipment" end
New rules are added at the top. So in the example above, the irregular rule for octopus will now be the first of the pluralization and singularization rules that is runs. This guarantees that your rules run before any of the rules that may already have been loaded.
humans | [R] | |
plurals | [R] | |
singulars | [R] | |
uncountables | [R] |
# File vendor/rails/activesupport/lib/active_support/inflector.rb, line 37 37: def initialize 38: @plurals, @singulars, @uncountables, @humans = [], [], [], [] 39: end
Clears the loaded inflections within a given scope (default is :all). Give the scope as a symbol of the inflection type, the options are: :plurals, :singulars, :uncountables, :humans.
Examples:
clear :all clear :plurals
# File vendor/rails/activesupport/lib/active_support/inflector.rb, line 105 105: def clear(scope = :all) 106: case scope 107: when :all 108: @plurals, @singulars, @uncountables = [], [], [] 109: else 110: instance_variable_set "@#{scope}", [] 111: end 112: end
Specifies a humanized form of a string by a regular expression rule or by a string mapping. When using a regular expression based replacement, the normal humanize formatting is called after the replacement. When a string is used, the human form should be specified as desired (example: ‘The name’, not ‘the_name’)
Examples:
human /_cnt$/i, '\1_count' human "legacy_col_person_name", "Name"
# File vendor/rails/activesupport/lib/active_support/inflector.rb, line 94 94: def human(rule, replacement) 95: @humans.insert(0, [rule, replacement]) 96: end
Specifies a new irregular that applies to both pluralization and singularization at the same time. This can only be used for strings, not regular expressions. You simply pass the irregular in singular and plural form.
Examples:
irregular 'octopus', 'octopi' irregular 'person', 'people'
# File vendor/rails/activesupport/lib/active_support/inflector.rb, line 63 63: def irregular(singular, plural) 64: @uncountables.delete(singular) 65: @uncountables.delete(plural) 66: if singular[0,1].upcase == plural[0,1].upcase 67: plural(Regexp.new("(#{singular[0,1]})#{singular[1..-1]}$", "i"), '\1' + plural[1..-1]) 68: singular(Regexp.new("(#{plural[0,1]})#{plural[1..-1]}$", "i"), '\1' + singular[1..-1]) 69: else 70: plural(Regexp.new("#{singular[0,1].upcase}(?i)#{singular[1..-1]}$"), plural[0,1].upcase + plural[1..-1]) 71: plural(Regexp.new("#{singular[0,1].downcase}(?i)#{singular[1..-1]}$"), plural[0,1].downcase + plural[1..-1]) 72: singular(Regexp.new("#{plural[0,1].upcase}(?i)#{plural[1..-1]}$"), singular[0,1].upcase + singular[1..-1]) 73: singular(Regexp.new("#{plural[0,1].downcase}(?i)#{plural[1..-1]}$"), singular[0,1].downcase + singular[1..-1]) 74: end 75: end
Specifies a new pluralization rule and its replacement. The rule can either be a string or a regular expression. The replacement should always be a string that may include references to the matched data from the rule.
# File vendor/rails/activesupport/lib/active_support/inflector.rb, line 43 43: def plural(rule, replacement) 44: @uncountables.delete(rule) if rule.is_a?(String) 45: @uncountables.delete(replacement) 46: @plurals.insert(0, [rule, replacement]) 47: end
Specifies a new singularization rule and its replacement. The rule can either be a string or a regular expression. The replacement should always be a string that may include references to the matched data from the rule.
# File vendor/rails/activesupport/lib/active_support/inflector.rb, line 51 51: def singular(rule, replacement) 52: @uncountables.delete(rule) if rule.is_a?(String) 53: @uncountables.delete(replacement) 54: @singulars.insert(0, [rule, replacement]) 55: end
Add uncountable words that shouldn‘t be attempted inflected.
Examples:
uncountable "money" uncountable "money", "information" uncountable %w( money information rice )
# File vendor/rails/activesupport/lib/active_support/inflector.rb, line 83 83: def uncountable(*words) 84: (@uncountables << words).flatten! 85: end