Added support for boolean and lists

src/zutil/parser/Templator.java

@@ -27,6 +27,7 @@ import zutil.struct.MutableInt;
 
 import java.lang.reflect.Field;
 import java.util.ArrayList;
+import java.util.Collection;
 import java.util.HashMap;
 import java.util.List;
 import java.util.logging.Level;
@@ -43,18 +44,26 @@ import java.util.logging.Logger;
  *      <b> {{obj.attr}} </b><br>
  *      Will be replaced with the string from the key.</li>
  *  <li><b> {{#key}}...{{/key}} </b><br>
- *      Will display content between the tags if key is defined.</li>
+ *      <b> {{#obj.attr}}...{{/obj.attr}} </b><br>
- *  <li><b>{{^key}}</b><br>
+ *      Will display content between the tags if:
- *      A negative condition, will display content if key is not set.</li>
+ *      key is defined,
+ *      if the key references a list the content will be iterated
+ *          for every element, the element can be referenced by the tag {{.}},
+ *      if key is a true boolean (false will not display content).</li>
+ *  <li><b> {{^key}}</b><br>
+ *      <b> {{^obj.attr}}...{{/obj.attr}} </b><br>
+ *      A negative condition, will display content if:
+ *      the key is undefined,
+ *      the key is a empty list,
+ *      the key is a false boolean.</li>
  *  <li><b>{{! ignore me }}</b><br>
  *      Comment, will be ignored.</li>
  * </ul>
  *
- * TODO:
+ * TODO: {{#key}}: support for boolean
- *  * {{#person}}: support for boolean
+ * TODO: {{> file}}: include file
- *  * {{#person}}: support for iterators
+ * TODO: {{=<% %>=}}: change delimiter
- *  * {{> file}}: include file
+ *
- *  * {{=<% %>=}}: change delimiter
  * @author Ziver koc
  */
 public class Templator {
@@ -160,23 +169,6 @@ public class Templator {
     }
 
 
-
-
-    /**************************** Utility functions *************************************/
-    public static Object getFieldValue(Object obj, String attrib){
-        try {
-            for (Field field : obj.getClass().getDeclaredFields()) {
-                if(field.getName().equals(attrib)) {
-                    field.setAccessible(true);
-                    return field.get(obj);
-                }
-            }
-        }catch (IllegalAccessException e){
-            log.log(Level.WARNING, null, e);
-        }
-        return null;
-    }
-
     /**************************** Template Helper Classes *************************************/
 
     protected interface TemplateEntity {
@@ -207,28 +199,53 @@ public class Templator {
     }
 
     protected class TemplateCondition extends TemplateNode {
-        private String key;
+        private TemplateDataAttribute attrib;
 
         public TemplateCondition(String key){
-            this.key = key.trim();
+            this.attrib = new TemplateDataAttribute(key);
         }
 
         public void compile(StringBuilder str) {
-            if(data.containsKey(key))
+            Object obj = attrib.getObject();
-                super.compile(str);
+            if(obj != null) {
+                if(obj instanceof Boolean){
+                    if ((Boolean) obj)
+                        super.compile(str);
+                }
+                else if(obj instanceof Iterable){
+                    for(Object o : (Iterable)obj){ // Iterate through the whole list
+                        set(".", o);
+                        super.compile(str);
+                    }
+                    set(".", null);
+                }
+                else
+                    super.compile(str);
+            }
         }
     }
 
     protected class TemplateNegativeCondition extends TemplateNode {
-        private String key;
+        private TemplateDataAttribute attrib;
 
         public TemplateNegativeCondition(String key){
-            this.key = key.trim();
+            this.attrib = new TemplateDataAttribute(key);
         }
 
         public void compile(StringBuilder str) {
-            if( ! data.containsKey(key))
+            Object obj = attrib.getObject();
+            if(obj == null)
                 super.compile(str);
+            else {
+                if(obj instanceof Boolean) {
+                    if ( ! (Boolean) obj)
+                        super.compile(str);
+                }
+                else if(obj instanceof Collection) {
+                    if (((Collection) obj).isEmpty())
+                        super.compile(str);
+                }
+            }
         }
     }
 
@@ -245,30 +262,54 @@ public class Templator {
     }
 
     protected class TemplateDataAttribute implements TemplateEntity {
+        private String tag;
         private String key;
         private String attrib;
 
-        public TemplateDataAttribute(String key){
+        public TemplateDataAttribute(String tag){
-            String[] s = key.trim().split("\\.", 2);
+            this.tag = tag;
+            String[] s = tag.trim().split("\\.", 2);
             this.key = s[0];
             if(s.length > 1)
                 this.attrib = s[1];
         }
 
-        public void compile(StringBuilder str) {
+
-            if (data.containsKey(key)) {
+        public Object getObject(){
+            if (data.containsKey(tag))
+                return data.get(tag);
+            else if (data.containsKey(key)) {
                 if (attrib != null) {
                     Object obj = getFieldValue(data.get(key), attrib);
                     if(obj != null)
-                        str.append(obj.toString());
+                        return obj;
-                    else
-                        str.append("{{").append(key).append(".").append(attrib).append("}}");
                 }
                 else
-                    str.append(data.get(key).toString());
+                    return data.get(key);
             }
+            return null;
+        }
+        protected Object getFieldValue(Object obj, String attrib){
+            try {
+                for (Field field : obj.getClass().getDeclaredFields()) {
+                    if(field.getName().equals(attrib)) {
+                        field.setAccessible(true);
+                        return field.get(obj);
+                    }
+                }
+            }catch (IllegalAccessException e){
+                log.log(Level.WARNING, null, e);
+            }
+            return null;
+        }
+
+
+        public void compile(StringBuilder str) {
+            Object obj = getObject();
+            if(obj != null)
+                str.append(obj.toString());
             else
-                str.append("{{").append(key).append("}}");
+                str.append("{{").append(tag).append("}}");
         }
     }
 }

src/zutil/test/TemplatorTest.java

@@ -25,6 +25,10 @@ package zutil.test;
 import org.junit.Test;
 import zutil.parser.Templator;
 
+import java.util.ArrayList;
+import java.util.Arrays;
+import java.util.List;
+
 import static org.junit.Assert.*;
 
 /**
@@ -35,27 +39,10 @@ public class TemplatorTest {
         public String attr;
     }
 
+
+
     @Test
-    public void emptyAttributeTest(){
+    public void tagIncorrectTest(){
-        Templator tmpl = new Templator("<HTML>{{test}}</HTML>");
-        assertEquals("<HTML>{{test}}</HTML>", tmpl.compile());
-    }
-    @Test
-    public void simpleAttributeTest() {
-        Templator tmpl = new Templator("<HTML>{{test}}</HTML>");
-        tmpl.set("test", "1234");
-        assertEquals("<HTML>1234</HTML>", tmpl.compile());
-    }
-    @Test
-    public void objectAttributeTest(){
-        Templator tmpl = new Templator("<HTML>{{test.attr}}</HTML>");
-        TestClass obj = new TestClass();
-        obj.attr = "1234";
-        tmpl.set("test", obj);
-        assertEquals("<HTML>1234</HTML>", tmpl.compile());
-    }
-    @Test
-    public void incorrectTagsTest(){
         assertEquals("<HTML>{{</HTML>",
                 new Templator("<HTML>{{</HTML>").compile());
         assertEquals("<HTML>}}</HTML>",
@@ -73,27 +60,30 @@ public class TemplatorTest {
         assertEquals("<HTML>{test}</HTML>",
                 new Templator("<HTML>{test}</HTML>").compile());
     }
+    @Test
+    public void attributeEmptyTest(){
+        Templator tmpl = new Templator("<HTML>{{test}}</HTML>");
+        assertEquals("<HTML>{{test}}</HTML>", tmpl.compile());
+    }
+    @Test
+    public void attributeSimpleTest() {
+        Templator tmpl = new Templator("<HTML>{{test}}</HTML>");
+        tmpl.set("test", "1234");
+        assertEquals("<HTML>1234</HTML>", tmpl.compile());
+    }
+    @Test
+    public void attributeObjectTest(){
+        Templator tmpl = new Templator("<HTML>{{test.attr}}</HTML>");
+        TestClass obj = new TestClass();
+        obj.attr = "1234";
+        tmpl.set("test", obj);
+        assertEquals("<HTML>1234</HTML>", tmpl.compile());
+    }
+
 
 
     @Test
-    public void emptyConditionTest(){
+    public void conditionIncompleteTest(){
-        Templator tmpl = new Templator(
-                "<HTML>{{#key}}123456789{{/key}}</HTML>");
-        assertEquals(
-                "<HTML></HTML>",
-                tmpl.compile());
-    }
-    @Test
-    public void simpleConditionTest(){
-        Templator tmpl = new Templator(
-                "<HTML>{{#key}}123456789{{/key}}</HTML>");
-        tmpl.set("key", "set");
-        assertEquals(
-                "<HTML>123456789</HTML>",
-                tmpl.compile());
-    }
-    @Test
-    public void incompleteConditionTest(){
         assertEquals("<HTML>{{#key}}</HTML>",
                 new Templator("<HTML>{{#key}}</HTML>").compile());
         assertEquals("<HTML>{{/key}}</HTML>",
@@ -103,25 +93,122 @@ public class TemplatorTest {
         assertEquals("<HTML></HTML>",
                 new Templator("<HTML>{{#key}}{{/key}}</HTML>").compile());
     }
-
-
     @Test
-    public void emptyNegativeConditionTest(){
+    public void conditionEmptyTest(){
         Templator tmpl = new Templator(
-                "<HTML>{{^key}}123456789{{/key}}</HTML>");
+                "<HTML>{{#key}}123456789{{/key}}</HTML>");
+        assertEquals(
+                "<HTML></HTML>",
+                tmpl.compile());
+    }
+    @Test
+    public void conditionSimpleTest(){
+        Templator tmpl = new Templator(
+                "<HTML>{{#key}}123456789{{/key}}</HTML>");
+        tmpl.set("key", "set");
         assertEquals(
                 "<HTML>123456789</HTML>",
                 tmpl.compile());
     }
     @Test
-    public void setNegativeConditionTest(){
+    public void conditionObjectTest(){
+        Templator tmpl = new Templator("<HTML>{{#test.attr}}5678{{/test.attr}}</HTML>");
+        TestClass obj = new TestClass();
+        obj.attr = "1234";
+        tmpl.set("test", obj);
+        assertEquals("<HTML>5678</HTML>", tmpl.compile());
+
+        tmpl.clear();
+        tmpl.set("test", new TestClass());
+        assertEquals("<HTML></HTML>", tmpl.compile());
+    }
+    @Test
+    public void conditionBooleanTest(){
+        Templator tmpl = new Templator(
+                "<HTML>{{#key}}123456789{{/key}}</HTML>");
+        tmpl.set("key", true);
+        assertEquals(
+                "<HTML>123456789</HTML>", tmpl.compile());
+
+        tmpl.set("key", false);
+        assertEquals(
+                "<HTML></HTML>", tmpl.compile());
+    }
+
+
+
+    @Test
+    public void conditionIteratorEmptyTest(){
+        Templator tmpl = new Templator("<HTML>{{#list}}1234 {{.}} {{/list}}</HTML>");
+        tmpl.set("list", new ArrayList());
+        assertEquals(
+                "<HTML></HTML>", tmpl.compile());
+    }
+    @Test
+    public void conditionIteratorTest(){
+        Templator tmpl = new Templator("<HTML>{{#list}}{{.}}{{/list}}</HTML>");
+        tmpl.set("list", Arrays.asList(1,2,3,4,5,6,7,8,9));
+        assertEquals(
+                "<HTML>123456789</HTML>", tmpl.compile());
+    }
+
+
+    @Test
+    public void negativeConditionEmptyTest(){
+        Templator tmpl = new Templator(
+                "<HTML>{{^key}}123456789{{/key}}</HTML>");
+        assertEquals(
+                "<HTML>123456789</HTML>", tmpl.compile());
+    }
+    @Test
+    public void negativeConditionSetTest(){
         Templator tmpl = new Templator(
                 "<HTML>{{^key}}123456789{{/key}}</HTML>");
         tmpl.set("key", "set");
         assertEquals(
-                "<HTML></HTML>",
+                "<HTML></HTML>", tmpl.compile());
-                tmpl.compile());
     }
+    @Test
+    public void negativeConditionObjectTest(){
+        Templator tmpl = new Templator("<HTML>{{^test.attr}}5678{{/test.attr}}</HTML>");
+        TestClass obj = new TestClass();
+        obj.attr = "1234";
+        tmpl.set("test", obj);
+        assertEquals("<HTML></HTML>", tmpl.compile());
+
+        tmpl.clear();
+        tmpl.set("test", new TestClass());
+        assertEquals("<HTML>5678</HTML>", tmpl.compile());
+    }
+    @Test
+    public void negativeConditionIteratorTest(){
+        Templator tmpl = new Templator(
+                "<HTML>{{^key}}123456789{{/key}}</HTML>");
+        tmpl.set("key", Arrays.asList(1,2,3,4,5,6,7,8,9));
+        assertEquals(
+                "<HTML></HTML>", tmpl.compile());
+    }
+    @Test
+    public void negativeConditionIteratorEmptyTest(){
+        Templator tmpl = new Templator(
+                "<HTML>{{^key}}123456789{{/key}}</HTML>");
+        tmpl.set("key", new ArrayList());
+        assertEquals(
+                "<HTML>123456789</HTML>", tmpl.compile());
+    }
+    @Test
+    public void negativeConditionBooleanTest(){
+        Templator tmpl = new Templator(
+                "<HTML>{{^key}}123456789{{/key}}</HTML>");
+        tmpl.set("key", true);
+        assertEquals(
+                "<HTML></HTML>", tmpl.compile());
+
+        tmpl.set("key", false);
+        assertEquals(
+                "<HTML>123456789</HTML>", tmpl.compile());
+    }
+
 
 
     @Test
@@ -129,7 +216,6 @@ public class TemplatorTest {
         Templator tmpl = new Templator(
                 "<HTML>{{! This is a comment}}</HTML>");
         assertEquals(
-                "<HTML></HTML>",
+                "<HTML></HTML>", tmpl.compile());
-                tmpl.compile());
     }
 }