Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Feature more no_common_caveats_call default options #364

Merged
merged 2 commits into from
Sep 23, 2024
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 2 additions & 0 deletions MIGRATION.md
Original file line number Diff line number Diff line change
Expand Up @@ -26,6 +26,8 @@ This file's format is influenced by [Keep a Changelog](https://keepachangelog.co
<https://github.com/inaka/elvis_core/blob/3.2.5/doc_rules/elvis_style/module_naming_convention.md#options>
- your `no_debug_call` options to be the ones defined at
<https://github.com/inaka/elvis_core/blob/3.2.5/doc_rules/elvis_style/no_debug_call.md#options>
- your `no_common_caveats_call` options to be the ones defined at
<https://github.com/inaka/elvis_core/blob/3.2.5/doc_rules/elvis_style/no_common_caveats_call.md#options>

On the other hand you may choose to not implement those changes and merely adapt your code.

Expand Down
2 changes: 1 addition & 1 deletion doc_rules/elvis_style/no_call.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@
(since [0.4.0](https://github.com/inaka/elvis_core/releases/tag/0.4.0))

This rule raise a warning when certain functions are called. It is also used internally to implement
`no_debug_call` and `no_common_caveats` but, on its own, makes no checks on your code (the default
`no_debug_call` and `no_common_caveats_call` but, on its own, makes no checks on your code (the default
`no_call_functions` list is empty). However, it is a convenient place to add your own list of calls
to avoid (especially calls to third party libraries, where you can't just deprecate undesired
functions).
Expand Down
6 changes: 5 additions & 1 deletion doc_rules/elvis_style/no_common_caveats_call.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,8 @@
The [Erlang Efficiency Guide](https://erlang.org/doc/efficiency_guide/commoncaveats.html) has a list
of "Common Caveats" suggesting more efficient alternatives to several common functions. This rule
provides warnings if you call "inefficient" functions with entirely equivalent (efficient)
alternatives.
alternatives. It also warns you about functions with a more explicit interface (e.g. `gen_server:call/3`
instead of `gen_server:call/2`) so you're sure to not have forgotten it.
elbrujohalcon marked this conversation as resolved.
Show resolved Hide resolved

> Works on `.beam` file? Yes!

Expand All @@ -17,6 +18,9 @@ alternatives.
, {timer, send_interval, 2}
, {timer, send_interval, 3}
, {erlang, size, 1}
, {gen_statem, call, 2}
, {gen_server, call, 2}
, {gen_event, call, 3}
]`.

**Notice**: this rule is not enforced by default. Check the
Expand Down
11 changes: 10 additions & 1 deletion test/examples/fail_no_call_classes.erl
Original file line number Diff line number Diff line change
Expand Up @@ -13,4 +13,13 @@ fail() ->
_ = erlang:size(<<"fail_size">>),

_ = erlang:tuple_size({1,2,3}),
_ = erlang:byte_size(<<"ok_size">>).
_ = erlang:byte_size(<<"ok_size">>),

_ = gen_server:call(self(), request),
_ = gen_server:call(self(), request, infinity),

_ = gen_event:call(self(), self(), request),
_ = gen_event:call(self(), self(), request, infinity),

_ = gen_statem:call(self(), request),
_ = gen_statem:call(self(), request, infinity).
5 changes: 4 additions & 1 deletion test/style_SUITE.erl
Original file line number Diff line number Diff line change
Expand Up @@ -1232,7 +1232,10 @@ verify_no_call_flavours(Config,
{{erlang, size, 1}, 2},
{{timer, send_after}, 2},
{{timer, '_', '_'}, 4},
{{'_', tuple_size, 1}, 1}],
{{'_', tuple_size, 1}, 1},
{{gen_statem, call, 2}, 1},
{{gen_server, call, 2}, 1},
{{gen_event, call, 3}, 1}],

lists:foreach(fun({FunSpec, ExpectedCount}) ->
ThisRuleConfig = maps:from_list([{RuleConfigMapKey, [FunSpec]}]),
Expand Down