Merge lp:~camptocamp/account-invoicing/account-invoicing_payment_term_rounding into lp:~account-core-editors/account-invoicing/7.0

[Yannick Vaucher @ Camptocamp]

Add module payment_term_rounding

[Guewen Baconnier @ Camptocamp (gbaconnier-c2c)]

s/rouding/rounding/ in __openerp__.py

In this code:

    def compute_line_amount(self, cr, uid, id, total_amount, remaining_amount, context=None):
        if isinstance(id, list):
            id = id[0]

I observed that tuple is usually an accepted type for the ids too.
When 'id' is a list, you should assert that the received length if 'id' is 1. Otherwise the programmer using your method might have unpredictable effects if he want to call it on multiple ids.

Proposal:
    def compute_line_amount(self, cr, uid, id, total_amount, remaining_amount, context=None):
        if isinstance(id, (tuple, list)):
            assert len(id) == 1, "compute_line_amount accepts only 1 ID"
            id = id[0]

When you format the dates, '%Y-%m-%d' should be replaced by openerp.tools.DEFAULT_SERVER_DATE_FORMAT

At l.157, the whole branch
    if amt:
        ....
Can be replace by
    if not amt:
        continue
    ...
This will avoid to nest all this part of code and you'll gain some width.

review: Needs Fixing

[Yannick Vaucher @ Camptocamp (yvaucher-c2c)]

I made the corrections

Thanks for the review

[Guewen Baconnier @ Camptocamp (gbaconnier-c2c)]

Thanks for the change

review: Approve (code review, no test)

[Frederic Clementi - Camptocamp (frederic-clementi)]

On functional aspect, it works great.

review: Approve

=== added directory 'payment_term_rounding'
=== added file 'payment_term_rounding/__init__.py'
--- payment_term_rounding/__init__.py	1970-01-01 00:00:00 +0000
+++ payment_term_rounding/__init__.py	2013-07-23 09:55:33 +0000
@@ -0,0 +1,21 @@
+# -*- coding: utf-8 -*-
+##############################################################################
+#
+#    Author: Yannick Vaucher
+#    Copyright 2013 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 account

=== added file 'payment_term_rounding/__openerp__.py'
--- payment_term_rounding/__openerp__.py	1970-01-01 00:00:00 +0000
+++ payment_term_rounding/__openerp__.py	2013-07-23 09:55:33 +0000
@@ -0,0 +1,34 @@
+# -*- coding: utf-8 -*-
+##############################################################################
+#
+#    Author: Yannick Vaucher
+#    Copyright 2013 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' : 'Rounding on payment term',
+ 'version' : '1.0',
+ 'category': 'Accounting',
+ 'description': """Giving rounding functionality at payment term line level """,
+ 'author' : 'Camptocamp',
+ 'maintainer': 'Camptocamp',
+ 'website': 'http://www.camptocamp.com/',
+ 'depends' : ['account'],
+ 'data': ['account_view.xml'],
+ 'test': [],
+ 'installable': True,
+ 'auto_install': False,
+ 'application': True,
+ }

=== added file 'payment_term_rounding/account.py'
--- payment_term_rounding/account.py	1970-01-01 00:00:00 +0000
+++ payment_term_rounding/account.py	2013-07-23 09:55:33 +0000
@@ -0,0 +1,104 @@
+# -*- coding: utf-8 -*-
+##############################################################################
+#
+#    Author: Yannick Vaucher
+#    Copyright 2013 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 datetime import datetime
+from dateutil.relativedelta import relativedelta
+import time
+
+from openerp.osv import orm, fields
+from openerp.tools.float_utils import float_round
+
+import openerp.addons.decimal_precision as dp
+from openerp.tools import DEFAULT_SERVER_DATE_FORMAT
+
+
+class AccountPaymentTermLine(orm.Model):
+    _inherit = "account.payment.term.line"
+    _columns = {
+        'amount_round': fields.float('Amount Rounding',
+            digits_compute=dp.get_precision('Account'),
+            help="Sets the amount so that it is a multiple of this value.\n"
+              "To have amounts that end in 0.99, set rounding 1, surcharge -0.01"
+            ),
+    }
+
+    def compute_line_amount(self, cr, uid, id, total_amount, remaining_amount, context=None):
+        """
+        Compute the amount for a payment term line.
+        In case of procent computation, use the payment
+        term line rounding if defined
+
+            :param total_amount: total balance to pay
+            :param remaining_amount: total amount minus sum of previous lines
+                computed amount
+            :returns: computed amount for this line
+        """
+        if isinstance(id, (tuple, list)):
+            assert len(id) == 1, "compute_line_amount accepts only 1 ID"
+            id = id[0]
+        obj_precision = self.pool.get('decimal.precision')
+        prec = obj_precision.precision_get(cr, uid, 'Account')
+        line = self.browse(cr, uid, id, context=context)
+        if line.value == 'fixed':
+            return float_round(line.value_amount, precision_digits=prec)
+        elif line.value == 'procent':
+            amt = total_amount * line.value_amount
+            if line.amount_round:
+                amt = float_round(amt, precision_rounding=line.amount_round)
+            return float_round(amt, precision_digits=prec)
+        elif line.value == 'balance':
+            amt = float_round(remaining_amount,  precision_digits=prec)
+        return None
+
+
+class AccountPaymentTerm(orm.Model):
+    _inherit = "account.payment.term"
+
+    def compute(self, cr, uid, id, value, date_ref=False, context=None):
+        """
+        Complete overwrite of compute method to add rounding on line computing
+        """
+
+        obj_precision = self.pool.get('decimal.precision')
+        prec = obj_precision.precision_get(cr, uid, 'Account')
+        if not date_ref:
+            date_ref = datetime.now().strftime(DEFAULT_SERVER_DATE_FORMAT)
+        pt = self.browse(cr, uid, id, context=context)
+        amount = value
+        result = []
+        for line in pt.line_ids:
+            amt = line.compute_line_amount(value, amount)
+            if not amt:
+                continue
+            next_date = (datetime.strptime(date_ref, DEFAULT_SERVER_DATE_FORMAT) + relativedelta(days=line.days))
+            if line.days2 < 0:
+                next_first_date = next_date + relativedelta(day=1,months=1) #Getting 1st of next month
+                next_date = next_first_date + relativedelta(days=line.days2)
+            if line.days2 > 0:
+                next_date += relativedelta(day=line.days2, months=1)
+            result.append( (next_date.strftime(DEFAULT_SERVER_DATE_FORMAT), amt) )
+            amount -= amt
+
+        amount = reduce(lambda x,y: x+y[1], result, 0.0)
+        dist = round(value-amount, prec)
+        if dist:
+            result.append( (time.strftime(DEFAULT_SERVER_DATE_FORMAT), dist) )
+        return result
+

=== added file 'payment_term_rounding/account_view.xml'
--- payment_term_rounding/account_view.xml	1970-01-01 00:00:00 +0000
+++ payment_term_rounding/account_view.xml	2013-07-23 09:55:33 +0000
@@ -0,0 +1,15 @@
+<?xml version="1.0" encoding="utf-8"?>
+<openerp>
+    <data>
+        <record id="view_payment_term_line_form" model="ir.ui.view">
+            <field name="name">account.payment.term.line.form.add.rounding</field>
+            <field name="model">account.payment.term.line</field>
+            <field name="inherit_id" ref="account.view_payment_term_line_form"/>
+            <field name="arch" type="xml">
+                <div attrs="{'invisible':[('value','=','balance')]}" position="after">
+                    <field name="amount_round" attrs="{'invisible':[('value','=','balance')]}"/>
+                </div>
+            </field>
+        </record>
+    </data>
+</openerp>

=== added directory 'payment_term_rounding/documentation'
=== added file 'payment_term_rounding/documentation/DOC_payment_terms_rounding.ods'
Binary files payment_term_rounding/documentation/DOC_payment_terms_rounding.ods	1970-01-01 00:00:00 +0000 and payment_term_rounding/documentation/DOC_payment_terms_rounding.ods	2013-07-23 09:55:33 +0000 differ