inflector.rb in activesupport-2.1.0

- old
+ new

@@ -1,10 +1,15 @@
 require 'singleton'
 
 # 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).
 module Inflector
   # A singleton instance of this class is yielded by Inflector.inflections, which can then be used to specify additional
   # inflection rules. Examples:
   #
   #   Inflector.inflections do |inflect|
@@ -66,12 +71,13 @@
     #   uncountable %w( money information rice )
     def uncountable(*words)
       (@uncountables << words).flatten!
     end
 
-    # 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
+    # Clears the loaded inflections within a given scope (default is <tt>:all</tt>).
+    # Give the scope as a symbol of the inflection type, the options are: <tt>:plurals</tt>,
+    # <tt>:singulars</tt>, <tt>:uncountables</tt>.
     #
     # Examples:
     #   clear :all
     #   clear :plurals
     def clear(scope = :all)
@@ -84,27 +90,34 @@
     end
   end
 
   extend self
 
+  # Yields a singleton instance of Inflector::Inflections so you can specify additional
+  # inflector rules.
+  #
+  # Example:
+  #   Inflector.inflections do |inflect|
+  #     inflect.uncountable "rails"
+  #   end
   def inflections
     if block_given?
       yield Inflections.instance
     else
       Inflections.instance
     end
   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"
+  # Examples:
+  #   "post".pluralize             # => "posts"
+  #   "octopus".pluralize          # => "octopi"
+  #   "sheep".pluralize            # => "sheep"
+  #   "words".pluralize            # => "words"
+  #   "the blue mailman".pluralize # => "the blue mailmen"
+  #   "CamelOctopus".pluralize     # => "CamelOctopi"
   def pluralize(word)
     result = word.to_s.dup
 
     if word.empty? || inflections.uncountables.include?(result.downcase)
       result
@@ -112,19 +125,19 @@
       inflections.plurals.each { |(rule, replacement)| break if result.gsub!(rule, replacement) }
       result
     end
   end
 
-  # The reverse of pluralize, returns the singular form of a word in a string.
+  # 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"
+  # Examples:
+  #   "posts".singularize            # => "post"
+  #   "octopi".singularize           # => "octopus"
+  #   "sheep".singluarize            # => "sheep"
+  #   "word".singluarize             # => "word"
+  #   "the blue mailmen".singularize # => "the blue mailman"
+  #   "CamelOctopi".singularize      # => "CamelOctopus"
   def singularize(word)
     result = word.to_s.dup
 
     if inflections.uncountables.include?(result.downcase)
       result
@@ -132,139 +145,149 @@
       inflections.singulars.each { |(rule, replacement)| break if result.gsub!(rule, replacement) }
       result
     end
   end
 
-  # By default, camelize converts strings to UpperCamelCase. If the argument to camelize
-  # is set to ":lower" then camelize produces lowerCamelCase.
+  # By default, +camelize+ converts strings to UpperCamelCase. If the argument to +camelize+
+  # is set to <tt>:lower</tt> then +camelize+ produces lowerCamelCase.
   #
-  # camelize will also convert '/' to '::' which is useful for converting paths to namespaces
+  # +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"
+  # Examples:
+  #   "active_record".camelize                # => "ActiveRecord"
+  #   "active_record".camelize(:lower)        # => "activeRecord"
+  #   "active_record/errors".camelize         # => "ActiveRecord::Errors"
+  #   "active_record/errors".camelize(:lower) # => "activeRecord::Errors"
   def camelize(lower_case_and_underscored_word, first_letter_in_uppercase = true)
     if first_letter_in_uppercase
-      lower_case_and_underscored_word.to_s.gsub(/\/(.?)/) { "::" + $1.upcase }.gsub(/(^|_)(.)/) { $2.upcase }
+      lower_case_and_underscored_word.to_s.gsub(/\/(.?)/) { "::#{$1.upcase}" }.gsub(/(?:^|_)(.)/) { $1.upcase }
     else
       lower_case_and_underscored_word.first + camelize(lower_case_and_underscored_word)[1..-1]
     end
   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
+  # 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
+  # +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"
+  # Examples:
+  #   "man from the boondocks".titleize # => "Man From The Boondocks"
+  #   "x-men: the last stand".titleize  # => "X Men: The Last Stand"
   def titleize(word)
     humanize(underscore(word)).gsub(/\b('?[a-z])/) { $1.capitalize }
   end
 
-  # The reverse of +camelize+. Makes an underscored form from the expression in the string.
+  # 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
+  # Examples:
+  #   "ActiveRecord".underscore         # => "active_record"
+  #   "ActiveRecord::Errors".underscore # => active_record/errors
   def underscore(camel_cased_word)
     camel_cased_word.to_s.gsub(/::/, '/').
       gsub(/([A-Z]+)([A-Z][a-z])/,'\1_\2').
       gsub(/([a-z\d])([A-Z])/,'\1_\2').
       tr("-", "_").
       downcase
   end
 
   # Replaces underscores with dashes in the string.
   #
-  # Example
-  #   "puni_puni" #=> "puni-puni"
+  # Example:
+  #   "puni_puni" # => "puni-puni"
   def dasherize(underscored_word)
     underscored_word.gsub(/_/, '-')
   end
 
-  # Capitalizes the first word and turns underscores into spaces and strips _id.
-  # Like titleize, this is meant for creating pretty output.
+  # 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"
+  # Examples:
+  #   "employee_salary" # => "Employee salary"
+  #   "author_id"       # => "Author"
   def humanize(lower_case_and_underscored_word)
     lower_case_and_underscored_word.to_s.gsub(/_id$/, "").gsub(/_/, " ").capitalize
   end
 
-  # Removes the module part from the expression in the string
+  # Removes the module part from the expression in the string.
   #
-  # Examples
-  #   "ActiveRecord::CoreExtensions::String::Inflections".demodulize #=> "Inflections"
-  #   "Inflections".demodulize #=> "Inflections"
+  # Examples:
+  #   "ActiveRecord::CoreExtensions::String::Inflections".demodulize # => "Inflections"
+  #   "Inflections".demodulize                                       # => "Inflections"
   def demodulize(class_name_in_module)
     class_name_in_module.to_s.gsub(/^.*::/, '')
   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.
+  # 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"
+  #   "RawScaledScorer".tableize # => "raw_scaled_scorers"
+  #   "egg_and_ham".tableize     # => "egg_and_hams"
+  #   "fancyCategory".tableize   # => "fancy_categories"
   def tableize(class_name)
     pluralize(underscore(class_name))
   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.)
+  # follow +classify+ with +constantize+.)
   #
-  # Examples
-  #   "egg_and_hams".classify #=> "EggAndHam"
-  #   "posts".classify #=> "Post"
+  # Examples:
+  #   "egg_and_hams".classify # => "EggAndHam"
+  #   "posts".classify        # => "Post"
   #
-  # Singular names are not handled correctly
-  #   "business".classify #=> "Busines"
+  # Singular names are not handled correctly:
+  #   "business".classify     # => "Busines"
   def classify(table_name)
     # strip out any leading schema name
     camelize(singularize(table_name.to_s.sub(/.*\./, '')))
   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"
+  # Examples:
+  #   "Message".foreign_key        # => "message_id"
+  #   "Message".foreign_key(false) # => "messageid"
+  #   "Admin::Post".foreign_key    # => "post_id"
   def foreign_key(class_name, separate_class_name_and_id_with_underscore = true)
     underscore(demodulize(class_name)) + (separate_class_name_and_id_with_underscore ? "_id" : "id")
   end
 
-  # 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.
+  # Tries to find a constant with the name specified in the argument string:
   #
-  # Examples
-  #   "Module".constantize #=> Module
-  #   "Class".constantize #=> Class
+  #   "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.
   def constantize(camel_cased_word)
     unless /\A(?:::)?([A-Z]\w*(?:::[A-Z]\w*)*)\z/ =~ camel_cased_word
       raise NameError, "#{camel_cased_word.inspect} is not a valid constant name!"
     end
 
     Object.module_eval("::#{$1}", __FILE__, __LINE__)
   end
 
-  # Ordinalize turns a number into an ordinal string used to denote the
-  # position in an ordered sequence such as 1st, 2nd, 3rd, 4th.
+  # Turns a number into an ordinal string used to denote the position in an
+  # ordered sequence such as 1st, 2nd, 3rd, 4th.
   #
-  # Examples
+  # Examples:
   #   ordinalize(1)     # => "1st"
   #   ordinalize(2)     # => "2nd"
   #   ordinalize(1002)  # => "1002nd"
   #   ordinalize(1003)  # => "1003rd"
   def ordinalize(number)