xref_runner

-module(xrefr).
-author('euen@inakanerworks.com').

-export([ main/1
        , help/0
        , process_options/1
        ]).

%% @doc Allows us to runs xref_runner as script.
%%      This can be generated executing make escript
-spec main(string()) -> ok | no_return().
main(Args) ->
  OptSpecList = option_spec_list(),
  case getopt:parse(OptSpecList, Args) of
    {ok, {Options, _Commands}} ->
      case process_options(Options) of
          ok       -> ok;
          []       -> ok;
          Warnings -> maybe_halt(Warnings)
      end;
    {error, {Reason, Data}} ->
      error_prn("~s ~p~n", [Reason, Data]),
      help(),
      maybe_halt(64) %% 64 is EX_USAGE in sysexits(3).
  end.

-spec maybe_halt(non_neg_integer() | [xref_runner:warning()]) -> no_return().
maybe_halt(Warnings) when is_list(Warnings) ->
  case application:get_env(xref_runner, halt_behaviour, halt) of
    halt -> erlang:halt(1);
    exception -> throw({halt, Warnings})
  end;
maybe_halt(ExitStatus) when is_integer(ExitStatus) ->
  case application:get_env(xref_runner, halt_behaviour, halt) of
    halt -> erlang:halt(ExitStatus);
    exception -> throw({halt, ExitStatus})
  end.

-spec help() -> ok.
help() ->
  OptSpecList = option_spec_list(),
  getopt:usage(OptSpecList, "xref_runner", standard_io).

-spec option_spec_list() -> [getopt:option_spec()].
option_spec_list() ->
  Config = "Provide the path to the configuration file. "
           ++ "When none is provided xref_runner checks if there's "
           ++ "an ./xref.config file.",
  [
    {help, $h, "help", undefined, "Show this help information."},
    {config, $c, "config", string, Config}
  ].

%% @doc Identifies the argument and executes the corresponding functions
%%      depending if these are "-h --help", "-c --config" or empty.
-spec process_options([atom()]) -> ok | [xref_runner:warning()].
process_options([help | _Opts]) ->
  help();
process_options([{config, Path} | _Opts]) ->
  XrefWarnings = xref_runner:check(Path),
  warnings_prn(XrefWarnings),
  XrefWarnings;
process_options([]) ->
  XrefWarnings = xref_runner:check(),
  warnings_prn(XrefWarnings),
  XrefWarnings.

generate_comment(XrefWarning) ->
  #{ filename := Filename
   , line     := Line
   , source   := Source
   , check    := Check
   } = XrefWarning,
  Target = maps:get(target, XrefWarning, undefined),
  Position =
    case {Filename, Line} of
      {"", _} -> "";
      {Filename, 0} -> [Filename, " "];
      {Filename, Line} -> [Filename, ":", integer_to_list(Line), " "]
    end,
  [Position, generate_comment_text(Check, Source, Target)].

generate_comment_text(Check, {SM, SF, SA}, TMFA) ->
  SMFA = io_lib:format("`~p:~p/~p`", [SM, SF, SA]),
  generate_comment_text(Check, SMFA, TMFA);
generate_comment_text(Check, SMFA, {TM, TF, TA}) ->
  TMFA = io_lib:format("`~p:~p/~p`", [TM, TF, TA]),
  generate_comment_text(Check, SMFA, TMFA);
generate_comment_text(undefined_function_calls, SMFA, TMFA) ->
  io_lib:format("~s calls undefined function ~s", [SMFA, TMFA]);
generate_comment_text(undefined_functions, SMFA, _TMFA) ->
  io_lib:format("~s is not defined as a function", [SMFA]);
generate_comment_text(locals_not_used, SMFA, _TMFA) ->
  io_lib:format("~s is an unused local function", [SMFA]);
generate_comment_text(exports_not_used, SMFA, _TMFA) ->
  io_lib:format("~s is an unused export", [SMFA]);
generate_comment_text(deprecated_function_calls, SMFA, TMFA) ->
  io_lib:format("~s calls deprecated function ~s", [SMFA, TMFA]);
generate_comment_text(deprecated_functions, SMFA, _TMFA) ->
  io_lib:format("~s is deprecated", [SMFA]).

warnings_prn(Comments) ->
  Messages = lists:map(fun generate_comment/1, Comments),
  lists:foreach(fun warning_prn/1, Messages).

-spec warning_prn(string()) -> ok.
warning_prn(Message) ->
  FullMessage = Message ++ "~n",
  io:format(FullMessage, []).

-spec error_prn(string(), [term()]) -> ok.
error_prn(Message, Args) ->
  FullMessage = "Error: " ++ Message ++ "~n",
  io:format(FullMessage, Args).