Merge pull request django-oscar#1482 from machtfit/tables-plural-caption

Tables plural caption

Author: mbertheau

docs/source/releases/v1.1.rst

@@ -28,8 +28,12 @@ What's new in Oscar 1.1?
 ------------------------
 
 * The frontend templates have been updated to use Bootstrap 3 instead of version 2 (`#1576`_)
+* The icon and caption of `django-tables2` tables can be set directly on the `Table` object, if it
+  derives from :class:`~oscar.apps.dashboard.tables.DashboardTable`. The caption can be localized
+  in singular and plural. (`#1482`_)
 
 .. _`#1576`: https://github.com/django-oscar/django-oscar/pull/1576
+.. _`#1482`: https://github.com/django-oscar/django-oscar/pull/1482
 
 
 .. _minor_changes_in_1.1:

oscar/apps/dashboard/catalogue/tables.py

@@ -1,7 +1,7 @@
 from django.utils.safestring import mark_safe
-from django.utils.translation import ugettext_lazy as _
+from django.utils.translation import ugettext_lazy as _, ugettext_noop
 
-from django_tables2 import Table, Column, LinkColumn, TemplateColumn, A
+from django_tables2 import Column, LinkColumn, TemplateColumn, A
 
 from oscar.core.loading import get_class, get_model
 
@@ -10,7 +10,7 @@
 Category = get_model('catalogue', 'Category')
 
 
-class ProductTable(Table):
+class ProductTable(DashboardTable):
     title = TemplateColumn(
         verbose_name=_('Title'),
         template_name='dashboard/catalogue/product_row_title.html',
@@ -37,6 +37,8 @@ class ProductTable(Table):
         template_name='dashboard/catalogue/product_row_actions.html',
         orderable=False)
 
+    icon = "sitemap"
+
     class Meta(DashboardTable.Meta):
         model = Product
         fields = ('upc', 'date_updated')
@@ -45,7 +47,7 @@ class Meta(DashboardTable.Meta):
         order_by = '-date_updated'
 
 
-class CategoryTable(Table):
+class CategoryTable(DashboardTable):
     name = LinkColumn('dashboard:catalogue-category-update', args=[A('pk')])
     description = TemplateColumn(
         template_code='{{ record.description|default:""|striptags'
@@ -61,6 +63,10 @@ class CategoryTable(Table):
         template_name='dashboard/catalogue/category_row_actions.html',
         orderable=False)
 
+    icon = "sitemap"
+    caption_singular = ugettext_noop("{count} Category")
+    caption_plural = ugettext_noop("{count} Categories")
+
     class Meta(DashboardTable.Meta):
         model = Category
         fields = ('name', 'description')

oscar/apps/dashboard/catalogue/views.py

@@ -76,14 +76,21 @@ def get_context_data(self, **kwargs):
         ctx = super(ProductListView, self).get_context_data(**kwargs)
         ctx['form'] = self.form
         ctx['productclass_form'] = self.productclass_form_class()
-        ctx['queryset_description'] = self.get_description(self.form)
         return ctx
 
     def get_description(self, form):
         if form.is_valid() and any(form.cleaned_data.values()):
             return _('Product search results')
         return _('Products')
 
+    def get_table(self, **kwargs):
+        if 'recently_edited' in self.request.GET:
+            kwargs.update(dict(orderable=False))
+
+        table = super(ProductListView, self).get_table(**kwargs)
+        table.caption = self.get_description(self.form)
+        return table
+
     def get_table_pagination(self):
         return dict(per_page=20)
 
@@ -514,7 +521,6 @@ def get_queryset(self):
     def get_context_data(self, *args, **kwargs):
         ctx = super(CategoryListView, self).get_context_data(*args, **kwargs)
         ctx['child_categories'] = Category.get_root_nodes()
-        ctx['queryset_description'] = _("Categories")
         return ctx
 
 
@@ -533,7 +539,6 @@ def get_context_data(self, *args, **kwargs):
                                                                    **kwargs)
         ctx['child_categories'] = self.object.get_children()
         ctx['ancestors'] = self.object.get_ancestors_and_self()
-        ctx['queryset_description'] = _("Categories")
         return ctx
 
 

oscar/apps/dashboard/tables.py

@@ -1,7 +1,26 @@
+from django.utils.translation import ungettext, ugettext_noop
+
 from django_tables2 import Table
 
 
 class DashboardTable(Table):
+    _caption = None
+    caption_singular = ugettext_noop('{count} Row')
+    caption_plural = ugettext_noop('{count} Rows')
+
+    @property
+    def caption(self):
+        if self._caption:
+            return self._caption
+
+        return (ungettext(self.caption_singular, self.caption_plural,
+                          self.paginator.count)
+                .format(count=self.paginator.count))
+
+    @caption.setter
+    def caption(self, caption):
+        self._caption = caption
+
     class Meta:
         template = 'dashboard/table.html'
         attrs = {'class': 'table table-striped table-bordered'}

oscar/apps/dashboard/users/tables.py

@@ -1,11 +1,11 @@
-from django_tables2 import Table, LinkColumn, TemplateColumn, Column, A
+from django_tables2 import LinkColumn, TemplateColumn, Column, A
 
 from oscar.core.loading import get_class
 
 DashboardTable = get_class('dashboard.tables', 'DashboardTable')
 
 
-class UserTable(Table):
+class UserTable(DashboardTable):
     check = TemplateColumn(
         template_name='dashboard/users/user_row_checkbox.html',
         verbose_name=' ', orderable=False)
@@ -21,5 +21,7 @@ class UserTable(Table):
         template_name='dashboard/users/user_row_actions.html',
         verbose_name=' ')
 
+    icon = "group"
+
     class Meta(DashboardTable.Meta):
         template = 'dashboard/users/table.html'

oscar/apps/dashboard/users/views.py

@@ -94,11 +94,14 @@ def apply_search_filters(self, queryset, data):
 
         return queryset
 
+    def get_table(self, **kwargs):
+        table = super(IndexView, self).get_table(**kwargs)
+        table.caption = self.desc_template % self.desc_ctx
+        return table
+
     def get_context_data(self, **kwargs):
         context = super(IndexView, self).get_context_data(**kwargs)
         context['form'] = self.form
-        context['queryset_description'] = self.desc_template % self.desc_ctx
-        context['queryset_icon'] = 'group'
         return context
 
     def make_inactive(self, request, users):

oscar/templates/oscar/dashboard/table.html

@@ -6,7 +6,10 @@
 <caption>
     {% block table.caption %}
         <h3 class="pull-left">
-            <i class="icon-{{ queryset_icon|default:"sitemap" }} icon-large"></i>{{ queryset_description }}
+            {% if table.icon %}
+              <i class="icon-{{ table.icon }} icon-large"></i>
+            {% endif %}
+            {{ table.caption }}
         </h3>
     {% endblock %}
 </caption>