Reinstated the old methods for backward compatibility

Author: sahansera

src/main/java/org/kohsuke/github/GHContentSearchBuilder.java

@@ -41,6 +41,18 @@ public GHContentSearchBuilder language(String v) {
         return q("language:" + v);
     }
 
+    /**
+     * Fork gh content search builder.
+     *
+     * @param v
+     *            the v
+     * @return the gh content search builder
+     */
+    @Deprecated
+    public GHContentSearchBuilder fork(String v) {
+        return q("fork:" + v);
+    }
+
     /**
      * Fork gh content search builder.
      *

src/main/java/org/kohsuke/github/GHRepositorySearchBuilder.java

@@ -52,6 +52,40 @@ public GHRepositorySearchBuilder forks(String v) {
         return q("forks:" + v);
     }
 
+    /**
+     * 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>
+     *
+     */
+    @Deprecated
+    public GHRepositorySearchBuilder fork(Fork fork) {
+        if (Fork.PARENT_ONLY.equals(fork)) {
+            this.terms.removeIf(term -> term.contains("fork:"));
+            return this;
+        }
+
+        return q("fork:" + fork);
+    }
+
     /**
      * Searching in forks
      *
@@ -216,6 +250,45 @@ public enum Sort {
         STARS, FORKS, UPDATED
     }
 
+    /**
+     * The enum for Fork search mode
+     * Note: Kept for backward compatibility. Use GHFork instead.
+     */
+    @Deprecated
+    public enum Fork {
+
+        /**
+         * 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;
+        Fork(final String mode) {
+            this.filterMode = mode;
+        }
+
+        @Override
+        public String toString() {
+            return filterMode;
+        }
+    }
+
     private static class RepositorySearchResult extends SearchResult<GHRepository> {
         private GHRepository[] items;
 

src/test/java/org/kohsuke/github/GitHubTest.java

@@ -161,6 +161,7 @@ public void searchContentWithForks() {
                 .language("js")
                 .sort(GHContentSearchBuilder.Sort.INDEXED)
                 .order(GHDirection.DESC)
+                .fork(GHFork.PARENT_ONLY)
                 .list();
 
         final PagedSearchIterable<GHContent> resultsWithForks = gitHub.searchContent()

src/test/resources/org/kohsuke/github/GitHubTest/wiremock/searchContentWithForks/__files/search_code-2.json

@@ -34,7 +34,7 @@
   "private_gists": 7,
   "total_private_repos": 25,
   "owned_private_repos": 25,
-  "disk_usage": 505415,
+  "disk_usage": 505417,
   "collaborators": 1,
   "two_factor_authentication": true,
   "plan": {

src/test/resources/org/kohsuke/github/GitHubTest/wiremock/searchContentWithForks/__files/search_code-3.json

@@ -1,5 +1,5 @@
 {
-  "id": "b264f2c8-9780-4d39-8f59-39adb461e042",
+  "id": "e66f46d2-2827-412a-a0c6-89f8370c34ac",
   "name": "search_code",
   "request": {
     "url": "/search/code?sort=indexed&order=desc&q=addClass+language%3Ajs",
@@ -15,7 +15,7 @@
     "bodyFileName": "search_code-2.json",
     "headers": {
       "Server": "GitHub.com",
-      "Date": "Sun, 21 Nov 2021 13:04:45 GMT",
+      "Date": "Mon, 22 Nov 2021 10:03:26 GMT",
       "Content-Type": "application/json; charset=utf-8",
       "Cache-Control": "no-cache",
       "Vary": [
@@ -28,7 +28,7 @@
       "X-GitHub-Media-Type": "github.v3; format=json",
       "X-RateLimit-Limit": "30",
       "X-RateLimit-Remaining": "29",
-      "X-RateLimit-Reset": "1637499943",
+      "X-RateLimit-Reset": "1637575463",
       "X-RateLimit-Used": "1",
       "X-RateLimit-Resource": "search",
       "Strict-Transport-Security": "max-age=31536000; includeSubdomains; preload",
@@ -37,11 +37,11 @@
       "X-XSS-Protection": "0",
       "Referrer-Policy": "origin-when-cross-origin, strict-origin-when-cross-origin",
       "Content-Security-Policy": "default-src 'none'",
-      "X-GitHub-Request-Id": "D5C0:1F74:CD3CA9:DC0F7D:619A43EA",
+      "X-GitHub-Request-Id": "EB6C:1F74:1390213:14C0A7E:619B6AEB",
       "Link": "<https://api.github.com/search/code?sort=indexed&order=desc&q=addClass+language%3Ajs&page=2>; rel=\"next\", <https://api.github.com/search/code?sort=indexed&order=desc&q=addClass+language%3Ajs&page=34>; rel=\"last\""
     }
   },
-  "uuid": "b264f2c8-9780-4d39-8f59-39adb461e042",
+  "uuid": "e66f46d2-2827-412a-a0c6-89f8370c34ac",
   "persistent": true,
   "insertionIndex": 2
 }

src/test/resources/org/kohsuke/github/GitHubTest/wiremock/searchContentWithForks/__files/user-1.json

@@ -1,5 +1,5 @@
 {
-  "id": "e8cbb690-9c42-4a75-83c8-65a3dc22c263",
+  "id": "67436d53-afd1-4df2-8f10-734b45b4abed",
   "name": "search_code",
   "request": {
     "url": "/search/code?sort=indexed&order=desc&q=addClass+language%3Ajs+fork%3Atrue",
@@ -15,7 +15,7 @@
     "bodyFileName": "search_code-3.json",
     "headers": {
       "Server": "GitHub.com",
-      "Date": "Sun, 21 Nov 2021 13:04:48 GMT",
+      "Date": "Mon, 22 Nov 2021 10:03:29 GMT",
       "Content-Type": "application/json; charset=utf-8",
       "Cache-Control": "no-cache",
       "Vary": [
@@ -28,7 +28,7 @@
       "X-GitHub-Media-Type": "github.v3; format=json",
       "X-RateLimit-Limit": "30",
       "X-RateLimit-Remaining": "28",
-      "X-RateLimit-Reset": "1637499943",
+      "X-RateLimit-Reset": "1637575463",
       "X-RateLimit-Used": "2",
       "X-RateLimit-Resource": "search",
       "Strict-Transport-Security": "max-age=31536000; includeSubdomains; preload",
@@ -37,11 +37,11 @@
       "X-XSS-Protection": "0",
       "Referrer-Policy": "origin-when-cross-origin, strict-origin-when-cross-origin",
       "Content-Security-Policy": "default-src 'none'",
-      "X-GitHub-Request-Id": "D5C1:1F74:CD3D28:DC100B:619A43EE",
+      "X-GitHub-Request-Id": "EB6D:7D60:761E32:7C4B93:619B6AEE",
       "Link": "<https://api.github.com/search/code?sort=indexed&order=desc&q=addClass+language%3Ajs+fork%3Atrue&page=2>; rel=\"next\", <https://api.github.com/search/code?sort=indexed&order=desc&q=addClass+language%3Ajs+fork%3Atrue&page=34>; rel=\"last\""
     }
   },
-  "uuid": "e8cbb690-9c42-4a75-83c8-65a3dc22c263",
+  "uuid": "67436d53-afd1-4df2-8f10-734b45b4abed",
   "persistent": true,
   "insertionIndex": 3
 }

src/test/resources/org/kohsuke/github/GitHubTest/wiremock/searchContentWithForks/mappings/search_code-2.json

@@ -1,5 +1,5 @@
 {
-  "id": "117d529c-d4aa-46ea-8b5b-c07ea58ee7be",
+  "id": "8794a2f3-d6de-4578-8f68-33dbec02760d",
   "name": "user",
   "request": {
     "url": "/user",
@@ -15,34 +15,34 @@
     "bodyFileName": "user-1.json",
     "headers": {
       "Server": "GitHub.com",
-      "Date": "Sun, 21 Nov 2021 13:04:41 GMT",
+      "Date": "Mon, 22 Nov 2021 10:03:22 GMT",
       "Content-Type": "application/json; charset=utf-8",
       "Cache-Control": "private, max-age=60, s-maxage=60",
       "Vary": [
         "Accept, Authorization, Cookie, X-GitHub-OTP",
         "Accept-Encoding, Accept, X-Requested-With"
       ],
-      "ETag": "W/\"274b7a0391a4d8ec088bc09c2ea4493111a73618dc4f9b76977913c0187d8e4b\"",
+      "ETag": "W/\"423eec8cb3dd36cf77abae8e76b77dd64a32ff8cecee5af3e3e25ccf8fea4459\"",
       "Last-Modified": "Thu, 18 Nov 2021 15:29:00 GMT",
       "X-OAuth-Scopes": "admin:org, delete_repo, repo, user",
       "X-Accepted-OAuth-Scopes": "",
       "github-authentication-token-expiration": "2022-01-30 03:21:12 UTC",
       "X-GitHub-Media-Type": "github.v3; format=json",
       "X-RateLimit-Limit": "5000",
-      "X-RateLimit-Remaining": "4793",
-      "X-RateLimit-Reset": "1637502525",
-      "X-RateLimit-Used": "207",
+      "X-RateLimit-Remaining": "4973",
+      "X-RateLimit-Reset": "1637576004",
+      "X-RateLimit-Used": "27",
       "X-RateLimit-Resource": "core",
       "Strict-Transport-Security": "max-age=31536000; includeSubdomains; preload",
       "X-Frame-Options": "deny",
       "X-Content-Type-Options": "nosniff",
       "X-XSS-Protection": "0",
       "Referrer-Policy": "origin-when-cross-origin, strict-origin-when-cross-origin",
       "Content-Security-Policy": "default-src 'none'",
-      "X-GitHub-Request-Id": "D5BE:1F74:CD3C84:DC0F57:619A43E9"
+      "X-GitHub-Request-Id": "EB6A:7D60:761CE4:7C4A2D:619B6AEA"
     }
   },
-  "uuid": "117d529c-d4aa-46ea-8b5b-c07ea58ee7be",
+  "uuid": "8794a2f3-d6de-4578-8f68-33dbec02760d",
   "persistent": true,
   "insertionIndex": 1
 }