Packages
credo
1.1.0-rc2
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/scope.ex
defmodule Credo.Code.Scope do
@moduledoc """
This module provides helper functions to determine the scope name at a certain
point in the analysed code.
"""
alias Credo.Code.Block
alias Credo.Code.Module
@def_ops [:def, :defp, :defmacro]
@doc """
Returns the module part of a scope.
iex> Credo.Code.Scope.mod_name("Credo.Code")
"Credo.Code"
iex> Credo.Code.Scope.mod_name("Credo.Code.ast")
"Credo.Code"
"""
def mod_name(nil), do: nil
def mod_name(scope_name) do
names = String.split(scope_name, ".")
base_name = List.last(names)
if String.match?(base_name, ~r/^[a-z]/) do
names
|> Enum.slice(0..(length(names) - 2))
|> Enum.join(".")
else
scope_name
end
end
@doc """
Returns the scope for the given line as a tuple consisting of the call to
define the scope (`:defmodule`, `:def`, `:defp` or `:defmacro`) and the
name of the scope.
Examples:
{:defmodule, "Foo.Bar"}
{:def, "Foo.Bar.baz"}
"""
def name(_ast, line: 0), do: nil
def name(ast, line: line) do
result =
case find_scope(ast, line, [], nil) do
nil ->
name(ast, line: line - 1)
{op, list} ->
name =
list
|> Enum.map(&name_to_string/1)
|> Enum.join(".")
{op, name}
end
result || {nil, ""}
end
defp name_to_string(atom) when is_atom(atom), do: to_string(atom)
defp name_to_string(term), do: Macro.to_string(term)
# Returns a List for the scope name
defp find_scope({:__block__, _meta, arguments}, line, name_list, last_op) do
find_scope(arguments, line, name_list, last_op)
end
defp find_scope({:do, arguments}, line, name_list, last_op) do
find_scope(arguments, line, name_list, last_op)
end
defp find_scope({:else, arguments}, line, name_list, last_op) do
find_scope(arguments, line, name_list, last_op)
end
defp find_scope(list, line, name_list, last_op) when is_list(list) do
Enum.find_value(list, &find_scope(&1, line, name_list, last_op))
end
defp find_scope(
{:defmodule, meta, [{:__aliases__, _, module_name}, arguments]},
line,
name_list,
_last_op
) do
name_list = name_list ++ module_name
cond do
meta[:line] == line ->
{:defmodule, name_list}
meta[:line] > line ->
nil
true ->
arguments
|> Block.do_block_for!()
|> find_scope(line, name_list, :defmodule)
end
end
for op <- @def_ops do
defp find_scope(
{unquote(op) = op, meta, arguments} = ast,
line,
name_list,
_last_op
)
when is_list(arguments) do
fun_name = Module.def_name(ast)
name_list = name_list ++ [fun_name]
cond do
meta[:line] == line ->
{op, name_list}
meta[:line] > line ->
nil
true ->
arguments
|> Block.do_block_for!()
|> find_scope(line, name_list, op)
end
end
end
defp find_scope({_atom, meta, arguments}, line, name_list, last_op) do
if meta[:line] == line do
{last_op, name_list}
else
find_scope(arguments, line, name_list, last_op)
end
end
defp find_scope(_value, _line, _name_list, _last_op) do
nil
end
end