module Sequel::Inflections

  1. lib/sequel/model/inflections.rb
Parent: Sequel

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)$/, '\1\2en'
  inflect.singular /^(ox)en/, '\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.

Constants

CAMELIZE_CONVERT_REGEXP = /(^|_)(.)/.freeze  
CAMELIZE_MODULE_REGEXP = /\/(.?)/.freeze  
DASH = '-'.freeze  
DEMODULIZE_CONVERT_REGEXP = /^.*::/.freeze  
EMPTY_STRING = ''.freeze  
SLASH = '/'.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  
VALID_CONSTANT_NAME_REGEXP = /\A(?:::)?([A-Z]\w*(?:::[A-Z]\w*)*)\z/.freeze  

Attributes

plurals [R]

Array of two element arrays, first containing a regex, and the second containing a substitution pattern, used for plurization.
singulars [R]

Array of two element arrays, first containing a regex, and the second containing a substitution pattern, used for singularization.
uncountables [R]

Array of strings for words were the singular form is the same as the plural form

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
[show source] 
# File lib/sequel/model/inflections.rb, line 58
def self.clear(scope = :all)
  case scope
  when :all
    @plurals, @singulars, @uncountables = [], [], []
  else
    instance_variable_set("@#{scope}", [])
  end
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'
[show source] 
# File lib/sequel/model/inflections.rb, line 73
def self.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)

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')
[show source] 
# File lib/sequel/model/inflections.rb, line 83
def self.plural(rule, replacement)
  @plurals.insert(0, [rule, replacement])
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')
[show source] 
# File lib/sequel/model/inflections.rb, line 92
def self.singular(rule, replacement)
  @singulars.insert(0, [rule, replacement])
end
uncountable (*words)

Add uncountable words that shouldn’t be attempted inflected.

Examples:

uncountable "money"
uncountable "money", "information"
uncountable %w( money information rice )
[show source] 
# File lib/sequel/model/inflections.rb, line 102
def self.uncountable(*words)
  (@uncountables << words).flatten!
end