Merge pull request #118 from akretion/8.0-port-currency-rate-date-check

currency_rate_date_check: port to v8

__unported__/currency_rate_date_check/currency_rate_date_check.py

@@ -1,112 +0,0 @@
-# -*- encoding: utf-8 -*-
-##############################################################################
-#
-#    Currency rate date check module for OpenERP
-#    Copyright (C) 2012-2013 Akretion (http://www.akretion.com)
-#    @author Alexis de Lattre <alexis.delattre@akretion.com>
-#
-#    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
-from datetime import datetime
-from openerp.tools.translate import _
-
-# Here are some explainations about the design of this module.
-# In server/openerp/addons/base/res/res_currency.py :
-# compute() -> _get_conversion_rate()
-# -> _current_rate() -> _current_rate_computation()
-# The date used for the rate is the one in the context
-# compute() adds currency_rate_type_from
-#  and currency_rate_type_to to the context
-# _get_conversion_rate() adds currency_rate_type_id to context ;
-# its value is currency_rate_type_to ;
-# if it doesn't exist it's currency_rate_type_from ;
-# if it doesn't exist either it's False
-# It already contains raise "No rate found for currency ... at the date ..."
-# _current_rate() reads currency_rate_type_id
-# from context and uses it in the SQL request
-# This is the function used for the definition of
-# the field.function 'rate' on res_currency
-
-# Which one of the 3 functions should we inherit ? Good question...
-# It's probably better to inherit the lowest level function,
-# i.e. _current_rate_computation()
-# Advantage : by inheriting the lowest level function,
-# we can be sure that the check
-# always apply, even for scenarios where we
-# read the field "rate" of the obj currency
-# => that's the solution I implement in the code below
-
-
-class res_currency(orm.Model):
-    _inherit = 'res.currency'
-
-    def _current_rate_computation(self, cr, uid, ids, name, arg,
-                                  raise_on_no_rate, context=None):
-        if context is None:
-            context = {}
-        # We only do the check if there is an explicit date in the context and
-        # there is no specific currency_rate_type_id
-        if context.get('date') and not context.get('currency_rate_type_id') and\
-           not context.get('disable_rate_date_check'):
-            for currency_id in ids:
-                # We could get the company from the currency, but it's not a
-                # 'required' field, so we should probably continue to get it
-                # from the user, shouldn't we ?
-                user = self.pool['res.users'].browse(cr, uid, uid,
-                                                     context=context)
-                # if it's the company currency, don't do anything
-                # (there is just one old rate at 1.0)
-                if user.company_id.currency_id.id == currency_id:
-                    continue
-                else:
-                    # now we do the real work !
-                    date = context.get('date',
-                                       datetime.today().strftime('%Y-%m-%d'))
-                    date_datetime = datetime.strptime(date, '%Y-%m-%d')
-                    rate_obj = self.pool['res.currency.rate']
-                    selected_rate = rate_obj.search(cr, uid, [
-                        ('currency_id', '=', currency_id),
-                        ('name', '<=', date),
-                        ('currency_rate_type_id', '=', None)
-                    ], order='name desc', limit=1, context=context)
-                    if not selected_rate:
-                        continue
-
-                    rate_date = rate_obj.read(cr, uid, selected_rate[0],
-                                              ['name'],
-                                              context=context)['name']
-                    rate_date_datetime = datetime.strptime(rate_date,
-                                                           '%Y-%m-%d')
-                    max_delta = user.company_id.currency_rate_max_delta
-                    if (date_datetime - rate_date_datetime).days > max_delta:
-                        currency_name = self.read(cr, uid,
-                                                  currency_id,
-                                                  ['name'],
-                                                  context=context)['name']
-                        raise orm.except_orm(
-                            _('Error'),
-                            _('You are requesting a rate conversion on %s for '
-                              'currency %s but the nearest '
-                              'rate before that date is '
-                              'dated %s and the maximum currency '
-                              'rate time delta for '
-                              'your company is %s days') % (
-                                  date, currency_name, rate_date, max_delta)
-                        )
-        # Now we call the regular function from the "base" module
-        return super(res_currency, self)._current_rate_computation(
-            cr, uid, ids, name, arg, raise_on_no_rate, context=context)

currency_rate_date_check/__init__.py

@@ -1,8 +1,8 @@
 # -*- encoding: utf-8 -*-
 ##############################################################################
 #
-#    Currency rate date check module for OpenERP
-#    Copyright (C) 2012-2013 Akretion (http://www.akretion.com).
+#    Currency rate date check module for Odoo
+#    Copyright (C) 2012-2014 Akretion (http://www.akretion.com).
 #    @author Alexis de Lattre <alexis.delattre@akretion.com>
 #
 #    This program is free software: you can redistribute it and/or modify

currency_rate_date_check/__openerp__.py

@@ -1,8 +1,8 @@
 # -*- encoding: utf-8 -*-
 ##############################################################################
 #
-#    Currency rate date check module for OpenERP
-#    Copyright (C) 2012-2013 Akretion (http://www.akretion.com).
+#    Currency rate date check module for Odoo
+#    Copyright (C) 2012-2014 Akretion (http://www.akretion.com).
 #    @author Alexis de Lattre <alexis.delattre@akretion.com>
 #
 #    This program is free software: you can redistribute it and/or modify
@@ -31,10 +31,9 @@
 Currency Rate Date Check
 ========================
 
-This module adds a check on dates when doing currency conversion in OpenERP.
+This module adds a check on dates when doing currency conversion in Odoo.
 It checks that the currency rate used to make the conversion
-is not more than N days away
-from the date of the amount to convert.
+is not more than N days away from the date of the amount to convert.
 
 The maximum number of days of the interval can be
 configured on the company form.
@@ -50,6 +49,5 @@ for any help or question about this module.
         'images/date_check_error_popup.jpg',
         'images/date_check_company_config.jpg',
         ],
-    'installable': False,
-    'active': False,
+    'installable': True,
 }

currency_rate_date_check/company.py

@@ -1,8 +1,8 @@
 # -*- encoding: utf-8 -*-
 ##############################################################################
 #
-#    Currency rate date check module for OpenERP
-#    Copyright (C) 2012-2013 Akretion (http://www.akretion.com)
+#    Currency rate date check module for Odoo
+#    Copyright (C) 2012-2014 Akretion (http://www.akretion.com)
 #    @author Alexis de Lattre <alexis.delattre@akretion.com>
 #
 #    This program is free software: you can redistribute it and/or modify
@@ -20,25 +20,17 @@
 #
 ##############################################################################
 
-from openerp.osv import orm, fields
+from openerp import models, fields
 
 
-class res_company(orm.Model):
+class ResCompany(models.Model):
     _inherit = 'res.company'
 
-    _columns = {
-        'currency_rate_max_delta': fields.integer(
-            'Max Time Delta in Days for Currency Rates',
-            help="This is the maximum interval in days between "
-                 "the date associated "
-                 "with the amount to convert and the date "
-                 "of the nearest currency "
-                 "rate available in OpenERP."),
-    }
-
-    _defaults = {
-        'currency_rate_max_delta': 7,
-    }
+    currency_rate_max_delta = fields.Integer(
+        string='Max Time Delta in Days for Currency Rates', default=7,
+        help="This is the maximum interval in days between "
+        "the date associated with the amount to convert and the date "
+        "of the nearest currency rate available in Odoo.")
 
     _sql_constraints = [
         ('currency_rate_max_delta_positive',

currency_rate_date_check/company_view.xml

@@ -1,7 +1,7 @@
 <?xml version="1.0" encoding="utf-8"?>
 
 <!--
-    Copyright (C) 2012 Akretion (http://www.akretion.com/)
+    Copyright (C) 2012-2014 Akretion (http://www.akretion.com/)
     @author Alexis de Lattre <alexis.delattre@akretion.com>
     The licence is in the file __openerp__.py
 -->
@@ -9,8 +9,9 @@
 <openerp>
 <data>
 
-<record id="currency_rate_date_check_form" model="ir.ui.view">
-    <field name="name">currency.rate.date.check.form</field>
+
+<record id="view_company_form" model="ir.ui.view">
+    <field name="name">currency.rate.date.check.company.form</field>
     <field name="model">res.company</field>
     <field name="inherit_id" ref="base.view_company_form" />
     <field name="arch" type="xml">

currency_rate_date_check/currency_rate_date_check.py

@@ -0,0 +1,95 @@
+# -*- encoding: utf-8 -*-
+##############################################################################
+#
+#    Currency rate date check module for OpenERP
+#    Copyright (C) 2012-2013 Akretion (http://www.akretion.com)
+#    @author Alexis de Lattre <alexis.delattre@akretion.com>
+#
+#    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 import models, fields, _
+from openerp.exceptions import Warning
+
+# Here are some explainations about the design of this module.
+# In odoo/openerp/addons/base/res/res_currency.py :
+# compute() -> _get_conversion_rate()
+# -> _current_rate() -> _get_current_rate()
+# The date used for the rate is the one in the context
+
+# Which one of the 3 functions should we inherit ? Good question...
+# It's probably better to inherit the lowest level function,
+# i.e. _get_current_rate()
+# Advantage : by inheriting the lowest level function,
+# we can be sure that the check
+# always apply, even for scenarios where we
+# read the field "rate" of the obj currency
+# => that's the solution I implement in the code below
+
+
+class ResCurrency(models.Model):
+    _inherit = 'res.currency'
+
+    def _get_current_rate(
+            self, cr, uid, ids, raise_on_no_rate=True, context=None):
+        if context is None:
+            context = {}
+        # We don't check if we don't have 'date' in context, which is
+        # a pb because it means Odoo can do a rate conversion
+        # on today's date with an old rate, but otherwize it would raise
+        # too often, for example it would raise entering the
+        # Currencies menu entry !
+        if context.get('date') and not context.get('disable_rate_date_check'):
+            date = context.get('date')
+            for currency_id in ids:
+                # We could get the company from the currency, but it's not a
+                # 'required' field, so we should probably continue to get it
+                # from the user, shouldn't we ?
+                user = self.pool['res.users'].browse(cr, uid, uid,
+                                                     context=context)
+                # if it's the company currency, don't do anything
+                # (there is just one old rate at 1.0)
+                if user.company_id.currency_id.id == currency_id:
+                    continue
+                else:
+                    # now we do the real work !
+                    cr.execute(
+                        'SELECT rate, name FROM res_currency_rate '
+                        'WHERE currency_id = %s '
+                        'AND name <= %s '
+                        'ORDER BY name desc LIMIT 1',
+                        (currency_id, date))
+                    if cr.rowcount:
+                        rate_date = cr.fetchone()[1]
+                        rate_date_dt = fields.Date.from_string(rate_date)
+                        if len(date) <= 10:
+                            date_dt = fields.Date.from_string(date)
+                        else:
+                            date_dt = fields.Datetime.from_string(date)
+                        max_delta = user.company_id.currency_rate_max_delta
+                        if (date_dt - rate_date_dt).days > max_delta:
+                            currency = self.browse(
+                                cr, uid, currency_id, context=context)
+                            raise Warning(
+                                _('You are requesting a rate conversion on %s '
+                                  'for currency %s but the nearest '
+                                  'rate before that date is '
+                                  'dated %s and the maximum currency '
+                                  'rate time delta for '
+                                  'your company is %s days')
+                                % (date, currency.name, rate_date, max_delta))
+        # Now we call the regular function from the "base" module
+        return super(ResCurrency, self)._get_current_rate(
+            cr, uid, ids, raise_on_no_rate=raise_on_no_rate, context=context)