Add Bootstrap template and fix inconsistancy in current template (#149)

While I was at it:
- Clean up unused imports
- Split templatetags tests from template tests
- fix example project for django 1.7 and 1.8

Author: jieter

django_tables2/columns/base.py

@@ -1,7 +1,6 @@
 # coding: utf-8
 from __future__ import absolute_import, unicode_literals
 
-import warnings
 from collections import OrderedDict
 from itertools import islice
 

django_tables2/columns/checkboxcolumn.py

@@ -1,8 +1,6 @@
 # coding: utf-8
 from __future__ import absolute_import, unicode_literals
 
-import warnings
-
 from django.utils.safestring import mark_safe
 
 from django_tables2.utils import AttributeDict

django_tables2/static/django_tables2/bootstrap.css

@@ -0,0 +1,8 @@
+.table-container th.asc:after {
+    content: '\0000a0\0025b2';
+    float: right;
+}
+.table-container th.desc:after {
+    content: '\0000a0\0025bc';
+    float: right;
+}

django_tables2/tables.py

@@ -2,7 +2,6 @@
 from __future__ import unicode_literals
 
 import copy
-import warnings
 from collections import OrderedDict
 
 import six

django_tables2/templates/django_tables2/bootstrap.html

@@ -0,0 +1,74 @@
+{% load querystring from django_tables2 %}
+{% load i18n %}
+{% load blocktrans trans from i18n %}
+
+<div class="table-container">
+    {% block table %}
+        <table class="table table-bordered table-striped"{% if table.attrs %} {{ table.attrs.as_html }}{% endif %}>
+            {% block table.thead %}
+                <thead>
+                <tr>
+                    {% for column in table.columns %}
+                        {% if column.orderable %}
+                            <th {{ column.attrs.th.as_html }}>
+                                <a href="{% querystring table.prefixed_order_by_field=column.order_by_alias.next %}">{{ column.header }}</a>
+                            </th>
+                        {% else %}
+                            <th {{ column.attrs.th.as_html }}>{{ column.header }}</th>
+                        {% endif %}
+                    {% endfor %}
+                </tr>
+                </thead>
+            {% endblock table.thead %}
+            {% block table.tbody %}
+                <tbody>
+                {% for row in table.page.object_list|default:table.rows %} {# support pagination #}
+                    {% block table.tbody.row %}
+                        <tr class="{% cycle "odd" "even" %}">
+                            {% for column, cell in row.items %}
+                                <td {{ column.attrs.td.as_html }}>{{ cell }}</td>
+                            {% endfor %}
+                        </tr>
+                    {% endblock table.tbody.row %}
+                {% empty %}
+                    {% block table.tbody.empty_text %}
+                        {% trans "no results" as table_empty_text %}
+                        <tr>
+                            <td colspan="{{ table.columns|length }}">{{ table.empty_text|default:table_empty_text }}</td>
+                        </tr>
+                    {% endblock table.tbody.empty_text %}
+                {% endfor %}
+                </tbody>
+            {% endblock table.tbody %}
+            {% block table.tfoot %}
+                <tfoot></tfoot>
+            {% endblock table.tfoot %}
+        </table>
+    {% endblock table %}
+
+    {% if table.page and table.paginator.num_pages > 1 %}
+        {% block pagination %}
+        <ul class="pager">
+            {% if table.page.has_previous %}
+            <li class="previous">
+                <a href="{% querystring table.prefixed_page_field=table.page.previous_page_number %}" class="btn btn-default">
+                    {% trans 'previous' %}
+                </a>
+            {% endif %}
+            <li class="cardinality">
+                {% blocktrans with table.page.number as current and table.paginator.num_pages as total %}
+                    Page {{ current }} of {{ total }}
+                {% endblocktrans %}
+            </li>
+            {% if table.page.has_next %}
+            <li class="next">
+                <a href="{% querystring table.prefixed_page_field=table.page.next_page_number %}" class="btn btn-default">
+                    {% trans 'next' %}
+                </a>
+            </li>
+            {% endif %}
+        </ul>
+
+        {% endblock pagination %}
+    {% endif %}
+</div>

django_tables2/templates/django_tables2/table.html

@@ -1,9 +1,8 @@
 {% spaceless %}
 {% load django_tables2 %}
 {% load i18n %}
-{% if table.page %}
+
 <div class="table-container">
-{% endif %}
 {% block table %}
 <table{% if table.attrs %} {{ table.attrs.as_html }}{% endif %}>
     {% nospaceless %}
@@ -70,6 +69,6 @@
 {% endblock pagination %}
 {% endwith %}
 {% endwith %}
-</div>
 {% endif %}
+</div>
 {% endspaceless %}

django_tables2/templatetags/django_tables2.py

@@ -2,13 +2,12 @@
 from __future__ import absolute_import, unicode_literals
 
 import re
-import tokenize
 from collections import OrderedDict
 
 import six
 from django import template
 from django.core.exceptions import ImproperlyConfigured
-from django.template import Node, TemplateSyntaxError, Variable
+from django.template import Node, TemplateSyntaxError
 from django.template.defaultfilters import title as old_title
 from django.template.defaultfilters import stringfilter
 from django.template.loader import get_template, select_template

django_tables2/utils.py

@@ -2,7 +2,6 @@
 from __future__ import absolute_import, unicode_literals
 
 import inspect
-import warnings
 from functools import total_ordering
 from itertools import chain
 

docs/conf.py

@@ -1,15 +1,13 @@
 # coding: utf-8
 import os
-from os.path import abspath, dirname, join
 import re
 import sys
+from os.path import abspath
 
 os.environ["DJANGO_SETTINGS_MODULE"] = "example.settings"
 
 # import project
 sys.path.insert(0, abspath('..'))
-import example
-import django_tables2
 sys.path.pop(0)
 
 

example/app/tables.py

@@ -1,6 +1,7 @@
 # coding: utf-8
 import django_tables2 as tables
-from .models import Country
+
+from .models import Country, Person
 
 
 class CountryTable(tables.Table):
@@ -17,3 +18,9 @@ class Meta:
 class ThemedCountryTable(CountryTable):
     class Meta:
         attrs = {'class': 'paleblue'}
+
+
+class BootstrapTable(tables.Table):
+    class Meta:
+        model = Person
+        template = 'django_tables2/bootstrap.html'

example/app/views.py

@@ -4,7 +4,13 @@
 from django_tables2 import RequestConfig, SingleTableView
 
 from .models import Country, Person
-from .tables import CountryTable, ThemedCountryTable
+from .tables import BootstrapTable, CountryTable, ThemedCountryTable
+
+try:
+    from django.utils.lorem_ipsum import words
+except ImportError:
+    # django 1.7 has lorem_ipsum in contrib.webdisign, moved in 1.8
+    from django.contrib.webdesign.lorem_ipsum import words
 
 
 def multiple(request):
@@ -35,6 +41,20 @@ def multiple(request):
     })
 
 
+def bootstrap(request):
+    '''Demonstrate the use of the bootstrap template'''
+    # create some fake data to make sure we need to paginate
+    if Person.objects.all().count() < 50:
+        Person.objects.create_bulk([Person(name=words(3, common=False)) for i in range(50)])
+
+    table = BootstrapTable(Person.objects.all())
+    RequestConfig(request, paginate={"per_page": 10}).configure(table)
+
+    return render(request, 'bootstrap_template.html', {
+        'table': table
+    })
+
+
 class ClassBased(SingleTableView):
     table_class = ThemedCountryTable
     queryset = Country.objects.all()

example/settings.py

@@ -1,6 +1,4 @@
 # coding: utf-8
-# import django_tables2
-import sys
 from os.path import abspath, dirname, join
 
 from django import VERSION
@@ -97,6 +95,7 @@
     )
 
     TEMPLATE_CONTEXT_PROCESSORS = [
+        'django.contrib.auth.context_processors.auth',
         'django.core.context_processors.static',
         'django.core.context_processors.request'
     ]

example/templates/bootstrap_template.html

@@ -0,0 +1,22 @@
+{% load render_table from django_tables2 %}
+<!doctype html>
+<html>
+<head>
+    <title>django_tables2 with bootstrap template example</title>
+
+    <link href="https://maxcdn.bootstrapcdn.com/bootstrap/3.3.6/css/bootstrap.min.css" rel="stylesheet" />
+    <link href="{{ STATIC_URL }}django_tables2/bootstrap.css" rel="stylesheet" />
+</head>
+<body>
+    <div class="container">
+
+        <h3>django_tables2 with bootstrap template example</h3>
+
+        <div class="row">
+            <div class="col-sm-10">
+                {% render_table table %}
+            </div>
+        </div>
+    </div>
+</body>
+</html>

example/urls.py

@@ -4,14 +4,15 @@
 from django.contrib import admin
 from django.views import static
 
-from app.views import class_based, multiple, tutorial
+from app.views import bootstrap, class_based, multiple, tutorial
 
 admin.autodiscover()
 
 urlpatterns = [
     url(r'^$', multiple),
     url(r'^class-based/$', class_based),
     url(r'^tutorial/$', tutorial),
+    url(r'^bootstrap/$', bootstrap),
 
     url(r'^admin/doc/', include('django.contrib.admindocs.urls')),
     url(r'^admin/', include(admin.site.urls)),

tests/app/models.py

@@ -10,12 +10,11 @@
 
 try:
     # Django >= 1.7
-    from django.contrib.contenttypes.fields import (GenericForeignKey,
-                                                    GenericRelation)
+    from django.contrib.contenttypes.fields import GenericForeignKey
+
 except ImportError:
     # Django < 1.7, TODO: remove if we drop support for 1.7
-    from django.contrib.contenttypes.generic import (GenericForeignKey,
-                                                     GenericRelation)
+    from django.contrib.contenttypes.generic import GenericForeignKey
 
 
 class Person(models.Model):

tests/app/settings.py

@@ -1,5 +1,3 @@
-import os
-
 import six
 from django import VERSION
 from django.conf import global_settings

tests/columns/test_checkboxcolumn.py

@@ -4,7 +4,7 @@
 
 import django_tables2 as tables
 
-from ..utils import attrs, warns
+from ..utils import attrs
 
 
 def test_new_attrs_should_be_supported():

tests/columns/test_general.py

@@ -9,7 +9,7 @@
 import django_tables2 as tables
 
 from ..app.models import Person
-from ..utils import build_request, parse, warns
+from ..utils import build_request, parse
 
 request = build_request('/')
 

tests/test_core.py

@@ -12,7 +12,7 @@
 import django_tables2 as tables
 from django_tables2.tables import DeclarativeColumnsMetaclass
 
-from .utils import build_request, warns
+from .utils import build_request
 
 request = build_request('/')