Class: Inflector::Inflections

Class | Inflector::Inflections
In: | lib/assistance/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

clear irregular new plural singular uncountable

### Included Modules

Singleton

### Attributes

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

### Public Class methods

new()

[Source]

        # File lib/assistance/inflector.rb, line 27
    27:     def initialize
    28:       @plurals, @singulars, @uncountables = [], [], []
    29:     end

### Public Instance methods

clear(scope = :all)

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

[Source]

        # File lib/assistance/inflector.rb, line 70
    70:     def clear(scope = :all)
    71:       case scope
    72:         when :all
    73:           @plurals, @singulars, @uncountables = [], [], []
    74:         else
    75:           instance_variable_set "@#{scope}", []
    76:       end
    77:     end

irregular(singular, plural)

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/assistance/inflector.rb, line 49
    49:     def irregular(singular, plural)
    50:       plural(Regexp.new("(#{singular[0,1]})#{singular[1..-1]}$", "i"), '\1' + plural[1..-1])
    51:       singular(Regexp.new("(#{plural[0,1]})#{plural[1..-1]}$", "i"), '\1' + singular[1..-1])
    52:     end

plural(rule, replacement)

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/assistance/inflector.rb, line 33
    33:     def plural(rule, replacement)
    34:       @plurals.insert(0, [rule, replacement])
    35:     end

singular(rule, replacement)

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/assistance/inflector.rb, line 39
    39:     def singular(rule, replacement)
    40:       @singulars.insert(0, [rule, replacement])
    41:     end

uncountable(*words)

Add uncountable words that shouldn‘t be attempted inflected.

Examples:

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

[Source]

        # File lib/assistance/inflector.rb, line 60
    60:     def uncountable(*words)
    61:       (@uncountables << words).flatten!
    62:     end

[Validate]