From 2c13736cbf5bd27e0e30a98529ec4fc368f0f6df Mon Sep 17 00:00:00 2001
From: "Denis Vermylen (dve)" <dve@odoo.com>
Date: Mon, 3 Oct 2016 13:18:45 +0200
Subject: [PATCH] [IMP] attendance: help messages, comments, ...

- improve some help messages
- improve comments
- small refactoring
- add category to group "Manual Attendance"
---
 addons/hr_attendance/models/hr_employee.py       | 16 +++++-----------
 .../security/hr_attendance_security.xml          |  3 ++-
 2 files changed, 7 insertions(+), 12 deletions(-)

diff --git a/addons/hr_attendance/models/hr_employee.py b/addons/hr_attendance/models/hr_employee.py
index b794f8fee28..5b5d5a15d99 100644
--- a/addons/hr_attendance/models/hr_employee.py
+++ b/addons/hr_attendance/models/hr_employee.py
@@ -21,13 +21,13 @@ class HrEmployee(models.Model):
         return barcode
 
     barcode = fields.Char(string="Badge ID", help="ID used for employee identification.", default=_default_random_barcode, copy=False)
-    pin = fields.Char(string="PIN", default=_default_random_pin, help="PIN used for Check In/Out in Attendance.", copy=False)
+    pin = fields.Char(string="PIN", default=_default_random_pin, help="PIN used to Check In/Out in Kiosk Mode (if enabled in Configuration).", copy=False)
 
     attendance_ids = fields.One2many('hr.attendance', 'employee_id', help='list of attendances for the employee')
     last_attendance_id = fields.Many2one('hr.attendance', compute='_compute_last_attendance_id')
     attendance_state = fields.Selection(string="Attendance", compute='_compute_attendance_state', selection=[('checked_out', "Checked out"), ('checked_in', "Checked in")])
     manual_attendance = fields.Boolean(string='Manual Attendance', compute='_compute_manual_attendance', inverse='_inverse_manual_attendance',
-                                       help='The employee will have access to the "My Attendances" menu to perform his check in and out from his session')
+                                       help='The employee will have access to the "My Attendances" menu to check in and out from his session')
 
     _sql_constraints = [('barcode_uniq', 'unique (barcode)', "The Badge ID must be unique, this one is already assigned to another employee.")]
 
@@ -53,8 +53,6 @@ class HrEmployee(models.Model):
 
     @api.depends('last_attendance_id.check_in', 'last_attendance_id.check_out', 'last_attendance_id')
     def _compute_attendance_state(self):
-        """compute employee state, last check in and last check out
-        """
         for employee in self:
             employee.attendance_state = employee.last_attendance_id and not employee.last_attendance_id.check_out and 'checked_in' or 'checked_out'
 
@@ -66,7 +64,7 @@ class HrEmployee(models.Model):
 
     @api.model
     def attendance_scan(self, barcode):
-        """ Receive a barcode scanned from the main menu and change the attendances of corresponding employee.
+        """ Receive a barcode scanned from the Kiosk Mode and change the attendances of corresponding employee.
             Returns either an action or a warning.
         """
         employee = self.search([('barcode', '=', barcode)], limit=1)
@@ -85,7 +83,7 @@ class HrEmployee(models.Model):
     def attendance_action(self, next_action):
         """ Changes the attendance of the employee.
             Returns an action to the check in/out message,
-            next_action defines which menu the check in/out message should return to.
+            next_action defines which menu the check in/out message should return to. ("My Attendances" or "Kiosk Mode")
         """
         self.ensure_one()
         action_message = self.env.ref('hr_attendance.hr_attendance_action_greeting_message').read()[0]
@@ -113,11 +111,7 @@ class HrEmployee(models.Model):
             raise exceptions.UserError(_('Cannot perform check in or check out on multiple employees.'))
         action_date = fields.Datetime.now()
 
-        action = 'check_in'
-        if self.attendance_state == 'checked_in':
-            action = 'check_out'
-
-        if action == 'check_in':
+        if self.attendance_state != 'checked_in':
             vals = {
                 'employee_id': self.id,
                 'check_in': action_date,
diff --git a/addons/hr_attendance/security/hr_attendance_security.xml b/addons/hr_attendance/security/hr_attendance_security.xml
index 559df28e799..76a67019658 100644
--- a/addons/hr_attendance/security/hr_attendance_security.xml
+++ b/addons/hr_attendance/security/hr_attendance_security.xml
@@ -27,7 +27,8 @@
     </record>
 
     <record id="hr.group_hr_attendance" model="res.groups">
-        <field name="name">Manual Attendances</field>
+        <field name="name">Manual Attendance</field>
+        <field name="category_id" ref="base.module_category_hr_attendance"/>
         <field name="comment">The user will gain access to the human resources attendance menu, enabling him to manage his own attendance.</field>
     </record>