Add preview page for creating issues from an estimate

- "Create Issues from Estimate" now opens a preview listing each
  matching estimate line: include checkbox, subject (from the line
  description), tracker dropdown, template dropdown and estimated
  hours (from the line quantity)
- Admins set which QBO item codes to look for (e.g. Labor, Alignments)
  and a default tracker in the plugin settings
- Optional redmine_issue_templates support: templates supply the issue
  description; titles still come from the line description
- New appointment_estimate_issues table records which issue came from
  which estimate line, so a line can't be turned into an issue twice;
  deleting the issue frees the line again
- Creation is all-or-nothing; errors are shown on the preview page
- Removes the old Labor-only create_issues_from_labor_lines code

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-28 20:34:06 -04:00
1 parent 73115da2b9
commit 184c1e2464
15 files changed
+613 -92

No files matched your search

@@ -11,7 +11,7 @@
class CustomerAppointmentsController < ApplicationController
before_action :require_login
before_action :find_project, except: [:index]
before_action :find_appointment, only: [ :show, :edit, :update, :destroy, :create_issues ]
before_action :find_appointment, only: [ :show, :edit, :update, :destroy, :issues_preview, :create_issues ]
# This tells Redmine to check global permissions for the current controller/action
before_action :authorize_global
@@ -26,22 +26,26 @@ class CustomerAppointmentsController < ApplicationController
}
end
# Creates one issue per "Labor" line on the appointment's QBO estimate.
# Preview of the issues that can be created from the appointment's QBO estimate.
# Each line gets a tracker and (optionally) a template before anything is created.
def issues_preview
load_issue_preview
end
# Creates the issues selected on the preview page, all or nothing.
def create_issues
# Same fallback order as CustomerAppointment#create_issues_from_labor_lines
target_project = @project || @appointment.project || Project.first
load_issue_preview
return if performed?
# The user must also be allowed to add issues to the project they'll be created in
return deny_access unless target_project && User.current.allowed_to?(:add_issues, target_project)
created_issues = @appointment.create_issues_from_labor_lines(project: target_project, author: User.current)
@rows = params[:lines].respond_to?(:to_unsafe_h) ? params[:lines].to_unsafe_h : {}
created_issues = @builder.create_issues(project: @target_project, rows: @rows)
if created_issues.any?
flash[:notice] = l(:notice_appointment_issues_created, count: created_issues.size)
redirect_to customer_appointment_path(@appointment)
else
flash[:error] = l(:error_no_labor_lines_found)
render :issues_preview, status: :unprocessable_entity
end
redirect_to customer_appointment_path(@appointment)
end
def index
@@ -145,6 +149,28 @@ class CustomerAppointmentsController < ApplicationController
nil
end
# Sets up everything the preview page needs: the target project, its trackers and templates.
def load_issue_preview
@builder = RedmineQboCalendar::EstimateIssueBuilder.new(@appointment)
@available_projects = Project.allowed_to(User.current, :add_issues).sorted.to_a
# A project chosen on the page wins, then the appointment's project, then the first allowed one
@target_project =
if @project
@project if @available_projects.include?(@project)
elsif @available_projects.include?(@appointment.project)
@appointment.project
else
@available_projects.first
end
return deny_access unless @target_project
@trackers = Issue.allowed_target_trackers(@target_project, User.current).to_a
@default_tracker = @trackers.detect { |t| t.id == RedmineQboCalendar::EstimateIssueBuilder.default_tracker_id } || @trackers.first
@templates = RedmineQboCalendar::IssueTemplateSupport.templates_for(@target_project)
@rows ||= {}
end
def find_project
@project = Project.find(params[:project_id]) if params[:project_id].present?
end
+20
View File
@@ -0,0 +1,20 @@
#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.
# Link between a QBO estimate line and the issue created from it.
class AppointmentEstimateIssue < ActiveRecord::Base
belongs_to :customer_appointment, optional: true
belongs_to :issue
validates :estimate_id, :line_id, presence: true
validates :line_id, uniqueness: { scope: :estimate_id }
before_create { self.created_on ||= Time.current }
end
+4 -77
View File
@@ -16,6 +16,10 @@ class CustomerAppointment < ActiveRecord::Base
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
@@ -46,65 +50,6 @@ class CustomerAppointment < ActiveRecord::Base
!NON_SCHEDULED_STATUSES.include?(status.to_s)
end
# Scans the QBO Estimate's InvoiceLineItems for "Labor" sales items
# and generates a Redmine Issue for each matching line.
#
# @param project [Project] Target project (defaults to appointment's project)
# @param author [User] Author for the new issues
# @param tracker [Tracker] Target tracker (defaults to project's first tracker)
# @return [Array<Issue>] Created issues
def create_issues_from_labor_lines(project: self.project, author: User.current, tracker: nil)
return [] if estimate.blank?
target_project = project || self.project || Project.first
target_tracker = tracker || target_project&.trackers&.first
return [] unless target_project && target_tracker
created_issues = []
# estimate.line_items returns array of Quickbooks::Model::InvoiceLineItem
estimate.line_items.each do |line|
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
description = line.description.to_s.strip
# Match "Labor" (case-insensitive) and ensure description is present
next unless item_name.casecmp('Labor').zero?
next if description.blank?
# detail.quantity contains line quantity/hours; line.amount is total line cost fallback
qty = detail.respond_to?(:quantity) ? detail.quantity.to_f : 0.0
hours = qty.positive? ? qty : line.amount.to_f
issue = Issue.new(
project: target_project,
tracker: target_tracker,
assigned_to_id: self.user&.id,
author: author,
subject: description.truncate(255),
description: "The purpose of this work is to bill the time spent on this issue for Estimate ##{estimate.doc_number} for Appointment: #{subject}",
estimated_hours: hours,
start_date: self.start_date,
due_date: self.due_date,
vehicle: self.vehicle,
estimate: self.estimate,
customer: self.customer,
created_on: Time.current,
updated_on: Time.current
)
if issue.save
created_issues << issue
else
log "Failed to create issue for Estimate ##{estimate.id}: #{issue.errors.full_messages.join(', ')}"
end
end
created_issues
end
# Cast datetime to Date for Redmine Calendar compatibility
def start_date
date&.to_date
@@ -155,22 +100,4 @@ class CustomerAppointment < ActiveRecord::Base
end
end
# Helper to parse item name across Quickbooks::Model::Line and Hash structures
def extract_item_name(line)
if line.respond_to?(:sales_line_item_detail) && line.sales_line_item_detail.present?
line.sales_line_item_detail.item_ref&.name
elsif line.is_a?(Hash)
line[:item_name] || line.dig('sales_line_item_detail', 'item_ref', 'name')
end
end
# Helper to parse description across Quickbooks::Model::Line and Hash structures
def extract_description(line)
if line.respond_to?(:description)
line.description
elsif line.is_a?(Hash)
line[:description] || line['description']
end
end
end
@@ -0,0 +1,198 @@
<div class="contextual">
<%= link_to customer_appointment_path(@appointment) do %>
<i class="fa-solid fa-arrow-left"></i> <%= l(:label_appointment) %>
<% end %>
</div>
<h2>
<%= l(:button_create_issues_from_estimate) %>
<% if @appointment.estimate %>
<span class="estimate-preview-subtitle">
&middot; <%= l(:label_estimate) %> #<%= @appointment.estimate.doc_number %>
&middot; <%= @appointment.subject %>
</span>
<% end %>
</h2>
<%# Target project: changing it reloads the page with that project's trackers and templates %>
<% if @available_projects.size > 1 %>
<%= form_tag issues_preview_customer_appointment_path(@appointment), method: :get, id: 'estimate-issues-project-form' do %>
<p>
<label for="project_id"><strong><%= l(:field_project) %>:</strong></label>
<%= select_tag :project_id,
options_from_collection_for_select(@available_projects, :id, :name, @target_project.id),
onchange: 'this.form.submit();' %>
<noscript><%= submit_tag l(:button_apply), name: nil %></noscript>
</p>
<% end %>
<% else %>
<p><strong><%= l(:field_project) %>:</strong> <%= link_to_project @target_project %></p>
<% end %>
<% if @builder.errors.any? %>
<div id="errorExplanation">
<ul>
<% @builder.errors.each do |message| %>
<li><%= message %></li>
<% end %>
</ul>
</div>
<% end %>
<% proposals = @builder.proposals %>
<% if @appointment.estimate.blank? %>
<p class="nodata"><%= l(:label_appointment_has_no_estimate) %></p>
<% elsif proposals.empty? %>
<p class="nodata">
<%= l(:error_no_labor_lines_found) %>
(<%= l(:label_estimate_item_codes) %>: <%= RedmineQboCalendar::EstimateIssueBuilder.item_codes.join(', ') %>)
<% if User.current.admin? %>
&middot; <%= link_to l(:label_settings), plugin_settings_path(id: 'redmine_qbo_calendar') %>
<% end %>
</p>
<% else %>
<%
templates_enabled = RedmineQboCalendar::IssueTemplateSupport.enabled_for?(@target_project)
template_data = @templates.map { |t| { key: t.key, title: t.title, tracker_id: t.tracker_id, is_default: t.is_default, group: t.group } }
default_template_for = ->(tracker_id) { @templates.detect { |t| t.tracker_id == tracker_id.to_i && t.is_default }&.key }
selectable_count = proposals.count { |p| !p.created? }
%>
<%= form_tag create_issues_customer_appointment_path(@appointment),
method: :post,
id: 'estimate-issues-form',
data: { templates: template_data.to_json } do %>
<%= hidden_field_tag :project_id, @target_project.id %>
<table class="list estimate-issues-preview">
<thead>
<tr>
<th class="checkbox">
<% if selectable_count > 0 %>
<input type="checkbox" id="estimate-issues-toggle-all" checked title="<%= l(:button_check_all) %>">
<% end %>
</th>
<th><%= l(:label_estimate_item) %></th>
<th><%= l(:field_subject) %></th>
<th><%= l(:field_tracker) %></th>
<% if templates_enabled %>
<th><%= l(:label_issue_template) %></th>
<% end %>
<th><%= l(:field_estimated_hours) %></th>
</tr>
</thead>
<tbody>
<% proposals.each do |proposal| %>
<% field = "lines[#{proposal.line_id}]" %>
<% if proposal.created? %>
<tr class="estimate-line created">
<td class="checkbox"><input type="checkbox" disabled></td>
<td><%= proposal.item_name %></td>
<td class="subject"><%= proposal.description %></td>
<td colspan="<%= templates_enabled ? 3 : 2 %>">
<%= l(:label_estimate_line_already_created) %>:
<%= link_to_issue(proposal.existing_issue, truncate: 60) %>
</td>
</tr>
<% else %>
<%
row = (@rows[proposal.line_id] || {}).to_h
selected = row.empty? || row['selected'] == '1'
tracker_id = (row['tracker_id'].presence || @default_tracker&.id).to_i
template_key = row.key?('template') ? row['template'] : default_template_for.call(tracker_id)
hours = row.key?('estimated_hours') ? row['estimated_hours'] : proposal.hours
%>
<tr class="estimate-line">
<td class="checkbox">
<%= hidden_field_tag "#{field}[selected]", '0', id: nil %>
<%= check_box_tag "#{field}[selected]", '1', selected, class: 'estimate-line-select', id: nil %>
</td>
<td><%= proposal.item_name %></td>
<td class="subject">
<%= text_field_tag "#{field}[subject]", row['subject'] || proposal.description,
maxlength: 255, class: 'estimate-line-subject', id: nil %>
</td>
<td>
<%= select_tag "#{field}[tracker_id]",
options_from_collection_for_select(@trackers, :id, :name, tracker_id),
class: 'estimate-line-tracker', id: nil %>
</td>
<% if templates_enabled %>
<td>
<%# Options are filled by the script below to match the chosen tracker %>
<%= select_tag "#{field}[template]",
options_for_select([[l(:label_no_issue_template), '']] +
@templates.select { |t| t.tracker_id == tracker_id }.map { |t| [t.title, t.key] }, template_key),
class: 'estimate-line-template', id: nil %>
</td>
<% end %>
<td>
<%= number_field_tag "#{field}[estimated_hours]", hours, step: 0.25, min: 0, size: 6, id: nil %>
</td>
</tr>
<% end %>
<% end %>
</tbody>
</table>
<p class="estimate-issues-hint">
<% if templates_enabled %>
<%= l(:text_estimate_issues_template_hint) %>
<% else %>
<%= l(:text_estimate_issues_hint) %>
<% end %>
</p>
<p>
<% if selectable_count > 0 %>
<%= submit_tag l(:button_create_issues), data: { disable_with: l(:label_loading) } %>
<% end %>
<%= link_to l(:button_cancel), customer_appointment_path(@appointment) %>
</p>
<% end %>
<%= javascript_tag do %>
(function () {
var form = document.getElementById('estimate-issues-form');
if (!form) return;
// Select / deselect all lines
var toggleAll = document.getElementById('estimate-issues-toggle-all');
if (toggleAll) {
toggleAll.addEventListener('change', function () {
form.querySelectorAll('.estimate-line-select').forEach(function (box) { box.checked = toggleAll.checked; });
});
}
// Keep each template dropdown limited to templates for the chosen tracker
var templates = [];
try { templates = JSON.parse(form.dataset.templates || '[]'); } catch (e) { templates = []; }
var noneLabel = <%= raw l(:label_no_issue_template).to_json %>;
function fillTemplates(templateSelect, trackerId, useDefault) {
var current = templateSelect.value;
var matches = templates.filter(function (t) { return String(t.tracker_id) === String(trackerId); });
templateSelect.innerHTML = '';
templateSelect.appendChild(new Option(noneLabel, ''));
matches.forEach(function (t) {
templateSelect.appendChild(new Option(t.title + (t.group === 'global' ? ' (global)' : ''), t.key));
});
var defaultTemplate = matches.find(function (t) { return t.is_default; });
if (useDefault) {
templateSelect.value = defaultTemplate ? defaultTemplate.key : '';
} else if (matches.some(function (t) { return t.key === current; })) {
templateSelect.value = current;
}
}
form.querySelectorAll('tr.estimate-line').forEach(function (row) {
var tracker = row.querySelector('.estimate-line-tracker');
var template = row.querySelector('.estimate-line-template');
if (!tracker || !template) return;
fillTemplates(template, tracker.value, false);
tracker.addEventListener('change', function () { fillTemplates(template, tracker.value, true); });
});
})();
<% end %>
<% end %>
@@ -15,9 +15,7 @@
<% end %>
<% if @appointment.estimate && User.current.allowed_to?(:create_customer_appointment_issues, nil, global: true) %>
<%= link_to create_issues_customer_appointment_path(@appointment),
method: :post,
data: { confirm: l(:text_are_you_sure) } do %>
<%= link_to issues_preview_customer_appointment_path(@appointment) do %>
<i class="fa-solid fa-list-check"></i> <%= l(:button_create_issues_from_estimate) %>
<% end %>
<% end %>
@@ -0,0 +1,17 @@
<fieldset class="box tabular">
<legend><%= l(:label_estimate_issue_settings) %></legend>
<p>
<label for="settings_item_codes"><%= l(:label_estimate_item_codes) %></label>
<%= text_area_tag 'settings[item_codes]', settings['item_codes'], rows: 5, cols: 30, id: 'settings_item_codes' %>
<em class="info"><%= l(:text_estimate_item_codes_info) %></em>
</p>
<p>
<label for="settings_default_tracker_id"><%= l(:label_default_tracker) %></label>
<%= select_tag 'settings[default_tracker_id]',
options_from_collection_for_select(Tracker.sorted, :id, :name, settings['default_tracker_id'].to_i),
include_blank: true, id: 'settings_default_tracker_id' %>
<em class="info"><%= l(:text_default_tracker_info) %></em>
</p>
</fieldset>