2.0 Sprint 5.4

Author: rpannekoek

README.md

@@ -9,7 +9,7 @@ The SDL Digital Experience Accelerator (DXA) is a reference implementation of SD
 It is available for .NET and Java Web Applications and has a modular architecture consisting of a Framework and example web application providing core functionality and separate Modules for additional, optional functionality.
 
 This repository contains the source code of the DXA Framework, example web application and Maven archetype for Java. 
-The full DXA distribution (including CM-side items and installation support) is downloadable from the [SDL Community site](https://community.sdl.com/developers/tridion_developer/m/mediagallery/1241) (latest version)
+The full DXA distribution (including CM-side items and installation support) is downloadable from the [SDL Appstore site](https://appstore.sdl.com/web-content-management/app/sdl-digital-experience-accelerator-java/737/) (latest version)
 or the [Releases in GitHub](https://github.com/sdl/dxa-web-application-java/releases) (all versions)
 
 Furthermore, the compiled DXA artifacts are available on [Maven Central](http://search.maven.org/#search%7Cga%7C1%7Cdxa). 

build.gradle

@@ -32,7 +32,7 @@ task help(type: MavenHelpTask)
 task buildFramework(type: MavenBuildTask) {
     configurations = [
             ["dxa-oss-parent"],
-            ["dxa-model-service-client"],
+            ["dxa-model-service-client", "dxa-javadoc-tools"],
             ["dxa-framework", "dxa-dd4t-ms-provider"],
             ["> dxa-webapp > clean org.apache.maven.plugins:maven-archetype-plugin:2.4:create-from-project -Darchetype.properties=archetype.properties"]
     ]
@@ -73,7 +73,14 @@ task buildArchetype(type: MavenBuildTask, dependsOn: prepareArchetype) {
     configurations = [["dxa-webapp/target/generated-sources/archetype"]]
 }
 
-task buildDxa(type: MavenBuildTask, dependsOn: [buildFramework, buildArchetype])
+task buildPublicApiDocs(type: MavenBuildTask, dependsOn: buildFramework) {
+    configurations = [
+            //[ "> dxa-framework/dxa-common-api > javadoc:javadoc@publicApi" ],
+            //[ "> dxa-framework/dxa-tridion-provider > javadoc:javadoc@publicApi" ]
+    ]
+}
+
+task buildDxa(type: MavenBuildTask, dependsOn: [buildFramework, buildArchetype, buildPublicApiDocs])
 
 def mavenSettings = {
     if (project.hasProperty('command')) {

dxa-builder/build.gradle

@@ -203,7 +203,9 @@ dependencies {
     compile gradleApi()
     compile localGroovy()
     compile 'org.jdom:jdom2:2.0.5'
-    compile 'jaxen:jaxen:1.1.4'
+    compile 'jaxen:jaxen:1.1.6'
+    compile group: 'commons-configuration', name: 'commons-configuration', version: '1.10'
     compile group: 'commons-validator', name: 'commons-validator', version: '1.5.1'
     testCompile group: 'junit', name: 'junit', version: '4.11'
+    testCompile group: 'org.mockito', name: 'mockito-all', version: '1.10.19'
 }

dxa-builder/src/main/groovy/com/sdl/dxa/builder/configuration/parameters/Parameter.groovy

@@ -89,7 +89,7 @@ class Parameter {
         println ''
 
         if (this.properties) {
-            def param = this;
+            def param = this
             this.properties.each {
                 it.caseSensitive = param.isValueCaseSensitive
                 props[it] = this.get()
@@ -101,7 +101,9 @@ class Parameter {
 
     String request() {
         println "\n  ::  ${description}\n  ::  Default value: '${value ?: 'no default'}'" +
+                (this.isValueCaseSensitive ? "\n  ::  This value is case-sensitive" : '') +
                 "\n\nPress <Enter> to choose default value or type 'halt' to stop"
+
         validator?.describe()
 
         def userValue
@@ -127,6 +129,9 @@ class Parameter {
 
     String get() {
         if (!isValid(value)) {
+            if (this.isValueCaseSensitive) {
+                println "This value is case-sensitive"
+            }
             validator?.describe()
             throw new IllegalArgumentException("Invalid value '${value}' for '${description}'")
         }

dxa-builder/src/main/groovy/com/sdl/dxa/builder/configuration/parameters/PropertiesFileProperty.groovy

@@ -1,5 +1,8 @@
 package com.sdl.dxa.builder.configuration.parameters
 
+import org.apache.commons.configuration.PropertiesConfiguration
+import org.apache.commons.configuration.PropertiesConfigurationLayout
+
 /**
  * Property that is capable to work with {@code *.properties} files.
  */
@@ -11,18 +14,22 @@ class PropertiesFileProperty extends Property {
         }
 
         def file = new File(filename)
-        def properties = new Properties()
-        properties.load(file.newDataInputStream())
+
+        PropertiesConfiguration config = new PropertiesConfiguration()
+        PropertiesConfigurationLayout layout = new PropertiesConfigurationLayout(config)
+
+        layout.load(new InputStreamReader(new FileInputStream(file)))
 
         if (this.append) {
-            def old = properties.get(this.name)
-            if (old == null || !(old as String).contains(value)) {
-                properties.setProperty(this.name, "${(old == null || old == '' ? '' : old + ', ')}${value}")
+            def list = config.getList(this.name)
+            if (!list.contains(value)) {
+                list.add(value)
+                config.setProperty(this.name, list)
             }
         } else {
-            properties.setProperty(this.name, value)
+            config.setProperty(this.name, value)
         }
         println "Modified $filename, set ${name == null ? 'property to' : (name + ' =')} $value"
-        properties.store(file.newWriter(), 'UTF-8')
+        layout.save(new FileWriter(filename, false))
     }
 }

dxa-builder/src/main/groovy/com/sdl/dxa/builder/configuration/parameters/Property.groovy

@@ -64,7 +64,7 @@ abstract class Property {
         def result
 
         if (this.valueMapping) {
-            if (this.caseSensitive) {
+            if (!this.caseSensitive) {
                 value = value.toLowerCase()
             }
 

dxa-builder/src/main/groovy/com/sdl/dxa/builder/maven/MavenBuildTask.groovy

@@ -25,8 +25,26 @@ class MavenBuildTask extends DefaultTask {
 
     def customCommandDelimiter = /\s*>\s*/
 
+    static String mvnVersion() {
+        def mvnVersion = BuildTask.determineShell() + "mvn --version"
+        return mvnVersion.execute().text
+    }
+
+    static boolean isMvnInstalled() {
+        try {
+            return mvnVersion().contains("Maven")
+        } catch (Exception ignored) {
+            return false
+        }
+    }
+
     @TaskAction
     def run() {
+        if (!configurations) {
+            println "Nothing to do with Maven"
+            return
+        }
+
         printMvnVersion()
 
         def pool = Executors.newFixedThreadPool(numberThreads)
@@ -49,7 +67,7 @@ class MavenBuildTask extends DefaultTask {
                     System.in.read()
                 }
                 println "Error building ${output.command}"
-                System.exit(output.code);
+                System.exit(output.code)
             } else {
                 outputPool.submit {
                     println "= SUCCESS (in ${output.timeSeconds}s): ${output.command}"
@@ -77,7 +95,7 @@ class MavenBuildTask extends DefaultTask {
 
     }
 
-    def BuildTask buildTask(String task, Closure callback, boolean verbose) {
+    BuildTask buildTask(String task, Closure callback, boolean verbose) {
         task = task.trim()
 
         if (task =~ customCommandDelimiter) {
@@ -111,13 +129,10 @@ class MavenBuildTask extends DefaultTask {
     }
 
     private static void printMvnVersion() {
-        if (!isVersionShown) {
+        if (!isVersionShown && isMvnInstalled()) {
             isVersionShown = true
 
-            def mvnVersion = BuildTask.determineShell() + "mvn --version"
-            println mvnVersion
-            mvnVersion.execute().in.eachLine { println it }
-            println ""
+            println mvnVersion()
         }
     }
 }

dxa-builder/src/test/groovy/com/sdl/dxa/builder/configuration/writers/XmlWriterTest.groovy

@@ -30,7 +30,7 @@ class XmlWriterTest {
                 '/element/outerTag/innerTag/text()'                   : 'new value',
         ]).save()
 
-        Assert.assertEquals(new File(example).text, new File(pathTo).text)
+        Assert.assertEquals(new File(example).text.normalize(), new File(pathTo).text.normalize())
     }
 
     @Test
@@ -50,7 +50,7 @@ class XmlWriterTest {
                 .modifyByXPath([:])
                 .save()
 
-        Assert.assertEquals(new File(example).text, new File(pathTo).text)
+        Assert.assertEquals(new File(example).text.normalize(), new File(pathTo).text.normalize())
 
         writer = new XmlWriter()
                 .from(fromPath)
@@ -63,7 +63,7 @@ class XmlWriterTest {
                 .modifyByXPath([:])
                 .save()
 
-        Assert.assertEquals(new File(example).text, new File(pathTo).text)
+        Assert.assertEquals(new File(example).text.normalize(), new File(pathTo).text.normalize())
     }
 
     @Test
@@ -93,7 +93,7 @@ class XmlWriterTest {
                 .save()
 
         //then
-        Assert.assertEquals(new File(example).text, new File(pathTo).text)
+        Assert.assertEquals(new File(example).text.normalize(), new File(pathTo).text.normalize())
     }
 
     String path(String path) {

dxa-framework/dxa-common-api/src/main/java/com/sdl/dxa/caching/WebRequestContextLocalizationIdProvider.java

@@ -0,0 +1,17 @@
+package com.sdl.dxa.caching;
+
+import com.sdl.webapp.common.api.WebRequestContext;
+import org.springframework.beans.factory.annotation.Autowired;
+import org.springframework.stereotype.Component;
+
+@Component
+public class WebRequestContextLocalizationIdProvider implements LocalizationIdProvider {
+
+    @Autowired
+    private WebRequestContext webRequestContext;
+
+    @Override
+    public String getId() {
+        return webRequestContext.getLocalization().getId();
+    }
+}

dxa-framework/dxa-common-api/src/main/java/com/sdl/dxa/caching/wrapper/EntitiesCache.java

@@ -5,6 +5,11 @@
 import com.sdl.webapp.common.api.model.EntityModel;
 import org.springframework.stereotype.Component;
 
+/**
+ * Default implementation of entities cache for manual access.
+ *
+ * @dxa.publicApi
+ */
 @Component
 public class EntitiesCache extends SimpleCacheWrapper<EntityModelData, EntityModel> {