Handle JARs that are transitive dependencies of GEMs (#370)

ysb33r · ysb33r · commit 207113aba059 · 2019-06-15T14:58:36.000+02:00
Finalised at hack.commit.push 2019 with @ixchelruiz.
diff --git a/base-plugin/src/integTest/groovy/com/github/jrubygradle/JRubyPrepareGemsIntegrationSpec.groovy b/base-plugin/src/integTest/groovy/com/github/jrubygradle/JRubyPrepareGemsIntegrationSpec.groovy
@@ -39,7 +39,7 @@ class JRubyPrepareGemsIntegrationSpec extends IntegrationSpecification {
         withDependencies """
             gems "rubygems:sinatra:1.4.5"
             gems "rubygems:rack:[0,)"
-            gems "rubygems:lookout-rack-utils:3.8.0.39"
+            gems "rubygems:lookout-rack-utils:5.0.0.49"
         """
 
         when:
diff --git a/base-plugin/src/main/groovy/com/github/jrubygradle/JRubyPluginExtension.groovy b/base-plugin/src/main/groovy/com/github/jrubygradle/JRubyPluginExtension.groovy
@@ -18,7 +18,7 @@ import java.util.concurrent.Callable
 import static org.ysb33r.grolifant.api.StringUtils.stringize
 
 /**
- * Class providing the jruby{} DSL extension to the Gradle build script.
+ * Class providing the jruby DSL extension to the Gradle build script.
  *
  * @author Schalk W. Cronjé
  * @author R Tyler Croy
diff --git a/core-plugin/src/integTest/groovy/com/github/jrubygradle/api/core/IvyXmlProxyServerIntegrationSpec.groovy b/core-plugin/src/integTest/groovy/com/github/jrubygradle/api/core/IvyXmlProxyServerIntegrationSpec.groovy
@@ -128,6 +128,22 @@ class IvyXmlProxyServerIntegrationSpec extends Specification {
         findFiles ~/^github-pages-106.gem$/
     }
 
+    void 'Resolve GEM with JAR dependencies'() {
+        setup:
+        withBuildFile '''
+        repositories.jcenter()
+        dependencies {
+            something 'rubygems:jruby-openssl:0.10.2'    
+        }
+        '''
+
+        when:
+        build()
+
+        then:
+        findFiles ~/^jruby-openssl-0.10.2-java.gem$/
+    }
+
     private List<File> findFiles(Pattern pat) {
         new File(projectDir, 'build/something').listFiles(new FilenameFilter() {
             @Override
diff --git a/core-plugin/src/main/groovy/com/github/jrubygradle/api/core/RepositoryHandlerExtension.groovy b/core-plugin/src/main/groovy/com/github/jrubygradle/api/core/RepositoryHandlerExtension.groovy
@@ -95,7 +95,7 @@ class RepositoryHandlerExtension {
     @CompileDynamic
     private IvyArtifactRepository createIvyRepo(URI server, URI bindAddress) {
         this.project.repositories.ivy {
-            artifactPattern "${server}/downloads/[artifact]-[revision].gem"
+            artifactPattern "${server}/downloads/[artifact]-[revision](-[classifier]).gem"
             ivyPattern "${bindAddress}/[organisation]/[module]/[revision]/ivy.xml"
         }
     }
diff --git a/core-plugin/src/main/groovy/com/github/jrubygradle/api/gems/GemInfo.java b/core-plugin/src/main/groovy/com/github/jrubygradle/api/gems/GemInfo.java
@@ -101,6 +101,12 @@ public interface GemInfo {
      */
     List<GemDependency> getDevelopmentDependencies();
 
+    /** Transitive JAR requirements.
+     *
+     * @return List of JAR requirements. Can be empty, but never {@code null}
+     */
+    List<JarDependency> getJarRequirements();
+
     /** Whether the GEM is still a prerelease version.
      *
      * @return {@code true} for prerelease
diff --git a/core-plugin/src/main/groovy/com/github/jrubygradle/api/gems/GemVersion.groovy b/core-plugin/src/main/groovy/com/github/jrubygradle/api/gems/GemVersion.groovy
@@ -93,6 +93,7 @@ class GemVersion implements Comparable<GemVersion> {
     private static final Pattern RANGE = ~/^(\[|\])(.+?),(.+?)(\[|\])$/
 
     private static final Pattern ONLY_DIGITS = ~/^\d+$/
+    private static final Pattern DIGITS_AND_DOTS = ~/^\d+(\.\d+){1,3}(-\p{Alnum}+)?$/
 
     // GEM requirement patterns
     private static final Pattern GREATER_EQUAL = ~/^>=\s*(.+)/
@@ -132,13 +133,13 @@ class GemVersion implements Comparable<GemVersion> {
      */
     static List<GemVersion> gemVersionsFromMultipleGemRequirements(String multipleRequirements) {
         multipleRequirements.split(/,\s*/).collect { String it ->
-            gemVersionFromGemRequirement(it)
+            gemVersionFromGemRequirement(it.trim())
         }.findAll {
             it != NO_VERSION
         }
     }
 
-    /** Takes a GEM requirement list and creates a single GEM versoin, by taking a union of
+    /** Takes a GEM requirement list and creates a single GEM versin, by taking a union of
      * all requirements.
      *
      * @param multipleRequirements Comma-separated list of GEM requirements.
@@ -208,6 +209,13 @@ class GemVersion implements Comparable<GemVersion> {
             )
         } else if (singleRequirement.matches(TWIDDLE_WAKKA)) {
             parseTwiddleWakka(singleRequirement)
+        } else if (singleRequirement.matches(DIGITS_AND_DOTS)) {
+            new GemVersion(
+                INCLUSIVE,
+                singleRequirement,
+                singleRequirement,
+                INCLUSIVE
+            )
         } else {
             throw new GemVersionException("'${singleRequirement}' does not look like a GEM version requirement")
         }
diff --git a/core-plugin/src/main/groovy/com/github/jrubygradle/api/gems/JarDependency.java b/core-plugin/src/main/groovy/com/github/jrubygradle/api/gems/JarDependency.java
@@ -0,0 +1,12 @@
+package com.github.jrubygradle.api.gems;
+
+/** JAR dependency as specified by a GEM spec.
+ *
+ */
+public interface JarDependency extends GemDependency {
+    /** Group/organisation that the JAR belongs to
+     *
+     * @return Can be {@code null} if no organisation.
+     */
+    String getGroup();
+}
diff --git a/core-plugin/src/main/groovy/com/github/jrubygradle/internal/core/DefaultRubyGemRestApi.groovy b/core-plugin/src/main/groovy/com/github/jrubygradle/internal/core/DefaultRubyGemRestApi.groovy
@@ -1,8 +1,10 @@
 package com.github.jrubygradle.internal.core
 
 import com.github.jrubygradle.api.gems.GemInfo
+import com.github.jrubygradle.api.gems.JarDependency
 import com.github.jrubygradle.internal.gems.DefaultGemDependency
 import com.github.jrubygradle.internal.gems.DefaultGemInfo
+import com.github.jrubygradle.internal.gems.DefaultJarDependency
 import groovy.transform.CompileDynamic
 import groovy.transform.CompileStatic
 import groovyx.net.http.HttpBuilder
@@ -141,7 +143,7 @@ class DefaultRubyGemRestApi implements com.github.jrubygradle.api.core.RubyGemQu
             gemUri: jsonParser.gem_uri?.toURI(),
             homepageUri: jsonParser.homepage_uri?.toURI(),
             documentationUri: jsonParser.documentation_uri?.toURI(),
-            authors: ((String) jsonParser.authors).split(', ').toList() ?: [],
+            authors: ((String) jsonParser.authors).split(COMMA_SPACE).toList() ?: [],
             prerelease: jsonParser.prerelease
             // licenses arrayList
         )
@@ -158,10 +160,36 @@ class DefaultRubyGemRestApi implements com.github.jrubygradle.api.core.RubyGemQu
             })
         }
 
+        if (jsonParser.requirements) {
+            metadata.jarRequirements.addAll(findJarRequirements(jsonParser.requirements))
+        }
+
         metadata
     }
 
+    private List<JarDependency> findJarRequirements(Iterable<String> reqs) {
+        reqs.findAll { String it ->
+            it.startsWith('jar ')
+        }.collect {
+            String[] parts = ((String) it)[4..-1].split(COMMA_SPACE, 2)
+            String[] name_parts = parts[0].split(':', 2)
+            if (name_parts.size() == 1) {
+                new DefaultJarDependency(
+                    name: parts[0],
+                    requirements: parts[1]
+                )
+            } else {
+                new DefaultJarDependency(
+                    group: name_parts[0],
+                    name: name_parts[1],
+                    requirements: parts[1]
+                )
+            }
+        } as List<JarDependency>
+    }
+
     private final HttpBuilder httpBuilder
     static private final String V1 = 'api/v1'
     static private final String V2 = 'api/v2'
+    static private final String COMMA_SPACE = ', '
 }
diff --git a/core-plugin/src/main/groovy/com/github/jrubygradle/internal/gems/DefaultGemInfo.groovy b/core-plugin/src/main/groovy/com/github/jrubygradle/internal/gems/DefaultGemInfo.groovy
@@ -2,6 +2,7 @@ package com.github.jrubygradle.internal.gems
 
 import com.github.jrubygradle.api.gems.GemInfo
 import com.github.jrubygradle.api.gems.GemDependency
+import com.github.jrubygradle.api.gems.JarDependency
 import groovy.transform.CompileStatic
 
 /** An implementation of GEM metadata.
@@ -34,4 +35,5 @@ class DefaultGemInfo implements GemInfo {
 
     List<GemDependency> dependencies = []
     List<GemDependency> developmentDependencies = []
+    List<JarDependency> jarRequirements = []
 }
diff --git a/core-plugin/src/main/groovy/com/github/jrubygradle/internal/gems/DefaultJarDependency.groovy b/core-plugin/src/main/groovy/com/github/jrubygradle/internal/gems/DefaultJarDependency.groovy
@@ -0,0 +1,18 @@
+package com.github.jrubygradle.internal.gems
+
+import com.github.jrubygradle.api.gems.JarDependency
+import groovy.transform.CompileStatic
+
+/** Defining a JAR dependency.
+ *
+ * @author Schalk W. Cronjé
+ *
+ * @since 2.0
+ */
+@CompileStatic
+class DefaultJarDependency extends DefaultGemDependency implements JarDependency {
+    /** Name of group / organisation.
+     *
+     */
+    String group
+}
diff --git a/core-plugin/src/main/groovy/com/github/jrubygradle/internal/gems/GemToIvy.groovy b/core-plugin/src/main/groovy/com/github/jrubygradle/internal/gems/GemToIvy.groovy
@@ -48,9 +48,18 @@ class GemToIvy {
     Writer writeTo(Writer writer, GemInfo gem) {
         def xml = new MarkupBuilder(writer)
 
+        final Map artifactAttributes = [
+            type: 'gem', url: gem.gemUri
+        ]
+
+        if (gem.platform == JAVA_PLATFORM) {
+            artifactAttributes['e:classifier'] = JAVA_PLATFORM
+        }
+
         xml.'ivy-module'(
             'xmlns:xsi': 'http://www.w3.org/2001/XMLSchema-instance',
             'xsi:noNamespaceSchemaLocation': 'http://ant.apache.org/ivy/schemas/ivy.xsd',
+            'xmlns:e': 'http://ant.apache.org/ivy/extra',
             version: '2.0'
         ) {
             info(organisation: this.org, module: gem.name, revision: gem.version /*, publication: */) {
@@ -69,10 +78,10 @@ class GemToIvy {
             }
 
             publications {
-                artifact(type: 'gem')
+                artifact(artifactAttributes)
             }
 
-            if (gem.dependencies) {
+            if (gem.dependencies || gem.jarRequirements) {
                 dependencies {
                     gem.dependencies.each { dep ->
                         dependency(
@@ -81,6 +90,20 @@ class GemToIvy {
                             rev: singleGemVersionFromMultipleGemRequirements(dep.requirements).toString()
                         )
                     }
+                    gem.jarRequirements.each { dep ->
+                        if (dep.group) {
+                            dependency(
+                                org: dep.group,
+                                name: dep.name,
+                                rev: singleGemVersionFromMultipleGemRequirements(dep.requirements).toString()
+                            )
+                        } else {
+                            dependency(
+                                name: dep.name,
+                                rev: singleGemVersionFromMultipleGemRequirements(dep.requirements).toString()
+                            )
+                        }
+                    }
                 }
             }
         }
@@ -110,6 +133,7 @@ class GemToIvy {
         shaFile
     }
 
+    private static final String JAVA_PLATFORM = 'java'
     private final String serverUri
     private final String org = 'rubygems'
 }
diff --git a/core-plugin/src/test/groovy/com/github/jrubygradle/internal/gems/GemToIvySpec.groovy b/core-plugin/src/test/groovy/com/github/jrubygradle/internal/gems/GemToIvySpec.groovy
@@ -9,7 +9,9 @@ class GemToIvySpec extends Specification {
         given:
         def gem = new DefaultGemInfo(
             name: 'foo_module',
-            version: '1.2.3'
+            version: '1.2.3',
+            dependencies: [new DefaultGemDependency(name: 'foo', requirements: '< 13.0')],
+            jarRequirements: [new DefaultJarDependency(group: 'bar', name: 'foo', requirements: '>=2.2')]
         )
         def gemToIvy = new GemToIvy('https://foo'.toURI())
 
@@ -18,5 +20,7 @@ class GemToIvySpec extends Specification {
 
         then:
         result.contains("info organisation='rubygems' module='foo_module' revision='1.2.3'")
+        result.contains("<dependency org='rubygems' name='foo' rev='(,13.0['")
+        result.contains("<dependency org='bar' name='foo' rev='[2.2,)'")
     }
 }

Original file line number	Diff line number	Diff line change
`@@ -18,7 +18,7 @@ import java.util.concurrent.Callable`
`18`	`18`	`import static org.ysb33r.grolifant.api.StringUtils.stringize`
`19`	`19`
`20`	`20`	`/**`
`21`		`- * Class providing the jruby{} DSL extension to the Gradle build script.`
	`21`	`+ * Class providing the jruby DSL extension to the Gradle build script.`
`22`	`22`	`*`
`23`	`23`	`* @author Schalk W. Cronjé`
`24`	`24`	`* @author R Tyler Croy`
Original file line number	Diff line number	Diff line change
`@@ -95,7 +95,7 @@ class RepositoryHandlerExtension {`
`95`	`95`	`@CompileDynamic`
`96`	`96`	`private IvyArtifactRepository createIvyRepo(URI server, URI bindAddress) {`
`97`	`97`	`this.project.repositories.ivy {`
`98`		`- artifactPattern "${server}/downloads/[artifact]-[revision].gem"`
	`98`	`+ artifactPattern "${server}/downloads/[artifact]-[revision](-[classifier]).gem"`
`99`	`99`	`ivyPattern "${bindAddress}/[organisation]/[module]/[revision]/ivy.xml"`
`100`	`100`	`}`
`101`	`101`	`}`