Do not include pre-release GEMs by default (#393)

Author: ysb33r

core-plugin/src/integTest/groovy/com/github/jrubygradle/api/core/IvyXmlProxyServerIntegrationSpec.groovy

@@ -30,6 +30,7 @@ import org.junit.rules.TemporaryFolder
 import spock.lang.IgnoreIf
 import spock.lang.Issue
 import spock.lang.Specification
+import spock.lang.Unroll
 
 import java.util.regex.Pattern
 
@@ -185,7 +186,7 @@ class IvyXmlProxyServerIntegrationSpec extends Specification {
         build()
 
         then:
-        findFiles (~/^asciidoctor-pdf.*\.gem$/).size() == 3
+        findFiles(~/^asciidoctor-pdf.*\.gem$/).size() == 3
     }
 
     @Issue('https://github.com/jruby-gradle/jruby-gradle-plugin/issues/380')
@@ -243,14 +244,16 @@ class IvyXmlProxyServerIntegrationSpec extends Specification {
             .build()
     }
 
-    private void withBuildFile(String content) {
+    private void withBuildFile(String content, boolean prerelease = false) {
         buildFile.text = """
         plugins {
             id 'com.github.jruby-gradle.core'
         }
 
         repositories {
-            ruby.gems()
+            ruby.gems {
+                prerelease = ${prerelease}
+            }
         }
 
         configurations {

core-plugin/src/main/groovy/com/github/jrubygradle/api/core/GemRepositoryConfiguration.groovy

@@ -0,0 +1,41 @@
+/*
+ * Copyright (c) 2014-2019, R. Tyler Croy <rtyler@brokenco.de>,
+ *     Schalk Cronje <ysb33r@gmail.com>, Christian Meier, Lookout, Inc.
+ *
+ * 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
+ * NONINFRINGEMENT. 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 com.github.jrubygradle.api.core
+
+import groovy.transform.CompileStatic
+
+/** Additional options for configuring a remote GEM repository
+ *
+ * @author Schalk W. Cronjé
+ *
+ * @since 2.0
+ */
+@CompileStatic
+class GemRepositoryConfiguration {
+
+    /** Set whether pre-release GEMs should be considered.
+     *
+     */
+    boolean prerelease = false
+}

core-plugin/src/main/groovy/com/github/jrubygradle/api/core/JRubyExecSpec.java

@@ -1,18 +1,18 @@
 /**
  * Copyright (c) 2014-2019, R. Tyler Croy <rtyler@brokenco.de>,
- * Schalk Cronje <ysb33r@gmail.com>, Christian Meier, Lookout, Inc.
- * <p>
+ *     Schalk Cronje <ysb33r@gmail.com>, Christian Meier, Lookout, Inc.
+ *
  * 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:
- * <p>
+ *
  * The above copyright notice and this permission notice shall be
  * included in all copies or substantial portions of the Software.
- * <p>
+ *
  * 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

core-plugin/src/main/groovy/com/github/jrubygradle/api/core/RepositoryHandlerExtension.groovy

@@ -31,8 +31,8 @@ import org.gradle.api.Action
 import org.gradle.api.Project
 import org.gradle.api.artifacts.repositories.ArtifactRepository
 import org.gradle.api.artifacts.repositories.IvyArtifactRepository
-import org.gradle.api.artifacts.repositories.MavenArtifactRepository
 import org.gradle.util.GradleVersion
+import org.ysb33r.grolifant.api.ClosureUtils
 
 /** Extension which can be added to {@code project.repositories}.
  *
@@ -60,7 +60,31 @@ class RepositoryHandlerExtension {
      * @return Artifact repository.
      */
     ArtifactRepository gems() {
-        bindRepositoryToProxyServer('https://rubygems.org'.toURI(), DEFAULT_GROUP_NAME)
+        bindRepositoryToProxyServer(
+            RUBYGEMS_URI,
+            DEFAULT_GROUP_NAME,
+            new GemRepositoryConfiguration()
+        )
+    }
+
+    /** Create an artifact repository which will use {@link https://rubygems.org} and
+     * associate group {@code rubygems} with it.
+     *
+     * @param cfg GEM repository configuration
+     * @return Artifact repository.
+     */
+    ArtifactRepository gems(@DelegatesTo(GemRepositoryConfiguration) Closure cfg) {
+        bindRepositoryToProxyServer(RUBYGEMS_URI, DEFAULT_GROUP_NAME, cfg)
+    }
+
+    /** Create an artifact repository which will use {@link https://rubygems.org} and
+     * associate group {@code rubygems} with it.
+     *
+     * @param cfg GEM repository configuration
+     * @return Artifact repository.
+     */
+    ArtifactRepository gems(Action<GemRepositoryConfiguration> cfg) {
+        bindRepositoryToProxyServer(RUBYGEMS_URI, DEFAULT_GROUP_NAME, cfg)
     }
 
     /** Create an artifact repository which will use specified URI and
@@ -72,7 +96,33 @@ class RepositoryHandlerExtension {
      * @return Artifact repository.
      */
     ArtifactRepository gems(Object uri) {
-        bindRepositoryToProxyServer(project.uri(uri), DEFAULT_GROUP_NAME)
+        bindRepositoryToProxyServer(project.uri(uri), DEFAULT_GROUP_NAME, new GemRepositoryConfiguration())
+    }
+
+    /** Create an artifact repository which will use specified URI and
+     * associate group {@code rubygems} with it.
+     *
+     * @param uri URI of remote repository that serves up Rubygems. Any object convertible
+     * with {@code project.uri} can be provided.
+     * @param cfg GEM repository configuration
+     *
+     * @return Artifact repository.
+     */
+    ArtifactRepository gems(Object uri, @DelegatesTo(GemRepositoryConfiguration) Closure cfg) {
+        bindRepositoryToProxyServer(project.uri(uri), DEFAULT_GROUP_NAME, cfg)
+    }
+
+    /** Create an artifact repository which will use specified URI and
+     * associate group {@code rubygems} with it.
+     *
+     * @param uri URI of remote repository that serves up Rubygems. Any object convertible
+     * with {@code project.uri} can be provided.
+     * @param cfg GEM repository configuration
+     *
+     * @return Artifact repository.
+     */
+    ArtifactRepository gems(Object uri, Action<GemRepositoryConfiguration> cfg) {
+        bindRepositoryToProxyServer(project.uri(uri), DEFAULT_GROUP_NAME, cfg)
     }
 
     /** Create an artifact repository which will use specified URI and
@@ -84,18 +134,65 @@ class RepositoryHandlerExtension {
      * @return Artifact repository.
      */
     ArtifactRepository gems(String group, Object uri) {
-        bindRepositoryToProxyServer(project.uri(uri), group)
+        bindRepositoryToProxyServer(project.uri(uri), group, new GemRepositoryConfiguration())
+    }
+
+    /** Create an artifact repository which will use specified URI and
+     * associate a specified group with it.
+     *
+     * @param group Group to associate this server with.
+     * @param uri URI of remote repository that serves up Rubygems. Any object convertible
+     * with {@code project.uri} can be provided.
+     * @param cfg GEM repository configuration
+     * @return Artifact repository.
+     */
+    ArtifactRepository gems(String group, Object uri, @DelegatesTo(GemRepositoryConfiguration) Closure cfg) {
+        bindRepositoryToProxyServer(project.uri(uri), group, cfg)
+    }
+
+    /** Create an artifact repository which will use specified URI and
+     * associate a specified group with it.
+     *
+     * @param group Group to associate this server with.
+     * @param uri URI of remote repository that serves up Rubygems. Any object convertible
+     * with {@code project.uri} can be provided.
+     * @param cfg GEM repository configuration
+     * @return Artifact repository.
+     */
+    ArtifactRepository gems(String group, Object uri, Action<GemRepositoryConfiguration> cfg) {
+        bindRepositoryToProxyServer(project.uri(uri), group, cfg)
     }
 
     private ArtifactRepository bindRepositoryToProxyServer(
         URI serverUri,
-        String group
+        String group,
+        GemRepositoryConfiguration cfg
     ) {
-        IvyXmlProxyServer proxy = ivyProxies.registerProxy(serverUri, group)
+        IvyXmlProxyServer proxy = ivyProxies.registerProxy(serverUri, group, cfg)
         project.extensions.getByType(GemResolverStrategy).addGemGroup(group)
         restrictToGems(createIvyRepo(serverUri, proxy.bindAddress), group)
     }
 
+    private ArtifactRepository bindRepositoryToProxyServer(
+        URI serverUri,
+        String group,
+        @DelegatesTo(GemRepositoryConfiguration) Closure cfg
+    ) {
+        GemRepositoryConfiguration grc = new GemRepositoryConfiguration()
+        ClosureUtils.configureItem(grc, cfg)
+        bindRepositoryToProxyServer(serverUri, group, grc)
+    }
+
+    private ArtifactRepository bindRepositoryToProxyServer(
+        URI serverUri,
+        String group,
+        Action<GemRepositoryConfiguration> cfg
+    ) {
+        GemRepositoryConfiguration grc = new GemRepositoryConfiguration()
+        cfg.execute(grc)
+        bindRepositoryToProxyServer(serverUri, group, grc)
+    }
+
     @CompileDynamic
     private IvyArtifactRepository createIvyRepo(URI server, URI bindAddress) {
         this.project.repositories.ivy {
@@ -122,4 +219,5 @@ class RepositoryHandlerExtension {
     private final IvyXmlGlobalProxyRegistry ivyProxies
     private static final boolean HAS_CONTENT_FEATURE = GradleVersion.current() >= GradleVersion.version('5.1')
     private static final boolean HAS_SECURE_PROTOCOL_FEATURE = GradleVersion.current() >= GradleVersion.version('6.0')
+    private static final URI RUBYGEMS_URI = 'https://rubygems.org'.toURI()
 }

core-plugin/src/main/groovy/com/github/jrubygradle/api/core/RubyGemQueryRestApi.java

@@ -33,9 +33,10 @@
  *
  * @since 2.0.
  *
- * @see https://guides.rubygems.org/rubygems-org-api
+ * @see {@link https://guides.rubygems.org/rubygems-org-api}
  */
 public interface RubyGemQueryRestApi {
+
     /**
      * Return all published versions for a specific GEM
      *
@@ -45,6 +46,16 @@ public interface RubyGemQueryRestApi {
      */
     List<String> allVersions(String gemName) throws ApiException;
 
+    /**
+     * Return all published versions for a specific GEM
+     *
+     * @param gemName Name of GEM.
+     * @param includePrelease Whether pre-release versions should be included.
+     * @return List of versions. Can be empty if the GEM does not have any versions. Never {@code null}.
+     * @throws {@link ApiException} if a networking or parser error occurs.
+     */
+    List<String> allVersions(String gemName, boolean includePrelease) throws ApiException;
+
     /**
      * Return latest published version of GEM.
      *
@@ -54,6 +65,16 @@ public interface RubyGemQueryRestApi {
      */
     String latestVersion(String gemName) throws ApiException;
 
+    /**
+     * Return latest published version of GEM.
+     *
+     * @param gemName Name of GEM.
+     * @param allowPrerelease Whether a prereleased version can be considered a latest version.
+     * @return Version of GEM
+     * @throws {@link ApiException} if GEM does not exist.
+     */
+    String latestVersion(String gemName, boolean allowPrerelease) throws ApiException;
+
     /** Returns the basic metadata for a GEM.
      *
      * @param gemName Name of GEM.

core-plugin/src/main/groovy/com/github/jrubygradle/internal/core/AbstractIvyXmlProxyServer.groovy

@@ -24,6 +24,7 @@
 package com.github.jrubygradle.internal.core
 
 import com.github.jrubygradle.api.core.ApiException
+import com.github.jrubygradle.api.core.GemRepositoryConfiguration
 import com.github.jrubygradle.api.core.IvyXmlProxyServer
 import com.github.jrubygradle.api.core.RubyGemQueryRestApi
 import com.github.jrubygradle.api.gems.GemInfo
@@ -94,12 +95,19 @@ abstract class AbstractIvyXmlProxyServer implements IvyXmlProxyServer {
      * @param cache Root directory for local Ivy XML cache.
      * @param serverUri URI of remote Rubygems proxy.
      * @param group Group that will be associated with the Rubygems proxy.
+     * @param grc       Additional configuration regarding remote GEM server
      */
-    protected AbstractIvyXmlProxyServer(File cache, URI serverUri, String group) {
+    protected AbstractIvyXmlProxyServer(
+        File cache,
+        URI serverUri,
+        String group,
+        GemRepositoryConfiguration grc
+    ) {
         localCachePath = cache
         gemToIvy = new GemToIvy(serverUri)
         api = new DefaultRubyGemRestApi(serverUri)
         this.group = group
+        this.configuration = grc
     }
 
     @Synchronized
@@ -170,7 +178,7 @@ abstract class AbstractIvyXmlProxyServer implements IvyXmlProxyServer {
     protected String getDirectoryListing(String grp, String name) throws NotFound {
         if (inGroups(grp)) {
             debug "Request to find all versions for ${grp}:${name}"
-            List<String> versions = api.allVersions(name)
+            List<String> versions = api.allVersions(name, configuration.prerelease)
             debug "Got versions ${versions.join(', ')}"
             revisionsAsHtmlDirectoryListing(versions)
         } else {
@@ -185,7 +193,7 @@ abstract class AbstractIvyXmlProxyServer implements IvyXmlProxyServer {
 
     private String getGemQueryRevisionFromIvy(String gemName, String revisionPattern) {
         GemVersion version = gemVersionFromGradleIvyRequirement(revisionPattern)
-        version.highOpenEnded ? api.latestVersion(gemName) : version.high
+        version.highOpenEnded ? api.latestVersion(gemName, configuration.prerelease) : version.high
     }
 
     private void debug(String text) {
@@ -203,4 +211,5 @@ abstract class AbstractIvyXmlProxyServer implements IvyXmlProxyServer {
     private final GemToIvy gemToIvy
     private final RubyGemQueryRestApi api
     private final String group
+    private final GemRepositoryConfiguration configuration
 }