mirror of
https://github.com/rickbarrette/redmine_qbo.git
synced 2026-11-17 18:20:36 -05:00
Move vehicle code out to redmine_qbo_vehicles
- IssueMileageListener removed: redmine_qbo_vehicles answers qbo_billing_issue_values with mileage. - New hook qbo_billing_build_issue sets plugins' fields on issues created from an estimate; the vehicle lookup by VIN moved to redmine_qbo_vehicles. - New hook qbo_billing_vin_options gives the VIN box's suggestions (RedmineQboBilling.vin_options) instead of reading customer.vehicles. - The customer page's New issue link script is generic: any checkbox with data-new-issue-param="issue[field]" fills that field. Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com> Claude-Session: https://claude.ai/code/session_01BiwYMjhoQvL7XsKKfRz4pM
This commit is contained in:
11 files changed
+78
-115
No files matched your search
@@ -19,7 +19,6 @@ module RedmineQboBilling
|
||||
|
||||
# Hooks
|
||||
RedmineQboBilling::Hooks::QboHookListener
|
||||
RedmineQboBilling::Hooks::IssueMileageListener
|
||||
|
||||
# Administration menu: the QuickBooks product/service list (accounts are reached from it)
|
||||
Redmine::MenuManager.map :admin_menu do |menu|
|
||||
@@ -28,6 +27,22 @@ module RedmineQboBilling
|
||||
end
|
||||
end
|
||||
|
||||
# VINs to suggest in the estimate/invoice VIN box for a customer, from plugins answering
|
||||
# :qbo_billing_vin_options, { customer: } => [{ vin:, name: }, ...] (e.g. redmine_qbo_vehicles: the
|
||||
# customer's vehicles)
|
||||
def self.vin_options(customer)
|
||||
return [] unless customer
|
||||
|
||||
Redmine::Hook.call_hook(:qbo_billing_vin_options, { customer: customer }).flatten.compact.filter_map do |option|
|
||||
option = option.to_h.symbolize_keys
|
||||
vin = option[:vin].to_s.strip
|
||||
{ vin: vin, name: option[:name].to_s.presence || vin } unless vin.empty?
|
||||
end.uniq { |o| o[:vin].upcase }
|
||||
rescue StandardError => e
|
||||
Rails.logger.warn "[RedmineQboBilling] VIN suggestions failed: #{e.message}"
|
||||
[]
|
||||
end
|
||||
|
||||
# True when the user may write estimates
|
||||
def self.writer?(user = User.current)
|
||||
user.allowed_to?(:write_estimates, nil, global: true)
|
||||
|
||||
@@ -12,7 +12,7 @@ module RedmineQboBilling
|
||||
# Turns the labor lines of a QuickBooks estimate into proposed issues, and creates the ones the user selects
|
||||
# on the "Create issues from estimate" page (moved here from redmine_qbo_calendar).
|
||||
#
|
||||
# - Only lines whose item matches a configured item code (e.g. "Labor", "Alignments") are proposed
|
||||
# - Only lines with a labor product/service (LaborItems, e.g. "Labor") 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
|
||||
@@ -20,8 +20,10 @@ module RedmineQboBilling
|
||||
#
|
||||
# Other plugins fill in more through hooks:
|
||||
# :qbo_billing_issue_defaults, { estimate:, params: } => a hash of start_date, due_date, assignee,
|
||||
# vehicle_id, description, project, return_path, return_label (e.g. redmine_qbo_calendar, when the page is
|
||||
# opened from an appointment)
|
||||
# description, project, return_path, return_label, plus anything a plugin's own fields need (e.g.
|
||||
# redmine_qbo_calendar's vehicle_id, when the page is opened from an appointment)
|
||||
# :qbo_billing_build_issue, { issue:, estimate:, defaults: } for each new issue before it's saved, to set
|
||||
# plugins' own fields (e.g. redmine_qbo_vehicles sets the vehicle)
|
||||
# :qbo_billing_issues_created, { estimate:, issues:, params: } after issues are created
|
||||
class EstimateIssueBuilder
|
||||
include Redmine::I18n
|
||||
@@ -89,7 +91,7 @@ module RedmineQboBilling
|
||||
attr_reader :estimate, :defaults, :errors
|
||||
|
||||
# estimate: redmine_qbo's local Estimate (its QuickBooks details give the lines)
|
||||
# defaults: start_date, due_date, assignee, vehicle_id, description (from another plugin's hook)
|
||||
# defaults: start_date, due_date, assignee, description and plugins' own values (from :qbo_billing_issue_defaults)
|
||||
def initialize(estimate, defaults: {})
|
||||
@estimate = estimate
|
||||
@defaults = (defaults || {}).to_h.symbolize_keys
|
||||
@@ -218,29 +220,15 @@ module RedmineQboBilling
|
||||
assignee = defaults[:assignee]
|
||||
issue.assigned_to = assignee if assignee && issue.assignable_users.include?(assignee)
|
||||
|
||||
# Customer / vehicle / estimate fields are added to issues by redmine_qbo and redmine_qbo_vehicles
|
||||
issue.customer_id = estimate.customer_id if issue.respond_to?(:customer_id=)
|
||||
issue.vehicle_id = vehicle_id if issue.respond_to?(:vehicle_id=)
|
||||
issue.estimate_id = estimate.id if issue.respond_to?(:estimate_id=)
|
||||
|
||||
# Plugins set their own fields (e.g. redmine_qbo_vehicles: the vehicle)
|
||||
Redmine::Hook.call_hook(:qbo_billing_build_issue, { issue: issue, estimate: estimate, defaults: defaults })
|
||||
|
||||
issue
|
||||
end
|
||||
|
||||
# The vehicle from the hook, or the customer's vehicle whose VIN is on the estimate
|
||||
def vehicle_id
|
||||
return defaults[:vehicle_id] if defaults[:vehicle_id].present?
|
||||
|
||||
customer = estimate.customer
|
||||
return nil unless customer.respond_to?(:vehicles)
|
||||
|
||||
vin = EstimateWriter.custom_value(estimate.details, Company.vin_field, Company::VIN_NAME).to_s.strip
|
||||
return nil if vin.empty?
|
||||
|
||||
customer.vehicles.detect { |v| v.vin.to_s.casecmp?(vin) }&.id
|
||||
rescue StandardError
|
||||
nil
|
||||
end
|
||||
|
||||
def default_description
|
||||
defaults[:description].presence ||
|
||||
"The purpose of this work is to bill the time spent on this issue for Estimate ##{estimate.doc_number}"
|
||||
|
||||
@@ -1,32 +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 RedmineQboBilling
|
||||
module Hooks
|
||||
|
||||
# Each work order's mileage, from Redmine's own issue custom field named "Mileage" (any capitalisation),
|
||||
# so an invoice's mileage box fills in when its time or estimates are imported. Answers the same
|
||||
# qbo_billing_issue_values hook other plugins use (see IssueValues).
|
||||
class IssueMileageListener < Redmine::Hook::Listener
|
||||
|
||||
def qbo_billing_issue_values(context = {})
|
||||
issue_ids = Array(context[:issues]).map(&:id)
|
||||
field = IssueCustomField.all.detect { |f| f.name.to_s.strip.casecmp?('mileage') }
|
||||
return {} if field.nil? || issue_ids.empty?
|
||||
|
||||
values = CustomValue.where(customized_type: 'Issue', customized_id: issue_ids, custom_field_id: field.id)
|
||||
.where.not(value: [nil, ''])
|
||||
.pluck(:customized_id, :value)
|
||||
{ mileage: values.to_h }
|
||||
end
|
||||
|
||||
end
|
||||
end
|
||||
end
|
||||
@@ -14,9 +14,9 @@ module RedmineQboBilling
|
||||
#
|
||||
# :qbo_billing_issue_values, { issues: [Issue, ...] }
|
||||
# Return a hash of field => { issue_id => value }, e.g. redmine_qbo_vehicles returns
|
||||
# { vin: { 116 => "1C4HJXDG5JW123456" } }. This plugin answers it too with { mileage: ... } from the
|
||||
# issue custom field named "Mileage" (Hooks::IssueMileageListener).
|
||||
# The invoice's VIN and mileage boxes are filled from them when time or estimates are imported.
|
||||
# { vin: { 116 => "1C4HJXDG5JW123456" }, mileage: { 116 => "48210" } } (mileage from the issue custom
|
||||
# field named "Mileage"). The invoice's VIN and mileage boxes are filled from them when time or
|
||||
# estimates are imported (the highest mileage wins).
|
||||
#
|
||||
# :qbo_billing_validate, { document: "invoice" or "estimate", form: EstimateForm, issues: [Issue, ...] }
|
||||
# Return an error message (or a list of them) to stop the save, e.g. redmine_qbo_vehicles refuses an
|
||||
|
||||
Reference in new issue
Block a user