Adds support for python >= 3.2. Version bumped

Author: GermanoGuerrini

.gitignore

@@ -52,3 +52,6 @@ docs/_build/
 
 # PyBuilder
 target/
+
+# Pyenv
+.python-version

.travis.yml

@@ -1,13 +1,24 @@
 language: python
 
 install:
-  - pip install tox 
+  - pip install tox
 
 script:
   - tox
 
 env:
-  - TOXENV=django_1.5.X
-  - TOXENV=django_1.6.X
-  - TOXENV=django_1.7.X
+  - TOXENV=py26-django15
+  - TOXENV=py26-django16
+  - TOXENV=py27-django15
+  - TOXENV=py27-django16
+  - TOXENV=py32-django15
+  - TOXENV=py32-django16
+  - TOXENV=py33-django15
+  - TOXENV=py33-django16
+  - TOXENV=py34-django15
+  - TOXENV=py34-django16
+  - TOXENV=py27-django17
+  - TOXENV=py32-django17
+  - TOXENV=py33-django17
+  - TOXENV=py34-django17
   - TOXENV=coverage

LICENSE

@@ -16,4 +16,4 @@ FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
 AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
 LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
 OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
-THE SOFTWARE.
+THE SOFTWARE.

README.md

@@ -6,4 +6,4 @@ Django Bricks
 
 A Django application that sorts lists of heterogeneous models.
 
-Documentation can be found at: http://django-bricks.readthedocs.org/en/latest/
+Documentation can be found at: http://django-bricks.readthedocs.org/en/latest/

djangobricks/__init__.py

@@ -2,9 +2,9 @@
 When you need a wall.
 """
 
-VERSION = (1, 0, 0)
+VERSION = (1, 1, 0)
 
 
 def get_version():
     """Returns the version as a string."""
-    return '.'.join(map(str, VERSION))
+    return '.'.join(map(str, VERSION))

djangobricks/exceptions.py

@@ -1,3 +1,3 @@
 class BricksException(Exception): pass
 
-class TemplateNameNotFound(BricksException): pass
+class TemplateNameNotFound(BricksException): pass

djangobricks/models.py

@@ -1,7 +1,16 @@
+from __future__ import unicode_literals
+
 import copy
 from operator import attrgetter
 from itertools import chain
 
+from django.utils import six
+from django.utils.six.moves import range
+
+if six.PY3:
+    def cmp(a, b):
+        return (a > b) - (a < b)
+
 SORTING_ASC = 1
 SORTING_DESC = -1
 
@@ -140,7 +149,7 @@ def get_bricks_for_queryset(cls, queryset):
         # Execute the query once to avoid several OFFSET LIMIT
         items = list(queryset)
         return [cls(i) for i in (items[i:i+cls.chunk_size]
-                                 for i in xrange(0, count, cls.chunk_size))]
+                                 for i in range(0, count, cls.chunk_size))]
 
     def get_context(self, **kwargs):
         """
@@ -161,7 +170,7 @@ class BaseWall(object):
 
     It orders a list of bricks using the given criteria and can be sliced or
     iterated.
-    
+
     :param bricks: the list of bricks to sort.
     :param criteria: the list of criteria to sort the bricks by.
     """
@@ -185,7 +194,7 @@ def __getstate__(self):
         # as those might not be pickable
         obj_dict = self.__dict__.copy()
         obj_dict['_sorted'] = self.sorted
-        if obj_dict.has_key('criteria'):
+        if 'criteria' in obj_dict:
             del obj_dict['criteria']
         return obj_dict
 
@@ -208,7 +217,13 @@ def sorted(self):
         Lazy property that returns the list of bricks sorted by the criteria.
         """
         if not self._sorted:
-            self._sorted = sorted(self.bricks, cmp=self._cmp)
+            try:
+                # Python > 2.6
+                from functools import cmp_to_key
+                self._sorted = sorted(self.bricks, key=cmp_to_key(self._cmp))
+            except ImportError:
+                # Python <= 2.6
+                self._sorted = sorted(self.bricks, cmp=self._cmp)
         return self._sorted
 
     def filter(self, callback, operator='AND'):
@@ -282,8 +297,8 @@ def content_iterator():
             # Do some sanity check just to help the user
             for brick, queryset in self.get_content():
                 if not issubclass(brick, BaseBrick):
-                    raise TypeError(u"Expected a BaseBrick subclass, "
-                                     "got %r instead" % brick)
+                    raise TypeError("Expected a BaseBrick subclass, "
+                                    "got %r instead" % brick)
                 yield brick, queryset
 
         bricks = (b.get_bricks_for_queryset(qs) for b, qs in content_iterator())
@@ -307,4 +322,4 @@ def get_content():
     factory = BaseWallFactory(criteria, wall_class)
     # Monkey patch the factory instance
     factory.get_content = get_content
-    return factory.wall()
+    return factory.wall()

djangobricks/templatetags/bricks.py

@@ -1,7 +1,9 @@
+from __future__ import unicode_literals
+
 from django import template
 from django.template.loader import render_to_string
 
-from ..exceptions import TemplateNameNotFound
+from djangobricks.exceptions import TemplateNameNotFound
 
 register = template.Library()
 
@@ -16,8 +18,8 @@ def render_brick(context, brick, **extra_context):
     to the brick.
     """
     if brick.template_name is None:
-        raise TemplateNameNotFound(u'%r does not define '
-                                    'any template name.' % brick.__class__)
+        raise TemplateNameNotFound('%r does not define '
+                                   'any template name.' % brick.__class__)
 
     request = context.get('request')
 

djangobricks/tests.py

@@ -1,12 +1,16 @@
+from __future__ import unicode_literals
+
 import datetime
 import os
 
 from django import get_version
-from django.utils import unittest
-from django.test import SimpleTestCase
-from django.test.utils import override_settings
 from django.db import models
 from django.template import Template, Context
+from django.test import SimpleTestCase
+from django.test.utils import override_settings
+from django.utils import unittest
+from django.utils.encoding import python_2_unicode_compatible
+from django.utils.six.moves import range
 
 from .models import (
     SingleBrick,
@@ -18,7 +22,7 @@
     BaseWallFactory,
     wall_factory,
 )
-from .exceptions import TemplateNameNotFound
+from djangobricks.exceptions import TemplateNameNotFound
 
 CURRENT_DIR = os.path.abspath(os.path.dirname(__file__))
 
@@ -51,40 +55,43 @@ class NotABrick(object): pass
 class TestBrickWall(BaseWall): pass
 
 
+@python_2_unicode_compatible
 class TestModelA(models.Model):
     name = models.CharField(max_length=8)
     popularity = models.PositiveIntegerField()
     pub_date = models.DateTimeField()
     is_sticky = models.BooleanField(default=False)
 
-    def __unicode__(self):
-        return unicode(self.name)
+    def __str__(self):
+        return self.name
 
     def callable_popularity(self):
         return self.popularity
 
 
+@python_2_unicode_compatible
 class TestModelB(models.Model):
     name = models.CharField(max_length=8)
     date_add = models.DateTimeField()
     popularity = models.PositiveIntegerField()
     is_sticky = models.BooleanField(default=False)
 
-    def __unicode__(self):
-        return unicode(self.name)
+    def __str__(self):
+        return self.name
 
     def pub_date(self):
         return self.date_add
 
 
+@python_2_unicode_compatible
 class TestModelC(models.Model):
     name = models.CharField(max_length=8)
     pub_date = models.DateTimeField()
     popularity = models.PositiveIntegerField()
     is_sticky = models.BooleanField(default=False)
 
-    def __unicode__(self):
-        return unicode(self.name)
+    def __str__(self):
+        return self.name
 
 
 class TestWallFactory(BaseWallFactory):
@@ -131,7 +138,7 @@ def _create_model_a_objects_and_bricks(self):
             pub_date=datetime.datetime(2012, 1, 1, 12, 0), is_sticky=True)
         objectA4 = TestModelA.objects.create(name='objectA4', popularity=2,
             pub_date=datetime.datetime(2013, 1, 1, 12, 0), is_sticky=False)
-    
+
         self.brickA1 = SingleBrick(objectA1)
         self.brickA2 = SingleBrick(objectA2)
         self.brickA3 = SingleBrick(objectA3)
@@ -148,7 +155,7 @@ def _create_model_b_objects_and_bricks(self):
             date_add=datetime.datetime(2008, 1, 1, 12, 0), is_sticky=True)
         objectB4 = TestModelB.objects.create(name='objectB4', popularity=7,
             date_add=datetime.datetime(2009, 1, 1, 12, 0), is_sticky=False)
-    
+
         self.brickB1 = SingleBrick(objectB1)
         self.brickB2 = SingleBrick(objectB2)
         self.brickB3 = SingleBrick(objectB3)
@@ -165,7 +172,7 @@ def _create_model_c_objects_and_bricks(self):
             pub_date=datetime.datetime(2004, 1, 1, 12, 0), is_sticky=True)
         objectC4 = TestModelC.objects.create(name='objectC4', popularity=17,
             pub_date=datetime.datetime(2005, 1, 1, 12, 0), is_sticky=False)
-    
+
         self.brickC1 = ListBrick([objectC1, objectC2])
         self.brickC2 = ListBrick([objectC3, objectC4])
         for i in range(1, 3):
@@ -203,7 +210,7 @@ def test_single_brick_init(self):
             pub_date=datetime.datetime(2012, 1, 1, 12, 0), is_sticky=True)
         objectA4 = TestModelA.objects.create(name='objectA4', popularity=2,
             pub_date=datetime.datetime(2013, 1, 1, 12, 0), is_sticky=False)
-    
+
         bricks = SingleBrick.get_bricks_for_queryset(TestModelA.objects.all())
         wall = TestBrickWall(bricks)
         self.assertEqual(wall[0].item, objectA1)
@@ -220,7 +227,7 @@ def test_list_brick_init(self):
             pub_date=datetime.datetime(2012, 1, 1, 12, 0), is_sticky=True)
         objectA4 = TestModelA.objects.create(name='objectA4', popularity=2,
             pub_date=datetime.datetime(2013, 1, 1, 12, 0), is_sticky=False)
-    
+
         bricks = ListBrick.get_bricks_for_queryset(TestModelA.objects.all())
         wall = TestBrickWall(bricks)
         self.assertEqual(wall[0].items, [objectA1, objectA2, objectA3, objectA4])
@@ -558,11 +565,11 @@ def test_list_brick_context(self):
     def test_list_brick_chunk(self):
         now = datetime.datetime.now()
         objects = []
-        for i in xrange(12):
+        for i in range(12):
             obj = TestModelC.objects.create(name=i, popularity=i, pub_date=now)
             objects.append(obj)
         bricks = TestListBrick.get_bricks_for_queryset(TestModelC.objects.all())
-        for i in xrange(3):
+        for i in range(3):
             start = i * TestListBrick.chunk_size
             stop = start + TestListBrick.chunk_size
             self.assertEqual(bricks[i].items, objects[start:stop])
@@ -748,4 +755,4 @@ def test_factory_method_multiple_queryset(self):
         expected = [self.brickB1.item, self.brickB2.item, self.brickB4.item,
                     self.brickA1.item, self.brickA2.item, self.brickA4.item,
                     self.brickB3.item, self.brickA3.item]
-        self.assertEqual([b.item for b in wall], expected)
+        self.assertEqual([b.item for b in wall], expected)

docs/advanced_usage.rst

@@ -122,7 +122,7 @@ content. So let's write a brick class for our new model:
         def get_value_for_criterion(self, criterion):
             if criterion.attrname == 'pub_date':
                 return self.item.public_from_date
-            return super(PhotoGalleryBrick, self).get_value_for_criterion(criterion) 
+            return super(PhotoGalleryBrick, self).get_value_for_criterion(criterion)
 
 And that's it! Unless you are sure to cover each possible criterion, it's a good
 practice to return the value from super at least, as shown above.
@@ -154,4 +154,4 @@ or you can add them using directly the templatetag
 
 .. code-block:: html+django
 
-    {% render_brick brick color='red' %}
+    {% render_brick brick color='red' %}

docs/api.rst

@@ -37,4 +37,4 @@ Utilities
 .. >>>>>>>>>>>>
 .. .. automodule:: djangobricks.templatetags.bricks
 ..
-.. .. autofunction:: render_brick
+.. .. autofunction:: render_brick

docs/changelog.rst

@@ -0,0 +1,12 @@
+=========
+Changelog
+=========
+
+Version 1.1
+===========
+* Added support for Python >= 3.2
+* Minor documentation fixes
+
+Version 1.0
+===========
+* First version

docs/index.rst

@@ -18,7 +18,17 @@ tricky.
 The :doc:`usage` will guide you through a complete tutorial to explain the
 concepts behind Bricks and to show how simple can be to achieve that goal.
 
-Contents:
+Requirements
+------------
+
+========  ======
+Python 2  >= 2.6
+Python 3  >= 3.2
+Django    >= 1.5
+========  ======
+
+Contents
+--------
 
 .. toctree::
    :maxdepth: 2
@@ -27,10 +37,10 @@ Contents:
    usage
    advanced_usage
    api
+   changelog
 
 Indices and tables
 ==================
 
 * :ref:`genindex`
 * :ref:`search`
-