No-new-work weeks on the calendar

A checkbox under each week number flags the week "no new work" and circles
it in red. New appointments in a flagged week (or ones moved or lengthened
into it) warn on the form and are stopped on save; users with "Override
no-new-work weeks" can tick "Schedule anyway". Flagging needs "Flag
no-new-work weeks". Call-outs aren't affected. Adds migration 005.

Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
This commit is contained in:
rickyandClaude Opus 5.5 committed 2026-11-06 10:16:10 -05:00
1 parent cba0057c9c
commit 9a07c16731
13 files changed
+304 -5

No files matched your search

+1
View File
@@ -34,6 +34,7 @@ Add appointments to the redmine calanedar with the abiltiy to attach a QBO custo
* Estimate pages in redmine_qbo get an **Add appointment** link. Other plugins can add to the new appointment through the `:qbo_calendar_appointment_params, { customer:, estimate_id:, custom_fields: }` hook (e.g. redmine_qbo_vehicles: the vehicle with the estimate's VIN).
* **Appointment statuses** are set up in the plugin's settings (Administration › Plugins › Configure): name, colour, whether the time counts toward the calendar's hours, and order (the first is the default). Renaming a status keeps its appointments; removing one in use asks which status to move them to. Statuses that don't count hours (e.g. Cancelled) stay on the calendar, crossed out.
* **Hours in a working day** (plugin setting, default 8): multi-day appointments count up to this many hours a day on the calendar, from their first day. Issues' estimated hours are spread over their working days from start to due date.
* **No-new-work weeks**: the checkbox under each week number on the calendar flags the week "no new work" and circles it in red. Opening a new appointment in a flagged week warns straight away, and saving one there (or moving or lengthening one into it) is stopped. Users with **Override no-new-work weeks** can tick "Schedule anyway" and save; flagging needs **Flag no-new-work weeks**. Call-outs aren't affected. Upgrading runs migration 005.
* **Call-outs**: an employee off work, added with the button next to each day's add button. They show at the top of the day in red stripes, have no customer or status, and never count toward hours. Upgrading (migration 004) turns appointments with the old Call_Out status into call-outs.
---
@@ -83,11 +83,14 @@ class CustomerAppointmentsController < ApplicationController
@appointment.date = (params[:start_date].to_date + 9.hours) if params[:start_date].present?
@appointment.customer_id = params[:customer_id] if params[:customer_id].present?
prefill_estimate_and_vehicle
# Warn up front when the day picked on the calendar is in a no-new-work week
@no_work_weeks = @appointment.no_work_weeks_added
end
def create
@appointment = CustomerAppointment.new(appointment_params)
@appointment.project = @project
apply_no_work_week_override
if @appointment.save
flash[:notice] = l(:notice_successful_create)
redirect_to customer_appointment_path( @appointment )
@@ -101,7 +104,9 @@ class CustomerAppointmentsController < ApplicationController
end
def update
if @appointment.update( appointment_params )
@appointment.assign_attributes(appointment_params)
apply_no_work_week_override
if @appointment.save
flash[:notice] = l(:notice_successful_update)
redirect_to customer_appointment_path( @appointment )
else
@@ -117,6 +122,16 @@ class CustomerAppointmentsController < ApplicationController
private
# "Schedule anyway" on the form counts only for users with "Override no-new-work weeks"
def apply_no_work_week_override
@appointment.no_work_week_override = params[:override_no_work_week] == '1' && can_override_no_work_weeks?
end
def can_override_no_work_weeks?
User.current.allowed_to?(:override_no_work_weeks, nil, global: true)
end
helper_method :can_override_no_work_weeks?
# Links from an estimate (redmine_qbo) pass the estimate and vehicle; each is used only when it
# belongs to the appointment's customer
def prefill_estimate_and_vehicle
@@ -0,0 +1,31 @@
# The MIT License (MIT)
#
# Copyright (c) 2026 rick barrette
#
# Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:
#
# The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.
#
# THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
# Flags and unflags a calendar week as "no new work" (the checkbox at the start of each calendar week)
class NoWorkWeeksController < ApplicationController
before_action :require_login
before_action :authorize_global
def update
date = Date.parse(params[:week].to_s)
if params[:flagged] == '1'
NoWorkWeek.flag!(date)
else
NoWorkWeek.unflag!(date)
end
respond_to do |format|
format.html { redirect_back_or_default issues_calendar_path }
format.json { render json: { week_start: NoWorkWeek.week_start_for(date), flagged: params[:flagged] == '1' } }
end
rescue Date::Error
render_error status: 422, message: l(:error_invalid_no_work_week)
end
end
+37
View File
@@ -34,6 +34,13 @@ class CustomerAppointment < ActiveRecord::Base
# The hours can't be less than the attached estimate's labor hours
validate :validate_hours_cover_estimate
# New work landing in a week flagged "no new work" needs an override (see #no_work_week_override)
validate :validate_no_work_weeks
# Set by the controller when the user ticked "Schedule anyway" and holds the "Override no-new-work weeks"
# permission
attr_accessor :no_work_week_override
# Capitalize the first letter only; titleize mangled vehicle names and acronyms (JL -> Jl, LED -> Led)
normalizes :subject, with: ->(subject) { subject.strip.sub(/\A[a-z]/, &:upcase) }
@@ -104,6 +111,24 @@ class CustomerAppointment < ActiveRecord::Base
subject
end
# The Mondays of flagged no-new-work weeks this appointment adds work to: weeks its working days fall in
# that it didn't already cover before this change. Call-outs aren't work, so never any.
def no_work_weeks_added
return [] if call_out? || date.blank?
weeks = NoWorkWeek.flagged_week_starts(working_days)
if persisted? && date_in_database.present? && event_type_in_database != CALL_OUT
previous = RedmineQboCalendar::WorkingDays.dates(date_in_database.to_date, duration_in_database)
weeks -= previous.map { |d| NoWorkWeek.week_start_for(d) }
end
weeks.sort
end
# True after validation stopped the save over a no-new-work week, so the form can offer "Schedule anyway"
def no_work_week_conflict?
@no_work_week_conflict == true
end
# The estimate's labor hours rounded up to whole hours (appointment hours are whole numbers): the
# quantities of its lines with redmine_qbo's labor products/services (e.g. Labor). 0 if the
# estimate can't be read from QuickBooks.
@@ -148,6 +173,18 @@ class CustomerAppointment < ActiveRecord::Base
errors.add(:base, I18n.t(:error_hours_less_than_estimate, hours: labor, estimate: estimate.doc_number))
end
def validate_no_work_weeks
@no_work_week_conflict = false
return if no_work_week_override
return unless new_record? || will_save_change_to_date? || will_save_change_to_duration? || will_save_change_to_event_type?
weeks = no_work_weeks_added
return if weeks.empty?
@no_work_week_conflict = true
errors.add(:base, I18n.t(:error_no_work_week, weeks: weeks.map { |w| I18n.l(w, format: :long) }.to_sentence))
end
# Validates that the appointment date does not land on a weekend or holiday
def validate_working_day
return if date.blank?
+45
View File
@@ -0,0 +1,45 @@
# The MIT License (MIT)
#
# Copyright (c) 2026 rick barrette
#
# Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:
#
# The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.
#
# THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
# A week flagged "no new work" on the calendar. Weeks are keyed by their Monday, so the flag holds whatever
# day the user's calendar starts its rows on.
class NoWorkWeek < ApplicationRecord
belongs_to :user, optional: true
validates :week_start, presence: true, uniqueness: true
# The Monday of the week a date is in
def self.week_start_for(date)
date.to_date.beginning_of_week(:monday)
end
# The Mondays of the flagged weeks among the given dates' weeks, read in one query
def self.flagged_week_starts(dates)
starts = Array(dates).compact.map { |d| week_start_for(d) }.uniq
return Set.new if starts.empty?
where(week_start: starts).pluck(:week_start).to_set
end
# Whether any of the dates falls in a flagged week
def self.flagged?(*dates)
flagged_week_starts(dates.flatten).any?
end
def self.flag!(date, user = User.current)
find_or_create_by!(week_start: week_start_for(date)) { |w| w.user = user if user&.logged? }
rescue ActiveRecord::RecordNotUnique
find_by(week_start: week_start_for(date))
end
def self.unflag!(date)
where(week_start: week_start_for(date)).delete_all
end
end
+26 -4
View File
@@ -11,6 +11,10 @@
# Read once for the whole page
non_working_days = Setting.non_working_week_days || []
# Weeks flagged "no new work" (keyed by their Monday): circled in red, and new appointments in them warn
flagged_weeks = NoWorkWeek.where(week_start: (calendar.startdt - 6)..calendar.enddt).pluck(:week_start).to_set
can_flag_weeks = User.current.allowed_to?(:manage_no_work_weeks, nil, global: true)
all_holidays = Holiday.all.to_a
working_days_between = lambda do |first, last|
RedmineQboCalendar::WorkingDays.between(first, last, holidays: all_holidays, week_days: non_working_days)
@@ -127,7 +131,8 @@
<%= form_tag({}, data: { cm_url: issues_context_menu_path }) do %>
<%= hidden_field_tag 'back_url', url_for(params: request.query_parameters), id: nil %>
<ul class="cal">
<%# data-no-work-weeks-url: where toggleNoWorkWeek (calendar.js) saves a week's flag %>
<ul class="cal" data-no-work-weeks-url="<%= no_work_weeks_path %>" data-no-work-week-error="<%= l(:error_no_work_week_save) %>">
<li scope="col" title="<%= l(:label_week) %>" class="calhead week-number"></li>
<% 7.times do |i| %>
@@ -175,9 +180,26 @@
end
%>
<li class="week-number">
<%
# Every 7-day row has exactly one Monday, whatever day the calendar starts on
week_monday = week.find { |d| d.cwday == 1 }
no_work_week = flagged_weeks.include?(week_monday)
week_css = no_work_week ? ['no-work-week'] : []
%>
<li class="week-number <%= week_css.join(' ') %>" data-no-work-week="<%= week_monday %>">
<span class="label-week"><%= l(:label_week) %></span>
<%= calendar.week_number(week.first) %>
<%# No-new-work flag: a checkbox for users who may set it, otherwise shown only when set %>
<% if can_flag_weeks || no_work_week %>
<label class="no-work-week-toggle" title="<%= l(:text_no_work_week_toggle) %>">
<%# No name, so the issues context menu form never sends it %>
<%= tag.input type: 'checkbox', checked: no_work_week, disabled: !can_flag_weeks,
onchange: "toggleNoWorkWeek(this, '#{week_monday}')" %>
<span><%= l(:label_no_work_week) %></span>
</label>
<% end %>
<%# Render the Weekly Total Hours under the Week Number %>
<% if weekly_total_hours > 0 %>
@@ -187,7 +209,7 @@
<% end %>
</li>
<% week.each do |day| %>
<% week.each_with_index do |day, day_index| %>
<%
is_today = (day == User.current.today)
@@ -204,7 +226,7 @@
%>
<%# Added 'week-end' class and background color styling for custom holidays to mimic weekends %>
<li class="<%= calendar.day_css_classes(day) %> calbody <%= 'week-end' if is_custom_holiday %>" style="<%= 'background-color: #f6f6f6;' if is_custom_holiday %>"<%= ' id="today"'.html_safe if is_today %>>
<li class="<%= calendar.day_css_classes(day) %> calbody <%= 'week-end' if is_custom_holiday %> <%= week_css.join(' ') %> <%= 'no-work-week-last' if day_index == 6 %>" data-no-work-week="<%= week_monday %>" style="<%= 'background-color: #f6f6f6;' if is_custom_holiday %>"<%= ' id="today"'.html_safe if is_today %>>
<p class="day-num" style="display: grid; grid-template-columns: 1fr auto 1fr; align-items: center; margin-bottom: 4px;">
<!-- Left: Day number and abbreviated weekday -->
@@ -3,6 +3,27 @@
<%= labelled_form_for @appointment do |f| %>
<%= error_messages_for @appointment %>
<%# No-new-work weeks: warned before saving (the day picked on the calendar), then after a save stopped
over one. Users with "Override no-new-work weeks" can tick "Schedule anyway". %>
<% if @no_work_weeks.present? %>
<div class="flash warning no-work-week-warning">
<%= l(:warning_no_work_week, weeks: @no_work_weeks.map { |w| format_date(w) }.to_sentence) %>
<%= l(can_override_no_work_weeks? ? :text_no_work_week_can_override : :text_no_work_week_cannot_override) %>
</div>
<% end %>
<% if @appointment.no_work_week_conflict? || @no_work_weeks.present? %>
<% if can_override_no_work_weeks? %>
<p class="no-work-week-override">
<label>
<%= check_box_tag 'override_no_work_week', '1', params[:override_no_work_week] == '1' %>
<%= l(:label_override_no_work_week) %>
</label>
</p>
<% elsif @appointment.no_work_week_conflict? %>
<p class="no-work-week-override"><em><%= l(:text_no_work_week_cannot_override) %></em></p>
<% end %>
<% end %>
<div class="box tabular">
<%= f.hidden_field :event_type %>
<% if @appointment.call_out? %>
+26
View File
@@ -54,4 +54,30 @@ document.addEventListener('DOMContentLoaded', function() {
window.toggleHidePastWeeks = function(checked) {
setToggle('hide_past_weeks', checked);
};
// The checkbox at the start of each week: flags it "no new work" (circled in red) without reloading
window.toggleNoWorkWeek = function(checkbox, week) {
const calendar = checkbox.closest('ul.cal');
const token = document.querySelector('meta[name="csrf-token"]');
const body = new URLSearchParams({ week: week, flagged: checkbox.checked ? '1' : '0' });
const cells = calendar.querySelectorAll('li[data-no-work-week="' + week + '"]');
checkbox.disabled = true;
fetch(calendar.dataset.noWorkWeeksUrl, {
method: 'POST',
headers: { 'Accept': 'application/json', 'X-CSRF-Token': token ? token.content : '' },
body: body,
credentials: 'same-origin'
}).then(function(response) {
if (!response.ok) throw new Error(response.status);
return response.json();
}).then(function(data) {
cells.forEach(function(cell) { cell.classList.toggle('no-work-week', data.flagged); });
}).catch(function() {
checkbox.checked = !checkbox.checked;
alert(calendar.dataset.noWorkWeekError || 'Could not save the week');
}).finally(function() {
checkbox.disabled = false;
});
};
})();
@@ -404,6 +404,56 @@ table.cal td.today {
outline-offset: -2px !important;
}
/* No-new-work weeks: the checkbox under the week number, and a red ring round the whole week.
The ring is drawn by an overlay on each cell of the row, stretched over the 1px cell borders so it
joins up, and it lets clicks through to the cell. */
.cal .week-number .no-work-week-toggle {
display: flex;
flex-direction: column;
align-items: center;
gap: 2px;
margin-top: 10px;
font-size: 0.7em;
font-weight: 600;
line-height: 1.1;
color: #777;
max-width: 4.5em;
white-space: normal;
cursor: pointer;
}
.cal .week-number .no-work-week-toggle input { margin: 0; cursor: pointer; }
.cal .week-number .no-work-week-toggle input:disabled { cursor: default; }
.cal .week-number.no-work-week .no-work-week-toggle { color: #d52b1e; }
ul.cal li.no-work-week { position: relative; }
ul.cal li.no-work-week::after {
content: "";
position: absolute;
top: -1px;
bottom: 0;
left: -1px;
right: 0;
border-top: 3px solid #d52b1e;
border-bottom: 3px solid #d52b1e;
pointer-events: none;
z-index: 1;
}
ul.cal li.week-number.no-work-week::after {
left: 0;
border-left: 3px solid #d52b1e;
border-radius: 14px 0 0 14px;
}
ul.cal li.no-work-week.no-work-week-last::after {
border-right: 3px solid #d52b1e;
border-radius: 0 14px 14px 0;
}
.no-work-week-override label { font-weight: bold; color: #9c1f16; }
/* Responsive Mobile View */
@media screen and (max-width: 768px) {
table.cal thead {
@@ -444,6 +494,15 @@ table.cal td.today {
box-sizing: border-box;
}
/* Cells are stacked, so ring each one in a flagged week */
ul.cal li.no-work-week::after,
ul.cal li.week-number.no-work-week::after,
ul.cal li.no-work-week.no-work-week-last::after {
inset: 0;
border: 3px solid #d52b1e;
border-radius: 6px;
}
.appointment-block {
width: 100% !important;
max-width: 100% !important;
+13
View File
@@ -120,3 +120,16 @@ en:
# Calendar settings
label_hours_per_day: "Hours in a working day"
text_hours_per_day: "Multi-day appointments count up to this many hours a day on the calendar, from their first day; one without its own hours counts this many a day. Default 8."
# No-new-work weeks: flagged with the checkbox at the start of each calendar week
label_no_work_week: "No new work"
text_no_work_week_toggle: "No new work this week: it's circled in red, and new appointments in it warn"
permission_manage_no_work_weeks: "Flag no-new-work weeks"
permission_override_no_work_weeks: "Override no-new-work weeks"
warning_no_work_week: "The week of %{weeks} is marked no new work."
error_no_work_week: "The week of %{weeks} is marked no new work"
text_no_work_week_can_override: "Tick \"Schedule anyway\" to save it regardless."
text_no_work_week_cannot_override: "Ask someone who can override no-new-work weeks to schedule it."
label_override_no_work_week: "Schedule anyway (this week is marked no new work)"
error_no_work_week_save: "Could not save the week's no-new-work flag"
error_invalid_no_work_week: "Invalid week"
+2
View File
@@ -11,6 +11,8 @@
RedmineApp::Application.routes.draw do
resources :holidays, except: [:show] # Exclude :show since we don't need a separate page for individual holidays
# The calendar's per-week "no new work" checkbox
post 'no_work_weeks', to: 'no_work_weeks#update', as: :no_work_weeks
resources :customer_appointments do
collection do
get :customer_options
+23
View File
@@ -0,0 +1,23 @@
# The MIT License (MIT)
#
# Copyright (c) 2026 rick barrette
#
# Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:
#
# The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.
#
# THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
# Weeks flagged "no new work": new appointments landing in one warn, and need the
# "Override no-new-work weeks" permission to be saved anyway. One row per week, keyed by its Monday.
class CreateNoWorkWeeks < ActiveRecord::Migration[7.0]
def change
create_table :no_work_weeks do |t|
t.date :week_start, null: false
t.references :user, index: false
t.timestamps
end
add_index :no_work_weeks, :week_start, unique: true
end
end
+4
View File
@@ -42,6 +42,10 @@ Redmine::Plugin.register :redmine_qbo_calendar do
permission :edit_customer_appointments, { customer_appointments: [:edit, :update, :customer_options, :estimate_hours] }, global: true
permission :delete_customer_appointments, { customer_appointments: [:destroy] }, global: true
# Creating issues from an appointment's estimate is redmine_qbo's "Create issues from estimates"
# Flag a calendar week "no new work": new appointments in it warn and need the override below
permission :manage_no_work_weeks, { no_work_weeks: [:update] }, global: true
# Save a new appointment in a no-new-work week anyway, after being warned
permission :override_no_work_weeks, {}, global: true
# Register top menu items
menu :top_menu, :calendar, { controller: :calendars, action: :show }, caption: :label_calendar, if: Proc.new {User.current.logged?}