16 Commits

14 changed files with 136 additions and 51 deletions

View File

@@ -1,53 +1,55 @@
# Redmine QuickBooks Online Vehicles # 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 ## 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 ## 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 ## 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_vehicles 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 bundle install
``` ```
3. **Migrate your database:** 3. **Migrate your database:**
```bash
Bash
```
bundle exec rake redmine:plugins:migrate RAILS_ENV=production 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 ## Usage
Simply add vehicles to customers via Customer Profile 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 ## License

View File

@@ -25,6 +25,7 @@ class VehiclesController < ApplicationController
begin 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 rescue ActiveRecord::RecordNotFound
flash[:error] = t :alert_vehicle_not_found
render_404 render_404
end end
end end
@@ -48,7 +49,7 @@ class VehiclesController < ApplicationController
def create def create
@vehicle = Vehicle.new(allowed_params) @vehicle = Vehicle.new(allowed_params)
if @vehicle.save if @vehicle.save
flash[:notice] = "New Vehicle Created" flash[:notice] = t :notice_vehicle_created
redirect_to @vehicle redirect_to @vehicle
else else
flash[:error] = @vehicle.errors.full_messages.to_sentence flash[:error] = @vehicle.errors.full_messages.to_sentence
@@ -63,7 +64,9 @@ class VehiclesController < ApplicationController
@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.order(id: :desc)
@closed_issues = (@issues - @issues.open) @closed_issues = (@issues - @issues.open)
flash[:error] = t :alert_no_customer if @vehicle.customer.nil?
rescue rescue
flash[:error] = t :alert_vehicle_not_found
render_404 render_404
end end
end end
@@ -74,6 +77,7 @@ class VehiclesController < ApplicationController
@vehicle = Vehicle.find_by_id(params[:id]) @vehicle = Vehicle.find_by_id(params[:id])
@customer = @vehicle.customer @customer = @vehicle.customer
rescue rescue
flash[:error] = t :alert_vehicle_not_found
render_404 render_404
end end
end end
@@ -84,7 +88,7 @@ class VehiclesController < ApplicationController
begin begin
@vehicle = Vehicle.find_by_id(params[:id]) @vehicle = Vehicle.find_by_id(params[:id])
if @vehicle.update(allowed_params) if @vehicle.update(allowed_params)
flash[:notice] = "Vehicle updated" flash[:notice] = t :notice_vehicle_updated
redirect_to @vehicle redirect_to @vehicle
else else
redirect_to edit_vehicle_path redirect_to edit_vehicle_path
@@ -92,6 +96,7 @@ class VehiclesController < ApplicationController
#show any errors anyways #show any errors anyways
flash[:error] = @vehicle.errors.full_messages.to_sentence unless @vehicle.errors.empty? flash[:error] = @vehicle.errors.full_messages.to_sentence unless @vehicle.errors.empty?
rescue rescue
flash[:error] = t :alert_vehicle_not_updated
render_404 render_404
end end
end end
@@ -100,9 +105,10 @@ class VehiclesController < ApplicationController
def destroy def destroy
begin begin
Vehicle.find_by_id(params[:id]).destroy Vehicle.find_by_id(params[:id]).destroy
flash[:notice] = "Vehicle deleted successfully" flash[:notice] = t :notice_vehicle_deleted
redirect_to action: :index redirect_to action: :index
rescue rescue
flash[:error] = t :alert_vehicle_not_deleted
render_404 render_404
end end
end end

View File

@@ -71,6 +71,16 @@ class Vehicle < ActiveRecord::Base
end end
self.name = to_s self.name = to_s
end 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 private

View File

@@ -10,9 +10,5 @@
<div class="vehicle_notes attribute"> <div class="vehicle_notes attribute">
<div class="label"><span><%=t(:field_notes)%></span>:</div> <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> </div>

View File

@@ -8,7 +8,7 @@
<tr> <tr>
<th><%= t(:field_customer)%></th> <th><%= t(:field_customer)%></th>
<td><%= link_to vehicle.customer.name, customer_path(vehicle.customer) %></td> <td><%= vehicle.customer ? link_to(vehicle.customer.name, customer_path(vehicle.customer)) : t(:no_customer) %></td>
</tr> </tr>
<tr> <tr>

View File

@@ -2,26 +2,29 @@
<% vehicles.each do |vehicle| %> <% vehicles.each do |vehicle| %>
<div class="row"> <div class="row">
<div>
<b><%= link_to "##{vehicle.id}", vehicle_path(vehicle) %> </b> <div class="container">
</div>
<%= check_box_tag "vehicle_ids[]", vehicle.id, false, onchange: "updateLink()", data: { url: vehicle_path(vehicle).html_safe, text: vehicle.to_s }, class: "appointment checkbox" %>
<div class='label-main'>
<%= link_to vehicle.to_s, vehicle_path(vehicle) %>
</div>
<div class="label-sub">
<%= vehicle.vin.scan(/.{1,9}/)[0] if vehicle.vin %><b><%=vehicle.vin.scan(/.{1,9}/)[1] if vehicle.vin%></b>
</div>
<div>
<%= vehicle.to_s %>
<br/>
<%= vehicle.customer %>
<br/>
<%= vehicle.vin.scan(/.{1,9}/)[0] if vehicle.vin %><b><%=vehicle.vin.scan(/.{1,9}/)[1] if vehicle.vin%></b>
</div> </div>
<br/>
</div> </div>
<br/>
<% end %> <% end %>
<div class="actions"> <div class="actions">
<%= will_paginate vehicles %> <%= will_paginate vehicles %>
</div> </div>
<p><%=t(:label_matching)%> <%=vehicles.count%> <%=t(:field_vehicles) %> </p> <%=t(:label_matching)%> <%=vehicles.count%> <%=t(:field_vehicles) %>
<% else %> <% else %>
<p><%=t(:label_no_vehicles)%> <%= params[:search] %>.</p> <p><%=t(:label_no_vehicles)%> <%= params[:search] %>.</p>

View File

@@ -2,6 +2,18 @@
<%= 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> <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} %>

View File

View File

@@ -0,0 +1,23 @@
.container {
display: grid;
/* Column 1 for checkbox, Column 2 for text */
grid-template-columns: auto 1fr;
/* Row 1 for 'Vehicle', Row 2 for 'VIN' */
grid-template-rows: auto auto;
align-items: center;
gap: 0 10px; /* Adjust spacing between checkbox and text */
}
.checkbox {
/* This makes the checkbox take up both rows */
grid-row: span 2;
}
.label-main {
font-weight: bold;
}
.label-sub {
font-size: 0.85em;
color: #666;
}

View File

@@ -23,4 +23,14 @@ en:
label_edit_customer_vehicle: "Edit Customer Vehicle" label_edit_customer_vehicle: "Edit Customer Vehicle"
label_cusomer_vehicles: "Customer Vehicles" label_cusomer_vehicles: "Customer Vehicles"
label_new_vehicle: "New Customer Vehicle" 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."
no_customer: "Customer no longer exists"
alert_no_customer: "Customer no longer exists, check for merged customers or deleted customers in Quick Books Online."

View File

@@ -14,7 +14,7 @@ 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.1.5' version '2026.2.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'

View File

@@ -0,0 +1,23 @@
#The MIT License (MIT)
#
#Copyright (c) 2016 - 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 Vehicles
module Hooks
class ViewHookListener < Redmine::Hook::ViewListener
def view_layouts_base_html_head(context = {})
safe_join([
stylesheet_link_tag('style', plugin: :redmine_qbo_vehicles, media: :all)
])
end
end
end
end