Merge pull request #45 from akefirad/GH-0-prepare-for-release

GH-0 cleanup and release v0.1.0

Author: akefirad

README.md

@@ -5,44 +5,41 @@
 [![Downloads](https://img.shields.io/jetbrains/plugin/d/26269-groom.svg)](https://plugins.jetbrains.com/plugin/26269-groom)
 [![codecov](https://codecov.io/gh/akefirad/groom/graph/badge.svg?token=ITYIWY5V29)](https://codecov.io/gh/akefirad/groom)
 
-## Template ToDo list
-- [x] Create a new [IntelliJ Platform Plugin Template][template] project.
-- [x] Get familiar with the [template documentation][template].
-- [x] Adjust the [pluginGroup](./gradle.properties) and [pluginName](./gradle.properties), as well as the [id](./src/main/resources/META-INF/plugin.xml) and [sources package](./src/main/kotlin).
-- [x] Adjust the plugin description in `README` (see [Tips][docs:plugin-description])
-- [x] Review the [Legal Agreements](https://plugins.jetbrains.com/docs/marketplace/legal-agreements.html?from=IJPluginTemplate).
-- [x] [Publish a plugin manually](https://plugins.jetbrains.com/docs/intellij/publishing-plugin.html?from=IJPluginTemplate) for the first time.
-- [x] Set the `26269-groom` in the above README badges. You can obtain it once the plugin is published to JetBrains Marketplace.
-- [x] Set the [Plugin Signing](https://plugins.jetbrains.com/docs/intellij/plugin-signing.html?from=IJPluginTemplate) related [secrets](https://github.com/JetBrains/intellij-platform-plugin-template#environment-variables).
-- [x] Set the [Deployment Token](https://plugins.jetbrains.com/docs/marketplace/plugin-upload.html?from=IJPluginTemplate).
-- [x] Click the <kbd>Watch</kbd> button on the top of the [IntelliJ Platform Plugin Template][template] to be notified about releases containing new features and fixes.
-
 <!-- Plugin description -->
-This a plugin for better Groovy development experience in IntelliJ IDEA. 
+A plugin for better Groovy development experience in IntelliJ IDEA.
 <!-- Plugin description end -->
 
+## Features
+
+- Folding for lists and maps in Groovy code
+- Folding for (Spock) specification labels (e.g. given, when, then, etc.)
+- Highlighting for (Spock) specification labels
+- Inlay hints for implicit assertions in Spock specifications expectation blocks
+
 ## Installation
 
 - Using the IDE built-in plugin system:
-  
+
   <kbd>Settings/Preferences</kbd> > <kbd>Plugins</kbd> > <kbd>Marketplace</kbd> > <kbd>Search for "groom"</kbd> >
   <kbd>Install</kbd>
-  
+
 - Using JetBrains Marketplace:
 
-  Go to [JetBrains Marketplace](https://plugins.jetbrains.com/plugin/26269-groom) and install it by clicking the <kbd>Install to ...</kbd> button in case your IDE is running.
+  Go to [JetBrains Marketplace](https://plugins.jetbrains.com/plugin/26269-groom) and install it by clicking the <kbd>
+  Install to ...</kbd> button in case your IDE is running.
 
-  You can also download the [latest release](https://plugins.jetbrains.com/plugin/26269-groom/versions) from JetBrains Marketplace and install it manually using
+  You can also download the [latest release](https://plugins.jetbrains.com/plugin/26269-groom/versions) from JetBrains
+  Marketplace and install it manually using
   <kbd>Settings/Preferences</kbd> > <kbd>Plugins</kbd> > <kbd>⚙️</kbd> > <kbd>Install plugin from disk...</kbd>
 
 - Manually:
 
   Download the [latest release](https://github.com/akefirad/groom/releases/latest) and install it manually using
   <kbd>Settings/Preferences</kbd> > <kbd>Plugins</kbd> > <kbd>⚙️</kbd> > <kbd>Install plugin from disk...</kbd>
 
-
 ---
 Plugin based on the [IntelliJ Platform Plugin Template][template].
 
 [template]: https://github.com/JetBrains/intellij-platform-plugin-template
+
 [docs:plugin-description]: https://plugins.jetbrains.com/docs/intellij/plugin-user-experience.html#plugin-description-and-presentation

src/main/kotlin/com/akefirad/groom/spock/AssertInlayHintsProvider.kt

@@ -1,6 +1,5 @@
 package com.akefirad.groom.spock
 
-import com.akefirad.groom.spock.SpockSpecUtils.hasAnySpecification
 import com.akefirad.groom.spock.SpockSpecUtils.isSpeckLabel
 import com.intellij.codeInsight.hints.declarative.InlayHintsProvider
 import com.intellij.codeInsight.hints.declarative.InlayTreeSink
@@ -11,6 +10,7 @@ import com.intellij.openapi.editor.Editor
 import com.intellij.openapi.project.PossiblyDumbAware
 import com.intellij.psi.PsiElement
 import com.intellij.psi.PsiFile
+import org.jetbrains.plugins.groovy.lang.psi.GroovyFile
 import org.jetbrains.plugins.groovy.lang.psi.api.statements.blocks.GrClosableBlock
 import org.jetbrains.plugins.groovy.lang.psi.api.statements.blocks.GrOpenBlock
 import org.jetbrains.plugins.groovy.lang.psi.api.statements.expressions.GrAssignmentExpression
@@ -20,14 +20,16 @@ import org.jetbrains.plugins.groovy.lang.psi.api.statements.typedef.members.GrMe
 import org.jetbrains.plugins.groovy.lang.psi.util.isWhiteSpaceOrNewLine
 
 class AssertInlayHintsProvider : InlayHintsProvider, PossiblyDumbAware {
-    override fun createCollector(file: PsiFile, editor: Editor) =
-        if (file.hasAnySpecification()) AssertInlayHintsCollector() else null
+    override fun createCollector(file: PsiFile, editor: Editor): AssertInlayHintsCollector? {
+        // TODO: check if it's an actual test file!
+        return if (file is GroovyFile) AssertInlayHintsCollector() else null
+    }
 }
 
 class AssertInlayHintsCollector : SharedBypassCollector {
 
     override fun collectFromElement(element: PsiElement, sink: InlayTreeSink) {
-        if (element is GrMethod)
+        if (element is GrMethod) // TODO: check if it's a test method!
             collectFromMethod(element, sink)
     }
 

src/main/kotlin/com/akefirad/groom/spock/SpockSpecUtils.kt

@@ -1,12 +1,11 @@
 package com.akefirad.groom.spock
 
-import com.intellij.psi.PsiClass
 import com.intellij.psi.PsiElement
-import org.jetbrains.plugins.groovy.lang.psi.GroovyFile
 import org.jetbrains.plugins.groovy.lang.psi.api.statements.GrLabeledStatement
 import kotlin.contracts.contract
 
 object SpockSpecUtils {
+    /*
     private const val SPOCK_SPEC_CLASS: String = "spock.lang.Specification"
 
     @JvmStatic
@@ -16,16 +15,15 @@ object SpockSpecUtils {
             .any(SpockSpecUtils::hasSpecificationSuperClass)
     }
 
-    /*
     fun PsiElement.isSpecification(): Boolean {
         val clazz = PsiTreeUtil.findFirstParent(this, true) { it is PsiClass }
         return clazz != null && hasSpecificationSuperClass(clazz as PsiClass)
     }
-    */
 
     private fun hasSpecificationSuperClass(clazz: PsiClass) =
         generateSequence(clazz) { it.superClass }
             .any { it.qualifiedName == SPOCK_SPEC_CLASS }
+    */
 
     fun PsiElement.isSpeckLabel(): Boolean {
         contract {

src/test/groovy/com/akefirad/groom/spock/AssertInlayHintsProviderTest.groovy

@@ -26,7 +26,7 @@ class AssertInlayHintsProviderTest extends LightPlatformCodeInsightFixture4TestC
 
     @Test
     void 'provider should provide implicit assert to simple spec'() {
-        def text = """
+        def code = """
             $SpecificationClass
 
             class MySpec extends Specification {
@@ -63,12 +63,12 @@ class AssertInlayHintsProviderTest extends LightPlatformCodeInsightFixture4TestC
                 }
             }
         """.stripIndent()
-        testAnnotations(text)
+        testAnnotations(code)
     }
 
     @Test
     void 'provider should provide implicit assert to simple spec with repeated labels'() {
-        def text = """
+        def code = """
             $SpecificationClass
 
             class MySpec extends Specification {
@@ -125,12 +125,12 @@ class AssertInlayHintsProviderTest extends LightPlatformCodeInsightFixture4TestC
                 }
             }
         """.stripIndent()
-        testAnnotations(text)
+        testAnnotations(code)
     }
 
     @Test
     void 'provider should provide implicit assert'() {
-        def text = """
+        def code = """
             $SpecificationClass
 
             abstract class MyBase {
@@ -212,12 +212,12 @@ class AssertInlayHintsProviderTest extends LightPlatformCodeInsightFixture4TestC
                 }
             }
         """.stripIndent()
-        testAnnotations(text)
+        testAnnotations(code)
     }
 
     @Test
     void 'provider should provide implicit assert when using verifyAll'() {
-        def text = """
+        def code = """
             $SpecificationClass
 
             class MySpec extends Specification {
@@ -250,12 +250,12 @@ class AssertInlayHintsProviderTest extends LightPlatformCodeInsightFixture4TestC
                 }
             }
         """.stripIndent()
-        testAnnotations(text)
+        testAnnotations(code)
     }
 
     @Test
     void 'provider should provide implicit assert when using with'() {
-        def text = """
+        def code = """
             $SpecificationClass
 
             class MySpec extends Specification {
@@ -293,12 +293,12 @@ class AssertInlayHintsProviderTest extends LightPlatformCodeInsightFixture4TestC
                 }
             }
         """.stripIndent()
-        testAnnotations(text)
+        testAnnotations(code)
     }
 
     @Test
     void 'provider should not provide implicit assert when assert is present'() {
-        def text = """
+        def code = """
             $SpecificationClass
 
             class MySpec extends Specification {
@@ -332,11 +332,37 @@ class AssertInlayHintsProviderTest extends LightPlatformCodeInsightFixture4TestC
                 }
             }
         """.stripIndent()
-        testAnnotations(text)
+        testAnnotations(code)
     }
 
-    private void testAnnotations(@Language("Groovy") String text) {
-        doTestProvider("MySpec.groovy", text, new AssertInlayHintsProvider())
+    @Test
+    void 'provider should do nothing when file is not GroovyFile'() {
+        given:
+            def code = '''
+            class SampleSpec extends Specification {
+                void test_method() <fold text='{...}'>{
+                    given: "some given block"
+                    var foo = 'foo';
+            
+                    when: "some when block"
+                    var baz = foo + bar;
+            
+                    then: "some then block"
+                    baz == 'foobar';
+                }</fold>
+            }
+
+            '''.stripIndent()
+
+        when:
+            doTestProvider("MySpec.java", code, new AssertInlayHintsProvider())
+
+        then:
+            true // TODO: How to check it's not folded?
+    }
+
+    private void testAnnotations(@Language("Groovy") String code) {
+        doTestProvider("MySpec.groovy", code, new AssertInlayHintsProvider())
     }
 
     @SuppressWarnings("UnstableApiUsage")