mirror of
https://github.com/rickbarrette/redmine_qbo_calendar.git
synced 2026-11-17 21:50:37 -05:00
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>
205 lines
8.1 KiB
Ruby
205 lines
8.1 KiB
Ruby
#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.
|
|
|
|
class CustomerAppointment < ActiveRecord::Base
|
|
|
|
belongs_to :project, optional: true
|
|
belongs_to :user, optional: true
|
|
belongs_to :customer, optional: true
|
|
belongs_to :vehicle, optional: true
|
|
belongs_to :estimate, optional: true
|
|
|
|
# Issues created from this appointment's estimate lines
|
|
has_many :appointment_estimate_issues, dependent: :nullify
|
|
has_many :created_issues, through: :appointment_estimate_issues, source: :issue
|
|
|
|
validates :subject, presence: true
|
|
validates :date, presence: true
|
|
# A call-out is about the employee who's off (checked when set, so older call-outs without one still save)
|
|
validates :user, presence: true, if: -> { call_out? && (new_record? || will_save_change_to_user_id?) }
|
|
|
|
# Call-outs have no customer side; appointments get the default status when none is chosen
|
|
before_validation :prepare_entry
|
|
|
|
# Prevent scheduling on non-working days or holidays
|
|
validate :validate_working_day
|
|
|
|
# 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) }
|
|
|
|
# An employee off work (sick, a day off): shown on the calendar, but not an appointment with a customer
|
|
CALL_OUT = 'call_out'
|
|
|
|
# The statuses set up in the plugin settings (see RedmineQboCalendar::AppointmentStatus)
|
|
def self.statuses
|
|
RedmineQboCalendar::AppointmentStatus.all
|
|
end
|
|
|
|
# Status keys, for other plugins' settings (e.g. redmine_qbo_reminders' "statuses that get reminders")
|
|
def self.status_options
|
|
statuses.map { |s| [s.name, s.key] }
|
|
end
|
|
|
|
def call_out?
|
|
event_type == CALL_OUT
|
|
end
|
|
|
|
# This appointment's status from the settings; nil for call-outs, which have none
|
|
def status_record
|
|
return nil if call_out?
|
|
RedmineQboCalendar::AppointmentStatus.find(status) || RedmineQboCalendar::AppointmentStatus.default
|
|
end
|
|
|
|
# False for call-outs and statuses like Cancelled, which stay on the calendar but free up their hours
|
|
def counts_toward_hours?
|
|
!call_out? && status_record.counts_hours?
|
|
end
|
|
|
|
# Cast datetime to Date for Redmine Calendar compatibility
|
|
def start_date
|
|
date&.to_date
|
|
end
|
|
|
|
# Last working day of the appointment. Weekends and holidays are skipped, matching how the
|
|
# calendar spreads a multi-day appointment (a 3-day job starting Friday ends Tuesday).
|
|
def due_date
|
|
working_days.last
|
|
end
|
|
|
|
# The working days the appointment takes (weekends and holidays skipped), in order: "Day 2 of 3" is the
|
|
# second. Pass the holidays when working this out for many appointments, to read them once.
|
|
def working_days(holidays: nil)
|
|
return [] unless date
|
|
@working_days ||= {}
|
|
@working_days[[start_date, duration.to_i]] ||=
|
|
RedmineQboCalendar::WorkingDays.dates(start_date, duration, **{ holidays: holidays }.compact)
|
|
end
|
|
|
|
# Which working day of the appointment a date is (1 for the first), or nil when it isn't one
|
|
def working_day_number(day)
|
|
index = working_days.index(day.to_date)
|
|
index && index + 1
|
|
end
|
|
|
|
# Appointments the user may see. Requires the global "View customer appointments" permission.
|
|
def self.visible(user = User.current)
|
|
if user.allowed_to?(:view_customer_appointments, nil, global: true)
|
|
all
|
|
else
|
|
none
|
|
end
|
|
end
|
|
|
|
def to_s
|
|
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.
|
|
def self.estimate_labor_hours(estimate)
|
|
return 0 if estimate.nil?
|
|
RedmineQboBilling::EstimateIssueBuilder.labor_hours(estimate).ceil
|
|
rescue StandardError => e
|
|
Rails.logger.warn "[CustomerAppointment] Could not read labor hours for estimate #{estimate&.id}: #{e.message}"
|
|
0
|
|
end
|
|
|
|
private
|
|
|
|
def log(msg)
|
|
Rails.logger.info "[CustomerAppointment] #{msg}"
|
|
end
|
|
|
|
def prepare_entry
|
|
if call_out?
|
|
self.customer = nil
|
|
self.vehicle = nil
|
|
self.estimate = nil
|
|
self.status = nil
|
|
self.estimated_hours = 0
|
|
self.subject = I18n.t(:label_call_out_subject, name: user.name) if subject.blank? && user
|
|
else
|
|
self.event_type = nil
|
|
self.status = RedmineQboCalendar::AppointmentStatus.default.key if status.blank?
|
|
end
|
|
self.description = description.to_s
|
|
end
|
|
|
|
# Checked when the estimate or the hours change, so changing just the status (the quick status buttons)
|
|
# never fails on an older appointment
|
|
def validate_hours_cover_estimate
|
|
return if estimate.nil?
|
|
return unless new_record? || will_save_change_to_estimate_id? || will_save_change_to_estimated_hours?
|
|
|
|
labor = self.class.estimate_labor_hours(estimate)
|
|
return if labor.zero? || estimated_hours.to_i >= labor
|
|
|
|
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?
|
|
|
|
target_date = date.to_date
|
|
non_working_days = Setting.non_working_week_days || []
|
|
|
|
if non_working_days.include?(target_date.cwday.to_s)
|
|
errors.add(:date, :invalid, message: I18n.t(:error_non_working_day))
|
|
elsif defined?(Holiday)
|
|
matched_holiday = Holiday.all.find { |h| h.occurs_on?(target_date) }
|
|
if matched_holiday.present?
|
|
errors.add(:date, :invalid, message: I18n.t(:error_holiday, name: matched_holiday.name))
|
|
end
|
|
end
|
|
end
|
|
|
|
end |