Changeset 1666

Timestamp:

07/10/08 13:37:49 (21 months ago)

Author:

JensDiemer

Message:

Fix for ticket:202 - kwargs in template tag {% lucidTag ... %}
Discuss in:  http://pylucid.org/phpBB2/viewtopic.php?t=228

Location:

trunk/pylucid

Files:

• PyLucid/template_addons/lucidTag.py (modified) (3 diffs)
• PyLucid/tools/utils.py (modified) (3 diffs)
• tests/test_plugin_api.py (modified) (2 diffs)

trunk/pylucid/PyLucid/template_addons/lucidTag.py

@@ -26 +26 @@
 from PyLucid.system.context_processors import add_css_tag
 from PyLucid.tools.data_eval import data_eval, DataEvalError
+from PyLucid.tools.utils import make_kwagrs
 
 from django.conf import settings
@@ -96 +97 @@
 
 
+
+
 def lucidTag(parser, token):
     """
@@ -114 +117 @@
         method_name = "lucidTag"
 
-#    print "1", content
-#    method_kwargs = {}
-#    if content:
-#        raw_kwargs = content[0]
-#        kwargs = raw_kwargs.replace("=", ":")
-#        kwargs = u"{ %s }" % kwargs
-#        print "2", kwargs
-#        try:
-#            method_kwargs = data_eval(kwargs)
-#        except DataEvalError, err:
-#            return lucidTagNodeError(
-#                plugin_name, method_name,
-#                msg = "Tag args error: %s" % err
-#            )
-#
-#        print "3", method_kwargs
-
-    method_kwargs = {}
     if content:
-        kwargs = content[0]
-        kwargs = KWARGS_REGEX.findall(kwargs)
-        for key, value in kwargs:
-            # method Keywords must be Strings
-            key = key.encode(settings.DEFAULT_CHARSET)
-            value_lower = value.lower()
-            if value_lower in ("true", "on"):
-                value = True
-            elif value_lower in ("false", "off"):
-                value = False
-            method_kwargs[key] = value
+        raw_kwargs = content[0]
+        method_kwargs = make_kwagrs(raw_kwargs)
+    else:
+        method_kwargs = {}
 
     return lucidTagNode(plugin_name, method_name, method_kwargs)

trunk/pylucid/PyLucid/tools/utils.py

@@ -18 +18 @@
 """
 
+import shlex
 from xml.sax.saxutils import escape as sax_escape
 
@@ -31 +32 @@
     Escape "&", "<", ">" and django template tags chars like "{" and "}"
     defined in ENTITIES to the HTML character entity.
+    >>> escape("<test1> & {{ test2 }} {% test3 %}")
+    '&lt;test1&gt; &amp; &#x7B;&#x7B; test2 &#x7D;&#x7D; &#x7B;% test3 %&#x7D;'
     """
     return sax_escape(txt, entities=ENTITIES)
@@ -38 +41 @@
     Escape only django template tags chars like "{" and "}" defined in ENTITIES
     to the HTML character entity.
+
+    >>> escape_django_tags("<test1> &")
+    '<test1> &'
+
+    >>> escape_django_tags("{{ test2 }} {% test3 %}")
+    '&#x7B;&#x7B; test2 &#x7D;&#x7D; &#x7B;% test3 %&#x7D;'
     """
     for source, dest in ENTITIES.iteritems():
         txt = txt.replace(source, dest)
     return txt
+
+
+# For make_kwagrs()
+KEYWORD_MAP = {
+    "True": True,
+    "False": False,
+    "None": None,
+}
+
+def make_kwagrs(raw_content, encoding="UTF-8"):
+    """
+    convert a string into a dictionary. e.g.:
+
+    >>> make_kwagrs('key1="value1" key2="value2"')
+    {'key2': 'value2', 'key1': 'value1'}
+
+    >>> make_kwagrs('A="B" C=1 D=1.1 E=True F=False G=None')
+    {'A': 'B', 'C': 1, 'E': True, 'D': '1.1', 'G': None, 'F': False}
+
+    >>> make_kwagrs(u'unicode=True')
+    {'unicode': True}
+    """
+    if isinstance(raw_content, unicode):
+        # shlex.split doesn't work with unicode?!?
+        raw_content = raw_content.encode(encoding)
+
+    parts = shlex.split(raw_content)
+
+    result = {}
+    for part in parts:
+        key, value = part.split("=", 1)
+
+        if value in KEYWORD_MAP:
+            # True False or None
+            value = KEYWORD_MAP[value]
+        else:
+            # A number?
+            try:
+                value = int(value)
+            except ValueError:
+                pass
+
+        result[key] = value
+
+    return result
+
+
+
+if __name__ == "__main__":
+    import doctest
+    doctest.testmod(
+#        verbose=True
+        verbose=False
+    )
+    print "DocTest end."

trunk/pylucid/tests/test_plugin_api.py

@@ -204 +204 @@
         # plugin model tables should be re-created, too.
         install_plugin(
-            package_name, plugin_name, page_msg, verbosity=2, active=True
+            package_name, plugin_name,
+            page_msg, verbosity=2, user=None, active=True
         )
 
@@ -281 +282 @@
         )
         self.assertEqual2(args, "()")
-        self.assertEqual2(kwargs, "{'arg1': u'test1'}")
-
-    def test_tag_more_args(self):
-        """
-        More string kwargs
+        self.assertEqual2(kwargs, "{'arg1': 'test1'}")
+
+    def test_numbers(self):
+        """
+        Test string and numbers
         """
         args, kwargs = self._get_args_info(
-            '{% lucidTag unittest_plugin a="0" b="1" c="2" %}'
+            '{% lucidTag unittest_plugin a="0" b=1 c=2 %}'
         )
         self.assertEqual2(args, "()")
-        self.assertEqual2(kwargs, "{'a': u'0', 'b': u'1', 'c': u'2'}")
-
-    def test_tag_bool_args1(self):
-        """
-        The current implementation converts strings to bool if it found
-        the bool words.
+        self.assertEqual2(kwargs, "{'a': 0, 'b': 1, 'c': 2}")
+
+    def test_keywords(self):
+        """
+        Test True, False and None
         """
         args, kwargs = self._get_args_info(
-            '{% lucidTag unittest_plugin'
-            ' t1="True" f1="False" t2="true" f2="false" %}'
+            '{% lucidTag unittest_plugin a=True b=False c=None %}'
         )
         self.assertEqual2(args, "()")
         self.assertEqual2(kwargs,
-            "{'f1': False, 'f2': False, 't1': True, 't2': True}"
-        )
-
-    #__________________________________________________________________________
-    # Problems with the current implementation.
-    # We can't pass other things than string.
-    """
-    Importtant: All follow test will failed!
-    See:
-        http://pylucid.net:8080/pylucid/ticket/202
-        http://pylucid.org/phpBB2/viewtopic.php?t=228
-    """
-    def test_tag_bool_args2(self):
-        """
-        Faild in the current implementation!
-        """
-        args, kwargs = self._get_args_info(
-            '{% lucidTag unittest_plugin t1=True f1=False %}'
-        )
-        self.assertEqual2(args, "()")
-        self.assertEqual2(kwargs,
-            "{'f1': False, 'f2': False}",
-            error_msg="Faild in the current implementation!"
-        )
-
-    def test_non_string_args(self):
-        """
-        Faild in the current implementation!
-        """
-        args, kwargs = self._get_args_info(
-            '{% lucidTag unittest_plugin arg1=1 arg2=2.0 %}'
-        )
-        self.assertEqual2(args, "()")
-        self.assertEqual2(kwargs,
-            "{'arg1': 1, 'args2': 2.0}",
-            error_msg="Faild in the current implementation!"
-        )
-
-
-
+            "{'a': True, 'b': False, 'c': None}"
+        )
+
+
+class PluginPreferencesTest(PluginAPI_Base):
+    """
+    Test the preferences API.
+
+    more info about plugin preferences:
+        http://www.pylucid.org/_goto/153/preferences/
+    """
+    def test(self):
+        url = self.command % "test_preferences"
+        content = self._get_plugin_content(url, debug=False)
+        self.assertEqual2(
+            content,
+            "{'index': u'Index', 'print_index': False, 'print_last_page': True,"
+            " 'index_url': u'/'}"
+        )