Contents

# frozen_string_literal: true

module Ductr
  module Store
    #
    # Convert jobs into active job serializable structs.
    #
    module JobSerializer
      #
      # @!parse
      #   #
      #   # The job representation as a struct.
      #   #
      #   # @!attribute [r] job_id
      #   #   @return [String] The active job's job id
      #   #
      #   # @!attribute [r] status
      #   #   @return [Symbol] The job's status
      #   #
      #   # @!attribute [r] error
      #   #   @return [Exception, nil] The job's error if any
      #   #
      #   class SerializedJob < Struct
      #     #
      #     # @param [String] job_id Active job's job id
      #     # @param [Symbol] status Job's status
      #     # @param [Exception, nil] error Job's error
      #     #
      #     def initialize(job_id, status, error)
      #       @job_id = job_id
      #       @status = status
      #       @error = error
      #     end
      #   end
      #
      SerializedJob = Struct.new(:job_id, :status, :error) do
        #
        # Determines whether the job has a `completed` or `failed` status.
        #
        # @return [Boolean] True when the status is `completed` or `failed`
        #
        def stopped?
          %i[completed failed].include? status
        end
      end

      #
      # Convert the given job into a `SerializedJob` struct.
      #
      # @param [Job] job The job to serialize
      #
      # @return [SerializedJob] The job converted into struct
      #
      def serialize_job(job)
        SerializedJob.new(job.job_id, job.status, job.error)
      end
    end
  end
end

Version data entries

7 entries across 7 versions & 1 rubygems

Version	Path
ductr-0.2.3	lib/ductr/store/job_serializer.rb
ductr-0.2.2	lib/ductr/store/job_serializer.rb
ductr-0.2.1	lib/ductr/store/job_serializer.rb
ductr-0.2.0	lib/ductr/store/job_serializer.rb
ductr-0.1.2	lib/ductr/store/job_serializer.rb
ductr-0.1.1	lib/ductr/store/job_serializer.rb
ductr-0.1.0	lib/ductr/store/job_serializer.rb