class Dry::Inflector::Inflections
@since 0.1.0
Attributes
Human rules
@return [Dry::Inflector::Rules]
@since 0.1.0 @api private
Pluralization rules
@return [Dry::Inflector::Rules]
@since 0.1.0 @api private
Singularization rules
@return [Dry::Inflector::Rules]
@since 0.1.0 @api private
Uncountable rules
@return [Set]
@since 0.1.0 @api private
Public Class Methods
Instantiate a set of inflection rules. It adds the default rules and the optional customizations, passed as a block.
@param blk [Proc] the optional, custom rules
@since 0.1.0 @api private
# File lib/dry/inflector/inflections.rb, line 22 def self.build(&blk) new do |inflect| Defaults.call(inflect) blk.call(inflect) if block_given? end end
Instantiate the rules
@return [Dry::Inflector::Inflections] @yieldparam [self]
@since 0.1.0 @api private
# File lib/dry/inflector/inflections.rb, line 76 def initialize @plurals = Rules.new @singulars = Rules.new @humans = Rules.new @uncountables = Set[] @acronyms = Acronyms.new yield(self) if block_given? end
Public Instance Methods
Add one or more acronyms
Acronyms
affect how basic operations are performed, such as camelize/underscore.
@param words [Array<String>] a list of acronyms
@since 0.1.2
@example
require "dry/inflector" inflector = Dry::Inflector.new do |inflections| inflections.acronym "HTML" end inflector.camelize("html") # => "HTML" inflector.underscore("HTMLIsFun") # => "html_is_fun"
# File lib/dry/inflector/inflections.rb, line 191 def acronym(*words) words.each { |word| @acronyms.add(word.downcase, word) } end
Add a custom humanize rule
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”`)
@param rule [String, Regexp] the rule @param replacement [String] the replacement
@since 0.1.0
@example
require "dry/inflector" inflector = Dry::Inflector.new do |inflections| inflections.human(/_cnt$/i, '\1_count') inflections.human("legacy_col_person_name", "Name") end
# File lib/dry/inflector/inflections.rb, line 213 def human(rule, replacement) humans.insert(0, [rule, replacement]) end
Add a custom pluralization rule
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.
@param singular [String] the singular @param plural [String] the plural
@since 0.1.0
@example
require "dry/inflector" inflector = Dry::Inflector.new do |inflections| inflections.singular "octopus", "octopi" end
# File lib/dry/inflector/inflections.rb, line 145 def irregular(singular, plural) uncountables.delete(singular) uncountables.delete(plural) add_irregular(singular, plural, plurals) add_irregular(plural, singular, singulars) end
Add a custom pluralization rule
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.
@param rule [String, Regexp] the rule @param replacement [String] the replacement
@since 0.1.0
@example
require "dry/inflector" inflector = Dry::Inflector.new do |inflections| inflections.plural "virus", "viruses" end
# File lib/dry/inflector/inflections.rb, line 103 def plural(rule, replacement) rule(rule, replacement, plurals) end
Add a custom singularization rule
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.
@param rule [String, Regexp] the rule @param replacement [String] the replacement
@since 0.1.0
@example
require "dry/inflector" inflector = Dry::Inflector.new do |inflections| inflections.singular "thieves", "thief" end
# File lib/dry/inflector/inflections.rb, line 124 def singular(rule, replacement) rule(rule, replacement, singulars) end
Add a custom rule for uncountable words
Uncountable will not be inflected
@param [Enumerable<String>] words
@since 0.1.0
@example
require "dry/inflector" inflector = Dry::Inflector.new do |inflections| inflections.uncountable "money" inflections.uncountable "money", "information" inflections.uncountable %w(money information rice) end
# File lib/dry/inflector/inflections.rb, line 169 def uncountable(*words) uncountables.merge(words.flatten) end
Private Instance Methods
Add irregular inflection
@param rule [String] the rule @param replacement [String] the replacement
@return [undefined]
@since 0.1.0 @api private
# File lib/dry/inflector/inflections.rb, line 228 def add_irregular(rule, replacement, target) head, *tail = rule.chars.to_a rule(/(#{head})#{tail.join}\z/i, '\1' + replacement[1..-1], target) end
Add a new rule
@param rule [String, Regexp] the rule @param replacement [String, Regexp] the replacement @param target [Dry::Inflector::Rules] the target
@since 0.1.0 @api private
# File lib/dry/inflector/inflections.rb, line 241 def rule(rule, replacement, target) uncountables.delete(rule) uncountables.delete(replacement) target.insert(0, [rule, replacement]) end