Fix EnumNaming textLocation #1977

BraisGabin · 2019-10-04T17:07:19Z

I'm finding some problems with the textLocation thanks to #1975. This is one of them.

I added two tests becase my first try to fix this bug broke that other part.

schalkms · 2019-10-04T19:46:48Z

detekt-rules/src/main/kotlin/io/gitlab/arturbosch/detekt/rules/naming/EnumNaming.kt

@@ -30,7 +30,7 @@ class EnumNaming(config: Config = Config.empty) : Rule(config) {
        if (!enumEntry.identifierName().matches(enumEntryPattern)) {
            report(CodeSmell(
                    issue,
-                    Entity.from(enumEntry),
+                    Entity.from(enumEntry.identifyingElement!!),


I don't understand why the enumEntry should report the wrong text location.
Could you please explain that?

Sure. If I use enumEntry the selected code is _Default, (I'm using te test as an example). But we don't want to select the , for that reason I'm using identifyingElement. But, as I said, I don't know this API and I can't find the documentation so I can't be sure about it.

Honestly, this is weird. However, originalElement did the trick for me.

With enumEntry.originalElement it doesn't pass the test for me (it has the same problem as enumEntry)

Yes, I also tried it out with different properties. None of them worked.
The problem with identifyingElement is that this API is experimental and I don't really want to have this in production code.
Furthermore, this would also potentially break detekt's baseline feature for this rule.
Unfortunately, I have to ask you to revert this line and adapt the test case. However, I'd really like to have the added tests in the productive code, since we are in the process of adding more tests like these.

I know that reporting the enum including the separator , feels weird, but it's not the end of the world.

If the problem is the experimental we could use nameIdentifier. It works too and it's stable. But as I said, without the documentation I don't know the difference between them

Anyway, I checked the baseline problem and you are right. This breaks the previous generated baselines.

Related with the tests: Do you mean to add this test as "Ignored" or something like this? To note that this is wrong but we don't change it for the breaking change? Or adding a test that assume that adding the , is ok?

In the first case I can refactor this PR to do that. If it's the second I think that an issue to talk about how we want the rule test before doing the changes would be great. I'm open to help with that but what should we test? Number of findings? sourcePostion? textPosition?...

If the problem is the experimental we could use nameIdentifier. It works too and it's stable.

I'd go this route.

schalkms · 2019-10-04T19:48:38Z

detekt-rules/src/test/kotlin/io/gitlab/arturbosch/detekt/rules/naming/EnumNamingSpec.kt

+                enum class WorkFlow {
+                    _Default,
+                }"""
+            assertThat(NamingRules().compileAndLint(code)[0].charPosition).isEqualTo(TextLocation(26, 34))


This could be made simpler by using the following code snippet.

val findings = NamingRules().compileAndLint(code) val source = findings.first.location.source source.line source.column

I just find the FindingsAssert class. I'll add a function there and use it.

schalkms · 2019-10-04T19:48:45Z

detekt-rules/src/test/kotlin/io/gitlab/arturbosch/detekt/rules/naming/ParameterNamingSpec.kt

+            val code = """
+                class C(val PARAM: String)
+            """
+            assertThat(NamingRules().lint(code)[0].charPosition).isEqualTo(TextLocation(8, 25))


schalkms · 2019-10-04T20:22:38Z

detekt-test/src/main/kotlin/io/gitlab/arturbosch/detekt/test/FindingsAssertions.kt

@@ -56,6 +57,21 @@ class FindingsAssert(actual: List<Finding>) :
            failWithMessage("Expected source locations to be ${expectedSources.toList()} but was ${actualSources.toList()}")
        }
    }
+
+    fun hasTextLocation(vararg expected: TextLocation) = apply {


The helper function is a good idea.

However, it can be inlined with just 2 asserts on the
source.line
source.column
as we've done it in all other tests.
This refactoring with a helper function should then maybe done globally for all rules-tests, but not in this PR.

codecov-io · 2019-10-04T20:56:59Z

Codecov Report

❗ No coverage uploaded for pull request base (master@8daf49e). Click here to learn what that means.
The diff coverage is 100%.

@@            Coverage Diff            @@
##             master    #1977   +/-   ##
=========================================
  Coverage          ?   80.75%           
  Complexity        ?     1966           
=========================================
  Files             ?      328           
  Lines             ?     5549           
  Branches          ?     1010           
=========================================
  Hits              ?     4481           
  Misses            ?      536           
  Partials          ?      532

Impacted Files	Coverage Δ	Complexity Δ
...itlab/arturbosch/detekt/rules/naming/EnumNaming.kt	`100% <100%> (ø)`	`4 <0> (?)`

Continue to review full report at Codecov.

Legend - Click here to learn more
Δ = absolute <relative> (impact), ø = not affected, ? = missing data
Powered by Codecov. Last update 8daf49e...995006a. Read the comment docs.

schalkms

Please see my last comment in EnumNaming.kt.
Please also use force push only if it's really necessary.
This really eases the review for us. Thank you! 🙂

schalkms · 2019-10-05T17:19:48Z

detekt-rules/src/main/kotlin/io/gitlab/arturbosch/detekt/rules/naming/EnumNaming.kt

@@ -30,7 +30,7 @@ class EnumNaming(config: Config = Config.empty) : Rule(config) {
        if (!enumEntry.identifierName().matches(enumEntryPattern)) {
            report(CodeSmell(
                    issue,
-                    Entity.from(enumEntry),
+                    Entity.from(enumEntry.identifyingElement!!),


Yes, I also tried it out with different properties. None of them worked.
The problem with identifyingElement is that this API is experimental and I don't really want to have this in production code.
Furthermore, this would also potentially break detekt's baseline feature for this rule.
Unfortunately, I have to ask you to revert this line and adapt the test case. However, I'd really like to have the added tests in the productive code, since we are in the process of adding more tests like these.

I know that reporting the enum including the separator , feels weird, but it's not the end of the world.

BraisGabin · 2019-10-06T20:32:38Z

Ok, so now I'm not using an unstable api. And I remove the !! opetator. If enumEntry.nameIdentifier return null we fallback to enumEntry.

Anyway we have the problem of breaking the baselines...

schalkms

Thanks!
I think this is a nice addition for v1.2.0
I’m waiting for Artur’s review.

schalkms reviewed Oct 4, 2019

View reviewed changes

BraisGabin force-pushed the enum-naming branch from 6f3ffc8 to 62ab00a Compare October 4, 2019 20:12

schalkms reviewed Oct 4, 2019

View reviewed changes

BraisGabin force-pushed the enum-naming branch from 62ab00a to 4c581cd Compare October 4, 2019 20:56

BraisGabin requested a review from schalkms October 4, 2019 20:57

This was referenced Oct 4, 2019

Add snippet code in html report #1975

Merged

Findings assertions #1978

Merged

schalkms reviewed Oct 5, 2019

View reviewed changes

BraisGabin requested a review from schalkms October 6, 2019 11:47

schalkms requested a review from arturbosch October 6, 2019 20:23

Fix EnumNaming textLocation

995006a

BraisGabin force-pushed the enum-naming branch from 4c581cd to 995006a Compare October 6, 2019 20:30

schalkms approved these changes Oct 7, 2019

View reviewed changes

arturbosch approved these changes Oct 10, 2019

View reviewed changes

arturbosch merged commit ed7b17d into detekt:master Oct 10, 2019

arturbosch added this to the 1.2.0 milestone Oct 10, 2019

BraisGabin mentioned this pull request Oct 12, 2019

Better handling for the Suppresion of errors #2013

Merged

BraisGabin deleted the enum-naming branch October 24, 2019 14:15

smyachenkov pushed a commit to smyachenkov/detekt that referenced this pull request Dec 9, 2019

Fix EnumNaming textLocation (detekt#1977)

8efa9c0

smyachenkov pushed a commit to smyachenkov/detekt that referenced this pull request Dec 9, 2019

Fix EnumNaming textLocation (detekt#1977)

f8f4adb

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Fix EnumNaming textLocation #1977

Fix EnumNaming textLocation #1977

BraisGabin commented Oct 4, 2019 •

edited

Loading

schalkms Oct 4, 2019

BraisGabin Oct 4, 2019

schalkms Oct 4, 2019 •

edited

Loading

BraisGabin Oct 4, 2019

schalkms Oct 5, 2019

BraisGabin Oct 6, 2019

schalkms Oct 6, 2019

schalkms Oct 4, 2019

BraisGabin Oct 4, 2019

schalkms Oct 4, 2019

schalkms Oct 4, 2019

schalkms Oct 4, 2019 •

edited

Loading

BraisGabin Oct 4, 2019

codecov-io commented Oct 4, 2019 •

edited

Loading

schalkms left a comment

schalkms Oct 5, 2019

BraisGabin commented Oct 6, 2019

schalkms left a comment

Fix EnumNaming textLocation #1977

Fix EnumNaming textLocation #1977

Conversation

BraisGabin commented Oct 4, 2019 • edited Loading

Choose a reason for hiding this comment

Choose a reason for hiding this comment

schalkms Oct 4, 2019 • edited Loading

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

Choose a reason for hiding this comment

Choose a reason for hiding this comment

schalkms Oct 4, 2019 • edited Loading

Choose a reason for hiding this comment

Choose a reason for hiding this comment

codecov-io commented Oct 4, 2019 • edited Loading

Codecov Report

schalkms left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

BraisGabin commented Oct 6, 2019

schalkms left a comment

Choose a reason for hiding this comment

BraisGabin commented Oct 4, 2019 •

edited

Loading

schalkms Oct 4, 2019 •

edited

Loading

schalkms Oct 4, 2019 •

edited

Loading

codecov-io commented Oct 4, 2019 •

edited

Loading