passive_support

defmodule PassiveSupport.Logging do
  @moduledoc """
  Helper functions for logging and inspecting.

  These functions serve two primary purposes and one subtle but kinda nice purpose:

  1. To keep outputs colorized even when they're sent to Logger,
  2. To keep `IO.inspect` and `Kernel.inspect` from truncating away data
     you might need if you intend, e.g., to save a function's return
     as fixture data for debugging purposes
  3. Not needing to temporarily `require Logger` when you're debugging a module
  """

  import Kernel, except: [inspect: 1, inspect: 2]

  @doc """
  Sensible defaults for see a value in its entirety through `IO.inspect` and `Kernel.inspect`
  """
  @spec inspect_opts :: [printable_limit: :infinity, limit: :infinity, width: 170, pretty: true]
  def inspect_opts do
    [
      printable_limit: :infinity,
      limit: :infinity,
      width: 170,
      pretty: true
    ]
  end

  @doc """
  Pretty good, pretty pretty, color choices for inspected data
  """
  @spec coloration_opts ::
    {:syntax_colors, [number: :yellow, string: :green, list: :light_magenta,
      map: :light_cyan, atom: :light_blue, tuple: :"[:black_background, :white]",
      regex: :"[:cyan_background, :light_yellow]"
    ]}
  def coloration_opts do
    {:syntax_colors, [number: :yellow, string: :green, list: :light_magenta,
      map: :light_cyan, atom: :light_blue, tuple: [:black_background, :white],
      regex: [:cyan_background, :light_yellow]
    ]}
  end

  @doc """
  Sensible option defaults for logging information to stdout
  """
  @spec logger_opts :: [
    syntax_colors: [number: :yellow, string: :green, list: :light_magenta,
        map: :light_cyan, atom: :light_blue, tuple: :"[:black_background, :white]",
        regex: :"[:cyan_background, :light_yellow]"
      ],
    printable_limit: :infinity, limit: :infinity, width: 170, pretty: true
  ]
  def logger_opts do
    [coloration_opts() | inspect_opts()]
  end

  @doc """
  calls `Kernel.inspect/2` on `item` with `logger_opts/0`.

  If you wish to overwrite some portion of the `opts` send to `inspect`,
  consider calling `Kernel.inspect` and passing `Utils.logger_opts() ++
  overwrites` as your `opts` instead of calling this function.
  """
  def inspect(item, to_log \\ false) do
    Kernel.inspect(item, if(to_log, do: logger_opts(), else: inspect_opts()))
  end

  require Logger
  def info(item \\ nil, label \\ nil) do
    if label, do: Logger.info([label, ":"])
    if item, do: Logger.info(inspect(item))
    item
  end

  def debug(item \\ nil, label \\ nil) do
    if label, do: Logger.debug([label, ":"])
    if item, do: Logger.debug(inspect(item))
    item
  end

  def warn(item \\ nil, label \\ nil) do
    if label, do: Logger.warn([label, ":"])
    if item, do: Logger.warn(inspect(item))
    item
  end

  def alert(item \\ nil, label \\ nil) do
    if label, do: Logger.alert([label, ":"])
    if item, do: Logger.alert(inspect(item))
    item
  end

  def critical(item \\ nil, label \\ nil) do
    if label, do: Logger.critical([label, ":"])
    if item, do: Logger.critical(inspect(item))
    item
  end

  def emergency(item \\ nil, label \\ nil) do
    if label, do: Logger.emergency([label, ":"])
    if item, do: Logger.emergency(inspect(item))
    item
  end

  def error(item \\ nil, label \\ nil) do
    if label, do: Logger.error([label, ":"])
    if item, do: Logger.error(inspect(item))
    item
  end

  def notice(item \\ nil, label \\ nil) do
    if label, do: Logger.notice([label, ":"])
    if item, do: Logger.notice(inspect(item))
    item
  end
end