class Garcon::Inflections::Inflections

A singleton instance of this class is yielded by Garcon.inflections, which can then be used to specify additional inflection rules. Examples:

Inflections.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

humans[R]

@return [Array] humans @api private

plurals[R]

@return [Array] plurals @api private

singulars[R]

@return [Array] singulars @api private

uncountables[R]

@return [Array] uncountables @api private

Public Class Methods

instance() click to toggle source

Return instance

@return [Inflections] @api private

# File lib/garcon/inflections/inflections.rb, line 45
def self.instance
  @__instance__ ||= new
end
new() click to toggle source

Initialize object

@return [undefined] @api private

# File lib/garcon/inflections/inflections.rb, line 69
def initialize
  @plurals      = RulesCollection.new
  @singulars    = RulesCollection.new
  @humans       = RulesCollection.new
  @uncountables = Set[]
end

Public Instance Methods

clear() click to toggle source

Clear all inflection rules

@return [self] @api private

# File lib/garcon/inflections/inflections.rb, line 150
def clear
  initialize
  self
end
human(rule, replacement) click to toggle source

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’)

@param [String, Regexp] rule @param [String, Regexp] replacement @return [self] @api private

# File lib/garcon/inflections/inflections.rb, line 141
def human(rule, replacement)
  @humans.insert(0, [rule, replacement])
  self
end
irregular(singular, plural) click to toggle source

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.

@param [String] singular @param [String] plural @return [self] @api private

# File lib/garcon/inflections/inflections.rb, line 113
def irregular(singular, plural)
  @uncountables.delete(singular)
  @uncountables.delete(plural)
  add_irregular(singular, plural, @plurals)
  add_irregular(plural, singular, @singulars)
  self
end
plural(rule, replacement) click to toggle source

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/garcon/inflections/inflections.rb, line 85
def plural(rule, replacement)
  rule(rule, replacement, @plurals)
  self
end
singular(rule, replacement) click to toggle source

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/garcon/inflections/inflections.rb, line 99
def singular(rule, replacement)
  rule(rule, replacement, @singulars)
  self
end
uncountable(*words) click to toggle source

Uncountable will not be inflected

@param [Enumerable<String>] words @return [self] @api private

# File lib/garcon/inflections/inflections.rb, line 126
def uncountable(*words)
  @uncountables.merge(words.flatten)
  self
end