Class: Inflector::Inflections

### Home Classes Methods

### In Files

- lib/assistance/inflector.rb

### Parent

Object

### Methods

- ::new
- #clear
- #irregular
- #plural
- #singular
- #uncountable

### Included Modules

- Singleton

### Files

- CHANGELOG
- COPYING
- README

### Class/Module Index

Quicksearch

- Validation
- Validation::ClassMethods
- Validation::Errors
- Validation::Generator
- Assistance
- Assistance::TimeCalculations
- Inflector
- Inflector::Inflections
- Array
- ConnectionPool
- FalseClass
- NilClass
- Numeric
- Object
- SingleThreadedPool
- String
- TrueClass

No matching classes.

# Inflector::Inflections

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.

### Attributes

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

### Public Class Methods

new() click to toggle source

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

### Public Instance Methods

clear(scope = :all) click to toggle source

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

    # File lib/assistance/inflector.rb, line 70
    def clear(scope = :all)
      case scope
        when :all
          @plurals, @singulars, @uncountables = [], [], []
        else
          instance_variable_set "@#{scope}", []
      end
    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.

Examples:

    irregular 'octopus', 'octopi'
    irregular 'person', 'people'

    # File lib/assistance/inflector.rb, line 49
    def irregular(singular, plural)
      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])
    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.

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

    # File lib/assistance/inflector.rb, line 39
    def singular(rule, replacement)
      @singulars.insert(0, [rule, replacement])
    end

uncountable(*words) click to toggle source

Add uncountable words that shouldn't be attempted inflected.

Examples:

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

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

[Validate]

Generated with the Darkfish Rdoc Generator 2.