Improve addDot (#240)

* Improve addDot

* Added test for improved addDot

* Updated sample application to show improved addDot

* Adopted sample docs to comply with project docs

* Fixed indentation

* Added more unit tests

Author: Josef-Reichardt

samples/java-webmvc/generated-docs/index.html

@@ -804,7 +804,7 @@ <h4 id="_response_fields"><a class="anchor" href="#_response_fields"></a><a clas
 <h4 id="_example_request_response"><a class="anchor" href="#_example_request_response"></a><a class="link" href="#_example_request_response">2.1.5. Example request/response</a></h4>
 <div class="listingblock">
 <div class="content">
-<pre class="highlightjs highlight"><code class="language-bash hljs" data-lang="bash">$ curl 'http://localhost:8080/items/1' -i</code></pre>
+<pre class="highlightjs highlight"><code class="language-bash hljs" data-lang="bash">$ curl 'http://localhost:8080/items/1' -i -X GET</code></pre>
 </div>
 </div>
 <div class="listingblock">
@@ -859,6 +859,22 @@ <h3 id="resources-items-all"><a class="anchor" href="#resources-items-all"></a><
 <div class="paragraph">
 <p>This endpoint really returns all items and that is always 100.</p>
 </div>
+<div class="paragraph">
+<p>Returns list of all items.</p>
+</div>
+<div class="paragraph">
+<p>Use query parameters to filter the list by:</p>
+</div>
+<div class="ulist">
+<ul>
+<li>
+<p>orderNumber</p>
+</li>
+<li>
+<p>type</p>
+</li>
+</ul>
+</div>
 <div class="sect3">
 <h4 id="_authorization_2"><a class="anchor" href="#_authorization_2"></a><a class="link" href="#_authorization_2">2.2.1. Authorization</a></h4>
 <div class="paragraph">
@@ -994,7 +1010,7 @@ <h4 id="_response_fields_2"><a class="anchor" href="#_response_fields_2"></a><a
 <h4 id="_example_request_response_2"><a class="anchor" href="#_example_request_response_2"></a><a class="link" href="#_example_request_response_2">2.2.4. Example request/response</a></h4>
 <div class="listingblock">
 <div class="content">
-<pre class="highlightjs highlight"><code class="language-bash hljs" data-lang="bash">$ curl 'http://localhost:8080/items' -i</code></pre>
+<pre class="highlightjs highlight"><code class="language-bash hljs" data-lang="bash">$ curl 'http://localhost:8080/items' -i -X GET</code></pre>
 </div>
 </div>
 <div class="paragraph">
@@ -1129,7 +1145,7 @@ <h4 id="_example_request"><a class="anchor" href="#_example_request"></a><a clas
 <div class="content">
 <pre class="highlightjs highlight"><code class="language-bash hljs" data-lang="bash">$ curl 'http://localhost:8080/items' -i -X POST \
     -H 'Content-Type: application/json' \
-    -H 'Authorization: Bearer 23d918a4-653f-4e61-9b46-b5e72fd2ba7c' \
+    -H 'Authorization: Bearer 55ad9296-b11a-4713-8370-a6c617d9656a' \
     -d '{"description":"Hot News"}'</code></pre>
 </div>
 </div>
@@ -1366,7 +1382,7 @@ <h4 id="_example_request_2"><a class="anchor" href="#_example_request_2"></a><a
 <div class="content">
 <pre class="highlightjs highlight"><code class="language-bash hljs" data-lang="bash">$ curl 'http://localhost:8080/items/1' -i -X PUT \
     -H 'Content-Type: application/json' \
-    -H 'Authorization: Bearer 23d918a4-653f-4e61-9b46-b5e72fd2ba7c' \
+    -H 'Authorization: Bearer 55ad9296-b11a-4713-8370-a6c617d9656a' \
     -d '{"description":"Hot News"}'</code></pre>
 </div>
 </div>
@@ -1472,7 +1488,7 @@ <h4 id="_example_request_3"><a class="anchor" href="#_example_request_3"></a><a
 <div class="listingblock">
 <div class="content">
 <pre class="highlightjs highlight"><code class="language-bash hljs" data-lang="bash">$ curl 'http://localhost:8080/items/1' -i -X DELETE \
-    -H 'Authorization: Bearer 23d918a4-653f-4e61-9b46-b5e72fd2ba7c'</code></pre>
+    -H 'Authorization: Bearer 55ad9296-b11a-4713-8370-a6c617d9656a'</code></pre>
 </div>
 </div>
 </div>
@@ -1682,7 +1698,7 @@ <h4 id="_response_fields_6"><a class="anchor" href="#_response_fields_6"></a><a
 <h4 id="_example_request_4"><a class="anchor" href="#_example_request_4"></a><a class="link" href="#_example_request_4">2.6.6. Example request</a></h4>
 <div class="listingblock">
 <div class="content">
-<pre class="highlightjs highlight"><code class="language-bash hljs" data-lang="bash">$ curl 'http://localhost:8080/items/1/child-1' -i</code></pre>
+<pre class="highlightjs highlight"><code class="language-bash hljs" data-lang="bash">$ curl 'http://localhost:8080/items/1/child-1' -i -X GET</code></pre>
 </div>
 </div>
 </div>
@@ -1909,7 +1925,7 @@ <h4 id="_response_fields_7"><a class="anchor" href="#_response_fields_7"></a><a
 <h4 id="_example_request_5"><a class="anchor" href="#_example_request_5"></a><a class="link" href="#_example_request_5">2.7.6. Example request</a></h4>
 <div class="listingblock">
 <div class="content">
-<pre class="highlightjs highlight"><code class="language-bash hljs" data-lang="bash">$ curl 'http://localhost:8080/items/search?desc=main&amp;hint=1' -i</code></pre>
+<pre class="highlightjs highlight"><code class="language-bash hljs" data-lang="bash">$ curl 'http://localhost:8080/items/search?desc=main&amp;hint=1' -i -X GET</code></pre>
 </div>
 </div>
 </div>
@@ -1961,25 +1977,25 @@ <h4 id="_example_response_5"><a class="anchor" href="#_example_response_5"></a><
       "sorted" : false,
       "unsorted" : true
     },
-    "offset" : 0,
     "pageSize" : 20,
     "pageNumber" : 0,
+    "offset" : 0,
     "paged" : true,
     "unpaged" : false
   },
   "total" : 1,
-  "totalElements" : 1,
   "totalPages" : 1,
+  "totalElements" : 1,
   "last" : true,
-  "size" : 20,
-  "number" : 0,
-  "numberOfElements" : 1,
+  "first" : true,
   "sort" : {
     "orders" : [ ],
     "sorted" : false,
     "unsorted" : true
   },
-  "first" : true
+  "numberOfElements" : 1,
+  "size" : 20,
+  "number" : 0
 }</code></pre>
 </div>
 </div>
@@ -2471,7 +2487,7 @@ <h4 id="_path_parameters_11"><a class="anchor" href="#_path_parameters_11"></a><
 </thead>
 <tbody>
 <tr>
-<td class="tableblock halign-left valign-top"><p class="tableblock"><code>id</code></p></td>
+<td class="tableblock halign-left valign-top"><p class="tableblock"><code>+id+</code></p></td>
 <td class="tableblock halign-left valign-top"><p class="tableblock">ID of the item.</p></td>
 </tr>
 </tbody>
@@ -2494,8 +2510,8 @@ <h4 id="_response_fields_12"><a class="anchor" href="#_response_fields_12"></a><
 </thead>
 <tbody>
 <tr>
-<td class="tableblock halign-left valign-top"><p class="tableblock"><code>id</code></p></td>
-<td class="tableblock halign-left valign-top"><p class="tableblock"><code>String</code></p></td>
+<td class="tableblock halign-left valign-top"><p class="tableblock"><code>+id+</code></p></td>
+<td class="tableblock halign-left valign-top"><p class="tableblock"><code>+String+</code></p></td>
 <td class="tableblock halign-left valign-top"><p class="tableblock">There are more fields but only the ID field is documented.</p></td>
 </tr>
 </tbody>
@@ -2505,7 +2521,7 @@ <h4 id="_response_fields_12"><a class="anchor" href="#_response_fields_12"></a><
 <h4 id="_example_request_response_3"><a class="anchor" href="#_example_request_response_3"></a><a class="link" href="#_example_request_response_3">2.12.4. Example request/response</a></h4>
 <div class="listingblock">
 <div class="content">
-<pre class="highlightjs highlight"><code class="language-bash hljs" data-lang="bash">$ curl 'http://localhost:8080/items/1' -i</code></pre>
+<pre class="highlightjs highlight"><code class="language-bash hljs" data-lang="bash">$ curl 'http://localhost:8080/items/1' -i -X GET</code></pre>
 </div>
 </div>
 <div class="listingblock">
@@ -2554,11 +2570,11 @@ <h4 id="_example_request_response_3"><a class="anchor" href="#_example_request_r
 </div>
 <div id="footer">
 <div id="footer-text">
-Last updated 2018-03-29 11:51:15 CEST
+Last updated 2018-06-15 10:19:16 MESZ
 </div>
 </div>
 <link rel="stylesheet" href="https://cdnjs.cloudflare.com/ajax/libs/highlight.js/9.12.0/styles/github.min.css">
 <script src="https://cdnjs.cloudflare.com/ajax/libs/highlight.js/9.12.0/highlight.min.js"></script>
 <script>hljs.initHighlighting()</script>
 </body>
-</html>
+</html>

samples/java-webmvc/src/main/asciidoc/items.adoc

@@ -40,6 +40,8 @@ As AsciiDoc is used, any additional information can be placed here and you don't
 
 This endpoint really returns all items and that is always 100.
 
+include::{snippets}/item-resource-test/get-all-items/auto-description.adoc[]
+
 ==== Authorization
 
 include::{snippets}/item-resource-test/get-all-items/auto-authorization.adoc[]

samples/java-webmvc/src/main/java/capital/scalable/restdocs/example/items/ItemResource.java

@@ -92,9 +92,13 @@ public ItemResponse getItem(@PathVariable("id") @Id String id) {
     }
 
     /**
-     * Lists all items.
+     * Returns list of all items.
      * <p>
-     * An example of retuning an array/collection.
+     * Use query parameters to filter the list by:
+     * <ul>
+     * <li>orderNumber</li>
+     * <li>type</li>
+     * </ul>
      *
      * @return list of all items
      */

spring-auto-restdocs-core/src/main/java/capital/scalable/restdocs/util/FormatUtil.java

@@ -39,7 +39,7 @@ public static String collectionToString(Collection<?> c) {
     }
 
     public static String addDot(String text) {
-        return isNotBlank(text) && !text.endsWith(".") && !text.endsWith(" ")
+        return isNotBlank(text) && !text.matches("^(?s).*(?:[.?!:;)\"]|</(?:p|ul|ol)>)\\s*$") && !text.endsWith(" ")
                 ? text + "."
                 : text;
     }

spring-auto-restdocs-core/src/test/java/capital/scalable/restdocs/util/FormatUtilTest.java

@@ -44,6 +44,21 @@ public void addDot() {
         assertThat(FormatUtil.addDot("."), is("."));
         assertThat(FormatUtil.addDot("text."), is("text."));
         assertThat(FormatUtil.addDot("text"), is("text."));
+        assertThat(FormatUtil.addDot("text?"), is("text?"));
+        assertThat(FormatUtil.addDot("text!"), is("text!"));
+        assertThat(FormatUtil.addDot("text:"), is("text:"));
+        assertThat(FormatUtil.addDot("text;"), is("text;"));
+        assertThat(FormatUtil.addDot("text)"), is("text)"));
+        assertThat(FormatUtil.addDot("text\""), is("text\""));
+        assertThat(FormatUtil.addDot("text+"), is("text+."));
+        assertThat(FormatUtil.addDot("text with html:\n<ul>\n<li>first</li>\n<li>second</li>\n</ul>"),
+                is("text with html:\n<ul>\n<li>first</li>\n<li>second</li>\n</ul>"));
+        assertThat(FormatUtil.addDot("text with html:\r\n<ul>\r\n<li>first</li>\r\n<li>second</li>\r\n</ul>"),
+                is("text with html:\r\n<ul>\r\n<li>first</li>\r\n<li>second</li>\r\n</ul>"));
+        assertThat(FormatUtil.addDot("text with html:\r\n<ol>\r\n<li>first</li>\r\n<li>second</li>\r\n</ol>"),
+                is("text with html:\r\n<ol>\r\n<li>first</li>\r\n<li>second</li>\r\n</ol>"));
+        assertThat(FormatUtil.addDot("text with html:\r\n<p>another paragraph</p>"),
+                is("text with html:\r\n<p>another paragraph</p>"));
     }
 
     @Test