Class: Garcon::Inflections::Inflections

Inherits:
Object
  • Object
show all
Defined in:
lib/garcon/inflections/inflections.rb

Overview

A singleton instance of this class is yielded by Garcon.inflections, which can then be used to specify additional inflection rules. Examples:

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

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize ⇒ undefined

This method is part of a private API. You should avoid using this method if possible, as it may be removed or be changed in the future.

Initialize object



69
70
71
72
73
74
 
# File 'lib/garcon/inflections/inflections.rb', line 69

def initialize
  @plurals      = RulesCollection.new
  @singulars    = RulesCollection.new
  @humans       = RulesCollection.new
  @uncountables = Set[]
end

Instance Attribute Details

#humans ⇒ Array (readonly)

This method is part of a private API. You should avoid using this method if possible, as it may be removed or be changed in the future.

Returns humans.

Returns:



63
64
65
 
# File 'lib/garcon/inflections/inflections.rb', line 63

def humans
  @humans
end

#plurals ⇒ Array (readonly)

This method is part of a private API. You should avoid using this method if possible, as it may be removed or be changed in the future.

Returns plurals.

Returns:



51
52
53
 
# File 'lib/garcon/inflections/inflections.rb', line 51

def plurals
  @plurals
end

#singulars ⇒ Array (readonly)

This method is part of a private API. You should avoid using this method if possible, as it may be removed or be changed in the future.

Returns singulars.

Returns:



55
56
57
 
# File 'lib/garcon/inflections/inflections.rb', line 55

def singulars
  @singulars
end

#uncountables ⇒ Array (readonly)

This method is part of a private API. You should avoid using this method if possible, as it may be removed or be changed in the future.

Returns uncountables.

Returns:

  • (Array) —

    uncountables



59
60
61
 
# File 'lib/garcon/inflections/inflections.rb', line 59

def uncountables
  @uncountables
end

Class Method Details

.instance ⇒ Inflections

This method is part of a private API. You should avoid using this method if possible, as it may be removed or be changed in the future.

Return instance

Returns:



45
46
47
 
# File 'lib/garcon/inflections/inflections.rb', line 45

def self.instance
  @__instance__ ||= new
end

Instance Method Details

#clear ⇒ self

This method is part of a private API. You should avoid using this method if possible, as it may be removed or be changed in the future.

Clear all inflection rules

Returns:

  • (self) 


150
151
152
153
 
# File 'lib/garcon/inflections/inflections.rb', line 150

def clear
  initialize
  self
end

#human(rule, replacement) ⇒ self

This method is part of a private API. You should avoid using this method if possible, as it may be removed or be changed in the future.

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’)

Parameters:

Returns:

  • (self) 


141
142
143
144
 
# File 'lib/garcon/inflections/inflections.rb', line 141

def human(rule, replacement)
  @humans.insert(0, [rule, replacement])
  self
end

#irregular(singular, plural) ⇒ self

This method is part of a private API. You should avoid using this method if possible, as it may be removed or be changed in the future.

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.

Parameters:

Returns:

  • (self) 


113
114
115
116
117
118
119
 
# File 'lib/garcon/inflections/inflections.rb', line 113

def irregular(singular, plural)
  @uncountables.delete(singular)
  @uncountables.delete(plural)
  add_irregular(singular, plural, @plurals)
  add_irregular(plural, singular, @singulars)
  self
end

#plural(rule, replacement) ⇒ self

This method is part of a private API. You should avoid using this method if possible, as it may be removed or be changed in the future.

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.

Parameters:

Returns:

  • (self) 


85
86
87
88
 
# File 'lib/garcon/inflections/inflections.rb', line 85

def plural(rule, replacement)
  rule(rule, replacement, @plurals)
  self
end

#singular(rule, replacement) ⇒ self

This method is part of a private API. You should avoid using this method if possible, as it may be removed or be changed in the future.

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.

Parameters:

Returns:

  • (self) 


99
100
101
102
 
# File 'lib/garcon/inflections/inflections.rb', line 99

def singular(rule, replacement)
  rule(rule, replacement, @singulars)
  self
end

#uncountable(*words) ⇒ self

This method is part of a private API. You should avoid using this method if possible, as it may be removed or be changed in the future.

Uncountable will not be inflected

Parameters:

Returns:

  • (self) 


126
127
128
129
 
# File 'lib/garcon/inflections/inflections.rb', line 126

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