minor: README code formatting

joshka · Nov 29, 2018 · 3a90fdd · 3a90fdd
1 parent ac414e5
commit 3a90fdd
Showing 1 changed file with 104 additions and 100 deletions.
diff --git a/README.md b/README.md
@@ -40,62 +40,64 @@ See [`JsonArgumentsProviderTest`](https://github.com/joshka/junit-json-params/bl
 ```java
 import net.joshka.junit.json.params.JsonSource;
 
-/**
- * When passed <code>{"key":"value"}</code>, is executed a single time
- * @param object the parsed JsonObject
- */
-@ParameterizedTest
-@JsonSource("{\"key\":\"value\"}")
-@DisplayName("provides a single object")
-void singleObject(JsonObject object) {
-    assertThat(object.getString("key")).isEqualTo("value");
-}
-
-/**
- * When passed <code>[{"key":"value1"},{"key","value2"}]</code>, is
- * executed once per element of the array
- * @param object the parsed JsonObject array element
- */
-@ParameterizedTest
-@JsonSource("[{\"key\":\"value1\"},{\"key\":\"value2\"}]")
-@DisplayName("provides an array of objects")
-void arrayOfObjects(JsonObject object) {
-    assertThat(object.getString("key")).startsWith("value");
-}
-
-/**
- * When passed <code>[1, 2]</code>, is executed once per array element
- * @param number the parsed JsonNumber for each array element
- */
-@ParameterizedTest
-@JsonSource("[1,2]")
-@DisplayName("provides an array of numbers")
-void arrayOfNumbers(JsonNumber number) {
-    assertThat(number.intValue()).isGreaterThan(0);
-}
-
-/**
- * When passed <code>["value1","value2"]</code>, is executed once per array
- * element
- * @param string the parsed JsonString for each array element
- */
-@ParameterizedTest
-@JsonSource("[\"value1\",\"value2\"]")
-@DisplayName("provides an array of strings")
-void arrayOfStrings(JsonString string) {
-    assertThat(string.getString()).startsWith("value");
-}
-
-/**
- * When passed <code>{'key':'value'}</code>, is executed a single time.
- * This simplifies writing inline JSON strings
- * @param object the parsed JsonObject
- */
-@ParameterizedTest
-@JsonSource("{'key':'value'}")
-@DisplayName("handles simplified json")
-void simplifiedJson(JsonObject object) {
-    assertThat(object.getString("key")).isEqualTo("value");
+class JsonArgumentsProviderTest {
+    /**
+     * When passed <code>{"key":"value"}</code>, is executed a single time
+     * @param object the parsed JsonObject
+     */
+    @ParameterizedTest
+    @JsonSource("{\"key\":\"value\"}")
+    @DisplayName("provides a single object")
+    void singleObject(JsonObject object) {
+        assertThat(object.getString("key")).isEqualTo("value");
+    }
+
+    /**
+     * When passed <code>[{"key":"value1"},{"key","value2"}]</code>, is
+     * executed once per element of the array
+     * @param object the parsed JsonObject array element
+     */
+    @ParameterizedTest
+    @JsonSource("[{\"key\":\"value1\"},{\"key\":\"value2\"}]")
+    @DisplayName("provides an array of objects")
+    void arrayOfObjects(JsonObject object) {
+        assertThat(object.getString("key")).startsWith("value");
+    }
+
+    /**
+     * When passed <code>[1, 2]</code>, is executed once per array element
+     * @param number the parsed JsonNumber for each array element
+     */
+    @ParameterizedTest
+    @JsonSource("[1,2]")
+    @DisplayName("provides an array of numbers")
+    void arrayOfNumbers(JsonNumber number) {
+        assertThat(number.intValue()).isGreaterThan(0);
+    }
+
+    /**
+     * When passed <code>["value1","value2"]</code>, is executed once per array
+     * element
+     * @param string the parsed JsonString for each array element
+     */
+    @ParameterizedTest
+    @JsonSource("[\"value1\",\"value2\"]")
+    @DisplayName("provides an array of strings")
+    void arrayOfStrings(JsonString string) {
+        assertThat(string.getString()).startsWith("value");
+    }
+
+    /**
+     * When passed <code>{'key':'value'}</code>, is executed a single time.
+     * This simplifies writing inline JSON strings
+     * @param object the parsed JsonObject
+     */
+    @ParameterizedTest
+    @JsonSource("{'key':'value'}")
+    @DisplayName("handles simplified json")
+    void simplifiedJson(JsonObject object) {
+        assertThat(object.getString("key")).isEqualTo("value");
+    }
 }
 ```
 
@@ -108,50 +110,52 @@ See [`JsonFileArgumentsProviderTest`](https://github.com/joshka/junit-json-param
 ```java
 import net.joshka.junit.json.params.JsonFileSource;
 
-/**
- * When passed <code>{"key":"value"}</code>, is executed a single time
- * @param object the parsed JsonObject
- */
-@ParameterizedTest
-@JsonFileSource(resources = "/single-object.json")
-@DisplayName("provides a single object")
-void singleObject(JsonObject object) {
-    assertThat(object.getString("key")).isEqualTo("value");
-}
-
-/**
- * When passed <code>[{"key":"value1"},{"key","value2"}]</code>, is
- * executed once per element of the array
- * @param object the parsed JsonObject array element
- */
-@ParameterizedTest
-@JsonFileSource(resources = "/array-of-objects.json")
-@DisplayName("provides an array of objects")
-void arrayOfObjects(JsonObject object) {
-    assertThat(object.getString("key")).startsWith("value");
-}
-
-/**
- * When passed <code>[1, 2]</code>, is executed once per array element
- * @param number the parsed JsonNumber for each array element
- */
-@ParameterizedTest
-@JsonFileSource(resources = "/array-of-numbers.json")
-@DisplayName("provides an array of numbers")
-void arrayOfNumbers(JsonNumber number) {
-    assertThat(number.intValue()).isGreaterThan(0);
-}
-
-/**
- * When passed <code>["value1","value2"]</code>, is executed once per array
- * element
- * @param string the parsed JsonString for each array element
- */
-@ParameterizedTest
-@JsonFileSource(resources = "/array-of-strings.json")
-@DisplayName("provides an array of strings")
-void arrayOfStrings(JsonString string) {
-    assertThat(string.getString()).startsWith("value");
+class JsonFileArgumentsProviderTest {
+    /**
+     * When passed <code>{"key":"value"}</code>, is executed a single time
+     * @param object the parsed JsonObject
+     */
+    @ParameterizedTest
+    @JsonFileSource(resources = "/single-object.json")
+    @DisplayName("provides a single object")
+    void singleObject(JsonObject object) {
+        assertThat(object.getString("key")).isEqualTo("value");
+    }
+
+    /**
+     * When passed <code>[{"key":"value1"},{"key","value2"}]</code>, is
+     * executed once per element of the array
+     * @param object the parsed JsonObject array element
+     */
+    @ParameterizedTest
+    @JsonFileSource(resources = "/array-of-objects.json")
+    @DisplayName("provides an array of objects")
+    void arrayOfObjects(JsonObject object) {
+        assertThat(object.getString("key")).startsWith("value");
+    }
+
+    /**
+     * When passed <code>[1, 2]</code>, is executed once per array element
+     * @param number the parsed JsonNumber for each array element
+     */
+    @ParameterizedTest
+    @JsonFileSource(resources = "/array-of-numbers.json")
+    @DisplayName("provides an array of numbers")
+    void arrayOfNumbers(JsonNumber number) {
+        assertThat(number.intValue()).isGreaterThan(0);
+    }
+
+    /**
+     * When passed <code>["value1","value2"]</code>, is executed once per array
+     * element
+     * @param string the parsed JsonString for each array element
+     */
+    @ParameterizedTest
+    @JsonFileSource(resources = "/array-of-strings.json")
+    @DisplayName("provides an array of strings")
+    void arrayOfStrings(JsonString string) {
+        assertThat(string.getString()).startsWith("value");
+    }
 }
 ```