Rename to linaro-django-pagination.
authorZygmunt Krynicki <zygmunt.krynicki@linaro.org>
Mon, 13 Jun 2011 11:29:09 +0000 (13:29 +0200)
committerZygmunt Krynicki <zygmunt.krynicki@linaro.org>
Mon, 13 Jun 2011 11:29:09 +0000 (13:29 +0200)
The import package changed from 'pagination' to 'linaro_django_pagination'.
The project name changed to 'linaro-django-pagination'

30 files changed:
docs/index.txt
docs/install.txt
docs/usage.txt
linaro_django_pagination/__init__.py [new file with mode: 0644]
linaro_django_pagination/locale/de/LC_MESSAGES/django.po [new file with mode: 0644]
linaro_django_pagination/locale/fr/LC_MESSAGES/django.po [new file with mode: 0644]
linaro_django_pagination/locale/pl/LC_MESSAGES/django.po [new file with mode: 0644]
linaro_django_pagination/locale/pt/LC_MESSAGES/django.po [new file with mode: 0644]
linaro_django_pagination/middleware.py [new file with mode: 0644]
linaro_django_pagination/models.py [new file with mode: 0644]
linaro_django_pagination/paginator.py [new file with mode: 0644]
linaro_django_pagination/templates/pagination/pagination.html [new file with mode: 0644]
linaro_django_pagination/templatetags/__init__.py [new file with mode: 0644]
linaro_django_pagination/templatetags/pagination_tags.py [new file with mode: 0644]
linaro_django_pagination/tests.py [new file with mode: 0644]
pagination/__init__.py [deleted file]
pagination/locale/de/LC_MESSAGES/django.po [deleted file]
pagination/locale/fr/LC_MESSAGES/django.po [deleted file]
pagination/locale/pl/LC_MESSAGES/django.po [deleted file]
pagination/locale/pt/LC_MESSAGES/django.po [deleted file]
pagination/middleware.py [deleted file]
pagination/models.py [deleted file]
pagination/paginator.py [deleted file]
pagination/templates/pagination/pagination.html [deleted file]
pagination/templatetags/__init__.py [deleted file]
pagination/templatetags/pagination_tags.py [deleted file]
pagination/tests.py [deleted file]
setup.py [changed mode: 0644->0755]
tests/runtests.py
tests/settings.py

index e40b22d..b9dbafe 100644 (file)
@@ -1,5 +1,5 @@
 #################
-django-pagination
+linaro-django-pagination
 #################
 
 Django-pagination is a set of utilities for creating robust pagination tools 
index d178755..f70d4d3 100644 (file)
@@ -1,10 +1,10 @@
-Installing the latest development version of django-pagination
+Installing the latest development version of linaro-linaro-django-pagination
 ---------------------------------------------------------------
 
 To install, first check out the latest version of the application from
 subversion:
 
-    svn co http://django-pagination.googlecode.com/svn/trunk django-pagination
+    svn co http://linaro-django-pagination.googlecode.com/svn/trunk linaro-django-pagination
 
 Now, link the inner ``pagination`` project to your Python path:
 
@@ -27,14 +27,14 @@ following command:
 
     sudo python setup.py install
 
-Once that's done, you should be able to begin using django-pagination at will.
+Once that's done, you should be able to begin using linaro-django-pagination at will.
 
 Installing via setuptools
 -------------------------
 
 If you have setuptools_ installed, you can simply run the following command
-to install django-pagination:
+to install linaro-django-pagination:
 
-    sudo easy_install django-pagination
+    sudo easy_install linaro-django-pagination
 
-.. _setuptools: http://peak.telecommunity.com/DevCenter/setuptools
\ No newline at end of file
+.. _setuptools: http://peak.telecommunity.com/DevCenter/setuptools
index b520169..bb819b5 100644 (file)
@@ -1,7 +1,7 @@
-How to use django-pagination
+How to use linaro-django-pagination
 ----------------------------
 
-``django-pagination`` allows for easy Digg-style pagination without modifying
+``linaro-django-pagination`` allows for easy Digg-style pagination without modifying
 your views.
 
 There are really 5 steps to setting it up with your projects (not including 
@@ -73,7 +73,7 @@ a way to navigate between the different pages--all without touching your views.
 A Note About Uploads
 --------------------
 
-It is important, when using django-pagination in conjunction with file uploads,
+It is important, when using linaro-django-pagination in conjunction with file uploads,
 to be aware of when ``request.page`` is accessed.  As soon as ``request.page``
 is accessed, ``request.upload_handlers`` is frozen and cannot be altered in any
 way.  It's a good idea to access the ``page`` attribute on the request object 
@@ -83,7 +83,7 @@ as late as possible in your views.
 Optional Settings
 ------------------
 
-In django-pagination, there are no required settings.  There are, however, a
+In linaro-django-pagination, there are no required settings.  There are, however, a
 small set of optional settings useful for changing the default behavior of the
 pagination tags.  Here's an overview:
 
diff --git a/linaro_django_pagination/__init__.py b/linaro_django_pagination/__init__.py
new file mode 100644 (file)
index 0000000..8b13789
--- /dev/null
@@ -0,0 +1 @@
+
diff --git a/linaro_django_pagination/locale/de/LC_MESSAGES/django.po b/linaro_django_pagination/locale/de/LC_MESSAGES/django.po
new file mode 100644 (file)
index 0000000..ff9872a
--- /dev/null
@@ -0,0 +1,27 @@
+# SOME DESCRIPTIVE TITLE.
+# Copyright (C) YEAR THE PACKAGE'S COPYRIGHT HOLDER
+# This file is distributed under the same license as the PACKAGE package.
+# FIRST AUTHOR <EMAIL@ADDRESS>, YEAR.
+#
+#, fuzzy
+msgid ""
+msgstr ""
+"Project-Id-Version: PACKAGE VERSION\n"
+"Report-Msgid-Bugs-To: \n"
+"POT-Creation-Date: 2009-03-16 16:26+0100\n"
+"PO-Revision-Date: YEAR-MO-DA HO:MI+ZONE\n"
+"Last-Translator: FULL NAME <EMAIL@ADDRESS>\n"
+"Language-Team: LANGUAGE <LL@li.org>\n"
+"MIME-Version: 1.0\n"
+"Content-Type: text/plain; charset=UTF-8\n"
+"Content-Transfer-Encoding: 8bit\n"
+
+#: templates/pagination/pagination.html:5
+#: templates/pagination/pagination.html:7
+msgid "previous"
+msgstr "Zurück"
+
+#: templates/pagination/pagination.html:21
+#: templates/pagination/pagination.html:23
+msgid "next"
+msgstr "Weiter"
diff --git a/linaro_django_pagination/locale/fr/LC_MESSAGES/django.po b/linaro_django_pagination/locale/fr/LC_MESSAGES/django.po
new file mode 100644 (file)
index 0000000..2ec8e65
--- /dev/null
@@ -0,0 +1,26 @@
+# linaro-django-pagination French translation.
+# Copyright (C) 2008, Julien Demoor
+# This file is distributed under the same license as the linaro-django-pagination package.
+# Julien Demoor <julien@jdemoor.com>, 2008
+#
+msgid ""
+msgstr ""
+"Project-Id-Version: PACKAGE VERSION\n"
+"Report-Msgid-Bugs-To: \n"
+"POT-Creation-Date: 2008-10-24 00:41-0700\n"
+"PO-Revision-Date: 2008-10-19 10:19+0200\n"
+"Last-Translator: Julien Demoor <julien@jdemoor.com>\n"
+"Language-Team: LANGUAGE <LL@li.org>\n"
+"MIME-Version: 1.0\n"
+"Content-Type: text/plain; charset=UTF-8\n"
+"Content-Transfer-Encoding: 8bit\n"
+
+#: templates/pagination/pagination.html:5
+#: templates/pagination/pagination.html:7
+msgid "previous"
+msgstr "précédente"
+
+#: templates/pagination/pagination.html:21
+#: templates/pagination/pagination.html:23
+msgid "next"
+msgstr "suivante"
diff --git a/linaro_django_pagination/locale/pl/LC_MESSAGES/django.po b/linaro_django_pagination/locale/pl/LC_MESSAGES/django.po
new file mode 100644 (file)
index 0000000..f6db3a8
--- /dev/null
@@ -0,0 +1,27 @@
+# Polish translation of linaro-django-pagination.
+# Copyright (C) 2008, linaro-django-pagination team
+# This file is distributed under the same license as the linaro-django-pagination package.
+# Jarek Zgoda <jarek.zgoda@gmail.com>, 2008.
+#
+#, fuzzy
+msgid ""
+msgstr ""
+"Project-Id-Version: 1.0\n"
+"Report-Msgid-Bugs-To: \n"
+"POT-Creation-Date: 2008-10-24 00:41-0700\n"
+"PO-Revision-Date: 2008-10-20 20:52+0200\n"
+"Last-Translator: Jarek Zgoda <jarek.zgoda@gmail.com>\n"
+"Language-Team: PL <pl@li.org>\n"
+"MIME-Version: 1.0\n"
+"Content-Type: text/plain; charset=UTF-8\n"
+"Content-Transfer-Encoding: 8bit\n"
+
+#: templates/pagination/pagination.html:5
+#: templates/pagination/pagination.html:7
+msgid "previous"
+msgstr "poprzednia"
+
+#: templates/pagination/pagination.html:21
+#: templates/pagination/pagination.html:23
+msgid "next"
+msgstr "następna"
diff --git a/linaro_django_pagination/locale/pt/LC_MESSAGES/django.po b/linaro_django_pagination/locale/pt/LC_MESSAGES/django.po
new file mode 100644 (file)
index 0000000..6b8e37b
--- /dev/null
@@ -0,0 +1,26 @@
+# linaro-django-pagination Portuguese translation.
+# Copyright (C) 2008, Alcides Fonseca
+# http://alcidesfonseca.com
+# This file is distributed under the WTFPL
+#
+msgid ""
+msgstr ""
+"Project-Id-Version: PACKAGE VERSION\n"
+"Report-Msgid-Bugs-To: \n"
+"POT-Creation-Date: 2008-10-24 00:41-0700\n"
+"PO-Revision-Date: 2008-10-19 10:19+0200\n"
+"Last-Translator: Alcides Fonseca <me@alcidesfonseca.com>\n"
+"Language-Team: LANGUAGE <LL@li.org>\n"
+"MIME-Version: 1.0\n"
+"Content-Type: text/plain; charset=UTF-8\n"
+"Content-Transfer-Encoding: 8bit\n"
+
+#: templates/pagination/pagination.html:5
+#: templates/pagination/pagination.html:7
+msgid "previous"
+msgstr "anterior"
+
+#: templates/pagination/pagination.html:21
+#: templates/pagination/pagination.html:23
+msgid "next"
+msgstr "próximo"
diff --git a/linaro_django_pagination/middleware.py b/linaro_django_pagination/middleware.py
new file mode 100644 (file)
index 0000000..f8a2a6f
--- /dev/null
@@ -0,0 +1,17 @@
+def get_page(self):
+    """
+    A function which will be monkeypatched onto the request to get the current
+    integer representing the current page.
+    """
+    try:
+        return int(self.REQUEST['page'])
+    except (KeyError, ValueError, TypeError):
+        return 1
+
+class PaginationMiddleware(object):
+    """
+    Inserts a variable representing the current page onto the request object if
+    it exists in either **GET** or **POST** portions of the request.
+    """
+    def process_request(self, request):
+        request.__class__.page = property(get_page)
\ No newline at end of file
diff --git a/linaro_django_pagination/models.py b/linaro_django_pagination/models.py
new file mode 100644 (file)
index 0000000..8b13789
--- /dev/null
@@ -0,0 +1 @@
+
diff --git a/linaro_django_pagination/paginator.py b/linaro_django_pagination/paginator.py
new file mode 100644 (file)
index 0000000..f67aa23
--- /dev/null
@@ -0,0 +1,171 @@
+from django.core.paginator import Paginator, Page, PageNotAnInteger, EmptyPage
+
+class InfinitePaginator(Paginator):
+    """
+    Paginator designed for cases when it's not important to know how many total
+    pages.  This is useful for any object_list that has no count() method or can
+    be used to improve performance for MySQL by removing counts.
+
+    The orphans parameter has been removed for simplicity and there's a link
+    template string for creating the links to the next and previous pages.
+    """
+
+    def __init__(self, object_list, per_page, allow_empty_first_page=True,
+        link_template='/page/%d/'):
+        orphans = 0 # no orphans
+        super(InfinitePaginator, self).__init__(object_list, per_page, orphans,
+            allow_empty_first_page)
+        # no count or num pages
+        del self._num_pages, self._count
+        # bonus links
+        self.link_template = link_template
+
+    def validate_number(self, number):
+        """
+        Validates the given 1-based page number.
+        """
+        try:
+            number = int(number)
+        except ValueError:
+            raise PageNotAnInteger('That page number is not an integer')
+        if number < 1:
+            raise EmptyPage('That page number is less than 1')
+        return number
+
+    def page(self, number):
+        """
+        Returns a Page object for the given 1-based page number.
+        """
+        number = self.validate_number(number)
+        bottom = (number - 1) * self.per_page
+        top = bottom + self.per_page
+        page_items = self.object_list[bottom:top]
+        # check moved from validate_number
+        if not page_items:
+            if number == 1 and self.allow_empty_first_page:
+                pass
+            else:
+                raise EmptyPage('That page contains no results')
+        return InfinitePage(page_items, number, self)
+
+    def _get_count(self):
+        """
+        Returns the total number of objects, across all pages.
+        """
+        raise NotImplementedError
+    count = property(_get_count)
+
+    def _get_num_pages(self):
+        """
+        Returns the total number of pages.
+        """
+        raise NotImplementedError
+    num_pages = property(_get_num_pages)
+
+    def _get_page_range(self):
+        """
+        Returns a 1-based range of pages for iterating through within
+        a template for loop.
+        """
+        raise NotImplementedError
+    page_range = property(_get_page_range)
+
+
+class InfinitePage(Page):
+
+    def __repr__(self):
+        return '<Page %s>' % self.number
+
+    def has_next(self):
+        """
+        Checks for one more item than last on this page.
+        """
+        try:
+            next_item = self.paginator.object_list[
+                self.number * self.paginator.per_page]
+        except IndexError:
+            return False
+        return True
+
+    def end_index(self):
+        """
+        Returns the 1-based index of the last object on this page,
+        relative to total objects found (hits).
+        """
+        return ((self.number - 1) * self.paginator.per_page +
+            len(self.object_list))
+
+    #Bonus methods for creating links
+
+    def next_link(self):
+        if self.has_next():
+            return self.paginator.link_template % (self.number + 1)
+        return None
+
+    def previous_link(self):
+        if self.has_previous():
+            return self.paginator.link_template % (self.number - 1)
+        return None
+
+class FinitePaginator(InfinitePaginator):
+    """
+    Paginator for cases when the list of items is already finite.
+
+    A good example is a list generated from an API call. This is a subclass
+    of InfinitePaginator because we have no idea how many items exist in the
+    full collection.
+
+    To accurately determine if the next page exists, a FinitePaginator MUST be
+    created with an object_list_plus that may contain more items than the
+    per_page count.  Typically, you'll have an object_list_plus with one extra
+    item (if there's a next page).  You'll also need to supply the offset from
+    the full collection in order to get the page start_index.
+
+    This is a very silly class but useful if you love the Django pagination
+    conventions.
+    """
+
+    def __init__(self, object_list_plus, per_page, offset=None,
+        allow_empty_first_page=True, link_template='/page/%d/'):
+        super(FinitePaginator, self).__init__(object_list_plus, per_page,
+            allow_empty_first_page, link_template)
+        self.offset = offset
+
+    def validate_number(self, number):
+        super(FinitePaginator, self).validate_number(number)
+        # check for an empty list to see if the page exists
+        if not self.object_list:
+            if number == 1 and self.allow_empty_first_page:
+                pass
+            else:
+                raise EmptyPage('That page contains no results')
+        return number
+
+    def page(self, number):
+        """
+        Returns a Page object for the given 1-based page number.
+        """
+        number = self.validate_number(number)
+        # remove the extra item(s) when creating the page
+        page_items = self.object_list[:self.per_page]
+        return FinitePage(page_items, number, self)
+
+class FinitePage(InfinitePage):
+
+    def has_next(self):
+        """
+        Checks for one more item than last on this page.
+        """
+        try:
+            next_item = self.paginator.object_list[self.paginator.per_page]
+        except IndexError:
+            return False
+        return True
+
+    def start_index(self):
+        """
+        Returns the 1-based index of the first object on this page,
+        relative to total objects in the paginator.
+        """
+        ## TODO should this holler if you haven't defined the offset?
+        return self.paginator.offset
\ No newline at end of file
diff --git a/linaro_django_pagination/templates/pagination/pagination.html b/linaro_django_pagination/templates/pagination/pagination.html
new file mode 100644 (file)
index 0000000..fe566a8
--- /dev/null
@@ -0,0 +1,26 @@
+{% if is_paginated %}
+{% load i18n %}
+<div class="pagination">
+    {% if page_obj.has_previous %}
+        <a href="?page={{ page_obj.previous_page_number }}{{ getvars }}{{ hashtag }}" class="prev">&lsaquo;&lsaquo; {% trans "previous" %}</a>
+    {% else %}
+        <span class="disabled prev">&lsaquo;&lsaquo; {% trans "previous" %}</span>
+    {% endif %}
+    {% for page in pages %}
+        {% if page %}
+            {% ifequal page page_obj.number %}
+                <span class="current page">{{ page }}</span>
+            {% else %}
+                <a href="?page={{ page }}{{ getvars }}{{ hashtag }}" class="page">{{ page }}</a>
+            {% endifequal %}
+        {% else %}
+            ...
+        {% endif %}
+    {% endfor %}
+    {% if page_obj.has_next %}
+        <a href="?page={{ page_obj.next_page_number }}{{ getvars }}{{ hashtag }}" class="next">{% trans "next" %} &rsaquo;&rsaquo;</a>
+    {% else %}
+        <span class="disabled next">{% trans "next" %} &rsaquo;&rsaquo;</span>
+    {% endif %}
+</div>
+{% endif %}
diff --git a/linaro_django_pagination/templatetags/__init__.py b/linaro_django_pagination/templatetags/__init__.py
new file mode 100644 (file)
index 0000000..8b13789
--- /dev/null
@@ -0,0 +1 @@
+
diff --git a/linaro_django_pagination/templatetags/pagination_tags.py b/linaro_django_pagination/templatetags/pagination_tags.py
new file mode 100644 (file)
index 0000000..ab87ed4
--- /dev/null
@@ -0,0 +1,250 @@
+try:
+    set
+except NameError:
+    from sets import Set as set
+
+from django import template
+from django.http import Http404
+from django.core.paginator import Paginator, InvalidPage
+from django.conf import settings
+
+register = template.Library()
+
+DEFAULT_PAGINATION = getattr(settings, 'PAGINATION_DEFAULT_PAGINATION', 20)
+DEFAULT_WINDOW = getattr(settings, 'PAGINATION_DEFAULT_WINDOW', 4)
+DEFAULT_ORPHANS = getattr(settings, 'PAGINATION_DEFAULT_ORPHANS', 0)
+INVALID_PAGE_RAISES_404 = getattr(settings,
+    'PAGINATION_INVALID_PAGE_RAISES_404', False)
+
+def do_autopaginate(parser, token):
+    """
+    Splits the arguments to the autopaginate tag and formats them correctly.
+
+    Syntax is:
+
+        autopaginate SOMETHING [PAGINATE_BY] [ORPHANS] [as NAME]
+    """
+    i = iter(token.split_contents())
+    paginate_by = None
+    queryset_var = None
+    context_var = None
+    orphans = None
+    word = None
+    try:
+        word = i.next()
+        assert word == "autopaginate"
+        queryset_var = i.next()
+        word = i.next()
+        if word != "as":
+            paginate_by = word
+            try:
+                paginate_by = int(paginate_by)
+            except ValueError:
+                pass
+            word = i.next()
+        if word != "as":
+            orphans = word
+            try:
+                orphans = int(orphans)
+            except ValueError:
+                pass
+            word = i.next()
+        assert word == "as"
+        context_var = i.next()
+    except StopIteration:
+        pass
+    if queryset_var is None:
+        raise template.TemplateSyntaxError(
+            "Invalid syntax. Proper usage of this tag is: "
+            "{%% autopaginate QUERYSET [PAGINATE_BY] [ORPHANS]"
+            " [as CONTEXT_VAR_NAME] %%}"
+        )
+    return AutoPaginateNode(queryset_var, paginate_by, orphans, context_var)
+
+class AutoPaginateNode(template.Node):
+    """
+    Emits the required objects to allow for Digg-style pagination.
+    
+    First, it looks in the current context for the variable specified, and using
+    that object, it emits a simple ``Paginator`` and the current page object 
+    into the context names ``paginator`` and ``page_obj``, respectively.
+    
+    It will then replace the variable specified with only the objects for the
+    current page.
+    
+    .. note::
+        
+        It is recommended to use *{% paginate %}* after using the autopaginate
+        tag.  If you choose not to use *{% paginate %}*, make sure to display the
+        list of available pages, or else the application may seem to be buggy.
+    """
+    def __init__(self, queryset_var, paginate_by=None,
+        orphans=None, context_var=None):
+        if paginate_by is None:
+            paginate_by = DEFAULT_PAGINATION
+        if orphans is None:
+            orphans = DEFAULT_ORPHANS
+        self.queryset_var = template.Variable(queryset_var)
+        if isinstance(paginate_by, int):
+            self.paginate_by = paginate_by
+        else:
+            self.paginate_by = template.Variable(paginate_by)
+        if isinstance(orphans, int):
+            self.orphans = orphans
+        else:
+            self.orphans = template.Variable(orphans)
+        self.context_var = context_var
+
+    def render(self, context):
+        key = self.queryset_var.var
+        value = self.queryset_var.resolve(context)
+        if isinstance(self.paginate_by, int):
+            paginate_by = self.paginate_by
+        else:
+            paginate_by = self.paginate_by.resolve(context)
+        if isinstance(self.orphans, int):
+            orphans = self.orphans
+        else:
+            orphans = self.orphans.resolve(context)
+        paginator = Paginator(value, paginate_by, orphans)
+        try:
+            page_obj = paginator.page(context['request'].page)
+        except InvalidPage:
+            if INVALID_PAGE_RAISES_404:
+                raise Http404('Invalid page requested.  If DEBUG were set to ' +
+                    'False, an HTTP 404 page would have been shown instead.')
+            context[key] = []
+            context['invalid_page'] = True
+            return u''
+        if self.context_var is not None:
+            context[self.context_var] = page_obj.object_list
+        else:
+            context[key] = page_obj.object_list
+        context['paginator'] = paginator
+        context['page_obj'] = page_obj
+        return u''
+
+
+def paginate(context, window=DEFAULT_WINDOW, hashtag=''):
+    """
+    Renders the ``pagination/pagination.html`` template, resulting in a
+    Digg-like display of the available pages, given the current page.  If there
+    are too many pages to be displayed before and after the current page, then
+    elipses will be used to indicate the undisplayed gap between page numbers.
+    
+    Requires one argument, ``context``, which should be a dictionary-like data
+    structure and must contain the following keys:
+    
+    ``paginator``
+        A ``Paginator`` or ``QuerySetPaginator`` object.
+    
+    ``page_obj``
+        This should be the result of calling the page method on the 
+        aforementioned ``Paginator`` or ``QuerySetPaginator`` object, given
+        the current page.
+    
+    This same ``context`` dictionary-like data structure may also include:
+    
+    ``getvars``
+        A dictionary of all of the **GET** parameters in the current request.
+        This is useful to maintain certain types of state, even when requesting
+        a different page.
+        """
+    try:
+        paginator = context['paginator']
+        page_obj = context['page_obj']
+        page_range = paginator.page_range
+        # Calculate the record range in the current page for display.
+        records = {'first': 1 + (page_obj.number - 1) * paginator.per_page}
+        records['last'] = records['first'] + paginator.per_page - 1
+        if records['last'] + paginator.orphans >= paginator.count:
+            records['last'] = paginator.count
+        # First and last are simply the first *n* pages and the last *n* pages,
+        # where *n* is the current window size.
+        first = set(page_range[:window])
+        last = set(page_range[-window:])
+        # Now we look around our current page, making sure that we don't wrap
+        # around.
+        current_start = page_obj.number-1-window
+        if current_start < 0:
+            current_start = 0
+        current_end = page_obj.number-1+window
+        if current_end < 0:
+            current_end = 0
+        current = set(page_range[current_start:current_end])
+        pages = []
+        # If there's no overlap between the first set of pages and the current
+        # set of pages, then there's a possible need for elusion.
+        if len(first.intersection(current)) == 0:
+            first_list = list(first)
+            first_list.sort()
+            second_list = list(current)
+            second_list.sort()
+            pages.extend(first_list)
+            diff = second_list[0] - first_list[-1]
+            # If there is a gap of two, between the last page of the first
+            # set and the first page of the current set, then we're missing a
+            # page.
+            if diff == 2:
+                pages.append(second_list[0] - 1)
+            # If the difference is just one, then there's nothing to be done,
+            # as the pages need no elusion and are correct.
+            elif diff == 1:
+                pass
+            # Otherwise, there's a bigger gap which needs to be signaled for
+            # elusion, by pushing a None value to the page list.
+            else:
+                pages.append(None)
+            pages.extend(second_list)
+        else:
+            unioned = list(first.union(current))
+            unioned.sort()
+            pages.extend(unioned)
+        # If there's no overlap between the current set of pages and the last
+        # set of pages, then there's a possible need for elusion.
+        if len(current.intersection(last)) == 0:
+            second_list = list(last)
+            second_list.sort()
+            diff = second_list[0] - pages[-1]
+            # If there is a gap of two, between the last page of the current
+            # set and the first page of the last set, then we're missing a 
+            # page.
+            if diff == 2:
+                pages.append(second_list[0] - 1)
+            # If the difference is just one, then there's nothing to be done,
+            # as the pages need no elusion and are correct.
+            elif diff == 1:
+                pass
+            # Otherwise, there's a bigger gap which needs to be signaled for
+            # elusion, by pushing a None value to the page list.
+            else:
+                pages.append(None)
+            pages.extend(second_list)
+        else:
+            differenced = list(last.difference(current))
+            differenced.sort()
+            pages.extend(differenced)
+        to_return = {
+            'MEDIA_URL': settings.MEDIA_URL,
+            'pages': pages,
+            'records': records,
+            'page_obj': page_obj,
+            'paginator': paginator,
+            'hashtag': hashtag,
+            'is_paginated': paginator.count > paginator.per_page,
+        }
+        if 'request' in context:
+            getvars = context['request'].GET.copy()
+            if 'page' in getvars:
+                del getvars['page']
+            if len(getvars.keys()) > 0:
+                to_return['getvars'] = "&%s" % getvars.urlencode()
+            else:
+                to_return['getvars'] = ''
+        return to_return
+    except KeyError, AttributeError:
+        return {}
+
+register.inclusion_tag('pagination/pagination.html', takes_context=True)(
+    paginate)
+register.tag('autopaginate', do_autopaginate)
diff --git a/linaro_django_pagination/tests.py b/linaro_django_pagination/tests.py
new file mode 100644 (file)
index 0000000..343d82f
--- /dev/null
@@ -0,0 +1,158 @@
+"""
+>>> from django.core.paginator import Paginator
+>>> from linaro_django_pagination.templatetags.pagination_tags import paginate
+>>> from django.template import Template, Context
+
+>>> p = Paginator(range(15), 2)
+>>> pg = paginate({'paginator': p, 'page_obj': p.page(1)})
+>>> pg['pages']
+[1, 2, 3, 4, 5, 6, 7, 8]
+>>> pg['records']['first']
+1
+>>> pg['records']['last']
+2
+
+>>> p = Paginator(range(15), 2)
+>>> pg = paginate({'paginator': p, 'page_obj': p.page(8)})
+>>> pg['pages']
+[1, 2, 3, 4, 5, 6, 7, 8]
+>>> pg['records']['first']
+15
+>>> pg['records']['last']
+15
+
+>>> p = Paginator(range(17), 2)
+>>> paginate({'paginator': p, 'page_obj': p.page(1)})['pages']
+[1, 2, 3, 4, 5, 6, 7, 8, 9]
+
+>>> p = Paginator(range(19), 2)
+>>> paginate({'paginator': p, 'page_obj': p.page(1)})['pages']
+[1, 2, 3, 4, None, 7, 8, 9, 10]
+
+>>> p = Paginator(range(21), 2)
+>>> paginate({'paginator': p, 'page_obj': p.page(1)})['pages']
+[1, 2, 3, 4, None, 8, 9, 10, 11]
+
+# Testing orphans
+>>> p = Paginator(range(5), 2, 1)
+>>> paginate({'paginator': p, 'page_obj': p.page(1)})['pages']
+[1, 2]
+
+>>> p = Paginator(range(21), 2, 1)
+>>> pg = paginate({'paginator': p, 'page_obj': p.page(1)})
+>>> pg['pages']
+[1, 2, 3, 4, None, 7, 8, 9, 10]
+>>> pg['records']['first']
+1
+>>> pg['records']['last']
+2
+
+>>> p = Paginator(range(21), 2, 1)
+>>> pg = paginate({'paginator': p, 'page_obj': p.page(10)})
+>>> pg['pages']
+[1, 2, 3, 4, 5, 6, 7, 8, 9, 10]
+>>> pg['records']['first']
+19
+>>> pg['records']['last']
+21
+
+>>> t = Template("{% load pagination_tags %}{% autopaginate var 2 %}{% paginate %}")
+
+>>> from django.http import HttpRequest as DjangoHttpRequest
+>>> class HttpRequest(DjangoHttpRequest):
+...     page = 1
+
+>>> t.render(Context({'var': range(21), 'request': HttpRequest()}))
+u'\\n\\n<div class="pagination">...
+>>>
+>>> t = Template("{% load pagination_tags %}{% autopaginate var %}{% paginate %}")
+>>> t.render(Context({'var': range(21), 'request': HttpRequest()}))
+u'\\n\\n<div class="pagination">...
+>>> t = Template("{% load pagination_tags %}{% autopaginate var 20 %}{% paginate %}")
+>>> t.render(Context({'var': range(21), 'request': HttpRequest()}))
+u'\\n\\n<div class="pagination">...
+>>> t = Template("{% load pagination_tags %}{% autopaginate var by %}{% paginate %}")
+>>> t.render(Context({'var': range(21), 'by': 20, 'request': HttpRequest()}))
+u'\\n\\n<div class="pagination">...
+>>> t = Template("{% load pagination_tags %}{% autopaginate var by as foo %}{{ foo }}")
+>>> t.render(Context({'var': range(21), 'by': 20, 'request': HttpRequest()}))
+u'[0, 1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12, 13, 14, 15, 16, 17, 18, 19]'
+>>>
+
+# Testing InfinitePaginator
+
+>>> from paginator import InfinitePaginator
+
+>>> InfinitePaginator
+<class 'linaro_django_pagination.paginator.InfinitePaginator'>
+>>> p = InfinitePaginator(range(20), 2, link_template='/bacon/page/%d')
+>>> p.validate_number(2)
+2
+>>> p.orphans
+0
+>>> p3 = p.page(3)
+>>> p3
+<Page 3>
+>>> p3.end_index()
+6
+>>> p3.has_next()
+True
+>>> p3.has_previous()
+True
+>>> p.page(10).has_next()
+False
+>>> p.page(1).has_previous()
+False
+>>> p3.next_link()
+'/bacon/page/4'
+>>> p3.previous_link()
+'/bacon/page/2'
+
+# Testing FinitePaginator
+
+>>> from paginator import FinitePaginator
+
+>>> FinitePaginator
+<class 'linaro_django_pagination.paginator.FinitePaginator'>
+>>> p = FinitePaginator(range(20), 2, offset=10, link_template='/bacon/page/%d')
+>>> p.validate_number(2)
+2
+>>> p.orphans
+0
+>>> p3 = p.page(3)
+>>> p3
+<Page 3>
+>>> p3.start_index()
+10
+>>> p3.end_index()
+6
+>>> p3.has_next()
+True
+>>> p3.has_previous()
+True
+>>> p3.next_link()
+'/bacon/page/4'
+>>> p3.previous_link()
+'/bacon/page/2'
+
+>>> p = FinitePaginator(range(20), 20, offset=10, link_template='/bacon/page/%d')
+>>> p2 = p.page(2)
+>>> p2
+<Page 2>
+>>> p2.has_next()
+False
+>>> p3.has_previous()
+True
+>>> p2.next_link()
+
+>>> p2.previous_link()
+'/bacon/page/1'
+
+>>> from linaro_django_pagination.middleware import PaginationMiddleware
+>>> from django.core.handlers.wsgi import WSGIRequest
+>>> from StringIO import StringIO
+>>> middleware = PaginationMiddleware()
+>>> request = WSGIRequest({'REQUEST_METHOD': 'POST', 'CONTENT_TYPE': 'multipart', 'wsgi.input': StringIO()})
+>>> middleware.process_request(request)
+>>> request.upload_handlers.append('asdf')
+"""
diff --git a/pagination/__init__.py b/pagination/__init__.py
deleted file mode 100644 (file)
index 8b13789..0000000
+++ /dev/null
@@ -1 +0,0 @@
-
diff --git a/pagination/locale/de/LC_MESSAGES/django.po b/pagination/locale/de/LC_MESSAGES/django.po
deleted file mode 100644 (file)
index ff9872a..0000000
+++ /dev/null
@@ -1,27 +0,0 @@
-# SOME DESCRIPTIVE TITLE.
-# Copyright (C) YEAR THE PACKAGE'S COPYRIGHT HOLDER
-# This file is distributed under the same license as the PACKAGE package.
-# FIRST AUTHOR <EMAIL@ADDRESS>, YEAR.
-#
-#, fuzzy
-msgid ""
-msgstr ""
-"Project-Id-Version: PACKAGE VERSION\n"
-"Report-Msgid-Bugs-To: \n"
-"POT-Creation-Date: 2009-03-16 16:26+0100\n"
-"PO-Revision-Date: YEAR-MO-DA HO:MI+ZONE\n"
-"Last-Translator: FULL NAME <EMAIL@ADDRESS>\n"
-"Language-Team: LANGUAGE <LL@li.org>\n"
-"MIME-Version: 1.0\n"
-"Content-Type: text/plain; charset=UTF-8\n"
-"Content-Transfer-Encoding: 8bit\n"
-
-#: templates/pagination/pagination.html:5
-#: templates/pagination/pagination.html:7
-msgid "previous"
-msgstr "Zurück"
-
-#: templates/pagination/pagination.html:21
-#: templates/pagination/pagination.html:23
-msgid "next"
-msgstr "Weiter"
diff --git a/pagination/locale/fr/LC_MESSAGES/django.po b/pagination/locale/fr/LC_MESSAGES/django.po
deleted file mode 100644 (file)
index 85086d2..0000000
+++ /dev/null
@@ -1,26 +0,0 @@
-# django-pagination French translation.
-# Copyright (C) 2008, Julien Demoor
-# This file is distributed under the same license as the django-pagination package.
-# Julien Demoor <julien@jdemoor.com>, 2008
-#
-msgid ""
-msgstr ""
-"Project-Id-Version: PACKAGE VERSION\n"
-"Report-Msgid-Bugs-To: \n"
-"POT-Creation-Date: 2008-10-24 00:41-0700\n"
-"PO-Revision-Date: 2008-10-19 10:19+0200\n"
-"Last-Translator: Julien Demoor <julien@jdemoor.com>\n"
-"Language-Team: LANGUAGE <LL@li.org>\n"
-"MIME-Version: 1.0\n"
-"Content-Type: text/plain; charset=UTF-8\n"
-"Content-Transfer-Encoding: 8bit\n"
-
-#: templates/pagination/pagination.html:5
-#: templates/pagination/pagination.html:7
-msgid "previous"
-msgstr "précédente"
-
-#: templates/pagination/pagination.html:21
-#: templates/pagination/pagination.html:23
-msgid "next"
-msgstr "suivante"
diff --git a/pagination/locale/pl/LC_MESSAGES/django.po b/pagination/locale/pl/LC_MESSAGES/django.po
deleted file mode 100644 (file)
index 84b41e3..0000000
+++ /dev/null
@@ -1,27 +0,0 @@
-# Polish translation of django-pagination.
-# Copyright (C) 2008, django-pagination team
-# This file is distributed under the same license as the django-pagination package.
-# Jarek Zgoda <jarek.zgoda@gmail.com>, 2008.
-#
-#, fuzzy
-msgid ""
-msgstr ""
-"Project-Id-Version: 1.0\n"
-"Report-Msgid-Bugs-To: \n"
-"POT-Creation-Date: 2008-10-24 00:41-0700\n"
-"PO-Revision-Date: 2008-10-20 20:52+0200\n"
-"Last-Translator: Jarek Zgoda <jarek.zgoda@gmail.com>\n"
-"Language-Team: PL <pl@li.org>\n"
-"MIME-Version: 1.0\n"
-"Content-Type: text/plain; charset=UTF-8\n"
-"Content-Transfer-Encoding: 8bit\n"
-
-#: templates/pagination/pagination.html:5
-#: templates/pagination/pagination.html:7
-msgid "previous"
-msgstr "poprzednia"
-
-#: templates/pagination/pagination.html:21
-#: templates/pagination/pagination.html:23
-msgid "next"
-msgstr "następna"
diff --git a/pagination/locale/pt/LC_MESSAGES/django.po b/pagination/locale/pt/LC_MESSAGES/django.po
deleted file mode 100644 (file)
index 9289f88..0000000
+++ /dev/null
@@ -1,26 +0,0 @@
-# django-pagination Portuguese translation.
-# Copyright (C) 2008, Alcides Fonseca
-# http://alcidesfonseca.com
-# This file is distributed under the WTFPL
-#
-msgid ""
-msgstr ""
-"Project-Id-Version: PACKAGE VERSION\n"
-"Report-Msgid-Bugs-To: \n"
-"POT-Creation-Date: 2008-10-24 00:41-0700\n"
-"PO-Revision-Date: 2008-10-19 10:19+0200\n"
-"Last-Translator: Alcides Fonseca <me@alcidesfonseca.com>\n"
-"Language-Team: LANGUAGE <LL@li.org>\n"
-"MIME-Version: 1.0\n"
-"Content-Type: text/plain; charset=UTF-8\n"
-"Content-Transfer-Encoding: 8bit\n"
-
-#: templates/pagination/pagination.html:5
-#: templates/pagination/pagination.html:7
-msgid "previous"
-msgstr "anterior"
-
-#: templates/pagination/pagination.html:21
-#: templates/pagination/pagination.html:23
-msgid "next"
-msgstr "próximo"
diff --git a/pagination/middleware.py b/pagination/middleware.py
deleted file mode 100644 (file)
index f8a2a6f..0000000
+++ /dev/null
@@ -1,17 +0,0 @@
-def get_page(self):
-    """
-    A function which will be monkeypatched onto the request to get the current
-    integer representing the current page.
-    """
-    try:
-        return int(self.REQUEST['page'])
-    except (KeyError, ValueError, TypeError):
-        return 1
-
-class PaginationMiddleware(object):
-    """
-    Inserts a variable representing the current page onto the request object if
-    it exists in either **GET** or **POST** portions of the request.
-    """
-    def process_request(self, request):
-        request.__class__.page = property(get_page)
\ No newline at end of file
diff --git a/pagination/models.py b/pagination/models.py
deleted file mode 100644 (file)
index 8b13789..0000000
+++ /dev/null
@@ -1 +0,0 @@
-
diff --git a/pagination/paginator.py b/pagination/paginator.py
deleted file mode 100644 (file)
index f67aa23..0000000
+++ /dev/null
@@ -1,171 +0,0 @@
-from django.core.paginator import Paginator, Page, PageNotAnInteger, EmptyPage
-
-class InfinitePaginator(Paginator):
-    """
-    Paginator designed for cases when it's not important to know how many total
-    pages.  This is useful for any object_list that has no count() method or can
-    be used to improve performance for MySQL by removing counts.
-
-    The orphans parameter has been removed for simplicity and there's a link
-    template string for creating the links to the next and previous pages.
-    """
-
-    def __init__(self, object_list, per_page, allow_empty_first_page=True,
-        link_template='/page/%d/'):
-        orphans = 0 # no orphans
-        super(InfinitePaginator, self).__init__(object_list, per_page, orphans,
-            allow_empty_first_page)
-        # no count or num pages
-        del self._num_pages, self._count
-        # bonus links
-        self.link_template = link_template
-
-    def validate_number(self, number):
-        """
-        Validates the given 1-based page number.
-        """
-        try:
-            number = int(number)
-        except ValueError:
-            raise PageNotAnInteger('That page number is not an integer')
-        if number < 1:
-            raise EmptyPage('That page number is less than 1')
-        return number
-
-    def page(self, number):
-        """
-        Returns a Page object for the given 1-based page number.
-        """
-        number = self.validate_number(number)
-        bottom = (number - 1) * self.per_page
-        top = bottom + self.per_page
-        page_items = self.object_list[bottom:top]
-        # check moved from validate_number
-        if not page_items:
-            if number == 1 and self.allow_empty_first_page:
-                pass
-            else:
-                raise EmptyPage('That page contains no results')
-        return InfinitePage(page_items, number, self)
-
-    def _get_count(self):
-        """
-        Returns the total number of objects, across all pages.
-        """
-        raise NotImplementedError
-    count = property(_get_count)
-
-    def _get_num_pages(self):
-        """
-        Returns the total number of pages.
-        """
-        raise NotImplementedError
-    num_pages = property(_get_num_pages)
-
-    def _get_page_range(self):
-        """
-        Returns a 1-based range of pages for iterating through within
-        a template for loop.
-        """
-        raise NotImplementedError
-    page_range = property(_get_page_range)
-
-
-class InfinitePage(Page):
-
-    def __repr__(self):
-        return '<Page %s>' % self.number
-
-    def has_next(self):
-        """
-        Checks for one more item than last on this page.
-        """
-        try:
-            next_item = self.paginator.object_list[
-                self.number * self.paginator.per_page]
-        except IndexError:
-            return False
-        return True
-
-    def end_index(self):
-        """
-        Returns the 1-based index of the last object on this page,
-        relative to total objects found (hits).
-        """
-        return ((self.number - 1) * self.paginator.per_page +
-            len(self.object_list))
-
-    #Bonus methods for creating links
-
-    def next_link(self):
-        if self.has_next():
-            return self.paginator.link_template % (self.number + 1)
-        return None
-
-    def previous_link(self):
-        if self.has_previous():
-            return self.paginator.link_template % (self.number - 1)
-        return None
-
-class FinitePaginator(InfinitePaginator):
-    """
-    Paginator for cases when the list of items is already finite.
-
-    A good example is a list generated from an API call. This is a subclass
-    of InfinitePaginator because we have no idea how many items exist in the
-    full collection.
-
-    To accurately determine if the next page exists, a FinitePaginator MUST be
-    created with an object_list_plus that may contain more items than the
-    per_page count.  Typically, you'll have an object_list_plus with one extra
-    item (if there's a next page).  You'll also need to supply the offset from
-    the full collection in order to get the page start_index.
-
-    This is a very silly class but useful if you love the Django pagination
-    conventions.
-    """
-
-    def __init__(self, object_list_plus, per_page, offset=None,
-        allow_empty_first_page=True, link_template='/page/%d/'):
-        super(FinitePaginator, self).__init__(object_list_plus, per_page,
-            allow_empty_first_page, link_template)
-        self.offset = offset
-
-    def validate_number(self, number):
-        super(FinitePaginator, self).validate_number(number)
-        # check for an empty list to see if the page exists
-        if not self.object_list:
-            if number == 1 and self.allow_empty_first_page:
-                pass
-            else:
-                raise EmptyPage('That page contains no results')
-        return number
-
-    def page(self, number):
-        """
-        Returns a Page object for the given 1-based page number.
-        """
-        number = self.validate_number(number)
-        # remove the extra item(s) when creating the page
-        page_items = self.object_list[:self.per_page]
-        return FinitePage(page_items, number, self)
-
-class FinitePage(InfinitePage):
-
-    def has_next(self):
-        """
-        Checks for one more item than last on this page.
-        """
-        try:
-            next_item = self.paginator.object_list[self.paginator.per_page]
-        except IndexError:
-            return False
-        return True
-
-    def start_index(self):
-        """
-        Returns the 1-based index of the first object on this page,
-        relative to total objects in the paginator.
-        """
-        ## TODO should this holler if you haven't defined the offset?
-        return self.paginator.offset
\ No newline at end of file
diff --git a/pagination/templates/pagination/pagination.html b/pagination/templates/pagination/pagination.html
deleted file mode 100644 (file)
index fe566a8..0000000
+++ /dev/null
@@ -1,26 +0,0 @@
-{% if is_paginated %}
-{% load i18n %}
-<div class="pagination">
-    {% if page_obj.has_previous %}
-        <a href="?page={{ page_obj.previous_page_number }}{{ getvars }}{{ hashtag }}" class="prev">&lsaquo;&lsaquo; {% trans "previous" %}</a>
-    {% else %}
-        <span class="disabled prev">&lsaquo;&lsaquo; {% trans "previous" %}</span>
-    {% endif %}
-    {% for page in pages %}
-        {% if page %}
-            {% ifequal page page_obj.number %}
-                <span class="current page">{{ page }}</span>
-            {% else %}
-                <a href="?page={{ page }}{{ getvars }}{{ hashtag }}" class="page">{{ page }}</a>
-            {% endifequal %}
-        {% else %}
-            ...
-        {% endif %}
-    {% endfor %}
-    {% if page_obj.has_next %}
-        <a href="?page={{ page_obj.next_page_number }}{{ getvars }}{{ hashtag }}" class="next">{% trans "next" %} &rsaquo;&rsaquo;</a>
-    {% else %}
-        <span class="disabled next">{% trans "next" %} &rsaquo;&rsaquo;</span>
-    {% endif %}
-</div>
-{% endif %}
diff --git a/pagination/templatetags/__init__.py b/pagination/templatetags/__init__.py
deleted file mode 100644 (file)
index 8b13789..0000000
+++ /dev/null
@@ -1 +0,0 @@
-
diff --git a/pagination/templatetags/pagination_tags.py b/pagination/templatetags/pagination_tags.py
deleted file mode 100644 (file)
index ab87ed4..0000000
+++ /dev/null
@@ -1,250 +0,0 @@
-try:
-    set
-except NameError:
-    from sets import Set as set
-
-from django import template
-from django.http import Http404
-from django.core.paginator import Paginator, InvalidPage
-from django.conf import settings
-
-register = template.Library()
-
-DEFAULT_PAGINATION = getattr(settings, 'PAGINATION_DEFAULT_PAGINATION', 20)
-DEFAULT_WINDOW = getattr(settings, 'PAGINATION_DEFAULT_WINDOW', 4)
-DEFAULT_ORPHANS = getattr(settings, 'PAGINATION_DEFAULT_ORPHANS', 0)
-INVALID_PAGE_RAISES_404 = getattr(settings,
-    'PAGINATION_INVALID_PAGE_RAISES_404', False)
-
-def do_autopaginate(parser, token):
-    """
-    Splits the arguments to the autopaginate tag and formats them correctly.
-
-    Syntax is:
-
-        autopaginate SOMETHING [PAGINATE_BY] [ORPHANS] [as NAME]
-    """
-    i = iter(token.split_contents())
-    paginate_by = None
-    queryset_var = None
-    context_var = None
-    orphans = None
-    word = None
-    try:
-        word = i.next()
-        assert word == "autopaginate"
-        queryset_var = i.next()
-        word = i.next()
-        if word != "as":
-            paginate_by = word
-            try:
-                paginate_by = int(paginate_by)
-            except ValueError:
-                pass
-            word = i.next()
-        if word != "as":
-            orphans = word
-            try:
-                orphans = int(orphans)
-            except ValueError:
-                pass
-            word = i.next()
-        assert word == "as"
-        context_var = i.next()
-    except StopIteration:
-        pass
-    if queryset_var is None:
-        raise template.TemplateSyntaxError(
-            "Invalid syntax. Proper usage of this tag is: "
-            "{%% autopaginate QUERYSET [PAGINATE_BY] [ORPHANS]"
-            " [as CONTEXT_VAR_NAME] %%}"
-        )
-    return AutoPaginateNode(queryset_var, paginate_by, orphans, context_var)
-
-class AutoPaginateNode(template.Node):
-    """
-    Emits the required objects to allow for Digg-style pagination.
-    
-    First, it looks in the current context for the variable specified, and using
-    that object, it emits a simple ``Paginator`` and the current page object 
-    into the context names ``paginator`` and ``page_obj``, respectively.
-    
-    It will then replace the variable specified with only the objects for the
-    current page.
-    
-    .. note::
-        
-        It is recommended to use *{% paginate %}* after using the autopaginate
-        tag.  If you choose not to use *{% paginate %}*, make sure to display the
-        list of available pages, or else the application may seem to be buggy.
-    """
-    def __init__(self, queryset_var, paginate_by=None,
-        orphans=None, context_var=None):
-        if paginate_by is None:
-            paginate_by = DEFAULT_PAGINATION
-        if orphans is None:
-            orphans = DEFAULT_ORPHANS
-        self.queryset_var = template.Variable(queryset_var)
-        if isinstance(paginate_by, int):
-            self.paginate_by = paginate_by
-        else:
-            self.paginate_by = template.Variable(paginate_by)
-        if isinstance(orphans, int):
-            self.orphans = orphans
-        else:
-            self.orphans = template.Variable(orphans)
-        self.context_var = context_var
-
-    def render(self, context):
-        key = self.queryset_var.var
-        value = self.queryset_var.resolve(context)
-        if isinstance(self.paginate_by, int):
-            paginate_by = self.paginate_by
-        else:
-            paginate_by = self.paginate_by.resolve(context)
-        if isinstance(self.orphans, int):
-            orphans = self.orphans
-        else:
-            orphans = self.orphans.resolve(context)
-        paginator = Paginator(value, paginate_by, orphans)
-        try:
-            page_obj = paginator.page(context['request'].page)
-        except InvalidPage:
-            if INVALID_PAGE_RAISES_404:
-                raise Http404('Invalid page requested.  If DEBUG were set to ' +
-                    'False, an HTTP 404 page would have been shown instead.')
-            context[key] = []
-            context['invalid_page'] = True
-            return u''
-        if self.context_var is not None:
-            context[self.context_var] = page_obj.object_list
-        else:
-            context[key] = page_obj.object_list
-        context['paginator'] = paginator
-        context['page_obj'] = page_obj
-        return u''
-
-
-def paginate(context, window=DEFAULT_WINDOW, hashtag=''):
-    """
-    Renders the ``pagination/pagination.html`` template, resulting in a
-    Digg-like display of the available pages, given the current page.  If there
-    are too many pages to be displayed before and after the current page, then
-    elipses will be used to indicate the undisplayed gap between page numbers.
-    
-    Requires one argument, ``context``, which should be a dictionary-like data
-    structure and must contain the following keys:
-    
-    ``paginator``
-        A ``Paginator`` or ``QuerySetPaginator`` object.
-    
-    ``page_obj``
-        This should be the result of calling the page method on the 
-        aforementioned ``Paginator`` or ``QuerySetPaginator`` object, given
-        the current page.
-    
-    This same ``context`` dictionary-like data structure may also include:
-    
-    ``getvars``
-        A dictionary of all of the **GET** parameters in the current request.
-        This is useful to maintain certain types of state, even when requesting
-        a different page.
-        """
-    try:
-        paginator = context['paginator']
-        page_obj = context['page_obj']
-        page_range = paginator.page_range
-        # Calculate the record range in the current page for display.
-        records = {'first': 1 + (page_obj.number - 1) * paginator.per_page}
-        records['last'] = records['first'] + paginator.per_page - 1
-        if records['last'] + paginator.orphans >= paginator.count:
-            records['last'] = paginator.count
-        # First and last are simply the first *n* pages and the last *n* pages,
-        # where *n* is the current window size.
-        first = set(page_range[:window])
-        last = set(page_range[-window:])
-        # Now we look around our current page, making sure that we don't wrap
-        # around.
-        current_start = page_obj.number-1-window
-        if current_start < 0:
-            current_start = 0
-        current_end = page_obj.number-1+window
-        if current_end < 0:
-            current_end = 0
-        current = set(page_range[current_start:current_end])
-        pages = []
-        # If there's no overlap between the first set of pages and the current
-        # set of pages, then there's a possible need for elusion.
-        if len(first.intersection(current)) == 0:
-            first_list = list(first)
-            first_list.sort()
-            second_list = list(current)
-            second_list.sort()
-            pages.extend(first_list)
-            diff = second_list[0] - first_list[-1]
-            # If there is a gap of two, between the last page of the first
-            # set and the first page of the current set, then we're missing a
-            # page.
-            if diff == 2:
-                pages.append(second_list[0] - 1)
-            # If the difference is just one, then there's nothing to be done,
-            # as the pages need no elusion and are correct.
-            elif diff == 1:
-                pass
-            # Otherwise, there's a bigger gap which needs to be signaled for
-            # elusion, by pushing a None value to the page list.
-            else:
-                pages.append(None)
-            pages.extend(second_list)
-        else:
-            unioned = list(first.union(current))
-            unioned.sort()
-            pages.extend(unioned)
-        # If there's no overlap between the current set of pages and the last
-        # set of pages, then there's a possible need for elusion.
-        if len(current.intersection(last)) == 0:
-            second_list = list(last)
-            second_list.sort()
-            diff = second_list[0] - pages[-1]
-            # If there is a gap of two, between the last page of the current
-            # set and the first page of the last set, then we're missing a 
-            # page.
-            if diff == 2:
-                pages.append(second_list[0] - 1)
-            # If the difference is just one, then there's nothing to be done,
-            # as the pages need no elusion and are correct.
-            elif diff == 1:
-                pass
-            # Otherwise, there's a bigger gap which needs to be signaled for
-            # elusion, by pushing a None value to the page list.
-            else:
-                pages.append(None)
-            pages.extend(second_list)
-        else:
-            differenced = list(last.difference(current))
-            differenced.sort()
-            pages.extend(differenced)
-        to_return = {
-            'MEDIA_URL': settings.MEDIA_URL,
-            'pages': pages,
-            'records': records,
-            'page_obj': page_obj,
-            'paginator': paginator,
-            'hashtag': hashtag,
-            'is_paginated': paginator.count > paginator.per_page,
-        }
-        if 'request' in context:
-            getvars = context['request'].GET.copy()
-            if 'page' in getvars:
-                del getvars['page']
-            if len(getvars.keys()) > 0:
-                to_return['getvars'] = "&%s" % getvars.urlencode()
-            else:
-                to_return['getvars'] = ''
-        return to_return
-    except KeyError, AttributeError:
-        return {}
-
-register.inclusion_tag('pagination/pagination.html', takes_context=True)(
-    paginate)
-register.tag('autopaginate', do_autopaginate)
diff --git a/pagination/tests.py b/pagination/tests.py
deleted file mode 100644 (file)
index 31b3301..0000000
+++ /dev/null
@@ -1,158 +0,0 @@
-"""
->>> from django.core.paginator import Paginator
->>> from pagination.templatetags.pagination_tags import paginate
->>> from django.template import Template, Context
-
->>> p = Paginator(range(15), 2)
->>> pg = paginate({'paginator': p, 'page_obj': p.page(1)})
->>> pg['pages']
-[1, 2, 3, 4, 5, 6, 7, 8]
->>> pg['records']['first']
-1
->>> pg['records']['last']
-2
-
->>> p = Paginator(range(15), 2)
->>> pg = paginate({'paginator': p, 'page_obj': p.page(8)})
->>> pg['pages']
-[1, 2, 3, 4, 5, 6, 7, 8]
->>> pg['records']['first']
-15
->>> pg['records']['last']
-15
-
->>> p = Paginator(range(17), 2)
->>> paginate({'paginator': p, 'page_obj': p.page(1)})['pages']
-[1, 2, 3, 4, 5, 6, 7, 8, 9]
-
->>> p = Paginator(range(19), 2)
->>> paginate({'paginator': p, 'page_obj': p.page(1)})['pages']
-[1, 2, 3, 4, None, 7, 8, 9, 10]
-
->>> p = Paginator(range(21), 2)
->>> paginate({'paginator': p, 'page_obj': p.page(1)})['pages']
-[1, 2, 3, 4, None, 8, 9, 10, 11]
-
-# Testing orphans
->>> p = Paginator(range(5), 2, 1)
->>> paginate({'paginator': p, 'page_obj': p.page(1)})['pages']
-[1, 2]
-
->>> p = Paginator(range(21), 2, 1)
->>> pg = paginate({'paginator': p, 'page_obj': p.page(1)})
->>> pg['pages']
-[1, 2, 3, 4, None, 7, 8, 9, 10]
->>> pg['records']['first']
-1
->>> pg['records']['last']
-2
-
->>> p = Paginator(range(21), 2, 1)
->>> pg = paginate({'paginator': p, 'page_obj': p.page(10)})
->>> pg['pages']
-[1, 2, 3, 4, 5, 6, 7, 8, 9, 10]
->>> pg['records']['first']
-19
->>> pg['records']['last']
-21
-
->>> t = Template("{% load pagination_tags %}{% autopaginate var 2 %}{% paginate %}")
-
->>> from django.http import HttpRequest as DjangoHttpRequest
->>> class HttpRequest(DjangoHttpRequest):
-...     page = 1
-
->>> t.render(Context({'var': range(21), 'request': HttpRequest()}))
-u'\\n\\n<div class="pagination">...
->>>
->>> t = Template("{% load pagination_tags %}{% autopaginate var %}{% paginate %}")
->>> t.render(Context({'var': range(21), 'request': HttpRequest()}))
-u'\\n\\n<div class="pagination">...
->>> t = Template("{% load pagination_tags %}{% autopaginate var 20 %}{% paginate %}")
->>> t.render(Context({'var': range(21), 'request': HttpRequest()}))
-u'\\n\\n<div class="pagination">...
->>> t = Template("{% load pagination_tags %}{% autopaginate var by %}{% paginate %}")
->>> t.render(Context({'var': range(21), 'by': 20, 'request': HttpRequest()}))
-u'\\n\\n<div class="pagination">...
->>> t = Template("{% load pagination_tags %}{% autopaginate var by as foo %}{{ foo }}")
->>> t.render(Context({'var': range(21), 'by': 20, 'request': HttpRequest()}))
-u'[0, 1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12, 13, 14, 15, 16, 17, 18, 19]'
->>>
-
-# Testing InfinitePaginator
-
->>> from paginator import InfinitePaginator
-
->>> InfinitePaginator
-<class 'pagination.paginator.InfinitePaginator'>
->>> p = InfinitePaginator(range(20), 2, link_template='/bacon/page/%d')
->>> p.validate_number(2)
-2
->>> p.orphans
-0
->>> p3 = p.page(3)
->>> p3
-<Page 3>
->>> p3.end_index()
-6
->>> p3.has_next()
-True
->>> p3.has_previous()
-True
->>> p.page(10).has_next()
-False
->>> p.page(1).has_previous()
-False
->>> p3.next_link()
-'/bacon/page/4'
->>> p3.previous_link()
-'/bacon/page/2'
-
-# Testing FinitePaginator
-
->>> from paginator import FinitePaginator
-
->>> FinitePaginator
-<class 'pagination.paginator.FinitePaginator'>
->>> p = FinitePaginator(range(20), 2, offset=10, link_template='/bacon/page/%d')
->>> p.validate_number(2)
-2
->>> p.orphans
-0
->>> p3 = p.page(3)
->>> p3
-<Page 3>
->>> p3.start_index()
-10
->>> p3.end_index()
-6
->>> p3.has_next()
-True
->>> p3.has_previous()
-True
->>> p3.next_link()
-'/bacon/page/4'
->>> p3.previous_link()
-'/bacon/page/2'
-
->>> p = FinitePaginator(range(20), 20, offset=10, link_template='/bacon/page/%d')
->>> p2 = p.page(2)
->>> p2
-<Page 2>
->>> p2.has_next()
-False
->>> p3.has_previous()
-True
->>> p2.next_link()
-
->>> p2.previous_link()
-'/bacon/page/1'
-
->>> from pagination.middleware import PaginationMiddleware
->>> from django.core.handlers.wsgi import WSGIRequest
->>> from StringIO import StringIO
->>> middleware = PaginationMiddleware()
->>> request = WSGIRequest({'REQUEST_METHOD': 'POST', 'CONTENT_TYPE': 'multipart', 'wsgi.input': StringIO()})
->>> middleware.process_request(request)
->>> request.upload_handlers.append('asdf')
-"""
old mode 100644 (file)
new mode 100755 (executable)
index 8ca27c5..2d0dc88
--- a/setup.py
+++ b/setup.py
@@ -1,13 +1,24 @@
+#!/usr/bin/env python
 from setuptools import setup, find_packages
 
 version = '1.0.7.1'
 
 LONG_DESCRIPTION = """
-How to use django-pagination
-----------------------------
 
-``django-pagination`` allows for easy Digg-style pagination without modifying
-your views.
+About the fork
+--------------
+
+This project is a fork of apparently dead "django-pagination" project
+originally written by 'Eric Florenzano'. It is maintained by the Linaro
+Validation/Infrastructure team. Latest releases can be found on launchpad and
+pypi.
+
+
+How to use linaro-django-pagination
+-----------------------------------
+
+``linaro-django-pagination`` allows for easy Digg-style pagination without
+modifying your views.
 
 There are really 5 steps to setting it up with your projects (not including 
 installation, which is covered in INSTALL.txt in this same directory.)
@@ -17,7 +28,7 @@ installation, which is covered in INSTALL.txt in this same directory.)
    
        INSTALLED_APPS = (
            # ...
-           'pagination',
+           'linaro_django_pagination',
        )
 
 
@@ -26,7 +37,7 @@ installation, which is covered in INSTALL.txt in this same directory.)
    
        MIDDLEWARE_CLASSES = (
            # ...
-           'pagination.middleware.PaginationMiddleware',
+           'linaro_django_pagination.middleware.PaginationMiddleware',
        )
 
 3. If it's not already added in your setup, add the request context processor.
@@ -76,11 +87,11 @@ a way to navigate between the different pages--all without touching your views.
 
 
 Optional Settings
-------------------
+-----------------
 
-In django-pagination, there are no required settings.  There are, however, a
-small set of optional settings useful for changing the default behavior of the
-pagination tags.  Here's an overview:
+In linaro-django-pagination, there are no required settings.  There are,
+however, a small set of optional settings useful for changing the default
+behavior of the pagination tags.  Here's an overview:
 
 ``PAGINATION_DEFAULT_PAGINATION``
     The default amount of items to show on a page if no number is specified.
@@ -102,9 +113,9 @@ pagination tags.  Here's an overview:
 """
 
 setup(
-    name='django-pagination',
+    name='linaro-django-pagination',
     version=version,
-    description="django-pagination",
+    description="linaro-django-pagination",
     long_description=LONG_DESCRIPTION,
     classifiers=[
         "Programming Language :: Python",
@@ -114,8 +125,8 @@ setup(
     ],
     keywords='pagination,django',
     author='Eric Florenzano',
-    author_email='floguy@gmail.com',
-    url='http://django-pagination.googlecode.com/',
+    author_email='zygmunt.krynicki@linaro.org',
+    url='http://launchpad.net/linaro-django-pagination/',
     license='BSD',
     packages=find_packages(),
     include_package_data=True,
index 6fb4b93..c0fba8f 100644 (file)
@@ -9,7 +9,7 @@ os.environ['DJANGO_SETTINGS_MODULE'] = 'settings'
 from django.test.simple import run_tests
 
 if __name__ == "__main__":
-    failures = run_tests(['pagination',], verbosity=9)
+    failures = run_tests(['linaro_django_pagination',], verbosity=9)
     if failures:
         sys.exit(failures)
     # Reset the DJANGO_SETTINGS_MODULE to what it was before running tests.
index ede4087..5ca32a2 100644 (file)
@@ -2,5 +2,5 @@ DATABASE_ENGINE = 'sqlite3'
 ROOT_URLCONF = ''
 SITE_ID = 1
 INSTALLED_APPS = (
-    'pagination',
+    'linaro_django_pagination',
 )