Fix handling of invalid tags and migrate deprecated method (#374)

* Fix handling of invalid tags and migrate deprecated method

* Fix handling of invalid tags and migrate deprecated method

* Fix handling of invalid tags for fields

Author: fbenz

pom.xml

@@ -338,6 +338,11 @@
                 <artifactId>commons-lang3</artifactId>
                 <version>3.9</version>
             </dependency>
+            <dependency>
+                <groupId>org.apache.commons</groupId>
+                <artifactId>commons-text</artifactId>
+                <version>1.8</version>
+            </dependency>
             <dependency>
                 <groupId>commons-io</groupId>
                 <artifactId>commons-io</artifactId>

spring-auto-restdocs-json-doclet-jdk9/pom.xml

@@ -26,7 +26,7 @@
         </dependency>
         <dependency>
             <groupId>org.apache.commons</groupId>
-            <artifactId>commons-lang3</artifactId>
+            <artifactId>commons-text</artifactId>
         </dependency>
         <dependency>
             <groupId>junit</groupId>

spring-auto-restdocs-json-doclet-jdk9/src/main/java/capital/scalable/restdocs/jsondoclet/FieldDocumentation.java

@@ -2,7 +2,7 @@
  * #%L
  * Spring Auto REST Docs Json Doclet for JDK9+
  * %%
- * Copyright (C) 2015 - 2019 Scalable Capital GmbH
+ * Copyright (C) 2015 - 2020 Scalable Capital GmbH
  * %%
  * Licensed under the Apache License, Version 2.0 (the "License");
  * you may not use this file except in compliance with the License.
@@ -29,26 +29,31 @@
 import java.util.Optional;
 
 import com.sun.source.doctree.BlockTagTree;
+import com.sun.source.doctree.DocTree;
 import jdk.javadoc.doclet.DocletEnvironment;
 
 public class FieldDocumentation {
 
     private String comment;
     private final Map<String, String> tags = new HashMap<>();
 
+    private void addTag(DocTree tag) {
+        if (tag instanceof BlockTagTree) {
+            tags.put(
+                    cleanupTagName(((BlockTagTree) tag).getTagName()),
+                    cleanupTagValue(tag.toString()));
+        }
+    }
+
     public static FieldDocumentation fromFieldDoc(DocletEnvironment docEnv,
             Element fieldElement) {
         FieldDocumentation fd = new FieldDocumentation();
         fd.comment = cleanupDocComment(docEnv.getElementUtils().getDocComment(fieldElement));
 
-
         Optional.ofNullable(docEnv.getDocTrees().getDocCommentTree(fieldElement))
                 .ifPresent(docCommentTree -> docCommentTree.getBlockTags()
-                        .forEach(tag -> fd.tags.put(
-                                cleanupTagName(((BlockTagTree) tag).getTagName()),
-                                cleanupTagValue(tag.toString()))));
+                        .forEach(tag -> fd.addTag(tag)));
 
         return fd;
     }
-
 }

spring-auto-restdocs-json-doclet-jdk9/src/main/java/capital/scalable/restdocs/jsondoclet/MethodDocumentation.java

@@ -2,7 +2,7 @@
  * #%L
  * Spring Auto REST Docs Json Doclet for JDK9+
  * %%
- * Copyright (C) 2015 - 2019 Scalable Capital GmbH
+ * Copyright (C) 2015 - 2020 Scalable Capital GmbH
  * %%
  * Licensed under the Apache License, Version 2.0 (the "License");
  * you may not use this file except in compliance with the License.
@@ -22,7 +22,7 @@
 import static capital.scalable.restdocs.jsondoclet.DocletUtils.cleanupDocComment;
 import static capital.scalable.restdocs.jsondoclet.DocletUtils.cleanupTagName;
 import static capital.scalable.restdocs.jsondoclet.DocletUtils.cleanupTagValue;
-import static org.apache.commons.lang3.StringEscapeUtils.unescapeJava;
+import static org.apache.commons.text.StringEscapeUtils.unescapeJava;
 
 import javax.lang.model.element.Element;
 import java.util.HashMap;
@@ -54,7 +54,7 @@ public static MethodDocumentation fromMethodDoc(DocletEnvironment docEnv,
                         ParamTree paramTag = (ParamTree) tag;
                         md.parameters.put(paramTag.getName().toString(),
                                 unescapeJava(paramTag.getDescription().toString()));
-                    } else {
+                    } else if (tag instanceof BlockTagTree) {
                         md.tags.put(
                                 cleanupTagName(((BlockTagTree) tag).getTagName()),
                                 unescapeJava(cleanupTagValue(tag.toString())));

spring-auto-restdocs-json-doclet-jdk9/src/test/java/capital/scalable/restdocs/jsondoclet/DocumentedClass.java

@@ -2,7 +2,7 @@
  * #%L
  * Spring Auto REST Docs Json Doclet for JDK9+
  * %%
- * Copyright (C) 2015 - 2019 Scalable Capital GmbH
+ * Copyright (C) 2015 - 2020 Scalable Capital GmbH
  * %%
  * Licensed under the Apache License, Version 2.0 (the "License");
  * you may not use this file except in compliance with the License.
@@ -23,6 +23,8 @@
 
 /**
  * This is a test class. UTF 8 test: 我能吞下玻璃而不伤身体。Árvíztűrő tükörfúrógép
+ *
+ * @ Don't fail on invalid tags
  */
 class DocumentedClass {
     /**
@@ -34,6 +36,8 @@ class DocumentedClass {
 
     /**
      * Path within location
+     *
+     * @ Don't fail on invalid tags
      */
     private BigDecimal path;
 
@@ -54,6 +58,7 @@ public void execute() {
      * @param force true if force (テスト)
      * @title Do initiate (テスト)
      * @deprecated use other method (テスト)
+     * @ Don't fail on invalid tags
      */
     private void initiate(String when, boolean force, int notDocumented) {
     }