hexapdf-extras 1.1.1 → 1.1.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 8e7fe626cf7fd851cd203b739c69bdd193b5debffcd129c656d59b51c2d326ad
-  data.tar.gz: 588a1a744477c437035ca66fd187f4c3563b135946efb8a21d5f73e77f15d238
+  metadata.gz: 9c7f4718bb802b0d1dd228a9fa22fb44ed10dd95402d72c664d937dc8368c5c2
+  data.tar.gz: 7a8111bdb4d323ae5ca910bb215c6aacdbb0799ea05a264a5d4d459a7b21c67c
 SHA512:
-  metadata.gz: fb195eef642905d2797b96c545f63eaee7edff117982e16e8c3965d05c9abdf537331d35cfa09df6d9aebac3d03e4a28dbb921714bc3a4968984789f2f4548ea
-  data.tar.gz: 8682207937162bef5c86ca5f0f061dbb25469b989e65fa51dc4fbe7f3bc75739cc382911efee4c954e30a14650322bd870aa308e56436a1e18a665e0f4174a9d
+  metadata.gz: bdf857f06fc000adb0a716bcb4d039b314a0acd3f424a2e39f370bf61851741467f4b3e6319b02d7d0f86d95179ab399ad88cdf0ba95f2202efbae9e422c3ef1
+  data.tar.gz: a9ba5813153564d05eff9c10e538a1793c3c6f469025969d50e17ffeb2755e64c7b2c57d88f4a0acb18ef1dfdc853f22d8238fb559e665261134bae5c44ff850

data/README.rdoc

@@ -36,3 +36,37 @@ for details.
 
 Note: There was a {bug in poppler}[https://gitlab.freedesktop.org/poppler/poppler/-/issues/1281]
 (already fixed) which leads to invalid rendering in Okular (as of 2022-08-06).
+
+
+=== Swiss QR-bill generator
+
+This extension provides a box class for the document layouting facilities of HexaPDF to easily
+create a {Swiss QR-bill}[https://www.six-group.com/en/products-services/banking-services/payment-standardization/standards/qr-bill.html]:
+
+  HexaPDF::Composer.create("sample-qr-bill.pdf", margin: 0) do |composer|
+    data = {
+     lang: :de,
+     creditor: {
+       iban: "CH44 3199 9123 0008 8901 2",
+       name: "Max Muster & Söhne",
+       address_line1: "Musterstrasse",
+       address_line2: "123",
+       postal_code: "8000",
+       town: "Seldwyla",
+       country: "CH",
+     },
+     debtor: {
+       address_type: :combined,
+       name: "Simon Muster",
+       address_line1: "Musterstrasse 1",
+       address_line2: "8000 Seldwyla",
+       country: "CH"
+     },
+     amount: 2500.25,
+     currency: 'CHF',
+    }
+    composer.swiss_qr_bill(data: data, style: {valign: :bottom})
+  end
+
+See {HexaPDF::Extras::Layout::SwissQRBill}[https://hexapdf-extras.gettalong.org/api/HexaPDF/Extras/Layout/SwissQRBill.html]
+for details.

data/lib/hexapdf/extras/layout/swiss_qr_bill.rb

@@ -66,8 +66,8 @@ module HexaPDF
       #     following elements:
       #
       #     :iban::
-      #         (required) The IBAN of the creditor (21 characters, no spaces, only IBANs for CH or
-      #         LI). Note that the IBAN is not checked for validity.
+      #         (required) The IBAN of the creditor (21 characters, only IBANs for CH or LI). The
+      #         IBAN is only validated with respect to its check digits.
       #
       #     :name::
       #         (required) The name of the creditor (maximum 70 characters).
@@ -158,7 +158,7 @@ module HexaPDF
       #      amount: 2500.25,
       #      currency: 'CHF',
       #     }
-      #     composer.swiss_qr_bill(data: data, valign: :bottom)
+      #     composer.swiss_qr_bill(data: data, style: {valign: :bottom})
       #   end
       #
       # == References
@@ -262,6 +262,25 @@ module HexaPDF
             raise Error, "Data field :amount must be between 0.01 and 999_999_999.99"
           end
 
+          if !@data[:creditor]
+            raise Error, "Data field :creditor is missing"
+          end
+
+          value = @data[:creditor][:iban]
+          if !value
+            raise Error, "Data field :iban of :creditor is missing"
+          end
+          value.gsub!(/\s+/, '')
+          value.upcase!
+          if value.size != 21
+            raise Error, "Data field :iban of :creditor must contain exactly 21 characters"
+          end
+          # https://en.wikipedia.org/wiki/International_Bank_Account_Number#Validating_the_IBAN
+          result = "#{value[4..-1]}#{value[0, 4]}".gsub(/[A-Z]/) {|c| c.ord - 55 }.to_i % 97
+          unless result == 1
+            raise Error, "Data field :iban of :creditor has invalid check digits"
+          end
+
           validate_address = lambda do |hash|
             hash[:address_type] ||= :structured
             if hash[:address_type] != :structured && hash[:address_type] != :combined
@@ -452,7 +471,7 @@ module HexaPDF
             col.text(text('Receipt'), height: 7.mm, style: styles[:section_heading])
             col.container(height: 56.mm) do |info|
               info.text(text('Account / Payable to'), style: styles[:receipt_heading])
-              info.text("#{@data[:creditor][:iban]}\n#{address(@data[:creditor])}", style: styles[:receipt_value])
+              info.text("#{formatted_iban}\n#{address(@data[:creditor])}", style: styles[:receipt_value])
 
               if @data[:reference_type] != 'NON'
                 info.text(text('Reference'), style: styles[:receipt_heading])
@@ -506,11 +525,11 @@ module HexaPDF
             end
             col.container(height: 85.mm) do |info|
               info.text(text('Account / Payable to'), style: styles[:payment_heading])
-              info.text("#{@data[:creditor][:iban]}\n#{address(@data[:creditor])}", style: styles[:payment_value])
+              info.text("#{formatted_iban}\n#{address(@data[:creditor])}", style: styles[:payment_value])
 
               if @data[:reference_type] != 'NON'
                 info.text(text('Reference'), style: styles[:payment_heading])
-                info.text(@data[:reference], style: styles[:payment_value])
+                info.text(formatted_reference, style: styles[:payment_value])
               end
 
               if @data[:message] || @data[:billing_information]
@@ -563,6 +582,11 @@ module HexaPDF
           TEXT_LITERALS.dig(@data[:lang], str) || str
         end
 
+        # Returns the formatted IBAN.
+        def formatted_iban
+          @data[:creditor][:iban].gsub(/(.{4})/, '\1 ')
+        end
+
         # Returns a string containing the formatted address for output using the provided data.
         def address(data)
           result = +''
@@ -584,6 +608,15 @@ module HexaPDF
           a.gsub!(/(\d)(?=(\d\d\d)+(?!\d))/, "\\1 ") << '.' << b
         end
 
+        # Returns the reference field correctly formatted.
+        def formatted_reference
+          if @data[:reference_type] == 'QRR'
+            "#{@data[:reference][0, 2]} #{@data[:reference][2..-1].gsub(/(.{5})/, '\1 ').strip}"
+          else
+            @data[:reference].gsub(/(.{4})/, '\1 ').strip
+          end
+        end
+
         # Creates the content of the QR code using the information provided in #data.
         def qr_code_data
           qr_code_data = []

data/lib/hexapdf/extras/version.rb

@@ -2,6 +2,6 @@
 
 module HexaPDF
   module Extras
-    VERSION = '1.1.1'
+    VERSION = '1.1.2'
   end
 end

data/test/hexapdf/extras/layout/test_swiss_qr_bill.rb

@@ -13,7 +13,7 @@ describe HexaPDF::Extras::Layout::SwissQRBill do
   def data
     @data ||= {
      creditor: {
-       iban: "CH44 3199 9123 0008 8901 2",
+       iban: "CH4431999123000889012",
        name: "Max Muster & Söhne",
        address_line1: "Musterstrasse",
        address_line2: "123",
@@ -64,6 +64,22 @@ describe HexaPDF::Extras::Layout::SwissQRBill do
         assert_equal('NICHT ZUR ZAHLUNG VERWENDEN', create_box(data).data[:message])
       end
 
+      it "ensures the creditor value exists" do
+        data.delete(:creditor)
+        assert_invalid_data(/:creditor is missing/)
+      end
+
+      it "ensures a correct iban value in the creditor field" do
+        data[:creditor].delete(:iban)
+        assert_invalid_data(/:iban of :creditor is missing/)
+        data[:creditor][:iban] = 'CH44 319 39912300088901 2'
+        assert_invalid_data(/:iban of :creditor.*21/)
+        data[:creditor][:iban] = 'CH4431999123000889013'
+        assert_invalid_data(/:iban of :creditor.*invalid check digits/)
+        data[:creditor][:iban] = 'CH4431999123000889012'
+        assert(create_box(data))
+      end
+
       it "sets the address type to structured by default" do
         assert_equal(:structured, create_box(data, width: 10, height: 15).data[:creditor][:address_type])
       end
@@ -220,6 +236,8 @@ describe HexaPDF::Extras::Layout::SwissQRBill do
     it "works with no amount and no debtor" do
       data.delete(:debtor)
       data.delete(:amount)
+      data[:reference_type] = 'SCOR'
+      data[:reference] = 'RF48 5000056789012345'
       assert(@composer.box(:swiss_qr_bill, data: data))
     end
 

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: hexapdf-extras
 version: !ruby/object:Gem::Version
-  version: 1.1.1
+  version: 1.1.2
 platform: ruby
 authors:
 - Thomas Leitner