NIHVIVO-2470 Initial work on new dump template. Handle undefined variables.

webapp/src/edu/cornell/mannlib/vitro/webapp/controller/freemarker/FreemarkerHttpServlet.java

@@ -316,6 +316,9 @@ public class FreemarkerHttpServlet extends VitroHttpServlet {
         map.put("dump", new edu.cornell.mannlib.vitro.webapp.web.directives.dump.DumpDirective());
         map.put("dumpAll", new edu.cornell.mannlib.vitro.webapp.web.directives.dump.DumpAllDirective());  
         map.put("help", new edu.cornell.mannlib.vitro.webapp.web.directives.dump.HelpDirective()); 
+        map.put("dump1", new freemarker.ext.dump.DumpDirective());
+        map.put("dumpAll1", new freemarker.ext.dump.DumpAllDirective());  
+        map.put("help1", new freemarker.ext.dump.HelpDirective()); 
         map.put("url", new edu.cornell.mannlib.vitro.webapp.web.directives.UrlDirective()); 
         map.put("widget", new edu.cornell.mannlib.vitro.webapp.web.directives.WidgetDirective());
         return map;

webapp/src/freemarker/ext/dump/BaseDumpDirective.java

@@ -50,14 +50,16 @@ public abstract class BaseDumpDirective implements TemplateDirectiveModel {
 
     private static final Log log = LogFactory.getLog(BaseDumpDirective.class);
     
-    Pattern PROPERTY_NAME_PATTERN = Pattern.compile("^(get|is)\\w");
+    protected static final String TEMPLATE_DEFAULT = "dump1.ftl";  // change to dump.ftl when old dump is removed  
+    protected static final String VALUE_UNDEFINED = "Undefined";
+    protected static final Pattern PROPERTY_NAME_PATTERN = Pattern.compile("^(get|is)\\w");
     
     enum Key {
+        DATE_TYPE("dateType"),
         METHODS("methods"),
         PROPERTIES("properties"),
         TYPE("type"),
-        VALUE("value"),
+        VALUE("value");
-        DATE_TYPE("dateType");
     
         private final String key;
         
@@ -71,17 +73,18 @@ public abstract class BaseDumpDirective implements TemplateDirectiveModel {
     }
     
     enum Type {
-        STRING("String"),
-        NUMBER("Number"),
         BOOLEAN("Boolean"),
+        COLLECTION("Collection"),
         DATE("Date"),
-        SEQUENCE("Sequence"),
+        DIRECTIVE("Directive"),
         HASH("Hash"),
         // Technically it's a HashEx, but for the templates call it a Hash
         HASH_EX("Hash"), // ("HashEx")
-        COLLECTION("Collection"),
         METHOD("Method"),        
-        DIRECTIVE("Directive");
+        NUMBER("Number"),
+        SEQUENCE("Sequence"),
+        STRING("String"),
+        UNDEFINED("Undefined");
         
         private final String type;
         
@@ -124,11 +127,13 @@ public abstract class BaseDumpDirective implements TemplateDirectiveModel {
 
         Map<String, Object> value = new HashMap<String, Object>();
         
-        // Don't return null if model == null. We still want to send the map to the template.
+        if (model == null) {
-        if (model != null) {
+            value.put(Key.TYPE.toString(), Type.UNDEFINED);
+            value.put(Key.VALUE.toString(), VALUE_UNDEFINED);
+
         // TemplateMethodModel and TemplateDirectiveModel objects can only be
         // included in the data model at the top level.
-            if (model instanceof TemplateMethodModel) {
+        } else if (model instanceof TemplateMethodModel) {
             value.putAll( getTemplateModelDump( ( TemplateMethodModel)model, varName ) );
             
         } else if (model instanceof TemplateDirectiveModel) {
@@ -137,7 +142,6 @@ public abstract class BaseDumpDirective implements TemplateDirectiveModel {
         } else {
             value.putAll(getDump(model));
         }
-        }
 
         Map<String, Object> dump = new HashMap<String, Object>();
         dump.put(varName, value);
@@ -455,9 +459,13 @@ public abstract class BaseDumpDirective implements TemplateDirectiveModel {
         return map;        
     }
     
-    protected void dump(String templateName, Map<String, Object> map, Environment env) 
+    protected void dump(String templateName, Map<String, Object> dump, Environment env) 
     throws TemplateException, IOException {
         
+        // Wrap the dump in another map so the template has a handle to iterate through
+        // the values: <#list dump?keys as key>...</#list>
+        Map<String, Map<String, Object>> map = new HashMap<String, Map<String, Object>>();
+        map.put("dump", dump);
         Template template = env.getConfiguration().getTemplate(templateName);
         StringWriter sw = new StringWriter();
         template.process(map, sw);     

webapp/src/freemarker/ext/dump/DumpAllDirective.java

@@ -4,7 +4,6 @@ package freemarker.ext.dump;
 
 import java.io.IOException;
 import java.util.ArrayList;
-import java.util.Collections;
 import java.util.HashMap;
 import java.util.List;
 import java.util.Map;
@@ -48,7 +47,7 @@ public class DumpAllDirective extends BaseDumpDirective {
         }
 
         SortedMap<String, Object> dataModelDump = getDataModelDump(env);
-        dump("dump-all.ftl", dataModelDump, env); 
+        dump(TEMPLATE_DEFAULT, dataModelDump, env); 
     }
     
     SortedMap<String, Object> getDataModelDump(Environment env) throws TemplateModelException {

webapp/src/freemarker/ext/dump/DumpDirective.java

@@ -37,16 +37,10 @@ public class DumpDirective extends BaseDumpDirective {
                 "The dump directive doesn't allow nested content.");
         }
         
-        Object o = params.get("var");
+        String varName = params.get("var").toString();  
-        if ( !(o instanceof SimpleScalar)) {
-            throw new TemplateModelException(
-               "Value of parameter 'var' must be a string.");     
-        }
-        
-        String varName = ((SimpleScalar)o).getAsString();       
         Map<String, Object> map = getTemplateVariableDump(varName, env); 
 
-        dump("dumpvar.ftl", map, env);   
+        dump(TEMPLATE_DEFAULT, map, env);   
     }
     
     @Override

webapp/src/freemarker/ext/dump/HelpDirective.java

@@ -41,12 +41,7 @@ public class HelpDirective extends BaseDumpDirective {
                 "Must specify 'for' argument.");
         }
 
-        if ( !(o instanceof SimpleScalar)) {
+        String varName = params.get("var").toString(); 
-            throw new TemplateModelException(
-               "Value of parameter 'for' must be a string.");     
-        }  
-        
-        String varName = ((SimpleScalar)o).getAsString();  
         TemplateHashModel dataModel = env.getDataModel();    
         Object templateModel = dataModel.get(varName);
 
@@ -61,7 +56,7 @@ public class HelpDirective extends BaseDumpDirective {
         }
 
         Map<String, Object> map = getTemplateVariableDump(varName, env);
-        dump("dumpvar.ftl", map, env);         
+        dump(TEMPLATE_DEFAULT, map, env);         
     }
     
     @Override

webapp/test/freemarker/ext/dump/DumpDirectiveTest.java

@@ -71,6 +71,22 @@ public class DumpDirectiveTest {
         Logger.getLogger(BaseDumpDirective.class).setLevel(Level.OFF);
     }
 
+    @Test
+    public void dumpUndefinedValue() {
+        
+        String varName = "dog";
+        Map<String, Object> dataModel = new HashMap<String, Object>();
+        
+        Map<String, Object> expectedDumpValue = new HashMap<String, Object>();
+        expectedDumpValue.put(Key.TYPE.toString(), Type.UNDEFINED);
+        expectedDumpValue.put(Key.VALUE.toString(), BaseDumpDirective.VALUE_UNDEFINED);
+
+        Map<String, Object> expectedDump = new HashMap<String, Object>();
+        expectedDump.put(varName, expectedDumpValue);
+        
+        test(varName, dataModel, expectedDump);
+    }
+    
     @Test
     public void dumpString() {
         

webapp/web/templates/freemarker/body/partials/dump/describe.ftl

@@ -1,13 +0,0 @@
-<#-- $This file is distributed under the terms of the license in /doc/license.txt$ -->
-
-<#-- Template for displaying directive describe -->
-
-<div class="dump">
-    <h3>Methods available to variable <em>${var}</em></h3>
-
-    <#list methods as method>
-        ${method}<br />
-    </#list>
-</div>
-
-${stylesheets.add('<link rel="stylesheet" href="${urls.base}/css/dump.css" />')}

webapp/web/templates/freemarker/body/partials/dump/dump-all.ftl

@@ -1 +0,0 @@
-<#-- $This file is distributed under the terms of the license in /doc/license.txt$ -->

webapp/web/templates/freemarker/body/partials/dump/dump1.ftl

@@ -0,0 +1,39 @@
+<#-- $This file is distributed under the terms of the license in /doc/license.txt$ -->
+
+<#-- Template for dump directives -->
+
+<#-- Styles here are temporary; move to css file once stylesheets.add() works -->
+<style>
+ul.dump {
+    padding-top: .75em;
+    padding-bottom: .75em;
+    border-top: 1px solid #ccc;
+    border-bottom: 1px solid #ccc; 
+    margin-bottom: .5em;
+}
+
+ul.dump li p {
+    margin-bottom: .5em;
+}
+</style>
+
+<#-- <pre><@dumper.dump dump /></pre> -->
+
+<#if dump?keys?has_content>
+    <ul class="dump">
+        <#list dump?keys as key>
+            <li>
+                <#assign value = dump[key] />
+                <p><strong>Variable name:</strong> ${key}</p>
+                <#if value.type??><p><strong>Type:</strong> ${value.type}</p></#if>   
+                <#-- <p><strong>Value:</strong> ${value.value}</p> -->
+                <#-- What to do here depends on time. Test either ${var.type} or ${var.value} -->
+                <#-- <p><strong>Value:</strong> ${var.value}</p> -->
+            </li>       
+        </#list>
+    </ul> 
+</#if>
+
+<#-- This will work after we move stylesheets to Configuration sharedVariables 
+${stylesheets.add('<link rel="stylesheet" href="/css/fmdump.css">')}
+-->