Removed UnnecessaryAbstractClass if it inherits from a abstract class #5009

gouri-panda · 2022-06-29T07:06:13Z

closes: #4753

Removed UnnecessaryAbstractClass if it inherits from abstract class an interface or that has concrete members.

BraisGabin · 2022-06-29T09:53:08Z

...tyle/src/test/kotlin/io/gitlab/arturbosch/detekt/rules/style/UnnecessaryAbstractClassSpec.kt

@@ -73,8 +73,7 @@ class UnnecessaryAbstractClassSpec(val env: KotlinCoreEnvironment) {
                    }
                    abstract class B : A
                """
-                val findings = subject.compileAndLintWithContext(env, code)
-                assertFindingMessage(findings, message)
+                assertThat(subject.compileAndLintWithContext(env, code)).isEmpty()


This test shouldn't change, right?

@BraisGabin If we don't change it, the tests will fail. I don't understand your question.

But this one was right. An abstract class that only extends an interface is an unnecessary abstract class. The only one that should change is the case where an abstract class extend another abstract class because there you can't use an interface. (maybe I'm missing something here)

Should I revert that?

Yes. This test shouldn't change.

schalkms

Thanks for the fix - appreciate it!

...tyle/src/test/kotlin/io/gitlab/arturbosch/detekt/rules/style/UnnecessaryAbstractClassSpec.kt

schalkms · 2022-06-29T12:45:15Z

@gouri-panda please try to rebase this branch and fix the following rule violation. Then this PR is good to go. 👍

UnnecessaryAbstractClass.kt:83:25: Function check has 3 return statements which exceeds the limit of 2. [ReturnCount]

amitdash291 · 2022-07-02T17:57:14Z

...es-style/src/main/kotlin/io/gitlab/arturbosch/detekt/rules/style/UnnecessaryAbstractClass.kt

@@ -98,6 +98,7 @@ class UnnecessaryAbstractClass(config: Config = Config.empty) : Rule(config) {
                    report(CodeSmell(issue, Entity.from(nameIdentifier), noConcreteMember))
                }
            }
+            hasInheritedMember(true) -> return


The following enhancement to this logic will ensure the rule still fails for interface super types (as discussed in @BraisGabin's comment):

hasInheritedMember(true) && !isParentInterface() -> return private fun KtClass.isParentInterface() = (bindingContext[BindingContext.CLASS, this]?.unsubstitutedMemberScope as? LazyClassMemberScope) ?.supertypes?.firstOrNull()?.isInterface() == true

@amitdash291 Thanks for advice and code :)

I think there's a corner case to test here. What if the class implements an interface and inherits from an abstract class in that order. For eg the following may fail the rule whereas it's expected to pass:

interface I abstract class A // some abstract fields here abstract class B: I, A()

cc @gouri-panda @BraisGabin

Is that even valid Kotlin code? Shouldn't the class be defined the first one? I can't check right now. Anyway, a test extending both, a class and an interface seems like a really good case to have a test. @guori-panda, can you add such test?

@BraisGabin yes interestingly this is valid Kotlin code, given below is the test case (that compiles):

@Test fun `does not report abstract class that inherits from an interface and an abstract class in that order`() { val code = """ interface I @Deprecated("We don't care about this first class") abstract class A { abstract val i: Int } abstract class B: I, A() """ val findings = subject.compileAndLintWithContext(env, code) assertThat(findings).isEmpty() }

...tyle/src/test/kotlin/io/gitlab/arturbosch/detekt/rules/style/UnnecessaryAbstractClassSpec.kt

...es-style/src/main/kotlin/io/gitlab/arturbosch/detekt/rules/style/UnnecessaryAbstractClass.kt

…abstract class that has concrete members Removed deprecated annotations Revert "Removed deprecated annotations" This reverts commit 326a356 fix return count rule violation

amitdash291

Refer reply to the code suggestion earlier.

BraisGabin · 2022-07-06T15:21:16Z

@gouri-panda sorry for all the changes. Can you fix the conflicts and add the tests that @amitdash291 point out here: #5009 (comment) ?

After that (and if that test passes) I think that this is ready to merge.

gouri-panda · 2022-07-06T20:11:31Z

@BraisGabin @amitdash291 Sure :)

…abstract class that has concrete members Removed deprecated annotations Revert "Removed deprecated annotations" This reverts commit 326a356 fix return count rule violation

# Conflicts: # detekt-rules-style/src/test/kotlin/io/gitlab/arturbosch/detekt/rules/style/UnnecessaryAbstractClassSpec.kt

BraisGabin

Thanks for the updates :). This still has conflicts, could you check that?

BraisGabin · 2022-07-07T14:12:19Z

...tyle/src/test/kotlin/io/gitlab/arturbosch/detekt/rules/style/UnnecessaryAbstractClassSpec.kt

+                abstract class A {
+                    abstract val i: Int
+                }
+                abstract class B: A(), I


Suggested change

abstract class B: A(), I

abstract class B: A(), I

abstract class C: I, A()

We should check both cases.

Sure! Let me add another test case as well!

@gouri-panda I have an idea to solve this in a generic manner. If you're okay I can raise a PR on your fork branch gouri-panda:fix-4753?

I was thinking if we check one of the parent is abstract, then we can return. But go for it :)

@gouri-panda
I have pushed my changes as a PR to your fork's branch here
In summary I have checked if not all the parents are interfaces, which is equivalent of the fact that at least one parent is abstract.
Please refer to this commit (there are a few other merge commits)

…s rule

Handle corner case of multiple inheritance in UnnecessaryAbstractClass rule

BraisGabin · 2022-07-10T10:26:39Z

Thanks for the fix @gouri-panda and @amitdash291

github-actions bot added the rules label Jun 29, 2022

vercel bot deployed to Preview June 29, 2022 07:12 View deployment

BraisGabin reviewed Jun 29, 2022

View reviewed changes

schalkms approved these changes Jun 29, 2022

View reviewed changes

...tyle/src/test/kotlin/io/gitlab/arturbosch/detekt/rules/style/UnnecessaryAbstractClassSpec.kt Outdated Show resolved Hide resolved

gouri-panda requested review from BraisGabin and schalkms June 29, 2022 11:16

vercel bot deployed to Preview June 29, 2022 11:20 View deployment

vercel bot deployed to Preview June 29, 2022 12:30 View deployment

gouri-panda force-pushed the fix-4753 branch from f2a6555 to 8445bee Compare June 29, 2022 12:57

vercel bot deployed to Preview June 29, 2022 13:03 View deployment

amitdash291 reviewed Jul 2, 2022

View reviewed changes

gouri-panda force-pushed the fix-4753 branch from 8445bee to 57072f6 Compare July 3, 2022 09:31

vercel bot deployed to Preview July 3, 2022 09:36 View deployment

BraisGabin reviewed Jul 3, 2022

View reviewed changes

...tyle/src/test/kotlin/io/gitlab/arturbosch/detekt/rules/style/UnnecessaryAbstractClassSpec.kt Outdated Show resolved Hide resolved

github-advanced-security bot found potential problems Jul 3, 2022

View reviewed changes

...es-style/src/main/kotlin/io/gitlab/arturbosch/detekt/rules/style/UnnecessaryAbstractClass.kt Fixed Show fixed Hide fixed

Removed UnnecessaryAbstractClass if it inherits from an interface or …

5736f42

…abstract class that has concrete members Removed deprecated annotations Revert "Removed deprecated annotations" This reverts commit 326a356 fix return count rule violation

gouri-panda force-pushed the fix-4753 branch from 57072f6 to 5736f42 Compare July 3, 2022 19:40

gouri-panda requested a review from BraisGabin July 3, 2022 19:41

vercel bot deployed to Preview July 3, 2022 19:45 View deployment

amitdash291 suggested changes Jul 4, 2022

View reviewed changes

cortinico added this to the 1.21.0 milestone Jul 5, 2022

gouri-panda added 2 commits July 7, 2022 16:42

Removed UnnecessaryAbstractClass if it inherits from an interface or …

b5b5742

…abstract class that has concrete members Removed deprecated annotations Revert "Removed deprecated annotations" This reverts commit 326a356 fix return count rule violation

Merge remote-tracking branch 'origin/fix-4753' into fix-4753

1a9aa3c

# Conflicts: # detekt-rules-style/src/test/kotlin/io/gitlab/arturbosch/detekt/rules/style/UnnecessaryAbstractClassSpec.kt

vercel bot deployed to Preview July 7, 2022 11:37 View deployment

BraisGabin reviewed Jul 7, 2022

View reviewed changes

amitdash291 added 2 commits July 9, 2022 23:49

Merge remote-tracking branch 'upstream/main' into fix-4753

675c48c

Handle corner case of multiple inheritance in UnnecessaryAbstractClas…

69b3fd3

…s rule

amitdash291 mentioned this pull request Jul 9, 2022

Handle corner case of multiple inheritance in UnnecessaryAbstractClass rule gouri-panda/detekt#1

Merged

Merge pull request #1 from amitdash291/fix-4753

2eabac7

Handle corner case of multiple inheritance in UnnecessaryAbstractClass rule

vercel bot deployed to Preview July 10, 2022 09:45 View deployment

BraisGabin approved these changes Jul 10, 2022

View reviewed changes

BraisGabin merged commit 1b330e9 into detekt:main Jul 10, 2022

TWiStErRob mentioned this pull request Jan 24, 2023

UnnecessaryAbstractClass false positive #4753

Closed

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Removed UnnecessaryAbstractClass if it inherits from a abstract class #5009

Removed UnnecessaryAbstractClass if it inherits from a abstract class #5009

gouri-panda commented Jun 29, 2022

BraisGabin Jun 29, 2022

gouri-panda Jun 29, 2022

BraisGabin Jun 29, 2022

gouri-panda Jun 30, 2022

BraisGabin Jun 30, 2022

schalkms left a comment

schalkms commented Jun 29, 2022

amitdash291 Jul 2, 2022 •

edited

gouri-panda Jul 3, 2022

amitdash291 Jul 4, 2022 •

edited

BraisGabin Jul 5, 2022

amitdash291 Jul 5, 2022 •

edited

amitdash291 left a comment

BraisGabin commented Jul 6, 2022

gouri-panda commented Jul 6, 2022

BraisGabin left a comment •

edited

BraisGabin Jul 7, 2022

gouri-panda Jul 7, 2022

amitdash291 Jul 9, 2022

gouri-panda Jul 9, 2022

amitdash291 Jul 9, 2022 •

edited

BraisGabin commented Jul 10, 2022

	abstract class B: A(), I
	abstract class B: A(), I
	abstract class C: I, A()

Removed UnnecessaryAbstractClass if it inherits from a abstract class #5009

Removed UnnecessaryAbstractClass if it inherits from a abstract class #5009

Conversation

gouri-panda commented Jun 29, 2022

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 left a comment

Choose a reason for hiding this comment

schalkms commented Jun 29, 2022

amitdash291 Jul 2, 2022 • edited

Choose a reason for hiding this comment

Choose a reason for hiding this comment

amitdash291 Jul 4, 2022 • edited

Choose a reason for hiding this comment

Choose a reason for hiding this comment

amitdash291 Jul 5, 2022 • edited

Choose a reason for hiding this comment

amitdash291 left a comment

Choose a reason for hiding this comment

BraisGabin commented Jul 6, 2022

gouri-panda commented Jul 6, 2022

BraisGabin left a comment • edited

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

amitdash291 Jul 9, 2022 • edited

Choose a reason for hiding this comment

BraisGabin commented Jul 10, 2022

amitdash291 Jul 2, 2022 •

edited

amitdash291 Jul 4, 2022 •

edited

amitdash291 Jul 5, 2022 •

edited

BraisGabin left a comment •

edited

amitdash291 Jul 9, 2022 •

edited