Class: Kiba::Extend::Transforms::Cspace::Movementreferencenumber

Inherits:
Object
  • Object
show all
Defined in:
lib/kiba/extend/transforms/cspace/movementreferencenumber.rb

Overview

Generates typical pattern of movementReferenceNumbers based on year in location date, where available. For each year, the procedure data is sorted by the full date value, and the reference number value is incremented.

The typical number pattern used is the location record pattern from the number autogenerator in Location/Movement/Inventory (LMI) the UI. The pattern is:

  • LOC (customizable via the prefix parameter)
  • 4-digit year (for rows with no date, the value given for nodateval will be inserted here)
  • .1 (this is one of those meaningless id number segments that never gets incremented, but clients like to have it there to match the default autogenerator, so here we are… customize this if desired via the preincrementsegment param)
  • .
  • autoincrementing digit

ASSUMPTIONS OF THIS TRANSFORM

  • You will have already reduced the output to one row per LMI to be created in CollectionSpace
  • You will have used DateValue::ForceDayPrecision or some other method to create a field containing only blank values and valid ISO 8601 dates to be mapped to the unstructured date locationdate field in CollectionSpace

SORTING, or, how the end digit gets incremented within a year

See IdGenerator::YearBasedIncrementing for sorting details.

Examples:

With default sorter

# Used in pipeline as:
# transform Cspace::Movementreferencenumber,
#   datefield: :d,
#   target: :tada
xform = Cspace::Movementreferencenumber.new(
  datefield: :d,
  target: :tada
)
input = [
  {d: "2007-12-13", i: "a"},
  {d: "2000-05-23", i: "z"},
  {d: "2000-01-01", i: "c"},
  {d: "", i: "q"},
  {d: "2000-05-23", i: "g"},
  {d: "2007-10-31", i: "f"},
  {d: "2000-12-14", i: "h"},
  {d: "2000-05-23", i: "d"},
  {d: nil, i: "y"},
  {d: "2017-02-04", i: "x"}
]
result = Kiba::StreamingRunner.transform_stream(input, xform)
  .map{ |row| row }
expected = [
  {d: "2007-10-31", i: "f", tada: "LOC2007.1.1"},
  {d: "2007-12-13", i: "a", tada: "LOC2007.1.2"},
  {d: "2000-01-01", i: "c", tada: "LOC2000.1.1"},
  {d: "2000-05-23", i: "z", tada: "LOC2000.1.2"},
  {d: "2000-05-23", i: "g", tada: "LOC2000.1.3"},
  {d: "2000-05-23", i: "d", tada: "LOC2000.1.4"},
  {d: "2000-12-14", i: "h", tada: "LOC2000.1.5"},
  {d: "", i: "q", tada: "LOC0000.1.1"},
  {d: nil, i: "y", tada: "LOC0000.1.2"},
  {d: "2017-02-04", i: "x", tada: "LOC2017.1.1"}
]
expect(result).to eq(expected)

With custom sorter and omitted preincrementsegment

# Used in pipeline as:
# transform Cspace::Movementreferencenumber,
#   datefield: :d,
#   target: :tada,
#   preincrementsegment: "",
#   sorter: ->(r, _na) do
#     r.sort_by { |row| row[:i] }
#   end
xform = Cspace::Movementreferencenumber.new(
  datefield: :d,
  target: :tada,
  preincrementsegment: "",
  sorter: ->(r, _na) do
    r.sort_by { |row| row[:i] }
  end
)
input = [
  {d: "2007-12-13", i: "a"},
  {d: "2000-05-23", i: "z"},
  {d: "2000-01-01", i: "c"},
  {d: "", i: "q"},
  {d: "2000-05-23", i: "g"},
  {d: "2007-10-31", i: "f"},
  {d: "2000-12-14", i: "h"},
  {d: "2000-05-23", i: "d"},
  {d: nil, i: "y"},
  {d: "2017-02-04", i: "x"}
]
result = Kiba::StreamingRunner.transform_stream(input, xform)
  .map{ |row| row }
expected = [
  {d: "2007-12-13", i: "a", tada: "LOC20071"},
  {d: "2007-10-31", i: "f", tada: "LOC20072"},
  {d: "2000-01-01", i: "c", tada: "LOC20001"},
  {d: "2000-05-23", i: "d", tada: "LOC20002"},
  {d: "2000-05-23", i: "g", tada: "LOC20003"},
  {d: "2000-12-14", i: "h", tada: "LOC20004"},
  {d: "2000-05-23", i: "z", tada: "LOC20005"},
  {d: "", i: "q", tada: "LOC00001"},
  {d: nil, i: "y", tada: "LOC00002"},
  {d: "2017-02-04", i: "x", tada: "LOC20171"}
]
expect(result).to eq(expected)

Instance Method Summary collapse

Constructor Details

#initialize(datefield:, prefix: "LOC", nodateval: "0000", preincrementsegment: ".1.", target: :movementreferencenumber, sorter: nil) ⇒ Movementreferencenumber

Returns a new instance of Movementreferencenumber.

Parameters:

  • datefield (Symbol) —

    field containing valid ISO 8601 dates and blank values only

  • target (Symbol) (defaults to: :movementreferencenumber) —

    field in which to write the generated value

  • prefix (String) (defaults to: "LOC") —

    initial segment of generated value

  • preincrementsegment (String) (defaults to: ".1.") —

    optional segment of number after the year or nodateval and before the incrementing segment

  • nodateval (String) (defaults to: "0000") —

    value inserted instead of the year, if datefield is blank

  • sorter (Lambda) (defaults to: nil) —

    taking rows and datefield args, and returning sorted rows



129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
 
# File 'lib/kiba/extend/transforms/cspace/movementreferencenumber.rb', line 129

def initialize(datefield:,
  prefix: "LOC",
  nodateval: "0000",
  preincrementsegment: ".1.",
  target: :movementreferencenumber,
  sorter: nil)
  @generator = IdGenerator::YearBasedIncrementing.new(
    datefield: datefield,
    prefix: prefix,
    nodateval: nodateval,
    preincrementsegment: preincrementsegment,
    target: target,
    sorter: sorter
  )
end

Instance Method Details

#close ⇒ Object 



149
150
151
152
 
# File 'lib/kiba/extend/transforms/cspace/movementreferencenumber.rb', line 149

def close
  generator.finalized_rows
    .each { |row| yield row }
end

#process(row) ⇒ Object 



145
146
147
 
# File 'lib/kiba/extend/transforms/cspace/movementreferencenumber.rb', line 145

def process(row)
  generator.process(row)
end