Changeset 234

Timestamp:

04/21/08 19:35:22 (7 months ago)

Author:

akaihola

Message:

[yui] Added support for loading the default skin.

Location:

trunk/yui

Files:

• components.py (modified) (3 diffs)
• middleware.py (modified) (10 diffs)
• module_info_2_5_1.py (modified) (1 diff)
• tests/test_middleware.py (modified) (2 diffs)

trunk/yui/components.py

@@ -34 +34 @@
         return self.data.get('rollup', 1)
 
+    @property
+    def skinnable(self):
+        return self.data.get('skinnable', False)
+
+    @property
+    def fullpath(self):
+        return self.data.get('fullpath', None)
+
     def __getattr__(self, attname):
         return self.data[attname]
@@ -40 +48 @@
 class Components(dict):
     def __init__(self, components_dict):
-        super(Components, self).__init__(components_dict)
+        super(Components, self).__init__()
         self.rollup_mapping = {}
         for component_name, data in components_dict.items():
-            self.rollup_mapping.setdefault(component_name, set())
-            if 'rollup' not in data:
-                continue
-            for rolled_up in data['supersedes']:
-                self.rollup_mapping.setdefault(rolled_up, set()).add(
-                    component_name)
+            self.add(component_name, data)
 
     def __getitem__(self, component_name):
@@ -66 +69 @@
         return [name for name, data in self.items()
                 if data['type'] == 'css']
+
+    def add(self, component_name, data):
+        self[component_name] = data
+        self.rollup_mapping.setdefault(component_name, set())
+        if 'rollup' not in data:
+            return
+        for rolled_up in data['supersedes']:
+            self.rollup_mapping.setdefault(rolled_up, set()).add(
+                component_name)

trunk/yui/middleware.py

@@ -69 +69 @@
 
 import re
+from shlex import shlex
 
 from django.conf import settings
 
-from module_info_2_5_1 import MODULE_INFO
+from module_info_2_5_1 import MODULE_INFO, SKIN
 from components import Components
 
@@ -87 +88 @@
 VERSIONS = {'raw': '', '': '', 'min': '-min', 'debug': '-debug'}
 
-COMPONENTS = Components(MODULE_INFO)
-
 
 class YUILoader:
 
     def __init__(self):
+        self._module_info = Components(MODULE_INFO)
         self._components = set()
         self._rolled_up_components = {}
@@ -112 +112 @@
                 self._roll_up_superseded(new_component_name)
 
+    def add_module(self, module_def):
+        module_data = {}
+        lexer = shlex(module_def, posix=True)
+
+        def expect(*patterns):
+            token = lexer.get_token()
+            if token not in patterns:
+                raise ValueError, '%s expected instead of %s' % \
+                      (' or '.join(repr(s) for s in patterns),
+                       token and repr(token) or 'end of data')
+            return token
+
+        str_attrs = 'name', 'type', 'path', 'fullpath', 'varName'
+        list_attrs = 'requires', 'optional', 'after'
+        state = 'ATTR'
+        expect('{')
+        while state != 'STOP':
+            if state == 'ATTR':
+                token = expect(*str_attrs+list_attrs)
+                expect(':')
+                if token in str_attrs:
+                    module_data[token] = lexer.get_token()
+                    if module_data[token] is None:
+                        raise ValueError, \
+                              'string expected instead of end of data'
+                    state = 'DELIM'
+                elif token in list_attrs:
+                    expect('[')
+                    lst = module_data[token] = []
+                    state = 'LIST'
+            elif state == 'LIST':
+                lst.append(lexer.get_token())
+                if re.search(r'\W', lst[-1]):
+                    raise ValueError, 'invalid component name %r' % token
+                if expect(',', ']') == ']':
+                    state = 'DELIM'
+            elif state == 'DELIM':
+                if expect(',', '}') == '}':
+                    expect(None)
+                    state = 'STOP'
+                else:
+                    state = 'ATTR'
+
+        if 'type' not in module_data:
+            raise ValueError, 'type missing in %r' % module_def
+        self._module_info.add(module_data['name'], module_data)
+        return module_data
+
     def render(self):
         return '\n'.join(self._render_component(component)
@@ -122 +170 @@
     def _get_satisfied_rollup(self, component_name):
         if self._version == '-min':
-            for rollup_name in COMPONENTS.get_rollups(component_name):
+            for rollup_name in self._module_info.get_rollups(component_name):
                 rollup_status = self._rollup_counters.get(rollup_name, set())
-                if len(rollup_status) >= COMPONENTS[rollup_name].rollup:
+                if len(rollup_status) >= self._module_info[rollup_name].rollup:
                     return rollup_name
 
     def _count_in_rollups(self, component_name):
-        for rollup_name in COMPONENTS.get_rollups(component_name):
+        for rollup_name in self._module_info.get_rollups(component_name):
             rolled_up = self._rollup_counters.setdefault(rollup_name, set())
             rolled_up.add(component_name)
-        for superseded in COMPONENTS[component_name].supersedes:
+        for superseded in self._module_info[component_name].supersedes:
             self._count_in_rollups(superseded)
 
     def _roll_up_superseded(self, component_name):
-        for superseded in COMPONENTS[component_name].supersedes:
+        for superseded in self._module_info[component_name].supersedes:
             self._rolled_up_components[superseded] = component_name
             if superseded in self._components:
@@ -141 +189 @@
 
     def _add_requirements(self, component_name):
-        for requirement in COMPONENTS[component_name].requires:
+        component = self._module_info[component_name]
+        for requirement in component.requires:
             self.add_component(requirement)
+        if component.skinnable:
+            self.add_component(SKIN['defaultSkin'])
 
     def _render_component(self, component_name):
-        component = COMPONENTS[component_name]
-        path = component.path
+        component = self._module_info[component_name]
+        path = component.fullpath or YUI_BASE + component.path
         if component.type == 'js':
             if self._version != '-min' and path.endswith('-min.js'):
@@ -153 +204 @@
             if self._version == '' and path.endswith('-min.css'):
                 path = path[:-8] + '.css'
-        return TAGS[component.type] % (YUI_BASE + path,)
+        return TAGS[component.type] % path
 
     def _sort_components(self, component_names=None):
@@ -162 +213 @@
         while comps:
             component_name = comps.pop()
-            component = COMPONENTS[component_name]
+            component = self._module_info[component_name]
             direct_deps = component.requires + component.after
             indirect_deps = [
@@ -177 +228 @@
 YUI_RE = re.compile(
     r'%s(include|version) +(.*?)%s' % (PREFIX_RE, SUFFIX_RE))
+YUI_ADDMODULE_RE = re.compile(
+    r'(?s)%saddModule\s*(\{\s*.*?\s*})\s*%s' % (PREFIX_RE, SUFFIX_RE))
 YUI_INIT_RE = re.compile(
     '%sinit%s' % (PREFIX_RE, SUFFIX_RE))
@@ -183 +236 @@
     def process_response(self, request, response):
         components = set()
-        node = YUILoader()
+        loader = YUILoader()
+
+        def add_module(match):
+            loader.add_module(match.group(1))
+            return ''
+        content = YUI_ADDMODULE_RE.sub(add_module, response.content)
+
         def collect(match):
             cmd, data = match.groups()
@@ -189 +248 @@
                 components.update(data.split())
             elif cmd == 'version':
-                node.set_version(data)
+                loader.set_version(data)
             else:
                 return '<!-- UNKNOWN COMMAND YUI_%s -->' % cmd
             return ''
-        content = YUI_RE.sub(collect, response.content)
+        content = YUI_RE.sub(collect, content)
+
         for component in components:
-            node.add_component(component)
-        content = YUI_INIT_RE.sub(node.render(), content, 1)
+            loader.add_component(component)
+
+        content = YUI_INIT_RE.sub(loader.render(), content, 1)
         response.content = YUI_INIT_RE.sub(
             '<!-- WARNING: MULTIPLE YUI_init STATEMENTS -->', content)
+
         return response

trunk/yui/module_info_2_5_1.py

@@ -193 +193 @@
                 'skinnable': True,
                 'type': 'js'}}
+
+SKIN = {
+    'defaultSkin': 'sam',
+    'base': 'assets/skins/',
+    'path': 'skin.css',
+    'after': ['reset', 'fonts', 'grids', 'base'],
+    'rollup': 3 }
+
+MODULE_INFO[SKIN['defaultSkin']] = {
+    'type': 'css',
+    'path': SKIN['base'] + SKIN['defaultSkin'] + '/' + SKIN['path'],
+    'after': SKIN['after'] }

trunk/yui/tests/test_middleware.py

@@ -3 +3 @@
 __doc__ = r"""
     >>> import sys ; sys.setrecursionlimit(100)
+    >>> from pprint import pprint
     >>> from ambidjangolib.yui.middleware import \
-    ...     COMPONENTS, YUILoader
-    >>> COMPONENTS['yahoo'].requires
+    ...     YUILoader
+
+    >>> n = YUILoader()
+
+    >>> n._module_info['yahoo'].requires
     []
-    >>> COMPONENTS['yahoo'].after
-    ['grids', 'reset-fonts', 'reset-fonts-grids', 'base', 'reset', 'fonts']
-    >>> COMPONENTS['event'].requires
+    >>> n._module_info['yahoo'].after
+    ['sam', 'reset-fonts', 'grids', 'reset-fonts-grids', 'base', 'reset', 'fonts']
+    >>> n._module_info['event'].requires
     ['yahoo']
-    >>> COMPONENTS['yuiloader-dom-event'].after
-    ['grids', 'reset-fonts', 'reset-fonts-grids', 'base', 'reset', 'fonts']
-    >>> COMPONENTS.get_rollups('event')
+    >>> n._module_info['yuiloader-dom-event'].after
+    ['sam', 'reset-fonts', 'grids', 'reset-fonts-grids', 'base', 'reset', 'fonts']
+    >>> n._module_info.get_rollups('event')
     set(['utilities', 'yuiloader-dom-event', 'yahoo-dom-event'])
 
-    >>> n = YUILoader()
+    >>> pprint(n.add_module('''{
+    ...     name: 'name', type: 'type', path: 'path', fullpath: 'fullpath',
+    ...     requires: ['req1', 'req2'], after: ['after1', 'after2'],
+    ...     optional: ['opt1', 'opt2'] }'''))
+    {'after': ['after1', 'after2'],
+     'fullpath': 'fullpath',
+     'name': 'name',
+     'optional': ['opt1', 'opt2'],
+     'path': 'path',
+     'requires': ['req1', 'req2'],
+     'type': 'type'}
+
+    >>> n.add_module('[')
+    Traceback (most recent call last):
+    ValueError: '{' expected instead of '['
+
+    >>> n.add_module('{')
+    Traceback (most recent call last):
+    ValueError: 'name' or 'type' or 'path' or 'fullpath' or 'varName' or 'requires' or 'optional' or 'after' expected instead of end of data
+
+    >>> n.add_module('{,')
+    Traceback (most recent call last):
+    ValueError: 'name' or 'type' or 'path' or 'fullpath' or 'varName' or 'requires' or 'optional' or 'after' expected instead of ','
+
+    >>> n.add_module('{name')
+    Traceback (most recent call last):
+    ValueError: ':' expected instead of end of data
 
     >>> def test_sort(*c): return list(n._sort_components(set(c)))
@@ -69 +99 @@
     >>> add(d, 'reset-fonts')
     ['reset-fonts-grids']
+
+    >>> d.add_module("{name:'added',requires:['dom']}")
+    Traceback (most recent call last):
+    ValueError: type missing in "{name:'added',requires:['dom']}"
+
+    >>> pprint(d.add_module("{type:'js',name:'added',requires:['dom']}"))
+    {'name': 'added', 'requires': ['dom'], 'type': 'js'}
+
+    >>> add(d, 'added')
+    ['reset-fonts-grids', 'yahoo', 'dom', 'added']
 """