Module: String::Inflections

Defined in:
lib/awestruct/util/inflector.rb

Overview

This module acts as a singleton returned/yielded by String.inflections, which is used to override or specify additional inflection rules. Examples:

String.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.

Class Attribute Summary collapse

Class Method Summary collapse

Class Attribute Details

.plurals ⇒ Object (readonly)

Array of 2 element arrays, first containing a regex, and the second containing a substitution pattern, used for plurization.



27
28
29
 
# File 'lib/awestruct/util/inflector.rb', line 27

def plurals
  @plurals
end

.singulars ⇒ Object (readonly)

Array of 2 element arrays, first containing a regex, and the second containing a substitution pattern, used for singularization.



30
31
32
 
# File 'lib/awestruct/util/inflector.rb', line 30

def singulars
  @singulars
end

.uncountables ⇒ Object (readonly)

Array of strings for words were the singular form is the same as the plural form



33
34
35
 
# File 'lib/awestruct/util/inflector.rb', line 33

def uncountables
  @uncountables
end

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



42
43
44
45
46
47
48
49
 
# File 'lib/awestruct/util/inflector.rb', line 42

def self.clear(scope = :all)
  case scope
  when :all
    @plurals, @singulars, @uncountables = [], [], []
  else
    instance_variable_set("@#{scope}", [])
  end
end

.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'



57
58
59
60
 
# File 'lib/awestruct/util/inflector.rb', line 57

def self.irregular(singular, plural)
  plural(Regexp.new("(#{singular[0,1]})#{singular[1..-1]}$", "i"), '\1' + plural[1..-1])
  singular(Regexp.new("(#{plural[0,1]})#{plural[1..-1]}$", "i"), '\1' + singular[1..-1])
end

.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')



67
68
69
 
# File 'lib/awestruct/util/inflector.rb', line 67

def self.plural(rule, replacement)
  @plurals.insert(0, [rule, replacement])
end

.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')



76
77
78
 
# File 'lib/awestruct/util/inflector.rb', line 76

def self.singular(rule, replacement)
  @singulars.insert(0, [rule, replacement])
end

.uncountable(*words) ⇒ Object

Add uncountable words that shouldn’t be attempted inflected.

Examples:

uncountable "money"
uncountable "money", "information"
uncountable %w( money information rice )



86
87
88
 
# File 'lib/awestruct/util/inflector.rb', line 86

def self.uncountable(*words)
  (@uncountables << words).flatten!
end