Module: Foxtail::Function

Defined in:
lib/foxtail/function.rb,
lib/foxtail/function/value.rb,
lib/foxtail/function/number.rb,
lib/foxtail/function/datetime.rb

Overview

Built-in formatting functions for FTL Uses ICU4X for number and datetime formatting

Defined Under Namespace

Classes: DateTime, Number, Value

Class Method Summary collapse

Class Method Details

.defaults ⇒ Hash{String => #call}

Default functions available to all bundles

Returns:

  • (Hash{String => #call}) —

    Function name to callable object mapping



9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
 
# File 'lib/foxtail/function.rb', line 9

def self.defaults
  {
    "NUMBER" => ->(value, **options) {
      # Unwrap value and merge options from nested function calls (like fluent.js)
      raw_value, existing_options = unwrap_value(value)
      unwrapped_options = unwrap_options(options)
      Number[raw_value, existing_options.merge(unwrapped_options)]
    },
    "DATETIME" => ->(value, **options) {
      # Unwrap value and merge options from nested function calls (like fluent.js)
      raw_value, existing_options = unwrap_value(value)
      unwrapped_options = unwrap_options(options)
      DateTime[raw_value, existing_options.merge(unwrapped_options)]
    }
  }
end

.unwrap_options(options) ⇒ Hash

Unwrap option values that may be Function::Value instances

Parameters:

  • options (Hash) —

    the options hash

Returns:

  • (Hash) —

    options with unwrapped values



40
41
42
43
44
 
# File 'lib/foxtail/function.rb', line 40

def self.unwrap_options(options)
  options.transform_values do |v|
    v.is_a?(Value) ? v.value : v
  end
end

.unwrap_value(value) ⇒ Array(Object, Hash)

Unwrap a Function::Value to get raw value and options

Parameters:

  • value (Object) —

    the value to unwrap

Returns:

  • (Array(Object, Hash)) —

    the raw value and options



29
30
31
32
33
34
35
 
# File 'lib/foxtail/function.rb', line 29

def self.unwrap_value(value)
  if value.is_a?(Value)
    [value.value, value.options]
  else
    [value, {}]
  end
end