gen_queue

defmodule GenQueue.JobAdapter do
  @moduledoc """
  A behaviour module for implementing job queue adapters.
  """

  @doc """
  Push a job to a queue

  ## Parameters:
    * `gen_queue` - A `GenQueue` module
    * `job` - A `GenQueue.Job` struct

  ## Returns:
    * `{:ok, job}` if the operation was successful
    * `{:error, reason}` if there was an error
  """
  @callback handle_job(gen_queue :: GenQueue.t(), job :: GenQueue.Job.t()) ::
              {:ok, GenQueue.Job.t()} | {:error, any}

  defmacro __using__(_) do
    quote location: :keep do
      @behaviour GenQueue.JobAdapter

      use GenQueue.Adapter

      @doc """
      Callback implementation for `GenQueue.Adapter.push/2`
      """
      def handle_push(gen_queue, item, opts) do
        handle_job(gen_queue, GenQueue.Job.new(item, opts))
      end

      @doc false
      def handle_job(_gen_queue, _job) do
        {:error, :not_implemented}
      end

      defoverridable GenQueue.JobAdapter
    end
  end
end