Merge pull request #93 from strzibny/qr-support

Add QR image support

Author: strzibny

assets/qr.png

@@ -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]

bin/invoice_printer

@@ -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

docs/COMMAND_LINE.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

docs/SERVER.md

@@ -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
+)

examples/qr.png

@@ -18,6 +18,7 @@
 #     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 @@ def self.labels
   # 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 @@ def self.print(
     bold_font: nil,
     stamp: nil,
     logo: nil,
+    qr: nil,
     background: nil,
     page_size: :letter,
     file_name:
@@ -90,6 +93,7 @@ def self.print(
       bold_font: bold_font,
       stamp: stamp,
       logo: logo,
+      qr: qr,
       background: background,
       page_size: page_size
     ).print(file_name)
@@ -103,6 +107,7 @@ def self.print(
   # 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 @@ def self.render(
     bold_font: nil,
     stamp: nil,
     logo: nil,
+    qr: nil,
     background: nil,
     page_size: :letter
   )
@@ -122,6 +128,7 @@ def self.render(
       bold_font: bold_font,
       stamp: stamp,
       logo: logo,
+      qr: qr,
       background: background,
       page_size: page_size
     ).render

examples/qr_invoice.pdf

@@ -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 @@ def initialize(
       bold_font: nil,
       stamp: nil,
       logo: nil,
+      qr: nil,
       background: nil,
       page_size: :letter
     )
@@ -83,6 +86,7 @@ def initialize(
       @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 @@ def initialize(
         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 @@ def build_pdf
       build_total
       build_stamp
       build_logo
+      build_qr
       build_note
       build_footer
     end
@@ -855,6 +868,26 @@ def build_logo
       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?