Continue/feature/reference gh

application/src/main/java/org/togetherjava/tjbot/commands/github/GitHubCommand.java

@@ -20,14 +20,14 @@
 import java.util.stream.Stream;
 
 /**
- * Slash command (/github) used to search for an issue in one of the repositories listed in the
- * config. It even comes with auto completion!
+ * Slash command (/github-search) used to search for an issue in one of the repositories listed in
+ * the config. It also auto suggests issues/PRs on trigger.
  */
-public class GitHubCommand extends SlashCommandAdapter {
+public final class GitHubCommand extends SlashCommandAdapter {
     private static final Duration CACHE_EXPIRES_AFTER = Duration.ofMinutes(1);
 
     /**
-     * Compares the getUpdatedAt values.
+     * Compares two GitHub Issues ascending by the time they have been updated at.
      */
     private static final Comparator<GHIssue> GITHUB_ISSUE_TIME_COMPARATOR = (i1, i2) -> {
         try {
@@ -70,7 +70,8 @@ public void onSlashCommand(SlashCommandInteractionEvent event) {
             return;
         }
 
-        reference.findIssue(Integer.parseInt(matcher.group(GitHubReference.ID_GROUP)))
+        int issueId = Integer.parseInt(matcher.group(GitHubReference.ID_GROUP));
+        reference.findIssue(issueId)
             .ifPresentOrElse(issue -> event.replyEmbeds(reference.generateReply(issue)).queue(),
                     () -> event.reply("Could not find the issue you are looking for.")
                         .setEphemeral(true)

application/src/main/java/org/togetherjava/tjbot/commands/github/GitHubReference.java

@@ -27,16 +27,17 @@
  * GitHub Referencing feature. If someone sends #id of an issue (e.g. #207) in specified channel,
  * the bot replies with an embed that contains info on the issue/PR.
  */
-public class GitHubReference extends MessageReceiverAdapter {
+public final class GitHubReference extends MessageReceiverAdapter {
+    static final String ID_GROUP = "id";
+
     /**
-     * The pattern used to determine whether a message is referencing an issue.
+     * The pattern(#123) used to determine whether a message is referencing an issue.
      */
-    protected static final String ID_GROUP = "id";
-    protected static final Pattern ISSUE_REFERENCE_PATTERN =
+    static final Pattern ISSUE_REFERENCE_PATTERN =
             Pattern.compile("#(?<%s>\\d+)".formatted(ID_GROUP));
     private static final int ISSUE_OPEN = Color.green.getRGB();
     private static final int ISSUE_CLOSE = Color.red.getRGB();
-    private static final List<String> months = List.of("Jan", "Feb", "Mar", "Apr", "May", "Jun",
+    private static final List<String> MONTHS = List.of("Jan", "Feb", "Mar", "Apr", "May", "Jun",
             "Jul", "Aug", "Sep", "Oct", "Nov", "Dec");
     private final Config config;
 
@@ -135,7 +136,7 @@ protected MessageEmbed generateReply(GHIssue issue) throws UncheckedIOException
 
             // Format: 9 Oct, 2023
             String dateOfCreation = "%d %s, %d".formatted(createdAt.get(Calendar.DATE),
-                    months.get(createdAt.get(Calendar.MONTH)), createdAt.get(Calendar.YEAR));
+                    MONTHS.get(createdAt.get(Calendar.MONTH)), createdAt.get(Calendar.YEAR));
 
             String footer = "%s • %s • %s".formatted(labels, assignees, dateOfCreation);
 
@@ -166,7 +167,7 @@ private String getUserNameOrThrow(GHUser user) throws UncheckedIOException {
     /**
      * Looks through all of the given repositories for an issue/pr with the given id.
      */
-    protected Optional<GHIssue> findIssue(int id) {
+    Optional<GHIssue> findIssue(int id) {
         return repositories.stream().map(repository -> {
             try {
                 return Optional.of(repository.getIssue(id));
@@ -181,7 +182,7 @@ protected Optional<GHIssue> findIssue(int id) {
     /**
      * All repositories monitored by this instance.
      */
-    protected List<GHRepository> getRepositories() {
+    List<GHRepository> getRepositories() {
         return repositories;
     }
 }

application/src/main/java/org/togetherjava/tjbot/config/Config.java

@@ -318,14 +318,14 @@ public List<String> getBlacklistedFileExtensions() {
     }
 
     /**
-     * The REGEX pattern used to identify the channels that support GitHub issue referencing
+     * The REGEX pattern used to identify the channels that support GitHub issue referencing.
      */
     public String getGitHubReferencingEnabledChannelPattern() {
         return githubReferencingEnabledChannelPattern;
     }
 
     /**
-     * The list of repositories that are searched when referencing a GitHub issue
+     * The list of repositories that are searched when referencing a GitHub issue.
      */
     public List<Long> getGitHubRepositories() {
         return githubRepositories;

database/build.gradle

@@ -7,7 +7,7 @@ var sqliteVersion = "3.44.0.0"
 dependencies {
     implementation 'com.google.code.findbugs:jsr305:3.0.2'
     implementation "org.xerial:sqlite-jdbc:${sqliteVersion}"
-    implementation 'org.flywaydb:flyway-core:10.0.0'
+    implementation 'org.flywaydb:flyway-core:10.1.0'
     implementation "org.jooq:jooq:$jooqVersion"
 
     implementation project(':utils')