Merge pull request #35 from ysb33r/master

Added JRubyPrepareGemsSpec. Fixed transitive dependencies for GEMs.

Author: R. Tyler Croy

README.md

@@ -75,18 +75,21 @@ Dependencies declared under the `jrubyWar` configuration will be copied into
 `.jarcache/` and `.war/WEB-INF/libs` when the archive is created.
 
 
+## Default Tasks
+
 The plugin provides the following tasks:
 
  * `jrubyWar` - Creates a runnable web archive file in `build/libs` for your
    project.
- * `jrubyPrepare` - Extracts content of Ruby gems in `.gemcache/` into `vendor/`
-   for use at runtime *or* when packaging a `.war` file. Also copies the
+ * `jrubyPrepareGems` - Extract GEMs declared as dependencies under `gems` to `jruby.gemInstallDir`. This is as instance
+ of `JRubyPrepareGems`.
+ * `jrubyPrepare` - Call `jrubyPrepareGems`. Also copies the
    content of Java-based dependencies into `.jarcache/` for interpreted use
    (see below)
  * `jrubyClean` - Cleans up the temporary directories that tasks like
-   `jrubyWar` create
+   `jrubyWar`- Creates a `war` file
 
-### Creating a .war
+## Creating a .war
 
 Currently the Gradle tooling expects the web application to reside in
 `src/main/webapp/WEB-INF`, so make sure your `config.ru` and application code
@@ -181,12 +184,13 @@ server.
 You can then use that custom Gem repository with:
 
 ```groovy
-// buildscript {} up here
-
-apply plugin: 'com.lookout.jruby'
+jruby {
+    defaultRepositories = false
+}
 
-// Set our custom Gem repository
-jruby.defaultGemRepo = 'http://localhost:8989/releases'
+repositories {
+    maven { url : 'http://localhost:8989/releases' }
+}
 
 dependencies {
     gems group: 'com.lookout', name: 'custom-gem', version: '1.0.+'
@@ -265,3 +269,23 @@ in the ```jrubyexec``` closure will cause a failure
 
 As with `JRubyExec`, `args`, `setArgs` and `main` are illegal within the `jrubyexec` closure.
 All other methods should work.
+
+## JRubyPrepareGems - A task for unpacking GEMs
+
+Unpacking occurs using the default `jruby` version as set by `jruby.execVersion`.
+
+```groovy
+import com.lookout.jruby.JRubyPrepareGems
+
+task unpackMyGems( type : JRubyPrepareGems ) {
+
+  // Parent directory for unpacking GEMs.
+  // Gems will end up in a subdirectory 'gems/GemName-GemVersion'
+  outputDir buildDir
+  
+  // Add one or more gems
+  // Can be String(s), File(s), FleCollection(s) or Configuration(s)
+  gems project.configuration.gems
+  
+}
+```

build.gradle

@@ -17,8 +17,33 @@ if (System.env.RELEASE != '1') {
 }
 sourceCompatibility = '1.7'
 
+// --- Could be in a separate gradle file
+configurations {
+    testJRubyPrepare
+}
+
+ext {
+    jrubyClassPathFromConfiguration = { Configuration cfg ->
+        def f = cfg.files.find { it.name.startsWith('jruby-complete-') }
+        return  f?.absolutePath
+    }
+}
+
+project.afterEvaluate {
+    test {
+        systemProperties TEST_JRUBY_CLASSPATH: "${jrubyClassPathFromConfiguration(configurations.testJRubyPrepare)}"
+
+    }
+}
+
+// --- up to here
+
+dependencies {
+    testJRubyPrepare 'org.jruby:jruby-complete:1.7.13'
+}
+
 repositories {
-    mavenCentral()
+    jcenter()
     mavenLocal()
 }
 
@@ -33,6 +58,7 @@ dependencies {
     testCompile (spockVersion) {
         exclude module : 'groovy-all'
     }
+
     integrationTestCompile (spockVersion) {
         exclude module : 'groovy-all'
     }
@@ -45,6 +71,7 @@ test {
     }
 
     systemProperties TESTROOT : new File(buildDir,'tmp/test/unittests').absolutePath
+    systemProperties TEST_GEM_DIR : new File(projectDir,'src/integTest/resources/gems').absolutePath
     systemProperties 'logback.configurationFile' : new File(projectDir,'src/test/resources/logback-test.xml').absolutePath
 
 }

src/integTest/groovy/com/lookout/jruby/JRubyExecExtensionIntegrationSpec.groovy

@@ -1,21 +1,17 @@
 package com.lookout.jruby
 
-import org.gradle.api.artifacts.repositories.ArtifactRepository
 import org.gradle.testfixtures.ProjectBuilder
-import spock.lang.Ignore
-import spock.lang.IgnoreIf
-import spock.lang.Specification
-import spock.lang.Stepwise
+import spock.lang.*
 
 import static org.gradle.api.logging.LogLevel.LIFECYCLE
 
 /**
  * @author Schalk W. Cronjé
  */
-@Stepwise
 class JRubyExecExtensionIntegrationSpec extends Specification {
+
     static final boolean TESTS_ARE_OFFLINE = System.getProperty('TESTS_ARE_OFFLINE') != null
-    static final File TEST_SCRIPT_DIR = new File( System.getProperty('TESTS_SCRIPT_DIR') ?: 'src/integTest/resources/scripts')
+    static final File TEST_SCRIPT_DIR = new File( System.getProperty('TEST_SCRIPT_DIR') ?: 'src/integTest/resources/scripts')
     static final File TESTROOT = new File("${System.getProperty('TESTROOT') ?: 'build/tmp/test/integration-tests'}/jreeis")
 
     def project
@@ -34,19 +30,18 @@ class JRubyExecExtensionIntegrationSpec extends Specification {
         }
     }
 
-
     @IgnoreIf({TESTS_ARE_OFFLINE})
     def "Run a script with minimum parameters"() {
         given:
             def output = new ByteArrayOutputStream()
 
-        when:
+        when: "I call jrubyexec with only a script name"
             project.jrubyexec {
                 script        "${TEST_SCRIPT_DIR}/helloWorld.rb"
                 standardOutput output
             }
 
-        then:
+        then: "I expect the Ruby script to be executed"
             output.toString() == "Hello, World\n"
     }
 
@@ -80,6 +75,8 @@ class JRubyExecExtensionIntegrationSpec extends Specification {
     def "Running a script that requires a gem, a separate jRuby and a separate configuration"() {
         given:
             def output = new ByteArrayOutputStream()
+
+        when:
             project.with {
                 dependencies {
                     jrubyExec 'rubygems:credit_card_validator:1.1.0'
@@ -91,9 +88,6 @@ class JRubyExecExtensionIntegrationSpec extends Specification {
                 }
             }
 
-        when:
-            project.evaluate()
-
         then:
             output.toString() == "Not valid\n"
     }

src/integTest/groovy/com/lookout/jruby/JRubyPrepareGemsIntegrationSpec.groovy

@@ -0,0 +1,97 @@
+package com.lookout.jruby
+
+import org.gradle.api.file.FileCollection
+import org.gradle.testfixtures.ProjectBuilder
+import spock.lang.Ignore
+import spock.lang.IgnoreIf
+import spock.lang.Specification
+
+import static org.gradle.api.logging.LogLevel.LIFECYCLE
+
+/**
+ * @author Schalk W. Cronjé.
+ */
+class JRubyPrepareGemsIntegrationSpec extends Specification {
+
+    static final boolean TESTS_ARE_OFFLINE = System.getProperty('TESTS_ARE_OFFLINE') != null
+    static final File TESTROOT = new File( "${System.getProperty('TESTROOT') ?: 'build/tmp/test/integration-tests'}/jpgis")
+    static final String TASK_NAME = 'RubyWax'
+    static final String OUR_GEM = 'rubygems:slim:2.0.2'
+
+    def project
+    def prepTask
+
+    void setup() {
+        if(TESTROOT.exists()) {
+            TESTROOT.deleteDir()
+        }
+        TESTROOT.mkdirs()
+
+        project = ProjectBuilder.builder().build()
+        project.with {
+            buildDir = TESTROOT
+            logging.level = LIFECYCLE
+            apply plugin: 'com.lookout.jruby'
+        }
+
+        prepTask = project.task(TASK_NAME, type: JRubyPrepareGems)
+    }
+
+    @IgnoreIf({TESTS_ARE_OFFLINE})
+    def "Unpack our gem as normal"() {
+        given:
+            project.dependencies {
+                gems OUR_GEM
+            }
+            project.configure(prepTask) {
+                outputDir TESTROOT
+                gems project.configurations.gems
+            }
+            project.evaluate()
+            prepTask.copy()
+
+        expect:
+            new File(prepTask.outputDir,'gems/slim-2.0.2').exists()
+            new File(prepTask.outputDir,'gems/temple-0.6.8').exists()
+            new File(prepTask.outputDir,'gems/tilt-2.0.1').exists()
+    }
+
+    @IgnoreIf({TESTS_ARE_OFFLINE})
+    def "Unpack our gem, but without transitives"() {
+        given:
+            project.dependencies {
+                gems (OUR_GEM) {
+                    transitive = false
+                }
+            }
+            project.configure(prepTask) {
+                outputDir TESTROOT
+                gems project.configurations.gems
+            }
+            project.evaluate()
+            prepTask.copy()
+
+        expect:
+            new File(prepTask.outputDir,'gems/slim-2.0.2').exists()
+            !new File(prepTask.outputDir,'gems/temple-0.6.8').exists()
+            !new File(prepTask.outputDir,'gems/tilt-2.0.1').exists()
+   }
+
+    @IgnoreIf({TESTS_ARE_OFFLINE})
+    def "Check that default 'jrubyPrepareGems' uses the correct directories"() {
+        given:
+            def jrpg = project.tasks.jrubyPrepareGems
+            project.jruby.gemInstallDir = TESTROOT.absolutePath
+
+            project.dependencies {
+                gems OUR_GEM
+            }
+            project.evaluate()
+            jrpg.copy()
+
+        expect:
+            new File(jrpg.outputDir,'gems/slim-2.0.2').exists()
+            new File(jrpg.outputDir,'gems/temple-0.6.8').exists()
+            new File(jrpg.outputDir,'gems/tilt-2.0.1').exists()
+    }
+}