sahansera · sahansera · Nov 18, 2021 · Nov 18, 2021 · Nov 20, 2021 · Nov 21, 2021
diff --git a/src/main/java/org/kohsuke/github/GHContentSearchBuilder.java b/src/main/java/org/kohsuke/github/GHContentSearchBuilder.java
@@ -48,10 +48,34 @@ public GHContentSearchBuilder language(String v) {
     *            the v
     * @return the gh content search builder
     */
+    // CS427 Issue Link: https://github.com/hub4j/github-api/issues/1154
+    @Deprecated
    public GHContentSearchBuilder fork(String v) {
        return q("fork:" + v);
    }

+    /**
+     * Fork gh content search builder.
+     *
+     * @param fork
+     *            search mode for forks
+     *
+     * @return the gh content search builder
+     *
+     * @see <a href=
+     *      "https://docs.github.com/en/github/searching-for-information-on-github/searching-on-github/searching-in-forks">Searching
+     *      in forks</a>
+     */
+    // CS427 Issue Link: https://github.com/hub4j/github-api/issues/1154
+    public GHContentSearchBuilder fork(GHFork fork) {
+        if (GHFork.PARENT_ONLY.equals(fork)) {
+            this.terms.removeIf(term -> term.contains("fork:"));
+            return this;
+        }
+
+        return q("fork:" + fork);
+    }
+
    /**
     * Size gh content search builder.
     *

diff --git a/src/main/java/org/kohsuke/github/GHFork.java b/src/main/java/org/kohsuke/github/GHFork.java
@@ -0,0 +1,39 @@
+package org.kohsuke.github;
+
+/**
+ * The enum for Fork search mode
+ */
+// CS427 Issue Link: https://github.com/hub4j/github-api/issues/1154
+public enum GHFork {
+
+    /**
+     * Search in the parent repository and in forks with more stars than the parent repository.
+     *
+     * Forks with the same or fewer stars than the parent repository are still ignored.
+     */
+    PARENT_AND_FORKS("true"),
+
+    /**
+     * Search only in forks with more stars than the parent repository.
+     *
+     * The parent repository is ignored. If no forks have more stars than the parent, no results will be returned.
+     */
+    FORKS_ONLY("only"),
+
+    /**
+     * (Default) Search only the parent repository.
+     *
+     * Forks are ignored.
+     */
+    PARENT_ONLY("");
+
+    private String filterMode;
+    GHFork(final String mode) {
+        this.filterMode = mode;
+    }
+
+    @Override
+    public String toString() {
+        return filterMode;
+    }
+}
diff --git a/src/main/java/org/kohsuke/github/GHRepositorySearchBuilder.java b/src/main/java/org/kohsuke/github/GHRepositorySearchBuilder.java
@@ -76,6 +76,8 @@ public GHRepositorySearchBuilder forks(String v) {
     *      in forks</a>
     *
     */
+    // CS427 Issue Link: https://github.com/hub4j/github-api/issues/1154
+    @Deprecated
    public GHRepositorySearchBuilder fork(Fork fork) {
        if (Fork.PARENT_ONLY.equals(fork)) {
            this.terms.removeIf(term -> term.contains("fork:"));
@@ -85,6 +87,40 @@ public GHRepositorySearchBuilder fork(Fork fork) {
        return q("fork:" + fork);
    }

+    /**
+     * Searching in forks
+     *
+     * The default search mode is {@link Fork#PARENT_ONLY}. In that mode, forks are not included in search results.
+     *
+     * <p>
+     * Passing {@link Fork#PARENT_AND_FORKS} or {@link Fork#FORKS_ONLY} will show results from forks, but only if they
+     * have more stars than the parent repository.
+     *
+     * <p>
+     * IMPORTANT: Regardless of this setting, no search results will ever be returned for forks with equal or fewer
+     * stars than the parent repository. Forks with less stars than the parent repository are not included in the index
+     * for code searching.
+     *
+     * @param fork
+     *            search mode for forks
+     *
+     * @return the gh repository search builder
+     *
+     * @see <a href=
+     *      "https://docs.github.com/en/github/searching-for-information-on-github/searching-on-github/searching-in-forks">Searching
+     *      in forks</a>
+     *
+     */
+    // CS427 Issue Link: https://github.com/hub4j/github-api/issues/1154
+    public GHRepositorySearchBuilder fork(GHFork fork) {
+        if (GHFork.PARENT_ONLY.equals(fork)) {
+            this.terms.removeIf(term -> term.contains("fork:"));
+            return this;
+        }
+
+        return q("fork:" + fork);
+    }
+
    /**
     * Search by repository visibility
     *
@@ -217,8 +253,10 @@ public enum Sort {
    }

    /**
-     * The enum for Fork search mode
+     * The enum for Fork search mode. Note: Kept for backward compatibility. Use GHFork instead.
     */
+    // CS427 Issue Link: https://github.com/hub4j/github-api/issues/1154
+    @Deprecated
    public enum Fork {

        /**
@@ -243,10 +281,11 @@ public enum Fork {
        PARENT_ONLY("");

        private String filterMode;
-        Fork(String mode) {
+        Fork(final String mode) {
            this.filterMode = mode;
        }

+        @Override
        public String toString() {
            return filterMode;
        }

diff --git a/src/test/java/org/kohsuke/github/GHRepositoryTest.java b/src/test/java/org/kohsuke/github/GHRepositoryTest.java
@@ -419,12 +419,13 @@ public void listCommitCommentsNoComments() throws IOException {
        assertThat("Commit has no comments", commitComments.isEmpty());
    }

+    // CS427 Issue Link: https://github.com/hub4j/github-api/issues/1154
    @Test
    public void searchAllPublicAndForkedRepos() throws IOException {
        PagedSearchIterable<GHRepository> list = gitHub.searchRepositories()
                .user("t0m4uk1991")
                .visibility(GHRepository.Visibility.PUBLIC)
-                .fork(GHRepositorySearchBuilder.Fork.PARENT_AND_FORKS)
+                .fork(GHFork.PARENT_AND_FORKS)
                .list();
        List<GHRepository> u = list.toList();
        assertThat(u.size(), is(14));
@@ -437,7 +438,7 @@ public void searchForPublicForkedOnlyRepos() throws IOException {
        PagedSearchIterable<GHRepository> list = gitHub.searchRepositories()
                .user("t0m4uk1991")
                .visibility(GHRepository.Visibility.PUBLIC)
-                .fork(GHRepositorySearchBuilder.Fork.FORKS_ONLY)
+                .fork(GHFork.FORKS_ONLY)
                .list();
        List<GHRepository> u = list.toList();
        assertThat(u.size(), is(2));
@@ -464,18 +465,19 @@ public void ghRepositorySearchBuilderIgnoresUnknownVisibility() {
        assertThat(ghRepositorySearchBuilder.terms.stream().filter(item -> item.contains("is:")).count(), is(1L));
    }

+    // CS427 Issue Link: https://github.com/hub4j/github-api/issues/1154
    @Test
    public void ghRepositorySearchBuilderForkDefaultResetForksSearchTerms() {
        GHRepositorySearchBuilder ghRepositorySearchBuilder = new GHRepositorySearchBuilder(gitHub);
-        ghRepositorySearchBuilder = ghRepositorySearchBuilder.fork(GHRepositorySearchBuilder.Fork.PARENT_AND_FORKS);
+        ghRepositorySearchBuilder = ghRepositorySearchBuilder.fork(GHFork.PARENT_AND_FORKS);
        assertThat(ghRepositorySearchBuilder.terms.stream().filter(item -> item.contains("fork:true")).count(), is(1L));
        assertThat(ghRepositorySearchBuilder.terms.stream().filter(item -> item.contains("fork:")).count(), is(1L));

-        ghRepositorySearchBuilder = ghRepositorySearchBuilder.fork(GHRepositorySearchBuilder.Fork.FORKS_ONLY);
+        ghRepositorySearchBuilder = ghRepositorySearchBuilder.fork(GHFork.FORKS_ONLY);
        assertThat(ghRepositorySearchBuilder.terms.stream().filter(item -> item.contains("fork:only")).count(), is(1L));
        assertThat(ghRepositorySearchBuilder.terms.stream().filter(item -> item.contains("fork:")).count(), is(2L));

-        ghRepositorySearchBuilder = ghRepositorySearchBuilder.fork(GHRepositorySearchBuilder.Fork.PARENT_ONLY);
+        ghRepositorySearchBuilder = ghRepositorySearchBuilder.fork(GHFork.PARENT_ONLY);
        assertThat(ghRepositorySearchBuilder.terms.stream().filter(item -> item.contains("fork:")).count(), is(0L));
    }


diff --git a/src/test/java/org/kohsuke/github/GitHubTest.java b/src/test/java/org/kohsuke/github/GitHubTest.java
@@ -154,6 +154,28 @@ public void searchContent() throws Exception {

    }

+    // CS427 Issue Link: https://github.com/hub4j/github-api/issues/1154
+    @Test
+    public void searchContentWithForks() {
+        final PagedSearchIterable<GHContent> results = gitHub.searchContent()
+                .q("addClass")
+                .language("js")
+                .sort(GHContentSearchBuilder.Sort.INDEXED)
+                .order(GHDirection.DESC)
+                .fork(GHFork.PARENT_ONLY)
+                .list();
+
+        final PagedSearchIterable<GHContent> resultsWithForks = gitHub.searchContent()
+                .q("addClass")
+                .language("js")
+                .sort(GHContentSearchBuilder.Sort.INDEXED)
+                .order(GHDirection.DESC)
+                .fork(GHFork.PARENT_AND_FORKS)
+                .list();
+
+        assertThat(results.getTotalCount(), lessThan(resultsWithForks.getTotalCount()));
+    }
+
    @Test
    public void testListMyAuthorizations() throws IOException {
        PagedIterable<GHAuthorization> list = gitHub.listMyAuthorizations();