Add billable hours indicator to timecard.

tock/employees/fixtures/user_data.json

@@ -1 +1 @@
-[{"model": "employees.userdata", "pk": 1, "fields": {"user": 1, "start_date": "2013-06-17", "end_date": "2015-05-29", "current_employee": true, "is_18f_employee": true, "is_billable": true, "unit": null}}]
+[{"model": "employees.userdata", "pk": 1, "fields": {"user": 1, "start_date": "2013-06-17", "end_date": "2015-05-29", "current_employee": true, "is_18f_employee": true, "is_billable": true, "unit": null, "billable_expectation": 0.80}}]

tock/employees/migrations/0025_userdata_billable_expectation.py

@@ -0,0 +1,19 @@
+# Generated by Django 2.2.7 on 2019-12-19 14:25
+
+import django.core.validators
+from django.db import migrations, models
+
+
+class Migration(migrations.Migration):
+
+    dependencies = [
+        ('employees', '0024_auto_20171229_1156'),
+    ]
+
+    operations = [
+        migrations.AddField(
+            model_name='userdata',
+            name='billable_expectation',
+            field=models.DecimalField(decimal_places=2, default=0.8, max_digits=3, validators=[django.core.validators.MaxValueValidator(limit_value=1)], verbose_name='Percentage of hours which are expected to be billable each week'),
+        ),
+    ]

tock/employees/models.py

@@ -2,14 +2,12 @@
 
 from django.apps import apps
 from django.contrib.auth import get_user_model
-from django.db import models, IntegrityError
+from django.core.validators import MaxValueValidator
+from django.db import IntegrityError, models
 from django.db.models import Q
-
-from rest_framework.authtoken.models import Token
-
 from organizations.models import Organization
 from projects.models import ProfitLossAccount
-
+from rest_framework.authtoken.models import Token
 
 User = get_user_model()
 
@@ -108,6 +106,9 @@ class UserData(models.Model):
     is_18f_employee = models.BooleanField(default=True, verbose_name='Is 18F Employee')
     is_billable = models.BooleanField(default=True, verbose_name="Is 18F Billable Employee")
     unit = models.IntegerField(null=True, choices=UNIT_CHOICES, verbose_name="Select 18F unit", blank=True)
+    billable_expectation = models.DecimalField(validators=[MaxValueValidator(limit_value=1)],
+                                              default=0.80, decimal_places=2, max_digits=3,
+                                              verbose_name="Percentage of hours (expressed as a decimal) expected to be billable each week")
     profit_loss_account = models.ForeignKey(
         ProfitLossAccount,
         on_delete=models.CASCADE,

tock/employees/tests/test_admin.py

@@ -34,7 +34,8 @@ def test_user_data_form(self):
             'is_18f_employee': '',
             'is_billable': '',
             'unit': '',
-            'profit_loss_account': ProfitLossAccount.objects.first().id
+            'profit_loss_account': ProfitLossAccount.objects.first().id,
+            'billable_expectation': 0.80
         }
         form = UserDataForm(data=form_data)
         self.assertTrue(form.is_valid())

tock/hours/forms.py

@@ -36,7 +36,7 @@ class TimecardForm(forms.ModelForm):
 
     class Meta:
         model = Timecard
-        exclude = ['time_spent', 'reporting_period', 'user']
+        exclude = ['time_spent', 'reporting_period', 'user', 'billable_expectation']
 
 
 class SelectWithData(forms.widgets.Select):

tock/hours/migrations/0048_auto_20191219_0925.py

@@ -0,0 +1,20 @@
+# Generated by Django 2.2.7 on 2019-12-19 14:25
+
+import django.core.validators
+from django.db import migrations, models
+
+
+class Migration(migrations.Migration):
+
+    dependencies = [
+        ('projects', '0024_project_exclude_from_billability'),
+        ('hours', '0047_auto_20191204_0940'),
+    ]
+
+    operations = [
+        migrations.AddField(
+            model_name='timecard',
+            name='billable_expectation',
+            field=models.DecimalField(decimal_places=2, default=0.8, max_digits=3, validators=[django.core.validators.MaxValueValidator(limit_value=1)], verbose_name='Percentage of hours which are expected to be billable this week'),
+        ),
+    ]

tock/hours/models.py

@@ -1,9 +1,9 @@
 import datetime
 
 from django.contrib.auth.models import User
+from django.core.validators import MaxValueValidator
 from django.db import models
 from django.db.models import Q
-
 from employees.models import EmployeeGrade, UserData
 from projects.models import ProfitLossAccount, Project
 
@@ -218,6 +218,9 @@ class Timecard(models.Model):
     submitted = models.BooleanField(default=False)
     created = models.DateTimeField(auto_now_add=True)
     modified = models.DateTimeField(auto_now=True)
+    billable_expectation = models.DecimalField(validators=[MaxValueValidator(limit_value=1)],
+                                            default=0.80, decimal_places=2, max_digits=3,
+                                            verbose_name="Percentage of hours which are expected to be billable this week")
 
     class Meta:
         unique_together = ('user', 'reporting_period')
@@ -226,6 +229,14 @@ class Meta:
     def __str__(self):
         return "%s - %s" % (self.user, self.reporting_period.start_date)
 
+    def save(self, *args, **kwargs):
+        """
+        If this is a new timecard,
+        Set weekly billing expectation from user.user_data
+        """
+        if not self.id and self.user:
+            self.billable_expectation = self.user.user_data.billable_expectation
+        super().save(*args, **kwargs)
 
 class TimecardNoteManager(models.Manager):
     def enabled(self):
@@ -313,7 +324,6 @@ def save(self, *args, **kwargs):
            self.rendered_body = render_markdown(self.body)
         super(TimecardNote, self).save(*args, **kwargs)
 
-
 class TimecardObject(models.Model):
     timecard = models.ForeignKey(Timecard, related_name='timecardobjects', on_delete=models.CASCADE)
     project = models.ForeignKey(Project, on_delete=models.CASCADE)

tock/hours/tests/test_forms.py

@@ -180,7 +180,8 @@ def test_timecard_inline_formset_modify_saved(self):
 
 class TimecardInlineFormSetTests(TestCase):
     fixtures = [
-        'projects/fixtures/projects.json', 'tock/fixtures/prod_user.json']
+        'projects/fixtures/projects.json', 'tock/fixtures/prod_user.json',
+        'employees/fixtures/user_data.json']
 
     setUp = time_card_inlineformset_setup
 

tock/hours/views.py

@@ -1,6 +1,7 @@
 import csv
 import datetime as dt
 import io
+import json
 from itertools import chain
 from operator import attrgetter
 
@@ -504,6 +505,9 @@ def get_context_data(self, **kwargs):
             'timecard_notes': TimecardNote.objects.enabled(),
             'unsubmitted': not self.object.submitted,
             'reporting_period': reporting_period,
+            'excluded_from_billability': json.dumps(list(Project.objects.excluded_from_billability().values_list('id', flat=True))),
+            'billable_expectation': json.dumps(str(self.object.billable_expectation)),
+            'non_billable_projects': json.dumps(list(Project.objects.non_billable().values_list('id', flat=True)))
         })
 
         return context

tock/projects/admin.py

@@ -89,6 +89,7 @@ class ProjectAdmin(admin.ModelAdmin):
         'start_date',
         'end_date',
         'active',
+        'exclude_from_billability',
         'agreement_URL',
         'description',
         'alerts',

tock/projects/migrations/0024_project_exclude_from_billability.py

@@ -0,0 +1,18 @@
+# Generated by Django 2.2.7 on 2019-12-19 14:25
+
+from django.db import migrations, models
+
+
+class Migration(migrations.Migration):
+
+    dependencies = [
+        ('projects', '0023_auto_20171229_1156'),
+    ]
+
+    operations = [
+        migrations.AddField(
+            model_name='project',
+            name='exclude_from_billability',
+            field=models.BooleanField(default=False, help_text='Check if this project should be excluded from calculations of billable hours, e.g. Out of Office'),
+        ),
+    ]

tock/projects/models.py

@@ -186,6 +186,18 @@ def active(self):
     def inactive(self):
         return self.get_queryset().filter(active=False)
 
+    # Get the projects that are categorized as excluded from billability, i.e. out of office, which means
+    # the hours tocked in these projects will not be used in the total hours calculation when tryng to figure
+    # out how many hours should be billable in a reporting period.
+    def excluded_from_billability(self):
+        return self.get_queryset().filter(exclude_from_billability=True)
+
+    # Get the projects that are categorized as nonbillable, which means the hours tocked in these projects
+    # will be used in the total hourse calcuation when trying to figure out how many hours should be billable
+    # in a reporting period.
+    def non_billable(self):
+        return self.get_queryset().filter(exclude_from_billability=False, accounting_code__billable=False)
+
 
 class Project(models.Model):
     """
@@ -230,7 +242,10 @@ class Project(models.Model):
     )
     project_lead = models.ForeignKey(User, null=True, on_delete=models.CASCADE)
     organization = models.ForeignKey(Organization, blank=True, null=True, on_delete=models.CASCADE)
-
+    exclude_from_billability = models.BooleanField(
+        default=False,
+        help_text='Check if this project should be excluded from calculations of billable hours, e.g. Out of Office'
+    )
     objects = ProjectManager()
 
     class Meta:

tock/tock/static/sass/_entries.scss

@@ -154,26 +154,58 @@
 	padding-top: 1.5rem;
 }
 
-.entries-total-reported-amount {
-	display:block;
-border: 1px solid #5b616b;
-border-radius: 0;
-box-sizing: border-box;
-color: #1F2E4A;
-display: block;
-font-size: 1.7rem;
-height: 4.4rem;
-line-height: 1.3;
-margin: 0.2em 0;
-max-width: 46rem;
-outline: none;
-padding: 1rem 0.7em;
-width: 65%;
-background-color: $color-green-lightest;
+.entries-total {
+  .text-label {
+    display: inline-block;
+    margin-bottom: 1rem;
+  }
+}
+
+.entries-total-reported-amount, .entries-total-billable-amount {
+  &, .number-label, .circular-graph {
+    width: 60px;
+    height: 60px;
+  }
+
+  .number-label {
+    position: relative;
+    display: table-cell;
+    vertical-align: middle;
+    text-align: center;
+    font-weight: bold;
+  }
+
+  .circular-graph {
+    transform: rotate(-90deg);
+    position: absolute;
+    left: 0;
+
+    .background {
+      fill: none;
+      stroke: $color-primary-alt-lightest;
+      stroke-width: 3;
+      transition: stroke-dasharray 0.3s ease-out;
+    }
+
+    .fill {
+      fill: none;
+      stroke: currentColor;
+      stroke-width: 3;
+      transition: stroke-dasharray 0.3s ease-out;
+    }
+  }
+
   &.invalid {
-	background-color: $color-secondary-dark;
-	color: #fff;
+    color: $color-secondary-dark;
   }
+
+  &.valid {
+    color: $color-green;
+  }
+
+  display: block;
+  position: relative;
+  color: $color-primary-alt-lightest;
 }
 
 .entries-total {
@@ -197,15 +229,6 @@ background-color: $color-green-lightest;
       margin-top: 0.5em;
     }
 	}
-	.entries-total-billable-amount {
-		color: green;
-	}
-	.entries-total-non-billable-amount {
-		color: #1188ff;
-	}
-	.entries-total-reported-wrapper {
-		font-weight:bold;
-	}
 }
 
 .form-error,