DXA DXA 2.0 CTP 2 Release

Author: rpannekoek

build.gradle

@@ -31,7 +31,7 @@ task help(type: MavenHelpTask)
 
 task buildFramework(type: MavenBuildTask) {
     configurations = [
-            //["dxa-bom"],
+            ["dxa-oss-parent"],
             ["dxa-framework"],
             ["> dxa-webapp > clean org.apache.maven.plugins:maven-archetype-plugin:2.4:create-from-project -Darchetype.properties=archetype.properties"]
     ]

dxa-builder/build.gradle

@@ -10,6 +10,33 @@ targetCompatibility = '1.8'
 
 def isRelease = !version.endsWith("-SNAPSHOT") && project.hasProperty('release')
 
+gradle.taskGraph.whenReady { taskGraph ->
+    if (taskGraph.allTasks.any { it instanceof Sign }) {
+        if (isRelease && !(project.hasProperty('signing.keyId') &&
+                project.hasProperty('signing.secretKeyRingFile') &&
+                project.hasProperty('signing.password'))) {
+            def reader = System.in.newReader()
+            println "\n\nWe have to sign some things in this build." +
+                    "\n\nPlease enter your signing details."
+
+            println "PGP Key Id: "
+            def id = reader.readLine()
+
+            println "PGP Secret Key Ring File (absolute path): "
+            def file = reader.readLine()
+
+            println "PGP Private Key Password: "
+            def password = reader.readLine()
+
+            allprojects { ext."signing.keyId" = id }
+            allprojects { ext."signing.secretKeyRingFile" = file }
+            allprojects { ext."signing.password" = password }
+
+            reader.printf "\nThanks.\n\n"
+        }
+    }
+}
+
 task wrapper(type: Wrapper) {
     gradleVersion = '2.9'
     distributionUrl = "https://services.gradle.org/distributions/gradle-$gradleVersion-all.zip"

dxa-builder/gradle.properties

@@ -1 +1 @@
-version=2.0.0-SNAPSHOT
+version=2.0.0-CTP2

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

@@ -1,11 +1,14 @@
 package com.sdl.dxa.builder.configuration.parameters
 
+import org.jdom2.Namespace
+
 class XmlProperty extends Property {
 
     private Map<String, String> xmlAddNodesMap = [:]
     private Map<String, String> xmlAddAttributesMap = [:]
     private String[] xmlModifyArray = []
 
+    Namespace namespace
     boolean canBeEmpty
     Map<String, Tuple2<String, String>> addNodesMap = [:]
     Map<String, Tuple2<String, String>> addAttributesMap = [:]
@@ -26,6 +29,12 @@ class XmlProperty extends Property {
         this
     }
 
+    XmlProperty thatModifiesXml(Namespace namespace, String... xmlModifyNodes) {
+        this.xmlModifyArray = xmlModifyNodes
+        this.namespace = namespace
+        this
+    }
+
     XmlProperty thatCanBeEmpty() {
         this.canBeEmpty = true
         this

dxa-builder/src/main/groovy/com/sdl/dxa/builder/configuration/writers/XmlWriter.groovy

@@ -3,6 +3,7 @@ package com.sdl.dxa.builder.configuration.writers
 import com.sdl.dxa.builder.configuration.parameters.XmlProperty
 import org.jdom2.Document
 import org.jdom2.Element
+import org.jdom2.filter.Filters
 import org.jdom2.input.SAXBuilder
 import org.jdom2.output.Format
 import org.jdom2.output.XMLOutputter
@@ -53,15 +54,15 @@ class XmlWriter {
         this
     }
 
-    XmlWriter addAttributes(Map<String, Tuple2<String, String>> mapToAdd) {
-        bulkEdit mapToAdd, { nodes, Tuple2<String, String> value ->
+    XmlWriter addAttributes(Map<String, Tuple2<String, String>> mapToAdd, XmlProperty xmlProperty) {
+        bulkEdit mapToAdd, xmlProperty, { nodes, Tuple2<String, String> value ->
             nodes*.setAttribute(value.first, value.second)
         }
         this
     }
 
-    XmlWriter addNodesAfter(Map<String, Tuple2<String, String>> mapToAdd) {
-        bulkEdit mapToAdd, { nodes, Tuple2<String, String> value ->
+    XmlWriter addNodesAfter(Map<String, Tuple2<String, String>> mapToAdd, XmlProperty xmlProperty) {
+        bulkEdit mapToAdd, xmlProperty, { nodes, Tuple2<String, String> value ->
             def tagName = value.first
             def tagValue = value.second
 
@@ -73,22 +74,41 @@ class XmlWriter {
         this
     }
 
-    XmlWriter modifyByXPath(Map<String, String> mapToModify) {
-        bulkEdit mapToModify, { nodes, value ->
+    XmlWriter modifyByXPath(Map<String, String> mapToModify, XmlProperty xmlProperty) {
+        bulkEdit mapToModify, xmlProperty, { nodes, value ->
             nodes*.value = value
         }
         this
     }
 
+
+    XmlWriter addAttributes(Map<String, Tuple2<String, String>> mapToAdd) {
+        addAttributes mapToAdd, null
+    }
+
+    XmlWriter addNodesAfter(Map<String, Tuple2<String, String>> mapToAdd) {
+        addNodesAfter mapToAdd, null
+    }
+
+    XmlWriter modifyByXPath(Map<String, String> mapToModify) {
+        modifyByXPath mapToModify, null
+    }
+
     XmlWriter modify(XmlProperty xmlProperty) {
-        addNodesAfter(xmlProperty.addNodesMap)
-        addAttributes(xmlProperty.addAttributesMap)
-        modifyByXPath(xmlProperty.modifyMap)
+        addNodesAfter(xmlProperty.addNodesMap, xmlProperty)
+        addAttributes(xmlProperty.addAttributesMap, xmlProperty)
+        modifyByXPath(xmlProperty.modifyMap, xmlProperty)
     }
 
-    private bulkEdit(Map<String, ?> map, Closure callback) {
+    private bulkEdit(Map<String, ?> map, XmlProperty xmlProperty, Closure callback) {
         map?.each {
-            callback xPathFactory.compile(it.key).evaluate(document), it.value
+            if (xmlProperty != null && xmlProperty.namespace != null) {
+                return callback(xPathFactory.compile(it.key, Filters.fpassthrough(), null,
+                        xmlProperty.namespace).evaluate(document), it.value)
+            } else {
+                return callback(xPathFactory.compile(it.key).evaluate(document), it.value)
+            }
+
         }
     }
 }

dxa-framework/dxa-common-api/pom.xml

@@ -6,7 +6,7 @@
     <parent>
         <groupId>com.sdl.dxa</groupId>
         <artifactId>dxa-framework</artifactId>
-        <version>2.0.0-SNAPSHOT</version>
+        <version>2.0.0-CTP2</version>
     </parent>
 
     <artifactId>dxa-common-api</artifactId>
@@ -63,6 +63,16 @@
             <artifactId>guava</artifactId>
         </dependency>
 
+        <dependency>
+            <groupId>javax.cache</groupId>
+            <artifactId>cache-api</artifactId>
+        </dependency>
+        <dependency>
+            <groupId>org.ehcache</groupId>
+            <artifactId>ehcache</artifactId>
+            <scope>test</scope>
+        </dependency>
+
         <!-- Joda Time -->
         <dependency>
             <groupId>joda-time</groupId>

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

@@ -0,0 +1,27 @@
+package com.sdl.dxa.caching;
+
+import com.google.common.collect.Lists;
+import com.sdl.webapp.common.api.WebRequestContext;
+import org.springframework.beans.factory.annotation.Autowired;
+import org.springframework.cache.interceptor.KeyGenerator;
+import org.springframework.cache.interceptor.SimpleKeyGenerator;
+import org.springframework.stereotype.Component;
+
+import java.lang.reflect.Method;
+
+@Component
+public class LocalizationAwareKeyGenerator implements KeyGenerator {
+
+    @SuppressWarnings("SpringAutowiredFieldsWarningInspection")
+    @Autowired
+    private WebRequestContext webRequestContext;
+
+    @Override
+    public Object generate(Object target, Method method, Object... params) {
+        return SimpleKeyGenerator.generateKey(Lists.asList(webRequestContext.getLocalization().getId(), params).toArray(new Object[params.length + 1]));
+    }
+
+    public Object generate(Object... params) {
+        return generate(null, null, params);
+    }
+}

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

@@ -0,0 +1,25 @@
+package com.sdl.dxa.caching;
+
+import com.sdl.webapp.common.api.model.ViewModel;
+
+import java.lang.annotation.ElementType;
+import java.lang.annotation.Inherited;
+import java.lang.annotation.Retention;
+import java.lang.annotation.RetentionPolicy;
+import java.lang.annotation.Target;
+
+/**
+ * Annotates types that should never be cached to be used with subtypes of {@link ViewModel}.
+ */
+@Target({ElementType.ANNOTATION_TYPE, ElementType.TYPE})
+@Retention(RetentionPolicy.RUNTIME)
+@Inherited
+public @interface NeverCached {
+
+    /**
+     * Qualifier of the annotated model to be used as a one-to-one identifier of the type.
+     *
+     * @return alias aka qualifier of the annotated model
+     */
+    String qualifier();
+}

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

@@ -0,0 +1,23 @@
+package com.sdl.dxa.caching.wrapper;
+
+import com.sdl.webapp.common.api.model.MvcData;
+import lombok.Value;
+
+import javax.servlet.http.HttpServletRequest;
+
+/**
+ * Composite key (DTO) for output caching.
+ */
+@Value
+public class CompositeOutputCacheKey {
+
+    private String pageId;
+
+    private String name;
+
+    private String include;
+
+    private MvcData mvcData;
+
+    private HttpServletRequest request;
+}

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

@@ -0,0 +1,16 @@
+package com.sdl.dxa.caching.wrapper;
+
+import lombok.Builder;
+import lombok.Value;
+
+/**
+ * Entity that determines if this key should be cached.
+ */
+@Value
+@Builder
+public class ConditionalKey {
+
+    private Object key;
+
+    private boolean skipCaching;
+}