From 1ccde72b403cccb76d10f1ee2d1848134f4ef263 Mon Sep 17 00:00:00 2001 From: rjy7 Date: Thu, 29 Jul 2010 13:44:53 +0000 Subject: [PATCH] NIHVIVO-564 Going back to using toString() methods for template model dump since it already handles nested collections. Improvements to DumpDataModelDirective so it dumps out values as well as variable names. --- .../directives/DumpDataModelDirective.java | 57 +++++++++------ .../webapp/web/directives/DumpDirective.java | 72 ++++++++++++------- .../body/partials/dump/dump-datamodel.ftl | 24 +++++++ .../{dump-array.ftl => dump-sequence.ftl} | 4 +- .../body/partials/dump/dump-var.ftl | 3 +- webapp/web/templates/freemarker/body/test.ftl | 4 +- 6 files changed, 111 insertions(+), 53 deletions(-) create mode 100644 webapp/web/templates/freemarker/body/partials/dump/dump-datamodel.ftl rename webapp/web/templates/freemarker/body/partials/dump/{dump-array.ftl => dump-sequence.ftl} (74%) diff --git a/webapp/src/edu/cornell/mannlib/vitro/webapp/web/directives/DumpDataModelDirective.java b/webapp/src/edu/cornell/mannlib/vitro/webapp/web/directives/DumpDataModelDirective.java index 0f8bde190..8510dc9b4 100644 --- a/webapp/src/edu/cornell/mannlib/vitro/webapp/web/directives/DumpDataModelDirective.java +++ b/webapp/src/edu/cornell/mannlib/vitro/webapp/web/directives/DumpDataModelDirective.java @@ -6,12 +6,17 @@ import java.io.IOException; import java.io.Writer; import java.util.ArrayList; import java.util.Collections; +import java.util.HashMap; import java.util.List; import java.util.Map; -import java.util.Set; -import edu.cornell.mannlib.vitro.webapp.utils.StringUtils; +import org.apache.commons.logging.Log; +import org.apache.commons.logging.LogFactory; + +import edu.cornell.mannlib.vitro.webapp.controller.freemarker.FreemarkerHelper; + import freemarker.core.Environment; +import freemarker.template.Configuration; import freemarker.template.TemplateDirectiveBody; import freemarker.template.TemplateDirectiveModel; import freemarker.template.TemplateException; @@ -22,49 +27,55 @@ import freemarker.template.utility.DeepUnwrap; public class DumpDataModelDirective implements TemplateDirectiveModel { - @SuppressWarnings({ "unchecked", "deprecation" }) + private static final Log log = LogFactory.getLog(DumpDataModelDirective.class); + + @SuppressWarnings({ "unchecked" }) @Override public void execute(Environment env, Map params, TemplateModel[] loopVars, TemplateDirectiveBody body) throws TemplateException, IOException { if (params.size() != 0) { throw new TemplateModelException( - "The dump directive doesn't allow parameters."); + "The dumpDataModel directive doesn't allow parameters."); } if (loopVars.length != 0) { throw new TemplateModelException( - "The dump directive doesn't allow loop variables."); + "The dumpDataModel directive doesn't allow loop variables."); } if (body != null) { throw new TemplateModelException( - "The dump directive doesn't allow nested content."); + "The dumpDataModel directive doesn't allow nested content."); } TemplateHashModel dataModel = env.getDataModel(); - List models = new ArrayList(); + Map models = new HashMap(); List directives = new ArrayList(); Map dm = (Map) DeepUnwrap.permissiveUnwrap(dataModel); - Set varNames = dm.keySet(); - for (Object varName : varNames) { - if (dm.get(varName) instanceof TemplateDirectiveModel) { - directives.add((String) varName); + List varNames = new ArrayList(dm.keySet()); + Collections.sort(varNames); + for (String var : varNames) { + Object value = dm.get(var); + if (value instanceof TemplateDirectiveModel) { + directives.add((String) var); } else { - models.add((String) varName); + models.put(var, value); } } + + Configuration config = env.getConfiguration(); + String templateName = "dump-datamodel.ftl"; + + Map map = new HashMap(); + map.put("models", models); + map.put("directives", directives); + map.put("stylesheets", dataModel.get("stylesheets")); + map.put("dump", dataModel.get("dump")); + // Put the current datamodel into the new datamodel so its values can be dumped with the dump directive + map.put("datamodel", dataModel); - Collections.sort(models); - Collections.sort(directives); - - // RY Improve by making presentation of various types more nuanced - // Also merge to a template for formatting - // get config from environment; get a template from config - // merge as in FreeMarkerHttpServlet.mergeToTemplate() - String modelNames = "

Data model: " + StringUtils.join(models, ", ") + ".

"; - String directiveNames = "

Directives: " + StringUtils.join(directives, ", ") + ".

"; - - String output = modelNames + directiveNames; + FreemarkerHelper helper = new FreemarkerHelper(); + String output = helper.mergeMapToTemplate(templateName, map, config); Writer out = env.getOut(); out.write(output); diff --git a/webapp/src/edu/cornell/mannlib/vitro/webapp/web/directives/DumpDirective.java b/webapp/src/edu/cornell/mannlib/vitro/webapp/web/directives/DumpDirective.java index 26484daff..2c72e2de0 100644 --- a/webapp/src/edu/cornell/mannlib/vitro/webapp/web/directives/DumpDirective.java +++ b/webapp/src/edu/cornell/mannlib/vitro/webapp/web/directives/DumpDirective.java @@ -7,24 +7,29 @@ import java.io.Writer; import java.util.HashMap; import java.util.Map; +import org.apache.commons.logging.Log; +import org.apache.commons.logging.LogFactory; + import edu.cornell.mannlib.vitro.webapp.controller.freemarker.FreemarkerHelper; -import edu.cornell.mannlib.vitro.webapp.web.templatemodels.files.Stylesheets; import freemarker.core.Environment; import freemarker.template.Configuration; -import freemarker.template.SimpleDate; -import freemarker.template.SimpleHash; import freemarker.template.SimpleScalar; -import freemarker.template.SimpleSequence; import freemarker.template.TemplateBooleanModel; +import freemarker.template.TemplateDateModel; import freemarker.template.TemplateDirectiveBody; import freemarker.template.TemplateDirectiveModel; import freemarker.template.TemplateException; import freemarker.template.TemplateHashModel; import freemarker.template.TemplateModel; import freemarker.template.TemplateModelException; +import freemarker.template.TemplateNumberModel; +import freemarker.template.TemplateScalarModel; +import freemarker.template.TemplateSequenceModel; public class DumpDirective implements TemplateDirectiveModel { + private static final Log log = LogFactory.getLog(DumpDirective.class); + @SuppressWarnings("unchecked") @Override public void execute(Environment env, Map params, TemplateModel[] loopVars, @@ -42,57 +47,72 @@ public class DumpDirective implements TemplateDirectiveModel { Object o = params.get("var"); if ( !(o instanceof SimpleScalar)) { throw new TemplateModelException( - "Value of 'var' must be a string."); + "Value of parameter 'var' must be a string."); } String var = ((SimpleScalar)o).getAsString(); + + Object r = params.get("dataModelDump"); + boolean dataModelDump = false; + if (r != null) { + if ( !(r instanceof TemplateBooleanModel)) { + throw new TemplateModelException( + "Value of parameter 'recursive' must be a boolean: true or false without quotation marks."); + } + dataModelDump = ((TemplateBooleanModel) r).getAsBoolean(); + } TemplateHashModel dataModel = env.getDataModel(); - TemplateModel val = dataModel.get(var); + if (dataModelDump) { + dataModel = (TemplateHashModel) dataModel.get("datamodel"); + } - Configuration config = env.getConfiguration(); - String templateName = "dump-var.ftl"; - String includeTemplate; - Object value = val; + TemplateModel val = null; + try { + val = dataModel.get(var); + } catch (TemplateModelException tme) { + log.error("Error getting value of template model " + var + " from data model."); + } + + // Just use this for now. Handles nested collections. + String value = val.toString(); String type = null; - Writer out = env.getOut(); - if (val instanceof SimpleScalar) { - includeTemplate = "dump-string.ftl"; + if (val instanceof TemplateScalarModel) { type = "string"; - } else if (val instanceof SimpleDate) { - includeTemplate = "dump-string.ftl"; - value = value.toString(); + } else if (val instanceof TemplateDateModel) { type = "date"; + } else if (val instanceof TemplateNumberModel) { + type = "number"; } else if (val instanceof TemplateBooleanModel) { - includeTemplate = "dump-string.ftl"; value = ((TemplateBooleanModel) val).getAsBoolean() ? "true" : "false"; type = "boolean"; - } else if (val instanceof SimpleSequence){ - includeTemplate = "dump-array.ftl"; - } else if (val instanceof SimpleHash) { - includeTemplate = "dump-hash.ftl"; - // In recursive dump, we've gotten down to a raw string + } else if (val instanceof TemplateSequenceModel){ + type = "sequence"; + } else if (val instanceof TemplateHashModel) { + type = "hash"; + // In recursive dump, we've gotten down to a raw string. Just output it. // } else if (val == null) { // out.write(var); // return; + // Add a case for BaseTemplateModel - our template model objects will have a dump() method. } else { - includeTemplate = "dump-string.ftl"; - value = value.toString(); type = "object"; } Map map = new HashMap(); map.put("var", var); map.put("value", value); - map.put("includeTemplate", includeTemplate); map.put("type", type); map.put("stylesheets", dataModel.get("stylesheets")); //map.put("dump", this); - + + Configuration config = env.getConfiguration(); + String templateName = "dump-var.ftl"; FreemarkerHelper helper = new FreemarkerHelper(); String output = helper.mergeMapToTemplate(templateName, map, config); + Writer out = env.getOut(); out.write(output); } diff --git a/webapp/web/templates/freemarker/body/partials/dump/dump-datamodel.ftl b/webapp/web/templates/freemarker/body/partials/dump/dump-datamodel.ftl new file mode 100644 index 000000000..34936715e --- /dev/null +++ b/webapp/web/templates/freemarker/body/partials/dump/dump-datamodel.ftl @@ -0,0 +1,24 @@ +<#-- $This file is distributed under the terms of the license in /doc/license.txt$ --> + +<#-- Template for dumping the template data model --> + +
+ +

Template data model dump

+ +
Variables
+ +
    + <#list models?keys as key> +
  • <@dump var="${key}" dataModelDump=true />
    • + +
+ +
Directives
+
    + <#list directives as directive> +
  • ${directive}
    • + +
+ +
\ No newline at end of file diff --git a/webapp/web/templates/freemarker/body/partials/dump/dump-array.ftl b/webapp/web/templates/freemarker/body/partials/dump/dump-sequence.ftl similarity index 74% rename from webapp/web/templates/freemarker/body/partials/dump/dump-array.ftl rename to webapp/web/templates/freemarker/body/partials/dump/dump-sequence.ftl index 630b61e21..1f1d079ee 100644 --- a/webapp/web/templates/freemarker/body/partials/dump/dump-array.ftl +++ b/webapp/web/templates/freemarker/body/partials/dump/dump-sequence.ftl @@ -1,8 +1,8 @@ <#-- $This file is distributed under the terms of the license in /doc/license.txt$ --> -<#-- Template for dumping array values --> +<#-- Template for dumping sequence (list and array) values --> -Type: array
+Type: sequence (array/list)
Values:
    <#list value as item> diff --git a/webapp/web/templates/freemarker/body/partials/dump/dump-var.ftl b/webapp/web/templates/freemarker/body/partials/dump/dump-var.ftl index e784ceb3b..b53010a78 100644 --- a/webapp/web/templates/freemarker/body/partials/dump/dump-var.ftl +++ b/webapp/web/templates/freemarker/body/partials/dump/dump-var.ftl @@ -6,7 +6,8 @@
    Dump of template variable ${var}:
    - <#include includeTemplate /> + Type: ${type}
    + Value: ${value}
    diff --git a/webapp/web/templates/freemarker/body/test.ftl b/webapp/web/templates/freemarker/body/test.ftl index e0d3e7c9d..8c060775d 100644 --- a/webapp/web/templates/freemarker/body/test.ftl +++ b/webapp/web/templates/freemarker/body/test.ftl @@ -46,12 +46,14 @@

    Berries: ${berries}

    +<#-- <@dump var="now" /> <@dump var="urls" /> <@dump var="fruit" /> <@dump var="trueStatement" /> -<@dump var="falseStatement" /> +<@dump var="falseStatement" /> --> +<@dump var="zoo1" /> <@dumpDataModel /> ${stylesheets.addFromTheme("/sstest.css", "/sstest2.css")}