Changeset 3744

Timestamp:

11/20/07 21:35:43 (8 months ago)

Author:

roger

Message:

Fix #1618:

• paginate's default_reversed is deprecated with a warning.
  
• paginate's default_order can handle a string or a list of strings, where every string started with a dash indicates a reverse ordering.
  
• refactoring of tests (and + tests covering this feature)
  

Thanks to Joel Pearson for bringing this nice idea to ML.

Files:

• branches/1.0/CHANGELOG.txt (modified) (2 diffs)
• branches/1.0/turbogears/paginate.py (modified) (5 diffs)
• branches/1.0/turbogears/tests/test_paginate.py (modified) (5 diffs)

branches/1.0/CHANGELOG.txt

@@ -5 +5 @@
-1.0.4:
-----------------------------
+
+Deprecations
+~~~~~~~~~~~~
+
+* Paginate ``default_order`` has been greatly improved. Use of the 
+  ``default_reversed`` parameter has been deprecated. It will still be used
+  if it is informed, but a DeprecationWarning will be displayed.
-
-Changes
@@ -32 +39 @@
-  should raise a redirect when current page is out of bound and the
-  last page is requested, respectively.
+* Paginate ``default_order`` can now be a string or a list of strings.
+  The list of string is used to specify the ordering of multiple columns.
+  Every string starting with a dash (``-``) indicates that the column will 
+  have its default ordering reversed (#1618).
-
-Fixes

branches/1.0/turbogears/paginate.py

@@ -3 +3 @@
-from math import ceil
-import logging
+import warnings
-
-import cherrypy
@@ -41 +42 @@
-_simulate_offset = None
-
-Fals
+Non
-            allow_limit_override=False, max_pages=5, dynamic_limit=None):
-    '''
@@ -51 +52 @@
-
-    @param default_order: Needs work! XXX
-
+
+
-
-    @param default_reversed: Needs work! XXX
-
+ [Deprecated]
-
-    @param limit: the hard coded limit that the paginate decorator will
@@ -88 +90 @@
-                return default
-
+            if default_reversed is not None:
+                warnings.warn(
+                    "default_reversed is deprecated. Use default_order='-field'"
+                    " to indicate default reversed order or"
+                    " default_order=['field1', '-field2, 'field3']"
+                    " for multiple fields", DeprecationWarning, 2)
+
-            get = turbogears.config.get
-
@@ -144 +153 @@
-
-            elif default_order and not ordering:
-
+
+
+
+
+
+
+
+
+
+
+
-            elif ordering and order:
-                sort_ordering(ordering, order)

branches/1.0/turbogears/tests/test_paginate.py

@@ -266 +266 @@
-        empty = paginate("data", limit=4)(empty)
-        empty = expose()(empty)
+    # end of MyRoot ------------------------------------------------------------
-
-
@@ -525 +526 @@
-
-    class MyRoot(RootController):
-basic
+__common
-            if method == "Q":
-                data = session.query(Address)
@@ -538 +539 @@
-                      order=None, row_count=16)
-            return dict(data=data, spy=spy)
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
-
-        def related(self):
@@ -566 +589 @@
-        related = paginate("data", default_order="id")(related)
-        related = expose("turbogears.tests.paginate")(related)
+
+    # end of MyRoot ------------------------------------------------------------
-
-    def setUp(self):
@@ -577 +602 @@
-
-    def test_basic(self):
+        for test in "basic1", "basic2":
+            for method in "Q", "SR", "SO":
+                self.request("/%s/?method=%s" % (test, method))
+                self.assert_order(1, 2, 3, 4, 5, 6, 7, 8, 9, 10)
+                Spy.assert_ok(self.body, 'current_page', 1)
+                Spy.assert_ok(self.body, 'first_item', 1)
+                Spy.assert_ok(self.body, 'last_item', 10)
+                Spy.assert_ok(self.body, 'ordering', {'id': [0, True]})
+
+                # old style
+                self.request("/%s/?method=%s&tg_paginate_no=2" % (test, method))
+                self.assert_order(11, 12, 13, 14, 15, 16)
+                Spy.assert_ok(self.body, 'current_page', 2)
+                Spy.assert_ok(self.body, 'first_item', 11)
+                Spy.assert_ok(self.body, 'last_item', 16)
+                Spy.assert_ok(self.body, 'ordering', {'id': [0, True]})
+
+                # new style
+                self.request("/%s/?method=%s&data_tgp_no=2" % (test, method))
+                self.assert_order(11, 12, 13, 14, 15, 16)
+                Spy.assert_ok(self.body, 'current_page', 2)
+                Spy.assert_ok(self.body, 'first_item', 11)
+                Spy.assert_ok(self.body, 'last_item', 16)
+                Spy.assert_ok(self.body, 'ordering', {'id': [0, True]})
+
+    def test_ordering(self):
+        for test in "basic1", "basic2":
+            for method in "Q", "SR", "SO":
+                self.request("/%s/?method=%s&tg_paginate_ordering=%s" % \
+                    (test, method, quote(str({'street': [0, True]}))))
+                self.assert_order(16, 2, 3, 4, 5, 6, 7, 8, 9, 10)
+                Spy.assert_ok(self.body, 'current_page', 1)
+                Spy.assert_ok(self.body, 'first_item', 1)
+                Spy.assert_ok(self.body, 'last_item', 10)
+                Spy.assert_ok(self.body, 'ordering', {'street': [0, True]})
+
+                self.request("/%s/?method=%s&tg_paginate_no=2&tg_paginate_ordering=%s" % \
+                    (test, method, quote(str({'street': [0, True]}))))
+                self.assert_order(11, 12, 13, 14, 15, 1)
+                Spy.assert_ok(self.body, 'current_page', 2)
+                Spy.assert_ok(self.body, 'first_item', 11)
+                Spy.assert_ok(self.body, 'last_item', 16)
+                Spy.assert_ok(self.body, 'ordering', {'street': [0, True]})
+
+    def test_default_reversed(self):
+        for test in "reversed1", "reversed2", "reversed3":
+            for method in "Q", "SR", "SO":
+                self.request("/%s/?method=%s" % (test, method))
+                self.assert_order(16, 15, 14, 13, 12, 11, 10, 9, 8, 7)
+                Spy.assert_ok(self.body, 'current_page', 1)
+                Spy.assert_ok(self.body, 'first_item', 1)
+                Spy.assert_ok(self.body, 'last_item', 10)
+                Spy.assert_ok(self.body, 'ordering', {'id': [0, False]})
+
+                self.request("/%s/?method=%s&data_tgp_no=2" % (test, method))
+                self.assert_order(6, 5, 4, 3, 2, 1)
+                Spy.assert_ok(self.body, 'current_page', 2)
+                Spy.assert_ok(self.body, 'first_item', 11)
+                Spy.assert_ok(self.body, 'last_item', 16)
+                Spy.assert_ok(self.body, 'ordering', {'id': [0, False]})
+
+    def test_invalid_default_reversed(self):
-        for method in "Q", "SR", "SO":
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
-        for method in "Q", "SR", "SO":
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
+
-            self.assert_order(16, 3, 9, 10, 12, 13, 1, 4, 7, 8)
-            Spy.assert_ok(self.body, 'ordering', {'city': [0, True], 'street': [1, True]})
-
-
-
+
-            self.assert_order(14, 15, 2, 5, 6, 11)
-            Spy.assert_ok(self.body, 'ordering', {'city': [0, True], 'street': [1, True]})
-
-
-
-
+
+
+
+
-            self.assert_order(1, 13, 12, 10, 9, 3, 16, 15, 14, 8)
-            Spy.assert_ok(self.body, 'ordering', {'city': [0, True], 'street': [1, False]})
-
-
-
+
-            self.assert_order(7, 4, 11, 6, 5, 2)
-            Spy.assert_ok(self.body, 'ordering', {'city': [0, True], 'street': [1, False]})
-
-
-
-
+
+
+
+
-            self.assert_order(2, 5, 6, 11, 4, 7, 8, 14, 15, 16)
-            Spy.assert_ok(self.body, 'ordering', {'city': [0, False], 'street': [1, True]})
-
-
-
+
-            self.assert_order(3, 9, 10, 12, 13, 1)
-            Spy.assert_ok(self.body, 'ordering', {'city': [0, False], 'street': [1, True]})
-
-
-
-
+
+
+
+
-            self.assert_order(11, 6, 5, 2, 15, 14, 8, 7, 4, 1)
-            Spy.assert_ok(self.body, 'ordering', {'city': [0, False], 'street': [1, False]})
-
-
-
+
-            self.assert_order(13, 12, 10, 9, 3, 16)
-            Spy.assert_ok(self.body, 'ordering', {'city': [0, False], 'street': [1, False]})