Add Getters & Setters metric

[padjal]

No description provided.

[padjal]

@yegor256 Can you approve the workflows?

[yegor256]

@padjal try make test locally

[padjal]

@yegor256 Good points, I have revised them and refactored the code.

[padjal]

@yegor256 The only failing test locally is the jpeek, but I have not touched it

[yegor256]

@padjal try to install Maven locally and run again. Maven is required.

[padjal]

@yegor256 Please see latest changes.

[padjal]

@yegor256 I have fixed all linting errors. However, a failing test blocks the workflow:

Locally, this test completes successfully:

Could you have a look?

[yegor256]

@padjal try to push something new into the branch, the tests should pass

[padjal]

@yegor256 Added something new as advised.

[padjal]

@yegor256 Could you please have a look?

[yegor256]

@padjal now the problem is clearly related to your branch

[padjal]

@yegor256 All I see is this

Is this related to the new metric?

[yegor256]

@padjal yes, I think so, because of the name getset.py (it belongs to your branch, I believe)

[padjal]

@yegor256 I cannot understand how the report creates such a file for the ast.py metric, but doesn't succeed to do it for the getset one. I have no idea how to debug awk '{ s= "\\item\\ff{" $1 "}: "; for (i = 3; i <= NF; i++) s = s $i " "; print s; }' < "${metric}" >> "${list}" in a meaningful way.

[padjal]

@yegor256 Do you have any tips here?

[padjal]

@yegor256 I have fixed the output. Please review.

[padjal]

@yegor256 Do you think that I should add anything else?

[yegor256]

@padjal as far as I understand, the idea was to count getters and setters in a class. Now, the description of the metric looks different. I don't understand what is "maximum complexity of getter"? Can you explain it better?

[padjal]

@yegor256 I can change the main objective of the metric to be a counter of the getters and setters in a class. Do you think that this metric will yield any useful information?

As per hour research paper, the original idea of the Getters and setters metric was something like this:
Getters and setters are a well-known design pattern, especially in Java. A getter is supposed to be a method that returns the value of an encapsulated attribute, while a setter is supposed to set the value of it. However, some programmers misunderstand how getters and setters are intended to be designed; they include a lot more evaluations inside them. In order to find out how often getters and setters are not designed as expected, we analyzed 100K+ Java classes from 100+ public GitHub repositories, and then summarized the results obtained.

Research question - How often are getters and setters not designed as expected?

Now that I review this approach however, it might turn out that this is not a trivial task. Maybe your suggestion to just count the number of getter & setter methods in a class is better. Please tell me what you think and how I should proceed in this case.

[padjal]

@yegor256 What do you think?

[padjal]

@yegor256 I have changed the metric according to your suggestions. Please review.

[padjal]

@yegor256 Can you review this, please?

[yegor256]

@padjal thanks!