Wrong typespec for `ktn_code:type/1`

[paulo-ferraz-oliveira]

Per elvis_core, the definition of https://github.com/inaka/katana-code/blob/main/src/ktn_code.erl#L187 is wrong, since in the case of a macro we can also get ktn_code:type(MaybeMacro) -> {atom, [_, _], define}.

We should at least code for that specific fix.

[elbrujohalcon]

Damn macros!

[paulo-ferraz-oliveira]

You know it 😄

[elbrujohalcon]

@paulo-ferraz-oliveira do you have an example of a macro with that type?
I tried with…

-module x.

-define MACRO, macro.
-define MACRO(X), {macro, X}.

x() -> ?MACRO.
y() -> ?MACRO(y).

And…

f(), {ok, F} = file:read_file("/tmp/x.erl"), ktn_code:parse_tree(F).
#{type => root,
  attrs =>
      #{tokens =>
            [#{type => '-',attrs => #{location => {1,1},text => "-"}},
             #{type => atom,value => module,
               attrs => #{location => {1,2},text => "module"}},
             #{type => atom,value => x,
               attrs => #{location => {1,9},text => "x"}},
             #{type => dot,attrs => #{location => {1,10},text => ".\n"}},
             #{type => '-',attrs => #{location => {3,1},text => "-"}},
             #{type => atom,value => define,
               attrs => #{location => {3,2},text => "define"}},
             #{type => var,value => 'MACRO',
               attrs => #{location => {3,9},text => "MACRO"}},
             #{type => ',',attrs => #{location => {3,14},text => ","}},
             #{type => atom,value => macro,
               attrs => #{location => {3,16},text => "macro"}},
             #{type => dot,attrs => #{location => {3,21},text => ".\n"}},
             #{type => '-',attrs => #{location => {4,1},text => "-"}},
             #{type => atom,value => define,
               attrs => #{location => {4,2},text => "define"}},
             #{type => var,value => 'MACRO',
               attrs => #{location => {4,9},text => "MACRO"}},
             #{type => '(',attrs => #{location => {4,14},text => "("}},
             #{type => var,value => 'X',
               attrs => #{location => {4,15},text => "X"}},
             #{type => ')',attrs => #{location => {4,16},text => ")"}},
             #{type => ',',attrs => #{location => {4,17},text => ","}},
             #{type => '{',attrs => #{location => {4,19},text => "{"}},
             #{type => atom,value => macro,
               attrs => #{location => {4,20},text => "macro"}},
             #{type => ',',attrs => #{location => {4,25},text => ","}},
             #{type => var,value => 'X',
               attrs => #{location => {4,27},text => "X"}},
             #{type => '}',attrs => #{location => {4,28},text => "}"}},
             #{type => dot,attrs => #{location => {4,29},text => ".\n"}},
             #{type => atom,value => x,
               attrs => #{location => {6,...},text => "x"}},
             #{type => '(',attrs => #{location => {...},...}},
             #{type => ')',...},
             #{...}|...]},
  content =>
      [#{type => module,
         attrs => #{value => x,location => {1,2},text => "module"}},
       #{type => function,
         attrs =>
             #{arity => 0,name => x,location => {6,1},text => "x"},
         content =>
             [#{type => clause,
                attrs => #{location => {6,1},text => "x"},
                content =>
                    [#{type => macro,
                       attrs =>
                           #{name => "MACRO",location => {6,8},text => "?MACRO"},
                       content => []}],
                node_attrs => #{pattern => [],guards => []}}]},
       #{type => function,
         attrs =>
             #{arity => 0,name => y,location => {7,1},text => "y"},
         content =>
             [#{type => clause,
                attrs => #{location => {7,1},text => "y"},
                content =>
                    [#{type => macro,
                       attrs =>
                           #{name => "MACRO",location => {7,8},text => "?MACRO"},
                       content =>
                           [#{type => atom,
                              attrs => #{value => y,location => {7,15},text => "y"}}]}],
                node_attrs => #{pattern => [],guards => []}}]}]}
4>

I see all types as atom here.

[paulo-ferraz-oliveira]

Remove the -dialyzer from elvis_core and it should surface right up.

[paulo-ferraz-oliveira]

From this:

        case ktn_code:type(Node) of
            {atom, [_, _], define} ->
                true;
            _ ->
                false
        end

[elbrujohalcon]

Cool. I'll check what test covers that code and go from there.

[elbrujohalcon]

🤦‍♂

TIL: You can't skip the parentheses on -define.

Check this out…

-module x.

-define X, x.
-define Y, y().

10> c("/tmp/x.erl").
/tmp/x.erl:3:9: badly formed 'define'
%    3| -define X, x.
%     |         ^

/tmp/x.erl:4:9: badly formed 'define'
%    4| -define Y, y().
%     |         ^

error

That's why they were invisible to ktn_code.

[elbrujohalcon]

Now, with a proper module…

-module x.

-export [x/0].

-define(X, x).

x() -> ?X.

…we get…

f(), {ok, F} = file:read_file("/tmp/x.erl"), maps:get(content, ktn_code:parse_tree(F)).
[#{type => module,
   attrs => #{value => x,location => {1,2},text => "module"}},
 #{type => export,
   attrs =>
       #{value => [{x,0}],location => {3,2},text => "export"}},
 #{type => {atom,[{text,"define"},{location,{5,2}}],define},
   attrs =>
       #{value =>
             [{var,[{text,"X"},{location,{5,9}}],'X'},
              {tree,text,
                    {attr,[{text,"define"},{location,{5,2}}],[],none},
                    "x"}],
         location => {5,2},
         text => "define"}},
 #{type => function,
   content =>
       [#{type => clause,
          content =>
              [#{type => macro,content => [],
                 attrs => #{name => "X",location => {7,8},text => "?X"}}],
          attrs => #{location => {7,1},text => "x"},
          node_attrs => #{pattern => [],guards => []}}],
   attrs =>
       #{arity => 0,name => x,location => {7,1},text => "x"}}]