The Inflector transforms words from singular to plural, class names to table names, modularized class names to ones without, and class names to foreign keys. The default inflections for pluralization, singularization, and uncountable words are kept in inflections.rb.
The Rails core team has stated patches for the inflections library will not be accepted in order to avoid breaking legacy applications which may be relying on errant inflections. If you discover an incorrect inflection and require it for your application, you‘ll need to correct it yourself (explained below).
- camelize
- classify
- constantize
- dasherize
- demodulize
- foreign_key
- humanize
- inflections
- ordinalize
- pluralize
- singularize
- tableize
- titleize
- underscore
By default, camelize converts strings to UpperCamelCase. If the argument to camelize is set to :lower then camelize produces lowerCamelCase.
camelize will also convert ’/’ to ’::’ which is useful for converting paths to namespaces.
Examples:
"active_record".camelize # => "ActiveRecord" "active_record".camelize(:lower) # => "activeRecord" "active_record/errors".camelize # => "ActiveRecord::Errors" "active_record/errors".camelize(:lower) # => "activeRecord::Errors"
[ show source ]
# File lib/active_support/inflector.rb, line 161
161: def camelize(lower_case_and_underscored_word, first_letter_in_uppercase = true)
162: if first_letter_in_uppercase
163: lower_case_and_underscored_word.to_s.gsub(/\/(.?)/) { "::#{$1.upcase}" }.gsub(/(?:^|_)(.)/) { $1.upcase }
164: else
165: lower_case_and_underscored_word.first + camelize(lower_case_and_underscored_word)[1..-1]
166: end
167: end
Create a class name from a plural table name like Rails does for table names to models. Note that this returns a string and not a Class. (To convert to an actual class follow classify with constantize.)
Examples:
"egg_and_hams".classify # => "EggAndHam" "posts".classify # => "Post"
Singular names are not handled correctly:
"business".classify # => "Busines"
[ show source ]
# File lib/active_support/inflector.rb, line 245
245: def classify(table_name)
246: # strip out any leading schema name
247: camelize(singularize(table_name.to_s.sub(/.*\./, '')))
248: end
Tries to find a constant with the name specified in the argument string:
"Module".constantize # => Module "Test::Unit".constantize # => Test::Unit
The name is assumed to be the one of a top-level constant, no matter whether it starts with "::" or not. No lexical context is taken into account:
C = 'outside'
module M
C = 'inside'
C # => 'inside'
"C".constantize # => 'outside', same as ::C
end
NameError is raised when the name is not in CamelCase or the constant is unknown.
[ show source ]
# File lib/active_support/inflector.rb, line 279
279: def constantize(camel_cased_word)
280: unless /\A(?:::)?([A-Z]\w*(?:::[A-Z]\w*)*)\z/ =~ camel_cased_word
281: raise NameError, "#{camel_cased_word.inspect} is not a valid constant name!"
282: end
283:
284: Object.module_eval("::#{$1}", __FILE__, __LINE__)
285: end
Replaces underscores with dashes in the string.
Example:
"puni_puni" # => "puni-puni"
[ show source ]
# File lib/active_support/inflector.rb, line 201
201: def dasherize(underscored_word)
202: underscored_word.gsub(/_/, '-')
203: end
Removes the module part from the expression in the string.
Examples:
"ActiveRecord::CoreExtensions::String::Inflections".demodulize # => "Inflections" "Inflections".demodulize # => "Inflections"
[ show source ]
# File lib/active_support/inflector.rb, line 220
220: def demodulize(class_name_in_module)
221: class_name_in_module.to_s.gsub(/^.*::/, '')
222: end
Creates a foreign key name from a class name. separate_class_name_and_id_with_underscore sets whether the method should put ‘_’ between the name and ‘id’.
Examples:
"Message".foreign_key # => "message_id" "Message".foreign_key(false) # => "messageid" "Admin::Post".foreign_key # => "post_id"
[ show source ]
# File lib/active_support/inflector.rb, line 258
258: def foreign_key(class_name, separate_class_name_and_id_with_underscore = true)
259: underscore(demodulize(class_name)) + (separate_class_name_and_id_with_underscore ? "_id" : "id")
260: end
Capitalizes the first word and turns underscores into spaces and strips a trailing "_id", if any. Like titleize, this is meant for creating pretty output.
Examples:
"employee_salary" # => "Employee salary" "author_id" # => "Author"
[ show source ]
# File lib/active_support/inflector.rb, line 211
211: def humanize(lower_case_and_underscored_word)
212: lower_case_and_underscored_word.to_s.gsub(/_id$/, "").gsub(/_/, " ").capitalize
213: end
Yields a singleton instance of Inflector::Inflections so you can specify additional inflector rules.
Example:
Inflector.inflections do |inflect|
inflect.uncountable "rails"
end
[ show source ]
# File lib/active_support/inflector.rb, line 103
103: def inflections
104: if block_given?
105: yield Inflections.instance
106: else
107: Inflections.instance
108: end
109: end
Turns a number into an ordinal string used to denote the position in an ordered sequence such as 1st, 2nd, 3rd, 4th.
Examples:
ordinalize(1) # => "1st" ordinalize(2) # => "2nd" ordinalize(1002) # => "1002nd" ordinalize(1003) # => "1003rd"
[ show source ]
# File lib/active_support/inflector.rb, line 295
295: def ordinalize(number)
296: if (11..13).include?(number.to_i % 100)
297: "#{number}th"
298: else
299: case number.to_i % 10
300: when 1; "#{number}st"
301: when 2; "#{number}nd"
302: when 3; "#{number}rd"
303: else "#{number}th"
304: end
305: end
306: end
Returns the plural form of the word in the string.
Examples:
"post".pluralize # => "posts" "octopus".pluralize # => "octopi" "sheep".pluralize # => "sheep" "words".pluralize # => "words" "the blue mailman".pluralize # => "the blue mailmen" "CamelOctopus".pluralize # => "CamelOctopi"
[ show source ]
# File lib/active_support/inflector.rb, line 120
120: def pluralize(word)
121: result = word.to_s.dup
122:
123: if word.empty? || inflections.uncountables.include?(result.downcase)
124: result
125: else
126: inflections.plurals.each { |(rule, replacement)| break if result.gsub!(rule, replacement) }
127: result
128: end
129: end
The reverse of pluralize, returns the singular form of a word in a string.
Examples:
"posts".singularize # => "post" "octopi".singularize # => "octopus" "sheep".singluarize # => "sheep" "word".singluarize # => "word" "the blue mailmen".singularize # => "the blue mailman" "CamelOctopi".singularize # => "CamelOctopus"
[ show source ]
# File lib/active_support/inflector.rb, line 140
140: def singularize(word)
141: result = word.to_s.dup
142:
143: if inflections.uncountables.include?(result.downcase)
144: result
145: else
146: inflections.singulars.each { |(rule, replacement)| break if result.gsub!(rule, replacement) }
147: result
148: end
149: end
Create the name of a table like Rails does for models to table names. This method uses the pluralize method on the last word in the string.
Examples
"RawScaledScorer".tableize # => "raw_scaled_scorers" "egg_and_ham".tableize # => "egg_and_hams" "fancyCategory".tableize # => "fancy_categories"
[ show source ]
# File lib/active_support/inflector.rb, line 231
231: def tableize(class_name)
232: pluralize(underscore(class_name))
233: end
Capitalizes all the words and replaces some characters in the string to create a nicer looking title. titleize is meant for creating pretty output. It is not used in the Rails internals.
titleize is also aliased as as titlecase.
Examples:
"man from the boondocks".titleize # => "Man From The Boondocks" "x-men: the last stand".titleize # => "X Men: The Last Stand"
[ show source ]
# File lib/active_support/inflector.rb, line 178
178: def titleize(word)
179: humanize(underscore(word)).gsub(/\b('?[a-z])/) { $1.capitalize }
180: end
The reverse of camelize. Makes an underscored, lowercase form from the expression in the string.
Changes ’::’ to ’/’ to convert namespaces to paths.
Examples:
"ActiveRecord".underscore # => "active_record" "ActiveRecord::Errors".underscore # => active_record/errors
[ show source ]
# File lib/active_support/inflector.rb, line 189
189: def underscore(camel_cased_word)
190: camel_cased_word.to_s.gsub(/::/, '/').
191: gsub(/([A-Z]+)([A-Z][a-z])/,'\1_\2').
192: gsub(/([a-z\d])([A-Z])/,'\1_\2').
193: tr("-", "_").
194: downcase
195: end