Class: Inflector::Inflections

Inherits:
Object
  • Object
show all
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:

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

Instance Method Summary collapse

Constructor Details

#initializeInflections

Returns a new instance of Inflections.


32
33
34
# File 'lib/active_support/inflector.rb', line 32

def initialize
  @plurals, @singulars, @uncountables = [], [], []
end

Instance Attribute Details

#pluralsObject (readonly)

Returns the value of attribute plurals


30
31
32
# File 'lib/active_support/inflector.rb', line 30

def plurals
  @plurals
end

#singularsObject (readonly)

Returns the value of attribute singulars


30
31
32
# File 'lib/active_support/inflector.rb', line 30

def singulars
  @singulars
end

#uncountablesObject (readonly)

Returns the value of attribute uncountables


30
31
32
# File 'lib/active_support/inflector.rb', line 30

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.

Examples:

clear :all
clear :plurals

83
84
85
86
87
88
89
90
# File 'lib/active_support/inflector.rb', line 83

def 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'

54
55
56
57
58
59
60
61
62
63
64
# File 'lib/active_support/inflector.rb', line 54

def irregular(singular, 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.


38
39
40
# File 'lib/active_support/inflector.rb', line 38

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


44
45
46
# File 'lib/active_support/inflector.rb', line 44

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

72
73
74
# File 'lib/active_support/inflector.rb', line 72

def uncountable(*words)
  (@uncountables << words).flatten!
end