Current section

Files

Jump to
credo lib credo priority.ex
Raw

lib/credo/priority.ex

defmodule Credo.Priority do
@moduledoc """
In Credo each Issue is given a priority to differentiate issues by a second
dimension next to their Category.
"""
alias Credo.Code.Module
alias Credo.Code.Parameters
alias Credo.Code.Scope
alias Credo.SourceFile
@def_ops [:def, :defp, :defmacro]
@many_functions_count 5
def scope_priorities(%SourceFile{} = source_file) do
line_count =
source_file
|> SourceFile.lines()
|> length()
empty_priorities = Enum.map(1..line_count, fn _ -> [] end)
priority_list = Credo.Code.prewalk(source_file, &traverse/2, empty_priorities)
base_map = make_base_map(priority_list, source_file)
lookup = Enum.into(base_map, %{})
base_map
|> Enum.map(fn {scope_name, prio} ->
names = String.split(scope_name, ".")
if names |> List.last() |> String.match?(~r/^[a-z]/) do
mod_name =
names
|> Enum.slice(0..(length(names) - 2))
|> Enum.join(".")
mod_prio = lookup[mod_name]
{scope_name, prio + mod_prio}
else
{scope_name, prio}
end
end)
|> Enum.into(%{})
end
defp make_base_map(priority_list, %SourceFile{} = source_file) do
ast = SourceFile.ast(source_file)
priority_list
|> Enum.with_index()
|> Enum.map(fn {list, index} ->
case list do
[] ->
nil
_ ->
{_, scope_name} = Scope.name(ast, line: index + 1)
{scope_name, Enum.sum(list)}
end
end)
|> Enum.reject(&is_nil/1)
end
defp traverse({:defmodule, meta, _} = ast, acc) do
added_prio = priority_for(ast)
{ast, List.update_at(acc, meta[:line] - 1, &(&1 ++ [added_prio]))}
end
for op <- @def_ops do
defp traverse({unquote(op), meta, arguments} = ast, acc)
when is_list(arguments) do
added_prio = priority_for(ast)
case arguments do
[{_func_name, _meta, _func_arguments}, _do_block] ->
{ast, List.update_at(acc, meta[:line] - 1, &(&1 ++ [added_prio]))}
_ ->
{ast, acc}
end
end
end
defp traverse(ast, acc) do
{ast, acc}
end
defp priority_for({:defmodule, _, _} = ast) do
if Module.def_count(ast) >= @many_functions_count do
2
else
1
end
end
for op <- @def_ops do
defp priority_for({unquote(op), _, arguments} = ast)
when is_list(arguments) do
count = Parameters.count(ast)
cond do
count == 0 -> 0
count in 1..2 -> 1
count in 3..4 -> 2
true -> 3
end
end
end
end