5c8508171a
Extends the app with friendly form-based management for Teams and Projects — an alternative to using Django admin for routine maintenance. New URLs (admin-only, all return 403 for non-admins): - /teams/ · /teams/new/ · /teams/<id>/ · /teams/<id>/edit/ - /teams/report/ · /teams/report/csv/ - /projects/ + same 5 variants Forms (core/forms.py): - TeamForm — ModelForm with pay-schedule validation (both or neither field) - ProjectForm — ModelForm with end_date >= start_date validation - _supervisor_user_queryset() — admins + Work Logger group members Views (core/views.py): - 10 new views (5 per model: list, detail, edit, batch_report, batch_csv) - _build_team_report_context() / _build_project_report_context() shared helpers - All views gate on is_admin(user) - Reuses existing get_pay_period() for Team detail Pay Schedule tab Templates (core/templates/core/teams/ and projects/): - list.html — filterable table with search - detail.html — tabbed profile / workers / history / schedule - edit.html — serves both /new/ and /edit/ - batch_report.html — lifetime aggregates per row, CSV download UI integration: - Resources dropdown added to top nav (admin-only, Teams + Projects) - Manage All buttons added to Dashboard Manage Resources tabs (Teams, Projects) No model changes, no migrations — purely additive. CLAUDE.md updated with new routes and section describing the pattern. Co-Authored-By: Claude Opus 4.7 (1M context) <noreply@anthropic.com>
355 lines
15 KiB
Python
355 lines
15 KiB
Python
# === FORMS ===
|
|
# Django form classes for the app.
|
|
# - AttendanceLogForm: daily work log creation with date ranges and conflict detection
|
|
# - PayrollAdjustmentForm: adding bonuses, deductions, overtime, and loan adjustments
|
|
# - ExpenseReceiptForm + ExpenseLineItemFormSet: expense receipt creation with dynamic line items
|
|
|
|
from django import forms
|
|
from django.forms import inlineformset_factory
|
|
from django.contrib.auth.models import User
|
|
from django.db.models import Q
|
|
from .models import WorkLog, Project, Team, Worker, PayrollAdjustment, ExpenseReceipt, ExpenseLineItem
|
|
|
|
|
|
# === HELPER: who can be a supervisor? ===
|
|
# The app's business rule: a "supervisor" is either an admin (is_staff)
|
|
# or a member of the "Work Logger" group. We reuse this queryset in both
|
|
# TeamForm (single supervisor) and ProjectForm (multiple supervisors).
|
|
def _supervisor_user_queryset():
|
|
return User.objects.filter(
|
|
Q(is_staff=True) | Q(groups__name='Work Logger')
|
|
).distinct().order_by('username')
|
|
|
|
|
|
class AttendanceLogForm(forms.ModelForm):
|
|
"""
|
|
Form for logging daily worker attendance.
|
|
|
|
Extra fields (not on the WorkLog model):
|
|
- end_date: optional end date for logging multiple days at once
|
|
- include_saturday: whether to include Saturdays in a date range
|
|
- include_sunday: whether to include Sundays in a date range
|
|
|
|
The supervisor field is NOT shown on the form — it gets set automatically
|
|
in the view to whoever is logged in.
|
|
"""
|
|
|
|
# --- Extra fields for date range logging ---
|
|
# These aren't on the WorkLog model, they're only used by the form
|
|
end_date = forms.DateField(
|
|
required=False,
|
|
widget=forms.DateInput(attrs={'type': 'date', 'class': 'form-control'}),
|
|
label='End Date',
|
|
help_text='Leave blank to log a single day'
|
|
)
|
|
include_saturday = forms.BooleanField(
|
|
required=False,
|
|
initial=False,
|
|
label='Include Saturdays',
|
|
widget=forms.CheckboxInput(attrs={'class': 'form-check-input'})
|
|
)
|
|
include_sunday = forms.BooleanField(
|
|
required=False,
|
|
initial=False,
|
|
label='Include Sundays',
|
|
widget=forms.CheckboxInput(attrs={'class': 'form-check-input'})
|
|
)
|
|
|
|
class Meta:
|
|
model = WorkLog
|
|
# Supervisor is NOT included — it gets set in the view automatically
|
|
fields = ['date', 'project', 'team', 'workers', 'overtime_amount', 'notes']
|
|
widgets = {
|
|
'date': forms.DateInput(attrs={'type': 'date', 'class': 'form-control'}),
|
|
'project': forms.Select(attrs={'class': 'form-select'}),
|
|
'team': forms.Select(attrs={'class': 'form-select'}),
|
|
'workers': forms.CheckboxSelectMultiple(attrs={'class': 'form-check-input'}),
|
|
'overtime_amount': forms.Select(attrs={'class': 'form-select'}),
|
|
'notes': forms.Textarea(attrs={
|
|
'class': 'form-control',
|
|
'rows': 3,
|
|
'placeholder': 'Any notes about the day...'
|
|
}),
|
|
}
|
|
|
|
def __init__(self, *args, **kwargs):
|
|
# Pop 'user' from kwargs so we can filter based on who's logged in
|
|
self.user = kwargs.pop('user', None)
|
|
super().__init__(*args, **kwargs)
|
|
|
|
# --- Supervisor filtering ---
|
|
# If the user is NOT an admin, they can only see:
|
|
# - Projects they're assigned to (via project.supervisors M2M)
|
|
# - Workers in teams they supervise
|
|
if self.user and not (self.user.is_staff or self.user.is_superuser):
|
|
# Only show projects this supervisor is assigned to
|
|
self.fields['project'].queryset = Project.objects.filter(
|
|
active=True,
|
|
supervisors=self.user
|
|
)
|
|
# Only show workers from teams this supervisor manages
|
|
supervised_teams = Team.objects.filter(supervisor=self.user, active=True)
|
|
self.fields['workers'].queryset = Worker.objects.filter(
|
|
active=True,
|
|
teams__in=supervised_teams
|
|
).distinct()
|
|
# Only show teams this supervisor manages
|
|
self.fields['team'].queryset = supervised_teams
|
|
else:
|
|
# Admins see everything
|
|
self.fields['workers'].queryset = Worker.objects.filter(active=True)
|
|
self.fields['project'].queryset = Project.objects.filter(active=True)
|
|
self.fields['team'].queryset = Team.objects.filter(active=True)
|
|
|
|
# Make team optional (it already is on the model, but make the form match)
|
|
self.fields['team'].required = False
|
|
|
|
# Force start date to be blank — don't pre-fill with today's date.
|
|
# Django 5.x auto-fills form fields from model defaults (default=timezone.now),
|
|
# but we want the user to consciously pick a date every time.
|
|
self.fields['date'].initial = None
|
|
|
|
def clean(self):
|
|
"""Validate the date range makes sense."""
|
|
cleaned_data = super().clean()
|
|
start_date = cleaned_data.get('date')
|
|
end_date = cleaned_data.get('end_date')
|
|
|
|
if start_date and end_date and end_date < start_date:
|
|
raise forms.ValidationError('End date cannot be before start date.')
|
|
|
|
return cleaned_data
|
|
|
|
|
|
class PayrollAdjustmentForm(forms.ModelForm):
|
|
"""
|
|
Form for adding/editing payroll adjustments (bonuses, deductions, etc.).
|
|
|
|
Business rule: A project is required for Overtime, Bonus, Deduction, and
|
|
Advance Payment types. Loan and Loan Repayment are worker-level (no project).
|
|
"""
|
|
|
|
class Meta:
|
|
model = PayrollAdjustment
|
|
fields = ['type', 'project', 'worker', 'amount', 'date', 'description']
|
|
widgets = {
|
|
'type': forms.Select(attrs={'class': 'form-select'}),
|
|
'project': forms.Select(attrs={'class': 'form-select'}),
|
|
'worker': forms.Select(attrs={'class': 'form-select'}),
|
|
'amount': forms.NumberInput(attrs={
|
|
'class': 'form-control',
|
|
'step': '0.01',
|
|
'min': '0.01'
|
|
}),
|
|
'date': forms.DateInput(attrs={'type': 'date', 'class': 'form-control'}),
|
|
'description': forms.Textarea(attrs={
|
|
'class': 'form-control',
|
|
'rows': 2,
|
|
'placeholder': 'Reason for this adjustment...'
|
|
}),
|
|
}
|
|
|
|
def __init__(self, *args, **kwargs):
|
|
super().__init__(*args, **kwargs)
|
|
self.fields['project'].queryset = Project.objects.filter(active=True)
|
|
self.fields['project'].required = False
|
|
self.fields['worker'].queryset = Worker.objects.filter(active=True)
|
|
|
|
def clean(self):
|
|
"""Validate that project-required types have a project selected."""
|
|
cleaned_data = super().clean()
|
|
adj_type = cleaned_data.get('type', '')
|
|
project = cleaned_data.get('project')
|
|
|
|
# These types must have a project — they're tied to specific work
|
|
project_required_types = ('Overtime', 'Bonus', 'Deduction', 'Advance Payment')
|
|
if adj_type in project_required_types and not project:
|
|
self.add_error('project', 'A project must be selected for this adjustment type.')
|
|
|
|
return cleaned_data
|
|
|
|
|
|
# =============================================================================
|
|
# === EXPENSE RECEIPT FORM ===
|
|
# Used on the /receipts/create/ page.
|
|
# The form handles receipt header fields (vendor, date, payment method, VAT type).
|
|
# Line items are handled separately by the ExpenseLineItemFormSet below.
|
|
# =============================================================================
|
|
|
|
class ExpenseReceiptForm(forms.ModelForm):
|
|
"""
|
|
Form for the receipt header — vendor, date, payment method, VAT type.
|
|
Line items (products + amounts) are handled by ExpenseLineItemFormSet.
|
|
"""
|
|
|
|
class Meta:
|
|
model = ExpenseReceipt
|
|
fields = ['date', 'vendor_name', 'description', 'payment_method', 'vat_type']
|
|
widgets = {
|
|
'date': forms.DateInput(attrs={'type': 'date', 'class': 'form-control'}),
|
|
'vendor_name': forms.TextInput(attrs={
|
|
'class': 'form-control',
|
|
'placeholder': 'Vendor Name'
|
|
}),
|
|
'description': forms.Textarea(attrs={
|
|
'class': 'form-control',
|
|
'rows': 2,
|
|
'placeholder': 'What was purchased and why...'
|
|
}),
|
|
'payment_method': forms.Select(attrs={'class': 'form-select'}),
|
|
# Radio buttons for VAT type — shown as 3 options side by side
|
|
'vat_type': forms.RadioSelect(attrs={'class': 'form-check-input'}),
|
|
}
|
|
|
|
|
|
# === LINE ITEM FORMSET ===
|
|
# A "formset" is a group of identical mini-forms — one per line item.
|
|
# inlineformset_factory creates it automatically from the parent-child relationship.
|
|
# - extra=1: start with 1 blank row
|
|
# - can_delete=True: allows removing rows (checks a hidden DELETE checkbox)
|
|
ExpenseLineItemFormSet = inlineformset_factory(
|
|
ExpenseReceipt, # Parent model
|
|
ExpenseLineItem, # Child model
|
|
fields=['product_name', 'amount'],
|
|
extra=1, # Show 1 blank row by default
|
|
can_delete=True, # Allow deleting rows
|
|
widgets={
|
|
'product_name': forms.TextInput(attrs={
|
|
'class': 'form-control',
|
|
'placeholder': 'Item Name'
|
|
}),
|
|
'amount': forms.NumberInput(attrs={
|
|
'class': 'form-control item-amount',
|
|
'step': '0.01',
|
|
'placeholder': '0.00'
|
|
}),
|
|
}
|
|
)
|
|
|
|
|
|
# =============================================================================
|
|
# === TEAM FORM ===
|
|
# Used on /teams/new/ and /teams/<id>/edit/ to create or edit a Team.
|
|
# Mirrors the Django admin experience outside of /admin/ so the owner
|
|
# doesn't need to go into Django admin for routine team maintenance.
|
|
# =============================================================================
|
|
|
|
class TeamForm(forms.ModelForm):
|
|
"""
|
|
Form for creating/editing a Team.
|
|
|
|
Fields:
|
|
- name: team name
|
|
- supervisor: a single User (filtered to admins + Work Logger group)
|
|
- active: whether the team is currently in use
|
|
- pay_frequency: optional — weekly / fortnightly / monthly
|
|
- pay_start_date: anchor date for the first pay period
|
|
- workers: checkbox list of ALL workers (active + inactive) —
|
|
inactive ones are flagged with a badge in the template
|
|
"""
|
|
|
|
class Meta:
|
|
model = Team
|
|
fields = ['name', 'supervisor', 'active', 'pay_frequency',
|
|
'pay_start_date', 'workers']
|
|
widgets = {
|
|
'name': forms.TextInput(attrs={
|
|
'class': 'form-control',
|
|
'placeholder': 'Team name (e.g. "Footings Crew")'
|
|
}),
|
|
'supervisor': forms.Select(attrs={'class': 'form-select'}),
|
|
'active': forms.CheckboxInput(attrs={'class': 'form-check-input'}),
|
|
'pay_frequency': forms.Select(attrs={'class': 'form-select'}),
|
|
'pay_start_date': forms.DateInput(attrs={
|
|
'type': 'date', 'class': 'form-control'
|
|
}),
|
|
# Multi-select for workers — rendered as a checkbox grid in the template
|
|
'workers': forms.CheckboxSelectMultiple(attrs={'class': 'form-check-input'}),
|
|
}
|
|
|
|
def __init__(self, *args, **kwargs):
|
|
super().__init__(*args, **kwargs)
|
|
# Supervisor dropdown = admins + Work Logger group, alphabetical
|
|
self.fields['supervisor'].queryset = _supervisor_user_queryset()
|
|
self.fields['supervisor'].required = False
|
|
# Workers picker: ALL workers — inactive marked in template
|
|
self.fields['workers'].queryset = Worker.objects.all().order_by('name')
|
|
self.fields['workers'].required = False
|
|
# Schedule fields are optional
|
|
self.fields['pay_frequency'].required = False
|
|
self.fields['pay_start_date'].required = False
|
|
|
|
def clean(self):
|
|
"""If pay_frequency is set, pay_start_date must also be set (and vice versa)."""
|
|
cleaned = super().clean()
|
|
freq = cleaned.get('pay_frequency')
|
|
start = cleaned.get('pay_start_date')
|
|
if freq and not start:
|
|
self.add_error('pay_start_date',
|
|
'A start date is required when pay frequency is set.')
|
|
if start and not freq:
|
|
self.add_error('pay_frequency',
|
|
'Choose a pay frequency when setting a start date.')
|
|
return cleaned
|
|
|
|
|
|
# =============================================================================
|
|
# === PROJECT FORM ===
|
|
# Used on /projects/new/ and /projects/<id>/edit/ to create or edit a Project.
|
|
# =============================================================================
|
|
|
|
class ProjectForm(forms.ModelForm):
|
|
"""
|
|
Form for creating/editing a Project.
|
|
|
|
Fields:
|
|
- name: project name (e.g. "Solar Farm — Phase 2")
|
|
- description: free-text notes
|
|
- active: whether the project is currently running
|
|
- start_date / end_date: optional timeline
|
|
- supervisors: M2M to User — any number of supervisors may be assigned
|
|
"""
|
|
|
|
class Meta:
|
|
model = Project
|
|
fields = ['name', 'description', 'active', 'start_date', 'end_date',
|
|
'supervisors']
|
|
widgets = {
|
|
'name': forms.TextInput(attrs={
|
|
'class': 'form-control',
|
|
'placeholder': 'Project name'
|
|
}),
|
|
'description': forms.Textarea(attrs={
|
|
'class': 'form-control',
|
|
'rows': 3,
|
|
'placeholder': 'What this project covers...'
|
|
}),
|
|
'active': forms.CheckboxInput(attrs={'class': 'form-check-input'}),
|
|
'start_date': forms.DateInput(attrs={
|
|
'type': 'date', 'class': 'form-control'
|
|
}),
|
|
'end_date': forms.DateInput(attrs={
|
|
'type': 'date', 'class': 'form-control'
|
|
}),
|
|
# Multi-select checkboxes for supervisors
|
|
'supervisors': forms.CheckboxSelectMultiple(attrs={'class': 'form-check-input'}),
|
|
}
|
|
|
|
def __init__(self, *args, **kwargs):
|
|
super().__init__(*args, **kwargs)
|
|
# Supervisor dropdown = admins + Work Logger group members
|
|
self.fields['supervisors'].queryset = _supervisor_user_queryset()
|
|
self.fields['supervisors'].required = False
|
|
self.fields['start_date'].required = False
|
|
self.fields['end_date'].required = False
|
|
self.fields['description'].required = False
|
|
|
|
def clean(self):
|
|
"""If both dates are set, end_date must not be before start_date."""
|
|
cleaned = super().clean()
|
|
start = cleaned.get('start_date')
|
|
end = cleaned.get('end_date')
|
|
if start and end and end < start:
|
|
self.add_error('end_date', 'End date cannot be before start date.')
|
|
return cleaned
|