Module | String::Inflections |
In: |
lib/sequel/extensions/inflector.rb
|
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.
plurals | [R] | Array of 2 element arrays, first containing a regex, and the second containing a substitution pattern, used for plurization. |
singulars | [R] | Array of 2 element arrays, first containing a regex, and the second containing a substitution pattern, used for singularization. |
uncountables | [R] | Array of strings for words were the singular form is the same as the plural form |
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
# File lib/sequel/extensions/inflector.rb, line 42 42: def self.clear(scope = :all) 43: case scope 44: when :all 45: @plurals, @singulars, @uncountables = [], [], [] 46: else 47: instance_variable_set("@#{scope}", []) 48: end 49: 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 lib/sequel/extensions/inflector.rb, line 57 57: def self.irregular(singular, plural) 58: plural(Regexp.new("(#{singular[0,1]})#{singular[1..-1]}$", "i"), '\1' + plural[1..-1]) 59: singular(Regexp.new("(#{plural[0,1]})#{plural[1..-1]}$", "i"), '\1' + singular[1..-1]) 60: 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.
Example:
plural(/(x|ch|ss|sh)$/i, '\1es')
# File lib/sequel/extensions/inflector.rb, line 67 67: def self.plural(rule, replacement) 68: @plurals.insert(0, [rule, replacement]) 69: 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.
Example:
singular(/([^aeiouy]|qu)ies$/i, '\1y')
# File lib/sequel/extensions/inflector.rb, line 76 76: def self.singular(rule, replacement) 77: @singulars.insert(0, [rule, replacement]) 78: end
Add uncountable words that shouldn‘t be attempted inflected.
Examples:
uncountable "money" uncountable "money", "information" uncountable %w( money information rice )
# File lib/sequel/extensions/inflector.rb, line 86 86: def self.uncountable(*words) 87: (@uncountables << words).flatten! 88: end