Refactor code as to get the docs base URL as a system property (allows switching from "next" to "latest" in dev mode easily)

Author: melix

generator/src/main/groovy/generator/DocUtils.groovy

@@ -0,0 +1,5 @@
+package generator
+
+class DocUtils {
+    @Lazy public static final String DOCS_BASEURL = System.getProperty('docs_baseurl')
+}

generator/src/main/groovy/generator/DocumentationHTMLCleaner.groovy

@@ -59,7 +59,7 @@ class DocumentationHTMLCleaner {
             def (String tag, String attr, String url) = [it[1], it[2], it[3]]
             url = url.replaceAll(/x(.+)\.(?:pagespeed.+)/, '$1')
             if (!url.startsWith('http') && !url.startsWith('#') && 'target.html'!=url) {
-                "$tag $attr'http://docs.groovy-lang.org/latest/html/documentation/$url'"
+                "$tag $attr'${DocUtils.DOCS_BASEURL}/html/documentation/$url'"
             } else {
                 it[0]
             }

generator/src/main/groovy/generator/PageTemplate.groovy

@@ -54,4 +54,7 @@ abstract class PageTemplate extends BaseTemplate {
         asciidoctor.convert(body,options)
     }
 
+    String latestDocURL(String target) {
+        "${DocUtils.DOCS_BASEURL}/html/$target"
+    }
 }

generator/src/main/groovy/generator/SiteGenerator.groovy

@@ -107,7 +107,7 @@ class SiteGenerator {
                     render 'docpage', item.targetFilename, [
                             category: 'Learn',
                             title: item.name,
-                            page: parsePage("http://docs.groovy-lang.org/docs/latest/html/documentation/${item.sourceFilename}.html")]
+                            page: parsePage("${DocUtils.DOCS_BASEURL}/html/documentation/${item.sourceFilename}.html")]
                 }
             }
         }

generator/src/main/groovy/model/SiteMap.groovy

@@ -4,6 +4,7 @@ import groovy.transform.ToString
 import org.codehaus.groovy.control.CompilerConfiguration
 
 import groovy.transform.CompileStatic
+import org.codehaus.groovy.control.customizers.ImportCustomizer
 
 @CompileStatic
 @ToString(includeNames=true)
@@ -23,6 +24,9 @@ class SiteMap {
 
     public static SiteMap from(File source) {
         CompilerConfiguration config = new CompilerConfiguration()
+        def customizer = new ImportCustomizer()
+        config.addCompilationCustomizers(customizer)
+        customizer.addStaticImport('generator.DocUtils','DOCS_BASEURL')
         config.scriptBaseClass = 'groovy.util.DelegatingScript'
         GroovyShell shell = new GroovyShell(config)
         def script = shell.parse(source)

gradle.properties

@@ -0,0 +1 @@
+systemProp.docs_baseurl=http://docs.groovy-lang.org/latest

site/build.gradle

@@ -39,7 +39,7 @@ task generateSite(type:JavaExec) {
     classpath = project(':generator').sourceSets.main.runtimeClasspath
     main = 'generator.SiteGenerator'
     args = [sources, outputDir, project.watchmode]
-
+    systemProperties.docs_baseurl = System.getProperty('docs_baseurl')
 }
 
 task checkDeadLinks(dependsOn: generateSite) {

site/src/site/pages/404.groovy

@@ -5,9 +5,6 @@
 layout 'layouts/main.groovy', true,
         pageTitle: 'The Groovy programming language - 404',
         mainContent: contents {
-            def latestURL = { String target ->
-                "http://docs.groovy-lang.org/latest/html/$target"
-            }
             div(id: 'content', class: 'page-1') {
                 div(class: 'row') {
                     div(class: 'row-fluid') {
@@ -16,10 +13,10 @@ layout 'layouts/main.groovy', true,
                             div(class: 'panel-body') {
                                 p 'We could not find the page you are looking for. Maybe you are looking for one of those?'
                                 ul {
-                                    li("The ${$a(href: latestURL('documentation'), 'reference documentation')} of the Groovy language.")
-                                    li("The latest ${$a(href: latestURL('api'), 'Javadocs')} of the language.")
-                                    li("The latest ${$a(href: latestURL('gapi'), 'Groovdocs')} of the Latestlanguage.")
-                                    li("Description of ${$a(href: latestURL('groovy-jdk'), 'the Groovy development kit APIs')}.")
+                                    li("The ${$a(href: latestDocURL('documentation'), 'reference documentation')} of the Groovy language.")
+                                    li("The latest ${$a(href: latestDocURL('api'), 'Javadocs')} of the language.")
+                                    li("The latest ${$a(href: latestDocURL('gapi'), 'Groovdocs')} of the Latestlanguage.")
+                                    li("Description of ${$a(href: latestDocURL('groovy-jdk'), 'the Groovy development kit APIs')}.")
                                 }
                             }
                         }

site/src/site/pages/release-notes.groovy

@@ -1,3 +1,5 @@
+import generator.DocUtils
+
 modelTypes = {
     String groovyVersion
     String notes
@@ -11,8 +13,8 @@ layout 'layouts/main.groovy', true,
             script { yieldUnescaped "document.addEventListener('DOMContentLoaded',prettyPrint)" }
         },
         mainContent: contents {
-
-            def notesAsHTML = asciidocText(notes)
+            Map options = [attributes:[DOCS_BASEURL:DocUtils.DOCS_BASEURL]]
+            def notesAsHTML = asciidocText(notes,options)
             def matcher = notesAsHTML =~ /<h2 id="(.+?)">(.+?)<\/h2>/
             def sections = [:]
             while (matcher.find()) {

site/src/site/releasenotes/groovy-1.6.adoc

@@ -864,7 +864,7 @@ html.body.'**'[email protected](~/.*\.pdf/).each{ println it }
 
 For the pleasure of giving another example: let’s use
 the link:http://eclipse.org/jetty/[Jetty servlet container] to
-expose link:http://docs.groovy-lang.org/next/html/documentation/template-engines.html[Groovy templates] in
+expose link:{DOCS_BASEURL}/html/documentation/template-engines.html[Groovy templates] in
 a few lines of code:
 
 [source,groovy]
@@ -983,7 +983,7 @@ bean location: bind { pos.x + ', ' + pos.y }
 --------------------------------------------
 
 You may also be interested in having a look
-at link:http://docs.groovy-lang.org/latest/html/api/groovy/util/ObservableMap.html[ObservableMap] and link:http://docs.groovy-lang.org/latest/html/api/groovy/util/ObservableList.html[ObservableList],
+at link:{DOCS_BASEURL}/html/api/groovy/util/ObservableMap.html[ObservableMap] and link:{DOCS_BASEURL}/html/api/groovy/util/ObservableList.html[ObservableList],
 for a similar mechanism on maps and lists.
 
 Along with `@Bindable`, there’s also a `@Vetoable` transformation for

site/src/site/releasenotes/groovy-2.1.adoc

@@ -246,7 +246,7 @@ delegate based methods, but we hinted at the fact we can go beyond, in
 terms of static type checking for your DSLs.
 
 For more details take a look at
-the link:http://docs.groovy-lang.org/docs/latest/html/documentation/#__code_delegatesto_code[@DelegatesTo documentation].
+the link:{DOCS_BASEURL}/html/documentation/#__code_delegatesto_code[@DelegatesTo documentation].
 
 [[Groovy21releasenotes-Typecheckerextensions]]
 == Type checker extensions

site/src/site/releasenotes/groovy-2.3.adoc

@@ -54,7 +54,7 @@ particular Groovy methods decorating JDK 8 APIs might be added.
 
 A major highlight for Groovy 2.3 is the introduction of the *concept of traits*.
 
-link:http://docs.groovy-lang.org/latest/html/documentation/core-traits.html[Traits]
+link:{DOCS_BASEURL}/html/documentation/core-traits.html[Traits]
 are reusable components of behavior that your classes can implement, and
 are an additional Object-Oriented concept alongside classes and
 interfaces.
@@ -192,7 +192,7 @@ assert na.quack() == 'Quack!'
 ----
 
 You can find more information on traits in the
-exhaustive link:http://docs.groovy-lang.org/latest/html/documentation/core-traits.html[traits documentation].
+exhaustive link:{DOCS_BASEURL}/html/documentation/core-traits.html[traits documentation].
 
 [[Groovy2.3releasenotes-NewandupdatedASTtransformations]]
 == New and updated AST transformations
@@ -271,7 +271,7 @@ assert person.age == 21
 -----
 
 You can have a look at
-the link:http://docs.groovy-lang.org/latest/html/documentation/core-metaprogramming.html#xform-Builder[@Builder documentation]
+the link:{DOCS_BASEURL}/html/documentation/core-metaprogramming.html#xform-Builder[@Builder documentation]
 for the other builder variants.
 
 [[Groovy2.3releasenotes-Sortable]]
@@ -310,7 +310,7 @@ Additionally, you can define included / excluded fields, access
 individual field comparators with methods like `comparatorByFirst()`.
 
 More details on
-the http://docs.groovy-lang.org/latest/html/documentation/core-metaprogramming.html#xform-Sortable[@Sortable documentation] page.
+the {DOCS_BASEURL}/html/documentation/core-metaprogramming.html#xform-Sortable[@Sortable documentation] page.
 
 [[Groovy2.3releasenotes-SourceURI]]
 ==== @SourceURI
@@ -363,7 +363,7 @@ the name and parameter types expressed in an interface type
 [[Groovy2.3releasenotes-BaseScriptclassimprovements]]
 ==== @BaseScript class improvements
 
-http://docs.groovy-lang.org/latest/html/gapi/groovy/transform/BaseScript.html[@BaseScript]
+{DOCS_BASEURL}/html/gapi/groovy/transform/BaseScript.html[@BaseScript]
 is a fairly recent addition in Groovy, and it allowed to annotate a
 variable in your script to instruct the compiler to use a particular
 base script class for this script. Now we have another notation which is
@@ -470,9 +470,9 @@ level as competing libraries.
 Beside the performance improvements of the JSON module, other updates
 have taken place.
 
-With link:http://docs.groovy-lang.org/latest/html/gapi/groovy/json/JsonSlurper.html[JsonSlurper],
+With link:{DOCS_BASEURL}/html/gapi/groovy/json/JsonSlurper.html[JsonSlurper],
 you’ll be able to set
-different link:http://docs.groovy-lang.org/latest/html/gapi/groovy/json/JsonParserType.html[parser types]
+different link:{DOCS_BASEURL}/html/gapi/groovy/json/JsonParserType.html[parser types]
 depending on the kind of input you wish to parse, particularly if
 you know the size of the payload you expect to parse, or whether you
 want a more tolerant parser which accepts elements like comments which
@@ -516,7 +516,7 @@ give the type of the parameter, but it’s no longer required:
 
 In the signature of your methods taking closures as arguments, you’ll
 also be able to annotate the closure parameter
-with link:http://docs.groovy-lang.org/latest/html/gapi/groovy/transform/stc/ClosureParams.html[@ClosureParams]
+with link:{DOCS_BASEURL}/html/gapi/groovy/transform/stc/ClosureParams.html[@ClosureParams]
 to give additional hints to the type checker to infer the type of the
 parameters passed to your closure.
 
@@ -534,7 +534,7 @@ internationalization, includes, as well as proposing type checked
 templates and models.
 
 More details about the
-new link:http://docs.groovy-lang.org/latest/html/documentation/markup-template-engine.html[Markup template engine]
+new link:{DOCS_BASEURL}/html/documentation/markup-template-engine.html[Markup template engine]
 in the documentation, as well as in Cédric’s link:http://melix.github.io/blog/[blog], if you want to learn more
 about the "behind the scenes" stories!
 
@@ -624,7 +624,7 @@ compiled.
 == JUnit 4 GroovyAssert class
 
 The
-venerable link:http://docs.groovy-lang.org/latest/html/gapi/groovy/util/GroovyTestCase.html[GroovyTestCase]
+venerable link:{DOCS_BASEURL}/html/gapi/groovy/util/GroovyTestCase.html[GroovyTestCase]
 (JUnit 3 based approach) has often been used as a base class for your
 test classes — unless you’ve been using
 the link:http://www.spockframework.org/[Spock testing framework], of course.
@@ -633,7 +633,7 @@ your own classes, but must derive from `GroovyTestCase` to benefit from
 the additional assertion methods.
 
 In earlier versions of Groovy we introduced the JUnit
-4-friendly link:http://docs.groovy-lang.org/latest/html/gapi/groovy/util/GroovyAssert.html[GroovyAssert],
+4-friendly link:{DOCS_BASEURL}/html/gapi/groovy/util/GroovyAssert.html[GroovyAssert],
 which is a convenient class offering the usual assertion methods of
 `GroovyTestCase`, but in the form of static methods that you can static
 import in your test class. In Groovy 2.3 we’ve enriched `GroovyAssert`
@@ -736,7 +736,7 @@ with link:http://jira.codehaus.org/browse/GROOVY-6459[GROOVY-6459].
 === New documentation
 
 We are still working on the
-brand link:http://docs.groovy-lang.org/docs/latest/html/documentation/[new documentation] for Groovy
+brand link:{DOCS_BASEURL}/html/documentation/[new documentation] for Groovy
 (in Asciidoc(tor) format), so you can already
 have a glimpse at what’s already covered or not.
 
@@ -767,7 +767,7 @@ documentation, showing the methods the Groovy library adds on top of the
 JDK classes.
 
 Please also have a look at the
-new link:http://docs.groovy-lang.org/latest/html/groovy-jdk/[restyled GDK documentation].
+new link:{DOCS_BASEURL}/html/groovy-jdk/[restyled GDK documentation].
 
 [[Groovy2.3releasenotes-Dependencyupgrades]]
 == Dependency upgrades

site/src/site/releasenotes/groovy-2.4.adoc

@@ -2,7 +2,7 @@
 == Android Support
 With Groovy 2.4, you can write Android applications in Groovy!
 
-A quick link:http://docs.groovy-lang.org/docs/latest/html/documentation/tools-groovyc.html#section-android[getting
+A quick link:{DOCS_BASEURL}/html/documentation/tools-groovyc.html#section-android[getting
 started guide] is available on the Groovy website.
 
 To build your Android applications with the Groovy support, you’ll be

site/src/site/sitemap.groovy

@@ -49,9 +49,9 @@ pages {
     page 'buildstatus', 'buildstatus', [category: 'Community']
     page 'faq', 'faq', [category: 'Documentation', docSections: documentationSections]
     page 'events', 'events', [category: 'Community', allEvents: allEvents]
-    page 'api', 'api', [category: 'Learn', iframeTarget: 'http://docs.groovy-lang.org/docs/latest/html/gapi']
-    page 'gdk', 'gdk', [category: 'Learn', iframeTarget: 'http://docs.groovy-lang.org/docs/latest/html/groovy-jdk']
-    page 'singlepagedocumentation', 'single-page-documentation', [category: 'Learn', iframeTarget: 'http://docs.groovy-lang.org/docs/next/html/documentation/']
+    page 'api', 'api', [category: 'Learn', iframeTarget: "${DOCS_BASEURL}/html/gapi"]
+    page 'gdk', 'gdk', [category: 'Learn', iframeTarget: "${DOCS_BASEURL}/html/groovy-jdk"]
+    page 'singlepagedocumentation', 'single-page-documentation', [category: 'Learn', iframeTarget: "${DOCS_BASEURL}/html/documentation/"]
     page 'changelogs', 'changelogs', [:]
     page '404','404', [:]
 }