Class: Dry::Transformer::Function Private

Inherits:
Object
  • Object
show all
Defined in:
lib/dry/transformer/function.rb

Overview

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

Transformation proc wrapper allowing composition of multiple procs into a data-transformation pipeline.

This is used by Dry::Transformer to wrap registered methods.

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(fn, options = {}) ⇒ Function

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 a new instance of Function.



36
37
38
39
40
 
# File 'lib/dry/transformer/function.rb', line 36

def initialize(fn, options = {})
  @fn = fn
  @args = options.fetch(:args, [])
  @name = options.fetch(:name, fn)
end

Instance Attribute Details

#args ⇒ 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.

Additional arguments that will be passed to the wrapped proc

Returns:

  • (Array) 


26
27
28
 
# File 'lib/dry/transformer/function.rb', line 26

def args
  @args
end

#fn ⇒ Proc, Composed (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.

Wrapped proc or another composite function

Returns:

  • (Proc, Composed) 


19
20
21
 
# File 'lib/dry/transformer/function.rb', line 19

def fn
  @fn
end

#name ⇒ <type] The name of the function (readonly)

Returns <type] The name of the function.

Returns:

  • (<type] The name of the function) —

    <type] The name of the function



33
34
35
 
# File 'lib/dry/transformer/function.rb', line 33

def name
  @name
end

Instance Method Details

#==(other) ⇒ Object Also known as: eql? 



79
80
81
82
83
 
# File 'lib/dry/transformer/function.rb', line 79

def ==(other)
  return false unless other.instance_of?(self.class)

  [fn, name, args] == [other.fn, other.name, other.args]
end

#call(*value) ⇒ Object Also known as: []

Call the wrapped proc

Parameters:

  • value (Object) —

    The input value



49
50
51
 
# File 'lib/dry/transformer/function.rb', line 49

def call(*value)
  fn.call(*value, *args)
end

#compose(other) ⇒ Composite Also known as: +, >>

Compose this function with another function or a proc

Parameters:

Returns:



63
64
65
 
# File 'lib/dry/transformer/function.rb', line 63

def compose(other)
  Composite.new(self, other)
end

#to_ast ⇒ Array

Return a simple AST representation of this function

Returns:

  • (Array) 


91
92
93
94
 
# File 'lib/dry/transformer/function.rb', line 91

def to_ast
  args_ast = args.map { |arg| arg.respond_to?(:to_ast) ? arg.to_ast : arg }
  [name, args_ast]
end

#to_proc ⇒ Proc

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.

Converts a transproc to a simple proc

Returns:

  • (Proc) 


100
101
102
103
104
105
106
 
# File 'lib/dry/transformer/function.rb', line 100

def to_proc
  if !args.empty?
    proc { |*value| fn.call(*value, *args) }
  else
    fn.to_proc
  end
end

#with(*args) ⇒ Function

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 a new fn with curried args

Returns:



74
75
76
 
# File 'lib/dry/transformer/function.rb', line 74

def with(*args)
  self.class.new(fn, name: name, args: args)
end