Module: String::Inflections

Module | String::Inflections
In: | lib/sequel_model/inflector.rb

This module acts as a singleton returned/yielded by String.inflections, which is used to override or specify additional inflection rules. Examples:

      String.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 plural singular uncountable

### Public Class 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/sequel_model/inflector.rb, line 32
    32:     def self.clear(scope = :all)
    33:       case scope
    34:       when :all
    35:         @plurals, @singulars, @uncountables = [], [], []
    36:       else
    37:         instance_variable_set("@#{scope}", [])
    38:       end
    39:     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/sequel_model/inflector.rb, line 47
    47:     def self.irregular(singular, plural)
    48:       plural(Regexp.new("(#{singular[0,1]})#{singular[1..-1]}$", "i"), '\1' + plural[1..-1])
    49:       singular(Regexp.new("(#{plural[0,1]})#{plural[1..-1]}$", "i"), '\1' + singular[1..-1])
    50:     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.

Example:

      plural(/(x|ch|ss|sh)$/i, '\1es')

[Source]

        # File lib/sequel_model/inflector.rb, line 57
    57:     def self.plural(rule, replacement)
    58:       @plurals.insert(0, [rule, replacement])
    59:     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.

Example:

      singular(/([^aeiouy]|qu)ies$/i, '\1y')

[Source]

        # File lib/sequel_model/inflector.rb, line 66
    66:     def self.singular(rule, replacement)
    67:       @singulars.insert(0, [rule, replacement])
    68:     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/sequel_model/inflector.rb, line 76
    76:     def self.uncountable(*words)
    77:       (@uncountables << words).flatten!
    78:     end

[Validate]