15 Commits

11 changed files with 135 additions and 144 deletions

View File

@@ -10,7 +10,6 @@ The goal of this project is to enable vehicle tracking for customer vehicles wit
* **Parent Plugin:** [Redmine QuickBooks Online](https://github.com/rickbarrette/redmine_qbo) * **Parent Plugin:** [Redmine QuickBooks Online](https://github.com/rickbarrette/redmine_qbo)
## Compatibility ## Compatibility
| Plugin Version | Redmine Version | Ruby Version | | Plugin Version | Redmine Version | Ruby Version |
| :--- | :--- | :--- | | :--- | :--- | :--- |
| 2026.1.2+ | Redmine 6.1 | 3.2+ | | 2026.1.2+ | Redmine 6.1 | 3.2+ |

View File

@@ -60,10 +60,15 @@ class VehiclesController < ApplicationController
# display a specific vehicle # display a specific vehicle
def show def show
begin begin
@vehicle = Vehicle.find_by_id(params[:id]) @vehicle = Vehicle.includes(issues: [:estimate, :invoices]).find(params[:id])
@vin = @vehicle.vin.scan(/.{1,9}/) if @vehicle.vin @vin = @vehicle.vin.scan(/.{1,9}/) if @vehicle.vin
@issues = @vehicle.issues.order(id: :desc) @issues = @vehicle.issues
@closed_issues = (@issues - @issues.open) .joins(:status)
.includes(:estimate, :invoices, :status, :project, :tracker, :priority)
.order(id: :desc)
@open_issues = @issues.select { |i| !i.status.is_closed }
@closed_issues = @issues.select { |i| i.status.is_closed }
flash[:error] = t :alert_no_customer if @vehicle.customer.nil? flash[:error] = t :alert_no_customer if @vehicle.customer.nil?
rescue rescue
flash[:error] = t :alert_vehicle_not_found flash[:error] = t :alert_vehicle_not_found

View File

@@ -9,117 +9,26 @@
#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. #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 Vehicle < ActiveRecord::Base class Vehicle < ActiveRecord::Base
include Redmine::Acts::Searchable
include Redmine::Acts::Event
belongs_to :customer belongs_to :customer
has_many :issues has_many :issues
validates_presence_of :customer validates_presence_of :customer
validates :vin, uniqueness: true validates :vin, uniqueness: true
before_save :decode_vin before_save :decode_vin
def self.searchable_columns acts_as_searchable columns: %w[vin make model year],
['vin', 'make', 'model', 'year'] scope: ->(_context) { left_joins(:project) },
end date_column: :updated_at
def self.searchable_options acts_as_event :title => Proc.new {|o| "#{o.to_s}"},
{ :url => Proc.new {|o| { :controller => 'vehicles', :action => 'show', :id => o.id} },
columns: searchable_columns, :type => :to_s,
scope: self.all :description => Proc.new {|o| "#{o.vin} - #{o.customer}"},
} :datetime => Proc.new {|o| o.updated_at || o.created_at}
end
def self.search_result_ranks_and_ids(tokens, user, project = nil, options = {})
return {} if tokens.blank?
scope = self.all
tokens.each do |token|
q = "%#{sanitize_sql_like(token)}%"
scope = where("vin LIKE ? OR make LIKE ? OR model LIKE ? OR year LIKE ?", "%#{q}%", "%#{q}%", "%#{q}%", "%#{q}%")
end
ids = scope.distinct.limit(options[:limit] || 100).pluck(:id)
# Assign simple uniform ranking
ids.each_with_object({}) { |id, h| h[id] = id }
end
def self.search_results_from_ids(ids, *args)
return [] if ids.blank?
Rails.logger.warn "IDS: #{ids.inspect}"
ids = ids.map(&:to_i)
records = where(id: ids).index_by(&:id)
ids.map { |id| records[id] }.compact
end
# ---- Redmine Search Event Interface ----
def event_type
'vehicle'
end
def event_title
to_s
end
def event_description
"#{vin} #{year} #{make} #{model}"
end
def event_url
Rails.application.routes.url_helpers.vehicle_path(self)
end
def event_datetime
updated_at || created_at
end
def project
# Vehicles are not project scoped in your schema.
# Return nil so global search works cleanly.
nil
end
# returns a human readable string
def to_s
if year.nil? or make.nil? or model.nil?
return "#{vin}"
else
split_vin = vin.scan(/.{1,9}/)
return "#{year} #{make} #{model} - #{split_vin[1]}"
end
end
# returns the raw JSON details from NHTSA
def details
get_details if @details.nil?
return @details
end
# Force Upper Case for make numbers
def make=(val)
# The to_s is in case you get nil/non-string
write_attribute(:make, val.to_s.titleize)
end
# Force Upper Case for model numbers
def model=(val)
# The to_s is in case you get nil/non-string
write_attribute(:model, val.to_s.titleize)
end
# Force Upper Case & strip VIN of all illegal chars (for barcode scanner)
def vin=(val)
val = val.to_s.upcase.gsub(/[^A-HJ-NPR-Za-hj-npr-z\d]+/,"")
write_attribute(:vin, val)
end
# search for a vehicle by vin, make, model, or year
def self.search(query)
q = sanitize_sql_like(query)
where("vin LIKE ? OR make LIKE ? OR model LIKE ? OR year LIKE ?", "%#{q}%", "%#{q}%", "%#{q}%", "%#{q}%")
end
# decodes a vin and updates self # decodes a vin and updates self
def decode_vin def decode_vin
get_details get_details
@@ -137,15 +46,74 @@ class Vehicle < ActiveRecord::Base
self.name = to_s self.name = to_s
end end
# reurns all invoices for this vehicle # returns the raw JSON details from NHTSA
def invoices def details
self.issues.flat_map(&:invoices).uniq.compact get_details if @details.nil?
return @details
end end
# returns all estimates for this vehicle # returns all estimates for this vehicle
def estimates def estimates
self.issues.flat_map(&:estimate).uniq.compact self.issues.flat_map(&:estimate).uniq.compact
end end
# reurns all invoices for this vehicle
def invoices
self.issues.flat_map(&:invoices).uniq.compact
end
# Force Upper Case for make numbers
def make=(val)
# The to_s is in case you get nil/non-string
write_attribute(:make, val.to_s.titleize)
end
# Force Upper Case for model numbers
def model=(val)
# The to_s is in case you get nil/non-string
write_attribute(:model, val.to_s.titleize)
end
# needed for redmine's search and event system, but we don't want to tie vehicles to projects
def project
nil
end
# search for a vehicle by vin, make, model, or year
def self.search(query)
q = sanitize_sql_like(query)
where("vin LIKE ? OR make LIKE ? OR model LIKE ? OR year LIKE ?", "%#{q}%", "%#{q}%", "%#{q}%", "%#{q}%")
end
# Override the defult redmine seach method to rank results by id
def self.search_result_ranks_and_ids(tokens, user, project = nil, options = {})
return {} if tokens.blank?
scope = self.all
tokens.each do |token|
scope = scope.search(token)
end
ids = scope.distinct.limit(options[:limit] || 100).pluck(:id)
ids.index_with { |id| id }
end
# returns a human readable string
def to_s
if year.nil? or make.nil? or model.nil?
return "#{vin}"
else
split_vin = vin.scan(/.{1,9}/)
return "#{year} #{make} #{model} - #{split_vin[1]}"
end
end
# Force Upper Case & strip VIN of all illegal chars (for barcode scanner)
def vin=(val)
val = val.to_s.upcase.gsub(/[^A-HJ-NPR-Za-hj-npr-z\d]+/,"")
write_attribute(:vin, val)
end
private private

View File

@@ -6,7 +6,7 @@
<div class="clearfix"> <div class="clearfix">
<%=t(:field_customer)%>: <%=t(:field_customer)%>:
<div class="input"> <div class="input">
<%= f.autocomplete_field :customer, autocomplete_customer_name_customers_path, value: @customer.name, update_elements: {id: '#customer_id', value: '#issue_customer'}, required: true %> <%= f.text_field :customer, class: "customer-name", autocomplete: "off", value: @customer.name, required: true,data: { autocomplete_url: "/customers/autocomplete" } %>
<%= f.hidden_field :customer_id, id: "customer_id", value: @customer.id %> <%= f.hidden_field :customer_id, id: "customer_id", value: @customer.id %>
</div> </div>
</div> </div>

View File

@@ -14,9 +14,9 @@
</div> </div>
</div> </div>
<h3><%=@issues.open.count%> <%=t(:label_open_issues)%></h3> <h3><%=@open_issues.count%> <%=t(:label_open_issues)%></h3>
<%= render partial: 'issues/list_simple', locals: {issues: @issues.open} %> <%= render partial: 'issues/list_simple', locals: {issues: @open_issues} %>
<h3><%=@closed_issues.count%> <%=t(:label_closed_issues)%></h3> <h3><%=@closed_issues.count%> <%=t(:label_closed_issues)%></h3>

View File

@@ -12,6 +12,11 @@ async function handleCopy(event) {
link = event.target; link = event.target;
} }
// If the text is already "Copied!", don't do anything
if (text == "Copied!") {
return;
}
try { try {
// Write to clipboard // Write to clipboard
await navigator.clipboard.writeText(text); await navigator.clipboard.writeText(text);

12
init.rb
View File

@@ -14,14 +14,14 @@ Redmine::Plugin.register :redmine_qbo_vehicles do
name 'Redmine QBO Vehicles plugin' name 'Redmine QBO Vehicles plugin'
author 'Rick Barrette' author 'Rick Barrette'
description 'This is a plugin for Redmine to intergrate with the redmine_qbo plugin to provide vehicle data tracking' description 'This is a plugin for Redmine to intergrate with the redmine_qbo plugin to provide vehicle data tracking'
version '2026.2.6' version '2026.3.2'
url 'https://github.com/rickbarrette/redmine_qbo_vehicles' url 'https://github.com/rickbarrette/redmine_qbo_vehicles'
author_url 'https://barrettefabrication.com' author_url 'https://barrettefabrication.com'
requires_redmine version_or_higher: '6.1.0' requires_redmine version_or_higher: '6.1.0'
# Ensure redmine_qbo is installed # Ensure redmine_qbo is installed
begin begin
requires_redmine_plugin :redmine_qbo, version_or_higher: '2026.1.2' requires_redmine_plugin :redmine_qbo, version_or_higher: '2026.3.13'
rescue Redmine::PluginNotFound rescue Redmine::PluginNotFound
raise 'Please install the redmine_qbo plugin (https://github.com/rickbarrette/redmine_qbo)' raise 'Please install the redmine_qbo plugin (https://github.com/rickbarrette/redmine_qbo)'
end end
@@ -41,10 +41,4 @@ Redmine::Plugin.register :redmine_qbo_vehicles do
end end
# Dynamically load all Hooks & Patches recursively RedmineQboVehicles.setup
base_dir = File.join(File.dirname(__FILE__), 'lib')
# '**' looks inside subdirectories, '*.rb' matches Ruby files
Dir.glob(File.join(base_dir, '**', '*.rb')).sort.each do |file|
require file
end

View File

@@ -0,0 +1,23 @@
#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 RedmineQboVehicles
def self.setup
Issue.prepend Vehicles::Patches::IssuePatch
Customer.prepend Vehicles::Patches::CustomerPatch
Vehicles::Hooks::CustomerShowHookListener
Vehicles::Hooks::InvoiceHookListener
Vehicles::Hooks::IssuesFormHookListener
Vehicles::Hooks::IssuesShowHookListener
Vehicles::Hooks::PdfHookListener
Vehicles::Hooks::ViewHookListener
end
end

View File

@@ -17,13 +17,13 @@ module Vehicles
# Called by Redmine QBO Invoice # Called by Redmine QBO Invoice
def process_invoice_custom_fields(context={}) def process_invoice_custom_fields(context={})
Rails.logger.info "redmine_qbo_vehicles.process_invoice_custom_fields" log "Processing invoice custom fields for invoice ##{context[:invoice].id}"
issue = context[:issue] issue = context[:issue]
# update the invoive custom fields with infomation from the issue if available # update the invoive custom fields with infomation from the issue if available
context[:invoice].custom_fields.each do |cf| context[:invoice].custom_fields.each do |cf|
Rails.logger.info "Checking invoice.custom field: #{cf.name}" log "Checking invoice custom field: #{cf.name}"
# VIN from the attached vehicle # VIN from the attached vehicle
begin begin
@@ -32,13 +32,13 @@ module Vehicles
# TODO check cf_sync_confict flag once implemented # TODO check cf_sync_confict flag once implemented
if cf.string_value.to_s.blank? if cf.string_value.to_s.blank?
Rails.logger.info "VIN was blank, updating the invoice vin in quickbooks" log "VIN was blank, updating the invoice vin in quickbooks"
vin = context[:issue].vehicle.vin vin = context[:issue].vehicle.vin
break if vin.nil? break if vin.nil?
if not cf.string_value.to_s.eql? vin if not cf.string_value.to_s.eql? vin
cf.string_value = vin.to_s cf.string_value = vin.to_s
Rails.logger.info "VIN has changed" log "VIN has changed"
context[:is_changed] = true context[:is_changed] = true
end end
@@ -47,7 +47,7 @@ module Vehicles
end end
rescue rescue
#do nothing #do nothing
Rails.logger.info "redmine_qbo_vehicles.process_invoice_custom_fields failed, skipping" log "redmine_qbo_vehicles.process_invoice_custom_fields failed, skipping"
return nil return nil
end end
end end
@@ -56,6 +56,12 @@ module Vehicles
return nil return nil
end end
private
def log(msg)
Rails.logger.info "[InvoiceHookListener] #{msg}"
end
end end
end end

View File

@@ -14,16 +14,12 @@ module Vehicles
# Patches Redmine QBO Customer dynamically. # Patches Redmine QBO Customer dynamically.
# Adds a relationship for vehicle ownership by customers # Adds a relationship for vehicle ownership by customers
module CustomerPatch module CustomerPatch
extend ActiveSupport::Concern
ActiveSupport.on_load(:active_record) do prepended do
has_many :vehicles
Customer.class_eval do
has_many :vehicles
end
end end
end end
end end
end end

View File

@@ -8,23 +8,18 @@
# #
#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. #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.
require_dependency 'issue'
module Vehicles module Vehicles
module Patches module Patches
# Patches Redmine's Issues dynamically. # Patches Redmine's Issues dynamically.
# Adds a relationship for attahcing a vehilce to an issue # Adds a relationship for attahcing a vehilce to an issue
module IssuePatch module IssuePatch
extend ActiveSupport::Concern
ActiveSupport.on_load(:active_record) do prepended do
belongs_to :vehicle
Issue.class_eval do
belongs_to :vehicle
end
end end
end end
end end
end end