Class: Kiba::Extend::Transforms::Rename::Fields

Inherits:
Object
  • Object
show all
Defined in:
lib/kiba/extend/transforms/rename/fields.rb

Overview

Renames multiple fields at once, given a fieldmap where key is from field and value is to field

This transform works by creating a Field transform for each key/value pair specified in fieldmap, so see Field for examples demonstrating edge case behavior.

Examples:

# Used in pipeline as:
# transform Rename::Fields, fieldmap: {
#   name: :appellation,
#   sex: :gender,
#   color: :color
# }
xform = Rename::Fields.new(fieldmap: {
  name: :appellation,
  sex: :gender,
  color: :color
})
input = [
  {name: "Weddy", sex: "m", color: "pearl gray, greater, pied"},
  {name: "Kernel", sex: "f", color: "buff dundotte"}
]
result = Kiba::StreamingRunner.transform_stream(input, xform)
  .map{ |row| row }
expected = [
  {appellation: "Weddy", gender: "m",
    color: "pearl gray, greater, pied"},
  {appellation: "Kernel", gender: "f", color: "buff dundotte"},
]
expect(result).to eq(expected)

Since:

  • 2.8.0

Instance Method Summary collapse

Constructor Details

#initialize(fieldmap:, suppress_missing_key_warnings: false, suppress_overwrite_warnings: false) ⇒ Fields

Returns a new instance of Fields.

Parameters:

  • fieldmap (Hash(Symbol => Symbol)) —

    Keys are the from fields; values are the to fields

  • suppress_missing_key_warnings (Boolean) (defaults to: false)
  • suppress_overwrite_warnings (Boolean) (defaults to: false)

Since:

  • 2.8.0



46
47
48
49
50
51
52
53
54
55
56
57
58
 
# File 'lib/kiba/extend/transforms/rename/fields.rb', line 46

def initialize(fieldmap:,
  suppress_missing_key_warnings: false,
  suppress_overwrite_warnings: false)
  @fieldmap = fieldmap
  @renamers = fieldmap.map do |from, to|
    Rename::Field.new(
      from: from,
      to: to,
      suppress_missing_key_warnings: suppress_missing_key_warnings,
      suppress_overwrite_warnings: suppress_overwrite_warnings
    )
  end
end

Instance Method Details

#process(row) ⇒ Object

Parameters:

  • row (Hash{ Symbol => String, nil })

Since:

  • 2.8.0



61
62
63
64
 
# File 'lib/kiba/extend/transforms/rename/fields.rb', line 61

def process(row)
  renamers.each { |renamer| renamer.process(row) }
  row
end