simplify seo code

rande · rande · commit d67ee132d4ad · 2014-05-12T18:59:36.000-04:00
diff --git a/element/plugins/seo/__init__.py b/element/plugins/seo/__init__.py
@@ -1,2 +1,3 @@
 # vim: set fileencoding=utf-8 :
 
+from element.plugins.seo.seo import *
diff --git a/element/plugins/seo/di.py b/element/plugins/seo/di.py
@@ -6,8 +6,7 @@ def load(self, config, container_builder):
         path = os.path.dirname(os.path.abspath(__file__))
 
         loader = ioc.loader.YamlLoader()
-        loader.load("%s/resources/config/handler_seo.yml" % path, container_builder)
-        loader.load("%s/resources/config/listener_seo.yml" % path, container_builder)
+        loader.load("%s/resources/config/seo.yml" % path, container_builder)
 
         container_builder.parameters.set('element.seo.page.title_pattern', config.get_all('title_pattern', 'Python Element : %s'))
         container_builder.parameters.set('element.seo.page.metas', config.get_all('metas', {}))
diff --git a/element/plugins/seo/listener.py b/element/plugins/seo/listener.py
diff --git a/element/plugins/seo/resources/config/handler_seo.yml b/element/plugins/seo/resources/config/handler_seo.yml
diff --git a/element/plugins/seo/resources/config/listener_seo.yml b/element/plugins/seo/resources/config/listener_seo.yml
diff --git a/element/plugins/seo/resources/config/seo.yml b/element/plugins/seo/resources/config/seo.yml
@@ -0,0 +1,23 @@
+services:
+    element.plugins.seo.page:
+        class: element.plugins.seo.SeoPage
+        arguments:
+            - "%element.seo.page.title_pattern%"
+            - "%element.seo.page.metas%"
+            - "%element.seo.page.keywords%"
+
+    element.plugins.listener.seo:
+        class: element.plugins.seo.SeoListener
+        arguments:
+            - "@element.plugins.seo.page"
+        tags:
+            event.listener:
+                - { name: element.seo.headers, method: listener }
+
+    element.plugins.seo:
+        class: element.plugins.seo.SeoHandler
+        arguments:
+            - '@ioc.extra.jinja2'
+        tags:
+            element.handler:
+                - { name: seo.headers }
diff --git a/element/plugins/seo/seo.py b/element/plugins/seo/seo.py
@@ -1,4 +1,81 @@
 import element.node
+from ioc.helper import deepcopy
+
+class SeoPage(object):
+    def __init__(self, title_pattern="%s", metas=None, keywords=None):
+        self.title_pattern = title_pattern
+        self.metas = metas or {}
+        self.keywords = keywords or []
+
+class SeoListener(object):
+    def __init__(self, seo_page):
+        self.seo_page = seo_page
+
+    def listener(self, event):
+        """
+        listen to element.seo.headers event and return a node with seo information only
+        subject should be a NodeContext object
+        """
+        if not event.has('subject'):
+            return
+
+        node = element.node.Node('seo://%s' % event.get('subject').id, {
+            'type': 'seo.headers',
+            'seo': self.build_seo(event.get('subject')),
+        })
+
+        event.set('node', node)
+
+    def build_seo(self, context):
+        """
+        build the seo information from the provide context
+        """
+        seo = {
+            'title': None,
+            'metas': {}
+        }
+
+        self.configure_title(context, seo)
+        self.configure_metas(context, seo)
+
+        return seo
+
+    def get_title(self, title):
+        return self.seo_page.title_pattern % title
+
+    def configure_title(self, context, seo):
+        if 'seo' in context.settings and 'title' in context.settings['seo']:
+            seo['title'] = self.get_title(context.settings['seo']['title'])
+
+            return
+
+        for field in ['title', 'name']:
+            if context[field]:
+                seo['title'] = self.get_title(context[field])
+                return
+
+        # no title defined!
+        seo['title'] = self.get_title(u"\u2605")
+
+    def configure_metas(self, context, seo):
+        if 'seo' not in context.settings or 'metas' not in context.settings['seo']:
+            seo['metas'] = deepcopy(self.seo_page.metas)
+
+            return
+
+        if 'metas' in context.settings['seo']:
+            seo['metas'] = deepcopy(context.settings['seo']['metas'])
+
+        for pname, pmetas in deepcopy(self.seo_page.metas).iteritems():
+            if pname not in seo['metas']:
+                seo['metas'][pname] = pmetas
+                continue
+
+            # merge values
+            for mname, mvalue in pmetas.iteritems():
+                if mname not in seo['metas'][pname]:
+                    seo['metas'][pname][mname] = mvalue
+                    
 
 class SeoHandler(element.node.NodeHandler):
     def __init__(self, templating):
@@ -17,18 +94,3 @@ def execute(self, request_handler, context):
             'context': context,
             'seo': context.seo
         })
-
-    def listener(self, event):
-        """
-        listen to element.seo.headers event and return a node with seo information only
-        subject should be a NodeContext object
-        """
-        if 'seo' not in event.get('subject').settings:
-            return
-
-        node = element.node.Node('seo://%s' % event.get('subject').id, {
-            'type': 'seo.headers',
-            'seo': event.get('subject').seo,
-        })
-
-        event.set('node', node)
diff --git a/tests/plugins/seo/__init__.py b/tests/plugins/seo/__init__.py
@@ -0,0 +1 @@
+__author__ = 'rande'
diff --git a/tests/plugins/seo/test_seo.py b/tests/plugins/seo/test_seo.py
@@ -0,0 +1,67 @@
+# vim: set fileencoding=utf-8 :
+import unittest
+
+from element.plugins.seo import SeoListener, SeoPage
+from element.node import Node
+from element.node import NodeContext
+
+from ioc.event import Event
+
+class SeoListenerTest(unittest.TestCase):
+    def test_title(self):
+        page = SeoPage()
+        listener = SeoListener(page)
+
+        self.assertEquals("title", listener.get_title("title"))
+
+    def test_event_without_subject(self):
+        event = Event()
+
+        SeoListener(SeoPage()).listener(event)
+
+        self.assertFalse(event.has('node'))
+
+    def test_event_with_subject(self):
+
+        event = Event({
+            'subject': NodeContext(Node())
+        })
+
+        SeoListener(SeoPage()).listener(event)
+
+        self.assertTrue(event.has('node'))
+
+        node = event.get('node')
+        self.assertEquals(node.seo['title'], u"\u2605")
+        self.assertEquals(node.seo['metas'], {})
+
+    def test_event_with_subject_seo(self):
+        event = Event({
+            'subject': NodeContext(Node(), {
+                'name': 'the name',
+                'seo': {
+                    'metas': {
+                        'name': {
+                            'keywords': 'list, of, keywords'
+                        }
+                    }
+                }
+            })
+        })
+
+        SeoListener(SeoPage("site - %s", {
+            'name': {
+                'description': 'The description'
+            }
+        })).listener(event)
+
+        self.assertTrue(event.has('node'))
+
+        node = event.get('node')
+        self.assertEquals(node.seo['title'], "site - the name")
+        self.assertEquals(node.seo['metas'], {
+            'name': {
+                'keywords': 'list, of, keywords',
+                'description': 'The description'
+            }
+        })

Original file line number	Diff line number	Diff line change
`@@ -1,2 +1,3 @@`
`1`	`1`	`# vim: set fileencoding=utf-8 :`
`2`	`2`
	`3`	`+from element.plugins.seo.seo import *`