Packages
credo
0.4.6
1.7.19
1.7.18
1.7.17
1.7.16
1.7.15
1.7.14
1.7.13
1.7.12
1.7.11
1.7.10
1.7.9
1.7.8
1.7.7
1.7.7-rc.0
1.7.6
1.7.5
1.7.4
1.7.3
1.7.2
1.7.2-rc.4
1.7.2-rc.3
1.7.2-rc.2
1.7.2-rc.1
1.7.2-rc.0
1.7.1
1.7.0
1.7.0-rc.2
1.7.0-rc.1
1.6.7
1.6.6
1.6.5
1.6.4
1.6.3
1.6.2
1.6.1
1.6.0
1.6.0-rc.1
1.6.0-rc.0
1.5.6
1.5.5
1.5.4
1.5.3
1.5.2
1.5.1
1.5.0
1.5.0-rc.5
1.5.0-rc.4
1.5.0-rc.3
1.5.0-rc.2
1.5.0-rc.1
1.4.1
1.4.0
1.4.0-rc.2
1.4.0-rc.1
1.3.2
1.3.1
1.3.0
1.3.0-rc3
1.3.0-rc2
1.3.0-rc1
1.2.3
1.2.2
1.2.1
1.2.0
1.2.0-rc4
1.2.0-rc3
1.2.0-rc2
1.2.0-rc1
1.1.5
1.1.4
1.1.3
1.1.2
1.1.1
1.1.0
1.1.0-rc3
1.1.0-rc2
1.1.0-rc1
1.0.5
1.0.4
1.0.3
1.0.2
1.0.1
1.0.1-rc1
1.0.0
1.0.0-rc1
0.10.2
0.10.1
0.10.0
0.9.3
0.9.2
0.9.1
0.9.0
0.9.0-rc8
0.9.0-rc7
0.9.0-rc6
0.9.0-rc5
0.9.0-rc4
0.9.0-rc3
0.9.0-rc2
0.9.0-rc1
0.8.10
0.8.9
0.8.8
0.8.7
0.8.6
0.8.5
0.8.4
0.8.3
0.8.2
0.8.1
0.8.0
0.8.0-rc7
0.8.0-rc6
0.8.0-rc5
0.8.0-rc4
0.8.0-rc3
0.8.0-rc2
0.8.0-rc1
0.7.4
0.7.3
0.7.2
0.7.1
0.7.0
0.6.1
0.6.0
0.6.0-rc2
0.6.0-rc1
0.5.3
0.5.2
0.5.1
0.5.0
0.4.14
0.4.13
0.4.12
0.4.11
0.4.10
0.4.10-dev
0.4.9
0.4.8
0.4.7
0.4.6
0.4.5
0.4.4
0.4.3
0.4.2
0.4.1
0.4.0
0.4.0-beta5
0.4.0-beta4
0.4.0-beta3
0.4.0-beta2
0.4.0-beta1
0.3.13
0.3.12
0.3.11
0.3.10
0.3.9
0.3.8
0.3.7
0.3.6
0.3.5
0.3.4
0.3.3
0.3.2
0.3.1
0.3.0
0.3.0-dev2
0.3.0-dev
0.2.6
0.2.5
0.2.4
0.2.3
0.2.2
0.2.1
0.2.0
0.1.10
0.1.9
0.1.8
0.1.7
0.1.6
0.1.5
0.1.4
0.1.3
0.1.2
0.1.1
0.1.0
0.0.1-dev
A static code analysis tool with a focus on code consistency and teaching.
Current section
Files
Jump to
Current section
Files
lib/credo/code/module.ex
defmodule Credo.Code.Module do
@moduledoc """
This module provides helper functions to analyse modules, return the defined
funcions or module attributes.
"""
alias Credo.Code
alias Credo.Code.Block
@def_ops [:def, :defp, :defmacro]
@doc "Reads an attribute from a module's `ast`"
def attribute(ast, attr_name) do
case Credo.Code.traverse(ast, &find_attribute(&1, &2, attr_name), {:error, nil}) do
{:ok, value} -> value
error -> error
end
end
defp find_attribute({:@, _meta, arguments} = ast, tuple, attribute_name) do
case arguments |> List.first do
{^attribute_name, _meta, [value]} -> {:ok, value}
_ -> {ast, tuple}
end
end
defp find_attribute(ast, tuple, _name) do
{ast, tuple}
end
@doc "Returns the function/macro count for the given module's AST"
def def_count(nil), do: 0
def def_count({:defmodule, _, _arguments} = ast) do
ast
|> Code.traverse(&traverse_mod/2)
|> Enum.count
end
@doc """
Returns of the name of the function/macro defined in the given `ast`.
"""
for op <- @def_ops ++ [:when] do
def def_name_with_op({unquote(op) = op, _meta, arguments}) when is_list(arguments) do
{arguments |> List.first |> def_name, op}
end
def def_name_with_op({unquote(op) = op, _meta, arguments}, arity) when is_list(arguments) do
fun_def = arguments |> List.first
if fun_def |> def_arity() == arity do
{fun_def |> def_name, op}
else
nil
end
end
end
@doc """
Returns the arity of the given function definition.
"""
def def_arity({_fun_name, _, nil}), do: 0
def def_arity({_fun_name, _, arguments}), do: Enum.count(arguments)
@doc """
Returns of the name of the function/macro defined in the given `ast`.
"""
for op <- @def_ops ++ [:when] do
def def_name({unquote(op), _meta, arguments}) when is_list(arguments) do
arguments
|> List.first
|> def_name
end
end
def def_name({fun_name, _meta, _arguments}) when is_atom(fun_name) do
fun_name
end
def def_name(_), do: nil
@doc "Returns the name of the functions/macros for the given module's `ast`"
def def_names_with_op(nil), do: []
def def_names_with_op({:defmodule, _, _arguments} = ast) do
ast
|> Code.traverse(&traverse_mod/2)
|> Enum.map(&def_name_with_op/1)
|> Enum.uniq
end
@doc "Returns the name of the functions/macros for the given module's `ast` if it has the given `arity`."
def def_names_with_op(nil, _arity), do: []
def def_names_with_op({:defmodule, _, _arguments} = ast, arity) do
ast
|> Code.traverse(&traverse_mod/2)
|> Enum.map(&def_name_with_op(&1, arity))
|> Enum.reject(&is_nil/1)
|> Enum.uniq
end
@doc "Returns the name of the functions/macros for the given module's `ast`"
def def_names(nil), do: []
def def_names({:defmodule, _, _arguments} = ast) do
ast
|> Code.traverse(&traverse_mod/2)
|> Enum.map(&def_name/1)
|> Enum.uniq
end
for op <- @def_ops do
def traverse_mod({unquote(op), _, arguments} = ast, defs) when is_list(arguments) do
{ast, defs ++ [ast]}
end
end
def traverse_mod(ast, defs) do
{ast, defs}
end
# TODO: write unit test
def name({:defmodule, _, [{:__aliases__, _, name_list}, _]}) do
Enum.join(name_list, ".")
end
def name(_), do: nil
# TODO: write unit test
def exception?({:defmodule, _, [{:__aliases__, _, _name_list}, arguments]}) do
arguments
|> Block.calls_in_do_block
|> Enum.any?(&defexception?/1)
end
def exception?(_), do: nil
defp defexception?({:defexception, _, _}), do: true
defp defexception?(_), do: false
end