Class: Treat::Workers::Inflectors::Cardinalizers::Linguistics

Inherits:
Object
  • Object
show all
Defined in:
lib/treat/workers/inflectors/cardinalizers/linguistics.rb

Overview

This class is a wrapper for the functions included in the ‘linguistics’ gem that allow to describe a number in words in cardinal form.

Project website: deveiate.org/projects/Linguistics/

Constant Summary collapse

DefaultOptions = 
{
  :language => Treat.core.language.default
}

Class Method Summary collapse

Class Method Details

.cardinal(entity, options = {}) ⇒ Object

Return the description of a cardinal number in words.

Options:

  • :group => Controls how many numbers at a time are

grouped together. Valid values are 0 (normal grouping), 1 (single-digit grouping, e.g., “one, two, three, four”), 2 (double-digit grouping, e.g., “twelve, thirty-four”, or 3 (triple-digit grouping, e.g., “one twenty-three, four”).

  • :comma => Set the character/s used to separate word groups.

Defaults to “, ”.

  • :and => Set the word and/or characters used where ‘ and ’

(the default) is normally used. Setting :and to ‘ ’, for example, will cause 2556 to be returned as “two-thousand, five hundred fifty-six” instead of “two-thousand, five hundred and fifty-six”.

  • :zero => Set the word used to represent the numeral 0 in

the result. ‘zero’ is the default.

  • :decimal => Set the translation of any decimal points in

the number; the default is ‘point’.

  • :asArray If set to a true value, the number will be returned

as an array of word groups instead of a String.

More specific options when using :type => :ordinal:



36
37
38
39
40
41
 
# File 'lib/treat/workers/inflectors/cardinalizers/linguistics.rb', line 36

def self.cardinal(entity, options = {})
  options = DefaultOptions.merge(options)
  lang = entity.language
  code = Treat::Loaders::Linguistics.load(lang)
  entity.to_s.send(code).numwords(options)
end