prawn-swiss_qr_bill 0.4.1

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

@@ -0,0 +1,88 @@
+# frozen_string_literal: true
+
+module Prawn
+  module SwissQRBill
+    module Sections
+      # Section main class which can draw itself at the right position.
+      #
+      # Subclasses shall implement the draw method with the box block:
+      #
+      #   def draw
+      #     box do
+      #       doc.text 'example'
+      #       draw_something
+      #     end
+      #   end
+      class Section
+        attr_reader :doc
+
+        # specifications for subclass' section, @see Specification for details
+        attr_accessor :specs
+
+        def initialize(document, data)
+          unless self.class.const_defined?(:KEY)
+            raise NotImplementedError, "constant KEY not defined in class #{self.class}"
+          end
+
+          @doc = document
+          @data = data
+
+          load_specs
+        end
+
+        def draw
+          raise NotImplementedError, 'Subcluss must implement draw method.'
+        end
+
+        private
+
+        def box(&block)
+          doc.bounding_box(specs.point, width: specs.width, height: specs.height, &block)
+        end
+
+        def label(text, options = {})
+          options = options.merge(
+            size: specs.label_font_size,
+            leading: specs.label_font_leading,
+            style: specs.label_font_style.to_sym
+          )
+
+          doc.text text, options
+        end
+
+        def content(text, options = {})
+          options = options.merge(
+            size: specs.content_font_size,
+            leading: specs.content_font_leading,
+            style: specs.content_font_style.to_sym
+          )
+
+          doc.text text, options
+        end
+
+        def line_spacing
+          doc.move_down specs.content_font_size + 1
+        end
+
+        def build_address(address)
+          [
+            address[:name],
+            address[:line1],
+            address[:line2],
+            [address[:postal_code], address[:city]].compact.join(' ')
+          ].compact.join("\n")
+        end
+
+        def load_specs
+          spec_factory = Prawn::SwissQRBill::Specifications.new
+
+          self.specs = spec_factory.get_specs(self.class::KEY)
+        end
+
+        def i18n_scope
+          'swiss_qr_bill'
+        end
+      end
+    end
+  end
+end

data/lib/prawn/swiss_qr_bill/sections.rb

@@ -0,0 +1,29 @@
+# frozen_string_literal: true
+
+module Prawn
+  module SwissQRBill
+    # Sections module manages all different sections.
+    module Sections
+      # All relevant classes to draw the full bill,
+      # ordered by drawing order.
+      SECTION_CLASSES = [
+        ReceiptTitle,
+        ReceiptInformation,
+        ReceiptAmount,
+        ReceiptAcceptance,
+        PaymentTitle,
+        PaymentInformation,
+        PaymentAmount,
+        PaymentFurtherInformation,
+        QRCode
+      ].freeze
+
+      # Draw all sections in the right order.
+      def self.draw_all(document, data)
+        SECTION_CLASSES.each do |klass|
+          klass.new(document, data).draw
+        end
+      end
+    end
+  end
+end

data/lib/prawn/swiss_qr_bill/specifications.rb

@@ -0,0 +1,78 @@
+# frozen_string_literal: true
+
+module Prawn
+  module SwissQRBill
+    class SpecificationError < StandardError; end
+
+    # Access common style specifications according to the style guide.
+    #
+    # Reference:
+    # https://www.paymentstandards.ch/dam/downloads/style-guide-en.pdf
+    class Specifications
+      Spec = Struct.new(:default, :format)
+
+      SPECS_FILE = 'specs.yml'
+
+      DEFAULTS = {
+        point: Spec.new(nil, ->(v) { from_mm(v) }),
+        width: Spec.new(nil, ->(v) { from_mm(v) }),
+        height: Spec.new(nil, ->(v) { from_mm(v) }),
+        content_font_size: Spec.new,
+        content_font_leading: Spec.new(0),
+        content_font_style: Spec.new(:normal, ->(v) { v.to_sym }),
+        label_font_size: Spec.new,
+        label_font_leading: Spec.new(0),
+        label_font_style: Spec.new(:bold, ->(v) { v.to_sym })
+      }.freeze
+
+      def initialize
+        @specs = load_specs
+      end
+
+      def get(spec_key)
+        @specs.dig(*key_path(spec_key)) || {}
+      end
+
+      def get_specs(spec_key)
+        # get hash from yaml by path
+        spec_values = get(spec_key)
+
+        values = {}
+        DEFAULTS.each_key do |key|
+          # set defaults
+          values[key] = DEFAULTS[key].default
+          # overwrite if set
+          values[key] = spec_values[key.to_s] if spec_values.key?(key.to_s)
+          # format
+          values[key] = DEFAULTS[key][:format].call(values[key]) if DEFAULTS[key][:format].is_a?(Proc)
+        end
+
+        spec_values = values.values_at(*DEFAULTS.keys)
+
+        Struct.new(*DEFAULTS.keys).new(*spec_values)
+      end
+
+      # Transform a value or an array of values from mm to pt
+      def self.from_mm(value)
+        case value
+        when Numeric
+          value.mm
+        when Array
+          value.map(&:mm)
+        else
+          value
+        end
+      end
+
+      private
+
+      def load_specs
+        @specs = YAML.load_file(File.expand_path(SPECS_FILE, File.dirname(__FILE__)))
+      end
+
+      def key_path(key)
+        key.split('.')
+      end
+    end
+  end
+end

data/lib/prawn/swiss_qr_bill/specs.yml

@@ -0,0 +1,106 @@
+# Style specifications according to the style guide:
+# https://www.paymentstandards.ch/dam/downloads/style-guide-en.pdf
+#
+# * All measurements in mm
+# * Origin reference point is bottom left
+width: 210
+height: 105
+receipt:
+  # x: always 0, or 5
+  # y: 105 (height)
+  point: [0, 105]
+  width: 62
+  height: 105
+  name: Receipt
+  title:
+    name: Title section
+    # y: 105 - 5
+    point: [5, 100]
+    width: 52
+    height: 7
+    content_font_size: 11
+    content_font_style: bold
+  information:
+    name: Information section
+    # y: 105 - 5 - 7
+    point: [5, 93]
+    width: 52
+    height: 56
+    content_font_size: 8
+    content_font_leading: 1
+    label_font_size: 6
+    label_font_style: bold
+  amount:
+    name: Amount section
+    # y: 105 - 5 - 7 - 56
+    point: [5, 37]
+    width: 52
+    height: 14
+    label_font_size: 6
+    # label_font_leading: 2
+    content_font_size: 8
+  acceptance:
+    name: Acceptance point section
+    # y: 105 - 5 - 7 - 56 - 14
+    point: [5, 23]
+    width: 52
+    height: 18
+    label_font_size: 6
+payment:
+  # x: 62
+  # y: 105 (height)
+  point: [62, 105]
+  width: 148
+  height: 105
+  name: Payment
+  title:
+    name: Title section
+    # x: 62 + 5
+    # y: 105 - 5
+    point: [67, 100]
+    width: 51
+    height: 7
+    content_font_size: 11
+    content_font_style: bold
+  information:
+    name: Information section
+    # x: 62 + 5 + 51
+    # y: 105 - 5
+    point: [118, 100]
+    width: 87
+    height: 85
+    content_font_size: 10
+    content_font_leading: 1
+    label_font_size: 8
+    label_font_weight: bold
+  qr_code:
+    name: Swiss QR code section
+    # x: 62 + 5
+    # y: 105 - 5 - 7 - 5
+    point: [67, 88]
+    width: 46
+    height: 46
+  qr_cross:
+    # Swiss Cross on QR code
+    # x: 62 + 5 + ((46 - 7) / 2)
+    # y: 105 - 5 - 7 - 5 - ((46 - 7) / 2)
+    point: [86.5, 68.5]
+    width: 7
+    height: 7
+  amount:
+    name: Amount section
+    # x: 62 + 5
+    # y: 105 - 5 - 7 - 56
+    point: [67, 37]
+    width: 51
+    height: 22
+    label_font_size: 8
+    content_font_size: 10
+    content_font_leading: 3
+  further_information:
+    name: Further information section
+    # x: 62 + 5
+    # y: 105 - 5 - 7 - 56 - 22
+    point: [67, 15]
+    width: 138
+    height: 10

data/lib/prawn/swiss_qr_bill/version.rb

@@ -0,0 +1,7 @@
+# frozen_string_literal: true
+
+module Prawn
+  module SwissQRBill
+    VERSION = '0.4.1'
+  end
+end

data/lib/prawn/swiss_qr_bill.rb

@@ -0,0 +1,43 @@
+# frozen_string_literal: true
+
+require 'i18n'
+I18n.load_path << Dir[File.join(File.expand_path("#{File.dirname(__FILE__)}/../../config/locales"), '*.yml')]
+I18n.load_path.flatten!
+
+require 'yaml'
+require 'rqrcode'
+
+require 'prawn'
+require 'prawn/measurement_extensions'
+
+require 'prawn/swiss_qr_bill/version'
+
+require 'prawn/swiss_qr_bill/helpers/number_helper'
+require 'prawn/swiss_qr_bill/helpers/box_helper'
+
+require 'prawn/swiss_qr_bill/qr/data'
+require 'prawn/swiss_qr_bill/iban'
+require 'prawn/swiss_qr_bill/padded_box'
+require 'prawn/swiss_qr_bill/corner_box'
+require 'prawn/swiss_qr_bill/cutting_lines'
+require 'prawn/swiss_qr_bill/sections/section'
+require 'prawn/swiss_qr_bill/sections/receipt_title'
+require 'prawn/swiss_qr_bill/sections/receipt_information'
+require 'prawn/swiss_qr_bill/sections/receipt_amount'
+require 'prawn/swiss_qr_bill/sections/receipt_acceptance'
+require 'prawn/swiss_qr_bill/sections/payment_title'
+require 'prawn/swiss_qr_bill/sections/payment_information'
+require 'prawn/swiss_qr_bill/sections/payment_amount'
+require 'prawn/swiss_qr_bill/sections/payment_further_information'
+require 'prawn/swiss_qr_bill/sections/qr_code'
+require 'prawn/swiss_qr_bill/sections'
+require 'prawn/swiss_qr_bill/debug_section'
+require 'prawn/swiss_qr_bill/specifications'
+require 'prawn/swiss_qr_bill/extension'
+require 'prawn/swiss_qr_bill/bill'
+
+# PrawnPDF: https://github.com/prawnpdf/prawn
+module Prawn
+end
+
+Prawn::Document.extensions << Prawn::SwissQRBill::Extension

data/prawn-swiss_qr_bill.gemspec

@@ -0,0 +1,40 @@
+# frozen_string_literal: true
+
+require File.expand_path('lib/prawn/swiss_qr_bill/version', __dir__)
+
+Gem::Specification.new do |spec|
+  spec.name = 'prawn-swiss_qr_bill'
+  spec.version = Prawn::SwissQRBill::VERSION
+  spec.platform = Gem::Platform::RUBY
+  spec.required_ruby_version = '>= 2.5.0'
+  spec.summary = 'Swiss QR-Bill PDFs in Ruby with Prawn'
+  spec.description = 'Ruby library for creating Swiss QR-Bills as PDF with Prawn'
+  spec.homepage = 'https://github.com/mitosch/prawn-swiss_qr_bill'
+  spec.license = 'MIT'
+  spec.authors = ['Mischa Schindowski']
+  spec.email = ['mschindowski@gmail.com']
+
+  spec.files = Dir['lib/**/**/*.rb',
+                   'lib/prawn/swiss_qr_bill/specs.yml',
+                   'lib/prawn/swiss_qr_bill/images/*.png',
+                   'config/locales/*.yml',
+                   'prawn-swiss_qr_bill.gemspec',
+                   'Gemfile', 'README.md', 'CHANGELOG.mg'
+                  ]
+
+  spec.add_dependency 'i18n', '~> 1.8'
+  spec.add_dependency 'prawn', '~> 2.0'
+  spec.add_dependency 'rqrcode', '~> 2.0'
+
+  spec.add_development_dependency 'pdf-reader', '~> 2.3'
+  spec.add_development_dependency 'rspec', '~> 3.0'
+  spec.add_development_dependency 'rubocop', '~> 1.0'
+  spec.add_development_dependency 'rubocop-performance', '~> 1.5'
+  spec.add_development_dependency 'rubocop-rspec', '~> 2.8'
+  spec.add_development_dependency 'simplecov', '~> 0.16'
+  spec.add_development_dependency 'simplecov-cobertura', '~> 2.0'
+
+  spec.metadata = {
+    'rubygems_mfa_required' => 'true'
+  }
+end

metadata

@@ -0,0 +1,218 @@
+--- !ruby/object:Gem::Specification
+name: prawn-swiss_qr_bill
+version: !ruby/object:Gem::Version
+  version: 0.4.1
+platform: ruby
+authors:
+- Mischa Schindowski
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2022-02-18 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: i18n
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.8'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.8'
+- !ruby/object:Gem::Dependency
+  name: prawn
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.0'
+- !ruby/object:Gem::Dependency
+  name: rqrcode
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.0'
+- !ruby/object:Gem::Dependency
+  name: pdf-reader
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.3'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.3'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+- !ruby/object:Gem::Dependency
+  name: rubocop
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.0'
+- !ruby/object:Gem::Dependency
+  name: rubocop-performance
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.5'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.5'
+- !ruby/object:Gem::Dependency
+  name: rubocop-rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.8'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.8'
+- !ruby/object:Gem::Dependency
+  name: simplecov
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.16'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.16'
+- !ruby/object:Gem::Dependency
+  name: simplecov-cobertura
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.0'
+description: Ruby library for creating Swiss QR-Bills as PDF with Prawn
+email:
+- mschindowski@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- Gemfile
+- README.md
+- config/locales/de.yml
+- config/locales/en.yml
+- config/locales/fr.yml
+- config/locales/it.yml
+- lib/prawn/swiss_qr_bill.rb
+- lib/prawn/swiss_qr_bill/bill.rb
+- lib/prawn/swiss_qr_bill/corner_box.rb
+- lib/prawn/swiss_qr_bill/cutting_lines.rb
+- lib/prawn/swiss_qr_bill/debug_section.rb
+- lib/prawn/swiss_qr_bill/extension.rb
+- lib/prawn/swiss_qr_bill/helpers/box_helper.rb
+- lib/prawn/swiss_qr_bill/helpers/number_helper.rb
+- lib/prawn/swiss_qr_bill/iban.rb
+- lib/prawn/swiss_qr_bill/images/scissor.png
+- lib/prawn/swiss_qr_bill/images/swiss_cross.png
+- lib/prawn/swiss_qr_bill/padded_box.rb
+- lib/prawn/swiss_qr_bill/qr/data.rb
+- lib/prawn/swiss_qr_bill/sections.rb
+- lib/prawn/swiss_qr_bill/sections/payment_amount.rb
+- lib/prawn/swiss_qr_bill/sections/payment_further_information.rb
+- lib/prawn/swiss_qr_bill/sections/payment_information.rb
+- lib/prawn/swiss_qr_bill/sections/payment_title.rb
+- lib/prawn/swiss_qr_bill/sections/qr_code.rb
+- lib/prawn/swiss_qr_bill/sections/receipt_acceptance.rb
+- lib/prawn/swiss_qr_bill/sections/receipt_amount.rb
+- lib/prawn/swiss_qr_bill/sections/receipt_information.rb
+- lib/prawn/swiss_qr_bill/sections/receipt_title.rb
+- lib/prawn/swiss_qr_bill/sections/section.rb
+- lib/prawn/swiss_qr_bill/specifications.rb
+- lib/prawn/swiss_qr_bill/specs.yml
+- lib/prawn/swiss_qr_bill/version.rb
+- prawn-swiss_qr_bill.gemspec
+homepage: https://github.com/mitosch/prawn-swiss_qr_bill
+licenses:
+- MIT
+metadata:
+  rubygems_mfa_required: 'true'
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 2.5.0
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.0.3.1
+signing_key: 
+specification_version: 4
+summary: Swiss QR-Bill PDFs in Ruby with Prawn
+test_files: []