ubill 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: e23f48847054bf7e4f64599585d697f2eb918f13cb080a21818cc27c6da88738
+  data.tar.gz: 5043034a212d8766fa4a0d1f400fbb92c7507656472e7ad40313165bfaddab7a
+SHA512:
+  metadata.gz: b38c22365eebd461ed42f8ab2cc671abaa0f37bf821ad9ead7dd11645d7f9805b07a595aeabdab40fea01576ad2c066f7dd92c96685444ea9bdb3278da6b176b
+  data.tar.gz: f921dc75d70feae1d634c9f51625eceef7414d5e905a7fd3ee35e82ed45cc8e6c0b043fdc4a2fedc0627deeb7ba3d5a32b5cd9997cadca4678c4b913dfaf536e

data/.rspec

@@ -0,0 +1,3 @@
+--format documentation
+--color
+--require spec_helper

data/Gemfile

@@ -0,0 +1,11 @@
+# frozen_string_literal: true
+
+source "https://rubygems.org"
+
+# Specify your gem's dependencies in ubill.gemspec
+gemspec
+
+gem "rake", "~> 13.0"
+gem "rspec", "~> 3.0"
+gem "ruby-debug-ide", require: false
+gem "debase", "0.2.5.beta2", require: false

data/Gemfile.lock

@@ -0,0 +1,52 @@
+PATH
+  remote: .
+  specs:
+    ubill (0.1.0)
+      matrix (~> 0.4)
+      prawn (~> 2.4)
+      prawn-table (~> 0.2)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    debase (0.2.5.beta2)
+      debase-ruby_core_source (>= 0.10.12)
+    debase-ruby_core_source (3.2.0)
+    diff-lcs (1.5.0)
+    matrix (0.4.2)
+    pdf-core (0.9.0)
+    prawn (2.4.0)
+      pdf-core (~> 0.9.0)
+      ttfunk (~> 1.7)
+    prawn-table (0.2.2)
+      prawn (>= 1.3.0, < 3.0.0)
+    rake (13.0.6)
+    rspec (3.12.0)
+      rspec-core (~> 3.12.0)
+      rspec-expectations (~> 3.12.0)
+      rspec-mocks (~> 3.12.0)
+    rspec-core (3.12.2)
+      rspec-support (~> 3.12.0)
+    rspec-expectations (3.12.3)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.12.0)
+    rspec-mocks (3.12.5)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.12.0)
+    rspec-support (3.12.0)
+    ruby-debug-ide (0.7.3)
+      rake (>= 0.8.1)
+    ttfunk (1.7.0)
+
+PLATFORMS
+  x86_64-linux
+
+DEPENDENCIES
+  debase (= 0.2.5.beta2)
+  rake (~> 13.0)
+  rspec (~> 3.0)
+  ruby-debug-ide
+  ubill!
+
+BUNDLED WITH
+   2.4.10

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2023 couchbelag
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in
+all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+THE SOFTWARE.

data/README.md

@@ -0,0 +1,120 @@
+# Ubill
+
+PDF Invoice generator.
+
+
+## Installation
+
+Install the gem and add to the application's Gemfile by executing:
+
+```bash
+$ bundle add ubill
+```
+
+If bundler is not being used to manage dependencies, install the gem by executing:
+
+```bash
+$ gem install ubill
+```
+
+
+## Configuration
+
+Configuration must to be executed only once! Put it into a rails initializer if possible.
+
+```ruby
+# configure pdf invoice generation
+Ubill.configure do
+  page_size "A4"
+  footer.configure do
+    # add one or more lines to footer
+    add_line do
+      # add items to a line in the footer,
+      # items will be separated by dots
+      append "rechnung GmbH", styles: [:bold]
+      append "Mattermoststraße 23"
+      append "12345 Demoburg"
+      append "info@example.org"
+      append "www.example.org"
+    end
+    add_line do
+      append "Geschäftsführer Fried Hof, Holger Manen, Manfred Erike"
+    end
+    add_line do
+      append "HRB 4711"
+      append "Amtsgericht Jurahausen"
+      append "Steuernummer 123/456/78900"
+    end
+  end
+  header.configure do
+    # header's left should be set to company name
+    # header's right should contain sender address
+    left "rechnung GmbH"
+    right do
+        append "Mattermoststraße 23"
+        append "12345 Demoburg"
+        append "info@example.org"
+    end
+  end
+  account.configure do
+    # configure bank account to which payments
+    # should be sent
+    recipient "rechnung GmbH"
+    iban "DE081547114200"
+    bic "ACCOUNTXXX"
+  end
+end
+```
+
+
+## Usage
+
+```ruby
+# Instantiate a new Invoice, this will use the
+# settings configured above.
+doc = Ubill::Invoice.new do
+  # subject of the invoice, most probably that's
+  # the invoice number. an additional info can be
+  # provided which will be displayed just below subject
+  # in a smaller font size
+  subject("Rechnung R1234567890", "Rechnungsdatum 01.01.2100")
+  # recipient address
+  recipient(
+    company: "Spielvereinigung Demoburg e.V.",
+    name: "Tobi Ornottobi",
+    department: "Dept. Purchase",
+    street_1: "Highwaytohell 2",
+    street_2: "Room 3.12",
+    zip: "12345",
+    city: "Coruscant",
+    country: "Galactic Empire"
+  )
+  # add positions to invoice. prices, units or any other
+  # numbers should be provided as strings, as we do not
+  # interpret numbers with locale settings. There is also
+  # no summing up of positions to totals! you have to
+  # calculate and provide totals all by yourselves!
+  4.times do |idx|
+    position(
+        # name, context and description are rendered into
+        # one cell in the table as consecutive lines
+        name: "Standard Abonnement",
+        context: "SpVgg Demoburg -- Platz #{idx+1}",
+        description: "Standard Abonnement für ein Jahr",
+        price_per_unit: "7,50 € / Monat",
+        units: "12",
+        price: "90,00 €"
+    )
+  end
+  # you have to calculate and provide totals all by yourselves!
+  total "180,00 €"
+  due "24.12.2100"
+end
+
+# save document
+doc.save_as("invoice.pdf")
+```
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).

data/Rakefile

@@ -0,0 +1,13 @@
+# frozen_string_literal: true
+
+require "bundler/gem_tasks"
+require "rspec/core/rake_task"
+
+RSpec::Core::RakeTask.new(:spec)
+
+task default: :spec
+
+desc "returns current version number as defined in lib/ubil/version.rb"
+task :version do
+  puts Ubill::VERSION
+end

data/lib/hash.rb

@@ -0,0 +1,19 @@
+class Hash
+  def each_with_filter(*filter, &block)
+    filter.each do |key|
+      if key.is_a?(Array)
+        values = key.map do |k|
+          self.fetch(k) if has_key?(k)
+        end
+        values.compact!
+        block.call(key, values.join(" "))
+      else
+        with(key, &block)
+      end
+    end
+  end
+
+  def with(key)
+    yield(key, fetch(key)) if has_key?(key)
+  end
+end

data/lib/ubill/account.rb

@@ -0,0 +1,22 @@
+require_relative "line"
+
+module Ubill
+  class Account
+    include Ubill::Concerns::Configurable
+
+    def recipient(value=nil)
+      @recipient = value unless value.nil?
+      @recipient
+    end
+
+    def iban(value=nil)
+      @iban = value unless value.nil?
+      @iban
+    end
+
+    def bic(value=nil)
+      @bic = value unless value.nil?
+      @bic
+    end
+  end
+end

data/lib/ubill/concerns/configurable.rb

@@ -0,0 +1,10 @@
+module Ubill
+  module Concerns
+    module Configurable
+      def configure(&block)
+        self.instance_eval(&block)
+        self
+      end
+    end
+  end
+end

data/lib/ubill/configuration.rb

@@ -0,0 +1,49 @@
+require_relative "header"
+require_relative "footer"
+require_relative "account"
+
+module Ubill
+  def self.configure(&block)
+    @config ||= Configuration.new
+    @config.instance_eval(&block)
+  end
+
+  def self.config
+    @config ||= Configuration.new
+  end
+
+  class Configuration
+    attr_accessor :options
+
+    def initialize
+      self.options = {
+        page_size: "A4",
+        margin: [2.8.cm, 2.8.cm, 3.2.cm, 2.8.cm]
+      }
+    end
+
+    def page_size(value)
+      options[:page_size] = value
+    end
+
+    def footer
+      @footer ||= Footer.new
+    end
+
+    def header
+      @header ||= Header.new
+    end
+
+    def account
+      @account ||= Account.new
+    end
+
+    def debug_bounding_boxes
+      @debug_bounding_boxes = true
+    end
+
+    def debug_bounding_boxes?
+      @debug_bounding_boxes || false
+    end
+  end
+end

data/lib/ubill/footer.rb

@@ -0,0 +1,19 @@
+require_relative "line"
+
+module Ubill
+  class Footer
+    include Ubill::Concerns::Configurable
+
+    attr_accessor :lines
+
+    def initialize
+      self.lines = []
+    end
+
+    def add_line(&block)
+      line = Line.new
+      line.instance_eval(&block)
+      self.lines << line
+    end
+  end
+end

data/lib/ubill/header.rb

@@ -0,0 +1,22 @@
+require_relative "line"
+
+module Ubill
+  class Header
+    include Ubill::Concerns::Configurable
+
+    attr_accessor :left_text, :right_text
+
+    def initialize
+      self.left_text = ""
+      self.right_text = Line.new
+    end
+
+    def left(value)
+      self.left_text = value
+    end
+
+    def right(&block)
+      right_text.instance_eval(&block)
+    end
+  end
+end

data/lib/ubill/invoice.rb

@@ -0,0 +1,242 @@
+require "prawn"
+require "prawn/table"
+require "prawn/measurement_extensions"
+
+require "json"
+
+module Ubill
+  class Invoice
+    include Prawn::View
+    include Ubill::Concerns::Configurable
+
+    COLOR_SECONDARY = "777777"
+    EXTERNAL_FONTS_DIR = File.join(__dir__, "fonts")
+
+    def initialize(&block)
+      super
+      @recipient = {}
+      @subject = ""
+      @subject_info = ""
+      @positions = [["#", "Beschreibung", "Einzelpreis", "Menge", "Gesamt"]]
+      @total = ""
+      @due = ""
+
+      load_external_font_families
+
+      configure(&block) unless block.nil?
+    end
+
+    def recipient(**options)
+      @recipient.merge!(options)
+    end
+
+    def subject(title, subtitle=nil)
+      @subject = title
+      @subject_info = subtitle
+    end
+
+    def position(name:, context:, description:, price_per_unit:, units:, price:)
+      @positions << [
+        @positions.size,
+        "<b>#{name}</b><font size=\"9\">\n#{context}\n#{description}</font>",
+        price_per_unit,
+        units,
+        price
+      ]
+    end
+
+    def total(value)
+      @total = value
+    end
+
+    def due(value)
+      @due = value
+    end
+
+
+    def config
+      Ubill.config
+    end
+
+    def document
+      @doc ||= Prawn::Document.new(config.options)
+    end
+
+    def width
+      bounds.top_right[0]
+    end
+
+    def height
+      bounds.top_left[1]
+    end
+
+    def margin_top
+      config.options[:margin][0]
+    end
+
+    def margin_right
+      config.options[:margin][1]
+    end
+
+    def margin_bottom
+      config.options[:margin][2]
+    end
+
+    def margin_left
+      config.options[:margin][3]
+    end
+
+    def save_as(*args, **options)
+      describe
+      super
+    end
+
+    def render(*args, **options)
+      describe
+      super
+    end
+
+    private
+      def load_external_font_families
+        Dir.glob(File.join(EXTERNAL_FONTS_DIR, "*")) do |family_dir|
+          family = File.basename(family_dir)
+          files = {}
+          Dir.glob(File.join(family_dir, "*.ttf")) do |file|
+            style = File.basename(file, ".*")
+            files[style.to_sym] = file
+          end
+          font_families.update(family => files)
+        end
+      end
+
+      def describe
+        default_leading 0.mm
+        default_kerning true
+
+        font "OpenSans"
+
+        describe_header
+        move_down 9.mm
+        pad 9.mm do
+          describe_address
+        end
+        pad 9.mm do
+          describe_subject
+        end
+        pad 9.mm do
+          describe_positions
+        end
+        pad 2.mm do
+          describe_terms
+        end
+        pad 2.mm do
+          describe_payment
+        end
+        describe_footer
+      end
+
+      def describe_header
+        repeat(:all) do
+          bounding_box([0, height + margin_top], width: width/3, height: margin_top - 1.cm) do
+            stroke_bounds if config.debug_bounding_boxes?
+            text config.header.left_text, style: :bold, align: :left, valign: :bottom, size: 13, color: COLOR_SECONDARY
+          end
+        end
+        bounding_box([width/3, height + margin_top], width: width/3*2, height: margin_top - 1.cm) do
+          stroke_bounds if config.debug_bounding_boxes?
+          formatted_text config.header.right_text, align: :right, valign: :bottom, size: 8, color: COLOR_SECONDARY
+        end
+      end
+
+      def describe_address
+        @recipient.each_with_filter(
+          :company, :name, [:firstname, :lastname], :department, :street_1, :street_2, [:zip, :city], :country
+        ) do |key, value|
+          move_down 0.3.cm if key.is_a?(Array) && key.eql?([:zip, :city])
+          text value, size: 10
+        end
+      end
+
+      def describe_subject
+        text @subject, size: 11, style: :bold
+        text @subject_info, size: 8
+      end
+
+      def describe_positions
+        data = @positions + [[{content: "Gesamtbetrag:", colspan: 4}, @total]]
+        table(data,
+          width: width,
+          header: true,
+          cell_style: {inline_format: true, size: 10}
+        ) do
+          cells.borders = [:bottom]
+          cells.border_color = "555555"
+          cells.border_width = 0.3
+          row(0).border_width = 0.88
+          row(0).font_style = :bold
+          row(0).size = 11
+          row(data.size-1).borders = [:top]
+          row(data.size-1).border_width = 0.88
+          row(data.size-1).font_style = :bold
+          cells.style do |cell|
+            if cell.column == 2
+              cell.style width: 30.mm, align: :right
+            end
+
+            if cell.column == 3
+              cell.style width: 20.mm, align: :right
+            end
+
+            if cell.column == 4
+              cell.style width: 25.mm, align: :right
+            end
+
+            if cell.row == data.size-1
+              cell.style align: :right
+            end
+          end
+        end
+      end
+
+      def describe_terms
+        font_size 10
+        text "Es wird gemäß §19 Abs. 1 Umsatzsteuergesetz keine Umsatzsteuer erhoben. Der Gesamtbetrag der Rechnung ist zahlbar bis zum #{@due} ohne Abzug. Wenn nicht anders angegeben, entspricht das Leistungsdatum dem Rechnungsdatum."
+      end
+
+      def describe_payment
+        font_size 10
+        text "Bitte überweisen Sie den Gesamtbetrag an:"
+        move_down 1.mm
+        table(
+          [
+            ["Empfänger:", config.account.recipient],
+            ["IBAN:", config.account.iban],
+            ["BIC/SWIFT:", config.account.bic],
+            ["Verwendungszweck:", @subject]
+          ],
+          cell_style: {size: 10}
+        ) do
+          cells.borders = []
+          cells.padding = [0, 0, 0.75.mm, 0]
+          cells.style do |cell|
+            if cell.column == 0
+              cell.style padding_left: 12.mm
+            else
+              cell.style padding_left: 8.mm
+            end
+          end
+        end
+      end
+
+      def describe_footer
+        repeat(:all) do
+          bounding_box([0, -1.cm], width: width, height: margin_bottom - 1.cm) do
+            stroke_bounds if config.debug_bounding_boxes?
+            config.footer.lines.each do |line|
+              formatted_text line, align: :center, size: 8, color: COLOR_SECONDARY
+            end
+          end
+        end
+      end
+  end
+end

data/lib/ubill/line.rb

@@ -0,0 +1,16 @@
+module Ubill
+  class Line < Array
+    def append(item, **options)
+      unless self.empty?
+        self << {text: " • ", character_spacing: 1.mm}
+      end
+
+      # don't know why, but sometimes there appears an additional
+      # space after the item. seems to be a certain combination of
+      # characters, maybe problems with UTF-8? However, if \0 is
+      # appended symptom vanishes.
+      options[:text] = "#{item}\0"
+      self << options
+    end
+  end
+end

data/lib/ubill/version.rb

@@ -0,0 +1,5 @@
+# frozen_string_literal: true
+
+module Ubill
+  VERSION = "0.1.0"
+end

data/lib/ubill.rb

@@ -0,0 +1,17 @@
+# frozen_string_literal: true
+
+
+CONCERNS_PATH = File.join(__dir__, "ubill", "concerns", "**", "*.rb")
+Dir.glob(CONCERNS_PATH) do |path|
+  require_relative path
+end
+
+require_relative "hash"
+require_relative "ubill/configuration"
+require_relative "ubill/invoice"
+require_relative "ubill/version"
+
+module Ubill
+  class Error < StandardError; end
+  # Your code goes here...
+end

data/sig/ubill.rbs

@@ -0,0 +1,4 @@
+module Ubill
+  VERSION: String
+  # See the writing guide of rbs: https://github.com/ruby/rbs#guides
+end

metadata

@@ -0,0 +1,109 @@
+--- !ruby/object:Gem::Specification
+name: ubill
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- couchbelag
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2023-05-12 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: prawn
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.4'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.4'
+- !ruby/object:Gem::Dependency
+  name: prawn-table
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.2'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.2'
+- !ruby/object:Gem::Dependency
+  name: matrix
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.4'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.4'
+description: PDF invoice generator by ubity UG (https://ubity.io).
+email:
+- ts@ubity.io
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".rspec"
+- Gemfile
+- Gemfile.lock
+- LICENSE.txt
+- README.md
+- Rakefile
+- lib/hash.rb
+- lib/ubill.rb
+- lib/ubill/account.rb
+- lib/ubill/concerns/configurable.rb
+- lib/ubill/configuration.rb
+- lib/ubill/fonts/OpenSans/bold.ttf
+- lib/ubill/fonts/OpenSans/bold_italic.ttf
+- lib/ubill/fonts/OpenSans/italic.ttf
+- lib/ubill/fonts/OpenSans/normal.ttf
+- lib/ubill/footer.rb
+- lib/ubill/header.rb
+- lib/ubill/invoice.rb
+- lib/ubill/line.rb
+- lib/ubill/version.rb
+- sig/ubill.rbs
+homepage: https://gitlab.com/ubity/gems/ubill
+licenses:
+- MIT
+metadata:
+  homepage_uri: https://gitlab.com/ubity/gems/ubill
+  source_code_uri: https://gitlab.com/ubity/gems/ubill
+  changelog_uri: https://gitlab.com/ubity/gems/ubill
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 3.1.3
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.3.26
+signing_key: 
+specification_version: 4
+summary: PDF invoice generator.
+test_files: []