Fix combined labels with comments being ignored (#2121)

Author: Vampire

spock-core/src/main/java/org/spockframework/compiler/SpecParser.java

@@ -190,11 +190,33 @@ private void buildBlocks(Method method) throws InvalidSpecCompileException {
     List<Statement> stats = AstUtil.getStatements(method.getAst());
     Block currBlock = method.addBlock(new AnonymousBlock(method));
 
+    String statementLabelToTransplant = null;
     for (Statement stat : stats) {
-      if (stat.getStatementLabel() == null)
+      if (stat.getStatementLabel() == null) {
+        if (statementLabelToTransplant != null) {
+          stat.setStatementLabel(statementLabelToTransplant);
+        }
         currBlock.getAst().add(stat);
-      else
+      } else {
         currBlock = addBlock(method, stat);
+      }
+      // Usually, you have a label on a statement like
+      //
+      // combined:
+      //   x << [1]
+      //
+      // and the label stays on that statement and could be used in later stages of the AST processing.
+      // Especially for "combined" this is essential for proper operation.
+      //
+      // But if the label has a description like
+      //
+      // combined: 'combined with x'
+      //   x << [1]
+      //
+      // then the description is added as "text" to the current block and the whole statement is swallowed.
+      // If the label is needed for further processing like for "combined", this is then missing,
+      // so transplant the label to the following statement which it actually affects.
+      statementLabelToTransplant = (getDescription(stat) == null) ? null : stat.getStatementLabel();
     }
 
     checkIsValidSuccessor(method, BlockParseInfo.METHOD_END,
@@ -215,7 +237,7 @@ private Block addBlock(Method method, Statement stat) throws InvalidSpecCompileE
     String label = stat.getStatementLabel();
 
     for (BlockParseInfo blockInfo: BlockParseInfo.values()) {
-	  	if (!label.equals(blockInfo.toString())) continue;
+      if (!label.equals(blockInfo.toString())) continue;
 
       checkIsValidSuccessor(method, blockInfo, stat.getLineNumber(), stat.getColumnNumber());
       Block block = blockInfo.addNewBlock(method);
@@ -226,9 +248,9 @@ private Block addBlock(Method method, Statement stat) throws InvalidSpecCompileE
         block.getDescriptions().add(description);
 
       return block;
-		}
+    }
 
-		throw new InvalidSpecCompileException(stat, "Unrecognized block label: " + label);
+    throw new InvalidSpecCompileException(stat, "Unrecognized block label: " + label);
   }
 
   private String getDescription(Statement stat) {

spock-specs/src/test/groovy/org/spockframework/smoke/Blocks.groovy

@@ -51,6 +51,8 @@ def m3() {
   and: "and"
   where: ""
   and: z << 1
+  combined: "foo"
+  zz << 2
 }
     """)
 
@@ -69,7 +71,7 @@ def m3() {
     and:
     def m3 = specInfo.features[2]
     m3.blocks*.kind == [SETUP,EXPECT,WHERE]
-    m3.blocks*.texts.flatten() == ["given","and",""]
+    m3.blocks*.texts.flatten() == ["given","and","","foo"]
   }
 
   def "unknown label"() {

spock-specs/src/test/groovy/org/spockframework/smoke/parameterization/DataProviders.groovy

@@ -297,6 +297,29 @@ where: a << b
     ]
   }
 
+  def 'combined label can have a comment'() {
+    when:
+    def results = runner.runSpecBody '''
+      def 'a feature (#a #b)'() {
+        expect:
+        true
+
+        where:
+        a << [3]
+        combined: 'combined'
+        b << [1, 2]
+      }
+    '''
+
+    then:
+    results.testsStartedCount == 1 + 2
+    results.testEvents().started().list().testDescriptor.displayName == [
+      'a feature (#a #b)',
+      'a feature (3 1)',
+      'a feature (3 2)'
+    ]
+  }
+
   @Issue('https://github.com/spockframework/spock/issues/2074')
   def 'multi-assignments can be combined'() {
     when: