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
  class Jobs
    module Collection
      # Take an array and remove the first N elements, where N is specified by the amount
      # attribute.
      # Expected Payload#value input: nothing.
      # Payload#value output: An array with N beginning elements removed.
      class Shift < Job
        DEFAULT_AMOUNT = 0

        private_constant :DEFAULT_AMOUNT

        attr_reader :amount

        def initialize(name:, amount: DEFAULT_AMOUNT)
          super(name: name)

          @amount = amount.to_i

          freeze
        end

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

          payload.value ||= []
          payload.value.shift(amount)

          nil
        end
      end
    end
  end
end

Version data entries

2 entries across 2 versions & 1 rubygems

Version	Path
burner-1.0.0.pre.alpha.5	lib/burner/jobs/collection/shift.rb
burner-1.0.0.pre.alpha.4	lib/burner/jobs/collection/shift.rb