Merge pull request #103 from colab/improve_widget

Improve widget

Merge pull request #103 from colab/improve_widget
Improve widget
Gustavo Jaruga Cruz
2 parents 7397ed19 dc49d1d7
Showing 9 changed files with 84 additions and 11 deletions Show diff stats
colab/accounts/templates/accounts/user_update_form.html
colab/accounts/views.py
colab/accounts/widgets/__init__.py
colab/settings.py
colab/templates/base.html
colab/widgets/templatetags/__init__.py
colab/widgets/templatetags/widgets_tag.py
colab/widgets/tests/test_widgets.py
docs/source/dev.rst
 {% extends "base.html" %}
-{% load i18n gravatar plugins %}
+{% load i18n gravatar plugins widgets_tag %}
+
+{% block html %}
+   {% import_widgets 'profile' %}
+   {{ block.super }}
+{% endblock %}
 {% block head_js %}
 <script>
@@ -105,7 +110,7 @@ $(function() {
 {% block head %}
   {{ block.super }}
-  {% for widget in widgets %}
+  {% for widget in widgets_profile %}
     {{ widget.get_header }}
   {% endfor %}
@@ -129,7 +134,7 @@ $(function() {
   <!-- Start of navs -->
   <ul class="nav nav-tabs">
     <li class="active"><a data-toggle="pill" href="#profile">Profile</a></li>
-    {% for widget in widgets %}
+    {% for widget in widgets_profile %}
       <li>
         <a data-toggle="pill" href="#{{ widget.identifier }}">{{ widget.name }}</a>
       </li>
@@ -229,7 +234,7 @@ $(function() {
         </div>
       </form>
     </div>
-    {% for widget in widgets %}
+    {% for widget in widgets_profile %}
       <div id="{{ widget.identifier }}" class="tab-pane fade">
         <h2>{{ widget.name }}</h2>
         {{ widget.get_body }}
@@ -15,7 +15,6 @@ from colab.super_archives.models import (EmailAddress,
                                          EmailAddressValidation)
 from colab.search.utils import get_collaboration_data, get_visible_threads
 from colab.accounts.models import User
-from colab.widgets.widget_manager import WidgetManager
 from .forms import (UserCreationForm, ListsForm, UserUpdateForm)
 from .utils import mailman
@@ -43,12 +42,6 @@ class UserProfileUpdateView(UserProfileBaseMixin, UpdateView):
         return obj
-    def get_context_data(self, **kwargs):
-        context = {}
-        context['widgets'] = WidgetManager.get_widgets('profile', self.request)
-        context.update(kwargs)
-        return super(UserProfileUpdateView, self).get_context_data(**context)
-
 class UserProfileDetailView(UserProfileBaseMixin, DetailView):
     template_name = 'accounts/user_detail.html'
@@ -53,6 +53,7 @@ INSTALLED_APPS = (
     'colab',
     'colab.home',
     'colab.plugins',
+    'colab.widgets',
     'colab.super_archives',
     'colab.rss',
     'colab.search',
@@ -2,6 +2,7 @@
 {% load i18n gravatar plugins %}
 {% load static from staticfiles %}
+{% block html %}
 <html>
   <head>
   {% block head %}
@@ -101,3 +102,4 @@
   {% block footer_js %}{% endblock %}
   </body>
 </html>
+{% endblock %}
@@ -0,0 +1,14 @@
+from django import template
+from colab.widgets.widget_manager import WidgetManager
+
+
+register = template.Library()
+
+
+@register.simple_tag(takes_context=True)
+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['request'])
+    return ""
@@ -0,0 +1,29 @@
+import unittest
+from mock import patch
+
+from colab.widgets.templatetags.widgets_tag import import_widgets
+from colab.widgets.widget_manager import WidgetManager
+
+
+class WidgetsTest(unittest.TestCase):
+    @patch.object(WidgetManager, 'get_widgets')
+    def test_import_widgets_tag(self, get_widgets):
+        return_list = [1, 2, 3]
+        get_widgets.return_value = return_list
+
+        context = {'request': ""}
+        import_widgets(context, 'area')
+
+        self.assertIn('widgets_area', context)
+        self.assertEquals(context['widgets_area'], return_list)
+
+    @patch.object(WidgetManager, 'get_widgets')
+    def test_import_widgets_tag_with_named_var(self, get_widgets):
+        return_list = [1, 2, 3]
+        get_widgets.return_value = return_list
+
+        context = {'request': ""}
+        import_widgets(context, 'area', 'var')
+
+        self.assertIn('var', context)
+        self.assertEquals(context['var'], return_list)
@@ -48,3 +48,32 @@ Example Widget:
                 self.content = processed_content
 To add the widget in a view check the Widgets section in User Documentation.
+To use a widget in the templates, you have to use the ``import_widget`` tag inside the ``html`` block.
+You can also set the variable that the widgets of an area will be imported.
+Or you can use the default name, which is ``widgets_area_name``.
+For example, in the ``profile`` area the variable name is ``widgets_profile``.
+This variable will be inserted directly in the page ``context``.
+
+.. code-block:: python
+
+    {% load widgets_tag %}
+
+    {% block html %}
+       {% import_widgets 'profile' %}
+       {{ block.super }}
+    {% endblock %}
+
+    {# example of how to use #}
+    {% block head %}
+      {{ block.super }}
+
+      {% for widget in widgets_profile %}
+        {{ widget.get_header }}
+      {% endfor %}
+
+    {% endblock %}
+
+
+.. warning::
+
+    Warning! Remember to use the tag ``{{ block.super }}`` inside the html block. Otherwise, the page will appear blank.
@@ -0,0 +1,14 @@		@@ -0,0 +1,14 @@
	1	+from django import template
	2	+from colab.widgets.widget_manager import WidgetManager
	3	+
	4	+
	5	+register = template.Library()
	6	+
	7	+
	8	+@register.simple_tag(takes_context=True)
	9	+def import_widgets(context, area_id, widget_var=None):
	10	+ if not widget_var:
	11	+ widget_var = "widgets_{}".format(area_id)
	12	+ context[widget_var] = WidgetManager.get_widgets(area_id,
	13	+ context['request'])
	14	+ return ""
@@ -0,0 +1,29 @@		@@ -0,0 +1,29 @@
	1	+import unittest
	2	+from mock import patch
	3	+
	4	+from colab.widgets.templatetags.widgets_tag import import_widgets
	5	+from colab.widgets.widget_manager import WidgetManager
	6	+
	7	+
	8	+class WidgetsTest(unittest.TestCase):
	9	+ @patch.object(WidgetManager, 'get_widgets')
	10	+ def test_import_widgets_tag(self, get_widgets):
	11	+ return_list = [1, 2, 3]
	12	+ get_widgets.return_value = return_list
	13	+
	14	+ context = {'request': ""}
	15	+ import_widgets(context, 'area')
	16	+
	17	+ self.assertIn('widgets_area', context)
	18	+ self.assertEquals(context['widgets_area'], return_list)
	19	+
	20	+ @patch.object(WidgetManager, 'get_widgets')
	21	+ def test_import_widgets_tag_with_named_var(self, get_widgets):
	22	+ return_list = [1, 2, 3]
	23	+ get_widgets.return_value = return_list
	24	+
	25	+ context = {'request': ""}
	26	+ import_widgets(context, 'area', 'var')
	27	+
	28	+ self.assertIn('var', context)
	29	+ self.assertEquals(context['var'], return_list)
	@@ -48,3 +48,32 @@ Example Widget:		@@ -48,3 +48,32 @@ Example Widget:
48	self.content = processed_content	48	self.content = processed_content
49		49
50	To add the widget in a view check the Widgets section in User Documentation.	50	To add the widget in a view check the Widgets section in User Documentation.
		51	+To use a widget in the templates, you have to use the ``import_widget`` tag inside the ``html`` block.
		52	+You can also set the variable that the widgets of an area will be imported.
		53	+Or you can use the default name, which is ``widgets_area_name``.
		54	+For example, in the ``profile`` area the variable name is ``widgets_profile``.
		55	+This variable will be inserted directly in the page ``context``.
		56	+
		57	+.. code-block:: python
		58	+
		59	+ {% load widgets_tag %}
		60	+
		61	+ {% block html %}
		62	+ {% import_widgets 'profile' %}
		63	+ {{ block.super }}
		64	+ {% endblock %}
		65	+
		66	+ {# example of how to use #}
		67	+ {% block head %}
		68	+ {{ block.super }}
		69	+
		70	+ {% for widget in widgets_profile %}
		71	+ {{ widget.get_header }}
		72	+ {% endfor %}
		73	+
		74	+ {% endblock %}
		75	+
		76	+
		77	+.. warning::
		78	+
		79	+ Warning! Remember to use the tag ``{{ block.super }}`` inside the html block. Otherwise, the page will appear blank.