[utils] Add the possibility to add elements in the head of an UStringIO list

--HG-- branch : 3.26

[utils] Add the possibility to add elements in the head of an UStringIO list
--HG-- branch : 3.26
b849eb11 · Guillaume Vandevelde · 9fa65579520f · cc71a801 · cc71a801
Commit b849eb11 authored Feb 10, 2020 by Guillaume Vandevelde
--- a/cubicweb/test/unittest_utils.py
+++ b/cubicweb/test/unittest_utils.py
@@ -287,6 +287,9 @@ class HTMLHeadTC(CubicWebTC):
            head.add_js(base_url + u'bob1.js')
            head.add_js(u'http://ext.com/bob2.js')
            head.add_js(u'http://ext.com/bob3.js')
+            head.write_front(
+                '<script type="text/javascript">console.log("FIRST SCRIPT ADDED HERE")</script>'
+            )
            head.add_css(base_url + u'bob4.css')
            head.add_css(base_url + u'bob5.css')
            head.add_css(base_url + u'bob6.css', 'print')
@@ -295,6 +298,7 @@ class HTMLHeadTC(CubicWebTC):
            head.add_ie_css(base_url + u'bob9.css', 'print', u'[if lt IE 7]')
            result = head.getvalue()
            expected = u"""<head>
+<script type="text/javascript">console.log("FIRST SCRIPT ADDED HERE")</script>
 <link rel="stylesheet" type="text/css" media="all" href="http://test.fr/data/bob4.css"/>
 <link rel="stylesheet" type="text/css" media="all" href="http://test.fr/data/bob5.css"/>
 <link rel="stylesheet" type="text/css" media="print" href="http://test.fr/data/bob6.css"/>

--- a/cubicweb/utils.py
+++ b/cubicweb/utils.py
@@ -33,6 +33,7 @@ if PY3:
    from inspect import getfullargspec as getargspec
 else:
    from inspect import getargspec
+from functools import wraps
 from itertools import repeat
 from uuid import uuid4
 from warnings import warn
@@ -191,6 +192,22 @@ class RepeatList(object):
        self._size -= 1


+def handle_writing_constraints(method):
+    @wraps(method)
+    def wrapper(self, value):
+        assert isinstance(value, text_type), u"unicode required not %s : %s"\
+            % (type(value).__name__, repr(value))
+        if self.tracewrites:
+            from traceback import format_stack
+            stack = format_stack(None)[:-1]
+            escaped_stack = xml_escape(json_dumps(u'\n'.join(stack)))
+            escaped_html = xml_escape(value).replace('\n', '<br/>\n')
+            tpl = u'<span onclick="alert(%s)">%s</span>'
+            value = tpl % (escaped_stack, escaped_html)
+        return method(self, value)
+    return wrapper
+
+
 class UStringIO(list):
    """a file wrapper which automatically encode unicode string to an encoding
    specifed in the constructor
@@ -205,18 +222,14 @@ class UStringIO(list):

    __nonzero__ = __bool__

+    @handle_writing_constraints
    def write(self, value):
-        assert isinstance(value, text_type), u"unicode required not %s : %s"\
-                                     % (type(value).__name__, repr(value))
-        if self.tracewrites:
-            from traceback import format_stack
-            stack = format_stack(None)[:-1]
-            escaped_stack = xml_escape(json_dumps(u'\n'.join(stack)))
-            escaped_html = xml_escape(value).replace('\n', '<br/>\n')
-            tpl = u'<span onclick="alert(%s)">%s</span>'
-            value = tpl % (escaped_stack, escaped_html)
        self.append(value)

+    @handle_writing_constraints
+    def write_front(self, value):
+        self.insert(0, value)
+
    def getvalue(self):
        return u''.join(self)