Packages
credo
1.6.0
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/refactor/variable_rebinding.ex
defmodule Credo.Check.Refactor.VariableRebinding do
use Credo.Check,
tags: [:controversial],
param_defaults: [allow_bang: false],
explanations: [
check: """
You might want to refrain from rebinding variables.
Although technically fine, rebinding to the same name can lead to less
precise naming.
Consider this example:
def find_a_good_time do
time = MyApp.DateTime.now
time = MyApp.DateTime.later(time, 5, :days)
{:ok, time} = verify_available_time(time)
time
end
While there is nothing wrong with this, many would consider the following
implementation to be easier to comprehend:
def find_a_good_time do
today = DateTime.now
proposed_time = DateTime.later(today, 5, :days)
{:ok, verified_time} = verify_available_time(proposed_time)
verified_time
end
In some rare cases you might really want to rebind a variable. This can be
enabled "opt-in" on a per-variable basis by setting the :allow_bang option
to true and adding a bang suffix sigil to your variable.
def uses_mutating_parameters(params!) do
params! = do_a_thing(params!)
params! = do_another_thing(params!)
params! = do_yet_another_thing(params!)
end
""",
params: [
allow_bang: "Variables with a bang suffix will be ignored."
]
]
@doc false
@impl true
def run(%SourceFile{} = source_file, params) do
issue_meta = IssueMeta.for(source_file, params)
Credo.Code.prewalk(source_file, &traverse(&1, &2, issue_meta))
end
defp traverse([do: {:__block__, _, ast}], issues, {_, _, opt} = issue_meta) do
variables =
ast
|> Enum.map(&find_assignments/1)
|> List.flatten()
|> Enum.filter(&only_variables(&1))
|> Enum.reject(&bang_sigil(&1, opt[:allow_bang]))
duplicates =
variables
|> Enum.filter(fn {key, _} ->
Enum.count(variables, fn {other, _} -> key == other end) >= 2
end)
|> Enum.reverse()
|> Enum.uniq_by(&get_variable_name/1)
new_issues =
Enum.map(duplicates, fn {variable_name, line} ->
issue_for(issue_meta, Atom.to_string(variable_name), line)
end)
if length(new_issues) > 0 do
{ast, issues ++ new_issues}
else
{ast, issues}
end
end
defp traverse(ast, issues, _issue_meta) do
{ast, issues}
end
defp find_assignments({:=, _, [lhs, _rhs]}) do
find_variables(lhs)
end
defp find_assignments(_), do: nil
defp find_variables({:=, _, args}) do
Enum.map(args, &find_variables/1)
end
# ignore pinned variables
defp find_variables({:"::", _, [{:^, _, _} | _]}) do
[]
end
defp find_variables({:"::", _, [lhs | _rhs]}) do
find_variables(lhs)
end
# ignore pinned variables
defp find_variables({:^, _, _}) do
[]
end
defp find_variables({variable_name, meta, nil}) when is_list(meta) do
{variable_name, meta[:line]}
end
defp find_variables(tuple) when is_tuple(tuple) do
tuple
|> Tuple.to_list()
|> find_variables
end
defp find_variables(list) when is_list(list) do
list
|> Enum.map(&find_variables/1)
|> List.flatten()
|> Enum.uniq_by(&get_variable_name/1)
end
defp find_variables(map) when is_map(map) do
map
|> Enum.into([])
|> Enum.map(fn {_, value} -> find_variables(value) end)
|> List.flatten()
|> Enum.uniq_by(&get_variable_name/1)
end
defp find_variables(_), do: nil
defp issue_for(issue_meta, trigger, line) do
format_issue(
issue_meta,
message: "Variable \"#{trigger}\" was declared more than once.",
trigger: trigger,
line_no: line
)
end
defp get_variable_name({name, _line}), do: name
defp get_variable_name(nil), do: nil
defp only_variables(nil), do: false
defp only_variables({name, _}) do
name
|> Atom.to_string()
|> String.starts_with?("_")
|> Kernel.not()
end
defp bang_sigil({name, _}, allowed) do
allowed &&
name
|> Atom.to_string()
|> String.ends_with?("!")
end
end