v0.3.0 (#8)

Added support for defining a context path prefix.

.gitignore

@@ -1,4 +1,5 @@
 .idea/*
 *.iml
 *.iws
-build/*
+build/*
+.gradle/*

README.md

@@ -21,7 +21,7 @@ You can apply the plugin using the `buildscript` block:
         }
       }
       dependencies {
-        classpath "gradle.plugin.com.stehno.gradle:webpreview:0.2.0"
+        classpath "gradle.plugin.com.stehno.gradle:webpreview:0.3.0"
       }
     }
 
@@ -30,7 +30,7 @@ You can apply the plugin using the `buildscript` block:
 Or the newer `plugins` block:
 
     plugins {
-      id "com.stehno.gradle.webpreview" version "0.2.0"
+      id "com.stehno.gradle.webpreview" version "0.3.0"
     }
 
 ## Usage
@@ -43,6 +43,7 @@ To configure the Web Preview plugin, the `webPreview` extension is provided:
         port = 0
         copyUrl = true
         resourceDir = file('build/web')
+        contextPath = '/'
     }
 
 The `port` property is the web server port where content is to be served. The default is `0`, which will choose a random available port. This port 
@@ -54,6 +55,9 @@ will fail to start without it.
 The `copyUrl` property determines whether or not the server URL is copied to the local clipboard on startup. This is handy when running locally 
 with the random port setting.
 
+The `contextPath` is an optional property used to define the root context path to be used as a prefix for all content. If not specified the server 
+root "/" will be used.
+
 ### Tasks
 
 * `startPreview` - used to start the preview server with the configuration provided in the `webPreview` extension.

build.gradle

@@ -9,7 +9,7 @@ plugins {
     id 'com.stehno.gradle.site' version '0.0.3'
 }
 
-version = '0.2.0'
+version = '0.3.0'
 group = 'com.stehno.gradle'
 
 sourceCompatibility = 8

gradle/wrapper/gradle-wrapper.properties

@@ -1,6 +1,6 @@
-#Wed Mar 15 12:55:27 CDT 2017
+#Fri Apr 28 10:01:12 CDT 2017
 distributionBase=GRADLE_USER_HOME
 distributionPath=wrapper/dists
 zipStoreBase=GRADLE_USER_HOME
 zipStorePath=wrapper/dists
-distributionUrl=https\://services.gradle.org/distributions/gradle-3.4.1-all.zip
+distributionUrl=https\://services.gradle.org/distributions/gradle-3.5-all.zip

src/main/groovy/com/stehno/gradle/web/PreviewServer.groovy

@@ -17,6 +17,8 @@ package com.stehno.gradle.web
 
 import groovy.transform.TypeChecked
 import io.undertow.Undertow
+import io.undertow.server.HttpHandler
+import io.undertow.server.handlers.PathHandler
 import io.undertow.server.handlers.resource.FileResourceManager
 import io.undertow.server.handlers.resource.ResourceHandler
 
@@ -27,20 +29,28 @@ import io.undertow.server.handlers.resource.ResourceHandler
 class PreviewServer {
 
     private Undertow server
+    private String path
 
     /**
      * Starts the server instance on the specified port and resource directory, if it is not already running.
      *
      * @param port the server port
      * @param directory the resource directory to be served
+     * @param contextPath the optional root context path
      */
-    void start(final int port, final File directory) {
+    void start(final int port, final File directory, final String contextPath = null) {
         if (!server) {
-            server = Undertow.builder()
-                .addHttpListener(port, '0.0.0.0')
-                .setHandler(new ResourceHandler(new FileResourceManager(directory, 1)))
-                .build()
+            this.path = contextPath
 
+            HttpHandler handler = new ResourceHandler(new FileResourceManager(directory, 1))
+
+            if (contextPath) {
+                PathHandler pathHandler = new PathHandler()
+                pathHandler.addPrefixPath(contextPath, handler)
+                handler = pathHandler
+            }
+
+            server = Undertow.builder().addHttpListener(port, '0.0.0.0').setHandler(handler).build()
             server.start()
         }
     }
@@ -50,7 +60,11 @@ class PreviewServer {
     }
 
     String getUrl() {
-        server ? "http://localhost:$port" : null
+        server ? "http://localhost:$port$contextPath" : null
+    }
+
+    String getContextPath() {
+        return path ? (path.startsWith('/') ? path : "/$path") : ''
     }
 
     void stop() {

src/main/groovy/com/stehno/gradle/web/StartPreviewTask.groovy

@@ -34,7 +34,7 @@ class StartPreviewTask extends DefaultTask {
         assert extension.resourceDir, 'No resourceDir configuration was provided.'
 
         PreviewServer server = PreviewServer.instance
-        server.start(extension.port, extension.resourceDir)
+        server.start(extension.port, extension.resourceDir, extension.contextPath)
 
         logger.lifecycle 'Started preview server ({}) for {}', server.url, extension.resourceDir
 

src/main/groovy/com/stehno/gradle/web/WebPreviewExtension.groovy

@@ -35,4 +35,9 @@ class WebPreviewExtension {
      * Whether or not the server URL is copied to the local clipboard on startup.
      */
     boolean copyUrl = true
+
+    /**
+     * Specifies the optional root context path.
+     */
+    String contextPath
 }

src/site/index.html

@@ -60,6 +60,7 @@ <h2>Configure It</h2>
     port = 0
     copyUrl = true
     resourceDir = file('build/web')
+    contextPath = '/'
 }</pre>
 
         <p>where:</p>
@@ -74,6 +75,9 @@ <h2>Configure It</h2>
             <li><code>copyUrl</code> - determines whether or not the server URL is copied to the local clipboard on startup. This is handy when
                 running locally with the random port setting.
             </li>
+            <li><code>contextPath</code> - optional root context path to be used as a prefix for all content. If not specified the server root "/"
+                will be used.
+            </li>
         </ul>
 
         <h2>Use It</h2>

src/test/groovy/com/stehno/gradle/web/PreviewTaskSpec.groovy

@@ -84,6 +84,46 @@ class PreviewTaskSpec extends Specification implements UsesGradleBuild {
         PreviewServer.instance.stop()
     }
 
+    def 'preview server with context path'(){
+        setup:
+        Random random = new Random()
+
+        def portRange = 10101..20202
+        int serverPort = portRange[random.nextInt(portRange.size())]
+
+        buildFile(extension: """
+            webPreview {
+                port = $serverPort
+                resourceDir = file('src/site')
+                copyUrl = false
+                contextPath = 'foo'
+            }
+        """)
+
+        String content = 'This is some really cool web content!'
+
+        File siteDir = projectRoot.newFolder('src', 'site')
+        new File(siteDir, 'index.html').text = content
+
+        when:
+        BuildResult result = gradleRunner(['startPreview']).build()
+
+        then:
+        totalSuccess result
+
+        and:
+        "http://localhost:$serverPort/foo/index.html".toURL().text == content
+
+        when:
+        "http://localhost:$serverPort/index.html".toURL().text != content
+
+        then:
+        thrown(FileNotFoundException)
+
+        cleanup:
+        PreviewServer.instance.stop()
+    }
+
     @Override
     String getBuildTemplate() {
         '''