webtranslateit-payday 1.6.8 → 1.7.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: b812ea02b7fa7c76c70b6467fac03cf73a611c4bfed8cf534357005ce6ab0ff3
-  data.tar.gz: '08444bff417aa25933eda527ccc31e0d27930a1512af5672d5b1520a8c2155b0'
+  metadata.gz: 288b40a42302084745d843de21dc11073b847efa4a32d03d4a4630c787f5d7fc
+  data.tar.gz: c01691b9167248808eaa803d57de94ba689b475af09bceaac6c4f5984eef0653
 SHA512:
-  metadata.gz: aeb03ec55592f4d1a1ea03ce387cd6b73b61fb9bc8c9a94234ab1a4666cd2047928e1bc6898c2598f2e1c8f045639cfd80b06ca8004a9734894f9cf0cbeee2a2
-  data.tar.gz: '0186c331eba8bb10753f7614a9ea541ada3d631ea9d2e0206b5e5a0e08be8350c8f1070d12f263426258cd20fe9950b718d923fd6103f715334b9281cd1429d6'
+  metadata.gz: 1719b034bf1a3555af1e00b074db6dab87118c77b7533356c1a7db22ae35b41ee7b4617d7f5455c0bad26695ee83d968aac3f0ab223a39c74d257d1ca314c28c
+  data.tar.gz: 984d41537f2a71ef74c700b89b7a075cb3eb6828c991668038c09ab12787b68fc5c1c7fab0944b60236692b30636dacb19fb1301e8e4f4a21a1e87e2385610fa

data/.github/workflows/ci.yml

@@ -14,10 +14,10 @@ jobs:
     runs-on: ubuntu-latest
     strategy:
       matrix:
-        ruby-version: ['3.1', '3.2', '3.3', '3.4']
+        ruby-version: ['3.2', '3.3', '3.4']
 
     steps:
-    - uses: actions/checkout@v4
+    - uses: actions/checkout@v6
     - name: Set up Ruby
     # To automatically get bug fixes and new Ruby versions for ruby/setup-ruby,
     # change this to (see https://github.com/ruby/setup-ruby#versioning):
@@ -30,12 +30,12 @@ jobs:
 
   linters:
     name: Linters
-    runs-on: ubuntu-20.04
+    runs-on: ubuntu-latest
     timeout-minutes: 10
 
     steps:
       - name: Checkout repository
-        uses: actions/checkout@v4
+        uses: actions/checkout@v6
 
       - name: Install ruby and gems
         uses: ruby/setup-ruby@v1

data/.rubocop.yml

@@ -1,4 +1,4 @@
-require:
+plugins:
   - rubocop-performance
   - rubocop-rspec
 

data/CHANGELOG.md

@@ -1,5 +1,13 @@
 # CHANGELOG
 
+## 1.7.0 (2025-11-25)
+
+* Add QR code support.
+
+## 1.6.9 (2025-01-28)
+
+* Bump dependencies.
+
 ## 1.6.8 (2024-11-11)
 
 * Add ruby 3.4 to test matrix.

data/Gemfile

@@ -8,7 +8,7 @@ gem 'guard'
 gem 'guard-rspec'
 gem 'guard-rubocop'
 gem 'matrix'
-gem 'rspec', '~> 3.13.0'
+gem 'rspec', '~> 3.13.2'
 gem 'rubocop'
 gem 'rubocop-performance'
 gem 'rubocop-rspec'

data/Gemfile.lock

@@ -1,19 +1,20 @@
 PATH
   remote: .
   specs:
-    webtranslateit-payday (1.6.8)
-      activesupport (~> 7, < 9)
+    webtranslateit-payday (1.7.0)
+      activesupport (>= 7, < 9)
       i18n (~> 1.12, < 2)
       money (~> 6.16, < 7)
       prawn (~> 2.4, < 3)
       prawn-svg (~> 0.32, < 1)
       prawn-table (~> 0.2, < 1)
+      rqrcode (~> 2.0, < 3)
       zeitwerk (~> 2.6, < 3)
 
 GEM
   remote: https://rubygems.org/
   specs:
-    activesupport (7.2.2)
+    activesupport (7.2.3)
       base64
       benchmark (>= 0.3)
       bigdecimal
@@ -27,27 +28,30 @@ GEM
       tzinfo (~> 2.0, >= 2.0.5)
     addressable (2.8.7)
       public_suffix (>= 2.0.2, < 7.0)
-    ast (2.4.2)
-    base64 (0.2.0)
-    benchmark (0.4.0)
-    bigdecimal (3.1.8)
+    ast (2.4.3)
+    base64 (0.3.0)
+    benchmark (0.5.0)
+    bigdecimal (3.3.1)
+    chunky_png (1.4.0)
     coderay (1.1.3)
-    concurrent-ruby (1.3.4)
-    connection_pool (2.4.1)
-    css_parser (1.19.1)
+    concurrent-ruby (1.3.5)
+    connection_pool (2.5.4)
+    css_parser (1.21.1)
       addressable
-    diff-lcs (1.5.1)
-    drb (2.2.1)
-    ffi (1.17.0-arm64-darwin)
-    ffi (1.17.0-x86_64-darwin)
-    ffi (1.17.0-x86_64-linux-gnu)
+    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.0)
+    guard (2.19.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)
@@ -59,26 +63,28 @@ GEM
     guard-rubocop (1.5.0)
       guard (~> 2.0)
       rubocop (< 2.0)
-    i18n (1.14.6)
+    i18n (1.14.7)
       concurrent-ruby (~> 1.0)
-    json (2.8.1)
-    language_server-protocol (3.17.0.3)
+    json (2.16.0)
+    language_server-protocol (3.17.0.5)
+    lint_roller (1.1.0)
     listen (3.9.0)
       rb-fsevent (~> 0.10, >= 0.10.3)
       rb-inotify (~> 0.9, >= 0.9.10)
-    logger (1.6.1)
+    logger (1.7.0)
     lumberjack (1.2.10)
-    matrix (0.4.2)
+    matrix (0.4.3)
     method_source (1.1.0)
-    minitest (5.25.1)
+    minitest (5.26.0)
     money (6.19.0)
       i18n (>= 0.6.4, <= 2)
     nenv (0.3.0)
     notiffany (0.1.3)
       nenv (~> 0.1)
       shellany (~> 0.0)
-    parallel (1.26.3)
-    parser (3.3.6.0)
+    ostruct (0.6.1)
+    parallel (1.27.0)
+    parser (3.3.10.0)
       ast (~> 2.4.1)
       racc
     pdf-core (0.10.0)
@@ -86,63 +92,74 @@ GEM
       matrix (~> 0.4)
       pdf-core (~> 0.10.0)
       ttfunk (~> 1.8)
-    prawn-svg (0.35.1)
+    prawn-svg (0.38.1)
       css_parser (~> 1.6)
       matrix (~> 0.4.2)
       prawn (>= 0.11.1, < 3)
-      rexml (>= 3.2.0, < 4)
+      rexml (>= 3.4.2, < 4)
     prawn-table (0.2.2)
       prawn (>= 1.3.0, < 3.0.0)
-    pry (0.14.2)
+    prism (1.6.0)
+    pry (0.15.2)
       coderay (~> 1.1)
       method_source (~> 1.0)
-    public_suffix (6.0.1)
+    public_suffix (6.0.2)
     racc (1.8.1)
     rainbow (3.1.1)
     rb-fsevent (0.11.2)
     rb-inotify (0.11.1)
       ffi (~> 1.0)
-    regexp_parser (2.9.2)
-    rexml (3.3.9)
-    rspec (3.13.0)
+    regexp_parser (2.11.3)
+    rexml (3.4.4)
+    rqrcode (2.2.0)
+      chunky_png (~> 1.0)
+      rqrcode_core (~> 1.0)
+    rqrcode_core (1.2.0)
+    rspec (3.13.2)
       rspec-core (~> 3.13.0)
       rspec-expectations (~> 3.13.0)
       rspec-mocks (~> 3.13.0)
-    rspec-core (3.13.2)
+    rspec-core (3.13.6)
       rspec-support (~> 3.13.0)
-    rspec-expectations (3.13.3)
+    rspec-expectations (3.13.5)
       diff-lcs (>= 1.2.0, < 2.0)
       rspec-support (~> 3.13.0)
-    rspec-mocks (3.13.2)
+    rspec-mocks (3.13.6)
       diff-lcs (>= 1.2.0, < 2.0)
       rspec-support (~> 3.13.0)
-    rspec-support (3.13.1)
-    rubocop (1.68.0)
+    rspec-support (3.13.6)
+    rubocop (1.81.7)
       json (~> 2.3)
-      language_server-protocol (>= 3.17.0)
+      language_server-protocol (~> 3.17.0.2)
+      lint_roller (~> 1.1.0)
       parallel (~> 1.10)
       parser (>= 3.3.0.2)
       rainbow (>= 2.2.2, < 4.0)
-      regexp_parser (>= 2.4, < 3.0)
-      rubocop-ast (>= 1.32.2, < 2.0)
+      regexp_parser (>= 2.9.3, < 3.0)
+      rubocop-ast (>= 1.47.1, < 2.0)
       ruby-progressbar (~> 1.7)
-      unicode-display_width (>= 2.4.0, < 3.0)
-    rubocop-ast (1.34.1)
-      parser (>= 3.3.1.0)
-    rubocop-performance (1.22.1)
-      rubocop (>= 1.48.1, < 2.0)
-      rubocop-ast (>= 1.31.1, < 2.0)
-    rubocop-rspec (3.2.0)
-      rubocop (~> 1.61)
+      unicode-display_width (>= 2.4.0, < 4.0)
+    rubocop-ast (1.48.0)
+      parser (>= 3.3.7.2)
+      prism (~> 1.4)
+    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)
+      lint_roller (~> 1.1)
+      rubocop (~> 1.81)
     ruby-progressbar (1.13.0)
-    securerandom (0.3.2)
+    securerandom (0.4.1)
     shellany (0.0.1)
     thor (1.3.2)
     ttfunk (1.8.0)
       bigdecimal (~> 3.1)
     tzinfo (2.0.6)
       concurrent-ruby (~> 1.0)
-    unicode-display_width (2.6.0)
+    unicode-display_width (3.2.0)
+      unicode-emoji (~> 4.1)
+    unicode-emoji (4.1.0)
     zeitwerk (2.7.1)
 
 PLATFORMS
@@ -158,11 +175,11 @@ DEPENDENCIES
   guard-rspec
   guard-rubocop
   matrix
-  rspec (~> 3.13.0)
+  rspec (~> 3.13.2)
   rubocop
   rubocop-performance
   rubocop-rspec
   webtranslateit-payday!
 
 BUNDLED WITH
-   2.5.23
+   2.6.2

data/README.md

@@ -53,6 +53,22 @@ Payday::Config.default.company_name = "Awesome Corp"
 Payday::Config.default.company_details = "10 This Way\nManhattan, NY 10001\n800-111-2222\nawesome@awesomecorp.com"
 ```
 
+QR Code Support
+===
+Invoices can include QR codes for verification purposes, useful for tax compliance requirements in various countries.
+
+Example:
+
+``` ruby
+invoice = Payday::Invoice.new(
+  invoice_number: 12345,
+  qr_code: 'https://verify.example.com/invoice/12345',
+  notes: 'Scan the QR code below to verify this invoice online.'
+)
+```
+
+QR codes are automatically rendered below the notes section.
+
 Using Payday with ActiveRecord Objects (or any other objects, for that matter)
 ===
 

data/lib/payday/invoice.rb

@@ -8,7 +8,8 @@ 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
+                  :tax_description, :due_at, :paid_at, :refunded_at, :currency, :invoice_details, :invoice_date,
+                  :qr_code
 
     attr_reader :tax_rate, :shipping_rate
 
@@ -31,6 +32,7 @@ module Payday
       self.currency = options[:currency] || nil
       self.invoice_details = options[:invoice_details] || []
       self.invoice_date = options[:invoice_date] || nil
+      self.qr_code = options[:qr_code] || nil
     end
     # rubocop:enable Metrics/AbcSize
     # rubocop:enable Metrics/MethodLength

data/lib/payday/pdf_renderer.rb

@@ -36,6 +36,7 @@ module Payday
       line_items_table(invoice, pdf)
       totals_lines(invoice, pdf)
       notes(invoice, pdf)
+      render_qr_code(invoice, pdf) unless defined?(invoice.notes) && invoice.notes
 
       page_numbers(pdf)
 
@@ -213,7 +214,7 @@ module Payday
                                          inline_format: true},
                             row_colors: %w[F6F9FC ffffff]) do
         # left align the number columns
-        columns(1..3).rows(1..row_length - 1).style(align: :right)
+        columns(1..3).rows(1..(row_length - 1)).style(align: :right)
 
         # set the column widths correctly
         natural = natural_column_widths
@@ -268,7 +269,7 @@ module Payday
     end
     # rubocop:enable Metrics/MethodLength
 
-    def self.notes(invoice, pdf) # rubocop:todo Metrics/AbcSize
+    def self.notes(invoice, pdf) # rubocop:todo Metrics/AbcSize, Metrics/MethodLength
       return unless defined?(invoice.notes) && invoice.notes
 
       pdf.move_cursor_to(pdf.cursor - 30)
@@ -280,6 +281,20 @@ module Payday
       pdf.stroke_line([0, pdf.cursor - 3, pdf.bounds.width, pdf.cursor - 3])
       pdf.move_cursor_to(pdf.cursor - 10)
       pdf.text(invoice.notes.to_s, inline_format: true)
+
+      render_qr_code(invoice, pdf)
+    end
+
+    def self.render_qr_code(invoice, pdf)
+      return unless defined?(invoice.qr_code) && invoice.qr_code.to_s.strip.present?
+
+      require 'rqrcode'
+
+      pdf.move_cursor_to(pdf.cursor - 10)
+      qr = RQRCode::QRCode.new(invoice.qr_code.to_s)
+      png = qr.as_png(size: 200)
+
+      pdf.image(StringIO.new(png.to_s), width: 100, position: :left)
     end
 
     def self.page_numbers(pdf)

data/payday.gemspec

@@ -2,7 +2,7 @@
 
 Gem::Specification.new do |s|
   s.name        = 'webtranslateit-payday'
-  s.version     = '1.6.8'
+  s.version     = '1.7.0'
   s.required_ruby_version = '>= 3.1'
   s.platform    = Gem::Platform::RUBY
   s.authors     = ['Alan Johnson', 'Edouard Briere']
@@ -12,12 +12,13 @@ Gem::Specification.new do |s|
   s.description = 'Payday is a library for rendering invoices to pdf.'
   s.license = 'MIT'
 
-  s.add_dependency 'activesupport', '~> 7', '< 9'
+  s.add_dependency 'activesupport', '>= 7', '< 9'
   s.add_dependency 'i18n', '~> 1.12', '< 2'
   s.add_dependency 'money', '~> 6.16', '< 7'
   s.add_dependency 'prawn', '~> 2.4', '< 3'
   s.add_dependency 'prawn-svg', '~> 0.32', '< 1'
   s.add_dependency 'prawn-table', '~> 0.2', '< 1'
+  s.add_dependency 'rqrcode', '~> 2.0', '< 3'
   s.add_dependency 'zeitwerk', '~> 2.6', '< 3'
 
   s.files = `git ls-files`.split("\n")

data/spec/invoice_spec.rb

@@ -244,6 +244,111 @@ module Payday # rubocop:todo Metrics/ModuleLength
         end
       end
 
+      context 'with QR code' do
+        it 'renders a complete invoice with QR code correctly' do # rubocop:todo RSpec/ExampleLength
+          Payday::Config.default.company_name = 'Example Company'
+          Payday::Config.default.company_details = "123 Business St\nCity, ST 12345\ninfo@example.com"
+
+          notes = "<b>Payment Terms:</b> Net 30 days\n\n" \
+                  "<b>Verification:</b> Scan the QR code below to verify this invoice online.\n\n" \
+                  'Questions? Contact us at <u>billing@example.com</u>'
+
+          invoice = described_class.new(
+            invoice_number: 'INV-2024-001',
+            invoice_date: Date.civil(2024, 11, 25),
+            due_at: Date.civil(2024, 12, 25),
+            bill_to: "Customer Name\n456 Customer Ave\nTown, ST 67890",
+            tax_rate: 10.0,
+            qr_code: 'https://example.com/verify/INV-2024-001',
+            notes: notes
+          )
+
+          invoice.add_line_item(description: 'Consulting Services', quantity: 10, price: 150)
+          invoice.add_line_item(description: 'Software License', predefined_amount: 500)
+
+          expect(invoice.render_pdf).to match_binary_asset 'example_invoice_with_qr.pdf'
+        end
+
+        it 'renders invoice with QR code containing URL' do # rubocop:todo RSpec/MultipleExpectations
+          invoice = new_invoice(qr_code: 'https://example.com/verify/invoice/12345')
+          invoice.line_items << LineItem.new(price: 20, quantity: 1, description: 'Test Item')
+
+          pdf_string = invoice.render_pdf
+          expect(pdf_string).to be_a(String)
+          expect(pdf_string.bytesize).to be > 0
+        end
+
+        # rubocop:todo RSpec/ExampleLength, RSpec/MultipleExpectations
+        it 'renders invoice with QR code containing arbitrary data' do
+          # rubocop:enable RSpec/ExampleLength, RSpec/MultipleExpectations
+          qr_data = 'INVOICE:12345|DATE:2024-01-01|TOTAL:1234.56'
+          invoice = new_invoice(qr_code: qr_data)
+          invoice.line_items << LineItem.new(price: 1234.56, quantity: 1, description: 'Service')
+
+          pdf_string = invoice.render_pdf
+          expect(pdf_string).to be_a(String)
+          expect(pdf_string.bytesize).to be > 0
+        end
+
+        it 'renders invoice without QR code when qr_code is nil' do # rubocop:todo RSpec/MultipleExpectations
+          invoice = new_invoice(qr_code: nil)
+          invoice.line_items << LineItem.new(price: 20, quantity: 1, description: 'Test Item')
+
+          pdf_string = invoice.render_pdf
+          expect(pdf_string).to be_a(String)
+          expect(pdf_string.bytesize).to be > 0
+        end
+
+        it 'renders invoice without QR code when qr_code is blank' do # rubocop:todo RSpec/MultipleExpectations
+          invoice = new_invoice(qr_code: '  ')
+          invoice.line_items << LineItem.new(price: 20, quantity: 1, description: 'Test Item')
+
+          pdf_string = invoice.render_pdf
+          expect(pdf_string).to be_a(String)
+          expect(pdf_string.bytesize).to be > 0
+        end
+
+        # rubocop:todo RSpec/ExampleLength, RSpec/MultipleExpectations
+        it 'renders invoice with QR code and notes' do
+          # rubocop:enable RSpec/ExampleLength, RSpec/MultipleExpectations
+          invoice = new_invoice(
+            notes: 'Scan the QR code below to verify this invoice.',
+            qr_code: 'https://example.com/verify/12345'
+          )
+          invoice.line_items << LineItem.new(price: 100, quantity: 1, description: 'Consulting')
+
+          pdf_string = invoice.render_pdf
+          expect(pdf_string).to be_a(String)
+          expect(pdf_string.bytesize).to be > 0
+        end
+
+        # rubocop:todo RSpec/ExampleLength, RSpec/MultipleExpectations
+        it 'renders invoice with QR code but without notes' do
+          # rubocop:enable RSpec/ExampleLength, RSpec/MultipleExpectations
+          invoice = new_invoice(
+            notes: nil,
+            qr_code: 'https://example.com/verify/12345'
+          )
+          invoice.line_items << LineItem.new(price: 100, quantity: 1, description: 'Consulting')
+
+          pdf_string = invoice.render_pdf
+          expect(pdf_string).to be_a(String)
+          expect(pdf_string.bytesize).to be > 0
+        end
+
+        # rubocop:todo RSpec/ExampleLength, RSpec/MultipleExpectations
+        it 'is able to be initialized with qr_code in options hash' do
+          # rubocop:enable RSpec/ExampleLength, RSpec/MultipleExpectations
+          i = described_class.new(
+            invoice_number: 20,
+            qr_code: 'https://example.com/verify/20'
+          )
+
+          expect(i.invoice_number).to eq(20)
+          expect(i.qr_code).to eq('https://example.com/verify/20')
+        end
+      end
+
       def new_invoice(params = {})
         default_params = {
           tax_rate: 0.1,

metadata

@@ -1,21 +1,20 @@
 --- !ruby/object:Gem::Specification
 name: webtranslateit-payday
 version: !ruby/object:Gem::Version
-  version: 1.6.8
+  version: 1.7.0
 platform: ruby
 authors:
 - Alan Johnson
 - Edouard Briere
-autorequire:
 bindir: bin
 cert_chain: []
-date: 2024-11-11 00:00:00.000000000 Z
+date: 1980-01-02 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activesupport
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
         version: '7'
     - - "<"
@@ -25,7 +24,7 @@ dependencies:
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
         version: '7'
     - - "<"
@@ -131,6 +130,26 @@ dependencies:
     - - "<"
       - !ruby/object:Gem::Version
         version: '1'
+- !ruby/object:Gem::Dependency
+  name: rqrcode
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.0'
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '3'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.0'
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '3'
 - !ruby/object:Gem::Dependency
   name: zeitwerk
   requirement: !ruby/object:Gem::Requirement
@@ -194,6 +213,7 @@ files:
 - lib/payday/pdf_renderer.rb
 - payday.gemspec
 - spec/assets/default_logo.png
+- spec/assets/example_invoice_with_qr.pdf
 - spec/assets/svg.pdf
 - spec/assets/testing.pdf
 - spec/assets/testing_es.pdf
@@ -209,7 +229,6 @@ licenses:
 - MIT
 metadata:
   rubygems_mfa_required: 'true'
-post_install_message:
 rdoc_options: []
 require_paths:
 - lib
@@ -224,8 +243,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.5.22
-signing_key:
+rubygems_version: 3.6.9
 specification_version: 4
 summary: A simple library for rendering invoices.
 test_files: []