[IMP] web_widget_x2many_2d_matrix: Several improvements

* README update to newest OCA template
* Example in README
* Massive performance boost for big matrices, specially on Firefox
* Assign id on row in order to find it back in all cases
* Fix #321, choked on cached writes

web_widget_x2many_2d_matrix/README.rst

@@ -1,3 +1,7 @@
+.. image:: https://img.shields.io/badge/licence-AGPL--3-blue.svg
+    :alt: License: AGPL-3
+
+===========================
 2D matrix for x2many fields
 ===========================
 
@@ -51,12 +55,41 @@ show_row_totals
 show_column_totals
     If field_value is a numeric field, calculate column totals
 
+Example
+=======
+
+You need a data structure already filled with values. Let's assume we want to use this widget in a wizard that lets the user fill in planned hours for one task per project per user. In this case, we can use ``project.task`` as our data model and point to it from our wizard. The crucial part is that we fill the field in the default function::
+
+ class MyWizard(models.TransientModel):
+    _name = 'my.wizard'
+
+    def _default_task_ids(self):
+        # your list of project should come from the context, some selection
+        # in a previous wizard or wherever else
+        projects = self.env['project.project'].browse([1, 2, 3])
+        # same with users
+        users = self.env['res.users'].browse([1, 2, 3])
+        return [
+            (0, 0, {'project_id': p.id, 'user_id': u.id, 'planned_hours': 0})
+            # if the project doesn't have a task for the user, create a new one
+            if not p.task_ids.filtered(lambda x: x.user_id == u) else
+            # otherwise, return the task
+            (4, p.task_ids.filtered(lambda x: x.user_id == u)[0].id)
+            for p in projects
+            for u in users
+        ]
+
+    task_ids = fields.Many2many('project.task', default=_default_task_ids)
+
+Now in our wizard, we can use::
+
+<field name="task_ids" widget="x2many_2d_matrix" field_x_axis="project_id" field_y_axis="user_id" field_value="planned_hours" />
+
 Known issues / Roadmap
 ======================
 
 * it would be worth trying to instantiate the proper field widget and let it render the input
 
-
 Bug Tracker
 ===========
 
@@ -65,7 +98,6 @@ In case of trouble, please check there if your issue has already been reported.
 If you spotted it first, help us smashing it by providing a detailed and welcomed feedback
 `here <https://github.com/OCA/web/issues/new?body=module:%20web_widget_x2many_2d_matrix%0Aversion:%208.0%0A%0A**Steps%20to%20reproduce**%0A-%20...%0A%0A**Current%20behavior**%0A%0A**Expected%20behavior**>`_.
 
-
 Credits
 =======
 
@@ -77,12 +109,14 @@ Contributors
 Maintainer
 ----------
 
-.. image:: http://odoo-community.org/logo.png
-    :alt: Odoo Community Association
-    :target: http://odoo-community.org
+.. image:: https://odoo-community.org/logo.png
+   :alt: Odoo Community Association
+   :target: https://odoo-community.org
 
 This module is maintained by the OCA.
 
-OCA, or the Odoo Community Association, is a nonprofit organization whose mission is to support the collaborative development of Odoo features and promote its widespread use.
+OCA, or the Odoo Community Association, is a nonprofit organization whose
+mission is to support the collaborative development of Odoo features and
+promote its widespread use.
 
-To contribute to this module, please visit http://odoo-community.org.
+To contribute to this module, please visit https://odoo-community.org.

web_widget_x2many_2d_matrix/static/src/js/web_widget_x2many_2d_matrix.js

@@ -31,6 +31,8 @@ openerp.web_widget_x2many_2d_matrix = function(instance)
         // those will be filled with rows from the dataset
         by_x_axis: {},
         by_y_axis: {},
+        by_id: {},
+        // configuration values
         field_x_axis: 'x',
         field_label_x_axis: 'x',
         field_y_axis: 'y',
@@ -81,6 +83,7 @@ openerp.web_widget_x2many_2d_matrix = function(instance)
 
             self.by_x_axis = {};
             self.by_y_axis = {};
+            self.by_id = {};
 
             return jQuery.when(result).then(function()
             {
@@ -90,7 +93,35 @@ openerp.web_widget_x2many_2d_matrix = function(instance)
                     self.is_numeric = fields[self.field_value].type == 'float';
                     self.show_row_totals &= self.is_numeric;
                     self.show_column_totals &= self.is_numeric;
-                }).then(function()
+                })
+                // if there are cached writes on the parent dataset, read below
+                // only returns the written data, which is not enough to properly
+                // set up our data structure. Read those ids here and patch the
+                // cache
+                .then(function()
+                {
+                    var ids_written = _.map(
+                        self.dataset.to_write, function(x) { return x.id });
+                    if(!ids_written.length)
+                    {
+                        return;
+                    }
+                    return (new instance.web.Query(self.dataset._model))
+                    .filter([['id', 'in', ids_written]])
+                    .all()
+                    .then(function(rows)
+                    {
+                        _.each(rows, function(row)
+                        {
+                            var cache = _.find(
+                                self.dataset.cache,
+                                function(x) { return x.id == row.id }
+                            );
+                            _.extend(cache.values, row, _.clone(cache.values));
+                        })
+                    })
+                })
+                .then(function()
                 {
                     return self.dataset.read_ids(self.dataset.ids).then(function(rows)
                     {
@@ -158,15 +189,31 @@ openerp.web_widget_x2many_2d_matrix = function(instance)
             });
         },
 
-        // to whatever needed to setup internal data structure
+        // do whatever needed to setup internal data structure
         add_xy_row: function(row)
         {
             var x = this.get_field_value(row, this.field_x_axis),
                 y = this.get_field_value(row, this.field_y_axis);
+            // row is a *copy* of a row in dataset.cache, fetch
+            // a reference to this row in order to have the
+            // internal data structure point to the same data
+            // the dataset manipulates
+            _.every(this.dataset.cache, function(cached_row)
+            {
+                if(cached_row.id == row.id)
+                {
+                    row = cached_row.values;
+                    // new rows don't have that
+                    row.id = cached_row.id;
+                    return false;
+                }
+                return true;
+            });
             this.by_x_axis[x] = this.by_x_axis[x] || {};
             this.by_y_axis[y] = this.by_y_axis[y] || {};
             this.by_x_axis[x][y] = row;
             this.by_y_axis[y][x] = row;
+            this.by_id[row.id] = row;
         },
 
         // get x axis values in the correct order
@@ -255,39 +302,38 @@ openerp.web_widget_x2many_2d_matrix = function(instance)
             var self = this,
                 grand_total = 0,
                 totals_x = {},
-                totals_y = {};
-            return self.dataset.read_ids(self.dataset.ids).then(function(rows)
+                totals_y = {},
+                rows = this.by_id,
+                deferred = jQuery.Deferred();
+            _.each(rows, function(row)
             {
-                _.each(rows, function(row)
-                {
-                    var key_x = self.get_field_value(row, self.field_x_axis),
-                        key_y = self.get_field_value(row, self.field_y_axis);
-                    totals_x[key_x] = (totals_x[key_x] || 0) + self.get_field_value(row, self.field_value);
-                    totals_y[key_y] = (totals_y[key_y] || 0) + self.get_field_value(row, self.field_value);
-                    grand_total += self.get_field_value(row, self.field_value);
-                });
-            }).then(function()
+                var key_x = self.get_field_value(row, self.field_x_axis),
+                    key_y = self.get_field_value(row, self.field_y_axis);
+                totals_x[key_x] = (totals_x[key_x] || 0) + self.get_field_value(row, self.field_value);
+                totals_y[key_y] = (totals_y[key_y] || 0) + self.get_field_value(row, self.field_value);
+                grand_total += self.get_field_value(row, self.field_value);
+            });
+            _.each(totals_y, function(total, y)
             {
-                _.each(totals_y, function(total, y)
-                {
-                    self.$el.find(
-                        _.str.sprintf('td.row_total[data-y="%s"]', y)).text(
-                            self.format_xy_value(total));
-                });
-                _.each(totals_x, function(total, x)
-                {
-                    self.$el.find(
-                        _.str.sprintf('td.column_total[data-x="%s"]', x)).text(
-                            self.format_xy_value(total));
-                });
-                self.$el.find('.grand_total').text(
-                    self.format_xy_value(grand_total))
-                return {
-                    totals_x: totals_x,
-                    totals_y: totals_y,
-                    grand_total: grand_total,
-                };
+                self.$el.find(
+                    _.str.sprintf('td.row_total[data-y="%s"]', y)).text(
+                        self.format_xy_value(total));
+            });
+            _.each(totals_x, function(total, x)
+            {
+                self.$el.find(
+                    _.str.sprintf('td.column_total[data-x="%s"]', x)).text(
+                        self.format_xy_value(total));
+            });
+            self.$el.find('.grand_total').text(
+                self.format_xy_value(grand_total))
+            deferred.resolve({
+                totals_x: totals_x,
+                totals_y: totals_y,
+                grand_total: grand_total,
+                rows: rows,
             });
+            return deferred;
         },
 
         setup_many2one_axes: function()