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

Add inspection for private primary constructors in data classes

Browse Source 
Fixes #KT-15709
This commit is contained in:
Kirill Rakhman
2017-01-22 13:45:58 +01:00
committed by Mikhail Glukhikh
parent f64345634b
commit 909007d984
7 changed files with 82 additions and 0 deletions
Download Patch File Download Diff File Expand all files Collapse all files
idea/resources/inspectionDescriptions/DataClassPrivateConstructor.html
+5
View File
@@ -0,0 +1,5 @@
<html>
<body>
This inspection reports private constructors of data classes because they are always exposed via the generated 'copy' method.
</body>
</html>
idea/src/META-INF/plugin.xml
+8
View File
@@ -2029,6 +2029,14 @@
language="kotlin"
/>
<localInspection implementationClass="org.jetbrains.kotlin.idea.inspections.DataClassPrivateConstructorInspection"
displayName="Private data class constructor is exposed via the 'copy' method"
groupName="Kotlin"
enabledByDefault="true"
level="WARNING"
language="kotlin"
/>
<referenceImporter implementation="org.jetbrains.kotlin.idea.quickfix.KotlinReferenceImporter"/>
idea/src/org/jetbrains/kotlin/idea/inspections/DataClassPrivateConstructorInspection.kt
+49
View File
@@ -0,0 +1,49 @@
/*
* Copyright 2010-2017 JetBrains s.r.o.
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
* You may obtain a copy of the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
*/
package org.jetbrains.kotlin.idea.inspections
import com.intellij.codeInspection.ProblemHighlightType
import com.intellij.codeInspection.ProblemsHolder
import com.intellij.psi.PsiElementVisitor
import org.jetbrains.kotlin.lexer.KtTokens
import org.jetbrains.kotlin.psi.KtPrimaryConstructor
import org.jetbrains.kotlin.psi.KtVisitorVoid
import org.jetbrains.kotlin.psi.psiUtil.containingClass
import org.jetbrains.kotlin.psi.psiUtil.isPrivate
class DataClassPrivateConstructorInspection : AbstractKotlinInspection() {
override fun buildVisitor(holder: ProblemsHolder, isOnTheFly: Boolean): PsiElementVisitor {
return object : KtVisitorVoid() {
override fun visitPrimaryConstructor(constructor: KtPrimaryConstructor) {
super.visitPrimaryConstructor(constructor)
if (constructor.containingClass()?.isData() == true && constructor.isPrivate()) {
val keyword = constructor.modifierList?.getModifier(KtTokens.PRIVATE_KEYWORD) ?: return
val problemDescriptor = holder.manager.createProblemDescriptor(
keyword,
keyword,
"Private data class constructor is exposed via the generated 'copy' method.",
ProblemHighlightType.GENERIC_ERROR_OR_WARNING,
isOnTheFly
)
holder.registerProblem(problemDescriptor)
}
}
}
}
}
idea/testData/inspections/dataClassPrivateConstructor/inspectionData/expected.xml
Vendored
+10
View File
@@ -0,0 +1,10 @@
<problems>
<problem>
<file>test.kt</file>
<line>1</line>
<module>light_idea_test_case</module>
<entry_point TYPE="file" FQNAME="temp:///src/test.kt" />
<problem_class severity="WARNING" attribute_key="WARNING_ATTRIBUTES">Private data class constructor is exposed via the 'copy' method</problem_class>
<description>Private data class constructor is exposed via the generated 'copy' method.</description>
</problem>
</problems>
idea/testData/inspections/dataClassPrivateConstructor/inspectionData/inspections.test
Vendored
+1
View File
@@ -0,0 +1 @@
// INSPECTION_CLASS: org.jetbrains.kotlin.idea.inspections.DataClassPrivateConstructorInspection
idea/testData/inspections/dataClassPrivateConstructor/test.kt
Vendored
+3
View File
@@ -0,0 +1,3 @@
data class Foo private constructor(val foo: String)
class Foo private constructor(val foo: String)
data class Foo2(val foo: String)
idea/tests/org/jetbrains/kotlin/idea/codeInsight/InspectionTestGenerated.java
+6
View File
@@ -173,6 +173,12 @@ public class InspectionTestGenerated extends AbstractInspectionTest {
doTest(fileName);
}
@TestMetadata("dataClassPrivateConstructor/inspectionData/inspections.test")
public void testDataClassPrivateConstructor_inspectionData_Inspections_test() throws Exception {
String fileName = KotlinTestUtils.navigationMetadata("idea/testData/inspections/dataClassPrivateConstructor/inspectionData/inspections.test");
doTest(fileName);
}
@TestMetadata("dynamic/js/inspectionData/inspections.test")
public void testDynamic_js_inspectionData_Inspections_test() throws Exception {
String fileName = KotlinTestUtils.navigationMetadata("idea/testData/inspections/dynamic/js/inspectionData/inspections.test");