#1136 RsStatus

Author: yegor256

src/main/java/org/takes/http/BkBasic.java

@@ -157,7 +157,6 @@ private static Response failure(final Throwable err, final int code) {
      * @param socket Socket
      * @return Request with custom headers
      */
-    @SuppressWarnings("PMD.AvoidDuplicateLiterals")
     private static Request addSocketHeaders(final Request req,
         final Socket socket) {
         return new RqWithHeaders(

src/main/java/org/takes/rs/RsStatus.java

@@ -0,0 +1,88 @@
+/*
+ * The MIT License (MIT)
+ *
+ * Copyright (c) 2014-2022 Yegor Bugayenko
+ *
+ * Permission is hereby granted, free of charge, to any person obtaining a copy
+ * of this software and associated documentation files (the "Software"), to deal
+ * in the Software without restriction, including without limitation the rights
+ * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+ * copies of the Software, and to permit persons to whom the Software is
+ * furnished to do so, subject to the following conditions:
+ *
+ * The above copyright notice and this permission notice shall be included
+ * in all copies or substantial portions of the Software.
+ *
+ * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+ * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+ * FITNESS FOR A PARTICULAR PURPOSE AND NON-INFRINGEMENT. IN NO EVENT SHALL THE
+ * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+ * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+ * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+ * SOFTWARE.
+ */
+package org.takes.rs;
+
+import java.io.IOException;
+import java.util.regex.Matcher;
+import java.util.regex.Pattern;
+import lombok.EqualsAndHashCode;
+import org.takes.Response;
+
+/**
+ * HTTP status of the Response.
+ *
+ * <p>All implementations of this interface must be immutable and thread-safe.
+ *
+ * @since 1.22
+ */
+public interface RsStatus extends Response {
+
+    /**
+     * Get status.
+     * @return Status
+     * @throws IOException If fails
+     */
+    int status() throws IOException;
+
+    /**
+     * Request decorator, for HTTP URI query parsing.
+     *
+     * <p>The class is immutable and thread-safe.
+     *
+     * @since 1.22
+     */
+    @EqualsAndHashCode(callSuper = true)
+    final class Base extends RsWrap implements RsStatus {
+
+        /**
+         * HTTP status line pattern.
+         */
+        private static final Pattern LINE = Pattern.compile(
+            "HTTP/[0-9.]+\\s+([0-9]+)\\s+.*"
+        );
+
+        /**
+         * Ctor.
+         * @param res Original response
+         */
+        public Base(final Response res) {
+            super(res);
+        }
+
+        @Override
+        public int status() throws IOException {
+            final String line = this.head().iterator().next();
+            final Matcher matcher = RsStatus.Base.LINE.matcher(line);
+            if (!matcher.matches()) {
+                throw new IllegalArgumentException(
+                    String.format(
+                        "Invalid status line: '%s'", line
+                    )
+                );
+            }
+            return Integer.parseInt(matcher.group(1));
+        }
+    }
+}
+

src/main/java/org/takes/servlet/HttpServletRequestFake.java

@@ -61,8 +61,7 @@
 @SuppressWarnings({
     "PMD.TooManyMethods",
     "PMD.ExcessiveImports",
-    "PMD.ExcessivePublicCount",
-    "PMD.AvoidDuplicateLiterals"
+    "PMD.ExcessivePublicCount"
 })
 public final class HttpServletRequestFake implements HttpServletRequest {
     /**

src/main/java/org/takes/tk/TkSslOnly.java

@@ -57,7 +57,6 @@ public TkSslOnly(final Take take) {
     }
 
     @Override
-    @SuppressWarnings("PMD.AvoidDuplicateLiterals")
     public Response act(final Request req) throws Exception {
         final String href = new RqHref.Base(req).href().toString();
         final String proto = new RqHeaders.Smart(

src/test/java/org/takes/facets/auth/PsByFlagTest.java

@@ -45,7 +45,7 @@
  * Test case for {@link PsByFlag}.
  * @since 0.10
  */
-@SuppressWarnings("PMD.AvoidDuplicateLiterals") final class PsByFlagTest {
+final class PsByFlagTest {
     /**
      * PsByFlag can skip if nothing found.
      * @throws Exception If some problem inside

src/test/java/org/takes/facets/auth/codecs/CcAesTest.java

@@ -38,7 +38,7 @@
  * Test case for {@link CcAes}.
  * @since 0.13.8
  */
-@SuppressWarnings("PMD.AvoidDuplicateLiterals") final class CcAesTest {
+final class CcAesTest {
     /**
      * CcAes can encrypt identity.
      * @throws Exception If fails

src/test/java/org/takes/facets/auth/signatures/SiHmacTest.java

@@ -32,7 +32,7 @@
  * Test case for {@link SiHmac}.
  * @since 1.3
  */
-@SuppressWarnings("PMD.AvoidDuplicateLiterals") final class SiHmacTest {
+final class SiHmacTest {
     /**
      * SiHmac corrects wrong bit length.
      */

src/test/java/org/takes/facets/fork/FkContentTypeTest.java

@@ -37,7 +37,7 @@
  * Test case for {@link FkContentType}.
  * @since 1.0
  */
-@SuppressWarnings("PMD.AvoidDuplicateLiterals") final class FkContentTypeTest {
+final class FkContentTypeTest {
 
     /**
      * Content-Type header.

src/test/java/org/takes/facets/fork/FkRegexTest.java

@@ -35,7 +35,6 @@
  * Test case for {@link FkRegex}.
  * @since 0.4
  */
-@SuppressWarnings("PMD.AvoidDuplicateLiterals")
 final class FkRegexTest {
 
     /**

src/test/java/org/takes/facets/fork/TkConsumesTest.java

@@ -113,7 +113,6 @@ void failsOnUnsupportedAcceptHeader() {
      * Checks TkConsumes equals method.
      */
     @Test
-    @SuppressWarnings("PMD.AvoidDuplicateLiterals")
     void equalsAndHashCodeEqualTest() {
         final Take take = new TkText("text");
         final String type = "Content-Type: text/plain";

src/test/java/org/takes/misc/HrefTest.java

@@ -34,7 +34,6 @@
  * Test case for {@link Href}.
  * @since 0.7
  */
-@SuppressWarnings("PMD.AvoidDuplicateLiterals")
 final class HrefTest {
 
     /**
@@ -147,7 +146,6 @@ void acceptsNonProperlyEncodedUrl() {
     /**
      * Href can build an URI with fragment.
      */
-    @SuppressWarnings("PMD.AvoidDuplicateLiterals")
     @Test
     void buildsUriWithFragmentAndParams() {
         MatcherAssert.assertThat(
@@ -159,7 +157,6 @@ void buildsUriWithFragmentAndParams() {
     /**
      * Href can build an URI with fragment and no params.
      */
-    @SuppressWarnings("PMD.AvoidDuplicateLiterals")
     @Test
     void buildsUriWithFragmentAndNoParams() {
         MatcherAssert.assertThat(

src/test/java/org/takes/rq/RqFakeTest.java

@@ -37,7 +37,7 @@
  * Test case for {@link RqFake}.
  * @since 0.24
  */
-@SuppressWarnings({"PMD.AvoidUsingHardCodedIP", "PMD.AvoidDuplicateLiterals"})
+@SuppressWarnings("PMD.AvoidUsingHardCodedIP")
 public final class RqFakeTest {
 
     /**

src/test/java/org/takes/rq/RqHrefTest.java

@@ -36,7 +36,7 @@
  * Test case for {@link RqHref.Base}.
  * @since 0.1
  */
-@SuppressWarnings("PMD.AvoidDuplicateLiterals") final class RqHrefTest {
+final class RqHrefTest {
 
     /**
      * RqHref.Base can parse a query.

src/test/java/org/takes/rq/RqSocketTest.java

@@ -38,7 +38,7 @@
  * Test case for {@link RqSocket}.
  * @since 1.0
  */
-@SuppressWarnings({"PMD.AvoidUsingHardCodedIP", "PMD.AvoidDuplicateLiterals"})
+@SuppressWarnings("PMD.AvoidUsingHardCodedIP")
 final class RqSocketTest {
 
     /**

src/test/java/org/takes/rq/RqWithHeaderTest.java

@@ -33,7 +33,7 @@
  * Test case for {@link RqWithHeader}.
  * @since 0.9
  */
-@SuppressWarnings("PMD.AvoidDuplicateLiterals") final class RqWithHeaderTest {
+final class RqWithHeaderTest {
 
     /**
      * RqWithHeader can add a header.

src/test/java/org/takes/rq/RqWithHeadersTest.java

@@ -37,7 +37,7 @@
  * Test case for {@link RqWithHeaders}.
  * @since 1.0
  */
-@SuppressWarnings("PMD.AvoidDuplicateLiterals") final class RqWithHeadersTest {
+final class RqWithHeadersTest {
 
     /**
      * RqWithHeaders can add headers.

src/test/java/org/takes/rq/multipart/RqMtFakeTest.java

@@ -45,7 +45,7 @@
  * Test case for {@link RqMtFake}.
  * @since 0.33
  */
-@SuppressWarnings({"PMD.AvoidDuplicateLiterals", "PMD.TooManyMethods"})
+@SuppressWarnings("PMD.TooManyMethods")
 final class RqMtFakeTest {
     /**
      * Format string for {@code Content-Length} header.

src/test/java/org/takes/rs/RsBodyPrintTest.java

@@ -33,7 +33,7 @@
  * Test case for {@link RsBodyPrint}.
  * @since 1.19
  */
-@SuppressWarnings("PMD.AvoidDuplicateLiterals") final class RsBodyPrintTest {
+final class RsBodyPrintTest {
 
     @Test
     void simple() throws IOException {

src/test/java/org/takes/rs/RsPrettyJsonTest.java

@@ -38,7 +38,6 @@
  * Test case for {@link RsPrettyJson}.
  * @since 1.0
  */
-@SuppressWarnings("PMD.AvoidDuplicateLiterals")
 final class RsPrettyJsonTest {
 
     /**

src/test/java/org/takes/rs/RsPrintTest.java

@@ -36,7 +36,6 @@
  * Test case for {@link RsPrint}.
  * @since 1.19
  */
-@SuppressWarnings("PMD.AvoidDuplicateLiterals")
 final class RsPrintTest {
 
     /**

src/test/java/org/takes/rs/RsStatusTest.java

@@ -0,0 +1,45 @@
+/*
+ * The MIT License (MIT)
+ *
+ * Copyright (c) 2014-2022 Yegor Bugayenko
+ *
+ * Permission is hereby granted, free of charge, to any person obtaining a copy
+ * of this software and associated documentation files (the "Software"), to deal
+ * in the Software without restriction, including without limitation the rights
+ * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+ * copies of the Software, and to permit persons to whom the Software is
+ * furnished to do so, subject to the following conditions:
+ *
+ * The above copyright notice and this permission notice shall be included
+ * in all copies or substantial portions of the Software.
+ *
+ * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+ * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+ * FITNESS FOR A PARTICULAR PURPOSE AND NON-INFRINGEMENT. IN NO EVENT SHALL THE
+ * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+ * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+ * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+ * SOFTWARE.
+ */
+package org.takes.rs;
+
+import java.io.IOException;
+import org.hamcrest.MatcherAssert;
+import org.hamcrest.Matchers;
+import org.junit.jupiter.api.Test;
+
+/**
+ * Test case for {@link RsStatus}.
+ * @since 1.22
+ */
+final class RsStatusTest {
+
+    @Test
+    void readsStatusCode() throws IOException {
+        final int status = 200;
+        MatcherAssert.assertThat(
+            new RsStatus.Base(new RsWithStatus(new RsEmpty(), status)).status(),
+            Matchers.equalTo(status)
+        );
+    }
+}

src/test/java/org/takes/rs/xe/XeWhenTest.java

@@ -36,7 +36,6 @@
  * Test case for {@link XeWhen}.
  * @since 0.13
  */
-@SuppressWarnings("PMD.AvoidDuplicateLiterals")
 final class XeWhenTest {
 
     /**

src/test/java/org/takes/servlet/HttpServletResponseFakeTest.java

@@ -41,7 +41,6 @@
  *
  * @since 1.14
  */
-@SuppressWarnings("PMD.AvoidDuplicateLiterals")
 final class HttpServletResponseFakeTest {
     /**
      * Set-Cookie header name.

src/test/java/org/takes/tk/TkGzipTest.java

@@ -46,7 +46,6 @@
  * Test case for {@link TkGzip}.
  * @since 0.17
  */
-@SuppressWarnings("PMD.AvoidDuplicateLiterals")
 final class TkGzipTest {
 
     /**

src/test/java/org/takes/tk/TkHtmlTest.java

@@ -39,7 +39,6 @@
  * Test case for {@link TkHtml}.
  * @since 0.10
  */
-@SuppressWarnings("PMD.AvoidDuplicateLiterals")
 final class TkHtmlTest {
 
     /**

src/test/java/org/takes/tk/TkRedirectTest.java

@@ -36,7 +36,7 @@
  * Test case for {@link TkRedirect}.
  * @since 0.10
  */
-@SuppressWarnings("PMD.AvoidDuplicateLiterals") final class TkRedirectTest {
+final class TkRedirectTest {
     /**
      * Constant variable for HTTP header testing.
      */

src/test/java/org/takes/tk/TkSmartRedirectTest.java

@@ -32,7 +32,6 @@
  * Test case for {@link TkSmartRedirect}.
  * @since 0.10
  */
-@SuppressWarnings("PMD.AvoidDuplicateLiterals")
 final class TkSmartRedirectTest {
     /**
      * TkRedirect should carry on the query and the fragment.

src/test/java/org/takes/tk/TkTextTest.java

@@ -39,7 +39,6 @@
  * Test case for {@link TkText}.
  * @since 0.4
  */
-@SuppressWarnings("PMD.AvoidDuplicateLiterals")
 final class TkTextTest {
 
     /**