diff --git a/README.md b/README.md index 3543dcf..3cc232a 100644 --- a/README.md +++ b/README.md @@ -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. --- diff --git a/app/controllers/customer_appointments_controller.rb b/app/controllers/customer_appointments_controller.rb index 6c2dad4..5646f5a 100644 --- a/app/controllers/customer_appointments_controller.rb +++ b/app/controllers/customer_appointments_controller.rb @@ -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 diff --git a/app/controllers/no_work_weeks_controller.rb b/app/controllers/no_work_weeks_controller.rb new file mode 100644 index 0000000..543c0d8 --- /dev/null +++ b/app/controllers/no_work_weeks_controller.rb @@ -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 diff --git a/app/models/customer_appointment.rb b/app/models/customer_appointment.rb index 2d38ca4..1046a5c 100644 --- a/app/models/customer_appointment.rb +++ b/app/models/customer_appointment.rb @@ -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? diff --git a/app/models/no_work_week.rb b/app/models/no_work_week.rb new file mode 100644 index 0000000..011bdf1 --- /dev/null +++ b/app/models/no_work_week.rb @@ -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 diff --git a/app/views/common/_calendar.html.erb b/app/views/common/_calendar.html.erb index 037f9eb..882088a 100644 --- a/app/views/common/_calendar.html.erb +++ b/app/views/common/_calendar.html.erb @@ -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 %> -