class Inflector::Inflections

Overview

A singleton instance of this class is yielded by Inflector.inflections, which can then be used to specify additional inflection rules. If passed an optional locale, rules for other languages can be specified. The default locale is :en. Only rules for English are provided.

ActiveSupport::Inflector.inflections(:en) do |inflect| inflect.plural /^(ox)$/i, "\1\2en" inflect.singular /^(ox)en/i, "\1"

inflect.irregular "octopus", "octopi"

inflect.uncountable "equipment"

end

New rules are added at the top. So in the example above, the irregular rule for octopus will now be the first of the pluralization and singularization rules that is runs. This guarantees that your rules run before any of the rules that may already have been loaded.

Defined in:

inflector/inflections.cr

Constructors

Class Method Summary

Instance Method Summary

Constructor Detail

def self.new #

[View source]

Class Method Detail

def self.clear #

[View source]
def self.instance(locale : Symbol = :en) #

[View source]
def self.instance(locale : String = "en") #

[View source]

Instance Method Detail

def acronym(word) #

Specifies a new acronym. An acronym must be specified as it will appear in a camelized string. An underscore string that contains the acronym will retain the acronym when passed to +camelize+, +humanize+, or +titleize+. A camelized string that contains the acronym will maintain the acronym when titleized or humanized, and will convert the acronym into a non-delimited single lowercase word when passed to +underscore+.

acronym "HTML" titleize "html" # => "HTML" camelize "html" # => "HTML" underscore "MyHTML" # => "my_html"

The acronym, however, must occur as a delimited unit and not be part of another word for conversions to recognize it:

acronym "HTTP" camelize "my_http_delimited" # => "MyHTTPDelimited" camelize "https" # => "Https", not "HTTPs" underscore "HTTPS" # => "http_s", not "https"

acronym "HTTPS" camelize "https" # => "HTTPS" underscore "HTTPS" # => "https"

Note: Acronyms that are passed to +pluralize+ will no longer be recognized, since the acronym will not occur as a delimited unit in the pluralized result. To work around this, you must specify the pluralized form as an acronym as well:

acronym "API" camelize(pluralize("api")) # => "Apis"

acronym "APIs" camelize(pluralize("api")) # => "APIs"

+acronym+ may be used to specify any word that contains an acronym or otherwise needs to maintain a non-standard capitalization. The only restriction is that the word must begin with a capital letter.

acronym "RESTful" underscore "RESTful" # => "restful" underscore "RESTfulController" # => "restful_controller" titleize "RESTfulController" # => "RESTful Controller" camelize "restful" # => "RESTful" camelize "restful_controller" # => "RESTfulController"

acronym "McDonald" underscore "McDonald" # => "mcdonald" camelize "mcdonald" # => "McDonald"


[View source]
def acronym_regex : Regex #

[View source]
def acronyms : Hash(String, String) #

[View source]
def clear(scope : Symbol = :all) #

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, :humans.

clear :all clear :plurals


[View source]
def clear(scope : String = "all") #

[View source]
def human(rule : Regex, replacement) #

Specifies a humanized form of a string by a regular expression rule or by a string mapping. When using a regular expression based replacement, the normal humanize formatting is called after the replacement. When a string is used, the human form should be specified as desired (example: "The name", not "the_name").

human /_cnt$/i, "\1_count" human "legacy_col_person_name", "Name"


[View source]
def human(rule : String, replacement) #

[View source]
def human(rule, replacement) #

[View source]
def humans : Array({Regex, String}) #

[View source]
def initialize_dup(orig) #

Private, for the test suite.


[View source]
def irregular(singular, plural) #

Specifies a new irregular that applies to both pluralization and singularization at the same time. This can only be used for strings, not regular expressions. You simply pass the irregular in singular and plural form.

irregular "octopus", "octopi" irregular "person", "people"


[View source]
def plural(rule : Regex, replacement) #

Specifies a new pluralization rule and its replacement. The rule can either be a string or a regular expression. The replacement should always be a string that may include references to the matched data from the rule.


[View source]
def plural(rule : String, replacement) #

[View source]
def plural(rule, replacement) #

[View source]
def plurals : Array({Regex, String}) #

[View source]
def singular(rule : Regex, replacement) #

Specifies a new singularization rule and its replacement. The rule can either be a string or a regular expression. The replacement should always be a string that may include references to the matched data from the rule.


[View source]
def singular(rule : String, replacement) #

[View source]
def singular(rule, replacement) #

[View source]
def singulars : Array({Regex, String}) #

[View source]
def uncountable(word : String) #

[View source]
def uncountable(words : Array(String)) #

[View source]
def uncountable : Array(String) #

[View source]
def uncountable(*words) #

Specifies words that are uncountable and should not be inflected.

uncountable "money" uncountable "money", "information" uncountable %w[foo bar]


[View source]
def uncountables : Array(String) #

[View source]