Migrate module hr_timesheet_sheet_period to v12

Author: AdriaGForgeFlow

Diff for: hr_timesheet_sheet_period/README.rst

@@ -1,15 +1,39 @@
-.. image:: https://img.shields.io/badge/licence-AGPL--3-blue.svg
-   :target: http://www.gnu.org/licenses/agpl-3.0-standalone.html
-   :alt: License: AGPL-3
-
 ==========================================
 HR Timesheet Sheet based on Payroll Period
 ==========================================
 
+.. !!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!
+   !! This file is generated by oca-gen-addon-readme !!
+   !! changes will be overwritten.                   !!
+   !!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!
+
+.. |badge1| image:: https://img.shields.io/badge/maturity-Beta-yellow.png
+    :target: https://odoo-community.org/page/development-status
+    :alt: Beta
+.. |badge2| image:: https://img.shields.io/badge/licence-AGPL--3-blue.png
+    :target: http://www.gnu.org/licenses/agpl-3.0-standalone.html
+    :alt: License: AGPL-3
+.. |badge3| image:: https://img.shields.io/badge/github-OCA%2Fhr--timesheet-lightgray.png?logo=github
+    :target: https://github.com/OCA/hr-timesheet/tree/12.0/hr_timesheet_sheet_period
+    :alt: OCA/hr-timesheet
+.. |badge4| image:: https://img.shields.io/badge/weblate-Translate%20me-F47D42.png
+    :target: https://translation.odoo-community.org/projects/hr-timesheet-12-0/hr-timesheet-12-0-hr_timesheet_sheet_period
+    :alt: Translate me on Weblate
+.. |badge5| image:: https://img.shields.io/badge/runbot-Try%20me-875A7B.png
+    :target: https://runbot.odoo-community.org/runbot/117/12.0
+    :alt: Try me on Runbot
+
+|badge1| |badge2| |badge3| |badge4| |badge5| 
+
 This module allows to create timesheets with start and end dates matching with the
-payroll period of the schedule pay that is specified in the contract of the 
+payroll period of the schedule pay that is specified in the contract of the
 employee or if not then will match the nearest payroll period.
 
+**Table of contents**
+
+.. contents::
+   :local:
+
 Configuration
 =============
 
@@ -21,48 +45,47 @@ Usage
 
 When the user goes to 'Human Resources > Time Tracking > My current
 timesheet', the application will attempt to create a new timesheet using
-start and end dates of the Pay Period corresponding to today's date 
+start and end dates of the Pay Period corresponding to today's date
 as per the Schedule Pay mentioned in the Employee's contract.
 
-.. image:: https://odoo-community.org/website/image/ir.attachment/5784_f2813bd/datas
-   :alt: Try me on Runbot
-   :target: https://runbot.odoo-community.org/runbot/117/10.0
-
-
 Bug Tracker
 ===========
 
-Bugs are tracked on `GitHub Issues
-<https://github.com/OCA/hr-timesheet/issues>`_. In case of trouble, please
-check there if your issue has already been reported. If you spotted it first,
-help us smashing it by providing a detailed and welcomed feedback.
+Bugs are tracked on `GitHub Issues <https://github.com/OCA/hr-timesheet/issues>`_.
+In case of trouble, please check there if your issue has already been reported.
+If you spotted it first, help us smashing it by providing a detailed and welcomed
+`feedback <https://github.com/OCA/hr-timesheet/issues/new?body=module:%20hr_timesheet_sheet_period%0Aversion:%2012.0%0A%0A**Steps%20to%20reproduce**%0A-%20...%0A%0A**Current%20behavior**%0A%0A**Expected%20behavior**>`_.
 
+Do not contact contributors directly about support or help with technical issues.
 
 Credits
 =======
 
-Images
-------
+Authors
+~~~~~~~
 
-* Odoo Community Association: `Icon <https://github.com/OCA/maintainer-tools/blob/master/template/module/static/description/icon.svg>`_.
+* Eficent Business and IT Consulting Services S.L.
+* Serpent Consulting Services Pvt. Ltd.
 
 Contributors
-------------
+~~~~~~~~~~~~
 
 * Jordi Ballester Alomar <[email protected]>
 * Serpent Consulting Services Pvt. Ltd. <[email protected]>
 
-Maintainer
-----------
+Maintainers
+~~~~~~~~~~~
+
+This module is maintained by the OCA.
 
 .. image:: https://odoo-community.org/logo.png
    :alt: Odoo Community Association
    :target: https://odoo-community.org
 
-This module is maintained by the OCA.
-
 OCA, or the Odoo Community Association, is a nonprofit organization whose
 mission is to support the collaborative development of Odoo features and
 promote its widespread use.
 
-To contribute to this module, please visit https://odoo-community.org.
+This module is part of the `OCA/hr-timesheet <https://github.com/OCA/hr-timesheet/tree/12.0/hr_timesheet_sheet_period>`_ project on GitHub.
+
+You are welcome to contribute. To learn how please visit https://odoo-community.org/page/Contribute.

Diff for: hr_timesheet_sheet_period/__init__.py

@@ -1,3 +1,3 @@
-# -*- coding: utf-8 -*-
+# License AGPL-3.0 or later (https://www.gnu.org/licenses/agpl.html).
 
 from . import models

Diff for: hr_timesheet_sheet_period/__manifest__.py

@@ -1,16 +1,15 @@
-# -*- coding: utf-8 -*-
 # Copyright 2016-17 Eficent Business and IT Consulting Services S.L.
 # Copyright 2016-17 Serpent Consulting Services Pvt. Ltd.
 # License AGPL-3.0 or later (https://www.gnu.org/licenses/agpl.html).
 
 {
     'name': "HR Timesheet Sheet based on Payroll Period",
-    'version': '10.0.1.0.0',
+    'version': '12.0.1.0.0',
     'category': 'Human Resources',
     "author": "Eficent Business and IT Consulting Services S.L., "
               "Serpent Consulting Services Pvt. Ltd., "
               "Odoo Community Association (OCA)",
-    'website': 'http://www.eficent.com',
+    'website': 'https://github.com/OCA/hr-timesheet',
     'license': 'AGPL-3',
     "depends": ['hr_period', 'hr_timesheet_sheet'],
     "data": [

Diff for: hr_timesheet_sheet_period/models/__init__.py

@@ -1,3 +1,3 @@
-# -*- coding: utf-8 -*-
+# License AGPL-3.0 or later (https://www.gnu.org/licenses/agpl.html).
 
 from . import hr_timesheet_sheet

Diff for: hr_timesheet_sheet_period/models/hr_timesheet_sheet.py

@@ -1,55 +1,59 @@
-# -*- coding: utf-8 -*-
 # Copyright 2016-17 Eficent Business and IT Consulting Services S.L.
 # Copyright 2016-17 Serpent Consulting Services Pvt. Ltd.
 # License AGPL-3.0 or later (https://www.gnu.org/licenses/agpl.html).
 
 from datetime import datetime
 from odoo import api, fields, models, _
-from odoo.exceptions import ValidationError as UserError
+from odoo.exceptions import ValidationError
+from odoo.tools import DEFAULT_SERVER_DATETIME_FORMAT
 
 
 class HrTimesheetSheet(models.Model):
-    _inherit = "hr_timesheet_sheet.sheet"
+    _inherit = "hr_timesheet.sheet"
 
     @api.model
-    def _default_date_from(self):
-        res = super(HrTimesheetSheet, self)._default_date_from()
+    def _default_date_start(self):
+        res = super(HrTimesheetSheet, self)._default_date_start()
         period = self._get_current_pay_period()
-        if period:
-            return period.date_start
-        else:
-            return res
+        return period and period.date_start or res
 
     @api.model
-    def _default_date_to(self):
-        res = super(HrTimesheetSheet, self)._default_date_to()
+    def _default_date_end(self):
+        res = super(HrTimesheetSheet, self)._default_date_end()
         period = self._get_current_pay_period()
-        if period:
-            return period.date_end
-        else:
-            return res
+        return period and period.date_end or res
 
     @api.model
     def _default_hr_period_id(self):
         return self._get_current_pay_period()
 
-    hr_period_id = fields.Many2one('hr.period', string='Pay Period',
-                                   readonly=True,
-                                   states={'new': [('readonly', False)]},
-                                   default=_default_hr_period_id)
-    date_from = fields.Date('Date from', required=True, index=True,
-                            readonly=True,
-                            states={'new': [('readonly', False)]},
-                            default=_default_date_from)
-    date_to = fields.Date('Date to', required=True, index=True, readonly=True,
-                          states={'new': [('readonly', False)]},
-                          default=_default_date_to)
+    hr_period_id = fields.Many2one(
+        'hr.period',
+        string='Pay Period',
+        readonly=True,
+        states={'draft': [('readonly', False)]},
+        default=_default_hr_period_id
+    )
+    date_start = fields.Date(
+        string='Date From',
+        default=lambda self: self._default_date_start(),
+        required=True,
+        index=True,
+        states={'draft': [('readonly', False)]},
+    )
+    date_end = fields.Date(
+        string='Date To',
+        default=lambda self: self._default_date_end(),
+        required=True,
+        index=True,
+        states={'draft': [('readonly', False)]},
+    )
 
     @api.multi
     def name_get(self):
         if not self._ids:
             return []
-        if isinstance(self._ids, (long, int)):
+        if isinstance(self._ids, int):
             self._ids = [self._ids]
         res = super(HrTimesheetSheet, self).name_get()
         res2 = []
@@ -68,15 +72,15 @@ def name_get(self):
     @api.onchange('hr_period_id')
     def onchange_pay_period(self):
         if self.hr_period_id:
-            self.date_from = self.hr_period_id.date_start
-            self.date_to = self.hr_period_id.date_end
+            self.date_start = self.hr_period_id.date_start
+            self.date_end = self.hr_period_id.date_end
             self.name = self.hr_period_id.name
 
     @api.model
     def _get_current_pay_period(self):
         period_obj = self.env['hr.period']
         contract_obj = self.env['hr.contract']
-        date_today = datetime.today().strftime('%Y-%m-%d')
+        date_today = datetime.today().strftime(DEFAULT_SERVER_DATETIME_FORMAT)
         employee = self.default_get(['employee_id'])
         contract = contract_obj.search([('employee_id', '=',
                                          employee.get('employee_id'))])
@@ -91,18 +95,18 @@ def _get_current_pay_period(self):
             return False
 
     @api.multi
-    @api.constrains('date_from', 'date_to', 'hr_period_id')
+    @api.constrains('date_start', 'date_end', 'hr_period_id')
     def _check_start_end_dates(self):
         for timesheet in self:
             if timesheet.hr_period_id:
-                if timesheet.date_from != timesheet.hr_period_id.date_start:
-                    raise UserError(
+                if timesheet.date_start != timesheet.hr_period_id.date_start:
+                    raise ValidationError(
                         _("The Date From of Timesheet must match with that of"
                           " date start '%s' of the Payroll period '%s'.") % (
                             timesheet.hr_period_id.date_start,
                             timesheet.hr_period_id.name))
-                if timesheet.date_to != timesheet.hr_period_id.date_end:
-                    raise UserError(
+                if timesheet.date_end != timesheet.hr_period_id.date_end:
+                    raise ValidationError(
                         _("The Date To of Timesheet must match with that of"
                           " date stop '%s' of the Payroll period '%s'.") % (
                             timesheet.hr_period_id.date_end,

Diff for: hr_timesheet_sheet_period/readme/CONFIGURE.rst

@@ -0,0 +1,2 @@
+Create first the Payroll Fiscal Years and Payroll
+Periods from 'Human Resources > Configuration > Payroll'

Diff for: hr_timesheet_sheet_period/readme/CONTRIBUTORS.rst

@@ -0,0 +1,2 @@
+* Jordi Ballester Alomar <[email protected]>
+* Serpent Consulting Services Pvt. Ltd. <[email protected]>

Diff for: hr_timesheet_sheet_period/readme/DESCRIPTION.rst

@@ -0,0 +1,3 @@
+This module allows to create timesheets with start and end dates matching with the
+payroll period of the schedule pay that is specified in the contract of the
+employee or if not then will match the nearest payroll period.

Diff for: hr_timesheet_sheet_period/readme/USAGE.rst

@@ -0,0 +1,4 @@
+When the user goes to 'Human Resources > Time Tracking > My current
+timesheet', the application will attempt to create a new timesheet using
+start and end dates of the Pay Period corresponding to today's date
+as per the Schedule Pay mentioned in the Employee's contract.