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.
Attributes
Array
of two element arrays, first containing a regex, and the second containing a substitution pattern, used for plurization.
Array
of two element arrays, first containing a regex, and the second containing a substitution pattern, used for singularization.
Array
of strings for words were the singular form is the same as the plural form
Public Class Methods
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 47 def self.clear(scope = :all) 48 case scope 49 when :all 50 @plurals, @singulars, @uncountables = [], [], [] 51 else 52 instance_variable_set("@#{scope}", []) 53 end 54 end
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 62 def self.irregular(singular, plural) 63 plural(Regexp.new("(#{singular[0,1]})#{singular[1..-1]}$", "i"), '\1' + plural[1..-1]) 64 singular(Regexp.new("(#{plural[0,1]})#{plural[1..-1]}$", "i"), '\1' + singular[1..-1]) 65 end
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 72 def self.plural(rule, replacement) 73 @plurals.insert(0, [rule, replacement]) 74 end
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 81 def self.singular(rule, replacement) 82 @singulars.insert(0, [rule, replacement]) 83 end
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 91 def self.uncountable(*words) 92 (@uncountables << words).flatten! 93 end
Private Instance Methods
Convert the given string to CamelCase. Will also convert '/' to '::' which is useful for converting paths to namespaces.
# File lib/sequel/model/inflections.rb 100 def camelize(s) 101 s = s.to_s 102 return s.camelize if s.respond_to?(:camelize) 103 s = s.gsub(/\/(.?)/){|x| "::#{x[-1..-1].upcase unless x == '/'}"}.gsub(/(^|_)(.)/){|x| x[-1..-1].upcase} 104 s 105 end
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 110 def constantize(s) 111 s = s.to_s 112 return s.constantize if s.respond_to?(:constantize) 113 raise(NameError, "#{s.inspect} is not a valid constant name!") unless m = /\A(?:::)?([A-Z]\w*(?:::[A-Z]\w*)*)\z/.match(s) 114 Object.module_eval("::#{m[1]}", __FILE__, __LINE__) 115 end
Removes the module part from the expression in the string
# File lib/sequel/model/inflections.rb 118 def demodulize(s) 119 s = s.to_s 120 return s.demodulize if s.respond_to?(:demodulize) 121 s.gsub(/^.*::/, '') 122 end
Returns the plural form of the word in the string.
# File lib/sequel/model/inflections.rb 125 def pluralize(s) 126 s = s.to_s 127 return s.pluralize if s.respond_to?(:pluralize) 128 result = s.dup 129 Inflections.plurals.each{|(rule, replacement)| break if result.gsub!(rule, replacement)} unless Inflections.uncountables.include?(s.downcase) 130 result 131 end
The reverse of pluralize, returns the singular form of a word in a string.
# File lib/sequel/model/inflections.rb 134 def singularize(s) 135 s = s.to_s 136 return s.singularize if s.respond_to?(:singularize) 137 result = s.dup 138 Inflections.singulars.each{|(rule, replacement)| break if result.gsub!(rule, replacement)} unless Inflections.uncountables.include?(s.downcase) 139 result 140 end
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 144 def underscore(s) 145 s = s.to_s 146 return s.underscore if s.respond_to?(:underscore) 147 s.gsub('::', '/').gsub(/([A-Z]+)([A-Z][a-z])/, '\1_\2'). 148 gsub(/([a-z\d])([A-Z])/, '\1_\2').tr('-', '_').downcase 149 end