New `elvis_style` rule: `no_init_lists` #367

bormilan · 2024-10-07T15:43:02Z

Description

A brief description of your changes.

Closes #329;.

I have read and understood the contributing guidelines

EDIT: I made a checklist based on @elbrujohalcon 's comment to to make the progress traceable.

has init([|]) -> …: Should fail.
has init(A = [1,2,3]) -> …: Should fail
has init/1 implemented with multiple clauses, all of them expecting a list: Should fail.
has init/1 implemented with multiple clauses, one of them not being a list: Should pass, even if other clauses expect a list.
has init/1 implemented using a map, but init/2 implemented using a list in one of the arguments: Should pass.
has init/0 implemented using a tuple, but also init/0: Should pass.
A module that doesn't implement a behaviour and has init([1,2,3]) -> …: Should pass.

bormilan · 2024-10-07T16:04:49Z

Do we want to check that the module implements a gen_* behavior, or should we check every module like now?
Oh, and I want to check if this rule can work on .beam files.

elbrujohalcon

This needs more tests, specifically:

A module that implements gen_server or gen_statem and…
- has init([_|_]) -> …: Should fail.
- has init(A = [1,2,3]) -> …: Should fail
- has init/1 implemented with multiple clauses, all of them expecting a list: Should fail.
- has init/1 implemented with multiple clauses, one of them not being a list: Should pass, even if other clauses expect a list.
- has init/1 implemented using a map, but init/2 implemented using a list in one of the arguments: Should pass.
- has init/0 implemented using a tuple, but also init/0: Should pass.
A module that doesn't implement a behaviour and has init([1,2,3]) -> …: Should pass.

RULES.md

elbrujohalcon · 2024-10-07T16:06:09Z

doc_rules/elvis_style/no_init_lists.md

+This warns you if you use list as a parameter in an init function in a gen_* module.
+[Reasoning](https://erlangforums.com/t/args-in-gen-init-1/3169/4?u=elbrujohalcon)


Suggested change

This warns you if you use list as a parameter in an init function in a gen_* module.

[Reasoning](https://erlangforums.com/t/args-in-gen-init-1/3169/4?u=elbrujohalcon)

Do not use a list as the parameter for the `init/1` callback when implementing `gen_*` behaviours. It's semantically clearer to use a tuple or a map. [More info](https://erlangforums.com/t/args-in-gen-init-1/3169/4?u=elbrujohalcon).

I think it's safe to remove ?u=elbrujohalcon from the link.

You are right I removed and changed the last id from 4 to 5 to point the link to the right comment.

doc_rules/elvis_style/no_init_lists.md

src/elvis_style.erl

elbrujohalcon · 2024-10-07T16:11:12Z

test/examples/fail_verify_no_init_lists.erl

+start_link(AParam) ->
+  gen_server:start_link(?MODULE, [AParam], []).
+
+init([_AParam]) ->


This file should actually work… It should not fail since it's not implementing any behaviour.
If the file is not implementing a behaviour that requires an init/1 callback, we don't care how init/1 is implemented.

Agreed, to start we should just go with a few hard-coded Erlang behaviours; then we can extend as time goes by (they don't come by that often, in any case).

paulo-ferraz-oliveira · 2024-10-08T20:51:12Z

test/examples/pass_verify_no_init_lists.erl

Same comment as Brujo's before; this file is irrelevant for the rule since it's not implementing a behaviour (not explicitly, at least).

paulo-ferraz-oliveira

You're on the right path here ❤️ Just a few more tweaks...

paulo-ferraz-oliveira · 2024-10-08T20:53:12Z

I tweaked the PR title since this'll go directly into the generated release Changelog.

bormilan · 2024-10-10T12:25:02Z

Thanks for the comments, I will solve all of them if I have some time. ❤️

Co-authored-by: Brujo Benavides <[email protected]>

…into no-init-lists

elbrujohalcon

Still missing some changes, but I just wanted to add feedback about the recent additions.

elbrujohalcon · 2024-10-10T13:36:45Z

src/elvis_style.erl

+no_init_lists(_Config, Target, _RuleConfig) ->
+    Root = get_root(#{}, Target, #{}),


Suggested change

no_init_lists(_Config, Target, _RuleConfig) ->

Root = get_root(#{}, Target, #{}),

no_init_lists(Config, Target, RuleConfig) ->

Root = get_root(Config, Target, RuleConfig),

Did you need to use empty maps there for a reason, @bormilan ?

Yes, you are right again, I just left it in...

elbrujohalcon · 2024-10-10T13:38:18Z

src/elvis_style.erl

+
+    FunListAttributeInfos = lists:map(PairFun, FunctionNodes),
+
+    FilterFun = fun({Name, _, C}) -> length(C) > 0 andalso Name =:= init end,


I'm not sure but… if C is the list of arguments… the it has to be exactly 1.

Suggested change

FilterFun = fun({Name, _, C}) -> length(C) > 0 andalso Name =:= init end,

FilterFun = fun({Name, _, Args}) -> length(Args) =:= 1 andalso Name =:= init end,

Yes, you are right it's a dumb fault.

bormilan and others added 9 commits October 6, 2024 19:06

add new rule: no_init_lists

61a901d

add to RULES.md

6e914c0

fix rule settings, and message

e471724

delete print

f8dec95

Merge branch 'main' into no-init-lists

ec36ca9

fix formatting

6164e12

fix deleted section

2d64012

fix rule markdown

fffeed6

fix rule markdown2

b517a00

elbrujohalcon requested changes Oct 7, 2024

View reviewed changes

paulo-ferraz-oliveira reviewed Oct 8, 2024

View reviewed changes

paulo-ferraz-oliveira changed the title ~~No init lists~~ New elvis_style rule: no_init_lists Oct 8, 2024

bormilan and others added 6 commits October 10, 2024 14:44

Update RULES.md

7972ccb

Co-authored-by: Brujo Benavides <[email protected]>

Update doc_rules/elvis_style/no_init_lists.md

6348711

Co-authored-by: Brujo Benavides <[email protected]>

Update src/elvis_style.erl

68c8945

Co-authored-by: Brujo Benavides <[email protected]>

fix description and link of no_init_lists rule

70874c3

Merge branch 'no-init-lists' of https://github.com/bormilan/elvis_core …

0db27a1

…into no-init-lists

fix markdown

299ed09

elbrujohalcon requested changes Oct 10, 2024

View reviewed changes

little fixes and change logic

0653f03

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

New `elvis_style` rule: `no_init_lists` #367

New `elvis_style` rule: `no_init_lists` #367

bormilan commented Oct 7, 2024 •

edited

Loading

bormilan commented Oct 7, 2024 •

edited

Loading

elbrujohalcon left a comment

elbrujohalcon Oct 7, 2024

paulo-ferraz-oliveira Oct 8, 2024

bormilan Oct 10, 2024

elbrujohalcon Oct 7, 2024

paulo-ferraz-oliveira Oct 8, 2024

paulo-ferraz-oliveira Oct 8, 2024

paulo-ferraz-oliveira left a comment

paulo-ferraz-oliveira commented Oct 8, 2024

bormilan commented Oct 10, 2024 •

edited

Loading

elbrujohalcon left a comment

elbrujohalcon Oct 10, 2024

bormilan Oct 10, 2024

elbrujohalcon Oct 10, 2024

bormilan Oct 10, 2024

		This warns you if you use list as a parameter in an init function in a gen_* module.
		[Reasoning](https://erlangforums.com/t/args-in-gen-init-1/3169/4?u=elbrujohalcon)

	This warns you if you use list as a parameter in an init function in a gen_* module.
	[Reasoning](https://erlangforums.com/t/args-in-gen-init-1/3169/4?u=elbrujohalcon)
	Do not use a list as the parameter for the `init/1` callback when implementing `gen_*` behaviours. It's semantically clearer to use a tuple or a map. [More info](https://erlangforums.com/t/args-in-gen-init-1/3169/4?u=elbrujohalcon).

		no_init_lists(_Config, Target, _RuleConfig) ->
		Root = get_root(#{}, Target, #{}),


		FunListAttributeInfos = lists:map(PairFun, FunctionNodes),

		FilterFun = fun({Name, _, C}) -> length(C) > 0 andalso Name =:= init end,

	FilterFun = fun({Name, _, C}) -> length(C) > 0 andalso Name =:= init end,
	FilterFun = fun({Name, _, Args}) -> length(Args) =:= 1 andalso Name =:= init end,

New elvis_style rule: no_init_lists #367

Are you sure you want to change the base?

New elvis_style rule: no_init_lists #367

Conversation

bormilan commented Oct 7, 2024 • edited Loading

Description

bormilan commented Oct 7, 2024 • edited Loading

elbrujohalcon left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

paulo-ferraz-oliveira left a comment

Choose a reason for hiding this comment

paulo-ferraz-oliveira commented Oct 8, 2024

bormilan commented Oct 10, 2024 • edited Loading

elbrujohalcon left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

New `elvis_style` rule: `no_init_lists` #367

New `elvis_style` rule: `no_init_lists` #367

bormilan commented Oct 7, 2024 •

edited

Loading

bormilan commented Oct 7, 2024 •

edited

Loading

bormilan commented Oct 10, 2024 •

edited

Loading