invoice_printer 2.4.0 → 2.5.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 0b35b038445eb5790a3241093f031314db880f037dbabd1800cff2a5548081ea
-  data.tar.gz: bd668a85987b9c72793724ce3a6d13d37478f7a747ae0d1e75f1b8a013809b6c
+  metadata.gz: f0b0c25298ec6af636229e5502e0e80bfdf7675bc46d4f6a8fbec3a81c215dbd
+  data.tar.gz: 80bb84c5081ece73c5f77ed6597e987267c64f90cdc76c547ee123e417c878ae
 SHA512:
-  metadata.gz: 1e16688d404cc7097f773babe821c62ddf6d06b87e23a80b1454e87bc6299549521b2e3a9bed556d8e35370a1c78843f6eca192618d4dd66da9e143b17ab60b4
-  data.tar.gz: 81f49267c2b967d6b3ac9596d06e330e112bbfb5b8ac51fa200f958e41c1a3a9fe6ad7624df08e069d2f697d625acf3484ca461a7523e32361122e06d23b3a85
+  metadata.gz: 68978f3d5badd98537e2c3c287c4bbca474de49db7b02210e0d388e764935f612fe10b72a53e689d29643466fd8ffce6d122202f55860876609d2f01dab4a2b8
+  data.tar.gz: f3d1d0a824c9c1ba9528a564a497e5709d118ab0d91e97f9910d369b448a45536097b60370255d6751d3bb2ce253eb751807bf1a73461b27ab68902d6d3016a8

data/.github/workflows/ci.yml

@@ -22,12 +22,13 @@ jobs:
         ruby:
           - "3.1"
           - "3.2"
-          # - "ruby-head"
+          - "3.3"
+          - "3.4"
     steps:
       - name: Install system dependencies
         run: sudo apt-get install imagemagick libmagickwand-dev
       - name: Check out code
-        uses: actions/checkout@v4
+        uses: actions/checkout@v5
       - name: Install Ruby dependencies
         uses: ruby/setup-ruby@v1
         with:

data/bin/invoice_printer

@@ -22,6 +22,7 @@ def show_help
          --bold-font   path to bold font or builtin font name
          -s, --stamp   path to stamp
               --logo   path to logotype
+                --qr   path to QR image
         --background   path to background image
          --page-size   letter or a4 (letter is the default)
       -f, --filename   output path
@@ -60,6 +61,10 @@ parser = OptionParser.new do|opts|
     options[:logo] = path
   end
 
+  opts.on('--qr PATH') do |path|
+    options[:qr] = path
+  end
+
   opts.on('--background PATH') do |path|
     options[:background] = path
   end
@@ -124,6 +129,7 @@ begin
       bold_font:  options[:bold_font],
       stamp:      options[:stamp],
       logo:       options[:logo],
+      qr:         options[:qr],
       background: options[:background],
       page_size:  options[:page_size]
     )
@@ -139,6 +145,7 @@ begin
       bold_font:  options[:bold_font],
       stamp:      options[:stamp],
       logo:       options[:logo],
+      qr:         options[:qr],
       file_name:  options[:filename],
       background: options[:background],
       page_size:  options[:page_size]

data/docs/COMMAND_LINE.md

@@ -16,6 +16,7 @@ Options:
      --bold-font   path to bold font or builtin font name
      -s, --stamp   path to stamp
           --logo   path to logotype
+            --qr   path to QR image
     --background   path to background image
      --page-size   letter or a4 (letter is the default)
   -f, --filename   output path

data/docs/SERVER.md

@@ -64,6 +64,7 @@ Options:
 - `bold_font` - path to bold font file or builtin font name
 - `stamp` - path to stamp file
 - `logo` - path to logotype file
+- `qr` - path to QR image file
 - `background` - path to background file
 - `page_size` - letter or A4 page size
 
@@ -107,6 +108,7 @@ Options:
 - `bold_font` - path to bold font file or builtin font name
 - `stamp` - path to stamp file
 - `logo` - path to logotype file
+- `qr` - path to QR image file
 - `background` - path to background file
 - `page_size` - letter or A4 page size
 - `filename` - path for saving the generated output PDF

data/examples/qr_invoice.rb

@@ -0,0 +1,57 @@
+#!/usr/bin/env ruby
+# Example demonstrating adding a QR image to the invoice (bottom-right)
+
+lib = File.expand_path('../../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'invoice_printer'
+
+provider_address = <<ADDRESS
+5th Avenue
+747 05  NYC
+ADDRESS
+
+purchaser_address = <<ADDRESS
+7th Avenue
+747 70  NYC
+ADDRESS
+
+item = InvoicePrinter::Document::Item.new(
+  name: 'Programming',
+  quantity: '10',
+  unit: 'hr',
+  price: '$ 90',
+  amount: '$ 900'
+)
+
+invoice = InvoicePrinter::Document.new(
+  number: 'NO. 202500000001',
+  provider_name: 'John White',
+  provider_lines: provider_address,
+  purchaser_name: 'Will Black',
+  purchaser_lines: purchaser_address,
+  issue_date: '10/20/2025',
+  due_date: '11/03/2025',
+  total: '$ 900',
+  bank_account_number: '156546546465',
+  description: "Invoice with QR image example.",
+  items: [item],
+  note: "Scan the QR code for payment or details."
+)
+
+qr_path = File.expand_path('../qr.png', __FILE__)
+logo_path = File.expand_path('../prawn.png', __FILE__)
+
+InvoicePrinter.print(
+  document: invoice,
+  logo: logo_path,
+  qr: qr_path,
+  file_name: 'qr_invoice.pdf'
+)
+
+InvoicePrinter.print(
+  document: invoice,
+  logo: logo_path,
+  qr: qr_path,
+  file_name: 'qr_invoice_a4.pdf',
+  page_size: :a4
+)

data/invoice_printer.gemspec

@@ -11,10 +11,13 @@ ONLY_FONTS_FILES = [
   'FONTS_LICENSE.txt',
   'assets/fonts/overpass/OFL-1.1.txt',
   'assets/fonts/overpass/Overpass-Regular.ttf',
+  'assets/fonts/overpass/Overpass-Bold.ttf',
   'assets/fonts/opensans/Apache-2.0.txt',
   'assets/fonts/opensans/OpenSans-Regular.ttf',
+  'assets/fonts/opensans/OpenSans-Bold.ttf',
   'assets/fonts/roboto/Apache-2.0.txt',
   'assets/fonts/roboto/Roboto-Regular.ttf',
+  'assets/fonts/roboto/Roboto-Bold.ttf',
   'lib/invoice_printer/fonts.rb'
 ]
 
@@ -49,6 +52,7 @@ Gem::Specification.new do |spec|
   spec.add_dependency 'prawn-table', '~> 0.2.2'
   spec.add_dependency 'matrix'
   spec.add_dependency 'e2mmap'
+  spec.add_dependency 'base64'
 
   spec.add_development_dependency 'bundler', '>= 1.7'
   spec.add_development_dependency 'rake', '>= 10.0'

data/lib/invoice_printer/pdf_document.rb

@@ -13,15 +13,17 @@ module InvoicePrinter
   #     font: 'font.ttf',
   #     bold_font: 'bold_font.ttf',
   #     stamp: 'stamp.jpg',
-  #     logo: 'example.jpg'
+  #     logo: 'example.jpg',
+  #     qr: 'qr.png'
   #   )
   class PDFDocument
     class FontFileNotFound < StandardError; end
     class LogoFileNotFound < StandardError; end
     class StampFileNotFound < StandardError; end
+    class QRFileNotFound < StandardError; end
     class InvalidInput < StandardError; end
 
-    attr_reader :invoice, :labels, :file_name, :font, :bold_font, :stamp, :logo
+    attr_reader :invoice, :labels, :file_name, :font, :bold_font, :stamp, :logo, :qr
 
     DEFAULT_LABELS = {
       name: 'Invoice',
@@ -74,6 +76,7 @@ module InvoicePrinter
       bold_font: nil,
       stamp: nil,
       logo: nil,
+      qr: nil,
       background: nil,
       page_size: :letter
     )
@@ -83,6 +86,7 @@ module InvoicePrinter
       @bold_font = bold_font
       @stamp     = stamp
       @logo      = logo
+      @qr        = qr
       @page_size = page_size ? PAGE_SIZES[page_size.to_sym] : PAGE_SIZES[:letter]
       @pdf       = Prawn::Document.new(background: background, page_size: @page_size.name)
 
@@ -105,6 +109,14 @@ module InvoicePrinter
         end
       end
 
+      if used? @qr
+        if File.exist?(@qr)
+          @qr = qr
+        else
+          raise QRFileNotFound, "QR image file not found at #{@qr}"
+        end
+      end
+
       if used?(@font) && used?(@bold_font)
         use_font(@font, @bold_font)
       elsif used?(@font)
@@ -176,6 +188,7 @@ module InvoicePrinter
       build_total
       build_stamp
       build_logo
+      build_qr
       build_note
       build_footer
     end
@@ -855,6 +868,26 @@ module InvoicePrinter
       end
     end
 
+    # Insert a QR image at the right bottom of the document
+    #
+    # If a note is present, position it on top of it.
+    def build_qr
+      if @qr && !@qr.empty?
+        bottom = @document.note.empty? ? 75 : (75 + note_height)
+        # Place QR at page width minus its fit width to keep it at the right edge.
+
+        image_info = Prawn::Images::PNG.new(File.read(@qr))
+        image_width  = image_info.width.to_f
+
+        if image_width > x(50)
+          image_width = x(50)
+        end
+
+        left = @pdf.bounds.right - image_width
+        @pdf.image(@qr, at: [left, bottom], fit: [x(50), y(50)])
+      end
+    end
+
     # Insert a stamp (with signature) after the total table
     def build_stamp
       if @stamp && !@stamp.empty?

data/lib/invoice_printer/version.rb

@@ -1,3 +1,3 @@
 module InvoicePrinter
-  VERSION = '2.4.0'
+  VERSION = '2.5.0'
 end

data/lib/invoice_printer.rb

@@ -18,6 +18,7 @@ Prawn::Font::AFM.hide_m17n_warning = true
 #     bold_font: 'path-to-font-file.ttf',
 #     stamp: 'stamp.jpg',
 #     logo: 'logo.jpg',
+#     qr: 'qr.png',
 #     file_name: 'invoice.pdf'
 #   )
 module InvoicePrinter
@@ -69,6 +70,7 @@ module InvoicePrinter
   # bold_font - bold font file to use
   # stamp - stamp & signature (image)
   # logo - logotype (image)
+  # qr - QR image (image)
   # background - background (image)
   # page_size - :letter or :a4
   # file_name - output file
@@ -79,6 +81,7 @@ module InvoicePrinter
     bold_font: nil,
     stamp: nil,
     logo: nil,
+    qr: nil,
     background: nil,
     page_size: :letter,
     file_name:
@@ -90,6 +93,7 @@ module InvoicePrinter
       bold_font: bold_font,
       stamp: stamp,
       logo: logo,
+      qr: qr,
       background: background,
       page_size: page_size
     ).print(file_name)
@@ -103,6 +107,7 @@ module InvoicePrinter
   # bold_font - bold font file to use
   # stamp - stamp & signature (image)
   # logo - logotype (image)
+  # qr - QR image (image)
   # background - background (image)
   # page_size - :letter or :a4
   def self.render(
@@ -112,6 +117,7 @@ module InvoicePrinter
     bold_font: nil,
     stamp: nil,
     logo: nil,
+    qr: nil,
     background: nil,
     page_size: :letter
   )
@@ -122,6 +128,7 @@ module InvoicePrinter
       bold_font: bold_font,
       stamp: stamp,
       logo: logo,
+      qr: qr,
       background: background,
       page_size: page_size
     ).render

data/test/cli_test.rb

@@ -22,6 +22,7 @@ class CLITest < Minitest::Test
               "--document '#{@invoice_as_json}' " +
               "--labels '#{labels_hash.to_json}' " +
               "--logo '#{logo_path}' " +
+              "--qr '#{qr_path}' " +
               "--background '#{background_path}' " +
               "--filename #{@output_path}"
 
@@ -44,6 +45,7 @@ class CLITest < Minitest::Test
       document:   @invoice,
       labels:     labels_hash,
       logo:       logo_path,
+      qr:         qr_path,
       background: background_path,
       page_size:  :letter,
       file_name:  expected_pdf_path
@@ -60,6 +62,7 @@ class CLITest < Minitest::Test
               "--document '#{@invoice_as_json}' " +
               "--labels '#{labels_hash.to_json}' " +
               "--logo '#{logo_path}' " +
+              "--qr '#{qr_path}' " +
               "--background '#{background_path}' " +
               "--page-size a4 " +
               "--filename #{@output_path}"
@@ -83,6 +86,7 @@ class CLITest < Minitest::Test
       document:   @invoice,
       labels:     labels_hash,
       logo:       logo_path,
+      qr:         qr_path,
       background: background_path,
       page_size:  :a4,
       file_name:  expected_pdf_path
@@ -107,6 +111,10 @@ class CLITest < Minitest::Test
     File.expand_path('../../examples/logo.png', __FILE__)
   end
 
+  def qr_path
+    File.expand_path('../../assets/qr.png', __FILE__)
+  end
+
   def background_path
     File.expand_path('../../examples/background.png', __FILE__)
   end

data/test/inputs_test.rb

@@ -55,4 +55,12 @@ class InputsTest < Minitest::Test
       InvoicePrinter.render(document: invoice, stamp: 'missing.png')
     end
   end
+
+  def test_missing_qr_raises_an_exception
+    invoice = InvoicePrinter::Document.new(**default_document_params)
+
+    assert_raises(InvoicePrinter::PDFDocument::QRFileNotFound) do
+      InvoicePrinter.render(document: invoice, qr: 'missing.png')
+    end
+  end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: invoice_printer
 version: !ruby/object:Gem::Version
-  version: 2.4.0
+  version: 2.5.0
 platform: ruby
 authors:
 - Josef Strzibny
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2024-10-13 00:00:00.000000000 Z
+date: 2025-10-20 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: json
@@ -80,6 +80,20 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
+- !ruby/object:Gem::Dependency
+  name: base64
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: bundler
   requirement: !ruby/object:Gem::Requirement
@@ -123,9 +137,6 @@ files:
 - LICENSE.txt
 - README.md
 - Rakefile
-- assets/fonts/opensans/OpenSans-Bold.ttf
-- assets/fonts/overpass/Overpass-Bold.ttf
-- assets/fonts/roboto/Roboto-Bold.ttf
 - benchmarks/render.yml
 - bin/invoice_printer
 - docs/COMMAND_LINE.md
@@ -142,6 +153,7 @@ files:
 - examples/picture.jpg
 - examples/promo.rb
 - examples/provider_purchaser_lines.rb
+- examples/qr_invoice.rb
 - examples/simple_invoice.rb
 - examples/variable_field_invoice.rb
 - invoice_printer.gemspec
@@ -186,7 +198,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.4.10
+rubygems_version: 3.5.22
 signing_key:
 specification_version: 4
 summary: Super simple PDF invoicing in pure Ruby