prawn-swiss_qr_bill 0.4.1

data/lib/prawn/swiss_qr_bill/padded_box.rb

@@ -0,0 +1,52 @@
+# frozen_string_literal: true
+
+module Prawn
+  # Attach padded_box to Prawn
+  #
+  #   padded_box(point, options = {}, &block)
+  #
+  # NOTE: not in use, not working properly. it is not easy to stroke the outer box.
+  #   was an idea for DebugSection, maybe deprecate/remove or make it work later.
+  #
+  # :nocov:
+  class Document
+    def padded_box(point, *args, &block)
+      init_padded_box(block) do |parent_box|
+        point = map_to_absolute(point)
+        @bounding_box = PaddedBox.new(self, parent_box, point, *args)
+      end
+    end
+
+    private
+
+    def init_padded_box(user_block)
+      # binding.pry
+      parent_box = @bounding_box
+
+      yield(parent_box)
+
+      self.y = @bounding_box.absolute_top
+
+      pad = @bounding_box.padding
+      bounding_box([@bounding_box.left + pad, @bounding_box.top - pad],
+                   width: @bounding_box.width - (2 * pad),
+                   height: @bounding_box.height - (2 * pad)) do
+        user_block.call
+      end
+
+      @bounding_box = parent_box
+    end
+  end
+
+  # Bounding box with padding
+  class PaddedBox < Prawn::Document::BoundingBox
+    attr_reader :padding
+
+    def initialize(document, parent, point, options = {})
+      super
+
+      @padding = options[:padding] || 0
+    end
+  end
+  # :nocov:
+end

data/lib/prawn/swiss_qr_bill/qr/data.rb

@@ -0,0 +1,105 @@
+# frozen_string_literal: true
+
+module Prawn
+  module SwissQRBill
+    module QR
+      # The data of the Swiss QR-bill
+      #
+      # References:
+      # https://www.paymentstandards.ch/dam/downloads/ig-qr-bill-en.pdf
+      # * Chapter 4, Page 25
+      #
+      # TODO: implement skippable (alt schemas, bill info. fields after trailer)
+      # TODO: check if addr-type has to be mentioned if not given?
+      # OPTIMIZE: implement non-changable?
+      class Data
+        # Simple field structure:
+        # * :default => default value to be set, if key is not given
+        # * :format  => Proc to call when generating output
+        # * :skippable  => Do not output in QR data if not given
+        Field = Struct.new(:default, :format, :skippable)
+
+        # Available fields of the QR code data, ordered.
+        FIELDS = {
+          # fixed: SPC
+          qr_type: Field.new('SPC'),
+          version: Field.new('0200'),
+          # fixed: 1
+          coding: Field.new('1'),
+          # TODO: check for valid iban
+          # iban: Field.new(nil, ->(value) { value.delete(' ') }),
+          iban: Field.new,
+          # enum: S, K
+          creditor_address_type: Field.new('K'),
+          creditor_address_name: Field.new,
+          creditor_address_line1: Field.new,
+          creditor_address_line2: Field.new,
+          creditor_address_postal_code: Field.new,
+          creditor_address_city: Field.new,
+          creditor_address_country: Field.new,
+          # omit ultimate_creditor_* => for future use
+          # enum: S, K
+          ultimate_creditor_address_type: Field.new,
+          ultimate_creditor_address_name: Field.new,
+          ultimate_creditor_address_line1: Field.new,
+          ultimate_creditor_address_line2: Field.new,
+          ultimate_creditor_address_postal_code: Field.new,
+          ultimate_creditor_address_city: Field.new,
+          ultimate_creditor_address_country: Field.new,
+          amount: Field.new(nil, ->(value) { value && format('%.2f', value) }),
+          # enum: CHF, EUR
+          currency: Field.new('CHF'),
+          # enum: S, K
+          debtor_address_type: Field.new,
+          debtor_address_name: Field.new,
+          debtor_address_line1: Field.new,
+          debtor_address_line2: Field.new,
+          debtor_address_postal_code: Field.new,
+          debtor_address_city: Field.new,
+          debtor_address_country: Field.new,
+          # enum: QRR, SCOR, NON
+          reference_type: Field.new('NON'),
+          reference: Field.new(nil, ->(value) { value && value.delete(' ') }),
+          unstructured_message: Field.new,
+          # fixed: EPD
+          trailer: Field.new('EPD'),
+
+          # additional:
+
+          bill_information: Field.new(nil, nil, true),
+          # key-value pairs:
+          alternative_parameters: Field.new(nil, nil, true)
+        }.freeze
+
+        # TODO: check if all fields can be changed by user?
+        attr_accessor(*FIELDS.keys)
+
+        def initialize(fields = {})
+          # set defaults
+          FIELDS.each_key do |field|
+            instance_variable_set("@#{field}", FIELDS[field].default)
+          end
+
+          # set given
+          fields.each_key do |field|
+            instance_variable_set("@#{field}", fields[field])
+          end
+        end
+
+        def generate
+          stack = []
+          FIELDS.keys.map do |k|
+            var = instance_variable_get("@#{k}")
+
+            next if FIELDS[k][:skippable] && var.nil?
+
+            var = FIELDS[k][:format].call(var) if FIELDS[k][:format].is_a?(Proc)
+
+            stack << var
+          end
+          stack.join("\r\n")
+        end
+      end
+    end
+  end
+end

data/lib/prawn/swiss_qr_bill/sections/payment_amount.rb

@@ -0,0 +1,88 @@
+# frozen_string_literal: true
+
+module Prawn
+  module SwissQRBill
+    module Sections
+      # Amount section at payment
+      #
+      # TODO: allow EUR payment
+      # TODO: find solution to put measurements to specs.yml
+      # OPTIMIZE: refactor with receipt_amount
+      class PaymentAmount < Section
+        KEY = 'payment.amount'
+
+        # width of the currency field with enough space for both variants
+        CURRENCY_WIDTH = 14.mm
+
+        # width of amount when amount has to be displayed
+        AMOUNT_WIDTH = 29.mm
+
+        # height of the amount label when corner-box has to be displayed
+        AMOUNT_LABEL_HEIGHT = 3.5.mm
+
+        # measurement of amount corner-box
+        AMOUNT_BOX_WIDTH = 40.mm
+        AMOUNT_BOX_HEIGHT = 15.mm
+
+        include Helpers::NumberHelper
+        include Helpers::BoxHelper
+
+        def draw
+          box do
+            draw_currency
+            draw_amount
+          end
+        end
+
+        private
+
+        def draw_currency
+          doc.bounding_box([doc.bounds.left, doc.bounds.top],
+                           width: CURRENCY_WIDTH, height: specs.height) do
+            label I18n.t('currency', scope: i18n_scope)
+            content 'CHF'
+          end
+        end
+
+        def draw_amount
+          if @data.key?(:amount)
+            draw_amount_label_and_value
+          else
+            draw_amount_label
+            draw_amount_corner_box
+          end
+        end
+
+        def draw_amount_label_and_value
+          left = specs.width - AMOUNT_WIDTH
+
+          doc.bounding_box([left, doc.bounds.top],
+                           width: AMOUNT_WIDTH, height: specs.height) do
+            label I18n.t('amount', scope: i18n_scope)
+            # format_with_delimiter => NumberHelper
+            content format_with_delimiter(@data[:amount])
+          end
+        end
+
+        def draw_amount_label
+          # amount label is not left aligned with the corner-box, subtract
+          # the currency width for alignment
+          left = CURRENCY_WIDTH
+
+          # width is calculated by the leftover space
+          width = specs.width - CURRENCY_WIDTH
+          doc.bounding_box([left, doc.bounds.top],
+                           width: width, height: AMOUNT_LABEL_HEIGHT) do
+            label I18n.t('amount', scope: i18n_scope)
+          end
+        end
+
+        def draw_amount_corner_box
+          corner_box(doc, [specs.width - AMOUNT_BOX_WIDTH, doc.bounds.top - AMOUNT_LABEL_HEIGHT],
+                     width: AMOUNT_BOX_WIDTH,
+                     height: AMOUNT_BOX_HEIGHT)
+        end
+      end
+    end
+  end
+end

data/lib/prawn/swiss_qr_bill/sections/payment_further_information.rb

@@ -0,0 +1,14 @@
+# frozen_string_literal: true
+
+module Prawn
+  module SwissQRBill
+    module Sections
+      # Further information section at payment
+      class PaymentFurtherInformation < Section
+        KEY = 'payment.further_information'
+
+        def draw; end
+      end
+    end
+  end
+end

data/lib/prawn/swiss_qr_bill/sections/payment_information.rb

@@ -0,0 +1,59 @@
+# frozen_string_literal: true
+
+module Prawn
+  module SwissQRBill
+    module Sections
+      # Information section at payment
+      class PaymentInformation < Section
+        KEY = 'payment.information'
+
+        include Helpers::BoxHelper
+
+        def draw
+          box do
+            draw_payable_to
+            draw_reference if @data.key?(:reference)
+            draw_additional_information if @data.key?(:additional_information)
+            draw_payable_by
+          end
+        end
+
+        private
+
+        def draw_payable_to
+          doc.pad_top(2.1) { label I18n.t('creditor', scope: i18n_scope) }
+          content [@data[:creditor][:iban],
+                   build_address(@data[:creditor][:address])].join("\n")
+
+          line_spacing
+        end
+
+        def draw_reference
+          label I18n.t('reference', scope: i18n_scope)
+          content @data[:reference]
+
+          line_spacing
+        end
+
+        def draw_additional_information
+          label I18n.t('additional_info', scope: i18n_scope)
+          content @data[:additional_information]
+
+          line_spacing
+        end
+
+        def draw_payable_by
+          if @data.key?(:debtor)
+            label I18n.t('debtor', scope: i18n_scope)
+            content build_address(@data[:debtor][:address])
+          else
+            label I18n.t('debtor_blank', scope: i18n_scope)
+
+            doc.move_down 2
+            corner_box(doc, [0, doc.cursor], width: 65.mm, height: 25.mm)
+          end
+        end
+      end
+    end
+  end
+end

data/lib/prawn/swiss_qr_bill/sections/payment_title.rb

@@ -0,0 +1,18 @@
+# frozen_string_literal: true
+
+module Prawn
+  module SwissQRBill
+    module Sections
+      # Title section at payment
+      class PaymentTitle < Section
+        KEY = 'payment.title'
+
+        def draw
+          box do
+            content I18n.t('payment', scope: i18n_scope)
+          end
+        end
+      end
+    end
+  end
+end

data/lib/prawn/swiss_qr_bill/sections/qr_code.rb

@@ -0,0 +1,102 @@
+# frozen_string_literal: true
+
+module Prawn
+  module SwissQRBill
+    module Sections
+      # QR code section
+      #
+      # The swiss cross is applied directly on the QR PNG. The PNG needs to be
+      # resized down, that the swiss cross overlaps exactly 9x9 modules for a
+      # QR-code of compression level :m.
+      #
+      # swiss_cross.png =>   166px ~>  7.mm
+      # QR-code:            1090px <~ 46.mm
+      #
+      # TODO: iban check -> raise exception if configured
+      class QRCode < Section
+        KEY = 'payment.qr_code'
+
+        QR_PX_SIZE = 1160
+
+        SWISS_CROSS_FILE = File.expand_path("#{__dir__}/../images/swiss_cross.png")
+
+        MAPPING = {
+          creditor_address_type: %i[creditor address type],
+          creditor_address_name: %i[creditor address name],
+          creditor_address_line1: %i[creditor address line1],
+          creditor_address_line2: %i[creditor address line2],
+          creditor_address_postal_code: %i[creditor address postal_code],
+          creditor_address_country: %i[creditor address country],
+          debtor_address_type: %i[debtor address type],
+          debtor_address_name: %i[debtor address name],
+          debtor_address_line1: %i[debtor address line1],
+          debtor_address_line2: %i[debtor address line2],
+          debtor_address_postal_code: %i[debtor address postal_code],
+          debtor_address_city: %i[debtor address city],
+          debtor_address_country: %i[debtor address country],
+          amount: [:amount],
+          currency: [:currency],
+          reference: [:reference],
+          reference_type: [:reference_type]
+        }.freeze
+
+        def draw
+          png = qr_as_png(@data)
+          add_swiss_cross!(png)
+
+          io = StringIO.new(png.to_blob)
+
+          box do
+            doc.image io, width: specs.width
+          end
+        end
+
+        private
+
+        def qr_as_png(data)
+          qr_data = generate_qr_data(data)
+          qr = RQRCode::QRCode.new(qr_data, level: :m)
+          png = qr.as_png(module_px_size: 20, border_modules: 0)
+          png.resize(QR_PX_SIZE, QR_PX_SIZE)
+        end
+
+        def add_swiss_cross!(png)
+          swiss_cross = ChunkyPNG::Image.from_file(SWISS_CROSS_FILE)
+
+          png.compose!(
+            swiss_cross,
+            (png.width - swiss_cross.width) / 2,
+            (png.height - swiss_cross.height) / 2
+          )
+        end
+
+        def generate_qr_data(data)
+          options = {}
+          MAPPING.each_key do |key|
+            # check if the exists
+            next unless deep_key?(data, MAPPING[key])
+
+            options[key] = data.dig(*MAPPING[key])
+          end
+
+          iban = IBAN.new(data[:creditor][:iban])
+          qr_data = QR::Data.new(options.merge(iban: iban.code))
+          qr_data.generate
+        end
+
+        # hash: hash to test key path for
+        # key_path: array of symbols to search the key
+        def deep_key?(hash, key_path)
+          path = key_path.dup
+
+          return false if path.empty?
+          return hash.key?(path[0]) if path.length == 1
+
+          last_key = path.pop
+
+          !!hash.dig(*path)&.key?(last_key)
+        end
+      end
+    end
+  end
+end

data/lib/prawn/swiss_qr_bill/sections/receipt_acceptance.rb

@@ -0,0 +1,18 @@
+# frozen_string_literal: true
+
+module Prawn
+  module SwissQRBill
+    module Sections
+      # Acceptance point section at receipt
+      class ReceiptAcceptance < Section
+        KEY = 'receipt.acceptance'
+
+        def draw
+          box do
+            label I18n.t('acceptance', scope: i18n_scope), align: :right
+          end
+        end
+      end
+    end
+  end
+end

data/lib/prawn/swiss_qr_bill/sections/receipt_amount.rb

@@ -0,0 +1,86 @@
+# frozen_string_literal: true
+
+module Prawn
+  module SwissQRBill
+    module Sections
+      # Amount section at receipt
+      #
+      # TODO: allow EUR payment
+      # TODO: find solution to put measurements to specs.yml
+      # OPTIMIZE: refactor with payment_amount
+      class ReceiptAmount < Section
+        KEY = 'receipt.amount'
+
+        # width of the currency field with enough space for both variants
+        CURRENCY_WIDTH = 11.mm
+
+        # measurement of the box for the amount as value and as corner-box
+        AMOUNT_BOX_WIDTH = 30.mm
+        AMOUNT_BOX_HEIGHT = 10.mm
+
+        # padding of the amount label to corner-box
+        AMOUNT_LABEL_PAD = 1.mm
+
+        include Helpers::NumberHelper
+        include Helpers::BoxHelper
+
+        def draw
+          box do
+            draw_currency
+            draw_amount
+          end
+        end
+
+        private
+
+        def draw_currency
+          # use the half width of the available size: space for amount-box
+          doc.bounding_box([doc.bounds.left, doc.bounds.top],
+                           width: CURRENCY_WIDTH, height: specs.height) do
+            doc.pad_top(1.4) { label I18n.t('currency', scope: i18n_scope) }
+            doc.pad_top(2.5) { content 'CHF' }
+          end
+        end
+
+        def draw_amount
+          if @data.key?(:amount)
+            draw_amount_label_and_value
+          else
+            draw_amount_label
+            draw_amount_corner_box
+          end
+        end
+
+        def draw_amount_label_and_value
+          # amount value is placed where the box would be, same width/height
+          left = specs.width - AMOUNT_BOX_WIDTH
+          doc.bounding_box([left, doc.bounds.top],
+                           width: AMOUNT_BOX_WIDTH, height: specs.height) do
+            doc.pad_top(1.4) { label I18n.t('amount', scope: i18n_scope) }
+            # format_with_delimiter => NumberHelper
+            doc.pad_top(2.5) { content format_with_delimiter(@data[:amount]) }
+          end
+        end
+
+        def draw_amount_label
+          # amount label is pushed to left, right after the currency box,
+          # which is the currency width
+          left = CURRENCY_WIDTH
+
+          # width is calculated by the left over space - 1.mm padding
+          width = specs.width - CURRENCY_WIDTH - AMOUNT_BOX_WIDTH - AMOUNT_LABEL_PAD
+          doc.bounding_box([left, doc.bounds.top],
+                           width: width, height: specs.height) do
+            doc.pad_top(1.4) { label I18n.t('amount', scope: i18n_scope), align: :right }
+          end
+        end
+
+        def draw_amount_corner_box
+          corner_box(doc, [specs.width - AMOUNT_BOX_WIDTH, doc.bounds.top - 1.4],
+                     width: AMOUNT_BOX_WIDTH,
+                     height: AMOUNT_BOX_HEIGHT)
+        end
+      end
+    end
+  end
+end

data/lib/prawn/swiss_qr_bill/sections/receipt_information.rb

@@ -0,0 +1,51 @@
+# frozen_string_literal: true
+
+module Prawn
+  module SwissQRBill
+    module Sections
+      # Information section at receipt
+      class ReceiptInformation < Section
+        KEY = 'receipt.information'
+
+        include Helpers::BoxHelper
+
+        def draw
+          box do
+            draw_payable_to
+            draw_reference if @data.key?(:reference)
+            draw_payable_by
+          end
+        end
+
+        private
+
+        def draw_payable_to
+          label I18n.t('creditor', scope: i18n_scope)
+          content [@data[:creditor][:iban],
+                   build_address(@data[:creditor][:address])].join("\n")
+
+          line_spacing
+        end
+
+        def draw_reference
+          label I18n.t('reference', scope: i18n_scope)
+          content @data[:reference]
+
+          line_spacing
+        end
+
+        def draw_payable_by
+          if @data.key?(:debtor)
+            label I18n.t('debtor', scope: i18n_scope)
+            content build_address(@data[:debtor][:address])
+          else
+            label I18n.t('debtor_blank', scope: i18n_scope)
+
+            doc.move_down 2
+            corner_box(doc, [0, doc.cursor], width: 52.mm, height: 20.mm)
+          end
+        end
+      end
+    end
+  end
+end

data/lib/prawn/swiss_qr_bill/sections/receipt_title.rb

@@ -0,0 +1,18 @@
+# frozen_string_literal: true
+
+module Prawn
+  module SwissQRBill
+    module Sections
+      # Title section at receipt
+      class ReceiptTitle < Section
+        KEY = 'receipt.title'
+
+        def draw
+          box do
+            content I18n.t('receipt', scope: i18n_scope)
+          end
+        end
+      end
+    end
+  end
+end