2007-02-09 09:04:31 +01:00
|
|
|
require 'active_support/inflector'
|
|
|
|
|
2007-01-22 14:43:50 +01:00
|
|
|
module ActiveSupport #:nodoc:
|
|
|
|
module CoreExtensions #:nodoc:
|
|
|
|
module String #:nodoc:
|
2007-02-09 09:04:31 +01:00
|
|
|
# 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.
|
2008-05-18 06:22:34 +02:00
|
|
|
#
|
|
|
|
# "ScaleScore".tableize # => "scale_scores"
|
2007-01-22 14:43:50 +01:00
|
|
|
module Inflections
|
2007-02-09 09:04:31 +01:00
|
|
|
# Returns the plural form of the word in the string.
|
|
|
|
#
|
2008-05-18 06:22:34 +02:00
|
|
|
# "post".pluralize # => "posts"
|
|
|
|
# "octopus".pluralize # => "octopi"
|
|
|
|
# "sheep".pluralize # => "sheep"
|
|
|
|
# "words".pluralize # => "words"
|
|
|
|
# "the blue mailman".pluralize # => "the blue mailmen"
|
|
|
|
# "CamelOctopus".pluralize # => "CamelOctopi"
|
2007-01-22 14:43:50 +01:00
|
|
|
def pluralize
|
|
|
|
Inflector.pluralize(self)
|
|
|
|
end
|
|
|
|
|
2008-05-18 06:22:34 +02:00
|
|
|
# The reverse of +pluralize+, returns the singular form of a word in a string.
|
2007-02-09 09:04:31 +01:00
|
|
|
#
|
2008-05-18 06:22:34 +02:00
|
|
|
# "posts".singularize # => "post"
|
|
|
|
# "octopi".singularize # => "octopus"
|
|
|
|
# "sheep".singluarize # => "sheep"
|
|
|
|
# "word".singluarize # => "word"
|
|
|
|
# "the blue mailmen".singularize # => "the blue mailman"
|
|
|
|
# "CamelOctopi".singularize # => "CamelOctopus"
|
2007-01-22 14:43:50 +01:00
|
|
|
def singularize
|
|
|
|
Inflector.singularize(self)
|
|
|
|
end
|
|
|
|
|
2008-05-18 06:22:34 +02:00
|
|
|
# By default, +camelize+ converts strings to UpperCamelCase. If the argument to camelize
|
|
|
|
# is set to <tt>:lower</tt> then camelize produces lowerCamelCase.
|
2007-02-09 09:04:31 +01:00
|
|
|
#
|
2008-05-18 06:22:34 +02:00
|
|
|
# +camelize+ will also convert '/' to '::' which is useful for converting paths to namespaces.
|
2007-02-09 09:04:31 +01:00
|
|
|
#
|
2008-05-18 06:22:34 +02:00
|
|
|
# "active_record".camelize # => "ActiveRecord"
|
|
|
|
# "active_record".camelize(:lower) # => "activeRecord"
|
|
|
|
# "active_record/errors".camelize # => "ActiveRecord::Errors"
|
|
|
|
# "active_record/errors".camelize(:lower) # => "activeRecord::Errors"
|
2007-01-22 14:43:50 +01:00
|
|
|
def camelize(first_letter = :upper)
|
|
|
|
case first_letter
|
|
|
|
when :upper then Inflector.camelize(self, true)
|
|
|
|
when :lower then Inflector.camelize(self, false)
|
|
|
|
end
|
|
|
|
end
|
|
|
|
alias_method :camelcase, :camelize
|
|
|
|
|
2007-02-09 09:04:31 +01:00
|
|
|
# Capitalizes all the words and replaces some characters in the string to create
|
2008-05-18 06:22:34 +02:00
|
|
|
# a nicer looking title. +titleize+ is meant for creating pretty output. It is not
|
2007-02-09 09:04:31 +01:00
|
|
|
# used in the Rails internals.
|
|
|
|
#
|
2008-05-18 06:22:34 +02:00
|
|
|
# +titleize+ is also aliased as +titlecase+.
|
2007-02-09 09:04:31 +01:00
|
|
|
#
|
2008-05-18 06:22:34 +02:00
|
|
|
# "man from the boondocks".titleize # => "Man From The Boondocks"
|
|
|
|
# "x-men: the last stand".titleize # => "X Men: The Last Stand"
|
2007-01-22 14:43:50 +01:00
|
|
|
def titleize
|
|
|
|
Inflector.titleize(self)
|
|
|
|
end
|
|
|
|
alias_method :titlecase, :titleize
|
|
|
|
|
2008-05-18 06:22:34 +02:00
|
|
|
# The reverse of +camelize+. Makes an underscored, lowercase form from the expression in the string.
|
2007-02-09 09:04:31 +01:00
|
|
|
#
|
2008-05-18 06:22:34 +02:00
|
|
|
# +underscore+ will also change '::' to '/' to convert namespaces to paths.
|
2007-02-09 09:04:31 +01:00
|
|
|
#
|
2008-05-18 06:22:34 +02:00
|
|
|
# "ActiveRecord".underscore # => "active_record"
|
|
|
|
# "ActiveRecord::Errors".underscore # => active_record/errors
|
2007-01-22 14:43:50 +01:00
|
|
|
def underscore
|
|
|
|
Inflector.underscore(self)
|
|
|
|
end
|
|
|
|
|
2007-02-09 09:04:31 +01:00
|
|
|
# Replaces underscores with dashes in the string.
|
|
|
|
#
|
2008-05-18 06:22:34 +02:00
|
|
|
# "puni_puni" # => "puni-puni"
|
2007-01-22 14:43:50 +01:00
|
|
|
def dasherize
|
|
|
|
Inflector.dasherize(self)
|
|
|
|
end
|
|
|
|
|
2008-05-18 06:22:34 +02:00
|
|
|
# Removes the module part from the constant expression in the string.
|
2007-02-09 09:04:31 +01:00
|
|
|
#
|
2008-05-18 06:22:34 +02:00
|
|
|
# "ActiveRecord::CoreExtensions::String::Inflections".demodulize # => "Inflections"
|
|
|
|
# "Inflections".demodulize # => "Inflections"
|
2007-01-22 14:43:50 +01:00
|
|
|
def demodulize
|
|
|
|
Inflector.demodulize(self)
|
|
|
|
end
|
|
|
|
|
2008-05-18 06:22:34 +02:00
|
|
|
# Creates 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.
|
2007-02-09 09:04:31 +01:00
|
|
|
#
|
2008-05-18 06:22:34 +02:00
|
|
|
# "RawScaledScorer".tableize # => "raw_scaled_scorers"
|
|
|
|
# "egg_and_ham".tableize # => "egg_and_hams"
|
|
|
|
# "fancyCategory".tableize # => "fancy_categories"
|
2007-01-22 14:43:50 +01:00
|
|
|
def tableize
|
|
|
|
Inflector.tableize(self)
|
|
|
|
end
|
|
|
|
|
2008-05-18 06:22:34 +02:00
|
|
|
# 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+.)
|
2007-02-09 09:04:31 +01:00
|
|
|
#
|
2008-05-18 06:22:34 +02:00
|
|
|
# "egg_and_hams".classify # => "EggAndHam"
|
|
|
|
# "posts".classify # => "Post"
|
|
|
|
#
|
|
|
|
# Singular names are not handled correctly.
|
|
|
|
#
|
|
|
|
# "business".classify # => "Busines"
|
2007-01-22 14:43:50 +01:00
|
|
|
def classify
|
|
|
|
Inflector.classify(self)
|
|
|
|
end
|
|
|
|
|
2008-05-18 06:22:34 +02:00
|
|
|
# Capitalizes the first word, turns underscores into spaces, and strips '_id'.
|
|
|
|
# Like +titleize+, this is meant for creating pretty output.
|
2007-02-09 09:04:31 +01:00
|
|
|
#
|
2008-05-18 06:22:34 +02:00
|
|
|
# "employee_salary" # => "Employee salary"
|
|
|
|
# "author_id" # => "Author"
|
2007-01-22 14:43:50 +01:00
|
|
|
def humanize
|
|
|
|
Inflector.humanize(self)
|
|
|
|
end
|
|
|
|
|
2007-02-09 09:04:31 +01:00
|
|
|
# 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
|
2008-05-18 06:22:34 +02:00
|
|
|
# "Message".foreign_key # => "message_id"
|
|
|
|
# "Message".foreign_key(false) # => "messageid"
|
|
|
|
# "Admin::Post".foreign_key # => "post_id"
|
2007-01-22 14:43:50 +01:00
|
|
|
def foreign_key(separate_class_name_and_id_with_underscore = true)
|
|
|
|
Inflector.foreign_key(self, separate_class_name_and_id_with_underscore)
|
|
|
|
end
|
|
|
|
|
2008-05-18 06:22:34 +02:00
|
|
|
# +constantize+ tries to find a declared constant with the name specified
|
2007-02-09 09:04:31 +01:00
|
|
|
# in the string. It raises a NameError when the name is not in CamelCase
|
|
|
|
# or is not initialized.
|
|
|
|
#
|
|
|
|
# Examples
|
2008-05-18 06:22:34 +02:00
|
|
|
# "Module".constantize # => Module
|
|
|
|
# "Class".constantize # => Class
|
2007-01-22 14:43:50 +01:00
|
|
|
def constantize
|
|
|
|
Inflector.constantize(self)
|
|
|
|
end
|
|
|
|
end
|
|
|
|
end
|
|
|
|
end
|
|
|
|
end
|