Merge lp:~akretion-team/project-service/project-service-base-sale-project into lp:~project-core-editors/project-service/trunk

[Sébastien BEAU - http://www.akretion.com]

Hi,
We are cleanning and improving our OpenERP, so we plan to contribute everything here !
Let's start with some basic module
Here it's just a base module in order to link correctly a project and a sale order and also to create a project from a sale order.
No big thing, it's an base module that can be usefull in many case

Thanks for your review

[Pedro Manuel Baeza (pedro.baeza)]

Hi, Sébastien, some remarks from a quick scan:

- Why do you need to declare a new field 'true_project_id' instead of using existing 'project_id'?
- You can put auto_install to True so that if sale and project are installed, this module is automatically installed.
- A similar module that glues sale and stock is called sale_stock. Maybe you can call yours sale_project.

Thanks for the contribution.

Regards.

review: Needs Information (code review)

[Sébastien BEAU - http://www.akretion.com (sebastien.beau)]

Hi Pedro

In fact this module is not a glue it more a base module for our modules (they will be contributed). But we think other project can need it so it why I push it here right now.

This module just add basic but usefull link between order and project and give the possibility to create a project from the sale order. I am not sure that it's a good idea to install it by default, I think it's better to install it only if it's needed. This is why I call it base_sale_project because it should be use as dependency of other module.

Regarding the field "project_id". In our case we need to have a real link between the sale order and the project. As "project_id" is already used for adding a link with... analytic.account :'(. We need to have a field that point on the "project.project" we don't found a better name than "true_project_id". The best will to clean addons code... and replace "project_id" by "analytic_account_id"

Thanks for your feedback

[Pedro Manuel Baeza (pedro.baeza)]

Yeah, you're right about project_id relation with analytic account instead of the project.

About names and so on, it's a matter of taste, so I'm not going to object.

I have checked code and seems OK, so I give my approval.

What is what we expect next?

Regards.

review: Approve (code review)

[Daniel Reis (dreis-pt)]

Thanks for the contribution!

Generating Projects from Sales Orders is a possible workflow.
But generating Tasks from Sales orders is also a valid workflow.
So I don't think it's a good idea to have it "autoinstall"ed.

I agree with Pedro on the two other issues:
- "base_*" modules are usually core functionality related; how about "sale_project_base"?
- I also find that "true_project_id" is not very intuitive. How about something like "related_project_id" or "sale_project_id"?

Nitpicks:
L66: s/posibility/possibility
L182: methods intended to be called by a button tend to be called "action_*". I suggest renaming this to "action_create_project()".
L188: I believe the context==None control can be safely removed here

Another suggestion (could be a later improvement):
- It would be nice for the create button to return an action, so that it opens the created Project after the button is clicked; like the Issue's "Create Task" button (standard in v6, ported to v7 in a project-service module).

review: Needs Information

[lp:~akretion-team/project-service/project-service-base-sale-project]

38. By Sébastien BEAU - http://www.akretion.com on 2014-03-20

[REF] change module name, rename method linked to the button, remove useless context is None

[Sébastien BEAU - http://www.akretion.com (sebastien.beau)]

@Daniel
I did the change, the name sale_project_base seem perfect for me.

For the field name, we should found something that contrast with the native "project_id" to avoid confusion. Developper that read the code should be alarmed by the name of the field.

Maybe "real_project_id"? What do you think?

note : related_project_id is great also. Pedro which one do you prefers?

[Pedro Manuel Baeza (pedro.baeza)]

I think related_project_id can be intuitive enough and not a shocking name.

Daniel suggestions are good for me too.

Regards.

[Raphaël Valyi - http://www.akretion.com (rvalyi)]

IMHO real_project_id and true_project id looks the same.
For us keeping true_project_id would make migration easier...
I also think "true_project_id" carries enough "subversive meta information" to make it clear that if a foreign key points to an analytic account and not to a project, may be it was not a good idea to call it "project_id".

Thoughts?

[Daniel Reis (dreis-pt)]

If you're already using the module, changing a field name is rather painful, and it probably isn't worth the effort. So, no objections there.

It would also be nice to add the i18n/.po file, but I won't pick on that.

review: Approve (lgtm, no test)

[Daniel Reis (dreis-pt)]

PS: Raphael, having a "project_id" field pointing at a Analytic Account is the kind of thing that bring emotion to OpenERP ;-)

[lp:~akretion-team/project-service/project-service-base-sale-project]

39. By Sébastien BEAU - http://www.akretion.com on 2014-03-20

[REF] rename true_project_id into related_project_id

40. By Sébastien BEAU - http://www.akretion.com on 2014-03-20

[IMP] add translation file

[Sébastien BEAU - http://www.akretion.com (sebastien.beau)]

I talk with Raph.
Even if we have to migrate our work, the later we will do the change the more painful it will be so let's rename it!
I also add the .po file

Thanks for your feedback

Just one question what is the best name for the onchange method?
- onchange_my_field
- on_my_field_change
-....

[Pedro Manuel Baeza (pedro.baeza)]

I use to call it onchange_fieldname: compact and indicating the field name.

Regards.

[lp:~akretion-team/project-service/project-service-base-sale-project]

41. By Sébastien BEAU - http://www.akretion.com on 2014-03-20

[REF] rename onchange and pass the context

[Sébastien BEAU - http://www.akretion.com (sebastien.beau)]

Yes is seem to be the best option, let's update my code

=== added directory 'sale_project_base'
=== added file 'sale_project_base/__init__.py'
--- sale_project_base/__init__.py	1970-01-01 00:00:00 +0000
+++ sale_project_base/__init__.py	2014-03-20 19:06:11 +0000
@@ -0,0 +1,26 @@
+# -*- coding: utf-8 -*-
+###############################################################################
+#
+#   Module for OpenERP
+#   Copyright (C) 2014 Akretion (http://www.akretion.com).
+#   Copyright (C) 2010-2013 Akretion LDTA (<http://www.akretion.com>)
+#   @author Sébastien BEAU <[e-mail]>
+#   @author Benoît GUILLOT <[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/>.
+#
+###############################################################################
+
+from . import sale
+from . import project

=== added file 'sale_project_base/__openerp__.py'
--- sale_project_base/__openerp__.py	1970-01-01 00:00:00 +0000
+++ sale_project_base/__openerp__.py	2014-03-20 19:06:11 +0000
@@ -0,0 +1,43 @@
+# -*- coding: utf-8 -*-
+###############################################################################
+#
+#   Module for OpenERP
+#   Copyright (C) 2010-2013 Akretion LDTA (<http://www.akretion.com>).
+#   Copyright (C) 2013 Akretion (http://www.akretion.com).
+#   @author Benoît GUILLOT <[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': 'Sale Project Base',
+    'version': '7.0',
+    'category': 'Generic Modules/Others',
+    'license': 'AGPL-3',
+    'description': """This module is a base module that give the possibility to
+    create a project from a quotation""",
+    'author': 'Akretion',
+    'website': 'http://www.akretion.com/',
+    'depends': [
+        'project',
+        'sale',
+    ],
+    'demo': [],
+    'data': [
+        'sale_view.xml',
+    ],
+    'installable': True,
+}

=== added directory 'sale_project_base/i18n'
=== added file 'sale_project_base/i18n/sale_project_base.po'
--- sale_project_base/i18n/sale_project_base.po	1970-01-01 00:00:00 +0000
+++ sale_project_base/i18n/sale_project_base.po	2014-03-20 19:06:11 +0000
@@ -0,0 +1,38 @@
+# Translation of OpenERP Server.
+# This file contains the translation of the following modules:
+#	* sale_project_base
+#
+msgid ""
+msgstr ""
+"Project-Id-Version: OpenERP Server 7.0\n"
+"Report-Msgid-Bugs-To: \n"
+"POT-Creation-Date: 2014-03-20 17:47+0000\n"
+"PO-Revision-Date: 2014-03-20 17:47+0000\n"
+"Last-Translator: <>\n"
+"Language-Team: \n"
+"MIME-Version: 1.0\n"
+"Content-Type: text/plain; charset=UTF-8\n"
+"Content-Transfer-Encoding: \n"
+"Plural-Forms: \n"
+
+#. module: sale_project_base
+#: model:ir.model,name:sale_project_base.model_project_project
+#: field:sale.order,related_project_id:0
+msgid "Project"
+msgstr ""
+
+#. module: sale_project_base
+#: model:ir.model,name:sale_project_base.model_sale_order
+msgid "Sales Order"
+msgstr ""
+
+#. module: sale_project_base
+#: view:sale.order:0
+msgid "Create Project"
+msgstr ""
+
+#. module: sale_project_base
+#: field:project.project,order_ids:0
+msgid "Orders"
+msgstr ""
+

=== added file 'sale_project_base/project.py'
--- sale_project_base/project.py	1970-01-01 00:00:00 +0000
+++ sale_project_base/project.py	2014-03-20 19:06:11 +0000
@@ -0,0 +1,37 @@
+# -*- coding: utf-8 -*-
+###############################################################################
+#
+#   Module for OpenERP
+#   Copyright (C) 2014 Akretion (http://www.akretion.com).
+#   Copyright (C) 2010-2013 Akretion LDTA (<http://www.akretion.com>)
+#   @author Sébastien BEAU <[e-mail]>
+#   @author Benoît GUILLOT <[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/>.
+#
+###############################################################################
+
+
+from openerp.osv import fields, orm
+
+
+class project_project(orm.Model):
+    _inherit = "project.project"
+
+    _columns = {
+        'order_ids': fields.one2many(
+            'sale.order',
+            'related_project_id',
+            'Orders'),
+        }

=== added file 'sale_project_base/sale.py'
--- sale_project_base/sale.py	1970-01-01 00:00:00 +0000
+++ sale_project_base/sale.py	2014-03-20 19:06:11 +0000
@@ -0,0 +1,69 @@
+# -*- coding: utf-8 -*-
+###############################################################################
+#
+#   Module for OpenERP
+#   Copyright (C) 2014 Akretion (http://www.akretion.com).
+#   Copyright (C) 2010-2013 Akretion LDTA (<http://www.akretion.com>)
+#   @author Sébastien BEAU <[e-mail]>
+#   @author Benoît GUILLOT <[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/>.
+#
+###############################################################################
+
+from openerp.osv import fields, orm
+from datetime import date
+
+
+class sale_order(orm.Model):
+    _inherit = "sale.order"
+
+    _columns = {
+        'related_project_id': fields.many2one(
+            'project.project',
+            'Project',
+            readonly=True,
+            states={'draft': [('readonly', False)]}
+        ),
+    }
+
+    def onchange_related_project_id(self, cr, uid, ids, related_project_id, context=None):
+        project_obj = self.pool['project.project']
+        if related_project_id:
+            project = project_obj.browse(cr, uid, related_project_id, context=context)
+            return {'value': {'project_id': project.analytic_account_id.id}}
+        return {}
+
+    def _prepare_project_vals(self, cr, uid, order, context=None):
+        name = u" %s - %s - %s" % (
+            order.partner_id.name,
+            date.today().year,
+            order.name)
+        return {
+            'user_id': order.user_id.id,
+            'name': name,
+            'partner_id': order.partner_id.id,
+        }
+
+    def action_create_project(self, cr, uid, ids, context=None):
+        project_obj = self.pool['project.project']
+        for order in self.browse(cr, uid, ids, context=context):
+            vals = self._prepare_project_vals(cr, uid, order, context)
+            project_id = project_obj.create(cr, uid, vals, context=context)
+            project = project_obj.browse(cr, uid, project_id, context=context)
+            order.write({
+                'related_project_id': project_id,
+                'project_id': project.analytic_account_id.id
+            })
+        return True

=== added file 'sale_project_base/sale_view.xml'
--- sale_project_base/sale_view.xml	1970-01-01 00:00:00 +0000
+++ sale_project_base/sale_view.xml	2014-03-20 19:06:11 +0000
@@ -0,0 +1,28 @@
+<?xml version="1.0" encoding="utf-8"?>
+<openerp>
+    <data>
+        
+        <record id="view_order_form" model="ir.ui.view">
+            <field name="name">view_project_quotation_order_form</field>
+            <field name="model">sale.order</field>
+            <field name="inherit_id" ref="sale.view_order_form" />
+            <field name="arch" type="xml">
+                <field name="project_id" position="replace">
+                    <field name="project_id" invisible="1" />
+                    <group col="4" colspan="2">
+                        <field name="related_project_id"
+                               on_change="onchange_related_project_id(related_project_id, context)"
+                               domain="[('partner_id','=',partner_id)]"
+                               attrs="{'readonly':[('partner_id','=', False)]}"/>
+                        <group attrs="{'invisible':[('related_project_id', '!=', False)]}">
+                            <button name="action_create_project" states="draft"
+                                    string="Create Project"
+                                    type="object" icon="gtk-execute" />
+                        </group>
+                    </group>
+                </field>
+            </field>
+        </record>
+
+    </data>
+</openerp>