[IMP] hr_payroll_overtime: implement date or day of week overrides to overtime rules

hr_payroll_overtime/models/hr_payslip.py

@@ -78,13 +78,24 @@ class HRPayslip(models.Model):
                 day_hours[iso_date] += regular_hours
                 week_hours[week] += regular_hours
             if ot_hours:
+                overtime_work_type = work_type.overtime_work_type_id
+                multiplier = work_type.overtime_type_id.multiplier
+                override = work_type.overtime_type_id.override_for_iso_date(iso_date)
+                if work_type == overtime_work_type:
+                    # trivial infinite recursion
+                    raise UserError('Work type "%s" (id %s) must not have itself as its next overtime type.' % (work_type.name, work_type.id))
+                if override:
+                    overtime_work_type = override.work_type_id
+                    multiplier = override.multiplier
+                    if work_type == overtime_work_type:
+                        # trivial infinite recursion from override
+                        raise UserError('Work type "%s" (id %s) must not have itself as its next overtime type. '
+                                        'This occurred due to an override "%s" from overtime rules "%s".' % (
+                            work_type.name, work_type.id, override.name, work_type.overtime_type_id.name))
                 # we need to save this because it won't be set once it reenter, we won't know what the original
                 # overtime multiplier was
-                working_aggregation[work_type.overtime_work_type_id][2] = work_type.overtime_type_id.multiplier
-                if work_type == work_type.overtime_work_type_id:
-                    # trivial infinite recursion
-                    raise UserError('Work type %s (id %s) must not have itself as its next overtime type.' % (work_type.name, work_type.id))
-                self._aggregate_overtime_add_work_type_hours(work_type.overtime_work_type_id, ot_hours, iso_date,
+                working_aggregation[overtime_work_type][2] = multiplier
+                self._aggregate_overtime_add_work_type_hours(overtime_work_type, ot_hours, iso_date,
                                                              working_aggregation, iso_days, day_hours, week_hours)
         else:
             # No overtime, just needs added to set

hr_payroll_overtime/models/hr_work_entry.py

@@ -1,4 +1,7 @@
-from odoo import fields, models
+from odoo import api, fields, models
+from odoo.exceptions import ValidationError
+
+from .resource_calendar import WEEKDAY_SELECTION
 
 
 class HRWorkEntryType(models.Model):
@@ -19,3 +22,40 @@ class HRWorkEntryOvertime(models.Model):
                                   help='Number of hours worked in a week to trigger overtime.')
     multiplier = fields.Float(string='Multiplier',
                               help='Rate for when overtime is reached.')
+    override_ids = fields.One2many('hr.work.entry.overtime.type.override', 'overtime_type_id',
+                                   string='Overrides',
+                                   help='Override lines with a Date will be considered before Day of Week.')
+
+    def override_for_iso_date(self, iso_date):
+        return self.override_ids.iso_date_applies(iso_date)
+
+
+class HRWorkEntryOvertimeOverride(models.Model):
+    _name = 'hr.work.entry.overtime.type.override'
+    _description = 'Overtime Rule Override'
+    _order = 'date desc, day_of_week'
+
+    name = fields.Char(string='Description')
+    overtime_type_id = fields.Many2one('hr.work.entry.overtime.type',
+                                       string='Overtime Rules')
+    work_type_id = fields.Many2one('hr.work.entry.type', string='Overtime Work Type', required=True,
+                                   help='Distinct Work Type for this. Given the different rate, it should '
+                                        ' be different from other Overtime Work Types (because payslips '
+                                        'should only have one line/rate per work type).')
+    multiplier = fields.Float(string='Multiplier',
+                              help='Rate for when overtime is reached.')
+    day_of_week = fields.Selection(WEEKDAY_SELECTION, string='Day of Week')
+    date = fields.Date(string='Date')
+
+    @api.constrains('day_of_week', 'date')
+    def _constrain_days(self):
+        for override in self:
+            if override.day_of_week and override.date:
+                raise ValidationError('An override should only have a Date OR Day of Week.')
+
+    def iso_date_applies(self, iso_date):
+        for override in self:
+            if override.date and override.date.isocalendar() == iso_date:
+                return override
+            if int(override.day_of_week) == iso_date[2]:
+                return override

hr_payroll_overtime/models/resource_calendar.py

@@ -1,15 +1,18 @@
 from odoo import fields, models
 
 
+WEEKDAY_SELECTION = [
+    ('1', 'Monday'),
+    ('2', 'Tuesday'),
+    ('3', 'Wednesday'),
+    ('4', 'Thursday'),
+    ('5', 'Friday'),
+    ('6', 'Saturday'),
+    ('7', 'Sunday'),
+]
+
+
 class ResourceCalendar(models.Model):
     _inherit = 'resource.calendar'
 
-    day_week_start = fields.Selection([
-        ('1', 'Monday'),
-        ('2', 'Tuesday'),
-        ('3', 'Wednesday'),
-        ('4', 'Thursday'),
-        ('5', 'Friday'),
-        ('6', 'Saturday'),
-        ('7', 'Sunday'),
-    ], string='Day Week Starts', required=True, default='1')
+    day_week_start = fields.Selection(WEEKDAY_SELECTION, string='Day Week Starts', required=True, default='1')

hr_payroll_overtime/security/ir.model.access.csv

@@ -1,3 +1,5 @@
 id,name,model_id:id,group_id:id,perm_read,perm_write,perm_create,perm_unlink
 access_hr_work_entry_overtime_type,access_hr_work_entry_overtime_type,model_hr_work_entry_overtime_type,base.group_user,1,0,0,0
 manage_hr_work_entry_overtime_type,manage_hr_work_entry_overtime_type,model_hr_work_entry_overtime_type,hr_payroll.group_hr_payroll_manager,1,1,1,1
+access_hr_work_entry_overtime_type_override,access_hr_work_entry_overtime_type_override,model_hr_work_entry_overtime_type_override,base.group_user,1,0,0,0
+manage_hr_work_entry_overtime_type_override,manage_hr_work_entry_overtime_type_override,model_hr_work_entry_overtime_type_override,hr_payroll.group_hr_payroll_manager,1,1,1,1

hr_payroll_overtime/tests/test_overtime.py

@@ -1,5 +1,7 @@
+from datetime import date
+
 from odoo.tests import common
-from odoo.exceptions import UserError
+from odoo.exceptions import UserError, ValidationError
 
 
 class TestOvertime(common.TransactionCase):
@@ -360,3 +362,94 @@ class TestOvertime(common.TransactionCase):
 
         with self.assertRaises(UserError):
             result_data = self.payslip.aggregate_overtime(work_data)
+
+    def test_15_override_day_of_week(self):
+        iso_date = (2020, 24, 1)
+        self.overtime_rules.hours_per_day = 8.0
+        self.overtime_rules.multiplier_per_day = 1.5
+        work_data = [
+            (iso_date, [
+                (self.work_type, 4.0, None),
+                (self.work_type, 6.0, None),
+            ]),
+        ]
+
+        result_data = self.payslip.aggregate_overtime(work_data)
+        self.assertTrue(self.work_type in result_data)
+        self.assertEqual(result_data[self.work_type][0], 1)
+        self.assertEqual(result_data[self.work_type][1], 8.0)
+        self.assertTrue(self.work_type_overtime in result_data)
+        self.assertEqual(result_data[self.work_type_overtime][0], 0)
+        self.assertEqual(result_data[self.work_type_overtime][1], 2.0)
+        self.assertEqual(result_data[self.work_type_overtime][2], 1.5)
+
+
+        # Now lets make an override line
+        self.overtime_rules.write({
+            'override_ids': [(0, 0, {
+                'name': 'Day 1 Override',
+                'multiplier': 2.0,
+                'day_of_week': str(iso_date[2]),
+                'work_type_id': self.work_type_overtime.id,  # Note that this wouldn't be good in practice
+            })]
+        })
+        result_data = self.payslip.aggregate_overtime(work_data)
+        self.assertTrue(self.work_type in result_data)
+        self.assertEqual(result_data[self.work_type][0], 1)
+        self.assertEqual(result_data[self.work_type][1], 8.0)
+        self.assertTrue(self.work_type_overtime in result_data)
+        self.assertEqual(result_data[self.work_type_overtime][0], 0)
+        self.assertEqual(result_data[self.work_type_overtime][1], 2.0)
+        self.assertEqual(result_data[self.work_type_overtime][2], 2.0)  # rate 2x
+
+    def test_16_override_date(self):
+        iso_date = (2020, 24, 1)
+        self.overtime_rules.hours_per_day = 8.0
+        self.overtime_rules.multiplier_per_day = 1.5
+        work_data = [
+            (iso_date, [
+                (self.work_type, 4.0, None),
+                (self.work_type, 6.0, None),
+            ]),
+        ]
+
+        result_data = self.payslip.aggregate_overtime(work_data)
+        self.assertTrue(self.work_type in result_data)
+        self.assertEqual(result_data[self.work_type][0], 1)
+        self.assertEqual(result_data[self.work_type][1], 8.0)
+        self.assertTrue(self.work_type_overtime in result_data)
+        self.assertEqual(result_data[self.work_type_overtime][0], 0)
+        self.assertEqual(result_data[self.work_type_overtime][1], 2.0)
+        self.assertEqual(result_data[self.work_type_overtime][2], 1.5)
+
+        # Now lets make a specific date override
+        self.overtime_rules.write({
+            'override_ids': [(0, 0, {
+                'name': 'Day (2020, 24, 1) Override',
+                'multiplier': 3.0,
+                'date': date(2020, 6, 8),  # date.fromisocalendar(*iso_date),
+                'work_type_id': self.work_type_overtime.id,  # Note that this wouldn't be good in practice
+            })]
+        })
+        self.overtime_rules.flush()
+        result_data = self.payslip.aggregate_overtime(work_data)
+        self.assertTrue(self.work_type in result_data)
+        self.assertEqual(result_data[self.work_type][0], 1)
+        self.assertEqual(result_data[self.work_type][1], 8.0)
+        self.assertTrue(self.work_type_overtime in result_data)
+        self.assertEqual(result_data[self.work_type_overtime][0], 0)
+        self.assertEqual(result_data[self.work_type_overtime][1], 2.0)
+        self.assertEqual(result_data[self.work_type_overtime][2], 3.0)  # rate 3x
+
+    def test_17_override_config(self):
+        with self.assertRaises(ValidationError):
+            self.overtime_rules.write({
+                'override_ids': [(0, 0, {
+                    'name': 'Day (2020, 24, 1) Override',
+                    'multiplier': 3.0,
+                    # cannot have both date and day_of_week
+                    'date': date(2020, 6, 8),
+                    'day_of_week': '1',
+                    'work_type_id': self.work_type_overtime.id,  # Note that this wouldn't be good in practice
+                })]
+            })

hr_payroll_overtime/views/hr_work_entry_views.xml

@@ -25,7 +25,7 @@
         <field name="name">hr.work.entry.overtime.type.tree</field>
         <field name="model">hr.work.entry.overtime.type</field>
         <field name="arch" type="xml">
-            <tree string="Overtime Rules" editable="bottom">
+            <tree string="Overtime Rules">
                 <field name="name"/>
                 <field name="hours_per_day"/>
                 <field name="hours_per_week"/>
@@ -34,6 +34,36 @@
         </field>
     </record>
 
+    <record id="hr_work_entry_overtime_type_form" model="ir.ui.view">
+        <field name="name">hr.work.entry.overtime.type.form</field>
+        <field name="model">hr.work.entry.overtime.type</field>
+        <field name="arch" type="xml">
+            <form string="Overtime Rules">
+                <group>
+                    <group>
+                        <field name="name"/>
+                        <field name="multiplier"/>
+                    </group>
+                    <group>
+                        <field name="hours_per_day"/>
+                        <field name="hours_per_week"/>
+                    </group>
+                </group>
+                <group name="overrides" string="Overrides">
+                    <field name="override_ids" nolabel="1">
+                        <tree editable="top">
+                            <field name="work_type_id"/>
+                            <field name="multiplier"/>
+                            <field name="date"/>
+                            <field name="day_of_week"/>
+                            <field name="name"/>
+                        </tree>
+                    </field>
+                </group>
+            </form>
+        </field>
+    </record>
+
     <record id="hr_work_entry_overtime_type_search" model="ir.ui.view">
         <field name="name">hr.work.entry.overtime.type.search</field>
         <field name="model">hr.work.entry.overtime.type</field>