cblage/elixir-json

View on GitHub
lib/json/decoder.ex

Summary

Maintainability
Test Coverage
F
57%
defprotocol JSON.Decoder do
  @moduledoc """
  Defines the protocol required for converting raw JSON into Elixir terms
  """

  @doc """
  Returns an atom and an Elixir term
  """
  @spec decode(any) :: {atom, term}
  def decode(bitstring_or_char_list)
end

defmodule JSON.Decoder.DefaultImplementations do
  require Logger
  import JSON.Logger

  defimpl JSON.Decoder, for: BitString do
    @moduledoc """
    JSON Decoder implementation for BitString values
    """

    alias JSON.Parser, as: Parser

    @doc """
    decodes json in BitString format

    ## Examples

        iex> JSON.Decoder.decode ""
        {:error, :unexpected_end_of_buffer}

        iex> JSON.Decoder.decode "face0ff"
        {:error, {:unexpected_token, "face0ff"}}

        iex> JSON.Decoder.decode "-hello"
        {:error, {:unexpected_token, "-hello"}}

    """
    def decode(bitstring) do
      log(:debug, fn -> "#{__MODULE__}.decode(#{inspect(bitstring)}) starting..." end)

      bitstring
      |> String.trim()
      |> Parser.parse()
      |> case do
        {:error, error_info} ->
          log(:debug, fn ->
            "#{__MODULE__}.decode(#{inspect(bitstring)}} failed with error: #{inspect(error_info)}"
          end)

          {:error, error_info}

        {:ok, value, rest} ->
          log(:debug, fn ->
            "#{__MODULE__}.decode(#{inspect(bitstring)}) trimming remainder of JSON payload #{
              inspect(rest)
            }..."
          end)

          case rest |> String.trim() do
            <<>> ->
              log(:debug, fn ->
                "#{__MODULE__}.decode(#{inspect(bitstring)}) successfully trimmed remainder JSON payload!"
              end)

              log(:debug, fn ->
                "#{__MODULE__}.decode(#{inspect(bitstring)}) returning {:ok. #{inspect(value)}}"
              end)

              {:ok, value}

            rest ->
              log(:debug, fn ->
                "#{__MODULE__}.decode(#{inspect(bitstring)}} failed consume entire buffer: #{rest}"
              end)

              {:error, {:unexpected_token, rest}}
          end
      end
    end
  end

  defimpl JSON.Decoder, for: List do
    @moduledoc """
    JSON Decoder implementation for Charlist values
    """

    alias JSON.Decoder, as: Decoder

    @doc """
    decodes json in BitString format

    ## Examples

        iex> JSON.Decoder.decode ""
        {:error, :unexpected_end_of_buffer}

        iex> JSON.Decoder.decode "face0ff"
        {:error, {:unexpected_token, "face0ff"}}

        iex> JSON.Decoder.decode "-hello"
        {:error, {:unexpected_token, "-hello"}}

    """
    def decode(charlist) do
      charlist
      |> to_string()
      |> Decoder.decode()
      |> case do
        {:ok, value} ->
          {:ok, value}

        {:error, error_info} when is_binary(error_info) ->
          log(:debug, fn ->
            "#{__MODULE__}.decode(#{inspect(charlist)}} failed with error: #{inspect(error_info)}"
          end)

          {:error, error_info |> to_charlist()}

        {:error, {:unexpected_token, bin}} when is_binary(bin) ->
          log(:debug, fn ->
            "#{__MODULE__}.decode(#{inspect(charlist)}} failed with error: #{inspect(bin)}"
          end)

          {:error, {:unexpected_token, bin |> to_charlist()}}

        e = {:error, error_info} ->
          log(:debug, fn ->
            "#{__MODULE__}.decode(#{inspect(charlist)}} failed with error: #{inspect(e)}"
          end)

          {:error, error_info}
      end
    end
  end
end