Ets fun2ms without ms transform (#374)

inaka · Nov 21, 2024 · a7a8267 · a7a8267
1 parent 6e0582c
commit a7a8267
Show file tree

Hide file tree

Showing 10 changed files with 142 additions and 3 deletions.
diff --git a/RULES.md b/RULES.md
@@ -64,6 +64,7 @@ identified with `(since ...)` for convenience purposes.
 - [Variable Naming Convention](doc_rules/elvis_style/variable_naming_convention.md)
 - [No Init Lists](doc_rules/elvis_style/no_init_lists.md)
 - [Prefer Unquoted Atoms](doc_rules/elvis_text_style/prefer_unquoted_atoms.md)
+- [ms_transform included](doc_rules/elvis_style/ms_transform_included.md)
 
 ## `.gitignore` rules
 

diff --git a/doc_rules/elvis_style/ms_transform_included.md b/doc_rules/elvis_style/ms_transform_included.md
@@ -0,0 +1,16 @@
+
+# Include `ms_transform` for `ets:fun2ms/1`
+
+The library `ms_transform` needs to be included if the function`ets:fun2ms` is used in the module.
+
+> Works on `.beam` files? Yes!
+
+## Options
+
+- None.
+
+## Example
+
+```erlang
+{elvis_style, ms_transform_included, #{}}
+```
diff --git a/src/elvis_rulesets.erl b/src/elvis_rulesets.erl
@@ -96,6 +96,7 @@ rules(erl_files_strict) ->
                              max_function_clause_length,
                              max_function_length,
                              max_module_length,
+                             ms_transform_included,
                              no_call,
                              no_init_lists,
                              no_common_caveats_call,
@@ -113,6 +114,7 @@ rules(beam_files) ->
                invalid_dynamic_call,
                max_anonymous_function_arity,
                max_function_arity,
+               ms_transform_included,
                module_naming_convention,
                nesting_level,
                no_author,

diff --git a/src/elvis_style.erl b/src/elvis_style.erl
@@ -13,7 +13,7 @@
          no_catch_expressions/3, no_single_clause_case/3, numeric_format/3, behaviour_spelling/3,
          always_shortcircuit/3, consistent_generic_type/3, export_used_types/3,
          no_match_in_condition/3, param_pattern_matching/3, private_data_types/3, option/3,
-         no_init_lists/3]).
+         no_init_lists/3, ms_transform_included/3]).
 
 -export_type([empty_rule_config/0]).
 -export_type([ignorable/0]).
@@ -33,6 +33,9 @@
 
 -define(NO_INIT_LISTS_MSG,
         "Do not use a list as the parameter for the 'init' callback at position ~p.").
+-define(MS_TRANSFORM_INCLUDED_MSG,
+        "Missing inclide library: stdlib/include/ms_transform.hrl when ets:fun2ms/1
+        is used at position ~p.").
 -define(INVALID_MACRO_NAME_REGEX_MSG,
         "The macro named ~p on line ~p does not respect the format "
         "defined by the regular expression '~p'.").
@@ -260,7 +263,8 @@ default(RuleWithEmptyDefault)
          RuleWithEmptyDefault == always_shortcircuit;
          RuleWithEmptyDefault == no_space_after_pound;
          RuleWithEmptyDefault == export_used_types;
-         RuleWithEmptyDefault == consistent_variable_casing ->
+         RuleWithEmptyDefault == consistent_variable_casing;
+         RuleWithEmptyDefault == ms_transform_included ->
     #{}.
 
 %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
@@ -1192,6 +1196,58 @@ is_list_node(#{type := match, content := Content}) ->
 is_list_node(_) ->
     false.
 
+-spec ms_transform_included(elvis_config:config(),
+                            elvis_file:file(),
+                            empty_rule_config()) ->
+                               [elvis_result:item()].
+ms_transform_included(Config, Target, RuleConfig) ->
+    Root = get_root(Config, Target, RuleConfig),
+
+    FunctionCalls = get_fun_2_ms_calls(Root),
+
+    IsIncluded = FunctionCalls /= [] andalso has_include_ms_transform(Root),
+
+    ResultFun =
+        fun(Location) ->
+           Info = [Location],
+           Msg = ?MS_TRANSFORM_INCLUDED_MSG,
+           elvis_result:new(item, Msg, Info, Location)
+        end,
+
+    case IsIncluded of
+        true ->
+            [];
+        false ->
+            lists:map(ResultFun, FunctionCalls)
+    end.
+
+-spec get_fun_2_ms_calls(ktn_code:tree_node()) -> [any()].
+get_fun_2_ms_calls(Root) ->
+    IsFun2MsFunctionCall =
+        fun(Node) -> ktn_code:type(Node) == call andalso is_ets_fun2ms(Node) end,
+
+    Functions = elvis_code:find(IsFun2MsFunctionCall, Root),
+    ProcessResult = fun(Node) -> ktn_code:attr(location, Node) end,
+
+    lists:map(ProcessResult, Functions).
+
+-spec is_ets_fun2ms(ktn_code:tree_node()) -> boolean().
+is_ets_fun2ms(Node) ->
+    Fun = ktn_code:node_attr(function, Node),
+    Fun2 = ktn_code:node_attr(function, Fun),
+    Module = ktn_code:node_attr(module, Fun),
+
+    ets == ktn_code:attr(value, Module) andalso fun2ms == ktn_code:attr(value, Fun2).
+
+-spec has_include_ms_transform(ktn_code:tree_node()) -> boolean().
+has_include_ms_transform(Root) ->
+    Fun = fun(Node) ->
+             ktn_code:type(Node) == include_lib
+             andalso ktn_code:attr(value, Node) == "stdlib/include/ms_transform.hrl"
+          end,
+
+    [] /= elvis_code:find(Fun, Root).
+
 -spec no_throw(elvis_config:config(), elvis_file:file(), empty_rule_config()) ->
                   [elvis_result:item()].
 no_throw(Config, Target, RuleConfig) ->

diff --git a/test/examples/custom_ms_transform_included.erl b/test/examples/custom_ms_transform_included.erl
@@ -0,0 +1,5 @@
+-module(custom_ms_transform_included).
+
+-export([test/0]).
+
+test() -> {this, is, "not", ets, my:fun2ms("It's my own")}.
diff --git a/test/examples/double_include_ms_transform.erl b/test/examples/double_include_ms_transform.erl
@@ -0,0 +1,8 @@
+-module(double_include_ms_transform).
+
+-include_lib("stdlib/include/ms_transform.hrl").
+-include_lib("stdlib/include/ms_transform.hrl").
+
+-export([test/0]).
+
+test() -> ets:fun2ms(fun(_) -> ok end).
diff --git a/test/examples/fail_ms_transform_included.erl b/test/examples/fail_ms_transform_included.erl
@@ -0,0 +1,5 @@
+-module(fail_ms_transform_included).
+
+-export([test/0]).
+
+test() -> ets:fun2ms(fun(_) -> ok end).
diff --git a/test/examples/included_but_not_used_ms_transform.erl b/test/examples/included_but_not_used_ms_transform.erl
@@ -0,0 +1,7 @@
+-module(included_but_not_used_ms_transform).
+
+-include_lib("stdlib/include/ms_transform.hrl").
+
+-export([test/0]).
+
+test() -> ok.
diff --git a/test/examples/pass_ms_transform_included.erl b/test/examples/pass_ms_transform_included.erl
@@ -0,0 +1,7 @@
+-module(pass_ms_transform_included).
+
+-include_lib("stdlib/include/ms_transform.hrl").
+
+-export([test/0]).
+
+test() -> ets:fun2ms(fun(_) -> ok end).
diff --git a/test/style_SUITE.erl b/test/style_SUITE.erl
@@ -26,7 +26,8 @@
          verify_consistent_generic_type/1, verify_no_types/1, verify_no_specs/1,
          verify_export_used_types/1, verify_consistent_variable_casing/1,
          verify_no_match_in_condition/1, verify_param_pattern_matching/1,
-         verify_private_data_types/1, verify_unquoted_atoms/1, verify_no_init_lists/1]).
+         verify_private_data_types/1, verify_unquoted_atoms/1, verify_no_init_lists/1,
+         verify_ms_transform_included/1]).
 %% -elvis attribute
 -export([verify_elvis_attr_atom_naming_convention/1, verify_elvis_attr_numeric_format/1,
          verify_elvis_attr_dont_repeat_yourself/1, verify_elvis_attr_function_naming_convention/1,
@@ -1397,6 +1398,37 @@ verify_unquoted_atoms(Config) ->
     [_, _] =
         elvis_core_apply_rule(Config, elvis_text_style, prefer_unquoted_atoms, #{}, FailPath).
 
+-spec verify_ms_transform_included(config()) -> any().
+verify_ms_transform_included(Config) ->
+    Ext = proplists:get_value(test_file_ext, Config, "erl"),
+
+    PassPath = "pass_ms_transform_included." ++ Ext,
+    [] = elvis_core_apply_rule(Config, elvis_style, ms_transform_included, #{}, PassPath),
+
+    CustomFunctionPath = "custom_ms_transform_included." ++ Ext,
+    [] =
+        elvis_core_apply_rule(Config,
+                              elvis_style,
+                              ms_transform_included,
+                              #{},
+                              CustomFunctionPath),
+
+    IncludedButNotUsed = "included_but_not_used_ms_transform." ++ Ext,
+    [] =
+        elvis_core_apply_rule(Config,
+                              elvis_style,
+                              ms_transform_included,
+                              #{},
+                              IncludedButNotUsed),
+
+    DoubleInclude = "double_include_ms_transform." ++ Ext,
+    [] =
+        elvis_core_apply_rule(Config, elvis_style, ms_transform_included, #{}, DoubleInclude),
+
+    FailPath = "fail_ms_transform_included." ++ Ext,
+    [_] = elvis_core_apply_rule(Config, elvis_style, ms_transform_included, #{}, FailPath),
+    ok.
+
 -spec verify_atom_naming_convention(config()) -> any().
 verify_atom_naming_convention(Config) ->
     Group = proplists:get_value(group, Config, erl_files),