module Sequel::Inflections

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.

Constants

CAMELIZE_CONVERT_REGEXP
CAMELIZE_MODULE_REGEXP
DASH
DEMODULIZE_CONVERT_REGEXP
EMPTY_STRING
SLASH
UNDERSCORE
UNDERSCORE_CONVERT_REGEXP1
UNDERSCORE_CONVERT_REGEXP2
UNDERSCORE_CONVERT_REPLACE
UNDERSCORE_MODULE_REGEXP
VALID_CONSTANT_NAME_REGEXP

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) 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/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) 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/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) 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.

Example:

plural(/(x|ch|ss|sh)$/i, '\1es')
# File lib/sequel/model/inflections.rb, line 83
def self.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.

Example:

singular(/([^aeiouy]|qu)ies$/i, '\1y')
# File lib/sequel/model/inflections.rb, line 92
def self.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/sequel/model/inflections.rb, line 102
def self.uncountable(*words)
  (@uncountables << words).flatten!
end

Private Instance Methods

camelize(s) click to toggle source

Convert the given string to CamelCase. Will also convert '/' to '::' which is useful for converting paths to namespaces.

# File lib/sequel/model/inflections.rb, line 111
def camelize(s)
  s = s.to_s
  return s.camelize if s.respond_to?(:camelize)
  s = s.gsub(CAMELIZE_MODULE_REGEXP){|x| "::#{x[-1..-1].upcase unless x == SLASH}"}.gsub(CAMELIZE_CONVERT_REGEXP){|x| x[-1..-1].upcase}
  s
end
constantize(s) click to toggle source

Tries to find a declared constant with the name specified in the string. It raises a NameError when the name is not in CamelCase or is not initialized.

# File lib/sequel/model/inflections.rb, line 121
def constantize(s)
  s = s.to_s
  return s.constantize if s.respond_to?(:constantize)
  raise(NameError, "#{s.inspect} is not a valid constant name!") unless m = VALID_CONSTANT_NAME_REGEXP.match(s)
  Object.module_eval("::#{m[1]}", __FILE__, __LINE__)
end
demodulize(s) click to toggle source

Removes the module part from the expression in the string

# File lib/sequel/model/inflections.rb, line 129
def demodulize(s)
  s = s.to_s
  return s.demodulize if s.respond_to?(:demodulize)
  s.gsub(DEMODULIZE_CONVERT_REGEXP, EMPTY_STRING)
end
pluralize(s) click to toggle source

Returns the plural form of the word in the string.

# File lib/sequel/model/inflections.rb, line 136
def pluralize(s)
  s = s.to_s
  return s.pluralize if s.respond_to?(:pluralize)
  result = s.dup
  Inflections.plurals.each{|(rule, replacement)| break if result.gsub!(rule, replacement)} unless Inflections.uncountables.include?(s.downcase)
  result
end
singularize(s) click to toggle source

The reverse of pluralize, returns the singular form of a word in a string.

# File lib/sequel/model/inflections.rb, line 145
def singularize(s)
  s = s.to_s
  return s.singularize if s.respond_to?(:singularize)
  result = s.dup
  Inflections.singulars.each{|(rule, replacement)| break if result.gsub!(rule, replacement)} unless Inflections.uncountables.include?(s.downcase)
  result
end
underscore(s) click to toggle source

The reverse of camelize. Makes an underscored form from the expression in the string. Also changes '::' to '/' to convert namespaces to paths.

# File lib/sequel/model/inflections.rb, line 155
def underscore(s)
  s = s.to_s
  return s.underscore if s.respond_to?(:underscore)
  s.gsub(UNDERSCORE_MODULE_REGEXP, SLASH).gsub(UNDERSCORE_CONVERT_REGEXP1, UNDERSCORE_CONVERT_REPLACE).
    gsub(UNDERSCORE_CONVERT_REGEXP2, UNDERSCORE_CONVERT_REPLACE).tr(DASH, UNDERSCORE).downcase
end