lib/patch/mock/history.ex

defmodule Patch.Mock.History do
  @type name :: atom()
  @type argument :: term()
  @type entry :: {name(), [argument()]}
  @type limit :: non_neg_integer() | :infinity
  @type sorting :: :asc | :desc

  @type t :: %__MODULE__{
          count: non_neg_integer(),
          entries: [entry()],
          limit: limit()
        }
  defstruct count: 0,
            entries: [],
            limit: :infinity

  @spec new(limit :: limit()) :: t()
  def new(limit \\ :infinity) do
    %__MODULE__{limit: limit}
  end

  @spec entries(history :: t(), sorting :: sorting()) :: [entry()]
  def entries(history, sorting \\ :asc)

  def entries(%__MODULE__{} = history, :asc) do
    Enum.reverse(history.entries)
  end

  def entries(%__MODULE__{} = history, :desc) do
    history.entries
  end

  @spec put(history :: t(), name :: name(), arguments :: [argument()]) :: t()
  def put(%__MODULE__{limit: 0} = history, _name, _arguments) do
    # When the limit is 0, no-op.
    history
  end

  def put(%__MODULE__{limit: 1} = history, name, arguments) do
    # When the limit is 1 just set the entries directly
    %__MODULE__{history | count: 1, entries: [{name, arguments}]}
  end

  def put(%__MODULE__{limit: :infinity} = history, name, arguments) do
    # When the history is infinite just keep appending.
    %__MODULE__{
      history
      | count: history.count + 1,
        entries: [{name, arguments} | history.entries]
    }
  end

  def put(%__MODULE__{limit: limit, count: count} = history, name, arguments)
      when count < limit do
    # When there is still slack capacity in the history, do a simple append.
    %__MODULE__{
      history
      | count: history.count + 1,
        entries: [{name, arguments} | history.entries]
    }
  end

  def put(%__MODULE__{} = history, name, arguments) do
    # Buffer is bounded and out of slack capacity.
    entries = Enum.take([{name, arguments} | history.entries], history.limit)
    %__MODULE__{history | entries: entries}
  end
end