Updated Ozark regarding new Models interface (#183)

Author: chkal

core/src/main/java/org/mvcspec/ozark/core/ModelsImpl.java

@@ -17,91 +17,50 @@
 
 import javax.enterprise.context.RequestScoped;
 import javax.mvc.Models;
-import java.util.*;
+import java.util.Collections;
+import java.util.Iterator;
+import java.util.LinkedHashMap;
+import java.util.Map;
+import java.util.Objects;
 
 /**
  * Implementation of {@link javax.mvc.Models} interface. A CDI class that delegates
  * to a {@link java.util.Map} implementation.
  *
  * @author Santiago Pericas-Geertsen
+ * @author Christian Kaltepoth
  */
 @RequestScoped
 public class ModelsImpl implements Models {
 
-    private Map<String, Object> delegate = new HashMap<>();
+    private final Map<String, Object> map = new LinkedHashMap<>();
 
     @Override
-    public int size() {
-        return delegate.size();
+    public Models put(String name, Object model) {
+        Objects.requireNonNull(name, "Name must not be null");
+        map.put(name, model);
+        return this;
     }
 
     @Override
-    public boolean isEmpty() {
-        return delegate.isEmpty();
+    public Object get(String name) {
+        return get(name, Object.class);
     }
 
     @Override
-    public boolean containsKey(Object key) {
-        return delegate.containsKey(key);
+    public <T> T get(String name, Class<T> type) {
+        Objects.requireNonNull(name, "Name must not be null");
+        Objects.requireNonNull(type, "Type must not be null");
+        return type.cast(map.get(name));
     }
 
     @Override
-    public boolean containsValue(Object value) {
-        return delegate.containsValue(value);
-    }
-
-    @Override
-    public Object get(Object key) {
-        return delegate.get(key);
-    }
-
-    @Override
-    public Object put(String key, Object value) {
-        return delegate.put(key, value);
-    }
-
-    @Override
-    public Object remove(Object key) {
-        return delegate.remove(key);
-    }
-
-    @Override
-    public void putAll(Map<? extends String, ?> m) {
-        delegate.putAll(m);
-    }
-
-    @Override
-    public void clear() {
-        delegate.clear();
-    }
-
-    @Override
-    public Set<String> keySet() {
-        return delegate.keySet();
-    }
-
-    @Override
-    public Collection<Object> values() {
-        return delegate.values();
-    }
-
-    @Override
-    public Set<Entry<String, Object>> entrySet() {
-        return delegate.entrySet();
-    }
-
-    @Override
-    public boolean equals(Object o) {
-        return delegate.equals(o);
-    }
-
-    @Override
-    public int hashCode() {
-        return delegate.hashCode();
+    public Map<String, Object> asMap() {
+        return Collections.unmodifiableMap(new LinkedHashMap<>(map));
     }
 
     @Override
     public Iterator<String> iterator() {
-        return delegate.keySet().iterator();
+        return map.keySet().iterator();
     }
 }

core/src/test/java/org/mvcspec/ozark/core/ModelsImplTest.java

@@ -33,50 +33,6 @@
 @SuppressWarnings("unchecked")
 public class ModelsImplTest {
 
-    /**
-     * Test size method.
-     */
-    @Test
-    public void testSize() {
-        ModelsImpl models = new ModelsImpl();
-        assertEquals(0, models.size());
-        models.put("1", "1");
-        assertEquals(1, models.size());
-    }
-
-    /**
-     * Test isEmpty method.
-     */
-    @Test
-    public void testIsEmpty() {
-        ModelsImpl models = new ModelsImpl();
-        assertTrue(models.isEmpty());
-        models.put("1", "1");
-        assertFalse(models.isEmpty());
-    }
-
-    /**
-     * Test containsKey method.
-     */
-    @Test
-    public void testContainsKey() {
-        ModelsImpl models = new ModelsImpl();
-        assertFalse(models.containsKey("K"));
-        models.put("K", "V");
-        assertTrue(models.containsKey("K"));
-    }
-
-    /**
-     * Test containsValue method.
-     */
-    @Test
-    public void testContainsValue() {
-        ModelsImpl models = new ModelsImpl();
-        assertFalse(models.containsValue("V"));
-        models.put("K", "V");
-        assertTrue(models.containsValue("V"));
-    }
-
     /**
      * Test get method.
      */
@@ -89,93 +45,6 @@ public void testGet() {
         assertEquals("V", models.get("K"));
     }
 
-    /**
-     * Test remove method.
-     */
-    @Test
-    public void testRemove() {
-        ModelsImpl models = new ModelsImpl();
-        assertEquals(0, models.size());
-        models.put("K", "V");
-        assertEquals(1, models.size());
-        models.remove("K");
-        assertEquals(0, models.size());
-    }
-
-    /**
-     * Test putAll method.
-     */
-    @Test
-    public void testPutAll() {
-        ModelsImpl models = new ModelsImpl();
-        assertEquals(0, models.size());
-        HashMap otherMap = new HashMap();
-        otherMap.put("1", "1V");
-        otherMap.put("2", "2V");
-        models.putAll(otherMap);
-        assertEquals(2, models.size());
-    }
-
-    /**
-     * Test clear method.
-     */
-    @Test
-    public void testClear() {
-        ModelsImpl models = new ModelsImpl();
-        assertFalse(models.containsValue("V"));
-        models.put("K", "V");
-        assertEquals(1, models.size());
-        models.clear();
-        assertEquals(0, models.size());
-    }
-
-    /**
-     * Test keySet method.
-     */
-    @Test
-    public void testKeySet() {
-        ModelsImpl models = new ModelsImpl();
-        assertNotNull(models.keySet());
-    }
-
-    /**
-     * Test values method.
-     */
-    @Test
-    public void testValues() {
-        ModelsImpl models = new ModelsImpl();
-        assertNotNull(models.values());
-    }
-
-    /**
-     * Test entrySet method.
-     */
-    @Test
-    public void testEntrySet() {
-        ModelsImpl models = new ModelsImpl();
-        assertNotNull(models.entrySet());
-    }
-
-    /**
-     * Test equals method.
-     */
-    @Test
-    public void testEquals() {
-        ModelsImpl modelsA = new ModelsImpl();
-        ModelsImpl modelsB = new ModelsImpl();
-        assertTrue(modelsA.equals(modelsB));
-    }
-
-    /**
-     * Test hashCode method.
-     */
-    @Test
-    public void testHashCode() {
-        ModelsImpl modelsA = new ModelsImpl();
-        ModelsImpl modelsB = new ModelsImpl();
-        assertEquals(modelsA.hashCode(), modelsB.hashCode());
-    }
-
     /**
      * Test iterator method.
      */

ext/asciidoc/src/main/java/org/mvcspec/ozark/ext/asciidoc/AsciiDocViewEngine.java

@@ -65,7 +65,7 @@ public void processView(ViewEngineContext context) throws ViewEngineException {
              BufferedReader reader = new BufferedReader(isr)) {
 
             Options options = new Options();
-            options.setAttributes(new HashMap(context.getModels()));
+            options.setAttributes(new HashMap<>(context.getModels().asMap()));
 
             asciidoctor.convert(reader, writer, options);
         } catch (IOException e) {

ext/freemarker/src/main/java/org/mvcspec/ozark/ext/freemarker/FreemarkerViewEngine.java

@@ -59,7 +59,7 @@ public void processView(ViewEngineContext context) throws ViewEngineException {
 
             Template template = configuration.getTemplate(resolveView(context));
 
-            Map<String, Object> model = new HashMap<>(context.getModels());
+            Map<String, Object> model = new HashMap<>(context.getModels().asMap());
             model.put("request", context.getRequest(HttpServletRequest.class));
 
             template.process(model, writer);

ext/groovy/src/main/java/org/mvcspec/ozark/ext/groovy/GroovyViewEngine.java

@@ -60,7 +60,7 @@ public boolean supports(String view) {
 
     public void processView(ViewEngineContext context) throws ViewEngineException {
 
-        Map<String, Object> model = new HashMap<>(context.getModels());
+        Map<String, Object> model = new HashMap<>(context.getModels().asMap());
         model.put("request", context.getRequest(HttpServletRequest.class));
         Charset charset = resolveCharsetAndSetContentType(context);
         try (Writer writer = new OutputStreamWriter(context.getOutputStream(), charset);

ext/handlebars/src/main/java/org/mvcspec/ozark/ext/handlebars/HandlebarsViewEngine.java

@@ -60,7 +60,7 @@ public boolean supports(String view) {
     @Override
     public void processView(ViewEngineContext context) throws ViewEngineException {
 
-        Map<String, Object> model = new HashMap<>(context.getModels());
+        Map<String, Object> model = new HashMap<>(context.getModels().asMap());
         model.put("request", context.getRequest(HttpServletRequest.class));
 
         Charset charset = resolveCharsetAndSetContentType(context);

ext/jade/src/main/java/org/mvcspec/ozark/ext/jade/JadeViewEngine.java

@@ -61,7 +61,7 @@ public void processView(ViewEngineContext context) throws ViewEngineException {
 
             JadeTemplate template = jade.getTemplate(resolveView(context));
 
-            Map<String, Object> model = new HashMap<>(context.getModels());
+            Map<String, Object> model = new HashMap<>(context.getModels().asMap());
             model.put("request", context.getRequest(HttpServletRequest.class));
 
             jade.renderTemplate(template, model, writer);

ext/jetbrick/src/main/java/org/mvcspec/ozark/ext/jetbrick/JetbrickViewEngine.java

@@ -65,7 +65,7 @@ public void processView(ViewEngineContext context) throws ViewEngineException {
 
             JetTemplate template = jetEngine.getTemplate(resolveView(context));
 
-            Map<String, Object> model = new HashMap<>(context.getModels());
+            Map<String, Object> model = new HashMap<>(context.getModels().asMap());
             model.put("request", context.getRequest(HttpServletRequest.class));
 
             template.render(model, writer);

ext/jsr223/src/main/java/org/mvcspec/ozark/ext/jsr223/Jsr223ViewEngine.java

@@ -92,7 +92,7 @@ public void processView(ViewEngineContext context) throws ViewEngineException {
             InputStream inputStream = servletContext.getResourceAsStream(resolveView(context));
             InputStreamReader reader = new InputStreamReader(inputStream);
             Bindings bindings = scriptEngine.createBindings();
-            bindings.put("models", context.getModels());
+            bindings.put("models", context.getModels().asMap());
             responseObject = scriptEngine.eval(reader, bindings);
         } catch (ScriptException exception) {
             throw new ViewEngineException("Unable to execute script", exception);

ext/jtwig/src/main/java/org/mvcspec/ozark/ext/jtwig/JtwigViewEngine.java

@@ -51,7 +51,7 @@ public void processView(ViewEngineContext context) throws ViewEngineException {
 
         try {
 
-            Map<String, Object> model = new HashMap<>(context.getModels());
+            Map<String, Object> model = new HashMap<>(context.getModels().asMap());
             model.put("request", context.getRequest(HttpServletRequest.class));
 
             HttpServletRequest request = context.getRequest(HttpServletRequest.class);