webtranslateit-payday 1.7.2 → 1.7.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 59ef0d55e5bb70dab72d78727e46907e75b49c959346f3d6f9282c5ddde202df
-  data.tar.gz: 221ddccb98e0ee6c239c770261b67f2e98d73a29f4862bda59eaed686cc88133
+  metadata.gz: 79e897436dac18ec0146ca7c556d2a1fd9a614fdc78b3b2fe4da6cff769184a5
+  data.tar.gz: 77f740456d34e88037867ca6890110bb39014073d476fedffed124fd698a844f
 SHA512:
-  metadata.gz: 01a66a64216ead7641340f677b324e705459812759864043e02e48bc542fa71b02a76048c9981b5b64e2f7f3e592e525bb5a9080bc84d5046ab8ffdb67d87538
-  data.tar.gz: 0b3c6eba860fb22dadae435310aed5d4d0a74812e27db53d6fe6580d3162f05ee7f017e487ff254e27fc67f233229feda3f77ecf0733f0cd2b5a7ec73b37640a
+  metadata.gz: 3253e3a0d51b8125df8fb0ee6341c18c320af4dbec9361376437082fc101b7552f8d25619f6d5ab79f914a2745c9a25a8952acce2a7cdeddbc71feeb7032afdf
+  data.tar.gz: 6af84ba49bb0171f4c969a13707b743e400694e897bdbf27ce494b2e1d18b7570ccee60da7c90789941c5e1669e82bde3d40b44b6088c772b3064aa30dd1bd91

data/CHANGELOG.md

@@ -1,5 +1,9 @@
 # CHANGELOG
 
+## 1.7.3 (2026-02-16)
+
+* Add retention support (e.g. Spanish IRPF). Set `retention_rate` on an invoice to apply a post-tax deduction calculated as a percentage of the subtotal. The retention amount is displayed as a negative line in the PDF and subtracted from the total. Customize the label with `retention_description` or via the `payday.invoice.retention` i18n key.
+
 ## 1.7.1 (2025-12-01)
 
 * Relax dependency on rqrcode.

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    webtranslateit-payday (1.7.2)
+    webtranslateit-payday (1.7.3)
       activesupport (>= 7, < 9)
       i18n (~> 1.12, < 2)
       money (>= 6.16, < 8.0)
@@ -34,24 +34,24 @@ GEM
     bigdecimal (3.3.1)
     chunky_png (1.4.0)
     coderay (1.1.3)
-    concurrent-ruby (1.3.5)
+    concurrent-ruby (1.3.6)
     connection_pool (2.5.4)
     css_parser (1.21.1)
       addressable
     diff-lcs (1.6.2)
     drb (2.2.3)
-    ffi (1.17.1-arm64-darwin)
-    ffi (1.17.1-x86_64-darwin)
-    ffi (1.17.1-x86_64-linux-gnu)
-    formatador (1.1.0)
-    guard (2.19.1)
+    ffi (1.17.3-arm64-darwin)
+    ffi (1.17.3-x86_64-darwin)
+    ffi (1.17.3-x86_64-linux-gnu)
+    formatador (1.2.3)
+      reline
+    guard (2.20.1)
       formatador (>= 0.2.4)
       listen (>= 2.7, < 4.0)
       logger (~> 1.6)
       lumberjack (>= 1.0.12, < 2.0)
       nenv (~> 0.1)
       notiffany (~> 0.0)
-      ostruct (~> 0.6)
       pry (>= 0.13.0)
       shellany (~> 0.0)
       thor (>= 0.18.1)
@@ -63,29 +63,30 @@ GEM
     guard-rubocop (1.5.0)
       guard (~> 2.0)
       rubocop (< 2.0)
-    i18n (1.14.7)
+    i18n (1.14.8)
       concurrent-ruby (~> 1.0)
-    json (2.16.0)
+    io-console (0.8.2)
+    json (2.18.1)
     language_server-protocol (3.17.0.5)
     lint_roller (1.1.0)
-    listen (3.9.0)
+    listen (3.10.0)
+      logger
       rb-fsevent (~> 0.10, >= 0.10.3)
       rb-inotify (~> 0.9, >= 0.9.10)
     logger (1.7.0)
-    lumberjack (1.2.10)
+    lumberjack (1.4.2)
     matrix (0.4.3)
     method_source (1.1.0)
     minitest (5.26.0)
-    money (7.0.0)
+    money (7.0.2)
       bigdecimal
       i18n (~> 1.9)
     nenv (0.3.0)
     notiffany (0.1.3)
       nenv (~> 0.1)
       shellany (~> 0.0)
-    ostruct (0.6.1)
     parallel (1.27.0)
-    parser (3.3.10.0)
+    parser (3.3.10.1)
       ast (~> 2.4.1)
       racc
     pdf-core (0.10.0)
@@ -100,10 +101,11 @@ GEM
       rexml (>= 3.4.2, < 4)
     prawn-table (0.2.2)
       prawn (>= 1.3.0, < 3.0.0)
-    prism (1.6.0)
-    pry (0.15.2)
+    prism (1.9.0)
+    pry (0.16.0)
       coderay (~> 1.1)
       method_source (~> 1.0)
+      reline (>= 0.6.0)
     public_suffix (6.0.2)
     racc (1.8.1)
     rainbow (3.1.1)
@@ -111,6 +113,8 @@ GEM
     rb-inotify (0.11.1)
       ffi (~> 1.0)
     regexp_parser (2.11.3)
+    reline (0.6.3)
+      io-console (~> 0.5)
     rexml (3.4.4)
     rqrcode (3.1.1)
       chunky_png (~> 1.0)
@@ -129,7 +133,7 @@ GEM
       diff-lcs (>= 1.2.0, < 2.0)
       rspec-support (~> 3.13.0)
     rspec-support (3.13.6)
-    rubocop (1.81.7)
+    rubocop (1.84.2)
       json (~> 2.3)
       language_server-protocol (~> 3.17.0.2)
       lint_roller (~> 1.1.0)
@@ -137,30 +141,30 @@ GEM
       parser (>= 3.3.0.2)
       rainbow (>= 2.2.2, < 4.0)
       regexp_parser (>= 2.9.3, < 3.0)
-      rubocop-ast (>= 1.47.1, < 2.0)
+      rubocop-ast (>= 1.49.0, < 2.0)
       ruby-progressbar (~> 1.7)
       unicode-display_width (>= 2.4.0, < 4.0)
-    rubocop-ast (1.48.0)
+    rubocop-ast (1.49.0)
       parser (>= 3.3.7.2)
-      prism (~> 1.4)
+      prism (~> 1.7)
     rubocop-performance (1.26.1)
       lint_roller (~> 1.1)
       rubocop (>= 1.75.0, < 2.0)
       rubocop-ast (>= 1.47.1, < 2.0)
-    rubocop-rspec (3.8.0)
+    rubocop-rspec (3.9.0)
       lint_roller (~> 1.1)
       rubocop (~> 1.81)
     ruby-progressbar (1.13.0)
     securerandom (0.4.1)
     shellany (0.0.1)
-    thor (1.3.2)
+    thor (1.5.0)
     ttfunk (1.8.0)
       bigdecimal (~> 3.1)
     tzinfo (2.0.6)
       concurrent-ruby (~> 1.0)
     unicode-display_width (3.2.0)
       unicode-emoji (~> 4.1)
-    unicode-emoji (4.1.0)
+    unicode-emoji (4.2.0)
     zeitwerk (2.7.1)
 
 PLATFORMS
@@ -168,6 +172,7 @@ PLATFORMS
   arm64-darwin-22
   arm64-darwin-23
   arm64-darwin-24
+  arm64-darwin-25
   x86_64-darwin-21
   x86_64-linux
 

data/config/locales/payday.de.yml

@@ -14,6 +14,7 @@ de:
       subtotal: "Zwischensumme:"
       shipping: "Versand:"
       tax: "Steuern:"
+      retention: "Einbehaltung:"
       total: "Gesamt:"
       notes: "Anmerkungen"
     line_item:

data/config/locales/payday.en.yml

@@ -14,6 +14,7 @@ en:
       subtotal: "Subtotal:"
       shipping: "Shipping:"
       tax: "Tax:"
+      retention: "Retention:"
       total: "Total:"
       notes: "Notes:"
     line_item:

data/config/locales/payday.es.yml

@@ -14,6 +14,7 @@ es:
       subtotal: "Subtotal:"
       shipping: "Envío:"
       tax: "Impuesto:"
+      retention: "Retención IRPF:"
       total: "Total:"
       notes: "Notas:"
     line_item:

data/config/locales/payday.fr.yml

@@ -14,6 +14,7 @@ fr:
       subtotal: "Sous-total :"
       shipping: "Livraison :"
       tax: "Taxes :"
+      retention: "Retenue :"
       total: "Total :"
       notes: "Notes :"
     line_item:

data/config/locales/payday.nl.yml

@@ -13,6 +13,7 @@ nl:
       subtotal: "Subtotaal:"
       shipping: "Levering:"
       tax: "Btw:"
+      retention: "Inhouding:"
       total: "Totaal:"
       notes: "Opmerkingen"
     line_item:

data/config/locales/payday.zh-CN.yml

@@ -12,6 +12,7 @@ zh-CN:
       subtotal: "小计:"
       shipping: "邮费:"
       tax: "税费:"
+      retention: "扣缴:"
       total: "总计:"
       notes: "备注"
     line_item:

data/lib/generators/payday/setup/templates/migration.rb

@@ -4,6 +4,9 @@ class CreatePaydayTables < ActiveRecord::Migration
       # invoices will work without anything but bill_to, but there are quite a few options for the fields you can save, like ship_to
       # due_at, refunded_at, and paid_at
       t.string :bill_to
+      t.decimal :tax_rate
+      t.decimal :shipping_rate
+      t.decimal :retention_rate
 
       t.timestamps
     end

data/lib/payday/invoice.rb

@@ -8,10 +8,10 @@ module Payday
     include Payday::Invoiceable
 
     attr_accessor :invoice_number, :bill_to, :ship_to, :notes, :line_items, :shipping_description,
-                  :tax_description, :due_at, :paid_at, :refunded_at, :currency, :invoice_details, :invoice_date,
-                  :qr_code
+                  :tax_description, :retention_description, :due_at, :paid_at, :refunded_at, :currency,
+                  :invoice_details, :invoice_date, :qr_code
 
-    attr_reader :tax_rate, :shipping_rate
+    attr_reader :tax_rate, :shipping_rate, :retention_rate
 
     # rubocop:todo Metrics/PerceivedComplexity
     # rubocop:todo Metrics/MethodLength
@@ -26,6 +26,8 @@ module Payday
       self.shipping_description = options[:shipping_description] || nil
       self.tax_rate = options[:tax_rate] || nil
       self.tax_description = options[:tax_description] || nil
+      self.retention_rate = options[:retention_rate] || nil
+      self.retention_description = options[:retention_description] || nil
       self.due_at = options[:due_at] || nil
       self.paid_at = options[:paid_at] || nil
       self.refunded_at = options[:refunded_at] || nil
@@ -50,6 +52,12 @@ module Payday
       @shipping_rate = BigDecimal(value.to_s)
     end
 
+    # Retention rate (e.g. IRPF). Applied as a percentage of the subtotal and deducted from the total.
+    def retention_rate=(value)
+      value = 0 if value.to_s.blank?
+      @retention_rate = BigDecimal(value.to_s)
+    end
+
     # Adds a line item
     def add_line_item(options = {})
       line_items << Payday::LineItem.new(options)

data/lib/payday/invoiceable.rb

@@ -49,9 +49,19 @@ module Payday
       end
     end
 
+    # Calculates the retention (e.g. IRPF) as a percentage of the subtotal.
+    # This is a post-tax deduction subtracted from the total.
+    def retention
+      if defined?(retention_rate)
+        subtotal * retention_rate / 100
+      else
+        0
+      end
+    end
+
     # Calculates the total for this invoice.
     def total
-      subtotal + tax + shipping
+      subtotal + tax + shipping - retention
     end
 
     def overdue?

data/lib/payday/pdf_renderer.rb

@@ -223,8 +223,9 @@ module Payday
     end
     # rubocop:enable Metrics/MethodLength
 
+    # rubocop:todo Metrics/PerceivedComplexity
     # rubocop:todo Metrics/MethodLength
-    def self.totals_lines(invoice, pdf) # rubocop:todo Metrics/AbcSize, Metrics/MethodLength
+    def self.totals_lines(invoice, pdf) # rubocop:todo Metrics/AbcSize, Metrics/MethodLength, Metrics/PerceivedComplexity
       table_data = []
       table_data << [
         bold_cell(pdf, I18n.t('payday.invoice.subtotal', default: 'Subtotal:')),
@@ -255,6 +256,21 @@ module Payday
                align: :right)
         ]
       end
+
+      if invoice.retention_rate.positive?
+        retention_description = if invoice.retention_description.nil?
+          I18n.t('payday.invoice.retention', default: 'Retention:')
+        else
+          invoice.retention_description
+        end
+
+        table_data << [
+          bold_cell(pdf, retention_description),
+          cell(pdf, number_to_currency(-invoice.retention, invoice),
+               align: :right)
+        ]
+      end
+
       table_data << [
         bold_cell(pdf, I18n.t('payday.invoice.total', default: 'Total:'),
                   size: 12),
@@ -268,6 +284,7 @@ module Payday
       end
     end
     # rubocop:enable Metrics/MethodLength
+    # rubocop:enable Metrics/PerceivedComplexity
 
     def self.notes(invoice, pdf) # rubocop:todo Metrics/AbcSize, Metrics/MethodLength
       return unless defined?(invoice.notes) && invoice.notes

data/payday.gemspec

@@ -2,7 +2,7 @@
 
 Gem::Specification.new do |s|
   s.name        = 'webtranslateit-payday'
-  s.version     = '1.7.2'
+  s.version     = '1.7.3'
   s.required_ruby_version = '>= 3.1'
   s.platform    = Gem::Platform::RUBY
   s.authors     = ['Alan Johnson', 'Edouard Briere']

data/spec/invoice_spec.rb

@@ -75,6 +75,41 @@ module Payday # rubocop:todo Metrics/ModuleLength
       expect(i.total).to eq(BigDecimal(1243))
     end
 
+    it 'returns zero retention when no retention_rate is set' do
+      i = described_class.new
+      i.line_items << LineItem.new(price: 100, quantity: 1, description: 'Service')
+
+      expect(i.retention).to eq(BigDecimal(0))
+    end
+
+    it 'calculates retention correctly as a percentage of the subtotal' do
+      i = described_class.new(retention_rate: 15.0)
+      i.line_items << LineItem.new(price: 200, quantity: 5, description: 'Service')
+
+      expect(i.retention).to eq(BigDecimal(150))
+    end
+
+    # rubocop:todo RSpec/MultipleExpectations
+    it 'calculates total with retention deducted (IRPF example: 500 + 21% VAT - 19% IRPF = 510)' do # rubocop:todo RSpec/ExampleLength, RSpec/MultipleExpectations
+      # rubocop:enable RSpec/MultipleExpectations
+      i = described_class.new(tax_rate: 21.0, retention_rate: 19.0)
+      i.line_items << LineItem.new(price: 500, quantity: 1, description: 'Consulting')
+
+      expect(i.subtotal).to eq(BigDecimal(500))
+      expect(i.tax).to eq(BigDecimal(105))
+      expect(i.retention).to eq(BigDecimal(95))
+      expect(i.total).to eq(BigDecimal(510))
+    end
+
+    it 'calculates total with tax, shipping, and retention combined' do
+      i = described_class.new(tax_rate: 10.0, shipping_rate: 20, retention_rate: 5.0)
+      i.line_items << LineItem.new(price: 100, quantity: 10, description: 'Widgets')
+
+      # subtotal: 1000, tax: 100, shipping: 20, retention: 50
+      # total: 1000 + 100 + 20 - 50 = 1070
+      expect(i.total).to eq(BigDecimal(1070))
+    end
+
     it "is overdue when it's past date and unpaid" do
       i = described_class.new(due_at: Date.today - 1)
       expect(i.overdue?).to be(true)

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: webtranslateit-payday
 version: !ruby/object:Gem::Version
-  version: 1.7.2
+  version: 1.7.3
 platform: ruby
 authors:
 - Alan Johnson