Module: Sequel::Inflections

Module | Sequel::Inflections
In: | lib/sequel/model/inflections.rb

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

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

### Constants

CAMELIZE_CONVERT_REGEXP | = | /(^|_)(.)/.freeze
CAMELIZE_MODULE_REGEXP | = | /\/(.?)/.freeze
DASH | = | '-'.freeze
DEMODULIZE_CONVERT_REGEXP | = | /^.*::/.freeze
EMPTY_STRING | = | ''.freeze
SLASH | = | '/'.freeze
VALID_CONSTANT_NAME_REGEXP | = | /\A(?:::)?([A-Z]\w*(?:::[A-Z]\w*)*)\z/.freeze
UNDERSCORE | = | '_'.freeze
UNDERSCORE_CONVERT_REGEXP1 | = | /([A-Z]+)([A-Z][a-z])/.freeze
UNDERSCORE_CONVERT_REGEXP2 | = | /([a-z\d])([A-Z])/.freeze
UNDERSCORE_CONVERT_REPLACE | = | '\1_\2'.freeze
UNDERSCORE_MODULE_REGEXP | = | /::/.freeze

### Attributes

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

### 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/inflections.rb, line 51
    51:     def self.clear(scope = :all)
    52:       case scope
    53:       when :all
    54:         @plurals, @singulars, @uncountables = [], [], []
    55:       else
    56:         instance_variable_set("@#{scope}", [])
    57:       end
    58:     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/inflections.rb, line 66
    66:     def self.irregular(singular, plural)
    67:       plural(Regexp.new("(#{singular[0,1]})#{singular[1..-1]}$", "i"), '\1' + plural[1..-1])
    68:       singular(Regexp.new("(#{plural[0,1]})#{plural[1..-1]}$", "i"), '\1' + singular[1..-1])
    69:     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/inflections.rb, line 76
    76:     def self.plural(rule, replacement)
    77:       @plurals.insert(0, [rule, replacement])
    78:     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/inflections.rb, line 85
    85:     def self.singular(rule, replacement)
    86:       @singulars.insert(0, [rule, replacement])
    87:     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/inflections.rb, line 95
    95:     def self.uncountable(*words)
    96:       (@uncountables << words).flatten!
    97:     end

[Validate]