Module: Sequel::Inflections

Included in:
Model, Model::Associations::AssociationReflection
Defined in:
lib/sequel/lib/sequel/model/inflections.rb

Overview

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.

Constant Summary collapse

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

Class Attribute Summary collapse

Class Method Summary collapse

Class Attribute Details

.pluralsObject (readonly)

Returns the value of attribute plurals


42
43
44
# File 'lib/sequel/lib/sequel/model/inflections.rb', line 42

def plurals
  @plurals
end

.singularsObject (readonly)

Returns the value of attribute singulars


42
43
44
# File 'lib/sequel/lib/sequel/model/inflections.rb', line 42

def singulars
  @singulars
end

.uncountablesObject (readonly)

Returns the value of attribute uncountables


42
43
44
# File 'lib/sequel/lib/sequel/model/inflections.rb', line 42

def uncountables
  @uncountables
end

Class Method Details

.clear(scope = :all) ⇒ Object

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

51
52
53
54
55
56
57
58
# File 'lib/sequel/lib/sequel/model/inflections.rb', line 51

def self.clear(scope = :all)
  case scope
  when :all
    @plurals, @singulars, @uncountables = [], [], []
  else
    instance_variable_set("@#{scope}", [])
  end
end

.irregular(singular, plural) ⇒ Object

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'

66
67
68
69
# File 'lib/sequel/lib/sequel/model/inflections.rb', line 66

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) ⇒ Object

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')

76
77
78
# File 'lib/sequel/lib/sequel/model/inflections.rb', line 76

def self.plural(rule, replacement)
  @plurals.insert(0, [rule, replacement])
end

.singular(rule, replacement) ⇒ Object

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')

85
86
87
# File 'lib/sequel/lib/sequel/model/inflections.rb', line 85

def self.singular(rule, replacement)
  @singulars.insert(0, [rule, replacement])
end

.uncountable(*words) ⇒ Object

Add uncountable words that shouldn't be attempted inflected.

Examples:

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

95
96
97
# File 'lib/sequel/lib/sequel/model/inflections.rb', line 95

def self.uncountable(*words)
  (@uncountables << words).flatten!
end