Class Inflector::Inflections
In: lib/data_mapper/support/inflector.rb
lib/data_mapper/support/inflector.rb
Parent: Object

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.

Methods

irregular   irregular   new   new   plural   plural   singular   singular   uncountable   uncountable  

Included Modules

Singleton Singleton

Attributes

plurals  [R] 
plurals  [R] 
singulars  [R] 
singulars  [R] 
uncountables  [R] 
uncountables  [R] 

Public Class methods

[Source]

    # File lib/data_mapper/support/inflector.rb, line 32
32:       def initialize
33:         @plurals, @singulars, @uncountables = [], [], []
34:       end

[Source]

    # File lib/data_mapper/support/inflector.rb, line 32
32:       def initialize
33:         @plurals, @singulars, @uncountables = [], [], []
34:       end

Public Instance methods

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'

[Source]

    # File lib/data_mapper/support/inflector.rb, line 54
54:       def irregular(singular, plural)
55:         plural(Regexp.new("(#{singular[0,1]})#{singular[1..-1]}$", "i"), '\1' + plural[1..-1])
56:         singular(Regexp.new("(#{plural[0,1]})#{plural[1..-1]}$", "i"), '\1' + singular[1..-1])
57:       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'

[Source]

    # File lib/data_mapper/support/inflector.rb, line 54
54:       def irregular(singular, plural)
55:         plural(Regexp.new("(#{singular[0,1]})#{singular[1..-1]}$", "i"), '\1' + plural[1..-1])
56:         singular(Regexp.new("(#{plural[0,1]})#{plural[1..-1]}$", "i"), '\1' + singular[1..-1])
57:       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.

[Source]

    # File lib/data_mapper/support/inflector.rb, line 38
38:       def plural(rule, replacement)
39:         @plurals.insert(0, [rule, replacement])
40:       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.

[Source]

    # File lib/data_mapper/support/inflector.rb, line 38
38:       def plural(rule, replacement)
39:         @plurals.insert(0, [rule, replacement])
40:       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.

[Source]

    # File lib/data_mapper/support/inflector.rb, line 44
44:       def singular(rule, replacement)
45:         @singulars.insert(0, [rule, replacement])
46:       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.

[Source]

    # File lib/data_mapper/support/inflector.rb, line 44
44:       def singular(rule, replacement)
45:         @singulars.insert(0, [rule, replacement])
46:       end

Add uncountable words that shouldn‘t be attempted inflected.

Examples:

  uncountable "money"
  uncountable "money", "information"
  uncountable %w( money information rice )

[Source]

    # File lib/data_mapper/support/inflector.rb, line 65
65:       def uncountable(*words)
66:         (@uncountables << words).flatten!
67:       end

Add uncountable words that shouldn‘t be attempted inflected.

Examples:

  uncountable "money"
  uncountable "money", "information"
  uncountable %w( money information rice )

[Source]

    # File lib/data_mapper/support/inflector.rb, line 65
65:       def uncountable(*words)
66:         (@uncountables << words).flatten!
67:       end

[Validate]