Module: String::Inflections
- Defined in:
- lib/core_ext/string.rb
Overview
This module acts as a singleton returned/yielded by String.inflections, which is used to override or specify additional inflection rules. Examples:
String.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.
Constant Summary collapse
- DEFAULT_INFLECTIONS_PROC =
Proc that is instance evaled to create the default inflections for both the model inflector and the inflector extension.
proc do plural(/$/, 's') plural(/s$/i, 's') plural(/(alias|(?:stat|octop|vir|b)us)$/i, '\1es') plural(/(buffal|tomat)o$/i, '\1oes') plural(/([ti])um$/i, '\1a') plural(/sis$/i, 'ses') plural(/(?:([^f])fe|([lr])f)$/i, '\1\2ves') plural(/(hive)$/i, '\1s') plural(/([^aeiouy]|qu)y$/i, '\1ies') plural(/(x|ch|ss|sh)$/i, '\1es') plural(/(matr|vert|ind)ix|ex$/i, '\1ices') plural(/([m|l])ouse$/i, '\1ice') singular(/s$/i, '') singular(/([ti])a$/i, '\1um') singular(/(analy|ba|cri|diagno|parenthe|progno|synop|the)ses$/i, '\1sis') singular(/([^f])ves$/i, '\1fe') singular(/([h|t]ive)s$/i, '\1') singular(/([lr])ves$/i, '\1f') singular(/([^aeiouy]|qu)ies$/i, '\1y') singular(/(m)ovies$/i, '\1ovie') singular(/(x|ch|ss|sh)es$/i, '\1') singular(/([m|l])ice$/i, '\1ouse') singular(/buses$/i, 'bus') singular(/oes$/i, 'o') singular(/shoes$/i, 'shoe') singular(/(alias|(?:stat|octop|vir|b)us)es$/i, '\1') singular(/(vert|ind)ices$/i, '\1ex') singular(/matrices$/i, 'matrix') irregular('person', 'people') irregular('man', 'men') irregular('child', 'children') irregular('sex', 'sexes') irregular('move', 'moves') irregular('quiz', 'quizzes') irregular('testis', 'testes') uncountable(%w(equipment information rice money species series fish sheep news)) end
Class Attribute Summary collapse
-
.plurals ⇒ Object
readonly
Array of 2 element arrays, first containing a regex, and the second containing a substitution pattern, used for plurization.
-
.singulars ⇒ Object
readonly
Array of 2 element arrays, first containing a regex, and the second containing a substitution pattern, used for singularization.
-
.uncountables ⇒ Object
readonly
Array of strings for words were the singular form is the same as the plural form.
Class Method Summary collapse
-
.clear(scope = :all) ⇒ Object
Clears the loaded inflections within a given scope (default is :all).
-
.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.
Class Attribute Details
.plurals ⇒ Object (readonly)
Array of 2 element arrays, first containing a regex, and the second containing a substitution pattern, used for plurization.
76 77 78 |
# File 'lib/core_ext/string.rb', line 76 def plurals @plurals end |
.singulars ⇒ Object (readonly)
Array of 2 element arrays, first containing a regex, and the second containing a substitution pattern, used for singularization.
80 81 82 |
# File 'lib/core_ext/string.rb', line 80 def singulars @singulars end |
.uncountables ⇒ Object (readonly)
Array of strings for words were the singular form is the same as the plural form
83 84 85 |
# File 'lib/core_ext/string.rb', line 83 def uncountables @uncountables end |
Class 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
Examples:
clear :all
clear :plurals
92 93 94 95 96 97 98 99 100 101 |
# File 'lib/core_ext/string.rb', line 92 def self.clear(scope = :all) case scope when :all @plurals = [] @singulars = [] @uncountables = [] else instance_variable_set("@#{scope}", []) end 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'
110 111 112 113 |
# File 'lib/core_ext/string.rb', line 110 def self.irregular(singular, plural) 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]) 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.
Example:
plural(/(x|ch|ss|sh)$/i, '\1es')
121 122 123 |
# File 'lib/core_ext/string.rb', line 121 def self.plural(rule, 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.
Example:
singular(/([^aeiouy]|qu)ies$/i, '\1y')
131 132 133 |
# File 'lib/core_ext/string.rb', line 131 def self.singular(rule, 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 )
141 142 143 |
# File 'lib/core_ext/string.rb', line 141 def self.uncountable(*words) (@uncountables << words).flatten! end |