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/check/consistency/helper.ex
defmodule Credo.Check.Consistency.Helper do
@moduledoc """
This module contains functions that are used by several
consistency checks.
# On properties and property lists
Imagine a test that checks files for whether they use soft-tabs or hard-tabs
for indentation.
property_values in this case might be :spaces and :tabs
{value, meta}
value can be anything imaginable, meta should contain a filename
(optionally with a line_no, trigger, etc.) or an AST
a `property_list` is simply a list of property_values
[
{value, meta},
{value, meta},
...
]
a property_tuple is a tuple of {property_list, source_file}
So in our example a property_tuple
{[{:spaces, meta}, {:tabs, meta2}], %SourceFile{}}
which would indicate that the check on that SourceFile showed that it mixes
different indentation styles within one file.
"""
alias Credo.Check.PropertyValue
alias Credo.IssueMeta
@doc """
`callback` is expected to return a tuple `{property_values, most_picked_prop_value}`.
"""
def most_picked_prop(source_files, callback) when is_list(source_files) and is_function(callback) do
properties =
source_files
|> Enum.map(callback)
|> Enum.sort
{properties, most_picked_prop_value(properties)}
end
@doc """
Returns a tuple `{most_picked_prop, picked_count, total_count}`
"""
def most_picked_prop_value(list) when is_list(list) do
all_property_values =
list
|> Enum.flat_map(fn({property_list, _source_file}) -> PropertyValue.get(property_list) end)
result =
all_property_values
|> Enum.map(fn(prop_val) ->
current_property_value = PropertyValue.get(prop_val)
prop_size =
all_property_values
|> Enum.filter(fn(property_value) ->
PropertyValue.get(property_value) == current_property_value
end)
|> Enum.count
case prop_size do
0 -> nil
_ -> {prop_size, current_property_value}
end
end)
|> Enum.reject(&is_nil/1)
|> Enum.sort
|> List.last
case result do
{prop_count, prop_name} -> {prop_name, prop_count, Enum.count(all_property_values)}
nil -> nil
end
end
@doc """
Runs a given set of `pattern_mods` (CodePattern modules) against a given
set of `source_files`.
Returns a tuple: {property_tuples, most_picked}
"""
def run_code_patterns(source_files, pattern_mods, params) do
source_files
|> most_picked_prop(&create_property_tuples(&1, pattern_mods, params))
end
@doc """
Takes all the `property_tuples` from run_code_patterns and creates issues in
all source_files that do not sport the most_picked property_value.
Does call `new_issue_fun/4` when necessary to create a new issue.
"""
def append_issues_via_issue_service({property_tuples, most_picked}, new_issue_fun, params) do
property_tuples
|> Enum.map(&append_issues_if_necessary(&1, most_picked, new_issue_fun, params))
end
defp append_issues_if_necessary({_prop_list, _source_file}, nil, _, _) do
nil
end
defp append_issues_if_necessary({prop_list, source_file}, most_picked, new_issue_fun, params) do
{expected_prop, picked_count, total_count} = most_picked
case prop_list |> PropertyValue.get |> Enum.uniq do
[^expected_prop] ->
nil
list ->
new_issues =
prop_list
|> Enum.map(fn(prop) ->
value = PropertyValue.get(prop)
if value != expected_prop && Enum.member?(list, value) do
issue_meta = IssueMeta.for(source_file, params)
new_issue_fun.(issue_meta, prop, expected_prop, picked_count, total_count)
end
end)
|> List.flatten
|> Enum.reject(&is_nil/1)
|> Enum.uniq # TODO: should we really "squash" the issues here?
|> Enum.each(fn(issue) ->
Credo.Service.SourceFileIssues.append(source_file, issue)
end)
end
end
defp create_property_tuples(source_file, pattern_mods, params) do
list = property_list_for(source_file, pattern_mods, params)
{list, source_file}
end
defp property_list_for(source_file, pattern_mods, params) do
pattern_mods
|> collect_property_values(source_file, params)
|> Enum.reject(&is_nil/1)
|> Enum.uniq
end
defp collect_property_values(pattern_mods, source_file, params) do
pattern_mods
|> Enum.reduce([], fn(pattern_mod, acc) ->
result = pattern_mod.property_value_for(source_file, params)
acc ++ List.wrap(result)
end)
end
end