Shared samples module (#252)

- `shared` module containing shared `POJOs`, `ConstraintDescriptions`, `SnippetMessages` and overridden `auto-authorization` snippet

Author: jmisur

.gitignore

@@ -17,5 +17,5 @@ target/
 *~
 
 # Gradle
-*/build
-spring-auto-restdocs-example/.gradle
+.gradle/
+build/

.travis.yml

@@ -18,18 +18,13 @@ before_install:
 script:
 - mvn install -B -V
 - cd samples
+- mvn install -B -V
 - cd java-webmvc
-- mvn verify -B
 - ./gradlew check
 - cd ..
 - cd kotlin-webmvc
-- mvn verify -B
 - ./gradlew check
-- cd ..
-- cd java-webtestclient
-- mvn verify -B
-- cd ..
-- cd ..
+- cd ../..
 after_success:
 - test "$TRAVIS_BRANCH" = "master"
   && test "$TRAVIS_PULL_REQUEST" = "false"

docs/index.html

@@ -1900,7 +1900,7 @@ <h4 id="contributing-building-build"><a class="link" href="#contributing-buildin
 <div id="footer">
 <div id="footer-text">
 Version 2.0.2-SNAPSHOT<br>
-Last updated 2018-07-19 08:37:35 MESZ
+    Last updated 2018-08-01 14:58:47 CEST
 </div>
 </div>
 <link rel="stylesheet" href="highlight/styles/github.min.css">

pom.xml

@@ -54,6 +54,8 @@
 
     <properties>
         <java.version>1.8</java.version>
+        <maven.compiler.source>1.8</maven.compiler.source>
+        <maven.compiler.target>1.8</maven.compiler.target>
         <project.build.sourceEncoding>UTF-8</project.build.sourceEncoding>
         <snippetsDirectory>${project.build.directory}/generated-snippets</snippetsDirectory>
         <spring-restdocs.version>2.0.1.RELEASE</spring-restdocs.version>
@@ -85,14 +87,6 @@
                     </execution>
                 </executions>
             </plugin>
-            <plugin>
-                <groupId>org.apache.maven.plugins</groupId>
-                <artifactId>maven-compiler-plugin</artifactId>
-                <configuration>
-                    <source>${java.version}</source>
-                    <target>${java.version}</target>
-                </configuration>
-            </plugin>
             <plugin>
                 <groupId>org.sonatype.plugins</groupId>
                 <artifactId>nexus-staging-maven-plugin</artifactId>

samples/java-webmvc/build.gradle

@@ -54,6 +54,7 @@ dependencies {
     compile "org.springframework.security.oauth:spring-security-oauth2:2.3.0.RELEASE"
     compile "org.springframework.data:spring-data-commons"
     compile "capital.scalable:spring-auto-restdocs-core:$springAutoRestDocsVersion"
+    compile "capital.scalable:spring-auto-restdocs-shared-pojos-example:${project.version}"
     testCompile("org.springframework.boot:spring-boot-starter-test") {
         exclude(module: "commons-logging")
     }

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

@@ -1145,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 55ad9296-b11a-4713-8370-a6c617d9656a' \
+    -H 'Authorization: Bearer f5f4f322-0af7-4c4b-b323-02f6fcf60514' \
     -d '{"description":"Hot News"}'</code></pre>
 </div>
 </div>
@@ -1382,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 55ad9296-b11a-4713-8370-a6c617d9656a' \
+    -H 'Authorization: Bearer f5f4f322-0af7-4c4b-b323-02f6fcf60514' \
     -d '{"description":"Hot News"}'</code></pre>
 </div>
 </div>
@@ -1488,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 55ad9296-b11a-4713-8370-a6c617d9656a'</code></pre>
+    -H 'Authorization: Bearer f5f4f322-0af7-4c4b-b323-02f6fcf60514'</code></pre>
 </div>
 </div>
 </div>
@@ -1977,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
+    "unpaged" : false,
+    "paged" : true
   },
   "total" : 1,
+  "last" : true,
   "totalPages" : 1,
   "totalElements" : 1,
-  "last" : true,
+  "size" : 20,
+  "number" : 0,
+  "numberOfElements" : 1,
   "first" : true,
   "sort" : {
     "orders" : [ ],
     "sorted" : false,
     "unsorted" : true
-  },
-  "numberOfElements" : 1,
-  "size" : 20,
-  "number" : 0
+  }
 }</code></pre>
 </div>
 </div>
@@ -2570,7 +2570,7 @@ <h4 id="_example_request_response_3"><a class="anchor" href="#_example_request_r
 </div>
 <div id="footer">
 <div id="footer-text">
-Last updated 2018-06-15 10:19:16 MESZ
+Last updated 2018-04-10 10:14:19 CEST
 </div>
 </div>
 <link rel="stylesheet" href="https://cdnjs.cloudflare.com/ajax/libs/highlight.js/9.12.0/styles/github.min.css">

samples/java-webmvc/pom.xml

@@ -33,13 +33,20 @@
 
     <properties>
         <java.version>1.8</java.version>
+        <maven.compiler.source>1.8</maven.compiler.source>
+        <maven.compiler.target>1.8</maven.compiler.target>
         <project.build.sourceEncoding>UTF-8</project.build.sourceEncoding>
         <start-class>capital.scalable.restdocs.example.Application</start-class>
         <spring-restdocs.version>2.0.1.RELEASE</spring-restdocs.version>
         <spring-auto-restdocs.version>2.0.2-SNAPSHOT</spring-auto-restdocs.version>
     </properties>
 
     <dependencies>
+        <dependency>
+            <groupId>capital.scalable</groupId>
+            <artifactId>spring-auto-restdocs-shared-pojos-example</artifactId>
+            <version>${project.version}</version>
+        </dependency>
         <dependency>
             <groupId>org.springframework.boot</groupId>
             <artifactId>spring-boot-starter-web</artifactId>

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

@@ -19,7 +19,7 @@
  */
 package capital.scalable.restdocs.example.items;
 
-import static capital.scalable.restdocs.example.items.ItemResponse.EnumType.ONE;
+import static capital.scalable.restdocs.example.items.EnumType.ONE;
 import static java.util.Collections.singletonList;
 
 import javax.validation.Valid;
@@ -31,10 +31,10 @@
 import java.net.URI;
 import java.util.Collections;
 
+import capital.scalable.restdocs.example.common.Money;
+import capital.scalable.restdocs.example.constraints.English;
+import capital.scalable.restdocs.example.constraints.German;
 import capital.scalable.restdocs.example.constraints.Id;
-import capital.scalable.restdocs.example.items.ItemResponse.Attributes;
-import capital.scalable.restdocs.example.items.ItemResponse.Metadata;
-import capital.scalable.restdocs.example.items.ItemResponse.Metadata1;
 import lombok.Data;
 import lombok.Value;
 import org.springframework.data.domain.Page;

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

@@ -19,27 +19,13 @@
  */
 package capital.scalable.restdocs.example.items;
 
-import static com.fasterxml.jackson.annotation.JsonTypeInfo.As.PROPERTY;
-import static com.fasterxml.jackson.annotation.JsonTypeInfo.Id.NAME;
-
 import javax.validation.Valid;
-import javax.validation.constraints.DecimalMax;
-import javax.validation.constraints.DecimalMin;
-import javax.validation.constraints.Max;
-import javax.validation.constraints.Min;
 import javax.validation.constraints.NotBlank;
 import javax.validation.constraints.NotEmpty;
-import javax.validation.constraints.NotNull;
-import javax.validation.constraints.Size;
-import java.math.BigDecimal;
 import java.util.List;
 
 import com.fasterxml.jackson.annotation.JsonIgnore;
-import com.fasterxml.jackson.annotation.JsonSubTypes;
-import com.fasterxml.jackson.annotation.JsonTypeInfo;
 import lombok.AllArgsConstructor;
-import lombok.NoArgsConstructor;
-import lombok.Value;
 
 /**
  * Java object for a single JSON item.
@@ -60,8 +46,7 @@ class ItemResponse {
      * <p>
      * An example of JsonSubType support.
      *
-     * @see
-     * <a href="https://github.com/FasterXML/jackson-annotations/wiki/Jackson-Annotations#type-handling">
+     * @see <a href="https://github.com/FasterXML/jackson-annotations/wiki/Jackson-Annotations#type-handling">
      * Jackson type documentation</a>
      */
     private Metadata meta;
@@ -89,88 +74,4 @@ class ItemResponse {
     public String getDescription() {
         return desc;
     }
-
-    /**
-     * Various attributes about the item.
-     */
-    @Value
-    public static class Attributes {
-        /**
-         * Textual attribute.
-         */
-        @NotBlank
-        @Size(min = 2, max = 20)
-        private String text;
-        /**
-         * Integer attribute.
-         */
-        @NotNull
-        @Min(1)
-        @Max(10)
-        private Integer number;
-        /**
-         * Boolean attribute.
-         */
-        private Boolean bool;
-        /**
-         * Decimal attribute.
-         */
-        @DecimalMin("1")
-        @DecimalMax("10")
-        private BigDecimal decimal;
-        /**
-         * Amount attribute.
-         */
-        @NotNull
-        private Money amount;
-        /**
-         * Enum attribute.
-         */
-        @NotNull
-        private EnumType enumType;
-    }
-
-    @NoArgsConstructor
-    @AllArgsConstructor
-    @JsonTypeInfo(use = NAME, include = PROPERTY, property = "type", visible = true)
-    @JsonSubTypes({
-            @JsonSubTypes.Type(value = Metadata1.class, name = "1"),
-            @JsonSubTypes.Type(value = Metadata2.class, name = "2")
-    })
-    static class Metadata {
-        /**
-         * Determines the type of metadata
-         */
-        @NotBlank
-        private String type;
-    }
-
-    @NoArgsConstructor
-    static class Metadata1 extends Metadata {
-        /**
-         * Tag attribute. Available only if metadata type=1
-         */
-        private String tag;
-
-        Metadata1(String type, String tag) {
-            super(type);
-            this.tag = tag;
-        }
-    }
-
-    static class Metadata2 extends Metadata {
-        /**
-         * Order attribute. Available only if metadata type=2
-         */
-        private Integer order;
-
-        Metadata2(String type, Integer order) {
-            super(type);
-            this.order = order;
-        }
-    }
-
-    enum EnumType {
-        ONE, TWO
-    }
 }

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

@@ -22,6 +22,8 @@
 import javax.validation.constraints.NotBlank;
 import javax.validation.constraints.Size;
 
+import capital.scalable.restdocs.example.constraints.English;
+import capital.scalable.restdocs.example.constraints.German;
 import capital.scalable.restdocs.example.constraints.OneOf;
 import lombok.Data;
 import org.hibernate.validator.constraints.Length;