Class: ActiveSupport::Inflector::Inflections
- Includes:
- Singleton
- Defined in:
- lib/active_support/inflector.rb
Overview
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.
Instance Attribute Summary collapse
-
#humans ⇒ Object
readonly
Returns the value of attribute humans.
-
#plurals ⇒ Object
readonly
Returns the value of attribute plurals.
-
#singulars ⇒ Object
readonly
Returns the value of attribute singulars.
-
#uncountables ⇒ Object
readonly
Returns the value of attribute uncountables.
Instance Method Summary collapse
-
#clear(scope = :all) ⇒ Object
Clears the loaded inflections within a given scope (default is
:all
). -
#human(rule, replacement) ⇒ Object
Specifies a humanized form of a string by a regular expression rule or by a string mapping.
-
#initialize ⇒ Inflections
constructor
A new instance of Inflections.
-
#irregular(singular, plural) ⇒ Object
Specifies a new irregular that applies to both pluralization and singularization at the same time.
-
#plural(rule, replacement) ⇒ Object
Specifies a new pluralization rule and its replacement.
-
#singular(rule, replacement) ⇒ Object
Specifies a new singularization rule and its replacement.
-
#uncountable(*words) ⇒ Object
Add uncountable words that shouldn’t be attempted inflected.
Constructor Details
#initialize ⇒ Inflections
Returns a new instance of Inflections.
37 38 39 |
# File 'lib/active_support/inflector.rb', line 37 def initialize @plurals, @singulars, @uncountables, @humans = [], [], [], [] end |
Instance Attribute Details
#humans ⇒ Object (readonly)
Returns the value of attribute humans.
35 36 37 |
# File 'lib/active_support/inflector.rb', line 35 def humans @humans end |
#plurals ⇒ Object (readonly)
Returns the value of attribute plurals.
35 36 37 |
# File 'lib/active_support/inflector.rb', line 35 def plurals @plurals end |
#singulars ⇒ Object (readonly)
Returns the value of attribute singulars.
35 36 37 |
# File 'lib/active_support/inflector.rb', line 35 def singulars @singulars end |
#uncountables ⇒ Object (readonly)
Returns the value of attribute uncountables.
35 36 37 |
# File 'lib/active_support/inflector.rb', line 35 def uncountables @uncountables end |
Instance Method Details
#clear(scope = :all) ⇒ Object
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
105 106 107 108 109 110 111 112 |
# File 'lib/active_support/inflector.rb', line 105 def clear(scope = :all) case scope when :all @plurals, @singulars, @uncountables = [], [], [] else instance_variable_set "@#{scope}", [] end end |
#human(rule, replacement) ⇒ Object
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"
94 95 96 |
# File 'lib/active_support/inflector.rb', line 94 def human(rule, replacement) @humans.insert(0, [rule, replacement]) end |
#irregular(singular, plural) ⇒ Object
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'
63 64 65 66 67 68 69 70 71 72 73 74 75 |
# File 'lib/active_support/inflector.rb', line 63 def irregular(singular, plural) @uncountables.delete(singular) @uncountables.delete(plural) if singular[0,1].upcase == plural[0,1].upcase plural(Regexp.new("(#{singular[0,1]})#{singular[1..-1]}$", "i"), '\1' + plural[1..-1]) singular(Regexp.new("(#{plural[0,1]})#{plural[1..-1]}$", "i"), '\1' + singular[1..-1]) else plural(Regexp.new("#{singular[0,1].upcase}(?i)#{singular[1..-1]}$"), plural[0,1].upcase + plural[1..-1]) plural(Regexp.new("#{singular[0,1].downcase}(?i)#{singular[1..-1]}$"), plural[0,1].downcase + plural[1..-1]) singular(Regexp.new("#{plural[0,1].upcase}(?i)#{plural[1..-1]}$"), singular[0,1].upcase + singular[1..-1]) singular(Regexp.new("#{plural[0,1].downcase}(?i)#{plural[1..-1]}$"), singular[0,1].downcase + singular[1..-1]) end end |
#plural(rule, replacement) ⇒ Object
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.
43 44 45 46 47 |
# File 'lib/active_support/inflector.rb', line 43 def plural(rule, replacement) @uncountables.delete(rule) if rule.is_a?(String) @uncountables.delete(replacement) @plurals.insert(0, [rule, replacement]) end |
#singular(rule, replacement) ⇒ Object
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.
51 52 53 54 55 |
# File 'lib/active_support/inflector.rb', line 51 def singular(rule, replacement) @uncountables.delete(rule) if rule.is_a?(String) @uncountables.delete(replacement) @singulars.insert(0, [rule, replacement]) end |
#uncountable(*words) ⇒ Object
Add uncountable words that shouldn’t be attempted inflected.
Examples:
uncountable "money"
uncountable "money", "information"
uncountable %w( money information rice )
83 84 85 |
# File 'lib/active_support/inflector.rb', line 83 def uncountable(*words) (@uncountables << words).flatten! end |