azalea/kotlin-fork
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

Do not suggest "convert to object" for sealed sub-classes with state

Browse Source 
So #KT-24816 Fixed
This commit is contained in:
Mikhail Glukhikh
2018-06-08 14:45:45 +03:00
parent 813d7fcb6a
commit a09f6e14a5
8 changed files with 118 additions and 3 deletions
Download Patch File Download Diff File Expand all files Collapse all files
idea/resources/inspectionDescriptions/CanSealedSubClassBeObject.html
+1 -1
View File
@@ -1,5 +1,5 @@
<html> <html>
<body> <body>
This inspection reports direct inheritors of <b>sealed class</b> that have default constructors only and thus can be objects. This inspection reports direct inheritors of <b>sealed class</b> that have no state and thus can be objects.
</body> </body>
</html> </html>
idea/src/org/jetbrains/kotlin/idea/inspections/CanSealedSubClassBeObjectInspection.kt
+40 -2
View File
@@ -20,13 +20,18 @@ import com.intellij.codeInspection.ProblemHighlightType
import com.intellij.codeInspection.ProblemsHolder import com.intellij.codeInspection.ProblemsHolder
import com.intellij.psi.PsiElementVisitor import com.intellij.psi.PsiElementVisitor
import org.jetbrains.kotlin.asJava.classes.KtLightClassImpl import org.jetbrains.kotlin.asJava.classes.KtLightClassImpl
import org.jetbrains.kotlin.idea.caches.resolve.resolveToDescriptorIfAny
import org.jetbrains.kotlin.idea.core.getModalityFromDescriptor import org.jetbrains.kotlin.idea.core.getModalityFromDescriptor
import org.jetbrains.kotlin.idea.quickfix.sealedSubClassToObject.ConvertSealedSubClassToObjectFix import org.jetbrains.kotlin.idea.quickfix.sealedSubClassToObject.ConvertSealedSubClassToObjectFix
import org.jetbrains.kotlin.idea.refactoring.isAbstract
import org.jetbrains.kotlin.idea.search.declarationsSearch.HierarchySearchRequest import org.jetbrains.kotlin.idea.search.declarationsSearch.HierarchySearchRequest
import org.jetbrains.kotlin.idea.search.declarationsSearch.searchInheritors import org.jetbrains.kotlin.idea.search.declarationsSearch.searchInheritors
import org.jetbrains.kotlin.lexer.KtTokens import org.jetbrains.kotlin.lexer.KtTokens
import org.jetbrains.kotlin.psi.KtClass import org.jetbrains.kotlin.psi.KtClass
import org.jetbrains.kotlin.psi.KtProperty
import org.jetbrains.kotlin.psi.KtVisitorVoid import org.jetbrains.kotlin.psi.KtVisitorVoid
import org.jetbrains.kotlin.resolve.DescriptorToSourceUtils
import org.jetbrains.kotlin.resolve.descriptorUtil.getSuperClassNotAny
class CanSealedSubClassBeObjectInspection : AbstractKotlinInspection() { class CanSealedSubClassBeObjectInspection : AbstractKotlinInspection() {
override fun buildVisitor(holder: ProblemsHolder, isOnTheFly: Boolean, session: LocalInspectionToolSession): PsiElementVisitor { override fun buildVisitor(holder: ProblemsHolder, isOnTheFly: Boolean, session: LocalInspectionToolSession): PsiElementVisitor {
@@ -35,13 +40,16 @@ class CanSealedSubClassBeObjectInspection : AbstractKotlinInspection() {
if (!klass.hasModifier(KtTokens.SEALED_KEYWORD)) return if (!klass.hasModifier(KtTokens.SEALED_KEYWORD)) return
if (klass.getModalityFromDescriptor() != KtTokens.SEALED_KEYWORD) return if (klass.getModalityFromDescriptor() != KtTokens.SEALED_KEYWORD) return
klass.getSubclasses() val candidates = klass.getSubclasses()
.withEmptyConstructors() .withEmptyConstructors()
.thatAreFinal() .thatAreFinal()
.thatHasNoTypeParameters() .thatHasNoTypeParameters()
.thatHasNoInnerClasses() .thatHasNoInnerClasses()
.thatHasNoCompanionObjects() .thatHasNoCompanionObjects()
.forEach { reportPossibleObject(it) } .thatHasNoState()
if (candidates.isEmpty() || !klass.hasNoState() || !klass.baseClassHasNoState()) return
candidates.forEach { reportPossibleObject(it) }
} }
private fun reportPossibleObject(klass: KtClass) { private fun reportPossibleObject(klass: KtClass) {
@@ -56,6 +64,14 @@ class CanSealedSubClassBeObjectInspection : AbstractKotlinInspection() {
} }
} }
private tailrec fun KtClass.baseClassHasNoState(): Boolean {
val descriptor = resolveToDescriptorIfAny() ?: return false
val superDescriptor = descriptor.getSuperClassNotAny() ?: return true // No super class -- no state
val superClass = DescriptorToSourceUtils.descriptorToDeclaration(superDescriptor) as? KtClass ?: return false
if (!superClass.hasNoState()) return false
return superClass.baseClassHasNoState()
}
private fun KtClass.getSubclasses(): List<KtLightClassImpl> { private fun KtClass.getSubclasses(): List<KtLightClassImpl> {
return HierarchySearchRequest(this, this.useScope, false) return HierarchySearchRequest(this, this.useScope, false)
.searchInheritors().filterIsInstance<KtLightClassImpl>() .searchInheritors().filterIsInstance<KtLightClassImpl>()
@@ -83,6 +99,28 @@ class CanSealedSubClassBeObjectInspection : AbstractKotlinInspection() {
return filter { klass -> klass.hasNoInnerClass() } return filter { klass -> klass.hasNoInnerClass() }
} }
private fun List<KtClass>.thatHasNoState(): List<KtClass> {
return filter { it.hasNoState() }
}
private fun KtClass.hasNoState(): Boolean {
if (primaryConstructor?.valueParameters?.isNotEmpty() == true) return false
val body = getBody()
return body == null || run {
val properties = body.declarations.filterIsInstance<KtProperty>()
properties.none { property ->
// Simplified "backing field required"
when {
property.isAbstract() -> false
property.initializer != null -> true
property.delegate != null -> false
!property.isVar -> property.getter == null
else -> property.getter == null || property.setter == null
}
}
}
}
private fun KtClass.hasNoInnerClass(): Boolean { private fun KtClass.hasNoInnerClass(): Boolean {
val internalClasses = getBody() val internalClasses = getBody()
?.declarations ?.declarations
idea/testData/inspectionsLocal/convertSealedSubClassToObject/baseState.kt
Vendored
+7
View File
@@ -0,0 +1,7 @@
// PROBLEM: none
abstract class Base(var x: String)
sealed class Sealed(s: String) : Base(s)
<caret>class Derived : Sealed("123")
idea/testData/inspectionsLocal/convertSealedSubClassToObject/fakeState.kt
Vendored
+18
View File
@@ -0,0 +1,18 @@
// WITH_RUNTIME
abstract class Base {
var s: String
get() = "Hello"
set(value) {}
}
sealed class Sealed : Base() {
open val x: List<Int>
get() = emptyList()
}
<caret>class Derived : Sealed() {
var length: Int
get() = s.length
set(value) {}
}
idea/testData/inspectionsLocal/convertSealedSubClassToObject/fakeState.kt.after
Vendored
+18
View File
@@ -0,0 +1,18 @@
// WITH_RUNTIME
abstract class Base {
var s: String
get() = "Hello"
set(value) {}
}
sealed class Sealed : Base() {
open val x: List<Int>
get() = emptyList()
}
object Derived : Sealed() {
var length: Int
get() = s.length
set(value) {}
}
idea/testData/inspectionsLocal/convertSealedSubClassToObject/ownState.kt
Vendored
+8
View File
@@ -0,0 +1,8 @@
// PROBLEM: none
// WITH_RUNTIME
sealed class SC {
<caret>class U : SC() {
val a = mutableListOf<String>()
}
}
idea/testData/inspectionsLocal/convertSealedSubClassToObject/sealedState.kt
Vendored
+6
View File
@@ -0,0 +1,6 @@
// PROBLEM: none
sealed class SC {
var u = 0
<caret>class C : SC() {}
}
idea/tests/org/jetbrains/kotlin/idea/inspections/LocalInspectionTestGenerated.java
Generated
+20
View File
@@ -1225,6 +1225,11 @@ public class LocalInspectionTestGenerated extends AbstractLocalInspectionTest {
KotlinTestUtils.assertAllTestsPresentByMetadata(this.getClass(), new File("idea/testData/inspectionsLocal/convertSealedSubClassToObject"), Pattern.compile("^([\\w\\-_]+)\\.(kt|kts)$"), TargetBackend.ANY, true); KotlinTestUtils.assertAllTestsPresentByMetadata(this.getClass(), new File("idea/testData/inspectionsLocal/convertSealedSubClassToObject"), Pattern.compile("^([\\w\\-_]+)\\.(kt|kts)$"), TargetBackend.ANY, true);
} }
@TestMetadata("baseState.kt")
public void testBaseState() throws Exception {
runTest("idea/testData/inspectionsLocal/convertSealedSubClassToObject/baseState.kt");
}
@TestMetadata("convertSubClassWithModifiers.kt") @TestMetadata("convertSubClassWithModifiers.kt")
public void testConvertSubClassWithModifiers() throws Exception { public void testConvertSubClassWithModifiers() throws Exception {
runTest("idea/testData/inspectionsLocal/convertSealedSubClassToObject/convertSubClassWithModifiers.kt"); runTest("idea/testData/inspectionsLocal/convertSealedSubClassToObject/convertSubClassWithModifiers.kt");
@@ -1240,6 +1245,11 @@ public class LocalInspectionTestGenerated extends AbstractLocalInspectionTest {
runTest("idea/testData/inspectionsLocal/convertSealedSubClassToObject/convertSubClassWithoutParentheses.kt"); runTest("idea/testData/inspectionsLocal/convertSealedSubClassToObject/convertSubClassWithoutParentheses.kt");
} }
@TestMetadata("fakeState.kt")
public void testFakeState() throws Exception {
runTest("idea/testData/inspectionsLocal/convertSealedSubClassToObject/fakeState.kt");
}
@TestMetadata("generic.kt") @TestMetadata("generic.kt")
public void testGeneric() throws Exception { public void testGeneric() throws Exception {
runTest("idea/testData/inspectionsLocal/convertSealedSubClassToObject/generic.kt"); runTest("idea/testData/inspectionsLocal/convertSealedSubClassToObject/generic.kt");
@@ -1255,6 +1265,16 @@ public class LocalInspectionTestGenerated extends AbstractLocalInspectionTest {
runTest("idea/testData/inspectionsLocal/convertSealedSubClassToObject/openSubclass.kt"); runTest("idea/testData/inspectionsLocal/convertSealedSubClassToObject/openSubclass.kt");
} }
@TestMetadata("ownState.kt")
public void testOwnState() throws Exception {
runTest("idea/testData/inspectionsLocal/convertSealedSubClassToObject/ownState.kt");
}
@TestMetadata("sealedState.kt")
public void testSealedState() throws Exception {
runTest("idea/testData/inspectionsLocal/convertSealedSubClassToObject/sealedState.kt");
}
@TestMetadata("withCompanion.kt") @TestMetadata("withCompanion.kt")
public void testWithCompanion() throws Exception { public void testWithCompanion() throws Exception {
runTest("idea/testData/inspectionsLocal/convertSealedSubClassToObject/withCompanion.kt"); runTest("idea/testData/inspectionsLocal/convertSealedSubClassToObject/withCompanion.kt");