Merge pull request #467 from timeoff-management/leaves-report-issues

Fixes to the recently introduced features

Author: vpp

README.md

@@ -122,6 +122,13 @@ npm run-script db-update
 npm start
 ```
 
+## How to?
+
+There are some customizations available.
+
+## How to amend or extend colours available for colour picker?
+Follow instructions on [this page](docs/extend_colors_for_leave_type.md).
+
 
 ## Feedback
 

docs/extend_colors_for_leave_type.md

@@ -0,0 +1,27 @@
+
+# Leave types colour setup
+
+For some organizations the available set of colours is not enough. The page describes how to extend the set and amend the values of available colours.
+
+# Amend colours of available options
+
+## To change the predefined colours one needs:
+
+* to open `scss/main.scss`
+* find classes of `leave_type_color_1` or similar
+* updated the classes to have relevant color for the `background` property
+* run the `npm run compile-sass` command to generate the css file
+* comment changes to git.
+
+## To add new colours to the set of available colours
+
+* open handlebar partial file that holds available options for the colour picker: `views/partials/options_for_color_picker.hbs`
+* add new option by adding line of following format:
+```
+<li><a href="#" class="btn btd-default leave_type_color_X" data-tom-color-picker-css-class="leave_type_color_X">Color X</a></li>
+```
+* * where `X` is next integer from the biggest one available so far
+* open `scss/main.scss`
+* find classes of `leave_type_color_` shape and add new one `leave_type_color_X` with colour of your choice
+* run the `npm run compile-sass` command to generate the css file
+* comment changes to git.

lib/model/db/user.js

@@ -14,6 +14,7 @@ const
     withCompanyAwareness = require('../mixin/user/company_aware'),
     withAbsenceAwareness = require('../mixin/user/absence_aware');
 
+const LeaveCollectionUtil = require('../leave_collection')();
 
 module.exports = function(sequelize, DataTypes) {
 
@@ -268,10 +269,12 @@ function get_instance_methods(sequelize) {
     },
 
     reload_with_leave_details : function(args){
-      var self = this;
+      const self = this;
+      const dbModel = self.sequelize.models;
 
       return Promise.join(
-        self.promise_my_active_leaves(args),
+        self.promise_my_active_leaves(args)
+          .then(leaves => LeaveCollectionUtil.enrichLeavesWithComments({leaves, dbModel})),
         self.getDepartment(),
         self.promise_schedule_I_obey(),
         function(leaves, department, schedule){
@@ -280,7 +283,7 @@ function get_instance_methods(sequelize) {
 
           // Note: we do not do anything with scheduler as "promise_schedule_I_obey"
           // sets the "cached_schedule" attribute under the hood, which is used in
-          // synchronous code afterwards. Yes... it is silly, but it is where we are
+          // synchronous code afterwards. Yes... itaza`z is silly, but it is where we are
           // at thi moment after mixing non blocking and blocking code together...
           //
           return Promise.resolve(self);

lib/model/leave_collection.js

@@ -59,9 +59,26 @@ function promise_to_sort_leaves(leaves) {
   ));
 }
 
+const enrichLeavesWithComments = async ({leaves, dbModel}) => {
+  const comments = await dbModel.Comment.findAll({where: {
+    entityId: { $in: leaves.map(l => l.id)},
+    entityType: dbModel.Comment.getEntityTypeLeave(),
+  }});
+
+  // Map comments by Leave ID
+  const commentMap = comments.reduce((acc, c) => {acc[c.entityId]=c; return acc}, {});
+
+  leaves
+    .filter(l => commentMap[l.id] !== undefined)
+    .forEach(l => l.comment = commentMap[l.id]);
+
+  return leaves;
+};
+
 module.exports = function(){
   return {
-    promise_to_group_leaves : promise_to_group_leaves,
-    promise_to_sort_leaves : promise_to_sort_leaves,
+    enrichLeavesWithComments,
+    promise_to_group_leaves,
+    promise_to_sort_leaves,
   };
 };

lib/route/reports.js

@@ -188,7 +188,7 @@ const renderLeavesReportAsCsv = async ({res, company, startDate, endDate, leaves
 
   // Compose result CSV header
   const content = [
-    ['Employee', 'Department', 'Leave Type', 'Deducted days', 'From', 'To', 'Status', 'Requested On', 'Approved By']
+    ['Employee', 'Department', 'Leave Type', 'Deducted days', 'From', 'To', 'Status', 'Requested On', 'Approved By', 'Comment']
   ];
 
   // ... and body

lib/route/requests.js

@@ -10,20 +10,23 @@ var express   = require('express'),
     EmailTransport      = require('../email');
 
 router.get('/', function(req, res){
-
-    Promise.join(
-        req.user
-          .promise_my_active_leaves_ever()
-          .then(leaves => LeaveCollectionUtil.promise_to_group_leaves(leaves)),
-        req.user.promise_leaves_to_be_processed(),
-        function(my_leaves_grouped, to_be_approved_leaves){
-
-            res.render('requests',{
-                my_leaves_grouped     : my_leaves_grouped,
-                to_be_approved_leaves : to_be_approved_leaves,
-            });
-        }
-    );
+  const dbModel = req.app.get('db_model');
+
+  Promise.join(
+      req.user
+        .promise_my_active_leaves_ever()
+        .then(leaves => LeaveCollectionUtil.enrichLeavesWithComments({leaves, dbModel}))
+        .then(leaves => LeaveCollectionUtil.promise_to_group_leaves(leaves)),
+      req.user
+        .promise_leaves_to_be_processed()
+        .then(leaves => LeaveCollectionUtil.enrichLeavesWithComments({leaves, dbModel})),
+      function(my_leaves_grouped, to_be_approved_leaves){
+        res.render('requests',{
+          my_leaves_grouped     : my_leaves_grouped,
+          to_be_approved_leaves : to_be_approved_leaves,
+        });
+      }
+  );
 });
 
 function leave_request_action(args) {

lib/route/users/index.js

@@ -255,6 +255,8 @@ router.get('/edit/:user_id/absences/', function(req, res){
     user_id = validator.trim(req.params['user_id']),
     user_allowance;
 
+  const dbModel = req.app.get('db_model');
+
   Promise
 
   .try( () => ensure_user_id_is_integer({req : req, user_id : user_id}) )
@@ -313,6 +315,7 @@ router.get('/edit/:user_id/absences/', function(req, res){
       .then(function(){
         employee
           .promise_my_active_leaves_ever({})
+          .then(leaves => LeaveCollectionUtil.enrichLeavesWithComments({leaves, dbModel}))
           .then(leaves => LeaveCollectionUtil.promise_to_group_leaves(leaves))
           .then(function(grouped_leaves){
 

views/general_settings.hbs

@@ -222,11 +222,7 @@
                 <input type="hidden" name="color__{{ this.id }}" value="{{# with this }}{{ this.get_color_class }}{{/with}}">
                 <button type="button" class="btn btn-default dropdown-toggle {{# with this }}{{ this.get_color_class }}{{/with}}" data-toggle="dropdown" aria-haspopup="true" aria-expanded="false"><i class="fa fa-paint-brush"></i></button>
                 <ul class="dropdown-menu">
-                  <li><a href="#" class="btn btd-default leave_type_color_1" data-tom-color-picker-css-class="leave_type_color_1">Color 1</a></li>
-                  <li><a href="#" class="btn btd-default leave_type_color_2" data-tom-color-picker-css-class="leave_type_color_2">Color 2</a></li>
-                  <li><a href="#" class="btn btd-default leave_type_color_3" data-tom-color-picker-css-class="leave_type_color_3">Color 3</a></li>
-                  <li><a href="#" class="btn btd-default leave_type_color_4" data-tom-color-picker-css-class="leave_type_color_4">Color 4</a></li>
-                  <li><a href="#" class="btn btd-default leave_type_color_5" data-tom-color-picker-css-class="leave_type_color_5">Color 5</a></li>
+                  {{> options_for_color_picker}}
                 </ul>
               </div>
 

views/partials/add_new_leave_type_modal.hbs

@@ -28,11 +28,7 @@
             <input type="hidden" name="color__new" value="leave_type_color_1">
             <button type="button" class="btn btn-default dropdown-toggle leave_type_color_1" data-toggle="dropdown" aria-haspopup="true" aria-expanded="false"><i class="fa fa-paint-brush"></i> Pick up color for new type</button>
             <ul class="dropdown-menu">
-              <li><a href="#" class="btn btd-default leave_type_color_1" data-tom-color-picker-css-class="leave_type_color_1">Color 1</a></li>
-              <li><a href="#" class="btn btd-default leave_type_color_2" data-tom-color-picker-css-class="leave_type_color_2">Color 2</a></li>
-              <li><a href="#" class="btn btd-default leave_type_color_3" data-tom-color-picker-css-class="leave_type_color_3">Color 3</a></li>
-              <li><a href="#" class="btn btd-default leave_type_color_4" data-tom-color-picker-css-class="leave_type_color_4">Color 4</a></li>
-              <li><a href="#" class="btn btd-default leave_type_color_5" data-tom-color-picker-css-class="leave_type_color_5">Color 5</a></li>
+              {{> options_for_color_picker}}
             </ul>
           </div>
           <p><em>Determine how leaves of new type are going to be highlighted on Calendar/Team view pages.</em></p>

views/partials/options_for_color_picker.hbs

@@ -0,0 +1,5 @@
+<li><a href="#" class="btn btd-default leave_type_color_1" data-tom-color-picker-css-class="leave_type_color_1">Color 1</a></li>
+<li><a href="#" class="btn btd-default leave_type_color_2" data-tom-color-picker-css-class="leave_type_color_2">Color 2</a></li>
+<li><a href="#" class="btn btd-default leave_type_color_3" data-tom-color-picker-css-class="leave_type_color_3">Color 3</a></li>
+<li><a href="#" class="btn btd-default leave_type_color_4" data-tom-color-picker-css-class="leave_type_color_4">Color 4</a></li>
+<li><a href="#" class="btn btd-default leave_type_color_5" data-tom-color-picker-css-class="leave_type_color_5">Color 5</a></li>

views/partials/user_requests.hbs

@@ -17,6 +17,7 @@
           <th>Deducted</th>
           <th>Approved by</th>
           <th></th>
+          <th class="col-xs-2">Comment</th>
           <th><span class="pull-right">Status</span></th>
         </tr>
       </thead>
@@ -36,18 +37,19 @@
           {{# unless this.is_pended_revoke_leave}}
           <form method="post" action="/requests/revoke/">
             <input type="hidden" value="{{this.id}}" name="request">
-            <button type="submit" class="pull-right btn btn-default btn-xs revoke-btn" title="Revoke leave request. Subject of approval."><i class="fa fa-trash"> Revoke</i></button>
+            <button type="submit" class="pull-right btn btn-default btn-xs revoke-btn" title="Revoke leave request. Subject of approval."><i class="fa fa-trash"></i> Revoke</button>
           </form>
           {{/unless}}
           {{else}}
             {{#if_equal this.userId ../logged_user.id }}
             <form method="post" action='/requests/cancel/'>
               <input type="hidden" value="{{this.id}}" name="request">
-              <button type="submit" class="pull-right btn btn-default btn-xs revoke-btn" title="Cancel leave request" value="cancel"><i class="fa fa-trash"> Cancel</i></button>
+              <button type="submit" class="pull-right btn btn-default btn-xs revoke-btn" title="Cancel leave request" value="cancel"><i class="fa fa-trash"></i> Cancel</button>
             </form>
             {{/if_equal}}
           {{/if}}
         </td>
+        <td>{{this.comment.comment}}</td>
         <td><span class="pull-right leave-request-row-status">{{#if this.is_new_leave }}Pending{{else}}{{#if this.is_approved_leave}}Approved{{else}}Rejected{{/if}}{{/if}}</span></td>
       </tr>
 

views/requests.hbs

@@ -27,6 +27,7 @@
           <th>Leave dates</th>
           <th>Type</th>
           <th>Days</th>
+          <th class="col-xs-2">Comment</th>
           <th colspan="2"></th>
         </tr>
       </thead>
@@ -41,6 +42,7 @@
           <td data-tom-leave-dates="1"><a class="leave-details-summary-trigger" data-leave-id="{{this.id}}" href="#">{{> leave_dates leave=this}}</a></td>
           <td>{{#if this.is_pended_revoke_leave}}REVOKE {{/if}}{{this.leave_type.name}}</td>
           <td data-vpp="days_used">{{ this.get_deducted_days_number }}</td>
+          <td>{{this.comment.comment}}</td>
           <td>
             <form action="/requests/reject/" method="POST">
             <input class="btn btn-warning" type="submit" value="Reject">