Changeset 3735

Timestamp:

11/19/07 21:17:32 (1 year ago)

Author:

roger

Message:

Fix #1617:

• Paginate decorator ensures page number is between 1 and page_count.
  
• Adapt PaginateDataGrid? template to make use of paginate.href_xxxx attributes.
  
• Introduce 2 new parameters: paginate.redirect_on_out_of_range and paginate.redirect_on_last_page.
  
• + Tests
  

Files:

• branches/1.0/CHANGELOG.txt (modified) (3 diffs)
• branches/1.0/turbogears/paginate.py (modified) (6 diffs)
• branches/1.0/turbogears/qstemplates/quickstart/+package+/config/app.cfg_tmpl (modified) (1 diff)
• branches/1.0/turbogears/tests/test_paginate.py (modified) (5 diffs)
• branches/1.0/turbogears/widgets/templates/paginate_datagrid.kid (modified) (4 diffs)

branches/1.0/CHANGELOG.txt

@@ -8 +8 @@
-    * Introduction of tg.mochikit_suppress to prevent the inclusion of
-      the shipped MochiKit 1.3.1. That allows to include custom mochikit versions.
+    * PaginateDataGrid template now makes use of paginate attributes to render
+      the links for first/previous/next/last page.
+    * paginate.href_last returns a special URL that allows paginate decorator
+      to compute the correct last page number at server-side.
-
-*Features*
@@ -18 +22 @@
-    * The tg-admin quickstart command has now an option --svn allowing
-      automatic creation of the project in the specified SVN repository.
+    * Introduction of paginate.redirect_on_out_of_range and
+      paginate.redirect_on_last_page, which determine if paginate decorator
+      should raise a redirect when current page is out of bound and the
+      last page is requested, respectively.
-
-*Fixes*
@@ -25 +33 @@
-    * Tickets #1458, #1599 and #1604. Fixed SQLAlchemy and Elixir issues.
-    * Ticket #1608. Fixed issues with tg-admin update on a project in SVN.
-: Fix pagination of SQLAlchemy Query ordering by backrefs 
- 
+. Fix pagination of SQLAlchemy Query ordering by backrefs
+
-      removed the "properties" accessor on Mapper.
-    * Ticket #1605. Ensure paginate links bring the same result when using
-      ordering columns with a custom datagrid template.
-
+
+
-
-*Contributors*

branches/1.0/turbogears/paginate.py

@@ -26 +26 @@
-
-import turbogears
+from turbogears.controllers import redirect
-from turbogears.decorator import weak_signature_decorator
-from turbogears.view import variable_providers
@@ -87 +88 @@
-                return default
-
-
+
+
+
+
+
+
+
+
+
+
+
+
+
-            limit_ = int(
-                kwpop(limit, var_name + '_tgp_limit', 'tg_paginate_limit'))
@@ -169 +182 @@
-                            var_data))
-
+            page_count = int(ceil(float(row_count)/limit_))
+
+            if page > page_count:
+                page = max(page_count, 1)
+                if get('paginate.redirect_on_out_of_range'):
+                    cherrypy.request.params[var_name + '_tgp_no'] = page
+                    redirect(cherrypy.request.path, cherrypy.request.params)
+
+            if page is None:
+                page = max(page_count, 1)
+                if get('paginate.redirect_on_last_page'):
+                    cherrypy.request.params[var_name + '_tgp_no'] = page
+                    redirect(cherrypy.request.path, cherrypy.request.params)
+
-            offset = (page-1) * limit_
-            page_count = int(ceil(float(row_count)/limit_))
-
-            # if it's possible display every page
@@ -211 +237 @@
-
-            global _simulate_offset
-            get = turbogears.config.get
-            if _simulate_offset is None:
-                _simulate_offset = get('paginate.simulate_offset', None)
@@ -263 +288 @@
-        self.ordering = ordering
-        self.row_count = row_count
-(current_page - 1) * limit + 1
+page_count and ((current_page - 1) * limit + 1) or 0
-        self.last_item = min(current_page * limit, row_count)
-        self.reversed = False
@@ -287 +312 @@
-                self.input_values)
-            self.input_values.update({
-page_count
+'last'
-                var_name + '_tgp_limit': limit
-            })

branches/1.0/turbogears/qstemplates/quickstart/+package+/config/app.cfg_tmpl

@@ -40 +40 @@
-# Set to True if the scheduler should be started
-# tg.scheduler = False
+
+# Set to True to allow paginate decorator redirects when page number gets
+# out of bound. Useful for getting the real page id in the url
+# paginate.redirect_on_out_of_range = True
+
+# Set to True to allow paginate decorator redirects when last page is requested.
+# This is useful for getting the real last page id in the url
+# paginate.redirect_on_last_page = True
-
-# Set session or cookie

branches/1.0/turbogears/tests/test_paginate.py

@@ -5 +5 @@
-
-from turbogears import config, expose, database
-
+, url
-from turbogears.database import get_engine, metadata, session, mapper
-from turbogears.paginate import paginate, sort_ordering
@@ -85 +85 @@
-            " , ".join(["%s=%r" % (k,v) for k,v in paginate.__dict__.items()])
-
-
+, raw=False
-        assert "ok: [paginate" in body
-
+
+
+
+
-        if expr not in body:
-            print body
@@ -161 +164 @@
-        body = cherrypy.response.body[0]
-        assert "fail: paginate does not have 'foobar' attribute" in body
+
+    def test_raw_expectation(self):
+        create_request('/spy_correct_expectation')
+        Spy.assert_ok(cherrypy.response.body[0], 'var_name', 'data')
+        Spy.assert_ok(cherrypy.response.body[0], 'var_name', "'data'", raw=True)
-
-
@@ -250 +258 @@
-        multiple = expose()(multiple)
-
+        def empty(self):
+            spy = Spy(var_name='data', pages=[], limit=4, page_count=0,
+                      order=None, ordering={}, row_count=0,
+                      current_page=1, first_item=0, last_item=0)
+            data = []
+            return dict(data=data, spy=spy)
+        empty = paginate("data", limit=4)(empty)
+        empty = expose()(empty)
+
-
-    def setUp(self):
@@ -375 +392 @@
-        assert '"bar": ["U", "V", "W", "X", "Y", "Z"]' in self.body
-
-
-
-
-
-
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
-
-

branches/1.0/turbogears/widgets/templates/paginate_datagrid.kid

@@ -1 +1 @@
-<div xmlns:py="http://purl.org/kid/ns#">
-
-
+
-    <tr>
-        <td>
@@ -8 +7 @@
-                    <td width="50" align="right">
-                        &nbsp;
-not tg.paginate.current_page == 1
-get_href(1)
-get_href(tg.paginate.current_page-1)
+tg.paginate.href_prev
+href_first
+href_prev
-                        </span>
-                    </td>
@@ -22 +21 @@
-                    </td>
-                    <td width="50">
-pages and not tg.paginate.current_page == tg.paginate.page_coun
-get_href(tg.paginate.current_page+1)
-get_href(tg.paginate.page_count)
+href_nex
+href_next
+href_last
-                        </span>
-                        &nbsp;
-                    </td>
-    
-        
+
+
-        </td>
-    </tr>
@@ -37 +36 @@
-            <thead py:if="columns">
-              <th py:for="i, col in enumerate(columns)" class="col_${i}">
- 
+
-                    href="${tg.paginate.get_href(1, col.name, col.get_option('reverse_order', False))}">${col.title}</a>
-                <span py:if="not getattr(tg, 'paginate', False) or not col.get_option('sortable', False)" py:replace="col.title"/>