ex_uc

defmodule ExUc.Kind do
  @moduledoc """
  Behaviour for a set of units of the same type with conversion
  among them. Every kind can be extended or overriden in configuration files.
  """

  use Behaviour

  @doc """
  Gets a keyword where every item is conformed by the unit identifier
  and a list of aliases
  """
  defcallback units() :: Keyword.t

  @doc """
  Gets a map  where each conversion is a composed by the pair `key:conversion`,
  where **key** is an atom with the pattern `<UNIT_FROM>_to_<UNIT_TO>`,
  and **conversion** could be a _number_, or a _closure_, or an _atom_.

  Numeric conversions describe multiplication factors,
  and can be also used as `<B>_to_<A>: 1 / conversion` for a `<A>_to_<B>: factor`
  without explicit definition.

  When a factor is not enough, a _closure_ can be used as a simple formula.

  For special cases use an _atom_ to describe a function in module `Special`.

  **Tip:** Althought the more direct conversions defined, the better performance is achieved, but
  every relation is not required,  just the ones conecting every unit as a graph.
  """
  defcallback conversions() :: Keyword.t

  @doc """
  Common methods for Kind
  """
  defmacro __using__(_) do
    quote location: :keep do
      @behaviour ExUc.Kind

      @doc """
      Gets all definitions in the module
      """
      def definitions do
        kind = __MODULE__ 
        |> Atom.to_string
        |> String.split(".")
        |> List.last
        |> String.downcase

        units_key = "#{kind}_units" |> String.to_atom
        conversions_key = "#{kind}_conversions" |> String.to_atom

        [
          {units_key, units()},
          {conversions_key, conversions()}
        ]
      end
    end
  end
end