defmodule Credo.Check.Refactor.FunctionArity do
use Credo.Check,
id: "EX4010",
param_defaults: [max_arity: 8, ignore_defp: false],
explanations: [
check: """
A function can take as many parameters as needed, but even in a functional
language there can be too many parameters.
Can optionally ignore private functions (check configuration options).
""",
params: [
max_arity: "The maximum number of parameters which a function should take.",
ignore_defp: "Set to `true` to ignore private functions."
]
]
alias Credo.Code.Parameters
@def_ops [:def, :defp, :defmacro]
@doc false
@impl true
def run(%SourceFile{} = source_file, params) do
issue_meta = IssueMeta.for(source_file, params)
max_arity = Params.get(params, :max_arity, __MODULE__)
ignore_defp = Params.get(params, :ignore_defp, __MODULE__)
Credo.Code.prewalk(
source_file,
&traverse(&1, &2, issue_meta, max_arity, ignore_defp)
)
end
# TODO: consider for experimental check front-loader (ast)
for op <- @def_ops do
defp traverse(
{unquote(op) = op, meta, arguments} = ast,
issues,
issue_meta,
max_arity,
ignore_defp
)
when is_list(arguments) do
arity = Parameters.count(ast)
if issue?(op, ignore_defp, arity, max_arity) do
fun_name = Credo.Code.Module.def_name(ast)
{
ast,
issues ++ [issue_for(issue_meta, meta[:line], fun_name, max_arity, arity)]
}
else
{ast, issues}
end
end
end
defp traverse(ast, issues, _issue_meta, _max_arity, _ignore_defp) do
{ast, issues}
end
defp issue?(:defp, true, _, _), do: false
defp issue?(_, _, arity, max_arity) when arity > max_arity, do: true
defp issue?(_, _, _, _), do: false
defp issue_for(issue_meta, line_no, trigger, max_value, actual_value) do
format_issue(
issue_meta,
message:
"Function takes too many parameters (arity is #{actual_value}, max is #{max_value}).",
trigger: trigger,
line_no: line_no,
severity: Severity.compute(actual_value, max_value)
)
end
end