litvinovg/vitro
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity Actions

NIHVIVO-1562 Dump for TemplateDirectiveModels and TemplateMethodModels

Browse source
This commit is contained in:
ryounes 2011-04-08 16:50:33 +00:00
parent 78fec720c4
commit 5bbf6b472b
2 changed files with 248 additions and 46 deletions
Download patch file Download diff file Expand all files Collapse all files

65
webapp/src/freemarker/ext/dump/BaseDumpDirective.java
View file

@ -5,6 +5,7 @@ package freemarker.ext.dump;
import java.io.IOException; import java.io.IOException;
import java.io.StringWriter; import java.io.StringWriter;
import java.io.Writer; import java.io.Writer;
import java.lang.reflect.Method;
import java.util.HashMap; import java.util.HashMap;
import java.util.Map; import java.util.Map;
@ -44,7 +45,18 @@ public abstract class BaseDumpDirective implements TemplateDirectiveModel {
TemplateHashModel dataModel = env.getDataModel(); TemplateHashModel dataModel = env.getDataModel();
TemplateModel model = dataModel.get(varName); TemplateModel model = dataModel.get(varName);
map.putAll(getData(model));
// TemplateMethodModel and TemplateDirectiveModel objects can only be
// included in the data model at the top level.
if (model instanceof TemplateMethodModel) {
map.putAll( getTemplateModelData( ( TemplateMethodModel)model, varName ) );
} else if (model instanceof TemplateDirectiveModel) {
map.putAll( getTemplateModelData( ( TemplateDirectiveModel)model, varName ) );
} else {
map.putAll(getData(model));
}
return map; return map;
} }
@ -54,9 +66,12 @@ public abstract class BaseDumpDirective implements TemplateDirectiveModel {
// Don't return null if model == null. We still want to send the map to the template. // Don't return null if model == null. We still want to send the map to the template.
if (model != null) { if (model != null) {
// Do TemplateHashModel case first, because model of POJOs are // Do TemplateHashModel cases first, because models of some Java objects are
// StringModels, which are both TemplateScalarModels and TemplateHashModels. // StringModels, and so are both TemplateScalarModels and TemplateHashModelExs.
if (model instanceof TemplateHashModel) { if (model instanceof TemplateHashModelEx) {
map.putAll( getTemplateModelData( ( TemplateHashModelEx)model ) );
} else if (model instanceof TemplateHashModel) {
map.putAll( getTemplateModelData( ( TemplateHashModel)model ) ); map.putAll( getTemplateModelData( ( TemplateHashModel)model ) );
} else if (model instanceof TemplateScalarModel) { } else if (model instanceof TemplateScalarModel) {
@ -73,16 +88,7 @@ public abstract class BaseDumpDirective implements TemplateDirectiveModel {
} else if (model instanceof TemplateSequenceModel){ } else if (model instanceof TemplateSequenceModel){
map.putAll( getTemplateModelData( ( TemplateSequenceModel)model ) ); map.putAll( getTemplateModelData( ( TemplateSequenceModel)model ) );
} else if (model instanceof TemplateHashModelEx) {
map.putAll( getTemplateModelData( ( TemplateHashModelEx)model ) );
} else if (model instanceof TemplateMethodModel) {
map.putAll( getTemplateModelData( ( TemplateMethodModel)model ) );
} else if (model instanceof TemplateDirectiveModel) {
map.putAll( getTemplateModelData( ( TemplateDirectiveModel)model ) );
} else { } else {
map.putAll( getTemplateModelData( (TemplateModel)model ) ); map.putAll( getTemplateModelData( (TemplateModel)model ) );
} }
@ -141,23 +147,44 @@ public abstract class BaseDumpDirective implements TemplateDirectiveModel {
return map; return map;
} }
private Map<String, Object> getTemplateModelData(TemplateMethodModel model) throws TemplateModelException { private Map<String, Object> getTemplateModelData(TemplateMethodModel model, String varName) throws TemplateModelException {
Map<String, Object> map = new HashMap<String, Object>(); Map<String, Object> map = new HashMap<String, Object>();
map.put("type", "Method"); map.put("type", "Method");
//map.put("value", model.getAsNumber()); map.put("help", getHelp(model, varName));
return map; return map;
} }
private Map<String, Object> getTemplateModelData(TemplateDirectiveModel model) throws TemplateModelException { private Map<String, Object> getTemplateModelData(TemplateDirectiveModel model, String varName) throws TemplateModelException {
Map<String, Object> map = new HashMap<String, Object>(); Map<String, Object> map = new HashMap<String, Object>();
map.put("type", "Directive");; map.put("type", "Directive");;
//map.put("value", model.getAsDate()); map.put("help", getHelp(model, varName));
return map;
}
@SuppressWarnings("unchecked")
private Map<String, Object> getHelp(TemplateModel model, String varName) {
Map<String, Object> map = null;
if ( model instanceof TemplateMethodModel || model instanceof TemplateDirectiveModel ) {
Class<?> cls = model.getClass();
Method[] methods = cls.getMethods();
for (Method method : methods) {
if ( method.getName().equals("help") ) {
try {
map = (Map<String, Object>) method.invoke(model, varName);
} catch (Exception e) {
String modelClass = model instanceof TemplateMethodModel ? "TemplateMethodModel" : "TemplateDirectiveModel";
log.error("Error invoking method help() on " + modelClass + " of class " + cls.getName());
}
break;
}
}
}
return map; return map;
} }
private Map<String, Object> getTemplateModelData(TemplateModel model) throws TemplateModelException { private Map<String, Object> getTemplateModelData(TemplateModel model) throws TemplateModelException {
// One of the above cases should have applied. Track whether this actually occurs. // One of the above cases should have applied. Track whether this actually occurs.
log.debug("Found model with no known type"); // log.debug("Found model with no known type");
Map<String, Object> map = new HashMap<String, Object>(); Map<String, Object> map = new HashMap<String, Object>();
Object unwrappedModel = DeepUnwrap.permissiveUnwrap(model); Object unwrappedModel = DeepUnwrap.permissiveUnwrap(model);
map.put("type", unwrappedModel.getClass().getName()); map.put("type", unwrappedModel.getClass().getName());

229
webapp/test/freemarker/ext/dump/DumpDirectiveTest.java
View file

@ -5,11 +5,14 @@ package freemarker.ext.dump;
import java.io.IOException; import java.io.IOException;
import java.io.StringReader; import java.io.StringReader;
import java.io.StringWriter; import java.io.StringWriter;
import java.util.ArrayList;
import java.util.HashMap; import java.util.HashMap;
import java.util.List; import java.util.List;
import java.util.Map; import java.util.Map;
import org.junit.Assert; import static junit.framework.Assert.assertEquals;
import static junit.framework.Assert.fail;
import org.junit.Before; import org.junit.Before;
import org.junit.Test; import org.junit.Test;
@ -34,7 +37,7 @@ public class DumpDirectiveTest {
try { try {
template = new Template("template", new StringReader(templateStr), config); template = new Template("template", new StringReader(templateStr), config);
} catch (Exception e) { } catch (Exception e) {
Assert.fail(e.getMessage()); fail(e.getMessage());
} }
} }
@ -54,9 +57,9 @@ public class DumpDirectiveTest {
try { try {
Environment env = template.createProcessingEnvironment(dataModel, new StringWriter()); Environment env = template.createProcessingEnvironment(dataModel, new StringWriter());
Map<String, Object> dumpData = new DumpDirective().getTemplateVariableData(varName, env); Map<String, Object> dumpData = new DumpDirective().getTemplateVariableData(varName, env);
Assert.assertEquals(expected, dumpData); assertEquals(expected, dumpData);
} catch (Exception e) { } catch (Exception e) {
Assert.fail(e.getMessage()); fail(e.getMessage());
} }
} }
@ -76,9 +79,9 @@ public class DumpDirectiveTest {
try { try {
Environment env = template.createProcessingEnvironment(dataModel, new StringWriter()); Environment env = template.createProcessingEnvironment(dataModel, new StringWriter());
Map<String, Object> dumpData = new DumpDirective().getTemplateVariableData(varName, env); Map<String, Object> dumpData = new DumpDirective().getTemplateVariableData(varName, env);
Assert.assertEquals(expected, dumpData); assertEquals(expected, dumpData);
} catch (Exception e) { } catch (Exception e) {
Assert.fail(e.getMessage()); fail(e.getMessage());
} }
} }
@ -98,9 +101,9 @@ public class DumpDirectiveTest {
try { try {
Environment env = template.createProcessingEnvironment(dataModel, new StringWriter()); Environment env = template.createProcessingEnvironment(dataModel, new StringWriter());
Map<String, Object> dumpData = new DumpDirective().getTemplateVariableData(varName, env); Map<String, Object> dumpData = new DumpDirective().getTemplateVariableData(varName, env);
Assert.assertEquals(expected, dumpData); assertEquals(expected, dumpData);
} catch (Exception e) { } catch (Exception e) {
Assert.fail(e.getMessage()); fail(e.getMessage());
} }
} }
@ -120,58 +123,144 @@ public class DumpDirectiveTest {
try { try {
Environment env = template.createProcessingEnvironment(dataModel, new StringWriter()); Environment env = template.createProcessingEnvironment(dataModel, new StringWriter());
Map<String, Object> dumpData = new DumpDirective().getTemplateVariableData(varName, env); Map<String, Object> dumpData = new DumpDirective().getTemplateVariableData(varName, env);
Assert.assertEquals(expected, dumpData); assertEquals(expected, dumpData);
} catch (Exception e) { } catch (Exception e) {
Assert.fail(e.getMessage()); fail(e.getMessage());
} }
} }
// RY test method and directive types with and without help methods // RY test method and directive types with and without help methods
@Test @Test
public void dumpMethod() { public void dumpHelplessMethod() {
String varName = "profileUri"; String varName = "square";
TemplateMethodModel value = new StubMethodModel(); TemplateMethodModel value = new HelplessMethod();
Map<String, Object> dataModel = new HashMap<String, Object>(); Map<String, Object> dataModel = new HashMap<String, Object>();
dataModel.put(varName, value); dataModel.put(varName, value);
Map<String, Object> expected = new HashMap<String, Object>(); Map<String, Object> expected = new HashMap<String, Object>();
expected.put("name", varName); expected.put("name", varName);
expected.put("type", "Method"); expected.put("type", "Method");
//expected.put("value", value); expected.put("help", null);
try { try {
Environment env = template.createProcessingEnvironment(dataModel, new StringWriter()); Environment env = template.createProcessingEnvironment(dataModel, new StringWriter());
Map<String, Object> dumpData = new DumpDirective().getTemplateVariableData(varName, env); Map<String, Object> dumpData = new DumpDirective().getTemplateVariableData(varName, env);
Assert.assertEquals(expected, dumpData); assertEquals(expected, dumpData);
} catch (Exception e) { } catch (Exception e) {
Assert.fail(e.getMessage()); fail(e.getMessage());
} }
} }
@Test @Test
public void dumpDirective() { public void dumpHelpfulMethod() {
String varName = "widget"; String varName = "square";
TemplateDirectiveModel value = new StubDirectiveModel(); TemplateMethodModel value = new HelpfulMethod();
Map<String, Object> dataModel = new HashMap<String, Object>();
dataModel.put(varName, value);
Map<String, Object> expected = new HashMap<String, Object>();
expected.put("name", varName);
expected.put("type", "Method");
expected.put("help", getMethodHelp(varName));
try {
Environment env = template.createProcessingEnvironment(dataModel, new StringWriter());
Map<String, Object> dumpData = new DumpDirective().getTemplateVariableData(varName, env);
assertEquals(expected, dumpData);
} catch (Exception e) {
fail(e.getMessage());
}
}
@Test
public void dumpMethodWithBadHelp() {
String varName = "square";
TemplateMethodModel value = new MethodWithBadHelp();
Map<String, Object> dataModel = new HashMap<String, Object>();
dataModel.put(varName, value);
Map<String, Object> expected = new HashMap<String, Object>();
expected.put("name", varName);
expected.put("type", "Method");
expected.put("help", null);
try {
Environment env = template.createProcessingEnvironment(dataModel, new StringWriter());
Map<String, Object> dumpData = new DumpDirective().getTemplateVariableData(varName, env);
assertEquals(expected, dumpData);
} catch (Exception e) {
fail(e.getMessage());
}
}
@Test
public void dumpHelplessDirective() {
String varName = "dump";
TemplateDirectiveModel value = new HelplessDirective();
Map<String, Object> dataModel = new HashMap<String, Object>(); Map<String, Object> dataModel = new HashMap<String, Object>();
dataModel.put(varName, value); dataModel.put(varName, value);
Map<String, Object> expected = new HashMap<String, Object>(); Map<String, Object> expected = new HashMap<String, Object>();
expected.put("name", varName); expected.put("name", varName);
expected.put("type", "Directive"); expected.put("type", "Directive");
//expected.put("value", value); expected.put("help", null);
try { try {
Environment env = template.createProcessingEnvironment(dataModel, new StringWriter()); Environment env = template.createProcessingEnvironment(dataModel, new StringWriter());
Map<String, Object> dumpData = new DumpDirective().getTemplateVariableData(varName, env); Map<String, Object> dumpData = new DumpDirective().getTemplateVariableData(varName, env);
Assert.assertEquals(expected, dumpData); assertEquals(expected, dumpData);
} catch (Exception e) { } catch (Exception e) {
Assert.fail(e.getMessage()); fail(e.getMessage());
} }
} }
@Test
public void dumpHelpfulDirective() {
String varName = "dump";
TemplateDirectiveModel value = new HelpfulDirective();
Map<String, Object> dataModel = new HashMap<String, Object>();
dataModel.put(varName, value);
Map<String, Object> expected = new HashMap<String, Object>();
expected.put("name", varName);
expected.put("type", "Directive");
expected.put("help", getDirectiveHelp(varName));
try {
Environment env = template.createProcessingEnvironment(dataModel, new StringWriter());
Map<String, Object> dumpData = new DumpDirective().getTemplateVariableData(varName, env);
assertEquals(expected, dumpData);
} catch (Exception e) {
fail(e.getMessage());
}
}
@Test
public void dumpDirectiveWithBadHelp() {
String varName = "dump";
TemplateDirectiveModel value = new DirectiveWithBadHelp();
Map<String, Object> dataModel = new HashMap<String, Object>();
dataModel.put(varName, value);
Map<String, Object> expected = new HashMap<String, Object>();
expected.put("name", varName);
expected.put("type", "Directive");
expected.put("help", null);
try {
Environment env = template.createProcessingEnvironment(dataModel, new StringWriter());
Map<String, Object> dumpData = new DumpDirective().getTemplateVariableData(varName, env);
assertEquals(expected, dumpData);
} catch (Exception e) {
fail(e.getMessage());
}
}
// RY Do these with different BeansWrappers // RY Do these with different BeansWrappers
@Test @Test
public void dumpSequence() { public void dumpSequence() {
@ -188,22 +277,108 @@ public class DumpDirectiveTest {
} }
private class StubMethodModel implements TemplateMethodModel { private class HelplessMethod implements TemplateMethodModel {
@Override @Override
public Object exec(List arg0) throws TemplateModelException { public Object exec(List arg0) throws TemplateModelException {
return null; return null;
} }
} }
private class HelpfulMethod implements TemplateMethodModel {
@Override
public Object exec(List arg0) throws TemplateModelException {
return null;
}
public Map<String, Object> help(String name) {
return getMethodHelp(name);
}
}
private class MethodWithBadHelp implements TemplateMethodModel {
@Override
public Object exec(List arg0) throws TemplateModelException {
return null;
}
public Map<String, Object> help() {
return new HashMap<String, Object>();
}
}
private class StubDirectiveModel implements TemplateDirectiveModel { private class HelplessDirective implements TemplateDirectiveModel {
@Override @Override
public void execute(Environment arg0, Map arg1, TemplateModel[] arg2, public void execute(Environment arg0, Map arg1, TemplateModel[] arg2,
TemplateDirectiveBody arg3) throws TemplateException, TemplateDirectiveBody arg3) throws TemplateException,
IOException { IOException {
}
}
private class HelpfulDirective implements TemplateDirectiveModel {
@Override
public void execute(Environment arg0, Map arg1, TemplateModel[] arg2,
TemplateDirectiveBody arg3) throws TemplateException,
IOException {
} }
public Map<String, Object> help(String name) {
return getDirectiveHelp(name);
}
} }
private class DirectiveWithBadHelp implements TemplateDirectiveModel {
@Override
public void execute(Environment arg0, Map arg1, TemplateModel[] arg2,
TemplateDirectiveBody arg3) throws TemplateException,
IOException {
}
public String help(String name) {
return "help";
}
}
private Map<String, Object> getDirectiveHelp(String name) {
Map<String, Object> map = new HashMap<String, Object>();
map.put("effect", "Dump the contents of a template variable.");
map.put("comments", "Sequences (lists and arrays) are enclosed in square brackets. Hashes are enclosed in curly braces.");
Map<String, String> params = new HashMap<String, String>();
params.put("var", "name of variable to dump");
map.put("params", params);
List<String> examples = new ArrayList<String>();
examples.add("<@" + name + " var=\"urls\" />");
map.put("examples", examples);
return map;
}
private Map<String, Object> getMethodHelp(String name) {
Map<String, Object> map = new HashMap<String, Object>();
map.put("name", name);
map.put("returns", "The square of the argument");
List<String>params = new ArrayList<String>();
params.add("Integer to square");
map.put("params", params);
List<String> examples = new ArrayList<String>();
examples.add(name + "(4)");
map.put("examples", examples);
return map;
}
} }