Extend templatetag paginate - flickr-like behaviour

diff --git a/pagination/templatetags/pagination_tags.py b/pagination/templatetags/pagination_tags.py
index ae843b1..14d0a57 100644 (file)
--- a/pagination/templatetags/pagination_tags.py
+++ b/pagination/templatetags/pagination_tags.py
@@ -12,6 +12,7 @@ register = template.Library()
 
 DEFAULT_PAGINATION = getattr(settings, 'PAGINATION_DEFAULT_PAGINATION', 20)
 DEFAULT_WINDOW = getattr(settings, 'PAGINATION_DEFAULT_WINDOW', 4)
 
 DEFAULT_PAGINATION = getattr(settings, 'PAGINATION_DEFAULT_PAGINATION', 20)
 DEFAULT_WINDOW = getattr(settings, 'PAGINATION_DEFAULT_WINDOW', 4)

+DEFAULT_MARGIN = getattr(settings, 'PAGINATION_DEFAULT_MARGIN', DEFAULT_WINDOW)

 DEFAULT_ORPHANS = getattr(settings, 'PAGINATION_DEFAULT_ORPHANS', 0)
 INVALID_PAGE_RAISES_404 = getattr(settings,
     'PAGINATION_INVALID_PAGE_RAISES_404', False)
 DEFAULT_ORPHANS = getattr(settings, 'PAGINATION_DEFAULT_ORPHANS', 0)
 INVALID_PAGE_RAISES_404 = getattr(settings,
     'PAGINATION_INVALID_PAGE_RAISES_404', False)


@@ -38,7 +39,7 @@ def do_autopaginate(parser, token):
     if len(split) == 2:
         return AutoPaginateNode(split[1])
     elif len(split) == 3:
     if len(split) == 2:
         return AutoPaginateNode(split[1])
     elif len(split) == 3:

-        return AutoPaginateNode(split[1], paginate_by=split[2], 
+        return AutoPaginateNode(split[1], paginate_by=split[2],

             context_var=context_var)
     elif len(split) == 4:
         try:
             context_var=context_var)
     elif len(split) == 4:
         try:


@@ -105,7 +106,7 @@ class AutoPaginateNode(template.Node):
         return u''
 
 
         return u''
 
 

-def paginate(context, window=DEFAULT_WINDOW, hashtag=''):
+def paginate(context, window=DEFAULT_WINDOW, hashtag='', margin=DEFAULT_MARGIN):

     """
     Renders the ``pagination/pagination.html`` template, resulting in a
     Digg-like display of the available pages, given the current page.  If there
     """
     Renders the ``pagination/pagination.html`` template, resulting in a
     Digg-like display of the available pages, given the current page.  If there


@@ -129,7 +130,22 @@ def paginate(context, window=DEFAULT_WINDOW, hashtag=''):
         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.
         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.

+    
+    Argument ``window`` is number to pages before/after current page. If window
+    exceed pagination border (1 and end), window is move to left or right.
+    Argument ``margin``` is number of pages on start/end of pagination. 
+    Example:
+        window=2, margin=1, current=6     1 ... 4 5 [6] 7 8 ... 11 
+        window=2, margin=0, current=1     [1] 2 3 4 5 ...
+        window=2, margin=0, current=5     ... 3 4 [5] 6 7 ...
+        window=2, margin=0, current=11     ... 7 8 9 10 [11]

         """
         """

+
+    if window < 0:
+        raise Exception, 'Parameter "window" cannot be less than zero'
+    if margin < 0:
+        raise Exception, 'Parameter "margin" cannot be less than zero'
+

     try:
         paginator = context['paginator']
         page_obj = context['page_obj']
     try:
         paginator = context['paginator']
         page_obj = context['page_obj']


@@ -139,71 +155,43 @@ def paginate(context, window=DEFAULT_WINDOW, hashtag=''):
         records['last'] = records['first'] + paginator.per_page - 1
         if records['last'] + paginator.orphans >= paginator.count:
             records['last'] = paginator.count
         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)
+
+        # figure window
+        window_start = page_obj.number - window - 1
+        window_end = page_obj.number + window
+        # solve if window exceeded page range
+        if window_start < 0:
+            window_end = window_end - window_start
+            window_start = 0
+        if window_end > paginator.num_pages:
+            window_start = window_start - (window_end - paginator.num_pages)
+            window_end = paginator.num_pages
+        pages = page_range[window_start:window_end]
+
+        # figure margin and add elipses
+        if margin > 0:
+            # figure margin
+            tmp_pages = set(pages)
+            tmp_pages = tmp_pages.union(page_range[:margin])
+            tmp_pages = tmp_pages.union(page_range[-margin:])
+            tmp_pages = list(tmp_pages)
+            tmp_pages.sort()
+            pages = []
+            pages.append(tmp_pages[0])
+            for i in range(1, len(tmp_pages)):
+                # figure gap size => add elipses or fill in gap
+                gap = tmp_pages[i] - tmp_pages[i - 1]
+                if gap >= 3:
+                    pages.append(None)
+                elif gap == 2:
+                    pages.append(tmp_pages[i] - 1)
+                pages.append(tmp_pages[i])

         else:
         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:
+            if pages[0] != 1:
+                pages.insert(0, None)
+            if pages[-1] != paginator.num_pages:

                 pages.append(None)
                 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,
         to_return = {
             'MEDIA_URL': settings.MEDIA_URL,
             'pages': pages,

diff --git a/pagination/tests.py b/pagination/tests.py
index 31b3301..ecdb156 100644 (file)
--- a/pagination/tests.py
+++ b/pagination/tests.py
@@ -25,134 +25,109 @@
 >>> paginate({'paginator': p, 'page_obj': p.page(1)})['pages']
 [1, 2, 3, 4, 5, 6, 7, 8, 9]
 
 >>> 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)
+# on start
+# moving the window from 1 ... to end
+# window size = 2, margin = 2
+# [1] 2 3 4 5 ... 15, 16
+# 1 [2] 3 4 5 ... 15, 16
+# 1 2 [3] 4 5 ... 15, 16
+# 1 2 3 [4] 5 6 ... 15, 16
+# 1 2 3 4 [5] 6 7 ... 15, 16
+# 1 2 3 4 5 [6] 7 8 ... 15, 16
+# 1 2 ... 5 6 [7] 8 9 ... 15, 16
+
+# window = 2 -> show 5 pages
+>>> p = Paginator(range(31), 2)
+>>> paginate({'paginator': p, 'page_obj': p.page(1)}, 2, '', 2)['pages']
+[1, 2, 3, 4, 5, None, 15, 16]
+
+>>> p = Paginator(range(31), 2)
+>>> paginate({'paginator': p, 'page_obj': p.page(2)}, 2, '', 2)['pages']
+[1, 2, 3, 4, 5, None, 15, 16]
+
+>>> p = Paginator(range(31), 2)
+>>> paginate({'paginator': p, 'page_obj': p.page(3)}, 2, '', 2)['pages']
+[1, 2, 3, 4, 5, None, 15, 16]
+
+>>> p = Paginator(range(31), 2)
+>>> paginate({'paginator': p, 'page_obj': p.page(4)}, 2, '', 2)['pages']
+[1, 2, 3, 4, 5, 6, None, 15, 16]
+
+>>> p = Paginator(range(31), 2)
+>>> paginate({'paginator': p, 'page_obj': p.page(5)}, 2, '', 2)['pages']
+[1, 2, 3, 4, 5, 6, 7, None, 15, 16]
+
+# in the middle
+>>> p = Paginator(range(31), 2)
+>>> paginate({'paginator': p, 'page_obj': p.page(7)}, 2, '', 2)['pages']
+[1, 2, None, 5, 6, 7, 8, 9, None, 15, 16]
+
+# on end
+>>> p = Paginator(range(31), 2)
+>>> paginate({'paginator': p, 'page_obj': p.page(16)}, 2, '', 2)['pages']
+[1, 2, None, 12, 13, 14, 15, 16]
+
+>>> p = Paginator(range(31), 2)
+>>> paginate({'paginator': p, 'page_obj': p.page(13)}, 2, '', 2)['pages']
+[1, 2, None, 11, 12, 13, 14, 15, 16]
+
+
+>>> p = Paginator(range(0), 2)

 >>> paginate({'paginator': p, 'page_obj': p.page(1)})['pages']
 >>> paginate({'paginator': p, 'page_obj': p.page(1)})['pages']

-[1, 2, 3, 4, None, 8, 9, 10, 11]
+[1]
+
+
+
+# no margin
+>>> p = Paginator(range(31), 2)
+>>> paginate({'paginator': p, 'page_obj': p.page(3)}, 2, '', 0)['pages']
+[1, 2, 3, 4, 5, None]
+
+>>> p = Paginator(range(31), 2)
+>>> paginate({'paginator': p, 'page_obj': p.page(5)}, 2, '', 0)['pages']
+[None, 3, 4, 5, 6, 7, None]
+
+>>> p = Paginator(range(31), 2)
+>>> paginate({'paginator': p, 'page_obj': p.page(16)}, 2, '', 0)['pages']
+[None, 12, 13, 14, 15, 16]
+
+
+# special
+# zero window, zero margin
+>>> p = Paginator(range(31), 2)
+>>> paginate({'paginator': p, 'page_obj': p.page(1)}, 0, '', 0)['pages']
+[1, None]
+
+>>> p = Paginator(range(31), 2)
+>>> paginate({'paginator': p, 'page_obj': p.page(2)}, 0, '', 0)['pages']
+[None, 2, None]
+
+>>> p = Paginator(range(31), 2)
+>>> paginate({'paginator': p, 'page_obj': p.page(3)}, 0, '', 0)['pages']
+[None, 3, None]
+
+>>> p = Paginator(range(31), 2)
+>>> paginate({'paginator': p, 'page_obj': p.page(10)}, 0, '', 0)['pages']
+[None, 10, None]
+
+>>> p = Paginator(range(31), 2)
+>>> paginate({'paginator': p, 'page_obj': p.page(14)}, 0, '', 0)['pages']
+[None, 14, None]
+
+>>> p = Paginator(range(31), 2)
+>>> paginate({'paginator': p, 'page_obj': p.page(15)}, 0, '', 0)['pages']
+[None, 15, None]
+
+>>> p = Paginator(range(31), 2)
+>>> paginate({'paginator': p, 'page_obj': p.page(16)}, 0, '', 0)['pages']
+[None, 16]
+
+>>> p = Paginator(range(31), 2)
+>>> paginate({'paginator': p, 'page_obj': p.page(5)}, 0, '', 1)['pages']
+[1, None, 5, None, 16]
+

 
 

-# 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')

 """
 """

diff --git a/tests/runtests.py b/tests/runtests.py
index 6fb4b93..ee06564 100644 (file)
--- a/tests/runtests.py
+++ b/tests/runtests.py
@@ -9,7 +9,7 @@ os.environ['DJANGO_SETTINGS_MODULE'] = 'settings'
 from django.test.simple import run_tests
 
 if __name__ == "__main__":
 from django.test.simple import run_tests
 
 if __name__ == "__main__":

-    failures = run_tests(['pagination',], verbosity=9)
+    failures = run_tests(['pagination', ], verbosity=1)

     if failures:
         sys.exit(failures)
     # Reset the DJANGO_SETTINGS_MODULE to what it was before running tests.
     if failures:
         sys.exit(failures)
     # Reset the DJANGO_SETTINGS_MODULE to what it was before running tests.