Store unknown attributes in DesignContext #19749

Change-Id: I1e90d422ec716092e6d407b6965902f48eac1646

server/src/main/java/com/vaadin/ui/AbstractComponent.java

@@ -24,6 +24,8 @@
 import java.util.Iterator;
 import java.util.List;
 import java.util.Locale;
+import java.util.Map;
+import java.util.Map.Entry;
 import java.util.Set;
 import java.util.StringTokenizer;
 import java.util.logging.Logger;
@@ -1041,10 +1043,11 @@ public void readDesign(Element design, DesignContext designContext) {
         supported.addAll(getDefaultAttributes());
         supported.addAll(getCustomAttributes());
         for (Attribute a : attr) {
-            if (!a.getKey().startsWith(":") && !supported.contains(a.getKey())) {
-                getLogger().info(
-                        "Unsupported attribute found when reading from design : "
-                                + a.getKey());
+            if (!a.getKey().startsWith(":")
+                    && !supported.contains(a.getKey())) {
+                // Add unknown attributes as custom attributes to the context
+                designContext.setCustomAttribute(this, a.getKey(),
+                        a.getValue());
             }
         }
     }
@@ -1326,7 +1329,14 @@ public void writeDesign(Element design, DesignContext designContext) {
                     ((Focusable) this).getTabIndex(),
                     ((Focusable) def).getTabIndex(), Integer.class);
         }
-
+        // handle custom attributes
+        Map<String, String> customAttributes = designContext
+                .getCustomAttributes(this);
+        if (customAttributes != null) {
+            for (Entry<String, String> entry : customAttributes.entrySet()) {
+                attr.put(entry.getKey(), entry.getValue());
+            }
+        }
     }
 
     /*

server/src/main/java/com/vaadin/ui/declarative/DesignContext.java

@@ -82,6 +82,7 @@ public class DesignContext implements Serializable {
     // namespace mappings
     private Map<String, String> packageToPrefix = new HashMap<String, String>();
     private Map<String, String> prefixToPackage = new HashMap<String, String>();
+    private final Map<Component, Map<String, String>> customAttributes = new HashMap<Component, Map<String, String>>();
 
     // component creation listeners
     private List<ComponentCreationListener> listeners = new ArrayList<ComponentCreationListener>();
@@ -792,4 +793,37 @@ public ShouldWriteDataDelegate getShouldWriteDataDelegate() {
         return shouldWriteDataDelegate;
     }
 
+    /**
+     * Gets the attributes that the component did not handle
+     * 
+     * @since
+     * @param component
+     *            the component to get the attributes for
+     * @return map of the attributes which were not recognized by the component
+     */
+    public Map<String, String> getCustomAttributes(Component component) {
+        return customAttributes.get(component);
+    }
+
+    /**
+     * Sets a custom attribute not handled by the component. These attributes
+     * are directly written to the component tag.
+     * 
+     * @since
+     * @param component
+     *            the component to set the attribute for
+     * @param attribute
+     *            the attribute to set
+     * @param value
+     *            the value of the attribute
+     */
+    public void setCustomAttribute(Component component, String attribute,
+            String value) {
+        Map<String, String> map = customAttributes.get(component);
+        if (map == null) {
+            customAttributes.put(component,
+                    map = new HashMap<String, String>());
+        }
+        map.put(attribute, value);
+    }
 }

server/src/test/java/com/vaadin/tests/design/DeclarativeTestBaseBase.java

@@ -67,16 +67,29 @@ protected T read(String design) {
         }
     }
 
+    protected DesignContext readAndReturnContext(String design) {
+        try {
+            return Design.read(
+                    new ByteArrayInputStream(design.getBytes("UTF-8")), null);
+        } catch (UnsupportedEncodingException e) {
+            throw new RuntimeException(e);
+        }
+    }
+
     protected String write(T object, boolean writeData) {
+        DesignContext dc = new DesignContext();
+        if (writeData) {
+            dc.setShouldWriteDataDelegate(
+                    DeclarativeTestBaseBase.ALWAYS_WRITE_DATA);
+        }
+        return write(object, dc);
+    }
+
+    protected String write(T object, DesignContext context) {
         try {
             ByteArrayOutputStream outputStream = new ByteArrayOutputStream();
-
-            DesignContext dc = new DesignContext();
-            if (writeData) {
-                dc.setShouldWriteDataDelegate(DeclarativeTestBaseBase.ALWAYS_WRITE_DATA);
-            }
-            dc.setRootComponent(object);
-            Design.write(dc, outputStream);
+            context.setRootComponent(object);
+            Design.write(context, outputStream);
             return outputStream.toString("UTF-8");
         } catch (Exception e) {
             throw new RuntimeException(e);
@@ -216,6 +229,18 @@ public void testWrite(String design, T expected, boolean writeData) {
         Assert.assertEquals(comparable, produced);
     }
 
+    public void testWrite(T component, String expected, DesignContext context) {
+        String written = write(component, context);
+
+        Element producedElem = Jsoup.parse(written).body().child(0);
+        Element comparableElem = Jsoup.parse(expected).body().child(0);
+
+        String produced = elementToHtml(producedElem);
+        String comparable = elementToHtml(comparableElem);
+
+        Assert.assertEquals(comparable, produced);
+    }
+
     protected Element createElement(Component c) {
         return new DesignContext().createElement(c);
     }

server/src/test/java/com/vaadin/tests/server/component/abstractcomponent/AbstractComponentDeclarativeTest.java

@@ -15,6 +15,8 @@
  */
 package com.vaadin.tests.server.component.abstractcomponent;
 
+import static org.junit.Assert.assertTrue;
+
 import java.io.ByteArrayInputStream;
 import java.io.File;
 import java.lang.reflect.Field;
@@ -222,6 +224,18 @@ public void testReadAlreadyResponsive() {
                 .getExtensions().size());
     }
 
+    @Test
+    public void testUnknownProperties() {
+        String design = "<vaadin-label foo=\"bar\"/>";
+
+        DesignContext context = readAndReturnContext(design);
+        Label label = (Label) context.getRootComponent();
+        assertTrue("Custom attribute was preserved in custom attributes",
+                context.getCustomAttributes(label).containsKey("foo"));
+
+        testWrite(label, design, context);
+    }
+
     private Element createDesign(boolean responsive) {
         Attributes attributes = new Attributes();
         attributes.put("responsive", responsive);