2026.2.0

Added vehicle estimates & invoices to vehicle page

README.md

@@ -1,53 +1,55 @@
 # Redmine QuickBooks Online Vehicles
 
-A redmine plugin to compliment the Redmine QuickBooks Online Vehicles plug in.
+A Redmine plugin to complement the [Redmine QuickBooks Online](https://github.com/rickbarrette/redmine_qbo) plugin.
 
-The goal of this project is to allow add vehicle tracking for customer vehicles.
+The goal of this project is to enable vehicle tracking for customer vehicles within Redmine.
+
+## Requirements
+
+* **Redmine:** 6.1+
+* **Parent Plugin:** [Redmine QuickBooks Online](https://github.com/rickbarrette/redmine_qbo)
 
 ## Compatibility
 
-| Redmine QBO Plugin Version | Redmine Version |
+| Plugin Version | Redmine Version | Ruby Version |
-| :--- | :--- |
+| :--- | :--- | :--- |
-| Version 2026.1.2+ | Redmine 6.1 |
+| 2026.1.2+ | Redmine 6.1 | 3.2+ |
 
 ## Features
 
-Adds vehicles that are owned by customers that can be attached to issues.
+* **Asset Tracking:** Adds vehicles owned by customers to the system.
+* **Issue Association:** Allows these vehicles to be attached directly to Redmine issues for better service tracking.
 
 ## Installation
 
-1. **Clone the plugin:**
+1.  **Clone the plugin:**
-   Clone this repo into your plugin folder and checkout a tagged version.
+    Navigate to your Redmine plugins directory and clone the repository.
-   ```bash
+    ```bash
-   cd path/to/redmine/plugins
+    cd path/to/redmine/plugins
-   git clone git@github.com:rickbarrette/redmine_qbo_vehicles.git
+    git clone git@github.com:rickbarrette/redmine_qbo_vehicles.git
-   cd redmine_qbo
+    cd redmine_qbo_vehicles
-   git checkout <tag>
+    git checkout <tag> 
-   ```
-
-2.  **Install dependencies:** *Crucial for Redmine 6 / Rails 7 compatibility.*
-    
-    Bash
-    
     ```
+    *(Note: Replace `<tag>` with the specific release version you wish to use, or omit the last line to use the main branch.)*
+
+2.  **Install dependencies:**
+    *Crucial for Redmine 6 / Rails 7 compatibility.*
+    ```bash
     bundle install
     ```
-    
+
 3.  **Migrate your database:**
-    
+    ```bash
-    Bash
-    
-    ```
     bundle exec rake redmine:plugins:migrate RAILS_ENV=production
     ```
-    
+
-4.  **Restart Redmine:** You must restart your Redmine server instance for the plugin and hooks to load.
+4.  **Restart Redmine:**
+    You must restart your Redmine server instance (e.g., Puma, Passenger, Unicorn) for the plugin and hooks to load correctly.
 
 ## Usage
 
-Simply add vehicles to customers via Customer view
+1.  **Add a Vehicle:** Navigate to a Customer Profile. You will see a new option to add vehicles to that customer.
-
+2.  **Link to Issue:** Once a vehicle is added to a customer, it can be selected and attached to an Issue relevant to that customer.
-Once a customer is attached to the customer, they can be attached to an issue.
 
 ## License
 

app/controllers/vehicles_controller.rb

@@ -23,15 +23,16 @@ class VehiclesController < ApplicationController
   def index
     if params[:customer_id]
       begin
-        @vehicles = Customer.find_by_id(params[:customer_id]).vehicles.paginate(:page => params[:page])
+        @vehicles = Customer.find_by_id(params[:customer_id]).vehicles.paginate(page: params[:page])
       rescue ActiveRecord::RecordNotFound
+        flash[:error] = t :alert_vehicle_not_found
         render_404
       end
     end
 
     # search for a vehicle by vin
     if params[:search]
-      @vehicles = Vehicle.search(params[:search]).paginate(:page => params[:page])
+      @vehicles = Vehicle.search(params[:search]).paginate(page: params[:page])
       if only_one_non_zero?(@vehicles)
         redirect_to @vehicles.first
       end
@@ -48,7 +49,7 @@ class VehiclesController < ApplicationController
   def create
     @vehicle = Vehicle.new(allowed_params)
     if @vehicle.save
-      flash[:notice] = "New Vehicle Created"
+      flash[:notice] = t :notice_vehicle_created
       redirect_to @vehicle
     else
       flash[:error] = @vehicle.errors.full_messages.to_sentence
@@ -64,6 +65,7 @@ class VehiclesController < ApplicationController
       @issues = @vehicle.issues.order(id: :desc)
       @closed_issues = (@issues - @issues.open)
     rescue 
+      flash[:error] = t :alert_vehicle_not_found
       render_404
     end
   end
@@ -74,6 +76,7 @@ class VehiclesController < ApplicationController
       @vehicle = Vehicle.find_by_id(params[:id])
       @customer = @vehicle.customer
     rescue 
+      flash[:error] = t :alert_vehicle_not_found
       render_404
     end
   end
@@ -84,7 +87,7 @@ class VehiclesController < ApplicationController
     begin
       @vehicle = Vehicle.find_by_id(params[:id])
       if @vehicle.update(allowed_params)
-        flash[:notice] = "Vehicle updated"
+        flash[:notice] = t :notice_vehicle_updated
         redirect_to @vehicle
       else
         redirect_to edit_vehicle_path
@@ -92,6 +95,7 @@ class VehiclesController < ApplicationController
       #show any errors anyways
       flash[:error] = @vehicle.errors.full_messages.to_sentence unless @vehicle.errors.empty?
     rescue 
+      flash[:error] = t :alert_vehicle_not_updated
       render_404
     end
   end
@@ -100,9 +104,10 @@ class VehiclesController < ApplicationController
   def destroy
     begin
       Vehicle.find_by_id(params[:id]).destroy
-      flash[:notice] = "Vehicle deleted successfully"
+      flash[:notice] = t :notice_vehicle_deleted
       redirect_to action: :index
     rescue 
+      flash[:error] = t :alert_vehicle_not_deleted
       render_404
     end
   end

app/models/vehicle.rb

@@ -71,6 +71,16 @@ class Vehicle < ActiveRecord::Base
     end
     self.name = to_s
   end
+
+  # reurns all invoices for this vehicle
+  def invoices
+    self.issues.flat_map(&:invoices).uniq.compact
+  end
+
+  # returns all estimates for this vehicle
+  def estimates
+    self.issues.flat_map(&:estimate).uniq.compact
+  end
   
   private
   

app/views/customers/_show_hook.html.erb

@@ -1,5 +1,5 @@
 <h4><%=t(:field_vehicles)%>:</h4>
-<%= render :partial => 'vehicles/list', :locals => { :vehicles => customer.vehicles.paginate(:page => params[:page]) } %>
+<%= render partial: 'vehicles/list', locals: { vehicles: customer.vehicles.paginate(page: params[:page]) } %>
 <div style="float: right;">
     <%= button_to t(:button_new_vehice), new_customer_vehicle_path(customer), method: :get %>
 </div>

app/views/issues/_show_issue_view_right.html.erb

@@ -10,9 +10,5 @@
     
 <div class="vehicle_notes attribute">
     <div class="label"><span><%=t(:field_notes)%></span>:</div>
-    <div class="value">
+    <pre class="value" id="note-display" style="text-align: left; white-space: pre-wrap; font-family: inherit; "><%=notes%></pre>
-    <pre id="note-display" style="text-align: left; white-space: pre-wrap; font-family: inherit; ">
-        <%=notes%>
-    </pre>
-    </div>
 </div>

app/views/vehicles/_form.html.erb

@@ -6,43 +6,43 @@
         <div class="clearfix">
           <%=t(:field_customer)%>:
           <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.autocomplete_field :customer, autocomplete_customer_name_customers_path, value: @customer.name, update_elements: {id: '#customer_id', value: '#issue_customer'}, required: true %>
-            <%= 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 class="clearfix">
           <%=t(:label_year)%>: 
           <div class="input">
-            <%= f.number_field :year, :autocomplete => "off"  %>
+            <%= f.number_field :year, autocomplete: "off"  %>
           </div>
         </div>
         
         <div class="clearfix">
           <%=t(:label_make)%>:
           <div class="input">
-            <%= f.text_field :make, :autocomplete => "off"  %>
+            <%= f.text_field :make, autocomplete: "off"  %>
           </div>
         </div>
         
         <div class="clearfix">
           <%=t(:label_model)%>:
           <div class="input">
-            <%= f.text_field :model, :autocomplete => "off"  %>
+            <%= f.text_field :model, autocomplete: "off"  %>
           </div>
         </div>
         
         <div class="clearfix">
           <%=t(:field_vin)%>:
           <div class="input">
-            <%= f.text_field :vin , :autofocus => true %>
+            <%= f.text_field :vin , autofocus: true %>
           </div>
         </div>
         
         <div class="clearfix">
           <%=t(:field_notes)%>: 
           <div class="input">
-            <%= f.text_area :notes, :cols => 60, :rows => 10, :no_label => true %>
+            <%= f.text_area :notes, cols: 60, rows: 10, no_label: true %>
           </div>
         </div>
         

app/views/vehicles/_list.html.erb

@@ -3,6 +3,7 @@
   <% vehicles.each do |vehicle| %>
     <div class="row">
       <div>
+        <%= check_box_tag "vehicle_ids[]", vehicle.id, false,  onchange: "updateLink()", data: { url: vehicle_path(vehicle).html_safe, text: vehicle.to_s }, class: "appointment" %>
         <b><%= link_to "##{vehicle.id}", vehicle_path(vehicle) %> </b>
       </div>
       

app/views/vehicles/_search.html.erb

@@ -1,4 +1,4 @@
-<%= form_tag(vehicles_path, :method => "get", id: "search-form") do %>
+<%= form_tag(vehicles_path, method: "get", id: "search-form") do %>
-  <%= text_field_tag :search, params[:search], placeholder: t(:label_search_vin), :autocomplete => "off" %>
+  <%= text_field_tag :search, params[:search], placeholder: t(:label_search_vin), autocomplete: "off" %>
   <%= submit_tag t(:label_search) %>
 <% end %>

app/views/vehicles/edit.html.erb

@@ -1,3 +1,3 @@
 <h1><%=t(:label_edit_customer_vehicle)%></h1> 
 <br/> 
-<%= render :partial => 'vehicles/form' %>
+<%= render partial: 'vehicles/form' %>

app/views/vehicles/index.html.erb

@@ -1,4 +1,4 @@
-<h2><%=t(:label_cusomer_vehicles)%> <span style="float:right"> <%= render :partial => 'vehicles/search' %> </span> </h2> 
+<h2><%=t(:label_cusomer_vehicles)%> <span style="float:right"> <%= render partial: 'vehicles/search' %> </span> </h2> 
 <br/> 
 
-<%= render :partial => 'vehicles/list', locals: {vehicles: @vehicles} %>
+<%= render partial: 'vehicles/list', locals: {vehicles: @vehicles} %>

app/views/vehicles/new.html.erb

@@ -1,3 +1,3 @@
 <h2><%=t(:label_new_vehicle)%></h2> 
 <br/> 
-<%= render :partial => 'vehicles/form' %>
+<%= render partial: 'vehicles/form' %>

app/views/vehicles/show.html.erb

@@ -1,11 +1,23 @@
 <h2><%=t(:field_vehicle)%> #<%=@vehicle.id%></h2>
 
-<%= render :partial => 'vehicles/details', locals: {vehicle: @vehicle} %>
+<%= render partial: 'vehicles/details', locals: {vehicle: @vehicle} %>
+
+<div class="splitcontent">
+    <div class="splitcontentleft">
+        <h4><%=t(:estimates)%>:</h4>
+        <%= render partial: 'estimates/list', locals: {estimates: @vehicle.estimates} %>
+    </div>
+
+    <div class="splitcontentleft">
+        <h4><%=t(:label_invoices)%>:</h4>
+        <%= render partial: 'invoices/list', locals: {invoices: @vehicle.invoices} %>
+    </div>
+</div>
 
 <h3><%=@issues.open.count%> <%=t(:label_open_issues)%></h3>
 
-<%= render :partial => 'issues/list_simple', locals: {issues: @issues.open} %>
+<%= render partial: 'issues/list_simple', locals: {issues: @issues.open} %>
 
 <h3><%=@closed_issues.count%> <%=t(:label_closed_issues)%></h3>
 
-<%= render :partial => 'issues/list_simple', locals: {issues: (@closed_issues)} %>
+<%= render partial: 'issues/list_simple', locals: {issues: (@closed_issues)} %>

config/locales/en.yml

@@ -23,4 +23,11 @@ en:
   label_edit_customer_vehicle: "Edit Customer Vehicle"
   label_cusomer_vehicles: "Customer Vehicles"
   label_new_vehicle: "New Customer Vehicle"
-  button_new_vehice: "New Vehicle"
+  button_new_vehice: "New Vehicle"
+  notice_vehicle_created: "Vehicle was successfully created."
+  notice_vehicle_updated: "Vehicle was successfully updated."
+  notice_vehicle_deleted: "Vehicle was successfully deleted."
+  alert_vehicle_not_found: "Vehicle not found."
+  alert_vehicle_not_deleted: "Vehicle could not be deleted."
+  alert_vehicle_not_created: "Vehicle could not be created."
+  alert_vehicle_not_updated: "Vehicle could not be updated."

config/routes.rb

@@ -11,7 +11,7 @@
 # Nest Vehicles under customers
 resources :customers do
   resources :vehicles
-  get :autocomplete_customer_name, :on => :collection
+  get :autocomplete_customer_name, on: :collection
 end
 
 #allow for just vehicles too

init.rb

@@ -14,10 +14,10 @@ Redmine::Plugin.register :redmine_qbo_vehicles do
   name 'Redmine QBO Vehicles plugin'
   author 'Rick Barrette'
   description 'This is a plugin for Redmine to intergrate with the redmine_qbo plugin to provide vehicle data tracking'
-  version '2026.1.1'
+  version '2026.2.0'
   url 'https://github.com/rickbarrette/redmine_qbo_vehicles'
   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
   begin
@@ -27,13 +27,13 @@ Redmine::Plugin.register :redmine_qbo_vehicles do
   end
   
   # Add safe attributes for core models
-  Issue.safe_attributes 'vehicle_id'
+  Issue.safe_attributes :vehicle_id
 
   # Permissions for security
-  permission :view_vehicles, :vehicles => :new, :public => false
+  permission :view_vehicles, vehicles: :new, public: false
 
   # Register top menu items
-  menu :top_menu, :vehicles, { :controller => :vehicles, :action => :index }, :caption => 'Vehicles', :if => Proc.new { User.current.logged? }
+  menu :top_menu, :vehicles, { controller: :vehicles, action: :index }, caption: :field_vehicles, if: Proc.new { User.current.logged? }
     
 end
 

lib/vehicles/hooks/customer_show_hook_listener.rb

@@ -13,13 +13,13 @@ module Vehicles
 
     class CustomerShowHookListener < Redmine::Hook::ViewListener
 
-    include IssuesHelper
+      include IssuesHelper
 
+      # Display vehicle information on the customer show view (right side)
       def show_customer_view_right(context={})
 
-        # Pass all prebuilt form components to our partial
         context[:controller].send(:render_to_string, { 
-          :partial => 'customers/show_hook', locals: { customer: context[:customer] } 
+          partial: 'customers/show_hook', locals: { customer: context[:customer] } 
         })
 
       end

lib/vehicles/hooks/invoice_hook_listener.rb

@@ -19,7 +19,6 @@ module Vehicles
       def process_invoice_custom_fields(context={})
         Rails.logger.info "redmine_qbo_vehicles.process_invoice_custom_fields"
         issue = context[:issue]
-        invoice = context[:invoice]
 
         # update the invoive custom fields with infomation from the issue if available
         context[:invoice].custom_fields.each do |cf|

lib/vehicles/hooks/issues_form_hook_listener.rb

@@ -13,40 +13,23 @@ module Vehicles
 
     class IssuesFormHookListener < Redmine::Hook::ViewListener
 
-    include IssuesHelper
+      include IssuesHelper
 
-      # Edit Issue Form
-      # Here we build the required form components before passing them to a partial view formatting. 
       def view_issues_form_details_bottom(context={})
-        f = context[:form]
-        issue = context[:issue]
 
-        # Check to see if the issue already belongs to a customer
+        # Load the customer's vehicles for selection in the issue form.
-        selected_vehicle = issue.vehicle.id unless issue.vehicle.nil?
-
-        # Load customer's vehicles
-        if issue.customer
-          if issue.customer.vehicles
-            vehicles = issue.customer.vehicles.pluck(:name, :id)
-          else
-            vehicles = [nil].compact
-          end
-        else
-          vehicles = [nil].compact
-        end
-
-        # Generate the drop down list of vehicles
-        vehicle = f.select :vehicle_id, vehicles, :selected => selected_vehicle, include_blank: true
-
-        # Pass all prebuilt form components to our partial
         context[:controller].send(:render_to_string, {
-          :partial => 'issues/form_hook_vehicles',
+          partial: 'issues/form_hook_vehicles',
-            locals: {
+          locals: {
-              vehicle: vehicle
+            vehicle: context[:form].select( :vehicle_id, 
-            } 
+              context[:issue].customer ? context[:issue].customer.vehicles.pluck(:name, :id) : [], 
-          })
+              selected: context[:issue].vehicle ? context[:issue].vehicle.id : nil, 
+              include_blank: true )
+          } 
+        })
+
       end
-      
+
     end
   end
 end

lib/vehicles/hooks/issues_show_hook_listener.rb

@@ -13,28 +13,15 @@ module Vehicles
 
     class IssuesShowHookListener < Redmine::Hook::ViewListener
 
-      # View Issue
+      # Display vehicle information on the issue view page.
-      # Display the quickbooks contact in the issue
       def show_issue_view_right(context={})
-        issue = context[:issue]
-        
-        begin
-          v = issue.vehicle
-          vehicle = link_to v.to_s, vehicle_path( v.id )
-          vin = v.vin 
-          notes = v.notes
-        rescue
-          #do nothing
-        end
-        
-        split_vin = vin.scan(/.{1,9}/) if vin
 
         context[:controller].send(:render_to_string, {
-          :partial => 'issues/show_issue_view_right',
+          partial: 'issues/show_issue_view_right',
             locals: {
-              vehicle: vehicle, 
+              vehicle: context[:issue].vehicle ? link_to(context[:issue].vehicle) : nil, 
-              split_vin: split_vin,
+              split_vin: context[:issue].vehicle ? context[:issue].vehicle.vin.to_s.scan(/.{1,9}/) : nil,
-              notes: notes
+              notes: context[:issue].vehicle ? context[:issue].vehicle.notes : nil
             } 
           })
       end

lib/vehicles/hooks/pdf_hook_listener.rb

@@ -15,19 +15,13 @@ module Vehicles
     class PdfHookListener < Redmine::Hook::ViewListener
 
       include IssuesHelper
-
+      
-      # Edit Issue Form
+      # Add vehicle information to the left column of the issue PDF
-      # Here we build the required form components before passing them to a partial view formatting. 
       def pdf_left(context={})
-        issue = context[:issue]
         output = []
-        v = issue.vehicle
+        output << [l(:field_vehicles), context[:issue].vehicle ? context[:issue].vehicle.to_s : nil]
-        vehicle = v ? v.to_s : nil
+        output << [l(:field_vin), context[:issue].vehicle ? context[:issue].vehicle.vin.gsub(/(.{9})/, '\1 ') : nil]
-        vin = v ? v.vin : nil
+        output << [l(:field_notes), context[:issue].vehicle ? context[:issue].vehicle.notes : nil]
-        notes = v ? v.notes : nil
-        output << [l(:field_vehicles), vehicle]
-        output << [l(:field_vin), vin ? vin.gsub(/(.{9})/, '\1 ') : nil]
-        output << [l(:field_notes), notes]
         return output
       end