Estimate hours rule, linked issues, issue creation via redmine_qbo_billing

- An appointment's hours can't be less than its estimate's labor hours
  (checked when the estimate or hours change, so the quick status buttons
  still work on older appointments). Picking an estimate on the form, or
  arriving from an estimate page, raises the hours to match.
- The appointment page lists the issues linked to its estimate.
- Creating issues from an estimate moved to redmine_qbo_billing (now
  required): Create Issues from Estimate opens its page with this
  appointment's dates, technician, vehicle and project (via
  qbo_billing_issue_defaults). The builder, preview page, settings and rake
  task are removed here; the old settings stay registered so billing can
  read them until its own are saved.

Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
Claude-Session: https://claude.ai/code/session_01BiwYMjhoQvL7XsKKfRz4pM
This commit is contained in:
Claude committed 2026-10-30 23:11:33 -04:00
1 parent 3b753c1f35
commit fc503fca68
16 files changed
+135 -764

No files matched your search

+1
View File
@@ -21,6 +21,7 @@ module RedmineQboCalendar
RedmineQboCalendar::Hooks::ViewHookListener
RedmineQboCalendar::Hooks::CustomerActionsHookListener
RedmineQboCalendar::Hooks::CustomerShowHookListener
RedmineQboCalendar::Hooks::BillingHookListener
Rails.configuration.to_prepare do
ApplicationController.prepend_view_path( File.expand_path("app/views", __dir__) )
@@ -1,239 +0,0 @@
#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.
module RedmineQboCalendar
# Turns the lines of an appointment's QBO estimate into proposed issues, and creates the ones
# the user selects on the preview page.
#
# - Only lines whose item matches an admin-configured item code (e.g. "Labor", "Alignments") are proposed
# - Subject = the line's description; estimated hours = the line's quantity
# - Lines already turned into issues are shown but can't be created again
# - Creation is all-or-nothing: if any issue fails validation, none are saved
# - All issues created from the same estimate are related to each other, across batches
class EstimateIssueBuilder
include Redmine::I18n
DEFAULT_ITEM_CODES = ['Labor'].freeze
Proposal = Struct.new(:line_id, :item_name, :description, :hours, :existing_issue, keyword_init: true) do
def created?
existing_issue.present?
end
end
# Item codes from the plugin settings, one per line (commas also accepted)
def self.item_codes
raw = settings['item_codes'].to_s
codes = raw.split(/[\n,]/).map(&:strip).reject(&:blank?)
codes.presence || DEFAULT_ITEM_CODES
end
def self.default_tracker_id
settings['default_tracker_id'].to_i
end
def self.default_project_id
settings['default_project_id'].to_i
end
def self.settings
Setting.plugin_redmine_qbo_calendar || {}
rescue StandardError
{}
end
# A line matches a code if its QBO item name equals the code, or any part of a
# "Category:Item" name does. Case-insensitive.
def self.item_matches?(item_name, codes = item_codes)
name = item_name.to_s.strip.downcase
parts = name.split(':').map(&:strip)
codes.map { |c| c.strip.downcase }.any? { |code| name == code || parts.include?(code) }
end
# Relates every issue in the list to every other one ("Related to"), skipping pairs that already
# have any relation. Used for issues created from the same estimate, whichever batch they came from.
# Issues loaded fresh have no open journal, so this adds no history entries and sends no
# "issue updated" emails. A failed relation (e.g. cross-project relations disabled) is logged, not fatal.
# Returns the number of relations created.
def self.relate_all(issues)
issues = issues.compact.uniq(&:id)
return 0 if issues.size < 2
ids = issues.map(&:id)
already_related = IssueRelation.where(issue_from_id: ids, issue_to_id: ids)
.pluck(:issue_from_id, :issue_to_id)
.map(&:minmax)
.to_set
issues.combination(2).count do |issue_from, issue_to|
next false if already_related.include?([issue_from.id, issue_to.id].minmax)
relation = IssueRelation.new(issue_from: issue_from, issue_to: issue_to,
relation_type: IssueRelation::TYPE_RELATES)
next true if relation.save
Rails.logger.warn "[EstimateIssueBuilder] Could not relate ##{issue_from.id} and ##{issue_to.id}: " \
"#{relation.errors.full_messages.join(', ')}"
false
end
end
attr_reader :appointment, :errors
def initialize(appointment)
@appointment = appointment
@errors = []
end
def estimate
appointment.estimate
end
def proposals
@proposals ||= build_proposals
end
# rows: { line_id => { 'selected' => '1', 'subject' => ..., 'tracker_id' => ..., 'template' => 'global:3', 'estimated_hours' => ... } }
# custom_field_values: { custom_field_id => value }, applied to every issue whose tracker uses the field
# Returns the created issues, or [] with #errors filled in.
def create_issues(project:, rows:, custom_field_values: {}, author: User.current)
@errors = []
rows = (rows || {}).to_h.transform_keys(&:to_s)
selected = proposals.reject(&:created?).select { |p| rows.dig(p.line_id, 'selected') == '1' }
if selected.empty?
@errors << l(:error_no_estimate_lines_selected)
return []
end
allowed_trackers = Issue.allowed_target_trackers(project, author).to_a
built = selected.map do |proposal|
[proposal, build_issue(proposal, rows[proposal.line_id] || {}, project, author, allowed_trackers, custom_field_values)]
end
Issue.transaction do
built.each do |proposal, issue|
next if issue.save
@errors << "#{proposal.description.truncate(60)}: #{issue.errors.full_messages.join(', ')}"
end
raise ActiveRecord::Rollback if @errors.any?
built.each do |proposal, issue|
# Clear a link left behind by an issue that no longer exists, then record the new one
AppointmentEstimateIssue.where(estimate_id: estimate.id, line_id: proposal.line_id)
.where.not(issue_id: Issue.select(:id)).delete_all
AppointmentEstimateIssue.create!(
customer_appointment: appointment,
estimate_id: estimate.id,
line_id: proposal.line_id,
issue: issue
)
end
relate_issues(built.map(&:last))
end
@errors.any? ? [] : built.map(&:last)
rescue ActiveRecord::RecordNotUnique, ActiveRecord::RecordInvalid
# Someone else created issues from the same lines at the same moment
@errors << l(:error_estimate_lines_already_created)
[]
end
private
def build_proposals
return [] if estimate.blank?
codes = self.class.item_codes
links = AppointmentEstimateIssue.where(estimate_id: estimate.id).includes(:issue).index_by(&:line_id)
Array(estimate.line_items).each_with_index.filter_map do |line, index|
detail = line.respond_to?(:sales_line_item_detail) ? line.sales_line_item_detail : nil
next if detail.nil? || detail.item_ref.nil?
item_name = detail.item_ref.name.to_s.strip
next unless self.class.item_matches?(item_name, codes)
# The subject comes from the line's description, so lines without one are skipped
description = line.description.to_s.strip
next if description.blank?
line_id = line_key(line, index)
quantity = detail.respond_to?(:quantity) ? detail.quantity.to_f : 0.0
Proposal.new(
line_id: line_id,
item_name: item_name,
description: description,
hours: quantity.positive? ? quantity : nil,
existing_issue: links[line_id]&.issue
)
end
end
# QBO line Ids are stable for the life of the estimate; fall back to line number / position
def line_key(line, index)
key = line.respond_to?(:id) ? line.id : nil
key = line.line_num if key.blank? && line.respond_to?(:line_num)
key = "pos-#{index}" if key.blank?
key.to_s
end
# Relates the new issues to each other and to every issue created earlier from the same estimate.
def relate_issues(new_issues)
earlier = AppointmentEstimateIssue.where(estimate_id: estimate.id)
.where.not(issue_id: new_issues.map(&:id))
.includes(:issue)
.filter_map(&:issue)
self.class.relate_all(earlier + new_issues)
end
def build_issue(proposal, row, project, author, allowed_trackers, custom_field_values)
issue = Issue.new(project: project, author: author)
issue.tracker = allowed_trackers.detect { |t| t.id == row['tracker_id'].to_i }
# Shared custom field values. Going through safe_attributes means fields the tracker doesn't
# use, or that this user can't edit (hidden / read-only by workflow), are ignored.
if custom_field_values.present? && issue.tracker
issue.send(:safe_attributes=, { 'custom_field_values' => custom_field_values.to_h }, author)
end
issue.subject = (row['subject'].presence || proposal.description).to_s.strip.truncate(255)
template = IssueTemplateSupport.find(row['template'], project)
issue.description = template&.description.presence || default_description
hours = row.key?('estimated_hours') ? row['estimated_hours'] : proposal.hours
issue.estimated_hours = hours.presence
issue.start_date = appointment.start_date
issue.due_date = appointment.due_date
# Only assign the appointment's technician if they can be assigned in this project
if appointment.user && issue.assignable_users.include?(appointment.user)
issue.assigned_to = appointment.user
end
# Customer / vehicle / estimate fields are added to issues by redmine_qbo
issue.customer_id = appointment.customer_id if issue.respond_to?(:customer_id=)
issue.vehicle_id = appointment.vehicle_id if issue.respond_to?(:vehicle_id=)
issue.estimate_id = appointment.estimate_id if issue.respond_to?(:estimate_id=)
issue
end
def default_description
"The purpose of this work is to bill the time spent on this issue for Estimate ##{estimate.doc_number} " \
"for Appointment: #{appointment.subject}"
end
end
end
@@ -0,0 +1,43 @@
#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.
module RedmineQboCalendar
module Hooks
# Hooks for redmine_qbo_billing
class BillingHookListener < Redmine::Hook::Listener
# "Create issues" opened from an appointment (?appointment_id=): the issues get the appointment's dates,
# technician, vehicle and project, and the page returns to the appointment
def qbo_billing_issue_defaults(context = {})
appointment_id = context.dig(:params, :appointment_id)
return nil if appointment_id.blank?
return nil unless User.current.allowed_to?(:view_customer_appointments, nil, global: true)
appointment = CustomerAppointment.find_by(id: appointment_id)
estimate = context[:estimate]
return nil unless appointment && estimate && appointment.estimate_id.to_s == estimate.id.to_s
{
start_date: appointment.start_date,
due_date: appointment.due_date,
assignee: appointment.user,
vehicle_id: appointment.vehicle_id,
project: appointment.project,
description: "The purpose of this work is to bill the time spent on this issue for Estimate ##{estimate.doc_number} " \
"for Appointment: #{appointment.subject}",
return_path: Rails.application.routes.url_helpers.customer_appointment_path(appointment),
return_label: appointment.subject
}
end
end
end
end
@@ -1,72 +0,0 @@
#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.
module RedmineQboCalendar
# The issue custom fields shown on the "Create Issues from Estimate" preview page.
#
# For every tracker the user may pick, a sample new issue is built in the target project to find
# which custom fields the user can edit, and which are required (either the field's own
# "Required" flag or a workflow rule for that tracker / role). Values are entered once on the page
# and applied to every created issue whose tracker uses that field.
class IssueFieldSet
# File uploads can't be handled by this shared form
UNSUPPORTED_FORMATS = %w[attachment].freeze
Field = Struct.new(:custom_field, :custom_value, :tracker_ids, :required_tracker_ids, keyword_init: true) do
def id
custom_field.id
end
def required_for_any?
required_tracker_ids.any?
end
end
attr_reader :fields
# values: the submitted { custom_field_id => value } hash, used to refill the form after errors
def initialize(project:, trackers:, user: User.current, values: {})
@fields = []
by_id = {}
Array(trackers).each do |tracker|
issue = Issue.new(project: project, author: user)
issue.tracker = tracker
issue.editable_custom_field_values(user).each do |custom_value|
custom_field = custom_value.custom_field
next if UNSUPPORTED_FORMATS.include?(custom_field.field_format)
field = by_id[custom_field.id] ||= Field.new(
custom_field: custom_field,
custom_value: custom_value,
tracker_ids: [],
required_tracker_ids: []
)
field.tracker_ids << tracker.id
if custom_field.is_required? || issue.required_attribute?(custom_field.id.to_s, user)
field.required_tracker_ids << tracker.id
end
end
end
@fields = by_id.values.sort_by { |f| [f.required_for_any? ? 0 : 1, f.custom_field.position.to_i] }
values = (values || {}).to_h.transform_keys(&:to_s)
@fields.each do |field|
field.custom_value.value = values[field.id.to_s] if values.key?(field.id.to_s)
end
end
def any?
@fields.any?
end
end
end
@@ -1,58 +0,0 @@
#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.
module RedmineQboCalendar
# Optional support for redmine_issue_templates (https://github.com/agileware-jp/redmine_issue_templates).
# Everything here returns empty results when that plugin isn't installed or isn't enabled on the project.
module IssueTemplateSupport
Option = Struct.new(:key, :title, :tracker_id, :is_default, :description, :group, keyword_init: true)
module_function
def installed?
defined?(::IssueTemplate) && defined?(::GlobalIssueTemplate) && defined?(::IssueTemplateSetting)
end
def enabled_for?(project)
!!(installed? && project&.module_enabled?(:issue_templates))
end
# Templates usable in the project: its own, those shared by parent projects, and global ones.
def templates_for(project)
return [] unless enabled_for?(project)
own = ::IssueTemplate.get_templates_for_project_tracker(project.id).to_a
inherited = Array(::IssueTemplateSetting.find_or_create(project.id).get_inherit_templates).to_a
global = ::GlobalIssueTemplate.get_templates_for_project_tracker(project.id).to_a
(own + inherited).uniq.map { |t| option('project', t) } + global.map { |t| option('global', t) }
rescue StandardError => e
Rails.logger.warn "[IssueTemplateSupport] Could not load templates: #{e.class}: #{e.message}"
[]
end
def find(key, project)
return nil if key.blank?
templates_for(project).detect { |t| t.key == key }
end
def option(group, template)
Option.new(
key: "#{group}:#{template.id}",
title: template.title,
tracker_id: template.tracker_id,
is_default: template.is_default?,
description: template.description,
group: group
)
end
end
end
-24
View File
@@ -1,24 +0,0 @@
#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.
namespace :redmine_qbo_calendar do
desc 'Relate all issues created from the same QBO estimate to each other (one-time catch-up; safe to re-run)'
task relate_estimate_issues: :environment do
total = 0
estimates = AppointmentEstimateIssue.distinct.pluck(:estimate_id)
estimates.each do |estimate_id|
issues = AppointmentEstimateIssue.where(estimate_id: estimate_id).includes(:issue).filter_map(&:issue)
total += RedmineQboCalendar::EstimateIssueBuilder.relate_all(issues)
end
puts "Checked #{estimates.size} estimate(s), created #{total} relation(s)."
end
end