Merge pull request #32 from tracehubpm/token-fix

feat(#2): transformed reviews with comments, class renames

pom.xml

@@ -428,7 +428,7 @@ SOFTWARE.
                         <limit>
                           <counter>INSTRUCTION</counter>
                           <value>COVEREDRATIO</value>
-                          <minimum>0.27</minimum>
+                          <minimum>0.24</minimum>
                         </limit>
                         <limit>
                           <counter>LINE</counter>
@@ -443,12 +443,12 @@ SOFTWARE.
                         <limit>
                           <counter>COMPLEXITY</counter>
                           <value>COVEREDRATIO</value>
-                          <minimum>0.47</minimum>
+                          <minimum>0.38</minimum>
                         </limit>
                         <limit>
                           <counter>METHOD</counter>
                           <value>COVEREDRATIO</value>
-                          <minimum>0.47</minimum>
+                          <minimum>0.38</minimum>
                         </limit>
                         <limit>
                           <counter>CLASS</counter>

src/main/java/git/tracehub/codereview/action/Entry.java

@@ -25,20 +25,18 @@
 
 import com.jcabi.github.Coordinates;
 import com.jcabi.github.Pull;
-import com.jcabi.github.Repo;
 import com.jcabi.github.RtGithub;
 import com.jcabi.log.Logger;
-import git.tracehub.codereview.action.github.Authored;
+import git.tracehub.codereview.action.github.EventPull;
+import git.tracehub.codereview.action.github.FixedReviews;
 import git.tracehub.codereview.action.github.GhRequest;
-import git.tracehub.codereview.action.github.JsonComments;
-import git.tracehub.codereview.action.github.PullRequest;
-import git.tracehub.codereview.action.github.ReviewIds;
-import git.tracehub.codereview.action.github.Reviews;
+import git.tracehub.codereview.action.github.JsonReviews;
+import git.tracehub.codereview.action.github.WithComments;
 import java.io.StringReader;
 import java.nio.file.Files;
 import java.nio.file.Paths;
-import java.util.List;
 import javax.json.Json;
+import javax.json.JsonArray;
 import javax.json.JsonObject;
 
 /**
@@ -65,9 +63,6 @@ public final class Entry {
      *  After information is collected (pull request itself, its files,
      *  and reviews) we can feed it into the model asking what is the quality
      *  of the following code review.
-     * @todo #2:30min Fetch all the info about pull request we are working with.
-     *  We should fetch all useful information about pull request that we are dealing with:
-     *  title, files (changes), and its author. Let's present this data in JSON/XML format.
      * @todo #2:30min Formulate action stoppers.
      *  We should formulate some action stoppers that would not "go further"
      *  into processing if: pull request is too small (we need a specific number),
@@ -88,24 +83,24 @@ public static void main(final String... args) throws Exception {
         ).readObject();
         Logger.info(Entry.class, "event received %s", event.toString());
         final String token = System.getenv().get("INPUT_GITHUB_TOKEN");
-        final Repo repo = new RtGithub(token)
-            .repos()
-            .get(new Coordinates.Simple(name));
-        final Pull pull = new PullRequest(repo, event).value();
-        Logger.info(Entry.class, "pull request found: %s", pull);
-        new ReviewIds(new Reviews(pull, new GhRequest(token))).value()
-            .forEach(
-                review -> {
-                    final List<String> comments = new Authored(
-                        new JsonComments(new GhRequest(token), pull, review)
-                    ).value();
-                    Logger.info(
-                        Entry.class,
-                        "found comments for review #%s: %s",
-                        review,
-                        comments
-                    );
-                }
-            );
+        final Pull.Smart pull = new Pull.Smart(
+            new EventPull(
+                new RtGithub(token).repos().get(new Coordinates.Simple(name)),
+                event
+            ).value()
+        );
+        final String title = pull.title();
+        Logger.info(
+            Entry.class,
+            "pull request found: #%s '%s'",
+            pull.number(),
+            title
+        );
+        final JsonArray reviews = new WithComments(
+            new FixedReviews(new JsonReviews(pull, new GhRequest(token))),
+            new GhRequest(token),
+            pull
+        ).value();
+        Logger.info(Entry.class, "found reviews: %s", reviews);
     }
 }

src/main/java/git/tracehub/codereview/action/github/Authored.java

@@ -23,19 +23,19 @@
  */
 package git.tracehub.codereview.action.github;
 
-import java.util.List;
+import javax.json.Json;
+import javax.json.JsonArray;
+import javax.json.JsonArrayBuilder;
 import lombok.RequiredArgsConstructor;
 import lombok.SneakyThrows;
-import org.cactoos.Scalar;
-import org.cactoos.list.ListOf;
 
 /**
  * All review comment bodies together with its author.
  *
  * @since 0.0.0
  */
 @RequiredArgsConstructor
-public final class Authored implements Scalar<List<String>> {
+public final class Authored implements Comments {
 
     /**
      * Comments.
@@ -44,10 +44,10 @@ public final class Authored implements Scalar<List<String>> {
 
     @Override
     @SneakyThrows
-    public List<String> value() {
-        final List<String> bodies = new ListOf<>();
+    public JsonArray value() {
+        final JsonArrayBuilder builder = Json.createArrayBuilder();
         this.origin.value().forEach(
-            value -> bodies.add(
+            value -> builder.add(
                 String.format(
                     "%s: %s",
                     value.asJsonObject()
@@ -57,6 +57,6 @@ public List<String> value() {
                 )
             )
         );
-        return bodies;
+        return builder.build();
     }
 }

src/main/java/git/tracehub/codereview/action/github/PullRequest.java → src/main/java/git/tracehub/codereview/action/github/EventPull.java

@@ -36,7 +36,7 @@
  * @since 0.0.0
  */
 @RequiredArgsConstructor
-public final class PullRequest implements Scalar<Pull> {
+public final class EventPull implements Scalar<Pull> {
 
     /**
      * Repo.

src/main/java/git/tracehub/codereview/action/github/ReviewIds.java → src/main/java/git/tracehub/codereview/action/github/FixedReviews.java

@@ -23,33 +23,36 @@
  */
 package git.tracehub.codereview.action.github;
 
-import java.util.List;
+import javax.json.Json;
 import javax.json.JsonArray;
+import javax.json.JsonArrayBuilder;
 import lombok.RequiredArgsConstructor;
 import org.cactoos.Scalar;
-import org.cactoos.list.ListOf;
 
 /**
  * Identifiers collected from all reviews.
  *
  * @since 0.0.0
  */
 @RequiredArgsConstructor
-public final class ReviewIds implements Scalar<List<Integer>> {
+public final class FixedReviews implements Scalar<JsonArray> {
 
     /**
      * All reviews.
      */
     private final Scalar<JsonArray> reviews;
 
     @Override
-    public List<Integer> value() throws Exception {
-        final List<Integer> identifiers = new ListOf<>();
+    public JsonArray value() throws Exception {
+        final JsonArrayBuilder builder = Json.createArrayBuilder();
         this.reviews.value().forEach(
-            value -> identifiers.add(
-                value.asJsonObject().getInt("id")
+            value -> builder.add(
+                Json.createObjectBuilder()
+                    .add("id", value.asJsonObject().getInt("id"))
+                    .add("body", value.asJsonObject().getString("body"))
+                    .build()
             )
         );
-        return identifiers;
+        return builder.build();
     }
 }

src/main/java/git/tracehub/codereview/action/github/Reviews.java → src/main/java/git/tracehub/codereview/action/github/JsonReviews.java

@@ -37,7 +37,7 @@
  * @since 0.0.0
  */
 @RequiredArgsConstructor
-public final class Reviews implements Scalar<JsonArray> {
+public final class JsonReviews implements Scalar<JsonArray> {
 
     /**
      * Pull request.

src/main/java/git/tracehub/codereview/action/github/WithComments.java

@@ -0,0 +1,77 @@
+/*
+ * The MIT License (MIT)
+ *
+ * Copyright (c) 2024 Tracehub.git
+ *
+ * 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 git.tracehub.codereview.action.github;
+
+import com.jcabi.github.Pull;
+import com.jcabi.http.Request;
+import javax.json.JsonArray;
+import javax.json.JsonObject;
+import lombok.RequiredArgsConstructor;
+import org.cactoos.Scalar;
+
+/**
+ * Reviews with comments.
+ *
+ * @since 0.0.0
+ */
+@RequiredArgsConstructor
+public final class WithComments implements Scalar<JsonArray> {
+
+    /**
+     * Origin.
+     */
+    private final Scalar<JsonArray> origin;
+
+    /**
+     * Request.
+     */
+    private final Scalar<Request> request;
+
+    /**
+     * Pull request.
+     */
+    private final Pull pull;
+
+    @Override
+    public JsonArray value() throws Exception {
+        final JsonArray base = this.origin.value();
+        base.forEach(
+            review -> {
+                final JsonObject json = review.asJsonObject();
+                final int identifier = json.getInt("id");
+                json.put(
+                    "comments",
+                    new Authored(
+                        new JsonComments(
+                            this.request,
+                            this.pull,
+                            identifier
+                        )
+                    ).value()
+                );
+            }
+        );
+        return base;
+    }
+}

src/test/java/git/tracehub/codereview/action/github/AuthoredTest.java

@@ -24,10 +24,9 @@
 package git.tracehub.codereview.action.github;
 
 import java.io.InputStreamReader;
-import java.util.List;
 import javax.json.Json;
+import javax.json.JsonArray;
 import org.cactoos.io.ResourceOf;
-import org.cactoos.list.ListOf;
 import org.hamcrest.MatcherAssert;
 import org.hamcrest.core.IsEqual;
 import org.junit.jupiter.api.Test;
@@ -36,13 +35,12 @@
  * Test case for {@link Authored}.
  *
  * @since 0.0.0
- * @checkstyle StringLiteralsConcatenationCheck (30 lines)
  */
 final class AuthoredTest {
 
     @Test
     void collectsAllComments() throws Exception {
-        final List<String> comments = new Authored(
+        final JsonArray comments = new Authored(
             () -> Json.createReader(
                 new InputStreamReader(
                     new ResourceOf(
@@ -51,12 +49,13 @@ void collectsAllComments() throws Exception {
                 )
             ).readArray()
         ).value();
-        final List<String> expected = new ListOf<>(
-            "h1alexbel: @hizmailovich first comment",
-            "h1alexbel: @hizmailovich second comment",
-            "h1alexbel: @hizmailovich This sentence might be connected with the"
-            + " previous one: \"The subject of this article is caching.\""
-        );
+        final JsonArray expected = Json.createReader(
+            new InputStreamReader(
+                new ResourceOf(
+                    "git/tracehub/codereview/action/github/with-comments.json"
+                ).stream()
+            )
+        ).readArray();
         MatcherAssert.assertThat(
             String.format(
                 "Received comments (%s) do not match with expected (%s)",

src/test/java/git/tracehub/codereview/action/github/PullRequestTest.java → src/test/java/git/tracehub/codereview/action/github/EventPullTest.java

@@ -32,18 +32,18 @@
 import org.junit.jupiter.api.Test;
 
 /**
- * Test case for {@link PullRequest}.
+ * Test case for {@link EventPull}.
  *
  * @since 0.0.0
  */
-final class PullRequestTest {
+final class EventPullTest {
 
     @Test
     void readsJsonPull() throws Exception {
         final Repo repo = new MkGithub().randomRepo();
         final Pull created = repo.pulls().create("test", "master", "master");
         final int expected = created.number();
-        final Pull pull = new PullRequest(
+        final Pull pull = new EventPull(
             repo,
             Json.createObjectBuilder()
                 .add(