Module: InactiveSupport::CoreExtensions::String::Inflections

Included in:
String
Defined in:
lib/inactive_support/core_ext/string/inflections.rb

Overview

String inflections define new methods on the String class to transform names for different purposes. For instance, you can figure out the name of a database from the name of a class.

"ScaleScore".tableize => "scale_scores"

Instance Method Summary collapse

Instance Method Details

#camelize(first_letter = :upper) ⇒ Object Also known as: camelcase

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"



46
47
48
49
50
51
 
# File 'lib/inactive_support/core_ext/string/inflections.rb', line 46

def camelize(first_letter = :upper)
  case first_letter
    when :upper then Inflector.camelize(self, true)
    when :lower then Inflector.camelize(self, false)
  end
end

#classify ⇒ Object

Create a class name from a 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"
"post".classify #=> "Post"



114
115
116
 
# File 'lib/inactive_support/core_ext/string/inflections.rb', line 114

def classify
  Inflector.classify(self)
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



147
148
149
 
# File 'lib/inactive_support/core_ext/string/inflections.rb', line 147

def constantize
  Inflector.constantize(self)
end

#dasherize ⇒ Object

Replaces underscores with dashes in the string.

Example

"puni_puni" #=> "puni-puni"



83
84
85
 
# File 'lib/inactive_support/core_ext/string/inflections.rb', line 83

def dasherize
  Inflector.dasherize(self)
end

#demodulize ⇒ Object

Removes the module part from the expression in the string

Examples

"ActiveRecord::CoreExtensions::String::Inflections".demodulize #=> "Inflections"
"Inflections".demodulize #=> "Inflections"



92
93
94
 
# File 'lib/inactive_support/core_ext/string/inflections.rb', line 92

def demodulize
  Inflector.demodulize(self)
end

#foreign_key(separate_class_name_and_id_with_underscore = true) ⇒ Object

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"



136
137
138
 
# File 'lib/inactive_support/core_ext/string/inflections.rb', line 136

def foreign_key(separate_class_name_and_id_with_underscore = true)
  Inflector.foreign_key(self, separate_class_name_and_id_with_underscore)
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"



124
125
126
 
# File 'lib/inactive_support/core_ext/string/inflections.rb', line 124

def humanize
  Inflector.humanize(self)
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"



19
20
21
 
# File 'lib/inactive_support/core_ext/string/inflections.rb', line 19

def pluralize
  Inflector.pluralize(self)
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"



32
33
34
 
# File 'lib/inactive_support/core_ext/string/inflections.rb', line 32

def singularize
  Inflector.singularize(self)
end

#tableize ⇒ Object

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"



103
104
105
 
# File 'lib/inactive_support/core_ext/string/inflections.rb', line 103

def tableize
  Inflector.tableize(self)
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. 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"



63
64
65
 
# File 'lib/inactive_support/core_ext/string/inflections.rb', line 63

def titleize
  Inflector.titleize(self)
end

#underscore ⇒ Object

The reverse of camelize. Makes an underscored 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



75
76
77
 
# File 'lib/inactive_support/core_ext/string/inflections.rb', line 75

def underscore
  Inflector.underscore(self)
end