Merge pull request #20 from cawolf/fix-18-dont-regenerate

Fixes #18: do not regenerate existing mocks

Author: cawolf

src/main/kotlin/de/cawolf/quickmock/intention/QuickMockCreator.kt

@@ -6,10 +6,8 @@ import com.intellij.openapi.components.ServiceManager
 import com.intellij.openapi.editor.Editor
 import com.intellij.openapi.project.Project
 import com.intellij.psi.PsiElement
-import com.intellij.psi.PsiWhiteSpace
 import com.intellij.psi.util.PsiTreeUtil
 import com.intellij.util.IncorrectOperationException
-import com.jetbrains.php.lang.psi.PhpPsiElementFactory
 import com.jetbrains.php.lang.psi.elements.*
 import de.cawolf.quickmock.Settings
 import de.cawolf.quickmock.intention.service.*
@@ -22,19 +20,15 @@ class QuickMockCreator : PsiElementBaseIntentionAction(), IntentionAction {
     override fun getFamilyName(): String = text
 
     override fun isAvailable(project: Project, editor: Editor, psiElement: PsiElement): Boolean {
+        val constructorParameters = ServiceManager.getService(project, ConstructorParameters::class.java)
         val newExpression = PsiTreeUtil.getParentOfType(psiElement, NewExpression::class.java)
         return newExpression is NewExpression
                 && newExpression.classReference?.resolve() is Method
-                && (newExpression.parameterList?.children?.isEmpty() ?: false)
+                && constructorParameters.get(psiElement).count() != newExpression.parameterList!!.children.count()
     }
 
     @Throws(IncorrectOperationException::class)
     override fun invoke(project: Project, editor: Editor, psiElement: PsiElement) {
-        val parameters = getConstructorParameters(psiElement)
-        if (parameters.size == 0) {
-            return // simple constructor without parameters - nothing to do
-        }
-
         // init and safeguards: do not proceed if the current edited test class is not parsing correctly
         val namespace = PsiTreeUtil.getParentOfType(psiElement, PhpNamespace::class.java)
                 ?: return
@@ -54,13 +48,21 @@ class QuickMockCreator : PsiElementBaseIntentionAction(), IntentionAction {
         val addProperty = ServiceManager.getService(project, AddProperty::class.java)
         val reformatTestcase = ServiceManager.getService(project, ReformatTestcase::class.java)
         val removeSurroundingWhitespaces = ServiceManager.getService(project, RemoveSurroundingWhitespaces::class.java)
+        val constructorParameters = ServiceManager.getService(project, ConstructorParameters::class.java)
+        val addNewlineBefore = ServiceManager.getService(project, AddNewlineBefore::class.java)
+        val removeWhitespaceBeforeConstruct = ServiceManager.getService(project, RemoveWhitespaceBeforeConstruct::class.java)
+        val existingMocks = ServiceManager.getService(project, ExistingMocks::class.java)
         val settings = ServiceManager.getService(Settings::class.java)
 
         // actually create mocks
         var currentAnchor = beginningOfClass
         var nonPrimitiveMocked = false
+        val allParameters = constructorParameters.get(psiElement)
+        val parametersWithoutMocks = allParameters.filter { parameter -> existingMocks.filter(parameter, clazz) }
 
-        for (parameter in parameters) {
+        removeWhitespaceBeforeConstruct.invoke(constructStatement)
+
+        for (parameter in parametersWithoutMocks) {
             nonPrimitiveMocked = addMissingUseStatements.invoke(namespace, parameter.type.toString()) || nonPrimitiveMocked
             addMockAssignment.invoke(project, constructStatement, parameter)
 
@@ -71,21 +73,9 @@ class QuickMockCreator : PsiElementBaseIntentionAction(), IntentionAction {
             addMissingUseStatements.invoke(namespace, "\\Prophecy\\Prophecy\\ObjectProphecy")
         }
 
-        addWhitespaceBetweenMockAssignmentsAnConstructor(constructStatement, project)
+        addNewlineBefore.invoke(constructStatement, project)
         removeSurroundingWhitespaces.invoke(parameterList)
-        addArguments.invoke(parameterList, parameters, project)
+        addArguments.invoke(parameterList, allParameters, project)
         reformatTestcase.invoke(project, currentAnchor, clazz)
     }
-
-    private fun addWhitespaceBetweenMockAssignmentsAnConstructor(constructStatement: PsiElement, project: Project) {
-        val currentMethod = constructStatement.parent
-        currentMethod.addBefore(PhpPsiElementFactory.createFromText(project, PsiWhiteSpace::class.java, "\n")!!, constructStatement)
-    }
-
-    private fun getConstructorParameters(psiElementAtCursor: PsiElement): MutableList<Parameter> {
-        val newExpression = PsiTreeUtil.getParentOfType(psiElementAtCursor, NewExpression::class.java) as NewExpression
-        val classReference = newExpression.classReference
-        val method = classReference?.resolve() as Method
-        return method.parameters.toMutableList()
-    }
 }

src/main/kotlin/de/cawolf/quickmock/intention/service/AddNewlineBefore.kt

@@ -0,0 +1,13 @@
+package de.cawolf.quickmock.intention.service
+
+import com.intellij.openapi.project.Project
+import com.intellij.psi.PsiElement
+import com.intellij.psi.PsiWhiteSpace
+import com.jetbrains.php.lang.psi.PhpPsiElementFactory
+
+class AddNewlineBefore {
+    fun invoke(psiElement: PsiElement, project: Project) {
+        val currentMethod = psiElement.parent
+        currentMethod.addBefore(PhpPsiElementFactory.createFromText(project, PsiWhiteSpace::class.java, "\n")!!, psiElement)
+    }
+}

src/main/kotlin/de/cawolf/quickmock/intention/service/ConstructorParameters.kt

@@ -0,0 +1,16 @@
+package de.cawolf.quickmock.intention.service
+
+import com.intellij.psi.PsiElement
+import com.intellij.psi.util.PsiTreeUtil
+import com.jetbrains.php.lang.psi.elements.Method
+import com.jetbrains.php.lang.psi.elements.NewExpression
+import com.jetbrains.php.lang.psi.elements.Parameter
+
+class ConstructorParameters {
+    fun get(psiElementAtCursor: PsiElement): MutableList<Parameter> {
+        val newExpression = PsiTreeUtil.getParentOfType(psiElementAtCursor, NewExpression::class.java) as NewExpression
+        val classReference = newExpression.classReference
+        val method = classReference?.resolve() as Method
+        return method.parameters.toMutableList()
+    }
+}

src/main/kotlin/de/cawolf/quickmock/intention/service/ExistingMocks.kt

@@ -0,0 +1,12 @@
+package de.cawolf.quickmock.intention.service
+
+import com.jetbrains.php.lang.psi.elements.Parameter
+import com.jetbrains.php.lang.psi.elements.PhpClass
+
+class ExistingMocks {
+    fun filter(parameter: Parameter, clazz: PhpClass): Boolean {
+        val existingField = clazz.findFieldByName(parameter.name, false)
+        val isPrivate = existingField?.modifier?.isPrivate
+        return isPrivate == null || !isPrivate
+    }
+}

src/main/kotlin/de/cawolf/quickmock/intention/service/RemoveWhitespaceBeforeConstruct.kt

@@ -0,0 +1,12 @@
+package de.cawolf.quickmock.intention.service
+
+import com.intellij.psi.PsiElement
+import com.intellij.psi.PsiWhiteSpace
+
+class RemoveWhitespaceBeforeConstruct {
+    fun invoke(constructStatement: PsiElement) {
+        if (constructStatement.parent.prevSibling is PsiWhiteSpace) {
+            constructStatement.parent.prevSibling.delete()
+        }
+    }
+}

src/main/resources/META-INF/plugin.xml

@@ -40,9 +40,13 @@
         <projectService serviceImplementation="de.cawolf.quickmock.intention.service.AddArguments" />
         <projectService serviceImplementation="de.cawolf.quickmock.intention.service.AddMissingUseStatements" />
         <projectService serviceImplementation="de.cawolf.quickmock.intention.service.AddMockAssignment" />
+        <projectService serviceImplementation="de.cawolf.quickmock.intention.service.AddNewlineBefore" />
         <projectService serviceImplementation="de.cawolf.quickmock.intention.service.AddProperty" />
+        <projectService serviceImplementation="de.cawolf.quickmock.intention.service.ConstructorParameters" />
+        <projectService serviceImplementation="de.cawolf.quickmock.intention.service.ExistingMocks" />
         <projectService serviceImplementation="de.cawolf.quickmock.intention.service.ReformatTestcase" />
         <projectService serviceImplementation="de.cawolf.quickmock.intention.service.RemoveSurroundingWhitespaces" />
+        <projectService serviceImplementation="de.cawolf.quickmock.intention.service.RemoveWhitespaceBeforeConstruct" />
     </extensions>
 
     <depends>com.jetbrains.php</depends>

src/main/resources/intentionDescriptions/QuickMockCreator/before.php.template

@@ -1,4 +1,4 @@
 public function test()
 {
-    $subjectUnderTest = new Subject(<spot></spot>);
+    $subjectUnderTest = <spot>new Subject()</spot>;
 }