Merge lp:~camptocamp/sale-wkfl/7.0-add-sale-default-discount-lep into lp:~sale-core-editors/sale-wkfl/7.0

[Leonardo Pistone]

[Pedro Manuel Baeza (pedro.baeza)]

Hi, Leonardo,

Thanks for the MP.

I'm seeing the code, and I feel more comfortable having the field called as default_sale_discount, or at least sale_discount, not only discount, because partners can be also suppliers.

About the functionality itself, I'm not seeing in the code the part that applies this default value to sale order lines. Where it is?

Regards.

review: Needs Information (code review)

[lp:~camptocamp/sale-wkfl/7.0-add-sale-default-discount-lep]

50. By Leonardo Pistone on 2014-07-18

rename field to sale_default_discount

As suggested by Pedro

51. By Leonardo Pistone on 2014-07-18

add tests to sale_default_discount

As discussed in the yaml file itself, I hit a situation where manual testing
works, but a default value does not show in the order line when in a yaml
test.

I prefer not to write extra production code just to make already working code
pass yaml tests. If YAML code are meant to be full-stack integrated tests (I
got the impression they are, since for example they run onchange methods),
then this looks like a bug in the yaml processor.

[Leonardo Pistone (lepistone)]

Pedro,

I renamed the field as you suggested.

The default in the line works because of the attribute "context" in sale.xml. Thanks to Romain Deheele for showing me that.

I also added two tests, and got a bit frustrated when I realized that the YAML test does not get the same behaviour of manual testing (all is OK when manual testing). More details in the commit message and the yaml file.

A broader discussion we could continue later on the community list is: what are yaml tests supposed to test?

Thanks

[Yann Papouin (yann-papouin)]

Just for the record, the almost same result can be achieved with a product.pricelist by checking the visible_discount field and setting this pricelist as the sale one in the partner form.

[Leonardo Pistone (lepistone)]

Yann,

you are right. Still, this module came out from a situation where pricelists were already used for other things, and a simple default discount was useful anyway.

[Pedro Manuel Baeza (pedro.baeza)]

This project is now hosted on https://github.com/OCA/sale-workflow. Please move your proposal there. This guide may help you https://github.com/OCA/maintainers-tools/wiki/How-to-move-a-Merge-Proposal-to-GitHub

review: Needs Resubmitting

[Leonardo Pistone (lepistone)]

migrated to https://github.com/OCA/sale-workflow/pull/74

Unmerged revisions

51. By Leonardo Pistone on 2014-07-18

add tests to sale_default_discount

As discussed in the yaml file itself, I hit a situation where manual testing
works, but a default value does not show in the order line when in a yaml
test.

I prefer not to write extra production code just to make already working code
pass yaml tests. If YAML code are meant to be full-stack integrated tests (I
got the impression they are, since for example they run onchange methods),
then this looks like a bug in the yaml processor.

50. By Leonardo Pistone on 2014-07-18

rename field to sale_default_discount

As suggested by Pedro

49. By Leonardo Pistone on 2014-07-17

[add] new module sale_default_discount

=== added directory 'sale_default_discount'
=== added file 'sale_default_discount/__init__.py'
--- sale_default_discount/__init__.py	1970-01-01 00:00:00 +0000
+++ sale_default_discount/__init__.py	2014-07-18 08:39:44 +0000
@@ -0,0 +1,22 @@
+# -*- coding: utf-8 -*-
+##############################################################################
+#
+#    Author: Leonardo Pistone
+#    Copyright 2014 Camptocamp SA
+#
+#    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 model  # noqa

=== added file 'sale_default_discount/__openerp__.py'
--- sale_default_discount/__openerp__.py	1970-01-01 00:00:00 +0000
+++ sale_default_discount/__openerp__.py	2014-07-18 08:39:44 +0000
@@ -0,0 +1,56 @@
+# -*- coding: utf-8 -*-
+##############################################################################
+#
+#    Author: Leonardo Pistone
+#    Copyright 2014 Camptocamp SA
+#
+#    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 Default Discount',
+    'version': '1.0',
+    'category': 'Generic Modules/Sale',
+    'description': """
+Sale Default Discount
+=====================
+
+This module allows to set a default discount per customer and per sale order.
+
+The customer discount is used by default when creating an order, and the
+order default is used when creating new order lines.
+
+The defaults can be left empty, keeping the default behaviour.
+
+Contributors
+------------
+
+  * Leonardo Pistone <[e-mail]>
+
+""",
+    'author': 'Camptocamp',
+    'depends': ['sale'],
+    'website': 'http://www.camptocamp.com',
+    'data': [
+        'view/partner.xml',
+        'view/sale.xml',
+    ],
+    'test': [
+        'test/no_default_discount.yml',
+        'test/partner_default_discount.yml',
+    ],
+    'demo': [],
+    'installable': True,
+    'active': False,
+}

=== added directory 'sale_default_discount/model'
=== added file 'sale_default_discount/model/__init__.py'
--- sale_default_discount/model/__init__.py	1970-01-01 00:00:00 +0000
+++ sale_default_discount/model/__init__.py	2014-07-18 08:39:44 +0000
@@ -0,0 +1,23 @@
+# -*- coding: utf-8 -*-
+##############################################################################
+#
+#    Author: Leonardo Pistone
+#    Copyright 2014 Camptocamp SA
+#
+#    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 partner  # noqa
+from . import sale  # noqa

=== added file 'sale_default_discount/model/partner.py'
--- sale_default_discount/model/partner.py	1970-01-01 00:00:00 +0000
+++ sale_default_discount/model/partner.py	2014-07-18 08:39:44 +0000
@@ -0,0 +1,34 @@
+# -*- coding: utf-8 -*-
+##############################################################################
+#
+#    Author: Leonardo Pistone
+#    Copyright 2014 Camptocamp SA
+#
+#    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 orm, fields
+import openerp.addons.decimal_precision as dp
+
+
+class Partner(orm.Model):
+    _inherit = 'res.partner'
+
+    _columns = {
+        'sale_default_discount': fields.float(
+            'Default sale discount (%)',
+            digits_compute=dp.get_precision('discount'),
+        ),
+    }

=== added file 'sale_default_discount/model/sale.py'
--- sale_default_discount/model/sale.py	1970-01-01 00:00:00 +0000
+++ sale_default_discount/model/sale.py	2014-07-18 08:39:44 +0000
@@ -0,0 +1,47 @@
+# -*- coding: utf-8 -*-
+##############################################################################
+#
+#    Author: Leonardo Pistone
+#    Copyright 2014 Camptocamp SA
+#
+#    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 orm, fields
+import openerp.addons.decimal_precision as dp
+
+
+class SaleOrder(orm.Model):
+    _inherit = 'sale.order'
+
+    _columns = {
+        'discount': fields.float(
+            'Default discount (%)',
+            digits_compute=dp.get_precision('discount'),
+            help='This discount is used by default when creating new lines',
+        ),
+    }
+
+    def onchange_partner_id(self, cr, uid, ids, partner_id, context=None):
+        result = super(SaleOrder, self).onchange_partner_id(
+            cr, uid, ids, partner_id, context=context)
+
+        if partner_id:
+            partner = self.pool['res.partner'].browse(
+                cr, uid, partner_id, context=context)
+            if partner.sale_default_discount:
+                result['value']['discount'] = partner.sale_default_discount
+
+        return result

=== added directory 'sale_default_discount/test'
=== added file 'sale_default_discount/test/no_default_discount.yml'
--- sale_default_discount/test/no_default_discount.yml	1970-01-01 00:00:00 +0000
+++ sale_default_discount/test/no_default_discount.yml	2014-07-18 08:39:44 +0000
@@ -0,0 +1,21 @@
+-
+  I create a sale order with an unmodified partner
+-
+  !record {model: sale.order, id: order1}:
+    partner_id: base.res_partner_1
+-
+  I check that the order discount is unchanged
+-
+  !assert {model: sale.order, id: order1, string: Discount should be zero}:
+    - discount == 0
+-
+  I add a line
+-
+  !record {model: sale.order.line, id: line1}:
+    name: line with no discount
+    order_id: order1
+-
+  I check that the line discount is unchanged
+-
+  !assert {model: sale.order.line, id: line1, string: Discount should be zero}:
+    - discount == 0

=== added file 'sale_default_discount/test/partner_default_discount.yml'
--- sale_default_discount/test/partner_default_discount.yml	1970-01-01 00:00:00 +0000
+++ sale_default_discount/test/partner_default_discount.yml	2014-07-18 08:39:44 +0000
@@ -0,0 +1,30 @@
+-
+  I set a default discount on a partner
+-
+  !record {model: res.partner, id: base.res_partner_2}:
+    sale_default_discount: 32.0
+-
+  I create a sale order with a partner with default discount
+-
+  !record {model: sale.order, id: order2}:
+    partner_id: base.res_partner_2
+-
+  I check that the order discount is set
+-
+  !assert {model: sale.order, id: order2, string: Order discount should be set}:
+    - discount == 32.0
+-
+  I add a line
+-
+  !record {model: sale.order.line, id: line2}:
+    name: discounted line
+    order_id: order2
+-
+  Now I would like to assert that discount == 32.0, and I promise that It works
+  when testing manually the webclient. Unfortunately, discount is zero when
+  we use a yaml test. I leave that assertion in the hope of reactivating it 
+  soon, and at least to test that the process does not crash.
+-
+  !assert {model: sale.order.line, id: line2, string: Line discount should be set}:
+    - discount in (0.0, 32.0)
+

=== added directory 'sale_default_discount/view'
=== added file 'sale_default_discount/view/partner.xml'
--- sale_default_discount/view/partner.xml	1970-01-01 00:00:00 +0000
+++ sale_default_discount/view/partner.xml	2014-07-18 08:39:44 +0000
@@ -0,0 +1,20 @@
+<?xml version="1.0" encoding="utf-8"?>
+<openerp>
+  <data>
+
+    <record id="view_partner_form" model="ir.ui.view">
+      <field name="name">view.partner.form</field>
+      <field name="model">res.partner</field>
+      <field name="inherit_id" ref="base.view_partner_form"/>
+      <field 
+        name="groups_id"
+        eval="[(6, 0, [ref('sale.group_discount_per_so_line')])]"/>
+      <field name="arch" type="xml">
+        <field name="user_id" position="after">
+          <field name="sale_default_discount"/>
+        </field>
+      </field>
+    </record>
+
+  </data>
+</openerp>

=== added file 'sale_default_discount/view/sale.xml'
--- sale_default_discount/view/sale.xml	1970-01-01 00:00:00 +0000
+++ sale_default_discount/view/sale.xml	2014-07-18 08:39:44 +0000
@@ -0,0 +1,34 @@
+<?xml version="1.0" encoding="utf-8"?>
+<openerp>
+  <data>
+
+    <record id="view_order_form" model="ir.ui.view">
+      <field name="name">sale.order.form</field>
+      <field name="model">sale.order</field>
+      <field name="inherit_id" ref="sale.view_order_form"/>
+      <field 
+        name="groups_id"
+        eval="[(6, 0, [ref('sale.group_discount_per_so_line')])]"/>
+      <field name="arch" type="xml">
+
+        <group name="sales_person" position="after">
+          <group>
+            <field 
+              name="discount" 
+              groups="sale.group_discount_per_so_line"/>
+          </group>
+        </group>
+
+        <field name="order_line" position="attributes">
+          <!-- that means: the default for the field "discount" on the line
+               comes from the field "discount" on the order -->
+          <attribute name="context">
+            {'default_discount': discount}
+          </attribute>
+        </field>
+
+      </field>
+    </record>
+
+  </data>
+</openerp>