Packages
credo
0.3.13
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/check/code_helper.ex
defmodule Credo.Check.CodeHelper do
@moduledoc """
This module contains functions that are used by several
checks when dealing with the AST.
"""
alias Credo.Code.Block
alias Credo.Code.Parameters
alias Credo.Code.Module
alias Credo.Code.Scope
alias Credo.Code.Sigils
alias Credo.Code.Strings
alias Credo.Service.SourceFileScopes
alias Credo.Service.SourceFileCodeOnly
alias Credo.Service.SourceFileWithoutStringAndSigils
alias Credo.SourceFile
@def_ops [:def, :defp, :defmacro]
defdelegate do_block?(ast), to: Block, as: :do_block?
defdelegate do_block_for!(ast), to: Block, as: :do_block_for!
defdelegate do_block_for(ast), to: Block, as: :do_block_for
defdelegate else_block?(ast), to: Block, as: :else_block?
defdelegate else_block_for!(ast), to: Block, as: :else_block_for!
defdelegate else_block_for(ast), to: Block, as: :else_block_for
defdelegate all_blocks_for!(ast), to: Block, as: :all_blocks_for!
defdelegate calls_in_do_block(ast), to: Block, as: :calls_in_do_block
defdelegate function_count(ast), to: Module
defdelegate def_name(ast), to: Module
defdelegate parameter_names(ast), to: Parameters, as: :names
defdelegate parameter_count(ast), to: Parameters, as: :count
@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 scope_for(source_file, [line: line_no]) do
source_file
|> scope_list
|> Enum.at(line_no-1)
end
@doc """
Returns all scopes for the given source_file per line of source code as 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, "Foo.Bar.baz"},
{:def, "Foo.Bar.baz"},
{:def, "Foo.Bar.baz"},
{:defmodule, "Foo.Bar"}
]
"""
def scope_list(%SourceFile{filename: filename, ast: ast, lines: lines}) do
case SourceFileScopes.get(filename) do
{:ok, value} ->
value
:notfound ->
result =
lines
|> Enum.map(fn({line_no, _}) ->
Scope.name(ast, line: line_no)
end)
SourceFileScopes.put(filename, result)
result
end
end
@doc """
Returns true if the given `child` AST node is part of the larger
`parent` AST node.
"""
def contains_child?(parent, child) do
Credo.Code.traverse(parent, &find_child(&1, &2, child), false)
end
defp find_child(parent, acc, child), do: {parent, acc || parent == child}
def clean_strings_sigils_and_comments(%SourceFile{filename: filename, source: source}) do
case SourceFileCodeOnly.get(filename) do
{:ok, value} ->
value
:notfound ->
result = clean_strings_sigils_and_comments(source)
SourceFileCodeOnly.put(filename, result)
result
end
end
def clean_strings_sigils_and_comments(source) do
source
|> Sigils.replace_with_spaces("")
|> Strings.replace_with_spaces
|> String.replace(~r/([^\?])#.+/, "\\1")
end
def clean_strings_and_sigils(%SourceFile{filename: filename, source: source}) do
case SourceFileWithoutStringAndSigils.get(filename) do
{:ok, value} ->
value
:notfound ->
result = clean_strings_and_sigils(source)
SourceFileWithoutStringAndSigils.put(filename, result)
result
end
end
def clean_strings_and_sigils(source) do
source
|> Sigils.replace_with_spaces
|> Strings.replace_with_spaces
end
end