class Flexus::Inflections
A singleton instance of this class is yielded by Flexus.inflections
, which can then be used to specify additional inflection rules. Examples:
Flexus.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.
Attributes
Return humans
@return [Array]
@api private
Return plurals
@return [Array]
@api private
Return singulars
@return [Array]
@api private
Return uncountables
@return [Array]
@api private
Public Class Methods
Return instance
@return [Inflections]
@api private
# File lib/flexus/inflections.rb, line 26 def self.instance @__instance__ ||= new end
Initialize object
@return [undefined]
@api private
# File lib/flexus/inflections.rb, line 69 def initialize @plurals = RulesCollection.new @singulars = RulesCollection.new @humans = RulesCollection.new @uncountables = Set[] end
Public Instance Methods
Clear all inflection rules
@example
Flexus.clear
@return [self]
@api private
# File lib/flexus/inflections.rb, line 193 def clear initialize self end
Add humanize rule
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')
@example
Flexus.human(/_cnt$/i, '\1_count') Flexus.human("legacy_col_person_name", "Name")
@param [String, Regexp] rule @param [String, Regexp] replacement
@api private
@return [self]
# File lib/flexus/inflections.rb, line 178 def human(rule, replacement) humans.insert(0, [rule, replacement]) self end
Add a new irregular pluralization
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.
@example
Flexus.irregular('octopus', 'octopi') Flexus.irregular('person', 'people')
@param [String] singular @param [String] plural
@return [self]
@api private
# File lib/flexus/inflections.rb, line 129 def irregular(singular, plural) uncountables.delete(singular) uncountables.delete(plural) add_irregular(singular, plural, plurals) add_irregular(plural, singular, singulars) self end
Add a new plural role
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.
@param [String, Regexp] rule @param [String, Regexp] replacement
@return [self]
@api private
# File lib/flexus/inflections.rb, line 88 def plural(rule, replacement) rule(rule, replacement, plurals) self end
Add a new singular rule
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.
@param [String, Regexp] rule @param [String, Regexp] replacement
@return [self]
@api private
# File lib/flexus/inflections.rb, line 106 def singular(rule, replacement) rule(rule, replacement, singulars) self end
Add uncountable words
Uncountable will not be inflected
@example
Flexus.uncountable "money" Flexus.uncountable "money", "information" Flexus.uncountable %w( money information rice )
@param [Enumerable<String>] words
@return [self]
@api private
# File lib/flexus/inflections.rb, line 155 def uncountable(*words) uncountables.merge(words.flatten) self end
Private Instance Methods
Add irregular inflection
@param [String] rule @param [String] replacement
@return [undefined]
@api private
# File lib/flexus/inflections.rb, line 209 def add_irregular(rule, replacement, target) head, *tail = rule.chars.to_a rule(/(#{head})#{tail.join}\z/i, '\1' + replacement[1..-1], target) end
Add a new rule
@param [String, Regexp] rule @param [String, Regexp] replacement @param [Array] target
@return [undefined]
@api private
# File lib/flexus/inflections.rb, line 224 def rule(rule, replacement, target) uncountables.delete(rule) uncountables.delete(replacement) target.insert(0, [rule, replacement]) end