refactor: better name for a single query stub response

Author: nergal-perm

pom.xml

@@ -49,7 +49,7 @@
                         <artifactId>qulice-maven-plugin</artifactId>
                         <configuration>
                             <excludes>
-                                <exclude>pmd:/src/main/java/ewc/utilities/testableio/core/ConfiguredResponse.java</exclude>
+                                <exclude>pmd:/src/main/java/ewc/utilities/testableio/core/SingleQueryResponses.java</exclude>
                             </excludes>
                         </configuration>
                     </plugin>

src/main/java/ewc/utilities/testableio/core/ConfigurableResponses.java

@@ -39,7 +39,7 @@ class ConfigurableResponses {
     /**
      * The storage for all the configured responses.
      */
-    private final Map<String, ConfiguredResponse> responses = new HashMap<>();
+    private final Map<String, SingleQueryResponses> responses = new HashMap<>();
 
     /**
      * Returns the next response for the given request.
@@ -65,12 +65,12 @@ public GenericResponse<?> nextResponseFor(final GenericRequest<?> request) {
         return response;
     }
 
-    public void setDefaultResponsesFor(final String query, final ConfiguredResponse response) {
+    public void setDefaultResponsesFor(final String query, final SingleQueryResponses response) {
         this.responses.put(query, response);
     }
 
     public void setResponsesFor(
-        final String client, final String query, final ConfiguredResponse response
+        final String client, final String query, final SingleQueryResponses response
     ) {
         this.responses.put(ConfigurableResponses.responseKeyFor(client, query), response);
     }

src/main/java/ewc/utilities/testableio/core/ConfiguredResponse.java renamed to src/main/java/ewc/utilities/testableio/core/SingleQueryResponses.java

@@ -30,11 +30,14 @@
 import java.util.stream.Stream;
 
 /**
- * This class provides configured responses for all the I/O operations.
+ * This class provides configured responses for a single I/O opersation stub. The responses could
+ * be in a form of a single response or an array of responses. The single response will be returned
+ * forever, while the array of responses will be returned sequentially until it runs out of
+ * responses. In such case, a {@link NoSuchElementException} will be thrown.
  *
  * @since 0.1
  */
-public class ConfiguredResponse {
+public class SingleQueryResponses {
     /**
      * The iterator of configured responses. This iterator is used to provide
      * responses sequentially.
@@ -47,24 +50,43 @@ public class ConfiguredResponse {
      */
     private final String description;
 
-    public ConfiguredResponse(final String name, final GenericResponse<?> value) {
-        this(Stream.generate(() -> value).iterator(), name);
+    /**
+     * Single response constructor. It means that the same response will be returned forever.
+     *
+     * @param stub The short description of this stub instance.
+     * @param value The response to be returned forever.
+     */
+    public SingleQueryResponses(final String stub, final GenericResponse<?> value) {
+        this(Stream.generate(() -> value).iterator(), stub);
     }
 
-    public ConfiguredResponse(final String name, final GenericResponse<?>... values) {
-        this(Arrays.stream(values).iterator(), name);
+    /**
+     * Array of responses constructor. It means that the responses will be returned sequentially
+     * until the array runs out of responses.
+     *
+     * @param stub The short description of this stub instance.
+     * @param values The array of responses to be returned sequentially.
+     */
+    public SingleQueryResponses(final String stub, final GenericResponse<?>... values) {
+        this(Arrays.stream(values).iterator(), stub);
     }
 
-    private ConfiguredResponse(
-        final Iterator<? extends GenericResponse<?>> values, final String name
+    /**
+     * Primary constructor.
+     *
+     * @param values The iterator that returns configured responses sequentially.
+     * @param description The short description of this instance.
+     */
+    private SingleQueryResponses(
+        final Iterator<? extends GenericResponse<?>> values, final String description
     ) {
         this.values = values;
-        this.description = name;
+        this.description = description;
     }
 
     /**
      * Returns the next response in the iterator. If the iterator has no more
-     * responses, a NoSuchElementException will be thrown. If the response
+     * responses, a {@link NoSuchElementException} will be thrown. If the response
      * contains a RuntimeException, it will be thrown immediately.
      *
      * @return The next configured response.

src/test/java/ewc/utilities/testableio/core/ConfigurableResponsesTest.java

@@ -57,22 +57,22 @@ void returnsTheResponseThatCorrespondsToTheRequest() {
         final ConfigurableResponses target = new ConfigurableResponses();
         target.setDefaultResponsesFor(
             "getHomePage",
-            new ConfiguredResponse(
+            new SingleQueryResponses(
                 "home",
                 new GenericResponse<>("Home page", 0, Map.of())
             )
         );
         target.setDefaultResponsesFor(
             "getItemRecommendations",
-            new ConfiguredResponse(
+            new SingleQueryResponses(
                 "recommendations",
                 new GenericResponse<>("Authorization page", 1000, Map.of())
             )
         );
         target.setResponsesFor(
             "12345",
             "getItemRecommendations",
-            new ConfiguredResponse(
+            new SingleQueryResponses(
                 "recommendations",
                 new GenericResponse<>("Recommendations page", 0, Map.of())
             )

src/test/java/ewc/utilities/testableio/core/ConfiguredResponseTest.java renamed to src/test/java/ewc/utilities/testableio/core/SingleQueryResponsesTest.java

@@ -30,16 +30,16 @@
 import org.junit.jupiter.api.Test;
 
 /**
- * Unit-tests for the {@link ConfiguredResponse} class.
+ * Unit-tests for the {@link SingleQueryResponses} class.
  *
  * @since 0.1
  */
-final class ConfiguredResponseTest {
+final class SingleQueryResponsesTest {
     @Test
     void shouldReturnTheSameResponseForeverIfItIsASingleResponse() {
-        final ConfiguredResponse response = new ConfiguredResponse(
+        final SingleQueryResponses response = new SingleQueryResponses(
             "single response",
-            ConfiguredResponseTest.getGenericResponse()
+            SingleQueryResponsesTest.getGenericResponse()
         );
         Assertions.assertThat(response.next())
             .isEqualTo(response.next())
@@ -49,9 +49,9 @@ void shouldReturnTheSameResponseForeverIfItIsASingleResponse() {
 
     @Test
     void shouldReturnJustOneResponseIfItIsAnArrayWithOneElement() {
-        final ConfiguredResponse response = new ConfiguredResponse(
+        final SingleQueryResponses response = new SingleQueryResponses(
             "array with one element",
-            new GenericResponse<?>[] {ConfiguredResponseTest.getGenericResponse()}
+            new GenericResponse<?>[] {SingleQueryResponsesTest.getGenericResponse()}
         );
         Assertions.assertThat(response.next())
             .extracting("contents").isEqualTo("sample response");
@@ -62,7 +62,7 @@ void shouldReturnJustOneResponseIfItIsAnArrayWithOneElement() {
 
     @Test
     void shouldThrowAnExceptionThatIsSetAsAResponse() {
-        final ConfiguredResponse response = new ConfiguredResponse(
+        final SingleQueryResponses response = new SingleQueryResponses(
             "exception response",
             new GenericResponse<>(
                 new ArithmeticException("test exception"),
@@ -77,7 +77,7 @@ void shouldThrowAnExceptionThatIsSetAsAResponse() {
 
     @Test
     void shouldReturnAllTheSpecifiedResponsesInOrder() {
-        final ConfiguredResponse response = new ConfiguredResponse(
+        final SingleQueryResponses response = new SingleQueryResponses(
             "multiple responses",
             new GenericResponse<>("response 1", 0, Map.of()),
             new GenericResponse<>(new ArithmeticException("test exception"), 0, Map.of())