Packages
credo
0.4.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/consistency/exception_names.ex
defmodule Credo.Check.Consistency.ExceptionNames do
@moduledoc """
Exception names should end with a common suffix like "Error".
Try to name your exception modules consistently:
defmodule BadCodeError do
defexception [:message]
end
defmodule ParserError do
defexception [:message]
end
Inconsistent use should be avoided:
defmodule BadHTTPResponse do
defexception [:message]
end
defmodule HTTPHeaderException do
defexception [:message]
end
While this is not necessarily a concern for the correctness of your code,
you should use a consistent style throughout your codebase.
"""
@explanation [check: @moduledoc]
@code_patterns [
Credo.Check.Consistency.ExceptionNames.PrefixAndSuffixCollector
]
alias Credo.Check.Consistency.Helper
alias Credo.Code.Module
alias Credo.Code.Name
use Credo.Check, run_on_all: true, base_priority: :high
def run(source_files, params \\ []) when is_list(source_files) do
{property_tuples, most_picked} =
source_files
|> Helper.run_code_patterns(@code_patterns, params)
count =
property_tuples
|> Enum.reduce(0, fn({prop_list, _}, acc) ->
acc + Enum.count(prop_list)
end)
if count > 2 do # we found more than one prefix and one suffix
{property_tuples, most_picked}
|> Helper.append_issues_via_issue_service(&check_for_issues/5, params)
end
:ok
end
defp check_for_issues(_issue_meta, _actual_prop, nil, _picked_count, _total_count), do: nil
defp check_for_issues(_issue_meta, [], _expected_prop, _picked_count, _total_count), do: nil
defp check_for_issues(issue_meta, _actual_prop, expected_prop, _picked_count, _total_count) do
source_file = IssueMeta.source_file(issue_meta)
case expected_prop do
{prefix, :prefix} ->
source_file
|> find_exception_modules_without_prefix(prefix)
|> issues_for_wrong(:prefix, issue_meta, prefix)
{suffix, :suffix} ->
source_file
|> find_exception_modules_without_suffix(suffix)
|> issues_for_wrong(:suffix, issue_meta, suffix)
_ -> nil
end
end
defp find_exception_modules_without_suffix(%SourceFile{ast: ast}, suffix) do
ast
|> Credo.Code.prewalk(&find_exception_modules(&1, &2))
|> Enum.reject(&name_with_suffix?(&1, suffix))
end
defp find_exception_modules_without_prefix(%SourceFile{ast: ast}, prefix) do
ast
|> Credo.Code.prewalk(&find_exception_modules(&1, &2))
|> Enum.reject(&name_with_prefix?(&1, prefix))
end
defp find_exception_modules({:defmodule, _meta, [{:__aliases__, _, _name_arr}, _arguments]} = ast, exception_names) do
if Module.exception?(ast) do
{ast, exception_names ++ [ast]}
else
{ast, exception_names}
end
end
defp find_exception_modules(ast, exception_names) do
{ast, exception_names}
end
defp name_with_suffix?(module_ast, suffix) do
module_ast |> Module.name |> Name.split_pascal_case |> List.last == suffix
end
defp name_with_prefix?(module_ast, prefix) do
module_ast |> Module.name |> Name.split_pascal_case |> List.first == prefix
end
defp issues_for_wrong(exception_list, prefix_or_suffix, issue_meta, suffix) do
exception_list
|> Enum.map(&issue_for_wrong(&1, prefix_or_suffix, issue_meta, suffix))
|> Enum.reject(&is_nil/1)
end
defp issue_for_wrong({:defmodule, meta, _} = ast, prefix_or_suffix, issue_meta, expected) do
trigger = Module.name(ast)
format_issue issue_meta,
message: message_for(prefix_or_suffix, expected, trigger),
line_no: meta[:line],
trigger: trigger
end
def message_for(:prefix, expected, trigger) do
"""
Exception modules should be named consistently.
It seems your strategy is to prefix them with `#{expected}`,
but `#{trigger}` does not follow that convention."
""" |> to_one_line
end
def message_for(:suffix, expected, trigger) do
"""
Exception modules should be named consistently.
It seems your strategy is to have `#{expected}` as a suffix,
but `#{trigger}` does not follow that convention.
""" |> to_one_line
end
def to_one_line(str), do: str |> String.split |> Enum.join(" ")
end