Class: String
- Inherits:
-
Object
- Object
- String
- Defined in:
- lib/sequel_model/inflector.rb
Overview
Add inflection methods to String, which allows the easy transformation of words from singular to plural,class names to table names, modularized class names to ones without, and class names to foreign keys.
Defined Under Namespace
Modules: Inflections
Class Method Summary collapse
-
.inflections {|Inflections| ... } ⇒ Object
Yield the Inflections module if a block is given, and return the Inflections module.
Instance Method Summary collapse
-
#camelize(first_letter_in_uppercase = :upper) ⇒ Object
(also: #camelcase)
By default, camelize converts the string to UpperCamelCase.
-
#classify ⇒ Object
Singularizes and camelizes the string.
-
#constantize ⇒ Object
Constantize tries to find a declared constant with the name specified in the string.
-
#dasherize ⇒ Object
Replaces underscores with dashes in the string.
-
#demodulize ⇒ Object
Removes the module part from the expression in the string.
-
#foreign_key(use_underscore = true) ⇒ Object
Creates a foreign key name from a class name.
-
#humanize ⇒ Object
Capitalizes the first word and turns underscores into spaces and strips _id.
-
#pluralize ⇒ Object
Returns the plural form of the word in the string.
-
#singularize ⇒ Object
The reverse of pluralize, returns the singular form of a word in a string.
-
#tableize ⇒ Object
Underscores and pluralizes the string.
-
#titleize ⇒ Object
(also: #titlecase)
Capitalizes all the words and replaces some characters in the string to create a nicer looking title.
-
#underscore ⇒ Object
The reverse of camelize.
Class Method Details
.inflections {|Inflections| ... } ⇒ Object
Yield the Inflections module if a block is given, and return the Inflections module.
135 136 137 138 |
# File 'lib/sequel_model/inflector.rb', line 135 def self.inflections yield Inflections if block_given? Inflections end |
Instance Method Details
#camelize(first_letter_in_uppercase = :upper) ⇒ Object Also known as: camelcase
By default, camelize converts the string 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"
150 151 152 153 154 155 156 |
# File 'lib/sequel_model/inflector.rb', line 150 def camelize(first_letter_in_uppercase = :upper) if first_letter_in_uppercase == :upper gsub(/\/(.?)/){|x| "::#{x[-1..-1].upcase unless x == '/'}"}.gsub(/(^|_)(.)/){|x| x[-1..-1].upcase} else "#{first}#{camelize[1..-1]}" end end |
#classify ⇒ Object
Singularizes and camelizes the string. Also strips out all characters preceding and including a period (“.”).
Examples
"egg_and_hams".classify #=> "EggAndHam"
"post".classify #=> "Post"
"schema.post".classify #=> "Post"
166 167 168 |
# File 'lib/sequel_model/inflector.rb', line 166 def classify sub(/.*\./, '').singularize.camelize end |
#constantize ⇒ Object
Constantize 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.
Examples
"Module".constantize #=> Module
"Class".constantize #=> Class
177 178 179 180 |
# File 'lib/sequel_model/inflector.rb', line 177 def constantize raise(NameError, "#{inspect} is not a valid constant name!") unless m = /\A(?:::)?([A-Z]\w*(?:::[A-Z]\w*)*)\z/.match(self) Object.module_eval("::#{m[1]}", __FILE__, __LINE__) end |
#dasherize ⇒ Object
Replaces underscores with dashes in the string.
Example
"puni_puni".dasherize #=> "puni-puni"
186 187 188 |
# File 'lib/sequel_model/inflector.rb', line 186 def dasherize gsub(/_/, '-') end |
#demodulize ⇒ Object
Removes the module part from the expression in the string
Examples
"ActiveRecord::CoreExtensions::String::Inflections".demodulize #=> "Inflections"
"Inflections".demodulize #=> "Inflections"
195 196 197 |
# File 'lib/sequel_model/inflector.rb', line 195 def demodulize gsub(/^.*::/, '') end |
#foreign_key(use_underscore = true) ⇒ Object
Creates a foreign key name from a class name. use_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"
206 207 208 |
# File 'lib/sequel_model/inflector.rb', line 206 def foreign_key(use_underscore = true) "#{demodulize.underscore}#{'_' if use_underscore}id" end |
#humanize ⇒ Object
Capitalizes the first word and turns underscores into spaces and strips _id. Like titleize, this is meant for creating pretty output.
Examples
"employee_salary" #=> "Employee salary"
"author_id" #=> "Author"
216 217 218 |
# File 'lib/sequel_model/inflector.rb', line 216 def humanize gsub(/_id$/, "").gsub(/_/, " ").capitalize end |
#pluralize ⇒ Object
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"
229 230 231 232 233 |
# File 'lib/sequel_model/inflector.rb', line 229 def pluralize result = dup Inflections.plurals.each{|(rule, replacement)| break if result.gsub!(rule, replacement)} unless Inflections.uncountables.include?(downcase) result end |
#singularize ⇒ Object
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"
244 245 246 247 248 |
# File 'lib/sequel_model/inflector.rb', line 244 def singularize result = dup Inflections.singulars.each{|(rule, replacement)| break if result.gsub!(rule, replacement)} unless Inflections.uncountables.include?(downcase) result end |
#tableize ⇒ Object
Underscores and pluralizes the string.
Examples
"RawScaledScorer".tableize #=> "raw_scaled_scorers"
"egg_and_ham".tableize #=> "egg_and_hams"
"fancyCategory".tableize #=> "fancy_categories"
256 257 258 |
# File 'lib/sequel_model/inflector.rb', line 256 def tableize underscore.pluralize end |
#titleize ⇒ Object Also known as: titlecase
Capitalizes all the words and replaces some characters in the string to create a nicer looking title. Titleize is meant for creating pretty output.
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"
268 269 270 |
# File 'lib/sequel_model/inflector.rb', line 268 def titleize underscore.humanize.gsub(/\b([a-z])/){|x| x[-1..-1].upcase} end |
#underscore ⇒ Object
The reverse of camelize. Makes an underscored form from the expression in the string. Also changes ‘::’ to ‘/’ to convert namespaces to paths.
Examples
"ActiveRecord".underscore #=> "active_record"
"ActiveRecord::Errors".underscore #=> active_record/errors
279 280 281 282 |
# File 'lib/sequel_model/inflector.rb', line 279 def underscore gsub(/::/, '/').gsub(/([A-Z]+)([A-Z][a-z])/,'\1_\2'). gsub(/([a-z\d])([A-Z])/,'\1_\2').tr("-", "_").downcase end |