stock_valuation_xlsx: add depreciation ratios

stock_valuation_xlsx/__init__.py

@@ -1,3 +1,4 @@
 # -*- coding: utf-8 -*-
 
 from . import wizard
+from . import models

stock_valuation_xlsx/__manifest__.py

@@ -38,9 +38,11 @@ This module has been written by Alexis de Lattre from Akretion <alexis.delattre@
     'website': 'http://www.akretion.com',
     'depends': ['stock_account'],
     'data': [
+        'security/ir.model.access.csv',
         'wizard/stock_valuation_xlsx_view.xml',
         'wizard/stock_variation_xlsx_view.xml',
         'views/stock_inventory.xml',
+        'views/stock_expiry_depreciation_rule.xml',
         ],
     'installable': True,
 }

stock_valuation_xlsx/models/__init__.py

@@ -0,0 +1,3 @@
+# -*- coding: utf-8 -*-
+
+from . import stock_expiry_depreciation_rule

stock_valuation_xlsx/models/stock_expiry_depreciation_rule.py

@@ -0,0 +1,36 @@
+# -*- coding: utf-8 -*-
+# Copyright 2021 Akretion France (http://www.akretion.com/)
+# @author: Alexis de Lattre <alexis.delattre@akretion.com>
+# License AGPL-3.0 or later (https://www.gnu.org/licenses/agpl).
+
+from odoo import fields, models
+
+
+class StockExpiryDepreciationRule(models.Model):
+    _name = 'stock.expiry.depreciation.rule'
+    _description = 'Stock Expiry Depreciation Rule'
+    _order = 'company_id, start_limit_days'
+
+    company_id = fields.Many2one(
+        'res.company', string='Company',
+        ondelete='cascade', required=True,
+        default=lambda self: self.env['res.company']._company_default_get())
+    start_limit_days = fields.Integer(
+        string='Days Before/After Expiry', required=True,
+        help="Enter negative value for days before expiry. Enter positive values for days after expiry. This value is the START of the time interval when going from future to past.")
+    ratio = fields.Integer(string='Depreciation Ratio (%)', required=True)
+    name = fields.Char(string='Label')
+
+    _sql_constraints = [(
+        'ratio_positive',
+        'CHECK(ratio >= 0)',
+        'The depreciation ratio must be positive.'
+        ), (
+        'ratio_max',
+        'CHECK(ratio <= 100)',
+        'The depreciation ratio cannot be above 100%.'
+        ), (
+        'start_limit_days_unique',
+        'unique(company_id, start_limit_days)',
+        'This depreciation rule already exists in this company.'
+        )]

stock_valuation_xlsx/security/ir.model.access.csv

@@ -0,0 +1,3 @@
+id,name,model_id:id,group_id:id,perm_read,perm_write,perm_create,perm_unlink
+access_stock_expiry_depreciation_rule_full,Full access on stock.expiry.depreciation.rule to account manager,model_stock_expiry_depreciation_rule,account.group_account_manager,1,1,1,1
+access_stock_expiry_depreciation_rule_read,Read access on stock.expiry.depreciation.rule to stock manager,model_stock_expiry_depreciation_rule,stock.group_stock_manager,1,0,0,0

stock_valuation_xlsx/views/stock_expiry_depreciation_rule.xml

@@ -0,0 +1,35 @@
+<?xml version="1.0" encoding="utf-8"?>
+<!--
+  Copyright 2021 Akretion France (http://www.akretion.com/)
+  @author: Alexis de Lattre <alexis.delattre@akretion.com>
+  License AGPL-3.0 or later (http://www.gnu.org/licenses/agpl).
+-->
+
+<odoo>
+<data>
+
+<record id="stock_expiry_depreciation_rule_tree" model="ir.ui.view">
+    <field name="model">stock.expiry.depreciation.rule</field>
+    <field name="arch" type="xml">
+        <tree editable="bottom">
+            <field name="start_limit_days"/>
+            <field name="ratio"/>
+            <field name="name"/>
+            <field name="company_id" groups="base.group_multi_company"/>
+        </tree>
+    </field>
+</record>
+
+<record id="stock_expiry_depreciation_rule_action" model="ir.actions.act_window">
+    <field name="name">Stock Depreciation Rules</field>
+    <field name="res_model">stock.expiry.depreciation.rule</field>
+    <field name="view_mode">tree</field>
+</record>
+
+<menuitem id="stock_expiry_depreciation_rule_menu"
+        action="stock_expiry_depreciation_rule_action"
+        parent="account.account_management_menu"
+        sequence="100"/>
+
+</data>
+</odoo>

stock_valuation_xlsx/wizard/stock_valuation_xlsx.py

@@ -5,6 +5,7 @@
 
 from odoo import models, fields, api, _
 from odoo.exceptions import UserError
+from dateutil.relativedelta import relativedelta
 from odoo.tools import float_is_zero, float_round
 from cStringIO import StringIO
 from datetime import datetime
@@ -62,11 +63,27 @@ class StockValuationXlsx(models.TransientModel):
         ('present', 'Current'),
         ], default='past', string='Cost Price Date',
         states={'done': [('readonly', True)]})
+    # I can't put a compute field for has_expiry_date
+    # because I want to have the value when the wizard is started,
+    # and not wait until run
+    has_expiry_date = fields.Boolean(
+        default=lambda self: self._default_has_expiry_date(), readonly=True)
+    apply_depreciation = fields.Boolean(
+        string='Apply Depreciation Rules', default=True,
+        states={'done': [('readonly', True)]})
     split_by_lot = fields.Boolean(
         string='Display Lots', states={'done': [('readonly', True)]})
     split_by_location = fields.Boolean(
         string='Display Stock Locations', states={'done': [('readonly', True)]})
 
+    @api.model
+    def _default_has_expiry_date(self):
+        splo = self.env['stock.production.lot']
+        has_expiry_date = False
+        if hasattr(splo, 'expiry_date'):
+            has_expiry_date = True
+        return has_expiry_date
+
     @api.model
     def _default_location(self):
         wh = self.env.ref('stock.warehouse0')
@@ -120,6 +137,18 @@ class StockValuationXlsx(models.TransientModel):
     def _prepare_product_fields(self):
         return ['uom_id', 'name', 'default_code', 'categ_id']
 
+    def _prepare_expiry_depreciation_rules(self, company_id, past_date):
+        rules = self.env['stock.expiry.depreciation.rule'].search_read([('company_id', '=', company_id)], ['start_limit_days', 'ratio'], order='start_limit_days desc')
+        if past_date:
+            date_dt = fields.Date.from_string(past_date)
+        else:
+            date_dt = fields.Date.from_string(fields.Date.context_today(self))
+        for rule in rules:
+            rule['start_date'] = fields.Date.to_string(
+                date_dt - relativedelta(days=rule['start_limit_days']))
+        logger.debug('depreciation_rules=%s', rules)
+        return rules
+
     def compute_product_data(
             self, company_id, in_stock_product_ids, standard_price_past_date=False):
         self.ensure_one()
@@ -174,17 +203,24 @@ class StockValuationXlsx(models.TransientModel):
         return uom_id2name
 
     @api.model
-    def prodlot_id2name(self, product_ids):
+    def prodlot_id2data(self, product_ids, has_expiry_date, depreciation_rules):
         splo = self.env['stock.production.lot']
         lot_id2data = {}
         lot_fields = ['name']
-        if hasattr(splo, 'expiry_date'):
+        if has_expiry_date:
             lot_fields.append('expiry_date')
 
         lots = splo.search_read(
             [('product_id', 'in', product_ids)], lot_fields)
         for lot in lots:
             lot_id2data[lot['id']] = lot
+            lot_id2data[lot['id']]['depreciation_ratio'] = 0
+            if depreciation_rules and lot.get('expiry_date'):
+                expiry_date = lot['expiry_date']
+                for rule in depreciation_rules:
+                    if expiry_date <= rule['start_date']:
+                        lot_id2data[lot['id']]['depreciation_ratio'] = rule['ratio'] / 100.0
+                        break
         return lot_id2data
 
     @api.model
@@ -283,7 +319,7 @@ class StockValuationXlsx(models.TransientModel):
     def stringify_and_sort_result(
             self, product_ids, product_id2data, data,
             prec_qty, prec_price, prec_cur_rounding, categ_id2name,
-            uom_id2name, lot_id2data, loc_id2name):
+            uom_id2name, lot_id2data, loc_id2name, apply_depreciation):
         logger.debug('Start stringify_and_sort_result')
         res = []
         for l in data:
@@ -292,17 +328,27 @@ class StockValuationXlsx(models.TransientModel):
             standard_price = float_round(
                 product_id2data[product_id]['standard_price'],
                 precision_digits=prec_price)
-            subtotal = float_round(
+            subtotal_before_depreciation = float_round(
                 standard_price * qty, precision_rounding=prec_cur_rounding)
+            depreciation_ratio = 0
+            if apply_depreciation and l['lot_id']:
+                depreciation_ratio = lot_id2data[l['lot_id']].get('depreciation_ratio', 0)
+                subtotal = float_round(
+                    subtotal_before_depreciation * (1 - depreciation_ratio),
+                    precision_rounding=prec_cur_rounding)
+            else:
+                subtotal = subtotal_before_depreciation
             res.append(dict(
                 product_id2data[product_id],
                 product_name=product_id2data[product_id]['name'],
                 loc_name=l['location_id'] and loc_id2name[l['location_id']] or '',
                 lot_name=l['lot_id'] and lot_id2data[l['lot_id']]['name'] or '',
                 expiry_date=l['lot_id'] and lot_id2data[l['lot_id']].get('expiry_date'),
+                depreciation_ratio=depreciation_ratio,
                 qty=qty,
                 uom_name=uom_id2name[product_id2data[product_id]['uom_id']],
                 standard_price=standard_price,
+                subtotal_before_depreciation=subtotal_before_depreciation,
                 subtotal=subtotal,
                 categ_name=categ_id2name[product_id2data[product_id]['categ_id']],
                 ))
@@ -321,6 +367,12 @@ class StockValuationXlsx(models.TransientModel):
         prec_cur_rounding = company.currency_id.rounding
         self._check_config(company_id)
 
+        apply_depreciation = self.apply_depreciation
+        if (
+                (self.source == 'stock' and self.stock_date_type == 'past') or
+                not self.split_by_lot or
+                not self.has_expiry_date):
+            apply_depreciation = False
         product_ids = self.get_product_ids()
         if not product_ids:
             raise UserError(_("There are no products to analyse."))
@@ -343,6 +395,13 @@ class StockValuationXlsx(models.TransientModel):
         standard_price_past_date = past_date
         if not (self.source == 'stock' and self.stock_date_type == 'present') and self.standard_price_date == 'present':
             standard_price_past_date = False
+        depreciation_rules = []
+        if apply_depreciation:
+            depreciation_rules = self._prepare_expiry_depreciation_rules(company_id, past_date)
+            if not depreciation_rules:
+                raise UserError(_(
+                    "The are not stock depreciation rule for company '%s'.")
+                    % company.display_name)
         in_stock_product_ids = in_stock_products.keys()
         product_id2data = self.compute_product_data(
             company_id, in_stock_product_ids,
@@ -350,11 +409,11 @@ class StockValuationXlsx(models.TransientModel):
         data_res = self.group_result(data, split_by_lot, split_by_location)
         categ_id2name = self.product_categ_id2name(self.categ_ids)
         uom_id2name = self.uom_id2name()
-        lot_id2data = self.prodlot_id2name(in_stock_product_ids)
+        lot_id2data = self.prodlot_id2data(in_stock_product_ids, self.has_expiry_date, depreciation_rules)
         loc_id2name = self.stock_location_id2name(self.location_id)
         res = self.stringify_and_sort_result(
             product_ids, product_id2data, data_res, prec_qty, prec_price, prec_cur_rounding,
-            categ_id2name, uom_id2name, lot_id2data, loc_id2name)
+            categ_id2name, uom_id2name, lot_id2data, loc_id2name, apply_depreciation)
 
         logger.debug('Start create XLSX workbook')
         file_data = StringIO()
@@ -367,12 +426,15 @@ class StockValuationXlsx(models.TransientModel):
         if not split_by_lot:
             cols.pop('lot_name', None)
             cols.pop('expiry_date', None)
-        if not hasattr(splo, 'expiry_date'):
+        if not self.has_expiry_date:
             cols.pop('expiry_date', None)
         if not split_by_location:
             cols.pop('loc_name', None)
         if not categ_subtotal:
             cols.pop('categ_subtotal', None)
+        if not apply_depreciation:
+            cols.pop('depreciation_ratio', None)
+            cols.pop('subtotal_before_depreciation', None)
 
         j = 0
         for col, col_vals in sorted(cols.items(), key=lambda x: x[1]['sequence']):
@@ -429,6 +491,9 @@ class StockValuationXlsx(models.TransientModel):
         letter_qty = cols['qty']['pos_letter']
         letter_price = cols['standard_price']['pos_letter']
         letter_subtotal = cols['subtotal']['pos_letter']
+        if apply_depreciation:
+            letter_subtotal_before_depreciation = cols['subtotal_before_depreciation']['pos_letter']
+            letter_depreciation_ratio = cols['depreciation_ratio']['pos_letter']
         crow = 0
         lines = res
         for categ_id in categ_ids:
@@ -444,12 +509,20 @@ class StockValuationXlsx(models.TransientModel):
                 total += l['subtotal']
                 ctotal += l['subtotal']
                 categ_has_line = True
-                subtotal_formula = '=%s%d*%s%d' % (letter_qty, i + 1, letter_price, i + 1)
+                qty_by_price_formula = '=%s%d*%s%d' % (letter_qty, i + 1, letter_price, i + 1)
+                if apply_depreciation:
+                    sheet.write_formula(i, cols['subtotal_before_depreciation']['pos'], qty_by_price_formula, styles['regular_currency'], l['subtotal_before_depreciation'])
+                    subtotal_formula = '=%s%d*(1 - %s%d)' % (letter_subtotal_before_depreciation, i + 1, letter_depreciation_ratio, i + 1)
+                else:
+                    subtotal_formula = qty_by_price_formula
                 sheet.write_formula(i, cols['subtotal']['pos'], subtotal_formula, styles['regular_currency'], l['subtotal'])
                 for col_name, col in cols.items():
                     if not col.get('formula'):
-                        if col.get('type') == 'date' and l[col_name]:
+                        if col.get('type') == 'date':
-                            l[col_name] = fields.Date.from_string(l[col_name])
+                            if l[col_name]:
+                                l[col_name] = fields.Date.from_string(l[col_name])
+                            else:
+                                l[col_name] = ''  # to avoid display of 31/12/1899
                         sheet.write(i, col['pos'], l[col_name], styles[col['style']])
             if categ_subtotal:
                 if categ_has_line:
@@ -509,6 +582,7 @@ class StockValuationXlsx(models.TransientModel):
             'regular_date': workbook.add_format({'num_format': 'dd/mm/yyyy'}),
             'regular_currency': workbook.add_format({'num_format': currency_num_format}),
             'regular_price_currency': workbook.add_format({'num_format': price_currency_num_format}),
+            'regular_int_percent': workbook.add_format({'num_format': u'0.%'}),
             'regular': workbook.add_format({}),
             'regular_small': workbook.add_format({'font_size': regular_font_size - 2}),
             'categ_title': workbook.add_format({
@@ -533,8 +607,10 @@ class StockValuationXlsx(models.TransientModel):
             'qty': {'width': 8, 'style': 'regular', 'sequence': 60, 'title': _('Qty')},
             'uom_name': {'width': 5, 'style': 'regular_small', 'sequence': 70, 'title': _('UoM')},
             'standard_price': {'width': 14, 'style': 'regular_price_currency', 'sequence': 80, 'title': _('Cost Price')},
-            'subtotal': {'width': 16, 'style': 'regular_currency', 'sequence': 90, 'title': _('Sub-total'), 'formula': True},
+            'subtotal_before_depreciation': {'width': 16, 'style': 'regular_currency', 'sequence': 90, 'title': _('Sub-total'), 'formula': True},
-            'categ_subtotal': {'width': 16, 'style': 'regular_currency', 'sequence': 100, 'title': _('Categ Sub-total'), 'formula': True},
+            'depreciation_ratio': {'width': 10, 'style': 'regular_int_percent', 'sequence': 100, 'title': _('Depreciation')},
-            'categ_name': {'width': 40, 'style': 'regular_small', 'sequence': 110, 'title': _('Product Category')},
+            'subtotal': {'width': 16, 'style': 'regular_currency', 'sequence': 110, 'title': _('Sub-total'), 'formula': True},
+            'categ_subtotal': {'width': 16, 'style': 'regular_currency', 'sequence': 120, 'title': _('Categ Sub-total'), 'formula': True},
+            'categ_name': {'width': 40, 'style': 'regular_small', 'sequence': 130, 'title': _('Product Category')},
             }
         return cols

stock_valuation_xlsx/wizard/stock_valuation_xlsx_view.xml

@@ -27,8 +27,10 @@
                 <field name="past_date" attrs="{'invisible': ['|', ('source', '!=', 'stock'), ('stock_date_type', '!=', 'past')], 'required': [('source', '=', 'stock'), ('stock_date_type', '=', 'past')]}"/>
                 <field name="standard_price_date" attrs="{'invisible': [('source', '=', 'stock'), ('stock_date_type', '=', 'present')]}" widget="radio"/>
                 <field name="categ_subtotal" />
+                <field name="has_expiry_date" invisible="1"/>
                 <field name="split_by_lot" attrs="{'invisible': [('source', '=', 'stock'), ('stock_date_type', '=', 'past')]}" groups="stock.group_production_lot"/>
                 <field name="split_by_location" attrs="{'invisible': [('source', '=', 'stock'), ('stock_date_type', '=', 'past')]}"/>
+                <field name="apply_depreciation" groups="stock.group_production_lot" attrs="{'invisible': ['|', '|', ('split_by_lot', '=', False), ('has_expiry_date', '=', False), '&amp;', ('source', '=', 'stock'), ('stock_date_type', '=', 'past')]}"/>
             </group>
             <group name="done" states="done" string="Result">
                 <field name="export_file" filename="export_filename"/>