Contents

# frozen_string_literal: true

#
# Copyright (c) 2020-present, Blue Marble Payroll, LLC
#
# This source code is licensed under the MIT license found in the
# LICENSE file in the root directory of this source tree.
#

module Burner
  module Library
    module Collection
      # Take an array and remove the first N elements, where N is specified by the amount
      # attribute.  The initial use case for this was to remove "header" rows from arrays,
      # like you would expect when parsing CSV files.
      #
      # Expected Payload[register] input: nothing.
      # Payload[register] output: An array with N beginning elements removed.
      class Shift < JobWithRegister
        DEFAULT_AMOUNT = 0

        private_constant :DEFAULT_AMOUNT

        attr_reader :amount

        def initialize(amount: DEFAULT_AMOUNT, name: '', register: DEFAULT_REGISTER)
          super(name: name, register: register)

          @amount = amount.to_i

          freeze
        end

        def perform(output, payload)
          output.detail("Shifting #{amount} entries.")

          payload[register] = array(payload[register]).slice(amount..-1)
        end
      end
    end
  end
end

Version data entries

8 entries across 8 versions & 1 rubygems

Version	Path
burner-1.12.0	lib/burner/library/collection/shift.rb
burner-1.11.0	lib/burner/library/collection/shift.rb
burner-1.10.0	lib/burner/library/collection/shift.rb
burner-1.9.0	lib/burner/library/collection/shift.rb
burner-1.9.0.pre.alpha	lib/burner/library/collection/shift.rb
burner-1.8.0	lib/burner/library/collection/shift.rb
burner-1.7.0	lib/burner/library/collection/shift.rb
burner-1.7.0.pre.alpha	lib/burner/library/collection/shift.rb