From 079e90afbbe657d8c6c746a5911e27446302facd Mon Sep 17 00:00:00 2001
From: Xavier Morel <xmo@openerp.com>
Date: Tue, 10 Jul 2012 14:37:18 +0200
Subject: [PATCH] [ADD] successor method to list collections, to safely get the
 "next" record in a nested (groupby) context

bzr revid: xmo@openerp.com-20120710123718-kiot6zzji07a4iao
---
 addons/web/static/src/js/view_list.js         | 31 +++++++++--
 .../web/static/src/js/view_list_editable.js   |  8 +--
 addons/web/static/test/list-utils.js          | 51 ++++++++++++++++---
 3 files changed, 71 insertions(+), 19 deletions(-)

diff --git a/addons/web/static/src/js/view_list.js b/addons/web/static/src/js/view_list.js
index 7c82d2b173f..2d1a06173cd 100644
--- a/addons/web/static/src/js/view_list.js
+++ b/addons/web/static/src/js/view_list.js
@@ -1849,7 +1849,7 @@ var Collection = instance.web.Class.extend(/** @lends Collection# */{
      * @returns this
      */
     remove: function (record) {
-        var index = _(this.records).indexOf(record);
+        var index = this.indexOf(record);
         if (index === -1) {
             _(this._proxies).each(function (proxy) {
                 proxy.remove(record);
@@ -1885,12 +1885,14 @@ var Collection = instance.web.Class.extend(/** @lends Collection# */{
 
     // underscore-type methods
     find: function (callback) {
-        var record = null;
+        var record;
         for(var section in this._proxies) {
-            if (this._proxies.hasOwnProperty(section)) {
-                record = this._proxies[section].find(callback);
+            if (!this._proxies.hasOwnProperty(section)) {
+                continue
+            }
+            if ((record = this._proxies[section].find(callback))) {
+                return record;
             }
-            if (record) { return record; }
         }
         for(var i=0; i<this.length; ++i) {
             record = this.records[i];
@@ -1923,6 +1925,25 @@ var Collection = instance.web.Class.extend(/** @lends Collection# */{
     },
     indexOf: function (record) {
         return _(this.records).indexOf(record);
+    },
+    succ: function (record, options) {
+        options = options || {wraparound: false};
+        var result;
+        for(var section in this._proxies) {
+            if (!this._proxies.hasOwnProperty(section)) {
+                continue
+            }
+            if ((result = this._proxies[section].succ(record, options))) {
+                return result;
+            }
+        }
+        var index = this.indexOf(record);
+        if (index === -1) { return null; }
+        var next_index = index + 1;
+        if (options.wraparound && (next_index === this.length)) {
+            return this.at(0);
+        }
+        return this.at(next_index);
     }
 });
 Collection.include(Events);
diff --git a/addons/web/static/src/js/view_list_editable.js b/addons/web/static/src/js/view_list_editable.js
index 1fb99966eeb..61ee6698452 100644
--- a/addons/web/static/src/js/view_list_editable.js
+++ b/addons/web/static/src/js/view_list_editable.js
@@ -359,12 +359,8 @@ openerp.web.list_editable = function (instance) {
                 if (saveInfo.created) {
                     return self.startEdition();
                 }
-                var next_index = self.records.indexOf(saveInfo.record) + 1;
-                if (next_index === self.records.length) {
-                    next_index = 0;
-                }
-
-                return self.startEdition(self.records.at(next_index));
+                return self.startEdition(
+                    self.records.succ(saveInfo.record, {wraparound: true}));
             });
         },
         keyup_ESCAPE: function () {
diff --git a/addons/web/static/test/list-utils.js b/addons/web/static/test/list-utils.js
index 97d7ec90cfc..18069943b2d 100644
--- a/addons/web/static/test/list-utils.js
+++ b/addons/web/static/test/list-utils.js
@@ -133,7 +133,7 @@ $(document).ready(function () {
         strictEqual(changed, 1);
     });
 
-    module('list-collections-degenerate', {
+    module('list-collections', {
         setup: function () {
             openerp = window.openerp.init([]);
             window.openerp.web.corelib(openerp);
@@ -145,7 +145,7 @@ $(document).ready(function () {
             window.openerp.web.list(openerp);
         }
     });
-    test('Fetch from collection', function () {
+    test('degenerate-fetch', function () {
         var c = new openerp.web.list.Collection();
         strictEqual(c.length, 0);
         c.add({id: 1, value: 2});
@@ -163,7 +163,7 @@ $(document).ready(function () {
         strictEqual(r2.get('id'), 1);
         strictEqual(r2.get('value'), 2);
     });
-    test('Add at index', function () {
+    test('degenerate-indexed-add', function () {
         var c = new openerp.web.list.Collection([
             {id: 1, value: 5},
             {id: 2, value: 10},
@@ -175,7 +175,7 @@ $(document).ready(function () {
         strictEqual(c.at(1).get('value'), 55);
         strictEqual(c.at(3).get('value'), 20);
     });
-    test('Remove record', function () {
+    test('degenerate-remove', function () {
         var c = new openerp.web.list.Collection([
             {id: 1, value: 5},
             {id: 2, value: 10},
@@ -188,7 +188,7 @@ $(document).ready(function () {
         equal(c.get(2), undefined);
         strictEqual(c.at(1).get('value'), 20);
     });
-    test('Remove unbind', function () {
+    test('degenerate-remove-bound', function () {
         var changed = false,
             c = new openerp.web.list.Collection([ {id: 1, value: 5} ]);
         c.bind('change', function () { changed = true; });
@@ -198,7 +198,7 @@ $(document).ready(function () {
         ok(!changed, 'removed records should not trigger events in their ' +
                      'parent collection');
     });
-    test('Reset', function () {
+    test('degenerate-reset', function () {
         var event, obj, c = new openerp.web.list.Collection([
             {id: 1, value: 5},
             {id: 2, value: 10},
@@ -218,7 +218,7 @@ $(document).ready(function () {
         strictEqual(c.length, 1);
         strictEqual(c.get(42).get('value'), 55);
     });
-    test('Reset unbind', function () {
+    test('degenerate-reset-bound', function () {
         var changed = false,
             c = new openerp.web.list.Collection([ {id: 1, value: 5} ]);
         c.bind('change', function () { changed = true; });
@@ -229,7 +229,7 @@ $(document).ready(function () {
                      'parent collection');
     });
 
-    test('Events propagation', function () {
+    test('degenerate-propagations', function () {
         var values = [];
         var c = new openerp.web.list.Collection([
             {id: 1, value: 5},
@@ -260,6 +260,41 @@ $(document).ready(function () {
         c.at(1).set('wealth', 5);
         strictEqual(total, 47);
     });
+    test('degenerate-successor', function () {
+        var root = new openerp.web.list.Collection([
+            {id: 1, value: 1},
+            {id: 2, value: 2},
+            {id: 3, value: 3},
+            {id: 4, value: 5},
+            {id: 5, value: 8},
+        ]);
+
+        deepEqual(root.succ(root.at(2)).attributes,
+                  root.at(3).attributes,
+                  "should return the record at (index + 1) from the pivot");
+        equal(root.succ(root.at(4)), null,
+              "should return null as successor to last record");
+        deepEqual(root.succ(root.at(4), {wraparound: true}).attributes,
+                  root.at(0).attributes,
+                  "should return index 0 as successor to last record if" +
+                  " wraparound is set");
+    });
+    test('successor', function () {
+        var root = new openerp.web.list.Collection();
+        root.proxy('first').add([{id: 1, value: 1}, {id: 2, value: 2}]);
+        root.proxy('second').add([{id: 3, value: 3}, {id: 4, value: 5}]);
+        root.proxy('third').add([{id: 5, value: 8}, {id: 6, value: 13}]);
+
+        deepEqual(root.succ(root.get(3)).attributes,
+                  root.get(4).attributes,
+                  "should get successor");
+        equal(root.succ(root.get(4)),
+              null,
+              "successors do not cross collections");
+        deepEqual(root.succ(root.get(4), {wraparound: true}).attributes,
+                  root.get(3).attributes,
+                  "should wraparound within a collection");
+    });
 
     module('list-hofs', {
         setup: function () {