mirror of
https://github.com/rickbarrette/redmine_qbo_lineitems.git
synced 2026-04-02 15:11:58 -04:00
Compare commits
10 Commits
| Author | SHA1 | Date | |
|---|---|---|---|
| 50a02cc497 | |||
| b63e8f2a45 | |||
| 4b561ef4e3 | |||
| 1dadcf37b6 | |||
| ffaee10fef | |||
| 58994e3c7d | |||
| 6365fe6679 | |||
| 4d6c16373a | |||
| 20b7564c38 | |||
| 9820646857 |
13
README.md
13
README.md
@@ -10,8 +10,6 @@ This plugin allows **billable line items** to be attached to a Redmine issue. Wh
|
|||||||
|
|
||||||
* **Redmine:** 6.1+
|
* **Redmine:** 6.1+
|
||||||
|
|
||||||
* **Ruby:** 3.2+
|
|
||||||
|
|
||||||
* **Parent Plugin:** [Redmine QuickBooks Online](https://github.com/rickbarrette/redmine_qbo) (must be installed and configured)
|
* **Parent Plugin:** [Redmine QuickBooks Online](https://github.com/rickbarrette/redmine_qbo) (must be installed and configured)
|
||||||
|
|
||||||
|
|
||||||
@@ -19,9 +17,9 @@ This plugin allows **billable line items** to be attached to a Redmine issue. Wh
|
|||||||
|
|
||||||
## Compatibility
|
## Compatibility
|
||||||
|
|
||||||
| Plugin Version | Redmine Version | Ruby Version |
|
| Plugin Version | Redmine Version | Parent Plugin Version |
|
||||||
| --- | --- | --- |
|
| --- | --- | --- |
|
||||||
| 2026.3.6+ | 6.1.x | 3.2+ |
|
| 2026.3.8+ | 6.1.x | 2026.3.9+ |
|
||||||
|
|
||||||
---
|
---
|
||||||
|
|
||||||
@@ -87,9 +85,10 @@ Before using this plugin:
|
|||||||
1. Install and configure the parent plugin.
|
1. Install and configure the parent plugin.
|
||||||
|
|
||||||
2. Ensure your **QuickBooks Online** company file is connected.
|
2. Ensure your **QuickBooks Online** company file is connected.
|
||||||
|
|
||||||
3. Verify that the products or services referenced in line items exist in QuickBooks.
|
3. Sync Accounts & Items via plugin settings
|
||||||
|
|
||||||
|
4. Set default income account for new items via plugin settings
|
||||||
|
|
||||||
---
|
---
|
||||||
|
|
||||||
|
|||||||
BIN
Screenshots/accounts.png
Normal file
BIN
Screenshots/accounts.png
Normal file
Binary file not shown.
|
After Width: | Height: | Size: 287 KiB |
BIN
Screenshots/edit item.png
Normal file
BIN
Screenshots/edit item.png
Normal file
Binary file not shown.
|
After Width: | Height: | Size: 170 KiB |
BIN
Screenshots/item.png
Normal file
BIN
Screenshots/item.png
Normal file
Binary file not shown.
|
After Width: | Height: | Size: 162 KiB |
BIN
Screenshots/items.png
Normal file
BIN
Screenshots/items.png
Normal file
Binary file not shown.
|
After Width: | Height: | Size: 368 KiB |
BIN
Screenshots/settings.png
Normal file
BIN
Screenshots/settings.png
Normal file
Binary file not shown.
|
After Width: | Height: | Size: 166 KiB |
@@ -15,7 +15,10 @@
|
|||||||
</p>
|
</p>
|
||||||
|
|
||||||
<p>
|
<p>
|
||||||
<%= f.number_field :unit_price, step: 0.01, size: 10 %>
|
<%= f.text_field :unit_price,
|
||||||
|
class: "price-field",
|
||||||
|
inputmode: "decimal",
|
||||||
|
autocomplete: "off"%>
|
||||||
</p>
|
</p>
|
||||||
|
|
||||||
<p>
|
<p>
|
||||||
|
|||||||
@@ -1,3 +1,9 @@
|
|||||||
|
let lastKeyWasTab = false;
|
||||||
|
|
||||||
|
document.addEventListener("keydown", function (e) {
|
||||||
|
lastKeyWasTab = (e.key === "Tab");
|
||||||
|
});
|
||||||
|
|
||||||
(function () {
|
(function () {
|
||||||
function initNestedForms() {
|
function initNestedForms() {
|
||||||
document.querySelectorAll("[data-nested-form]").forEach(function (wrapper) {
|
document.querySelectorAll("[data-nested-form]").forEach(function (wrapper) {
|
||||||
@@ -22,11 +28,28 @@
|
|||||||
Date.now().toString()
|
Date.now().toString()
|
||||||
);
|
);
|
||||||
|
|
||||||
//container.insertAdjacentHTML("beforeend", content);
|
|
||||||
container.insertAdjacentHTML("beforeend", content);
|
container.insertAdjacentHTML("beforeend", content);
|
||||||
|
|
||||||
// initialize autocomplete on the new row
|
const newRow = container.lastElementChild;
|
||||||
initLineItemAutocomplete(container.lastElementChild);
|
|
||||||
|
// Ensure clean state
|
||||||
|
newRow.dataset.autoAdded = "false";
|
||||||
|
|
||||||
|
// Reset defaults
|
||||||
|
const qty = newRow.querySelector(".qty-field");
|
||||||
|
if (qty && !qty.value) qty.value = 1;
|
||||||
|
|
||||||
|
const price = newRow.querySelector(".price-field");
|
||||||
|
if (price) price.value = "";
|
||||||
|
|
||||||
|
// initialize autocomplete
|
||||||
|
initLineItemAutocomplete(newRow);
|
||||||
|
|
||||||
|
// Only focus if NOT tabbing
|
||||||
|
if (!lastKeyWasTab) {
|
||||||
|
const desc = newRow.querySelector(".line-item-description");
|
||||||
|
if (desc) desc.focus();
|
||||||
|
}
|
||||||
}
|
}
|
||||||
|
|
||||||
// REMOVE
|
// REMOVE
|
||||||
@@ -56,9 +79,77 @@
|
|||||||
document.addEventListener("turbo:load", initNestedForms);
|
document.addEventListener("turbo:load", initNestedForms);
|
||||||
})();
|
})();
|
||||||
|
|
||||||
$(document).on("input", ".line-item-description", function(){
|
|
||||||
|
|
||||||
|
// Keep your existing behavior
|
||||||
|
$(document).on("input", ".line-item-description", function () {
|
||||||
let row = $(this).closest(".line-item");
|
let row = $(this).closest(".line-item");
|
||||||
row.find(".item-id-field").val("");
|
row.find(".item-id-field").val("");
|
||||||
|
});
|
||||||
|
|
||||||
});
|
|
||||||
|
// -------------------------------
|
||||||
|
// AUTO-ADD NEW ROW LOGIC
|
||||||
|
// -------------------------------
|
||||||
|
|
||||||
|
// Reset autoAdded flag if cleared
|
||||||
|
document.addEventListener("input", function (e) {
|
||||||
|
if (!e.target.classList.contains("line-item-description")) return;
|
||||||
|
|
||||||
|
const row = e.target.closest(".line-item");
|
||||||
|
if (!row) return;
|
||||||
|
|
||||||
|
if (e.target.value.trim() === "") {
|
||||||
|
row.dataset.autoAdded = "false";
|
||||||
|
}
|
||||||
|
});
|
||||||
|
|
||||||
|
|
||||||
|
// Add row when leaving last description (without breaking TAB flow)
|
||||||
|
document.addEventListener("blur", function (e) {
|
||||||
|
if (!e.target.classList.contains("line-item-description")) return;
|
||||||
|
|
||||||
|
const input = e.target;
|
||||||
|
const row = input.closest(".line-item");
|
||||||
|
if (!row) return;
|
||||||
|
|
||||||
|
const wrapper = input.closest("[data-nested-form]");
|
||||||
|
if (!wrapper) return;
|
||||||
|
|
||||||
|
const container = wrapper.querySelector("[data-nested-form-container]");
|
||||||
|
if (!container) return;
|
||||||
|
|
||||||
|
// Active (visible + not destroyed) rows only
|
||||||
|
const rows = Array.from(
|
||||||
|
container.querySelectorAll(wrapper.dataset.wrapperSelector)
|
||||||
|
).filter(r => {
|
||||||
|
const destroy = r.querySelector("input[name*='[_destroy]']");
|
||||||
|
const hidden = window.getComputedStyle(r).display === "none";
|
||||||
|
return !(destroy && destroy.value === "1") && !hidden;
|
||||||
|
});
|
||||||
|
|
||||||
|
const lastRow = rows[rows.length - 1];
|
||||||
|
|
||||||
|
// Only last row
|
||||||
|
if (row !== lastRow) return;
|
||||||
|
|
||||||
|
// Must have content
|
||||||
|
if (input.value.trim() === "") return;
|
||||||
|
|
||||||
|
// Prevent duplicate firing
|
||||||
|
if (row.dataset.autoAdded === "true") return;
|
||||||
|
|
||||||
|
// If TAB, ensure user is leaving the row entirely
|
||||||
|
if (lastKeyWasTab) {
|
||||||
|
const next = document.activeElement;
|
||||||
|
|
||||||
|
if (row.contains(next)) {
|
||||||
|
return; // still inside row → allow normal tabbing
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
row.dataset.autoAdded = "true";
|
||||||
|
|
||||||
|
const addButton = wrapper.querySelector("[data-nested-form-add]");
|
||||||
|
if (addButton) addButton.click();
|
||||||
|
|
||||||
|
}, true); // capture phase required for blur
|
||||||
16
init.rb
16
init.rb
@@ -14,7 +14,7 @@ Redmine::Plugin.register :redmine_qbo_lineitems do
|
|||||||
name 'Redmine QBO Line Items plugin'
|
name 'Redmine QBO Line Items plugin'
|
||||||
author 'Rick Barrette'
|
author 'Rick Barrette'
|
||||||
description 'A plugin for Redmine to extend the capabilitys of the Redmine QuickBooks Online plugin to attach billable line items to an isuue'
|
description 'A plugin for Redmine to extend the capabilitys of the Redmine QuickBooks Online plugin to attach billable line items to an isuue'
|
||||||
version '2026.3.10'
|
version '2026.3.12'
|
||||||
url 'https://github.com/rickbarrette/redmine_qbo_lineitems'
|
url 'https://github.com/rickbarrette/redmine_qbo_lineitems'
|
||||||
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'
|
||||||
@@ -31,10 +31,12 @@ Redmine::Plugin.register :redmine_qbo_lineitems do
|
|||||||
Issue.safe_attributes :line_items_attributes
|
Issue.safe_attributes :line_items_attributes
|
||||||
end
|
end
|
||||||
|
|
||||||
# Dynamically load all Hooks & Patches recursively
|
# Administration menu extension
|
||||||
base_dir = File.join(File.dirname(__FILE__), 'lib')
|
Redmine::MenuManager.map :admin_menu do |menu|
|
||||||
|
menu.push :redmine_qbo_lineitems, { controller: 'items', action: 'index' },
|
||||||
|
icon: 'list',
|
||||||
|
caption: :label_items,
|
||||||
|
html: { class: 'icon icon-list' }
|
||||||
|
end
|
||||||
|
|
||||||
# '**' looks inside subdirectories, '*.rb' matches Ruby files
|
RedmineQboLineItems.setup
|
||||||
Dir.glob(File.join(base_dir, '**', '*.rb')).sort.each do |file|
|
|
||||||
require file
|
|
||||||
end
|
|
||||||
@@ -8,10 +8,10 @@
|
|||||||
#
|
#
|
||||||
#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.
|
||||||
|
|
||||||
module RedmineQboLineItems
|
module LineItems
|
||||||
module Hooks
|
module Hooks
|
||||||
|
|
||||||
class IssuesSaveHookListener < Redmine::Hook::ViewListener
|
class IssuesSaveHookListener < Redmine::Hook::Listener
|
||||||
|
|
||||||
# Called After Issue Saved
|
# Called After Issue Saved
|
||||||
def controller_issues_edit_after_save(context={})
|
def controller_issues_edit_after_save(context={})
|
||||||
@@ -8,10 +8,10 @@
|
|||||||
#
|
#
|
||||||
#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.
|
||||||
|
|
||||||
module RedmineQboLineItems
|
module LineItems
|
||||||
module Hooks
|
module Hooks
|
||||||
|
|
||||||
class QboHookListener < Redmine::Hook::ViewListener
|
class QboHookListener < Redmine::Hook::Listener
|
||||||
|
|
||||||
# Called by WebhookProcessJob
|
# Called by WebhookProcessJob
|
||||||
def qbo_additional_entities(context={})
|
def qbo_additional_entities(context={})
|
||||||
@@ -8,7 +8,7 @@
|
|||||||
#
|
#
|
||||||
#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.
|
||||||
|
|
||||||
module RedmineQboLineItems
|
module LineItems
|
||||||
module Hooks
|
module Hooks
|
||||||
|
|
||||||
class ViewHookListener < Redmine::Hook::ViewListener
|
class ViewHookListener < Redmine::Hook::ViewListener
|
||||||
@@ -25,6 +25,7 @@ module RedmineQboLineItems
|
|||||||
end
|
end
|
||||||
|
|
||||||
def view_issues_edit_notes_bottom(context = {})
|
def view_issues_edit_notes_bottom(context = {})
|
||||||
|
return if context[:issue].closed?
|
||||||
context[:controller].send(:render_to_string, {
|
context[:controller].send(:render_to_string, {
|
||||||
partial: 'line_items/issue_form',
|
partial: 'line_items/issue_form',
|
||||||
locals: {
|
locals: {
|
||||||
@@ -8,35 +8,17 @@
|
|||||||
#
|
#
|
||||||
#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 LineItems
|
||||||
|
|
||||||
module RedmineQboLineItems
|
|
||||||
module Patches
|
module Patches
|
||||||
module IssuePatch
|
module IssuePatch
|
||||||
|
extend ActiveSupport::Concern
|
||||||
def self.included(base)
|
|
||||||
base.extend(ClassMethods)
|
prepended do
|
||||||
base.send(:include, InstanceMethods)
|
has_many :line_items, dependent: :destroy
|
||||||
|
accepts_nested_attributes_for :line_items,
|
||||||
base.class_eval do
|
allow_destroy: true,
|
||||||
has_many :line_items, dependent: :destroy
|
reject_if: proc { |attrs| attrs['description'].blank? }
|
||||||
accepts_nested_attributes_for :line_items,
|
|
||||||
allow_destroy: true,
|
|
||||||
reject_if: proc { |attrs| attrs['description'].blank? }
|
|
||||||
end
|
|
||||||
|
|
||||||
end
|
end
|
||||||
|
|
||||||
module ClassMethods
|
|
||||||
|
|
||||||
end
|
|
||||||
|
|
||||||
module InstanceMethods
|
|
||||||
|
|
||||||
end
|
|
||||||
|
|
||||||
end
|
end
|
||||||
|
|
||||||
Issue.send(:include, IssuePatch)
|
|
||||||
end
|
end
|
||||||
end
|
end
|
||||||
21
lib/redmine_qbo_line_items.rb
Normal file
21
lib/redmine_qbo_line_items.rb
Normal file
@@ -0,0 +1,21 @@
|
|||||||
|
#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 RedmineQboLineItems
|
||||||
|
|
||||||
|
def self.setup
|
||||||
|
unless Issue.ancestors.include?(LineItems::Patches::IssuePatch)
|
||||||
|
Issue.prepend LineItems::Patches::IssuePatch
|
||||||
|
LineItems::Hooks::IssuesSaveHookListener
|
||||||
|
LineItems::Hooks::QboHookListener
|
||||||
|
LineItems::Hooks::ViewHookListener
|
||||||
|
end
|
||||||
|
end
|
||||||
|
end
|
||||||
Reference in New Issue
Block a user