Merge pull request #106 from colab/improve_widget

Improve widget

Merge pull request #106 from colab/improve_widget
Improve widget
Matheus de Sousa Faria
2 parents d3de2a35 4a22801d
Showing 4 changed files with 79 additions and 20 deletions Show diff stats
colab/widgets/templatetags/widgets_tag.py
colab/widgets/tests/test_widget_manager.py
colab/widgets/tests/test_widgets.py
colab/widgets/widget_manager.py
@@ -9,5 +9,7 @@ register = template.Library()
 def import_widgets(context, area_id, widget_var=None):
     if not widget_var:
         widget_var = "widgets_{}".format(area_id)
+
     context[widget_var] = WidgetManager.get_widgets(area_id, context=context)
+
     return ""
@@ -3,34 +3,54 @@ from django.test import TestCase
 from colab.widgets.widget_manager import WidgetManager, Widget
+class WigetMock(Widget):
+
+    def __init__(self, content=""):
+        self.content = content
+
+
 class WidgetManagerTest(TestCase):
     html_content = "<head><meta charset='UTF-8'></head><body><p>T</p></body>"
     widget_area = 'profile'
     widget_id = 'widget_id'
-    def custom_widget_instance(self, content):
+    def ovewrited_widget_instance(self, content):
-        class CustomWidget(Widget):
+        class WidgetOverwrited(Widget):
             identifier = 'widget_id'
             def generate_content(self, request=None):
                 self.content = content
-        return CustomWidget()
+        return WidgetOverwrited()
+
+    def default_widget_instance(self):
+
+        class WidgetDefault(Widget):
+            pass
+
+        return WidgetDefault()
     def setUp(self):
-        custom_widget = self.custom_widget_instance(self.html_content)
+        custom_widget = self.ovewrited_widget_instance(self.html_content)
         WidgetManager.register_widget(self.widget_area, custom_widget)
     def tearDown(self):
         WidgetManager.unregister_widget(self.widget_area, self.widget_id)
+    def test_widget_default_values(self):
+        widget = self.default_widget_instance()
+        self.assertEqual(widget.identifier, None)
+        self.assertEqual(widget.name, None)
+        self.assertEqual(widget.content, '')
+        self.assertEqual(widget.template, '')
+
     def test_add_widgets_to_key_area(self):
         self.assertEqual(len(WidgetManager.get_widgets(self.widget_area)), 1)
     def test_remove_widgets_in_key_area(self):
         area = 'admin'
-        widget_instance = self.custom_widget_instance(self.html_content)
+        widget_instance = self.ovewrited_widget_instance(self.html_content)
         WidgetManager.register_widget(area, widget_instance)
         WidgetManager.unregister_widget(area, self.widget_id)
@@ -38,17 +58,41 @@ class WidgetManagerTest(TestCase):
         self.assertEqual(len(WidgetManager.get_widgets(area)), 0)
     def test_get_body(self):
-        customWidget = self.custom_widget_instance(self.html_content)
+        custom_widget = self.ovewrited_widget_instance(self.html_content)
-        customWidget.generate_content()
-        self.assertEqual(customWidget.get_body(), "<p>T</p>")
+        custom_widget.generate_content()
+        self.assertEqual(custom_widget.get_body(), "<p>T</p>")
     def test_get_header(self):
-        customWidget = self.custom_widget_instance(self.html_content)
+        custom_widget = self.ovewrited_widget_instance(self.html_content)
+
+        custom_widget.generate_content()
+        self.assertEqual(custom_widget.get_header(), "<meta charset='UTF-8'>")
+
+    def test_get_header_wrong(self):
+        widget = self.default_widget_instance()
+        widget.content = "<head> Teste <head>"
+        self.assertEqual(widget.get_header(), '')
-        customWidget.generate_content()
-        self.assertEqual(customWidget.get_header(), "<meta charset='UTF-8'>")
+    def test_get_body_wrong(self):
+        widget = self.default_widget_instance()
+        widget.content = "<body> Teste <body>"
+        self.assertEqual(widget.get_body(), '')
     def test_generate_content(self):
         widgets = WidgetManager.get_widgets(self.widget_area)
         self.assertEqual(widgets[0].content, self.html_content)
+
+    def test_widget_with_invalid_area(self):
+        self.assertEqual(WidgetManager.get_widgets("area"), [])
+
+    def test_generate_content_without_template(self):
+        widget = self.default_widget_instance()
+        with self.assertRaises(Exception):
+            widget.generate_content()
+
+    def test_generate_content_with_template(self):
+        widget = self.default_widget_instance()
+        widget.template = self.html_content
+        with self.assertRaises(Exception):
+            widget.generate_content()
@@ -2,16 +2,24 @@ import unittest
 from mock import patch
 from colab.widgets.templatetags.widgets_tag import import_widgets
-from colab.widgets.widget_manager import WidgetManager
+from colab.widgets.widget_manager import WidgetManager, Widget
+from django.template import Context
+
+
+class WigetMock(Widget):
+
+    def __init__(self, content=""):
+        self.content = content
 class WidgetsTest(unittest.TestCase):
+
     @patch.object(WidgetManager, 'get_widgets')
     def test_import_widgets_tag(self, get_widgets):
-        return_list = [1, 2, 3]
+        return_list = [WigetMock(), WigetMock(), WigetMock()]
         get_widgets.return_value = return_list
-        context = {'request': ""}
+        context = Context({'request': ""})
         import_widgets(context, 'area')
         self.assertIn('widgets_area', context)
@@ -19,10 +27,10 @@ class WidgetsTest(unittest.TestCase):
     @patch.object(WidgetManager, 'get_widgets')
     def test_import_widgets_tag_with_named_var(self, get_widgets):
-        return_list = [1, 2, 3]
+        return_list = [WigetMock(), WigetMock(), WigetMock()]
         get_widgets.return_value = return_list
-        context = {'request': ""}
+        context = Context({'request': ""})
         import_widgets(context, 'area', 'var')
         self.assertIn('var', context)
 from django.utils.safestring import mark_safe
+from django.template.loader import render_to_string
 class Widget(object):
     identifier = None
     name = None
     content = ''
+    template = ''
     def get_body(self):
         # avoiding regex in favor of performance
@@ -28,8 +30,11 @@ class Widget(object):
         head = self.content[start + len('<head>'):end]
         return mark_safe(head)
-    def generate_content(self, **kwarg):
-        self.content = ''
+    def generate_content(self, **kwargs):
+        if not self.template:
+            class_name = self.__class__.__name__
+            raise Exception("Template not defined in {}.".format(class_name))
+        self.content = render_to_string(self.template, kwargs.get('context'))
 class WidgetManager(object):
@@ -50,11 +55,11 @@ class WidgetManager(object):
                     WidgetManager.widget_categories[category].remove(widget)
     @staticmethod
-    def get_widgets(category, **kargs):
+    def get_widgets(category, **kwargs):
         if category not in WidgetManager.widget_categories:
             return []
         widgets = WidgetManager.widget_categories[category][:]
         for widget in widgets:
-            widget.generate_content(**kargs)
+            widget.generate_content(**kwargs)
         return widgets