[MIG] hr_payroll_timesheet: to Odoo 13.0 + [ADD] Overtime calculations

hr_payroll_timesheet/__manifest__.py

@@ -1,16 +1,19 @@
 {
     'name': 'Timesheets on Payslips',
     'description': 'Get Timesheet hours onto Employee Payslips.',
-    'version': '12.0.1.0.0',
+    'version': '13.0.1.0.0',
     'website': 'https://hibou.io/',
     'author': 'Hibou Corp. <hello@hibou.io>',
     'license': 'AGPL-3',
     'category': 'Human Resources',
     'data': [
+        'data/hr_payroll_timesheet_data.xml',
         'views/hr_contract_view.xml',
+        'views/hr_payslip_views.xml',
     ],
     'depends': [
         'hr_payroll',
         'hr_timesheet',
+        'hr_payroll_overtime',
     ],
 }

hr_payroll_timesheet/data/hr_payroll_timesheet_data.xml

@@ -0,0 +1,16 @@
+<?xml version="1.0" encoding="utf-8"?>
+<odoo>
+
+    <!-- Work Entry Type -->
+    <record id="work_input_timesheet_overtime" model="hr.work.entry.type">
+        <field name="name">Timesheet Overtime</field>
+        <field name="code">TS_OT</field>
+    </record>
+    <record id="work_input_timesheet" model="hr.work.entry.type">
+        <field name="name">Timesheet</field>
+        <field name="code">TS</field>
+        <field name="overtime_type_id" ref="hr_payroll_overtime.work_entry_overtime_type"/>
+        <field name="overtime_work_type_id" ref="work_input_timesheet_overtime"/>
+    </record>
+
+</odoo>

hr_payroll_timesheet/models/__init__.py

@@ -1,2 +1,3 @@
+from . import account
 from . import hr_contract
 from . import hr_payslip

hr_payroll_timesheet/models/account.py

@@ -0,0 +1,7 @@
+from odoo import fields, models
+
+
+class AnalyticLine(models.Model):
+    _inherit = 'account.analytic.line'
+
+    payslip_id = fields.Many2one('hr.payslip', string="Payslip", readonly=True)

hr_payroll_timesheet/models/hr_payslip.py

@@ -1,95 +1,88 @@
 from collections import defaultdict
-from odoo import api, models
+from odoo import api, fields, models, _
 
 
 class HrPayslip(models.Model):
     _inherit = 'hr.payslip'
 
-    @api.model
+    timesheet_ids = fields.One2many('account.analytic.line', 'payslip_id', string='Timesheets',
-    def get_worked_day_lines(self, contracts, date_from, date_to):
+                                     help='Timesheets represented by payslip.',
-        work = []
+                                     states={'draft': [('readonly', False)], 'verify': [('readonly', False)]})
-        for contract in contracts.filtered(lambda c: c.paid_hourly_timesheet):
+    timesheet_count = fields.Integer(compute='_compute_timesheet_count')
-            # Only run on 'paid hourly timesheet' contracts.
-            res = self._get_worked_day_lines_hourly_timesheet(contract, date_from, date_to)
-            if res:
-                work.append(res)
 
-        res = super(HrPayslip, self).get_worked_day_lines(contracts.filtered(lambda c: not c.paid_hourly_timesheet), date_from, date_to)
+    @api.depends('timesheet_ids', 'timesheet_ids.payslip_id')
-        res.extend(work)
+    def _compute_timesheet_count(self):
+        for payslip in self:
+            payslip.timesheet_count = len(payslip.timesheet_ids)
+
+    @api.onchange('worked_days_line_ids')
+    def _onchange_worked_days_line_ids(self):
+        # super()._onchange_worked_days_line_ids()
+        timesheet_type = self.env.ref('hr_payroll_timesheet.work_input_timesheet', raise_if_not_found=False)
+        if not self.worked_days_line_ids.filtered(lambda line: line.work_entry_type_id == timesheet_type):
+            self.timesheet_ids.write({'payslip_id': False})
+
+    @api.onchange('employee_id', 'struct_id', 'contract_id', 'date_from', 'date_to')
+    def _onchange_employee(self):
+        res = super()._onchange_employee()
+        if self.state == 'draft' and self.contract_id.paid_hourly_timesheet:
+            self.timesheet_ids = self.env['account.analytic.line'].search([
+                ('employee_id', '=', self.employee_id.id),
+                ('date', '<=', self.date_to),
+                '|', ('payslip_id', '=', False),
+                     ('payslip_id', '=', self.id),
+            ])
+            self._onchange_timesheet_ids()
         return res
 
-    def _get_worked_day_lines_hourly_timesheet(self, contract, date_from, date_to):
+    @api.onchange('timesheet_ids')
-        """
+    def _onchange_timesheet_ids(self):
-        This would be a common hook to extend or break out more functionality, like pay rate based on project.
+        timesheet_type = self.env.ref('hr_payroll_timesheet.work_input_timesheet', raise_if_not_found=False)
-        Note that you will likely need to aggregate similarly in hour_break_down() and hour_break_down_week()
+        if not timesheet_type:
-        :param contract: `hr.contract`
+            return
-        :param date_from: str
-        :param date_to: str
-        :return: dict of values for `hr.payslip.worked_days`
-        """
-        values = {
-            'name': 'Timesheet',
-            'sequence': 15,
-            'code': 'TS',
-            'number_of_days': 0.0,
-            'number_of_hours': 0.0,
-            'contract_id': contract.id,
-        }
 
-        valid_ts = [
+        original_work_type = self.env.ref('hr_work_entry.work_entry_type_attendance', raise_if_not_found=False)
-            # ('is_timesheet', '=', True),
+        if original_work_type:
-            # 'is_timesheet' is computed if there is a project_id associated with the entry
+            types_to_remove = original_work_type + timesheet_type
-            ('project_id', '!=', False),
+        else:
-            ('employee_id', '=', contract.employee_id.id),
+            types_to_remove = timesheet_type
-            ('date', '>=', date_from),
-            ('date', '<=', date_to),
-        ]
 
-        days = set()
+        work_data = self._pre_aggregate_timesheet_data()
-        for ts in self.env['account.analytic.line'].search(valid_ts):
+        processed_data = self.aggregate_overtime(work_data)
+
+        lines_to_keep = self.worked_days_line_ids.filtered(lambda x: x.work_entry_type_id not in types_to_remove)
+        # Note that [(5, 0, 0)] + [(4, 999, 0)], will not work
+        work_lines_vals = [(3, line.id, False) for line in (self.worked_days_line_ids - lines_to_keep)]
+        work_lines_vals += [(4, line.id, False) for line in lines_to_keep]
+        work_lines_vals += [(0, 0, {
+            'number_of_days': data[0],
+            'number_of_hours': data[1],
+            'amount': data[1] * data[2] * self._wage_for_work_type(work_type),
+            'contract_id': self.contract_id.id,
+            'work_entry_type_id': work_type.id,
+        }) for work_type, data in processed_data.items()]
+        self.update({'worked_days_line_ids': work_lines_vals})
+
+    def _wage_for_work_type(self, work_type):
+        # Override if you pay differently for different work types
+        return self.contract_id.wage
+
+    def _pre_aggregate_timesheet_data(self):
+        timesheet_type = self.env.ref('hr_payroll_timesheet.work_input_timesheet', raise_if_not_found=False)
+        worked_ts = defaultdict(list)
+        for ts in self.timesheet_ids.sorted('id'):
             if ts.unit_amount:
                 ts_iso = ts.date.isocalendar()
-                if ts_iso not in days:
+                worked_ts[ts_iso].append((timesheet_type, ts.unit_amount, ts))
-                    values['number_of_days'] += 1
+        res = [(k, worked_ts[k]) for k in sorted(worked_ts.keys())]
-                    days.add(ts_iso)
+        return res
-                values['number_of_hours'] += ts.unit_amount
 
-        values['number_of_hours'] = round(values['number_of_hours'], 2)
+    def action_open_timesheets(self):
-        return values
-
-    @api.multi
-    def hour_break_down(self, code):
-        """
-        :param code: what kind of worked days you need aggregated
-        :return: dict: keys are isocalendar tuples, values are hours.
-        """
         self.ensure_one()
-        if code == 'TS':
+        return {
-            timesheets = self.env['account.analytic.line'].search([
+            'type': 'ir.actions.act_window',
-                # ('is_timesheet', '=', True),
+            'name': _('Paid Timesheets'),
-                # 'is_timesheet' is computed if there is a project_id associated with the entry
+            'res_model': 'account.analytic.line',
-                ('project_id', '!=', False),
+            'view_mode': 'tree,form',
-                ('employee_id', '=', self.employee_id.id),
+            'domain': [('id', 'in', self.timesheet_ids.ids)],
-                ('date', '>=', self.date_from),
+        }
-                ('date', '<=', self.date_to),
-            ])
-            day_values = defaultdict(float)
-            for ts in timesheets:
-                if ts.unit_amount:
-                    ts_iso = ts.date.isocalendar()
-                    day_values[ts_iso] += ts.unit_amount
-            return day_values
-        elif hasattr(super(HrPayslip, self), 'hour_break_down'):
-            return super(HrPayslip, self).hour_break_down(code)
-
-    @api.multi
-    def hours_break_down_week(self, code):
-        """
-        :param code: hat kind of worked days you need aggregated
-        :return: dict: keys are isocalendar weeks, values are hours.
-        """
-        days = self.hour_break_down(code)
-        weeks = defaultdict(float)
-        for isoday, hours in days.items():
-            weeks[isoday[1]] += hours
-        return weeks

hr_payroll_timesheet/tests/test_payslip_timesheet.py

@@ -1,29 +1,33 @@
 from odoo.tests import common
-from odoo import fields
 
 
 class TestPayslipTimesheet(common.TransactionCase):
 
     def setUp(self):
         super(TestPayslipTimesheet, self).setUp()
-        self.employee = self.env['hr.employee'].create({
+        self.test_hourly_wage = 21.5
-            'birthday': '1985-03-14',
+        self.employee = self.env.ref('hr.employee_hne')
-            'country_id': self.ref('base.us'),
-            'department_id': self.ref('hr.dep_rd'),
-            'gender': 'male',
-            'name': 'Jared'
-        })
         self.contract = self.env['hr.contract'].create({
-            'name': 'test',
+            'name': 'Test',
             'employee_id': self.employee.id,
-            'type_id': self.ref('hr_contract.hr_contract_type_emp'),
+            'structure_type_id': self.env.ref('hr_payroll.structure_type_employee').id,
-            'struct_id': self.ref('hr_payroll.structure_base'),
-            'resource_calendar_id': self.ref('resource.resource_calendar_std'),
-            'wage': 21.50,
             'date_start': '2018-01-01',
-            'state': 'open',
+            'resource_calendar_id': self.employee.resource_calendar_id.id,
+            'wage': self.test_hourly_wage,
             'paid_hourly_timesheet': True,
-            'schedule_pay': 'monthly',
+            'state': 'open',
+        })
+        self.payslip_dummy = self.env['hr.payslip'].create({
+            'name': 'test slip dummy',
+            'employee_id': self.employee.id,
+            'date_from': '2017-01-01',
+            'date_to': '2017-01-31',
+        })
+        self.payslip = self.env['hr.payslip'].create({
+            'name': 'test slip',
+            'employee_id': self.employee.id,
+            'date_from': '2018-01-01',
+            'date_to': '2018-01-31',
         })
         self.project = self.env['project.project'].create({
             'name': 'Timesheets',
@@ -31,8 +35,6 @@ class TestPayslipTimesheet(common.TransactionCase):
 
     def test_payslip_timesheet(self):
         self.assertTrue(self.contract.paid_hourly_timesheet)
-        from_date = '2018-01-01'
-        to_date = '2018-01-31'
 
         # Day 1
         self.env['account.analytic.line'].create({
@@ -55,7 +57,7 @@ class TestPayslipTimesheet(common.TransactionCase):
             'employee_id': self.employee.id,
             'project_id': self.project.id,
             'date': '2018-01-02',
-            'unit_amount': 1.0,
+            'unit_amount': 10.0,
             'name': 'test',
         })
 
@@ -66,26 +68,60 @@ class TestPayslipTimesheet(common.TransactionCase):
             'date': '2017-01-01',
             'unit_amount': 5.0,
             'name': 'test',
+            'payslip_id': self.payslip_dummy.id,
         })
 
-        # Create slip like a batch run.
+        self.payslip._onchange_employee()
-        slip_data = self.env['hr.payslip'].onchange_employee_id(from_date, to_date, self.employee.id, contract_id=False)
+        self.assertTrue(self.payslip.contract_id, 'No auto-discovered contract!')
-        res = {
+        wage = self.test_hourly_wage
-            'employee_id': self.employee.id,
+        self.payslip.compute_sheet()
-            'name': slip_data['value'].get('name'),
+        self.assertTrue(self.payslip.worked_days_line_ids)
-            'struct_id': slip_data['value'].get('struct_id'),
-            'contract_id': slip_data['value'].get('contract_id'),
-            'input_line_ids': [(0, 0, x) for x in slip_data['value'].get('input_line_ids')],
-            'worked_days_line_ids': [(0, 0, x) for x in slip_data['value'].get('worked_days_line_ids')],
-            'date_from': from_date,
-            'date_to': to_date,
-            'company_id': self.employee.company_id.id,
-        }
-        payslip = self.env['hr.payslip'].create(res)
-        payslip.compute_sheet()
-        self.assertTrue(payslip.worked_days_line_ids)
 
-        timesheet_line = payslip.worked_days_line_ids.filtered(lambda l: l.code == 'TS')
+        timesheet_line = self.payslip.worked_days_line_ids.filtered(lambda l: l.code == 'TS')
         self.assertTrue(timesheet_line)
         self.assertEqual(timesheet_line.number_of_days, 2.0)
-        self.assertEqual(timesheet_line.number_of_hours, 9.0)
+        self.assertEqual(timesheet_line.number_of_hours, 18.0)
+
+        # Day 3
+        self.env['account.analytic.line'].create({
+            'employee_id': self.employee.id,
+            'project_id': self.project.id,
+            'date': '2018-01-03',
+            'unit_amount': 10.0,
+            'name': 'test',
+        })
+        # Day 4
+        self.env['account.analytic.line'].create({
+            'employee_id': self.employee.id,
+            'project_id': self.project.id,
+            'date': '2018-01-04',
+            'unit_amount': 10.0,
+            'name': 'test',
+        })
+        # Day 5
+        self.env['account.analytic.line'].create({
+            'employee_id': self.employee.id,
+            'project_id': self.project.id,
+            'date': '2018-01-05',
+            'unit_amount': 10.0,
+            'name': 'test',
+        })
+        # Day 6
+        self.env['account.analytic.line'].create({
+            'employee_id': self.employee.id,
+            'project_id': self.project.id,
+            'date': '2018-01-06',
+            'unit_amount': 4.0,
+            'name': 'test',
+        })
+
+        self.payslip.state = 'draft'
+        self.payslip._onchange_employee()
+        timesheet_line = self.payslip.worked_days_line_ids.filtered(lambda l: l.code == 'TS')
+        timesheet_overtime_line = self.payslip.worked_days_line_ids.filtered(lambda l: l.code == 'TS_OT')
+        self.assertTrue(timesheet_line)
+        self.assertEqual(timesheet_line.number_of_days, 5.0)
+        self.assertEqual(timesheet_line.number_of_hours, 40.0)
+        self.assertTrue(timesheet_overtime_line)
+        self.assertEqual(timesheet_overtime_line.number_of_days, 1.0)
+        self.assertEqual(timesheet_overtime_line.number_of_hours, 12.0)

hr_payroll_timesheet/views/hr_payslip_views.xml

@@ -0,0 +1,20 @@
+<?xml version="1.0" encoding="utf-8"?>
+<odoo>
+
+    <record id="hr_payslip_view_form_inherit" model="ir.ui.view">
+        <field name="name">hr.payslip.view.form.inherit</field>
+        <field name="model">hr.payslip</field>
+        <field name="inherit_id" ref="hr_payroll.view_hr_payslip_form"/>
+        <field name="arch" type="xml">
+            <xpath expr="//div[@name='button_box']" position="inside">
+                <button class="oe_stat_button" name="action_open_timesheets" type="object" icon="fa-history" attrs="{'invisible': [('timesheet_count', '=', 0)]}">
+                    <field string="Timesheets" name="timesheet_count" widget="statinfo"/>
+                </button>
+            </xpath>
+            <xpath expr="//field[@name='number']" position="after">
+                <field name="timesheet_ids" invisible="1"/>
+            </xpath>
+        </field>
+    </record>
+
+</odoo>