[Core] Look up docstring converter by type as fallback

Fixes: #2458
cucumber · Jan 7, 2022 · 47bdb92 · 47bdb92
1 parent 0364976
commit 47bdb92
Show file tree

Hide file tree

Showing 7 changed files with 176 additions and 173 deletions.
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -16,6 +16,7 @@ and this project adheres to [Semantic Versioning](http://semver.org/).
 ### Removed
 
 ### Fixed
+* [Core] Look up docstring converter by type as fallback ([#2459](https://github.com/cucumber/cucumber-jvm/pull/2459) M.P. Korstanje)
 
 ## [7.2.1] (2022-01-04)
 

diff --git a/core/src/main/java/io/cucumber/core/stepexpression/DocStringArgument.java b/core/src/main/java/io/cucumber/core/stepexpression/DocStringArgument.java
@@ -2,15 +2,17 @@
 
 import io.cucumber.docstring.DocString;
 
+import static java.util.Objects.requireNonNull;
+
 public final class DocStringArgument implements Argument {
 
     private final DocStringTransformer<?> docStringType;
     private final String content;
     private final String contentType;
 
     DocStringArgument(DocStringTransformer<?> docStringType, String content, String contentType) {
-        this.docStringType = docStringType;
-        this.content = content;
+        this.docStringType = requireNonNull(docStringType);
+        this.content = requireNonNull(content);
         this.contentType = contentType;
     }
 

diff --git a/core/src/main/java/io/cucumber/core/stepexpression/StepExpression.java b/core/src/main/java/io/cucumber/core/stepexpression/StepExpression.java
@@ -6,16 +6,18 @@
 import java.util.ArrayList;
 import java.util.List;
 
+import static java.util.Objects.requireNonNull;
+
 public final class StepExpression {
 
     private final Expression expression;
     private final DocStringTransformer<?> docStringType;
     private final RawTableTransformer<?> tableType;
 
     StepExpression(Expression expression, DocStringTransformer<?> docStringType, RawTableTransformer<?> tableType) {
-        this.expression = expression;
-        this.docStringType = docStringType;
-        this.tableType = tableType;
+        this.expression = requireNonNull(expression);
+        this.docStringType = requireNonNull(docStringType);
+        this.tableType = requireNonNull(tableType);
     }
 
     public Class<? extends Expression> getExpressionType() {

diff --git a/docstring/src/main/java/io/cucumber/docstring/DocStringTypeRegistry.java b/docstring/src/main/java/io/cucumber/docstring/DocStringTypeRegistry.java
@@ -51,15 +51,16 @@ private static String emptyToAnonymous(String contentType) {
     }
 
     List<DocStringType> lookup(String contentType, Type type) {
-        if (contentType == null) {
-            return lookUpByType(type);
+        DocStringType docStringType = lookupByContentTypeAndType(orDefault(contentType), type);
+        if (docStringType != null) {
+            return Collections.singletonList(docStringType);
         }
 
-        DocStringType docStringType = lookupByContentTypeAndType(contentType, type);
-        if (docStringType == null) {
-            return Collections.emptyList();
-        }
-        return Collections.singletonList(docStringType);
+        return lookUpByType(type);
+    }
+
+    private String orDefault(String contentType) {
+        return contentType == null ? DEFAULT_CONTENT_TYPE : contentType;
     }
 
     private List<DocStringType> lookUpByType(Type type) {

diff --git a/docstring/src/main/java/io/cucumber/docstring/DocStringTypeRegistryDocStringConverter.java b/docstring/src/main/java/io/cucumber/docstring/DocStringTypeRegistryDocStringConverter.java
@@ -39,10 +39,19 @@ public <T> T convert(DocString docString, Type targetType) {
                 targetType.getTypeName()));
         }
         if (docStringTypes.size() > 1) {
+            List<String> suggestedContentTypes = suggestedContentTypes(docStringTypes);
+            if (docString.getContentType() == null) {
+                throw new CucumberDocStringException(format(
+                    "Multiple converters found for type %s, add one of the following content types to your docstring %s",
+                    targetType.getTypeName(),
+                    suggestedContentTypes));
+            }
             throw new CucumberDocStringException(format(
-                "Multiple converters found for type %s, add one of the following content types to your docstring %s",
+                "Multiple converters found for type %s, and the content type '%s' did not match any of the registered types %s. Change the content type of the docstring or register a docstring type for '%s'",
                 targetType.getTypeName(),
-                suggestedContentTypes(docStringTypes)));
+                docString.getContentType(),
+                suggestedContentTypes,
+                docString.getContentType()));
         }
 
         return (T) docStringTypes.get(0).transform(docString.getContent());
@@ -51,12 +60,14 @@ public <T> T convert(DocString docString, Type targetType) {
     private List<String> suggestedContentTypes(List<DocStringType> docStringTypes) {
         return docStringTypes.stream()
                 .map(DocStringType::getContentType)
-                // Can't use the anonymous content type to resolve
-                // the ambiguity.
-                .filter(contentType -> !contentType.isEmpty())
+                .map(DocStringTypeRegistryDocStringConverter::emptyToAnonymous)
                 .sorted()
                 .distinct()
                 .collect(Collectors.toList());
     }
 
+    private static String emptyToAnonymous(String contentType) {
+        return contentType.isEmpty() ? "[anonymous]" : contentType;
+    }
+
 }