Merge lp:~akretion-team/server-env-tools/module-configuration-helper-dbl into lp:~server-env-tools-core-editors/server-env-tools/7.0

[David BEAL (ak)]

[ADD] module configuration_helper

add module configuration_helper

This module :

  * create automatically related fields in 'whatiwant.config.settings'
    using those defined in 'res.company' : it avoid duplicated field definitions.
  * company_id field with default value is created
  * onchange_company_id is defined to update all related fields
  * supported fields: char, text, integer, float, datetime, date, boolean, m2o

[Yannick Vaucher @ Camptocamp (yvaucher-c2c)]

Used it to create a config and works well.

Code review

l.161 + l.163 + l.172 please remove commented print line

l.226 no need to quote me for this code I took it from
addons/account/res_config.py

review: Needs Fixing (test + code review)

[David BEAL (ak) (davidbeal)]

@yannick

I have fixed it.

Your code gave me the idea to do this module,
You have done an improvement revision 7

thanks to you

[Yannick Vaucher @ Camptocamp (yvaucher-c2c)]

still you can remove l.223

Otherwise LGTM

review: Approve (code review and test)

[David BEAL (ak) (davidbeal)]

Here is a concrete example

http://bazaar.launchpad.net/~akretion-team/carriers-deliveries/7-delivery-carrier-coliposte/view/head:/delivery_carrier_colipostefr/company.py

http://bazaar.launchpad.net/~akretion-team/carriers-deliveries/7-delivery-carrier-coliposte/view/head:/delivery_carrier_colipostefr/config.py

Fields are only defined in 'res.company' but are also available in 'colipostefr.config.settings'.

[Florian da Costa (florian-dacosta)]

I now use it for delivery_carrier_chronopost and it work well!
Thanks David

review: Approve (test)

[Yannick Vaucher @ Camptocamp (yvaucher-c2c)]

Hello David,

I'm ok to merge this, I even tried to merge it before this project goes on Github. However, it seems you created that module on an empty branch.

Could you redo/rebase this?

Might be better to do it directly in git ?

review: Needs Resubmitting

Unmerged revisions

9. By David BEAL (ak) on 2014-05-23

[FIX] condition in field_to_populate_as_related() to limit fields related creation

8. By David BEAL (ak) on 2014-05-21

[FIX] remove print strings

7. By yvaucher-c2c on 2014-03-11

[MERGE] from lp:~camptocamp/server-env-tools/module-configuration-helper-yvr

6. By David BEAL (ak) on 2014-03-06

[IMP] add a prefix to related fields in ...config.settings

5. By David BEAL (ak) on 2014-03-01

[IMP] complete doc

4. By David BEAL (ak) on 2014-03-01

[IMP] add create method on AbstractConfigSettings

3. By David BEAL (ak) on 2014-03-01

[FIX] for m2o field

2. By David BEAL (ak) on 2014-03-01

[FIX] __init__ method + add doc

1. By David BEAL (ak) on 2014-02-28

[INIT] add configuration_helper module

=== added directory 'configuration_helper'
=== added file 'configuration_helper/__init__.py'
--- configuration_helper/__init__.py	1970-01-01 00:00:00 +0000
+++ configuration_helper/__init__.py	2014-05-23 12:54:31 +0000
@@ -0,0 +1,22 @@
+# -*- coding: utf-8 -*-
+##############################################################################
+#
+#    Author: David BEAL
+#    Copyright 2014 Akretion
+#
+#    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/>.
+#
+##############################################################################
+
+from . import config   # noqa
 
=== added file 'configuration_helper/__openerp__.py'
--- configuration_helper/__openerp__.py	1970-01-01 00:00:00 +0000
+++ configuration_helper/__openerp__.py	2014-05-23 12:54:31 +0000
@@ -0,0 +1,82 @@
+# -*- coding: utf-8 -*-
+##############################################################################
+#
+#    Author: David BEAL
+#    Copyright 2014 Akretion
+#
+#    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': 'Configuration Helper',
+    'version': '0.8',
+    'author': 'Akretion',
+    'maintainer': 'Akretion',
+    'category': 'server',
+    'complexity': 'normal',
+    'depends': ['base'],
+    'description': """
+Configuration Helper
+====================
+
+*This module is intended for developer only. It does nothing used alone.*
+
+This module :
+
+  * create automatically related fields in 'whatiwant.config.settings'
+    using those defined in 'res.company' : it avoid duplicated field definitions.
+  * company_id field with default value is created
+  * onchange_company_id is defined to update all related fields
+  * supported fields: char, text, integer, float, datetime, date, boolean, m2o
+
+
+How to use
+----------
+
+.. code-block:: python
+
+    from . company import ResCompany
+
+    class WhatiwantClassSettings(orm.TransientModel):
+        _inherit = ['res.config.settings', 'abstract.config.settings']
+        _name = 'whatiwant.config.settings'
+        # fields must be defined in ResCompany class
+        # related fields are automatically generated from previous definitions
+        _companyObject = ResCompany
+
+
+Roadmap
+-------
+  * support (or check support) for these field types : o2m, m2m, reference, property, selection
+  * automatically generate a default view for 'whatiwant.config.settings' (in --debug ?)
+
+
+Contributors
+------------
+
+* David BEAL <[e-mail]>
+* Sébastien BEAU <[e-mail]>
+* Yannick Vaucher, Camptocamp, (code refactoring from his module 'delivery_carrier_label_postlogistics')
+
+ """,
+    'website': 'http://www.akretion.com/',
+    'data': [
+    ],
+    'tests': [],
+    'installable': True,
+    'auto_install': False,
+    'license': 'AGPL-3',
+    'application': True,
+}
 
=== added file 'configuration_helper/config.py'
--- configuration_helper/config.py	1970-01-01 00:00:00 +0000
+++ configuration_helper/config.py	2014-05-23 12:54:31 +0000
@@ -0,0 +1,114 @@
+# -*- coding: utf-8 -*-
+##############################################################################
+#
+#    Author: David BEAL, Copyright 2014 Akretion
+#
+#    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/>.
+#
+##############################################################################
+import re
+
+from openerp.osv import orm, fields
+
+
+class AbstractConfigSettings(orm.AbstractModel):
+    _name = 'abstract.config.settings'
+    _description = 'Abstract configuration settings'
+    # prefix field name to differentiate fields in company with those in config
+    _prefix = 'setting_'
+    # this is the class name to import in your module
+    # (it should be ResCompany or res_company, depends of your code)
+    _companyObject = None
+
+    def _filter_field(self, field_key):
+        """Inherit in your module to define for which company field
+        you don't want have a matching related field"""
+        return True
+
+    def __init__(self, pool, cr):
+        super(AbstractConfigSettings, self).__init__(pool, cr)
+        if self._companyObject:
+            for field_key in self._companyObject._columns:
+                #allows to exclude some field
+                if self._filter_field(field_key):
+                    args = ('company_id', field_key)
+                    kwargs = {
+                        'string': self._companyObject._columns[field_key].string,
+                        'help': self._companyObject._columns[field_key].help,
+                        'type': self._companyObject._columns[field_key]._type,
+                    }
+                    if '_obj' in self._companyObject._columns[field_key].__dict__.keys():
+                        kwargs['relation'] = \
+                            self._companyObject._columns[field_key]._obj
+                    if '_domain' in \
+                            self._companyObject._columns[field_key].__dict__.keys():
+                        kwargs['domain'] = \
+                            self._companyObject._columns[field_key]._domain
+                    field_key = re.sub('^' + self._prefix, '', field_key)
+                    self._columns[field_key] = \
+                        fields.related(*args, **kwargs)
+
+    _columns = {
+        'company_id': fields.many2one(
+            'res.company',
+            'Company',
+            required=True),
+    }
+
+    def _default_company(self, cr, uid, context=None):
+        user = self.pool['res.users'].browse(cr, uid, uid, context=context)
+        return user.company_id.id
+
+    _defaults = {
+        'company_id': _default_company,
+    }
+
+    def field_to_populate_as_related(self, cr, uid, field, company_cols, context=None):
+        """Only fields which comes from company with the right prefix
+           must be defined as related"""
+        if self._prefix + field in company_cols:
+            return True
+        return False
+
+    def onchange_company_id(self, cr, uid, ids, company_id, context=None):
+        " update related fields "
+        values = {}
+        values['currency_id'] = False
+        if not company_id:
+            return {'value': values}
+        company_m = self.pool['res.company']
+        company = company_m.browse(
+            cr, uid, company_id, context=context)
+        company_cols = company_m._columns.keys()
+        for field in self._columns:
+            if self.field_to_populate_as_related(
+                    cr, uid, field, company_cols, context=context):
+                cpny_field = self._columns[field].arg[-1]
+                if self._columns[field]._type == 'many2one':
+                    values[field] = company[cpny_field]['id'] or False
+                else:
+                    values[field] = company[cpny_field]
+        return {'value': values}
+
+    def create(self, cr, uid, values, context=None):
+        id = super(AbstractConfigSettings, self).create(
+            cr, uid, values, context=context)
+        # Hack: to avoid some nasty bug, related fields are not written
+        # upon record creation.  Hence we write on those fields here.
+        vals = {}
+        for fname, field in self._columns.iteritems():
+            if isinstance(field, fields.related) and fname in values:
+                vals[fname] = values[fname]
+        self.write(cr, uid, [id], vals, context)
+        return id