Class: Flexus::Inflections

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

Overview

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

Flexus.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/flexus/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.

Return humans

Returns:

  • (Array) 


61
62
63
 
# File 'lib/flexus/inflections.rb', line 61

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.

Return plurals

Returns:

  • (Array) 


36
37
38
 
# File 'lib/flexus/inflections.rb', line 36

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.

Return singulars

Returns:

  • (Array) 


44
45
46
 
# File 'lib/flexus/inflections.rb', line 44

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.

Return uncountables

Returns:

  • (Array) 


52
53
54
 
# File 'lib/flexus/inflections.rb', line 52

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:



26
27
28
 
# File 'lib/flexus/inflections.rb', line 26

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

Examples:


Flexus.clear

Returns:

  • (self) 


193
194
195
196
 
# File 'lib/flexus/inflections.rb', line 193

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.

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

Examples:

Flexus.human(/_cnt$/i, '\1_count')
Flexus.human("legacy_col_person_name", "Name")

Parameters:

  • rule (String, Regexp)
  • replacement (String, Regexp)

Returns:

  • (self) 


178
179
180
181
 
# File 'lib/flexus/inflections.rb', line 178

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.

Add a new irregular pluralization

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:


Flexus.irregular('octopus', 'octopi')
Flexus.irregular('person', 'people')

Parameters:

  • singular (String)
  • plural (String)

Returns:

  • (self) 


129
130
131
132
133
134
135
136
137
 
# File 'lib/flexus/inflections.rb', line 129

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.

Add a new plural role

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:

  • rule (String, Regexp)
  • replacement (String, Regexp)

Returns:

  • (self) 


88
89
90
91
92
 
# File 'lib/flexus/inflections.rb', line 88

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.

Add a new singular 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.

Parameters:

  • rule (String, Regexp)
  • replacement (String, Regexp)

Returns:

  • (self) 


106
107
108
109
110
 
# File 'lib/flexus/inflections.rb', line 106

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.

Add uncountable words

Uncountable will not be inflected

Examples:


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

Parameters:

  • words (Enumerable<String>)

Returns:

  • (self) 


155
156
157
158
159
 
# File 'lib/flexus/inflections.rb', line 155

def uncountable(*words)
  uncountables.merge(words.flatten)

  self
end