diff --git a/README.md b/README.md index 1469c85..cf49cea 100644 --- a/README.md +++ b/README.md @@ -270,8 +270,8 @@ Hook| :qbo_additional_entities | Used to add additional entites to be processed Hook| :qbo_full_sync | Used to add a Class to be called by the QboSyncDispatcher Hook|:qbo_billing_issue_values, { issues: } | Return `{ field_id => { issue_id => value } }` (QuickBooks custom field id; find yours with `RedmineQboBilling::Company.custom_field_matching(/name/)`) for the work orders behind an invoice, e.g. redmine_qbo_vehicles' VIN and mileage. They're given to the editor with imported time and estimates (the `qbo:imported` event) and put on redmine_qbo_lineitems' estimates Hook|:qbo_billing_validate, { document:, form:, issues: } | Return an error message (or several) to stop an estimate or invoice from saving, e.g. redmine_qbo_vehicles: one vehicle per invoice -Hook|:qbo_billing_issue_defaults, { estimate:, params: } | Return `start_date`, `due_date`, `assignee`, `project`, `description`, `return_path`, `return_label`, plus any values your own fields need (e.g. redmine_qbo_calendar's `vehicle_id`), for issues created from an estimate (redmine_qbo_calendar, when opened from an appointment) -Hook|:qbo_billing_build_issue, { issue:, estimate:, defaults: } | Set your plugin's own fields on each issue created from an estimate, before it's saved (redmine_qbo_vehicles sets the vehicle: the one in `defaults`, or the customer's vehicle whose VIN is on the estimate) +Hook|:qbo_billing_issue_defaults, { estimate:, params:, parent_issue: } | Return `start_date`, `due_date`, `assignee`, `project`, `description`, `return_path`, `return_label`, plus any values your own fields need, for issues created from an estimate (redmine_qbo_calendar, when opened from an appointment; redmine_qbo_vehicles: the parent's or appointment's vehicle). Every plugin's hash is merged +Hook|:qbo_billing_build_issue, { issue:, estimate:, defaults:, parent: } | Set your plugin's own fields on each issue created from an estimate, before it's saved; `parent` is the parent issue, if any (redmine_qbo_vehicles sets the vehicle: the one in `defaults`, the customer's vehicle whose VIN is on the estimate, or the parent's) View|:view_qbo_estimate_issues_form, { estimate:, defaults:, project: } | Draw your plugin's fields on the Create issues from estimate page, applied to every issue. Name them `issue_plugin_fields[name]`; the posted values reach `:qbo_billing_build_issue` in `defaults` (redmine_qbo_vehicles: the Vehicle, preselected from the estimate's VIN) Hook|:qbo_billing_issues_created, { estimate:, issues:, params: } | Called after issues are created from an estimate Hook|:qbo_billing_field_defaults, { customer:, issues: } | Return `{ field_id => value }` for a document's work orders: used when an invoice is made from an estimate, for the fields it leaves blank. New estimates and invoices start blank (redmine_qbo_vehicles: the work orders' VIN and highest mileage) diff --git a/app/controllers/qbo_estimates_controller.rb b/app/controllers/qbo_estimates_controller.rb index 67bce3b..39d6504 100644 --- a/app/controllers/qbo_estimates_controller.rb +++ b/app/controllers/qbo_estimates_controller.rb @@ -95,8 +95,8 @@ class QboEstimatesController < ApplicationController end # Preview of the issues that can be created from the estimate's labor lines. Each line gets a tracker and - # (optionally) a template before anything is created. Opened from an appointment, the appointment's dates, - # technician and vehicle are used (redmine_qbo_calendar's :qbo_billing_issue_defaults). + # (optionally) a template before anything is created. Plugins fill in defaults through + # :qbo_billing_issue_defaults (e.g. redmine_qbo_calendar: the appointment's dates and technician). def issues_preview end @@ -227,19 +227,11 @@ class QboEstimatesController < ApplicationController # What the new issues start from: # - dates: another plugin's (e.g. the appointment's), else the parent issue's - # - vehicle: the parent issue's, else another plugin's (e.g. the appointment's) - # Values posted with the form (the dates, plugins' fields such as redmine_qbo_vehicles' vehicle) win. + # - plugins' own fields: what they return for :qbo_billing_issue_defaults (they're given the parent issue) + # Values posted with the form (the dates, plugins' fields) win. def build_defaults - parent_dates = {} - parent_vehicle = {} - if @parent_issue - parent_dates = { start_date: @parent_issue.start_date, due_date: @parent_issue.due_date }.compact - if @parent_issue.respond_to?(:vehicle_id) && @parent_issue.vehicle_id.present? - parent_vehicle = { vehicle_id: @parent_issue.vehicle_id.to_s } - end - end - - parent_dates.merge(issue_defaults.compact).merge(parent_vehicle).merge(submitted_plugin_fields).merge(submitted_dates) + parent_dates = @parent_issue ? { start_date: @parent_issue.start_date, due_date: @parent_issue.due_date }.compact : {} + parent_dates.merge(issue_defaults.compact).merge(submitted_plugin_fields).merge(submitted_dates) end # The Start date / Due date entered on the page, only when the form was posted. A blank one means no date. @@ -269,14 +261,15 @@ class QboEstimatesController < ApplicationController end end - # The first non-empty hash a plugin returns for :qbo_billing_issue_defaults + # What plugins return for :qbo_billing_issue_defaults, merged (each fills in its own keys) def issue_defaults - results = Redmine::Hook.call_hook(:qbo_billing_issue_defaults, { estimate: @estimate, params: params }) - (results.detect { |r| r.is_a?(Hash) && r.any? } || {}).symbolize_keys + results = Redmine::Hook.call_hook(:qbo_billing_issue_defaults, + { estimate: @estimate, params: params, parent_issue: @parent_issue }) + results.select { |r| r.is_a?(Hash) }.reduce({}) { |merged, r| merged.merge(r.symbolize_keys) } end # Plugins' own fields on the preview form (issue_plugin_fields[...], drawn by :view_qbo_estimate_issues_form), - # only when the form was posted: { vehicle_id: "5" } + # only when the form was posted, e.g. { some_plugin_field: "5" } def submitted_plugin_fields return {} unless request.post? diff --git a/app/views/qbo_estimates/issues_preview.html.erb b/app/views/qbo_estimates/issues_preview.html.erb index 0ecc119..d528139 100644 --- a/app/views/qbo_estimates/issues_preview.html.erb +++ b/app/views/qbo_estimates/issues_preview.html.erb @@ -15,7 +15,7 @@ <%# Target project and parent task: changing either reloads the page (the project's trackers and templates; - the parent's project, vehicle and custom field values) %> + the parent's project, custom field values and plugins' fields) %> <%= form_tag issues_preview_qbo_estimate_path(@estimate.id), method: :get, id: 'estimate-issues-project-form' do %> <% carry.each do |key, value| %><%= hidden_field_tag key, value, id: nil %><% end %>

diff --git a/config/locales/en.yml b/config/locales/en.yml index e09121b..c15a38f 100644 --- a/config/locales/en.yml +++ b/config/locales/en.yml @@ -15,7 +15,7 @@ en: error_estimate_parent_not_found: "Parent task #%{id} wasn't found, or you can't see it." error_estimate_parent_not_allowed: "You aren't allowed to add subtasks in %{project}." label_estimate_parent_placeholder: "Optional" - text_estimate_parent_info: "The issues are created as subtasks. They get the parent's customer, and the vehicle and custom field values below start from the parent's; any left empty are filled from the parent." + text_estimate_parent_info: "The issues are created as subtasks. They get the parent's customer, and the fields below start from the parent's; any left empty are filled from the parent." notice_qbo_oauth_state_mismatch: "QuickBooks connection was not completed: the request could not be verified. Please try connecting again." permission_bill_issues: "Bill issue time to QuickBooks" permission_share_issues_with_customers: "Share issues with customers" diff --git a/lib/redmine_qbo_billing/estimate_issue_builder.rb b/lib/redmine_qbo_billing/estimate_issue_builder.rb index dc6a08d..040a13b 100644 --- a/lib/redmine_qbo_billing/estimate_issue_builder.rb +++ b/lib/redmine_qbo_billing/estimate_issue_builder.rb @@ -17,16 +17,16 @@ module RedmineQboBilling # - 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 - # - With a parent issue, the issues are created as its subtasks and take its customer, plus its vehicle and - # custom field values where the page left them empty (the same rules as the subtask_field_copier plugin, - # which is used when installed) + # - With a parent issue, the issues are created as its subtasks and take its customer, plus its custom field + # values where the page left them empty (the same rules as the subtask_field_copier plugin, which is used + # when installed). Plugins copy their own fields from the parent in :qbo_billing_build_issue. # # Other plugins fill in more through hooks: - # :qbo_billing_issue_defaults, { estimate:, params: } => a hash of start_date, due_date, assignee, - # 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_issue_defaults, { estimate:, params:, parent_issue: } => a hash of start_date, due_date, + # assignee, description, project, return_path, return_label, plus anything a plugin's own fields need. + # Every plugin's hash is merged. + # :qbo_billing_build_issue, { issue:, estimate:, defaults:, parent: } for each new issue before it's saved, + # to set plugins' own fields (e.g. redmine_qbo_vehicles sets the vehicle, else the parent's) # :view_qbo_estimate_issues_form, { estimate:, defaults:, project: } (view hook) draws plugins' fields on # the page, applied to every issue; posted as issue_plugin_fields[name], they reach :qbo_billing_build_issue # in defaults (e.g. redmine_qbo_vehicles' Vehicle, preselected from the estimate's VIN) @@ -237,7 +237,7 @@ module RedmineQboBilling 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 }) + Redmine::Hook.call_hook(:qbo_billing_build_issue, { issue: issue, estimate: estimate, defaults: defaults, parent: parent }) if parent issue.parent_issue_id = parent.id @@ -248,7 +248,7 @@ module RedmineQboBilling end # Fills the subtask's empty fields from the parent: custom fields (those the author can see on the parent - # and edit on the subtask) and plugins' registered fields (customer, vehicle). Values entered on the page win. + # and edit on the subtask), and with subtask_field_copier its registered fields. Values entered on the page win. def copy_from_parent(issue, author) if defined?(::SubtaskFieldCopier) ::SubtaskFieldCopier.copy_from_parent(issue, parent, author, {}) @@ -263,10 +263,6 @@ module RedmineQboBilling values[custom_value.custom_field_id.to_s] = value end issue.custom_field_values = copied if copied.any? - - if issue.respond_to?(:vehicle_id=) && issue.vehicle_id.blank? && parent.respond_to?(:vehicle_id) - issue.vehicle_id = parent.vehicle_id - end end def default_description