jlengrand/kotlin
1
0
Fork 0
mirror of https://github.com/jlengrand/kotlin.git synced 2026-04-04 08:31:30 +00:00
Code Issues Packages Projects Releases Wiki Activity

Enhancement for "join declaration and assignment": now can handle also local variables, relevant inspection added #KT-12095 Fixed

Browse Source
This commit is contained in:
Mikhail Glukhikh
2016-11-17 16:02:19 +03:00
parent c44ecded42
commit 45e28bef1c
27 changed files with 244 additions and 61 deletions
Download Patch File Download Diff File Expand all files Collapse all files

5
idea/resources/inspectionDescriptions/JoinDeclarationAndAssignment.html Normal file
View File

@@ -0,0 +1,5 @@
<html>
<body>
This inspection reports any property declaration that can be joined with the following assignment
</body>
</html>

8
idea/src/META-INF/plugin.xml
View File

@@ -1928,6 +1928,14 @@
language="kotlin"
/>
<localInspection implementationClass="org.jetbrains.kotlin.idea.intentions.JoinDeclarationAndAssignmentInspection"
displayName="Join declaration and assignment"
groupName="Kotlin"
enabledByDefault="true"
level="WEAK WARNING"
language="kotlin"
/>
<referenceImporter implementation="org.jetbrains.kotlin.idea.quickfix.KotlinReferenceImporter"/>
<fileType.fileViewProviderFactory filetype="KJSM" implementationClass="com.intellij.psi.ClassFileViewProviderFactory"/>

98
idea/src/org/jetbrains/kotlin/idea/intentions/JoinDeclarationAndAssignmentIntention.kt
View File

@@ -24,38 +24,44 @@ import com.intellij.psi.util.PsiTreeUtil
import org.jetbrains.kotlin.idea.core.canOmitDeclaredType
import org.jetbrains.kotlin.idea.core.moveCaret
import org.jetbrains.kotlin.idea.core.unblockDocument
import org.jetbrains.kotlin.idea.inspections.IntentionBasedInspection
import org.jetbrains.kotlin.lexer.KtTokens
import org.jetbrains.kotlin.psi.*
import org.jetbrains.kotlin.psi.psiUtil.*
import org.jetbrains.kotlin.utils.addToStdlib.firstIsInstanceOrNull
class JoinDeclarationAndAssignmentIntention :
SelfTargetingIntention<KtBinaryExpression>(KtBinaryExpression::class.java, "Join declaration and assignment") {
class JoinDeclarationAndAssignmentInspection : IntentionBasedInspection<KtProperty>(
JoinDeclarationAndAssignmentIntention::class,
"Can be joined with assignment"
)
override fun isApplicableTo(element: KtBinaryExpression, caretOffset: Int): Boolean {
if (element.operationToken != KtTokens.EQ) {
class JoinDeclarationAndAssignmentIntention : SelfTargetingOffsetIndependentIntention<KtProperty>(
KtProperty::class.java,
"Join declaration and assignment"
) {
override fun isApplicableTo(element: KtProperty): Boolean {
if (element.hasDelegate()
|| element.hasInitializer()
|| element.setter != null
|| element.getter != null
|| element.receiverTypeReference != null
|| element.name == null) {
return false
}
val rightExpression = element.right ?: return false
val initializer = PsiTreeUtil.getParentOfType(element,
KtAnonymousInitializer::class.java,
KtSecondaryConstructor::class.java) ?: return false
val target = findTargetProperty(element)
return target != null && target.initializer == null && target.receiverTypeReference == null &&
target.getNonStrictParentOfType<KtClassOrObject>() == element.getNonStrictParentOfType<KtClassOrObject>() &&
hasNoLocalDependencies(rightExpression, initializer)
val assignment = findAssignment(element) ?: return false
return assignment.right?.let { hasNoLocalDependencies(it, element.parent) } ?: false
}
override fun applyTo(element: KtBinaryExpression, editor: Editor?) {
val property = findTargetProperty(element) ?: return
val initializer = element.right ?: return
val newInitializer = property.setInitializer(initializer)!!
override fun applyTo(element: KtProperty, editor: Editor?) {
val typeReference = element.typeReference ?: return
val initializerBlock = element.getStrictParentOfType<KtAnonymousInitializer>()
element.delete()
val assignment = findAssignment(element) ?: return
val initializer = assignment.right ?: return
val newInitializer = element.setInitializer(initializer)!!
val initializerBlock = assignment.parent?.parent as? KtAnonymousInitializer
assignment.delete()
if (initializerBlock != null && (initializerBlock.body as? KtBlockExpression)?.isEmpty() == true) {
initializerBlock.delete()
}
@@ -63,11 +69,10 @@ class JoinDeclarationAndAssignmentIntention :
editor?.apply {
unblockDocument()
val typeRef = property.typeReference
if (typeRef != null && property.canOmitDeclaredType(newInitializer, canChangeTypeToSubtype = !property.isVar)) {
val colon = property.colon!!
selectionModel.setSelection(colon.startOffset, typeRef.endOffset)
moveCaret(typeRef.endOffset, ScrollType.CENTER)
if (element.canOmitDeclaredType(newInitializer, canChangeTypeToSubtype = !element.isVar)) {
val colon = element.colon!!
selectionModel.setSelection(colon.startOffset, typeReference.endOffset)
moveCaret(typeReference.endOffset, ScrollType.CENTER)
}
else {
moveCaret(newInitializer.startOffset, ScrollType.CENTER)
@@ -75,15 +80,40 @@ class JoinDeclarationAndAssignmentIntention :
}
}
private fun findTargetProperty(expr: KtBinaryExpression): KtProperty? {
val leftExpression = expr.left as? KtNameReferenceExpression ?: return null
return leftExpression.resolveAllReferences().firstIsInstanceOrNull<KtProperty>()
private fun findAssignment(property: KtProperty): KtBinaryExpression? {
val propertyContainer = property.parent as? KtElement ?: return null
property.typeReference ?: return null
val assignments = mutableListOf<KtBinaryExpression>()
fun process(binaryExpr: KtBinaryExpression) {
if (binaryExpr.operationToken != KtTokens.EQ) return
val leftReference = binaryExpr.left as? KtNameReferenceExpression ?: return
if (leftReference.getReferencedName() != property.name) return
assignments += binaryExpr
}
propertyContainer.forEachDescendantOfType(::process)
fun PsiElement?.invalidParent(): Boolean {
when {
this == null -> return true
this === propertyContainer -> return false
else -> {
val grandParent = parent
if (grandParent.parent !== propertyContainer) return true
return grandParent !is KtAnonymousInitializer && grandParent !is KtSecondaryConstructor
}
}
}
if (assignments.any { it.parent.invalidParent() }) return null
val first = assignments.firstOrNull() ?: return null
if (assignments.any { it !== first && it.parent?.parent is KtSecondaryConstructor}) return null
return first
}
fun KtBlockExpression.isEmpty(): Boolean {
// a block that only contains comments is not empty
return contentRange().isEmpty
}
// a block that only contains comments is not empty
private fun KtBlockExpression.isEmpty() = contentRange().isEmpty
private fun hasNoLocalDependencies(element: KtElement, localContext: PsiElement): Boolean {
return !element.anyDescendantOfType<PsiElement> { child ->
@@ -97,5 +127,3 @@ private fun PsiElement.resolveAllReferences(): Sequence<PsiElement?> {
.asSequence()
.map { it.resolve() }
}

8
idea/testData/intentions/joinDeclarationAndAssignment/assignmentInIf.kt vendored Normal file
View File

@@ -0,0 +1,8 @@
// IS_APPLICABLE: false
fun foo(flag: Boolean) {
var x: Double<caret>
if (flag) {
x = 3.14
}
x = 2.71
}

4
idea/testData/intentions/joinDeclarationAndAssignment/cannotRemoveType.kt vendored
View File

@@ -1,7 +1,7 @@
class A {
var a: String?
var a<caret>: String?
init {
<caret>a = null
a = null
}
}

4
idea/testData/intentions/joinDeclarationAndAssignment/cannotRemoveType2.kt vendored
View File

@@ -1,9 +1,9 @@
// WITH_RUNTIME
class A {
var a: List<String>
var a<caret>: List<String>
init {
<caret>a = emptyList()
a = emptyList()
}
}

7
idea/testData/intentions/joinDeclarationAndAssignment/cannotRemoveType3.kt vendored
View File

@@ -1,7 +0,0 @@
class A {
val a: String?
init {
<caret>a = null
}
}

4
idea/testData/intentions/joinDeclarationAndAssignment/cannotRemoveType3.kt.after vendored
View File

@@ -1,4 +0,0 @@
class A {
val a<selection>: String?</selection><caret> = null
}

11
idea/testData/intentions/joinDeclarationAndAssignment/capturedInitialization.kt vendored Normal file
View File

@@ -0,0 +1,11 @@
// IS_APPLICABLE: false
fun bar() {
var x: <caret>String
fun foo() {
x = "456"
x.hashCode()
}
foo()
x = "123"
x.hashCode()
}

4
idea/testData/intentions/joinDeclarationAndAssignment/comment.kt vendored
View File

@@ -1,8 +1,8 @@
class A {
var a: Int
var a<caret>: Int
init {
// Initialize a
<caret>a = 1
a = 1
}
}

4
idea/testData/intentions/joinDeclarationAndAssignment/correctConditionalAssignment.kt vendored Normal file
View File

@@ -0,0 +1,4 @@
fun foo(flag: Boolean) {
val x: Double<caret>
x = if (flag) 3.14 else 2.71
}

3
idea/testData/intentions/joinDeclarationAndAssignment/correctConditionalAssignment.kt.after vendored Normal file
View File

@@ -0,0 +1,3 @@
fun foo(flag: Boolean) {
val x<selection>: Double</selection><caret> = if (flag) 3.14 else 2.71
}

4
idea/testData/intentions/joinDeclarationAndAssignment/deleteInitBlock.kt vendored
View File

@@ -1,7 +1,7 @@
class A {
var a: Int
var a<caret>: Int
init {
<caret>a = 1
a = 1
}
}

6
idea/testData/intentions/joinDeclarationAndAssignment/incorrectConditionalAssignment.kt vendored Normal file
View File

@@ -0,0 +1,6 @@
// IS_APPLICABLE: false
fun foo() {
val x: Double<caret>
val flag = false
x = if (flag) 3.14 else 2.71
}

12
idea/testData/intentions/joinDeclarationAndAssignment/multipleConstructors.kt vendored Normal file
View File

@@ -0,0 +1,12 @@
// IS_APPLICABLE: false
class A {
constructor() {
a = 1
}
constructor(aa: Int) {
a = aa
}
val a<caret>: Int
}

9
idea/testData/intentions/joinDeclarationAndAssignment/propertyReassignment.kt vendored Normal file
View File

@@ -0,0 +1,9 @@
class C {
var s<caret>: Int
init {
s = 1
s.hashCode()
s = 2
}
}

8
idea/testData/intentions/joinDeclarationAndAssignment/propertyReassignment.kt.after vendored Normal file
View File

@@ -0,0 +1,8 @@
class C {
var s<selection>: Int</selection><caret> = 1
init {
s.hashCode()
s = 2
}
}

4
idea/testData/intentions/joinDeclarationAndAssignment/simple.kt vendored
View File

@@ -1,9 +1,9 @@
class A {
var a: Int
var a<caret>: Int
var b: Int
init {
<caret>a = 1
a = 1
b = 2
}
}

4
idea/testData/intentions/joinDeclarationAndAssignment/simpleLocal.kt vendored Normal file
View File

@@ -0,0 +1,4 @@
fun foo() {
val s: String<caret>
s = "Hello"
}

3
idea/testData/intentions/joinDeclarationAndAssignment/simpleLocal.kt.after vendored Normal file
View File

@@ -0,0 +1,3 @@
fun foo() {
val s<selection>: String</selection><caret> = "Hello"
}

7
idea/testData/intentions/joinDeclarationAndAssignment/singleConstructor.kt vendored Normal file
View File

@@ -0,0 +1,7 @@
class A {
constructor() {
a = 1
}
val a<caret>: Int
}

6
idea/testData/intentions/joinDeclarationAndAssignment/singleConstructor.kt.after vendored Normal file
View File

@@ -0,0 +1,6 @@
class A {
constructor() {
}
val a<selection>: Int</selection><caret> = 1
}

4
idea/testData/intentions/joinDeclarationAndAssignment/usedLocal.kt vendored
View File

@@ -1,9 +1,9 @@
// IS_APPLICABLE: false
class A {
var b: Int
var b<caret>: Int
init {
val i = 0
b = <caret>i
b = i
}
}

7
idea/testData/intentions/joinDeclarationAndAssignment/usedLocal2.kt vendored Normal file
View File

@@ -0,0 +1,7 @@
// IS_APPLICABLE: false
fun foo() {
// It's possible here to join with assignment but move the result after declaration of i
var b<caret>: Int
val i = 0
b = i
}

6
idea/testData/intentions/joinDeclarationAndAssignment/varReassignment.kt vendored Normal file
View File

@@ -0,0 +1,6 @@
fun foo() {
var s<caret>: Int
s = 1
s.hashCode()
s = 2
}

5
idea/testData/intentions/joinDeclarationAndAssignment/varReassignment.kt.after vendored Normal file
View File

@@ -0,0 +1,5 @@
fun foo() {
var s<selection>: Int</selection><caret> = 1
s.hashCode()
s = 2
}

60
idea/tests/org/jetbrains/kotlin/idea/intentions/IntentionTestGenerated.java
View File

@@ -8046,6 +8046,12 @@ public class IntentionTestGenerated extends AbstractIntentionTest {
KotlinTestUtils.assertAllTestsPresentByMetadata(this.getClass(), new File("idea/testData/intentions/joinDeclarationAndAssignment"), Pattern.compile("^([\\w\\-_]+)\\.kt$"), TargetBackend.ANY, true);
}
@TestMetadata("assignmentInIf.kt")
public void testAssignmentInIf() throws Exception {
String fileName = KotlinTestUtils.navigationMetadata("idea/testData/intentions/joinDeclarationAndAssignment/assignmentInIf.kt");
doTest(fileName);
}
@TestMetadata("cannotRemoveType.kt")
public void testCannotRemoveType() throws Exception {
String fileName = KotlinTestUtils.navigationMetadata("idea/testData/intentions/joinDeclarationAndAssignment/cannotRemoveType.kt");
@@ -8058,9 +8064,9 @@ public class IntentionTestGenerated extends AbstractIntentionTest {
doTest(fileName);
}
@TestMetadata("cannotRemoveType3.kt")
public void testCannotRemoveType3() throws Exception {
String fileName = KotlinTestUtils.navigationMetadata("idea/testData/intentions/joinDeclarationAndAssignment/cannotRemoveType3.kt");
@TestMetadata("capturedInitialization.kt")
public void testCapturedInitialization() throws Exception {
String fileName = KotlinTestUtils.navigationMetadata("idea/testData/intentions/joinDeclarationAndAssignment/capturedInitialization.kt");
doTest(fileName);
}
@@ -8070,23 +8076,71 @@ public class IntentionTestGenerated extends AbstractIntentionTest {
doTest(fileName);
}
@TestMetadata("correctConditionalAssignment.kt")
public void testCorrectConditionalAssignment() throws Exception {
String fileName = KotlinTestUtils.navigationMetadata("idea/testData/intentions/joinDeclarationAndAssignment/correctConditionalAssignment.kt");
doTest(fileName);
}
@TestMetadata("deleteInitBlock.kt")
public void testDeleteInitBlock() throws Exception {
String fileName = KotlinTestUtils.navigationMetadata("idea/testData/intentions/joinDeclarationAndAssignment/deleteInitBlock.kt");
doTest(fileName);
}
@TestMetadata("incorrectConditionalAssignment.kt")
public void testIncorrectConditionalAssignment() throws Exception {
String fileName = KotlinTestUtils.navigationMetadata("idea/testData/intentions/joinDeclarationAndAssignment/incorrectConditionalAssignment.kt");
doTest(fileName);
}
@TestMetadata("multipleConstructors.kt")
public void testMultipleConstructors() throws Exception {
String fileName = KotlinTestUtils.navigationMetadata("idea/testData/intentions/joinDeclarationAndAssignment/multipleConstructors.kt");
doTest(fileName);
}
@TestMetadata("propertyReassignment.kt")
public void testPropertyReassignment() throws Exception {
String fileName = KotlinTestUtils.navigationMetadata("idea/testData/intentions/joinDeclarationAndAssignment/propertyReassignment.kt");
doTest(fileName);
}
@TestMetadata("simple.kt")
public void testSimple() throws Exception {
String fileName = KotlinTestUtils.navigationMetadata("idea/testData/intentions/joinDeclarationAndAssignment/simple.kt");
doTest(fileName);
}
@TestMetadata("simpleLocal.kt")
public void testSimpleLocal() throws Exception {
String fileName = KotlinTestUtils.navigationMetadata("idea/testData/intentions/joinDeclarationAndAssignment/simpleLocal.kt");
doTest(fileName);
}
@TestMetadata("singleConstructor.kt")
public void testSingleConstructor() throws Exception {
String fileName = KotlinTestUtils.navigationMetadata("idea/testData/intentions/joinDeclarationAndAssignment/singleConstructor.kt");
doTest(fileName);
}
@TestMetadata("usedLocal.kt")
public void testUsedLocal() throws Exception {
String fileName = KotlinTestUtils.navigationMetadata("idea/testData/intentions/joinDeclarationAndAssignment/usedLocal.kt");
doTest(fileName);
}
@TestMetadata("usedLocal2.kt")
public void testUsedLocal2() throws Exception {
String fileName = KotlinTestUtils.navigationMetadata("idea/testData/intentions/joinDeclarationAndAssignment/usedLocal2.kt");
doTest(fileName);
}
@TestMetadata("varReassignment.kt")
public void testVarReassignment() throws Exception {
String fileName = KotlinTestUtils.navigationMetadata("idea/testData/intentions/joinDeclarationAndAssignment/varReassignment.kt");
doTest(fileName);
}
}
@TestMetadata("idea/testData/intentions/loopToCallChain")