Module: Padrino::Inflections
- Extended by:
- Inflections
- Included in:
- Inflections
Overview
This module acts as a singleton returned/yielded by Sequel.inflections, which is used to override or specify additional inflection rules for Sequel. Examples:
Sequel.inflections 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.
Constant Summary collapse
- CAMELIZE_CONVERT_REGEXP =
/(^|_)(.)/.freeze
- CAMELIZE_MODULE_REGEXP =
/\/(.?)/.freeze
- DASH =
'-'.freeze
- DEMODULIZE_CONVERT_REGEXP =
/^.*::/.freeze
- EMPTY_STRING =
''.freeze
- SLASH =
'/'.freeze
- VALID_CONSTANT_NAME_REGEXP =
/\A(?:::)?([A-Z]\w*(?:::[A-Z]\w*)*)\z/.freeze
- UNDERSCORE =
'_'.freeze
- UNDERSCORE_CONVERT_REGEXP1 =
/([A-Z]+)([A-Z][a-z])/.freeze
- UNDERSCORE_CONVERT_REGEXP2 =
/([a-z\d])([A-Z])/.freeze
- UNDERSCORE_CONVERT_REPLACE =
'\1_\2'.freeze
- UNDERSCORE_MODULE_REGEXP =
/::/.freeze
Class Attribute Summary
-
.plurals ⇒ Object
readonly Array of two element arrays, first containing a regex, and the second containing a substitution pattern, used for plurization. -
.singulars ⇒ Object
readonly Array of two element arrays, first containing a regex, and the second containing a substitution pattern, used for singularization. -
.uncountables ⇒ Object
readonly Array of strings for words were the singular form is the same as the plural form.
Class Method Summary
-
.clear(scope = :all) ⇒ Object
Clears the loaded inflections within a given scope (default is :all). -
.irregular(singular, plural) ⇒ Object
Specifies a new irregular that applies to both pluralization and singularization at the same time. -
.plural(rule, replacement) ⇒ Object
Specifies a new pluralization rule and its replacement. -
.singular(rule, replacement) ⇒ Object
Specifies a new singularization rule and its replacement. -
.uncountable(*words) ⇒ Object
Add uncountable words that shouldn't be attempted inflected.
Instance Method Summary
-
#camelize(s) ⇒ Object
Convert the given string to CamelCase. -
#classify(s) ⇒ Object
Create a class name from a plural table name like Rails does for table names to models. -
#constantize(s) ⇒ Object
Tries to find a declared constant with the name specified in the string. -
#demodulize(s) ⇒ Object
Removes the module part from the expression in the string. -
#humanize(s) ⇒ Object
Capitalizes the first word, turns underscores into spaces, and strips a trailing '_id' if present. -
#pluralize(s) ⇒ Object
Returns the plural form of the word in the string. -
#singularize(s) ⇒ Object
The reverse of pluralize, returns the singular form of a word in a string. -
#underscore(s) ⇒ Object
The reverse of camelize.
Class Attribute Details
.plurals ⇒ Object (readonly)
Array of two element arrays, first containing a regex, and the second containing a substitution pattern, used for plurization.
.singulars ⇒ Object (readonly)
Array of two element arrays, first containing a regex, and the second containing a substitution pattern, used for singularization.
.uncountables ⇒ Object (readonly)
Array of strings for words were the singular form is the same as the plural form
Class Method Details
.clear(scope = :all) ⇒ Object
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
Examples:
clear :all clear :plurals
.irregular(singular, plural) ⇒ Object
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.
Examples:
irregular 'octopus', 'octopi' irregular 'person', 'people'
.plural(rule, replacement) ⇒ Object
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.
Example:
plural(/(x|ch|ss|sh)$/i, '\1es')
.singular(rule, replacement) ⇒ Object
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.
Example:
singular(/([^aeiouy]|qu)ies$/i, '\1y')
.uncountable(*words) ⇒ Object
Add uncountable words that shouldn't be attempted inflected.
Examples:
uncountable "money" uncountable "money", "information" uncountable %w( money information rice )
Instance Method Details
#camelize(s) ⇒ Object
Convert the given string to CamelCase. Will also convert '/' to '::' which is useful for converting paths to namespaces.
#classify(s) ⇒ Object
Create a class name from a plural table name like Rails does for table names to models.
#constantize(s) ⇒ Object
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.
#demodulize(s) ⇒ Object
Removes the module part from the expression in the string
#humanize(s) ⇒ Object
Capitalizes the first word, turns underscores into spaces, and strips a trailing '_id' if present.
#pluralize(s) ⇒ Object
Returns the plural form of the word in the string.
#singularize(s) ⇒ Object
The reverse of pluralize, returns the singular form of a word in a string.
#underscore(s) ⇒ Object
The reverse of camelize. Makes an underscored form from the expression in the string. Also changes '::' to '/' to convert namespaces to paths.
© 2010–2020 Padrino
Licensed under the MIT License.
https://www.rubydoc.info/github/padrino/padrino-framework/Padrino/Inflections