Merge lp:~ajite/web-addons/7.0-web-addons-add-0001 into lp:~webaddons-core-editors/web-addons/7.0

[Augustin Cisterne-Kaas - www.elico-corp.com]

Added a polymorphic widget based on many2one widget (different from reference field).
Use case available at https://www.openerp.com/apps/7.0/mail_organizer/

[Sylvain LE GAL (GRAP) (sylvain-legal)]

Hi,

Thanks for your MP.

2 little thinks :
1/ maybe it could be great to rename the module with the type of the field. Something like : 'web_many2one_polymorphic'.

2/ I tested your code with the mail_organizer module available on lp.

In this module,if new_model is 'none' and I click to select a new ressource, it's raise an Error. Maybe the widget have to manage this case.

Log below :

Traceback (most recent call last):
  File "~/ocb-server/openerp/netsvc.py", line 292, in dispatch_rpc
    result = ExportService.getService(service_name).dispatch(method, params)
  File "~/ocb-server/openerp/service/web_services.py", line 626, in dispatch
    res = fn(db, uid, *params)
  File "~/ocb-server/openerp/osv/osv.py", line 190, in execute_kw
    return self.execute(db, uid, obj, method, *args, **kw or {})
  File "~/ocb-server/openerp/osv/osv.py", line 132, in wrapper
    return f(self, dbname, *args, **kwargs)
  File "~/ocb-server/openerp/osv/osv.py", line 199, in execute
    res = self.execute_cr(cr, uid, obj, method, *args, **kw)
  File "~/ocb-server/openerp/osv/osv.py", line 186, in execute_cr
    raise except_osv('Object Error', 'Object %s doesn\'t exist' % str(obj))

Regards.

review: Needs Fixing (code review, test)

[lp:~ajite/web-addons/7.0-web-addons-add-0001]

24. By Augustin Cisterne-Kaas - www.elico-corp.com on 2014-03-13

[FIX] polymorphic widget is set to readonly if linked model value is none

[Augustin Cisterne-Kaas - www.elico-corp.com (ajite)]

Hi Sylvain,

Thank you for your feedback.

Indeed 'web_many2one_polymorphic' is more accurate.

I found a fix using javascript but I am not sure it's the best solution.

[Sylvain LE GAL (GRAP) (sylvain-legal)]

Thanks for the changes.

I'll test the module again next week.

Regards.

[Augustin Cisterne-Kaas - www.elico-corp.com (ajite)]

Thanks,

Don't forget to rename the module dependence web_polymorphic to web_many2one_polymorphic in the mail organizer __openerp__.py

Regards

[Augustin Cisterne-Kaas - www.elico-corp.com (ajite)]

Would not web_polymorphic_many2one be a better name (more generic) ?

[Guewen Baconnier @ Camptocamp (gbaconnier-c2c)]

> Would not web_polymorphic_many2one be a better name (more generic) ?

I think so.

Could you document in the manifest how the field should be declared in python (in `_columns`)?

Thanks

review: Needs Information

[Augustin Cisterne-Kaas - www.elico-corp.com (ajite)]

Hi Guewen,

Thanks for your feedback.

Do you mean by manifest the "__openerp__.py" ?

Kind regards,

Augustin Cisterne-Kaas

[Guewen Baconnier @ Camptocamp (gbaconnier-c2c)]

On 04/02/2014 03:40 AM, Augustin Cisterne-Kaas - www.elico-corp.com wrote:
> Hi Guewen,
>
> Thanks for your feedback.
>
> Do you mean by manifest the "__openerp__.py" ?
>
> Kind regards,
>
> Augustin Cisterne-Kaas
>

Yes

[lp:~ajite/web-addons/7.0-web-addons-add-0001]

25. By Augustin Cisterne-Kaas - www.elico-corp.com on 2014-04-11

[ADD] Fields declaration in manifest and renamed the module.

[Augustin Cisterne-Kaas - www.elico-corp.com (ajite)]

Dear all,

I have made the requested modifications.

Kind Regards,

Augustin Cisterne-Kaas

[Stefan Rijnhart (Opener) (stefan-opener)]

Is there a good reason why you did not make this a widget for the standard reference field type itself, instead of storing the model and the resource id separately?

review: Needs Information

[Augustin Cisterne-Kaas - www.elico-corp.com (ajite)]

Hi Stefan,

Thank you for your feedback,

Yes there is.

The standard reference field end result is serialized and therefore does not work for standard model such as "mail.message".

Kind Regards,

Augustin Cisterne-Kaas

[Stefan Rijnhart (Opener) (stefan-opener)]

Hi Augustin, thank you for your response. I know reference field values are stored in the form of '<model>,<id>'. How does this not work for mail.message?

[Holger Brunn (Therp) (hbrunn)]

Having model and id in separate fields allows you to do nifty stuff like
'my_mails': fields.one2many('mail.message', 'res_id', domain=['model', '=', 'my.model'])
and joins are a lot more efficient of course, which is why they used the split approach for mail.message.

You can of course wrap model and res_id in a function field which is a reference field, but then the UI to pick the correct model is unusable (remember all the trickery I had to suffer through for fetchmail_inbox).

With this, we can simply set the model in the context or in on_change (judging from the code, that should work too)

review: Approve (code review)

[Augustin Cisterne-Kaas - www.elico-corp.com (ajite)]

Yes, Exactly !

Thanks for answering :)

[Stefan Rijnhart (Opener) (stefan-opener)]

OK, thanks for the explanation! LGTM.

review: Approve

[Augustin Cisterne-Kaas - www.elico-corp.com (ajite)]

Hi,

Can that module be approved or should I change something ?

Regards,

Augustin Cisterne-Kaas

[Guewen Baconnier @ Camptocamp (gbaconnier-c2c)]

Hi Augustin,

LGTM finally!

Thanks for you work.

Since Sylvain's comments have been addressed, I'll merge it.

review: Approve (code review)

[Sylvain LE GAL (GRAP) (sylvain-legal)]

Hi.

Sorry, I totally forgot to review again that MP.

review: Abstain

[Augustin Cisterne-Kaas - www.elico-corp.com (ajite)]

Thanks a lot :)!

=== added directory 'web_polymorphic_many2one'
=== added file 'web_polymorphic_many2one/__init__.py'
--- web_polymorphic_many2one/__init__.py	1970-01-01 00:00:00 +0000
+++ web_polymorphic_many2one/__init__.py	2014-04-11 03:02:09 +0000
@@ -0,0 +1,21 @@
+# -*- coding: utf-8 -*-
+##############################################################################
+#
+#    OpenERP, Open Source Management Solution
+#    Copyright (c) 2010-2014 Elico Corp. All Rights Reserved.
+#    Augustin Cisterne-Kaas <[e-mail]>
+#
+#    This program is free software: you can redistribute it and/or modify
+#    it under the terms of the GNU Affero General Public License as
+#    published by the Free Software Foundation, either version 3 of the
+#    License, or (at your option) any later version.
+#
+#    This program is distributed in the hope that it will be useful,
+#    but WITHOUT ANY WARRANTY; without even the implied warranty of
+#    MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+#    GNU Affero General Public License for more details.
+#
+#    You should have received a copy of the GNU Affero General Public License
+#    along with this program.  If not, see <http://www.gnu.org/licenses/>.
+#
+##############################################################################

=== added file 'web_polymorphic_many2one/__openerp__.py'
--- web_polymorphic_many2one/__openerp__.py	1970-01-01 00:00:00 +0000
+++ web_polymorphic_many2one/__openerp__.py	2014-04-11 03:02:09 +0000
@@ -0,0 +1,49 @@
+# -*- coding: utf-8 -*-
+##############################################################################
+#
+#    OpenERP, Open Source Management Solution
+#    Copyright (c) 2010-2014 Elico Corp. All Rights Reserved.
+#    Augustin Cisterne-Kaas <[e-mail]>
+#
+#    This program is free software: you can redistribute it and/or modify
+#    it under the terms of the GNU Affero General Public License as
+#    published by the Free Software Foundation, either version 3 of the
+#    License, or (at your option) any later version.
+#
+#    This program is distributed in the hope that it will be useful,
+#    but WITHOUT ANY WARRANTY; without even the implied warranty of
+#    MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+#    GNU Affero General Public License for more details.
+#
+#    You should have received a copy of the GNU Affero General Public License
+#    along with this program.  If not, see <http://www.gnu.org/licenses/>.
+#
+##############################################################################
+{'name': 'Web Polymorphic Many2One',
+ 'version': '0.2',
+ 'category': 'Web',
+ 'depends': ['web'],
+ 'author': 'Elico Corp',
+ 'license': 'AGPL-3',
+ 'website': 'https://www.elico-corp.com',
+ 'description': """
+Add a new widget named "polymorphic"
+The polymorphic field allow to dynamically store an id linked to any model in
+OpenERP instead of the usual fixed one in the view definition
+
+
+Python fields declaration:
+
+    'model': fields.many2one('ir.model', string='Model'),
+    'object_id': fields.integer("Resource")
+
+XML fields declaration:
+
+    <field name="model" invisible="1" />
+    <field name="object_id" widget="polymorphic" polymorphic="model" />
+""",
+ 'js': [
+     'static/src/js/view_form.js'
+ ],
+ 'installable': True,
+ 'application': False}

=== added directory 'web_polymorphic_many2one/static'
=== added directory 'web_polymorphic_many2one/static/src'
=== added directory 'web_polymorphic_many2one/static/src/js'
=== added file 'web_polymorphic_many2one/static/src/js/view_form.js'
--- web_polymorphic_many2one/static/src/js/view_form.js	1970-01-01 00:00:00 +0000
+++ web_polymorphic_many2one/static/src/js/view_form.js	2014-04-11 03:02:09 +0000
@@ -0,0 +1,64 @@
+/******************************************************************************
+*
+*    OpenERP, Open Source Management Solution
+*    Copyright (c) 2010-2014 Elico Corp. All Rights Reserved.
+*    Augustin Cisterne-Kaas <[e-mail]>
+*
+*    This program is free software: you can redistribute it and/or modify
+*    it under the terms of the GNU Affero General Public License as
+*    published by the Free Software Foundation, either version 3 of the
+*    License, or (at your option) any later version.
+*
+*    This program is distributed in the hope that it will be useful,
+*    but WITHOUT ANY WARRANTY; without even the implied warranty of
+*    MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+*    GNU Affero General Public License for more details.
+*
+*    You should have received a copy of the GNU Affero General Public License
+*    along with this program.  If not, see <http://www.gnu.org/licenses/>.
+*
+******************************************************************************/
+openerp.web_polymorphic = function (instance) {
+    instance.web.form.FieldPolymorphic = instance.web.form.FieldMany2One.extend( {
+        template: "FieldMany2One",
+        events: {
+            'focus input': function(e) {
+                this.field.relation = this.field_manager.get_field_value(this.polymorphic);
+            },
+            'click input': function(e) {
+                this.field.relation = this.field_manager.get_field_value(this.polymorphic);
+            }
+        },
+        init: function(field_manager, node) {
+            this._super(field_manager, node);
+            this.polymorphic = this.node.attrs.polymorphic;
+        },
+        render_editable: function() {
+            var self = this;
+            this.$drop_down = this.$el.find(".oe_m2o_drop_down_button");
+            this.$drop_down.click(function() {
+                self.polymorphic = self.node.attrs.polymorphic;
+                self.field.relation = self.field_manager.get_field_value(self.polymorphic);              
+            });
+            this._super();
+            this.set_polymorphic_event();
+            this.set({
+                readonly: true
+            });
+
+        },
+        set_polymorphic_event: function() {
+            self = this;
+            this.field_manager.fields[this.polymorphic].$el.on(
+                'change', function(){
+                    field_value = self.field_manager.get_field_value(self.polymorphic);
+                    if(field_value !== false)
+                        self.set("effective_readonly", false);
+                    else
+                        self.set("effective_readonly", true);
+                }
+            );
+        }
+    });
+    instance.web.form.widgets.add('polymorphic', 'instance.web.form.FieldPolymorphic')
+};