Forward ported from 2.3-gae: DeepUnwrap hash unwrapping improvements. Also some FM3-only (not 100% BC) cleanups there.
Project: http://git-wip-us.apache.org/repos/asf/incubator-freemarker/repo Commit: http://git-wip-us.apache.org/repos/asf/incubator-freemarker/commit/b13c1c76 Tree: http://git-wip-us.apache.org/repos/asf/incubator-freemarker/tree/b13c1c76 Diff: http://git-wip-us.apache.org/repos/asf/incubator-freemarker/diff/b13c1c76 Branch: refs/heads/3 Commit: b13c1c768ea91853ff1bf3173112e2c2383492a5 Parents: 9d96369 Author: ddekany <ddek...@apache.org> Authored: Thu Mar 1 18:08:27 2018 +0100 Committer: ddekany <ddek...@apache.org> Committed: Thu Mar 1 18:08:27 2018 +0100 ---------------------------------------------------------------------- .../freemarker/core/util/DeepUnwrapTest.java | 96 ++++++++++++++++++++ .../apache/freemarker/core/util/DeepUnwrap.java | 21 +++-- 2 files changed, 111 insertions(+), 6 deletions(-) ---------------------------------------------------------------------- http://git-wip-us.apache.org/repos/asf/incubator-freemarker/blob/b13c1c76/freemarker-core-test/src/test/java/org/apache/freemarker/core/util/DeepUnwrapTest.java ---------------------------------------------------------------------- diff --git a/freemarker-core-test/src/test/java/org/apache/freemarker/core/util/DeepUnwrapTest.java b/freemarker-core-test/src/test/java/org/apache/freemarker/core/util/DeepUnwrapTest.java new file mode 100644 index 0000000..1e1a664 --- /dev/null +++ b/freemarker-core-test/src/test/java/org/apache/freemarker/core/util/DeepUnwrapTest.java @@ -0,0 +1,96 @@ +/* + * Licensed to the Apache Software Foundation (ASF) under one + * or more contributor license agreements. See the NOTICE file + * distributed with this work for additional information + * regarding copyright ownership. The ASF licenses this file + * to you under the Apache License, Version 2.0 (the + * "License"); you may not use this file except in compliance + * with the License. You may obtain a copy of the License at + * + * http://www.apache.org/licenses/LICENSE-2.0 + * + * Unless required by applicable law or agreed to in writing, + * software distributed under the License is distributed on an + * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY + * KIND, either express or implied. See the License for the + * specific language governing permissions and limitations + * under the License. + */ + +package org.apache.freemarker.core.util; + +import static org.junit.Assert.*; + +import java.util.LinkedHashMap; +import java.util.Map; + +import org.apache.freemarker.core.Configuration; +import org.apache.freemarker.core.TemplateException; +import org.apache.freemarker.core.model.TemplateCollectionModel; +import org.apache.freemarker.core.model.TemplateHashModelEx; +import org.apache.freemarker.core.model.TemplateModel; +import org.apache.freemarker.core.model.impl.DefaultObjectWrapper; +import org.junit.Test; + +public class DeepUnwrapTest { + + @SuppressWarnings("rawtypes") + @Test + public void testHashEx2Unwrapping() throws Exception { + Map<Object, Object> map = new LinkedHashMap<Object, Object>(); + map.put("k1", "v1"); + map.put("k2", null); + map.put(3, "v3"); + map.put(null, "v4"); + + DefaultObjectWrapper dow = new DefaultObjectWrapper.Builder(Configuration.VERSION_3_0_0).build(); + TemplateModel model = dow.wrap(map); + + assertSame(map, DeepUnwrap.unwrap(model)); + + Object unwrapped = DeepUnwrap.unwrap(new PurelyTemplateHashModelEx((TemplateHashModelEx) model)); + assertNotSame(map, unwrapped); + assertEquals(map, unwrapped); + // Order is kept: + assertArrayEquals(new Object[] { "k1", "k2", 3, null }, ((Map) unwrapped).keySet().toArray()); + } + + public static class PurelyTemplateHashModelEx implements TemplateHashModelEx { + private final TemplateHashModelEx delegate; + + public PurelyTemplateHashModelEx(TemplateHashModelEx delegate) { + this.delegate = delegate; + } + + @Override + public TemplateModel get(String key) throws TemplateException { + return delegate.get(key); + } + + @Override + public int getHashSize() throws TemplateException { + return delegate.getHashSize(); + } + + @Override + public boolean isEmptyHash() throws TemplateException { + return delegate.isEmptyHash(); + } + + @Override + public TemplateCollectionModel keys() throws TemplateException { + return delegate.keys(); + } + + @Override + public TemplateCollectionModel values() throws TemplateException { + return delegate.values(); + } + + @Override + public KeyValuePairIterator keyValuePairIterator() throws TemplateException { + return delegate.keyValuePairIterator(); + } + } + +} http://git-wip-us.apache.org/repos/asf/incubator-freemarker/blob/b13c1c76/freemarker-core/src/main/java/org/apache/freemarker/core/util/DeepUnwrap.java ---------------------------------------------------------------------- diff --git a/freemarker-core/src/main/java/org/apache/freemarker/core/util/DeepUnwrap.java b/freemarker-core/src/main/java/org/apache/freemarker/core/util/DeepUnwrap.java index 500ce65..ba6d132 100644 --- a/freemarker-core/src/main/java/org/apache/freemarker/core/util/DeepUnwrap.java +++ b/freemarker-core/src/main/java/org/apache/freemarker/core/util/DeepUnwrap.java @@ -20,7 +20,9 @@ package org.apache.freemarker.core.util; import java.util.ArrayList; -import java.util.HashMap; +import java.util.Collections; +import java.util.LinkedHashMap; +import java.util.Map; import org.apache.freemarker.core.Environment; import org.apache.freemarker.core.TemplateException; @@ -29,6 +31,8 @@ import org.apache.freemarker.core.model.ObjectWrapper; import org.apache.freemarker.core.model.TemplateBooleanModel; import org.apache.freemarker.core.model.TemplateDateModel; import org.apache.freemarker.core.model.TemplateHashModelEx; +import org.apache.freemarker.core.model.TemplateHashModelEx.KeyValuePair; +import org.apache.freemarker.core.model.TemplateHashModelEx.KeyValuePairIterator; import org.apache.freemarker.core.model.TemplateIterableModel; import org.apache.freemarker.core.model.TemplateModel; import org.apache.freemarker.core.model.TemplateModelIterator; @@ -138,11 +142,16 @@ public class DeepUnwrap { } if (model instanceof TemplateHashModelEx) { TemplateHashModelEx hash = (TemplateHashModelEx) model; - HashMap map = new HashMap(); - TemplateModelIterator keys = hash.keys().iterator(); - while (keys.hasNext()) { - String key = (String) unwrap(keys.next(), nullModel, permissive); - map.put(key, unwrap(hash.get(key), nullModel, permissive)); + if (hash.isEmptyHash()) { + return Collections.emptyMap(); + } + Map<Object, Object> map = new LinkedHashMap<Object, Object>((hash.getHashSize() + 1) * 4 / 3, 0.75f); + KeyValuePairIterator kvps = hash.keyValuePairIterator(); + while (kvps.hasNext()) { + KeyValuePair kvp = kvps.next(); + map.put( + unwrap(kvp.getKey(), nullModel, permissive), + unwrap(kvp.getValue(), nullModel, permissive)); } return map; }