invoice_printer 0.0.8 → 0.0.9

data/examples/international_invoice.rb

@@ -0,0 +1,84 @@
+#!/usr/bin/env ruby
+# This is an example of a international invoice with Czech labels and English translation.
+#
+# Due to the special characters it requires Overpass-Regular.ttf font to be
+# present in this directory.
+
+lib = File.expand_path('../../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'invoice_printer'
+
+labels = {
+  name: 'Faktura',
+  provider: 'Prodejce',
+  purchaser: 'Kupující',
+  tax_id: 'IČ',
+  tax_id2: 'DIČ',
+  payment: 'Forma úhrady',
+  payment_by_transfer: 'Platba na následující účet:',
+  account_number: 'Číslo účtu',
+  issue_date: 'Datum vydání',
+  due_date: 'Datum splatnosti',
+  item: 'Položka',
+  quantity: 'Počet',
+  unit: 'MJ',
+  price_per_item: 'Cena za položku',
+  amount: 'Celkem bez daně',
+  subtotal: 'Cena bez daně',
+  tax: 'DPH 21 %',
+  total: 'Celkem'
+}
+
+# Default English labels as sublabels
+sublabels = InvoicePrinter::PDFDocument::DEFAULT_LABELS
+labels.merge!({ sublabels: sublabels })
+
+first_item = InvoicePrinter::Document::Item.new(
+  name: 'Konzultace',
+  quantity: '2',
+  unit: 'hod',
+  price: 'Kč 500',
+  amount: 'Kč 1.000'
+)
+
+second_item = InvoicePrinter::Document::Item.new(
+  name: 'Programování',
+  quantity: '10',
+  unit: 'hod',
+  price: 'Kč 900',
+  amount: 'Kč 9.000'
+)
+
+invoice = InvoicePrinter::Document.new(
+  number: 'č. 198900000001',
+  provider_name: 'Petr Nový',
+  provider_tax_id: '56565656',
+  provider_street: 'Rolnická',
+  provider_street_number: '1',
+  provider_postcode: '747 05',
+  provider_city: 'Opava',
+  provider_city_part: 'Kateřinky',
+  purchaser_name: 'Adam Černý',
+  purchaser_street: 'Ostravská',
+  purchaser_street_number: '1',
+  purchaser_postcode: '747 70',
+  purchaser_city: 'Opava',
+  issue_date: '05/03/2016',
+  due_date: '19/03/2016',
+  subtotal: 'Kč 10.000',
+  tax: 'Kč 2.100',
+  total: 'Kč 12.100,-',
+  bank_account_number: '156546546465',
+  account_iban: 'IBAN464545645',
+  account_swift: 'SWIFT5456',
+  items: [first_item, second_item],
+  note: 'Osoba je zapsána v živnostenském rejstříku.'
+)
+
+InvoicePrinter.print(
+  document: invoice,
+  labels: labels,
+  font: File.expand_path('../Overpass-Regular.ttf', __FILE__),
+  logo: 'prawn.png',
+  file_name: 'international_invoice.pdf'
+)

data/examples/simple_invoice.rb

@@ -35,6 +35,6 @@ invoice = InvoicePrinter::Document.new(
 
 InvoicePrinter.print(
   document: invoice,
-  logo: 'example.jpg',
+  logo: 'prawn.png',
   file_name: 'simple_invoice.pdf'
 )

data/lib/invoice_printer/pdf_document.rb

@@ -44,7 +44,8 @@ module InvoicePrinter
       tax3: 'Tax 3',
       amount: 'Amount',
       subtotal: 'Subtotal',
-      total: 'Total'
+      total: 'Total',
+      sublabels: {}
     }
 
     def self.labels
@@ -66,7 +67,7 @@ module InvoicePrinter
       raise InvalidInput, 'document is not a type of InvoicePrinter::Document' \
         unless @document.is_a?(InvoicePrinter::Document)
 
-      if @logo && !@logo.empty?
+      if used? @logo
         if File.exist?(@logo)
           @logo = logo
         else
@@ -74,7 +75,7 @@ module InvoicePrinter
         end
       end
 
-      if @font && !@font.empty?
+      if used? @font
         if File.exist?(@font)
           set_fonts(@font) if @font
         else
@@ -129,7 +130,10 @@ module InvoicePrinter
       build_footer
     end
 
-    # Build the document name and number
+    # Build the document name and number at the top:
+    #
+    #   NAME                      NO. 901905374583579
+    #   Sublabel name
     def build_header
       @pdf.text_box(
         @labels[:name],
@@ -138,6 +142,17 @@ module InvoicePrinter
         width: 300,
         align: :left
       )
+
+      if used? @labels[:sublabels][:name]
+        @pdf.text_box(
+          @labels[:sublabels][:name],
+          size: 12,
+          at: [0, 720 - @push_down - 22],
+          width: 300,
+          align: :left
+        )
+      end
+
       @pdf.text_box(
         @document.number,
         size: 20,
@@ -146,34 +161,47 @@ module InvoicePrinter
         align: :right
       )
       @pdf.move_down(250)
+
+      if used? @labels[:sublabels][:name]
+        @pdf.move_down(12)
+      end
     end
 
     # Build the following provider box:
     #
-    #    -------------------------------------
-    #   | Provider                            |
-    #   | PROVIDER co.                        |
-    #   | 5th Street                          |
-    #   | 747 27    City                      |
-    #   |           Part of the city          |
-    #   |                                     |
-    #   | Identification number: Number       |
-    #   | Identification number: Number 2     |
-    #    -------------------------------------
+    #    ------------------------------------------
+    #   | Provider        Optinal provider sublabel|
+    #   | PROVIDER co.                             |
+    #   | 5th Street                               |
+    #   | 747 27    City                           |
+    #   |           Part of the city               |
+    #   |                                          |
+    #   | Identification number: Number            |
+    #   | Identification number: Number 2          |
+    #    ------------------------------------------
     #
     def build_provider_box
       @pdf.text_box(
-        @labels[:provider],
-        size: 10,
-        at: [10, 660 - @push_down],
+        @document.provider_name,
+        size: 15,
+        at: [10, 640 - @push_down],
         width: 240
       )
       @pdf.text_box(
-        @document.provider_name,
-        size: 14,
-        at: [10, 640 - @push_down],
+        @labels[:provider],
+        size: 11,
+        at: [10, 660 - @push_down],
         width: 240
       )
+      if used? @labels[:sublabels][:provider]
+        @pdf.text_box(
+            @labels[:sublabels][:provider],
+            size: 10,
+            at: [10, 660 - @push_down],
+            width: 250,
+            align: :right
+          )
+      end
       @pdf.text_box(
         "#{@document.provider_street}    #{@document.provider_street_number}",
         size: 10,
@@ -229,30 +257,39 @@ module InvoicePrinter
 
     # Build the following purchaser box:
     #
-    #    -------------------------------------
-    #   | Purchaser                           |
-    #   | PURCHASER co.                       |
-    #   | 5th Street                          |
-    #   | 747 27    City                      |
-    #   |           Part of the city          |
-    #   |                                     |
-    #   | Identification number: Number       |
-    #   | Identification number: Number 2     |
-    #    -------------------------------------
+    #    -------------------------------------------
+    #   | Purchaser      Optinal purchaser sublabel|
+    #   | PURCHASER co.                            |
+    #   | 5th Street                               |
+    #   | 747 27    City                           |
+    #   |           Part of the city               |
+    #   |                                          |
+    #   | Identification number: Number            |
+    #   | Identification number: Number 2          |
+    #    ------------------------------------------
     #
     def build_purchaser_box
       @pdf.text_box(
-        @labels[:purchaser],
-        size: 10,
-        at: [290, 660 - @push_down],
+        @document.purchaser_name,
+        size: 15,
+        at: [290, 640 - @push_down],
         width: 240
       )
       @pdf.text_box(
-        @document.purchaser_name,
-        size: 14,
-        at: [290, 640 - @push_down],
+        @labels[:purchaser],
+        size: 11,
+        at: [290, 660 - @push_down],
         width: 240
       )
+
+      if used? @labels[:sublabels][:purchaser]
+        @pdf.text_box(
+            @labels[:sublabels][:purchaser],
+            size: 10,
+            at: [10, 660 - @push_down],
+            align: :right
+          )
+      end
       @pdf.text_box(
         "#{@document.purchaser_street}    #{@document.purchaser_street_number}",
         size: 10,
@@ -310,14 +347,27 @@ module InvoicePrinter
     #
     #    -----------------------------------------
     #   | Payment on the following bank account:  |
-    #   | Number: 3920392032                      |
-    #   | SWIFT: ...                              |
-    #   | IBAN: ...                               |
+    #   | Number:                       3920392032|
+    #   | Optional number sublabel                |
+    #   | SWIFT:                                xy|
+    #   | Optional SWIFT sublabel                 |
+    #   | IBAN:                                 xy|
+    #   | Optional IBAN sublabel                  |
     #    -----------------------------------------
     #
     # If the bank account number is not provided include a note about payment
     # in cash.
     def build_payment_method_box
+      @push_down -= 3
+
+      # Match the height of next box if needed
+      # TODO: it's smaller without sublabels
+      min_height = 60
+      if used?(@document.issue_date) || used?(@document.due_date)
+        min_height = (used?(@document.issue_date) && used?(@document.due_date)) ? 75 : 60
+      end
+      @payment_box_height = min_height
+
       if @document.bank_account_number.empty?
         @pdf.text_box(
           @labels[:payment],
@@ -333,8 +383,9 @@ module InvoicePrinter
         )
         @pdf.stroke_rounded_rectangle([0, 508 - @push_down], 270, 45, 6)
       else
-        box_height = 45
-        push_iban = 0
+        @payment_box_height = 60
+        @push_iban = 0
+        sublabel_change = 0
         @pdf.text_box(
           @labels[:payment_by_transfer],
           size: 10,
@@ -342,95 +393,178 @@ module InvoicePrinter
           width: 240
         )
         @pdf.text_box(
-          "#{@labels[:account_number]}:",
-          size: 10,
+          "#{@labels[:account_number]}",
+          size: 11,
           at: [10, 483 - @push_down],
-          width: 240
+          width: 140
         )
         @pdf.text_box(
           @document.bank_account_number,
-          size: 10,
-          at: [75, 483 - @push_down],
-          width: 240
+          size: 13,
+          at: [21, 483 - @push_down],
+          width: 240,
+          align: :right
         )
-        unless @document.account_swift.empty?
+        if used? @labels[:sublabels][:account_number]
           @pdf.text_box(
-            "#{@labels[:swift]}:",
+            "#{@labels[:sublabels][:account_number]}",
             size: 10,
             at: [10, 468 - @push_down],
-            width: 240
+            width: 340
+          )
+        else
+          @payment_box_height -= 10
+          sublabel_change -= 10
+        end
+        unless @document.account_swift.empty?
+          @pdf.text_box(
+            "#{@labels[:swift]}",
+            size: 11,
+            at: [10, 453 - @push_down - sublabel_change],
+            width: 140
           )
           @pdf.text_box(
             @document.account_swift,
-            size: 10,
-            at: [75, 468 - @push_down],
-            width: 240
+            size: 13,
+            at: [21, 453 -  @push_down - sublabel_change],
+            width: 240,
+            align: :right
           )
-          box_height += 15
-          push_iban = 15
-          @push_items_table += 15
+
+          if used? @labels[:sublabels][:swift]
+            @pdf.text_box(
+              "#{@labels[:sublabels][:swift]}",
+              size: 10,
+              at: [10, 438 - @push_down - sublabel_change],
+              width: 340
+            )
+            @push_items_table += 10
+          else
+            @payment_box_height -= 10
+            sublabel_change -= 10
+          end
+
+          @payment_box_height += 30
+          @push_iban = 30
+          @push_items_table += 18
         end
         unless @document.account_iban.empty?
           @pdf.text_box(
-            "#{@labels[:iban]}:",
-            size: 10,
-            at: [10, 468 - push_iban - @push_down],
-            width: 240
+            "#{@labels[:iban]}",
+            size: 11,
+            at: [10, 453 - @push_iban - @push_down - sublabel_change],
+            width: 140
           )
           @pdf.text_box(
             @document.account_iban,
-            size: 10,
-            at: [75, 468 - push_iban - @push_down],
-            width: 240
+            size: 13,
+            at: [21, 453 - @push_iban - @push_down - sublabel_change],
+            width: 240,
+            align: :right
           )
-          box_height += 15
-          @push_items_table += 15
+
+          if used? @labels[:sublabels][:iban]
+            @pdf.text_box(
+              "#{@labels[:sublabels][:iban]}",
+              size: 10,
+              at: [10, 438 - @push_iban - @push_down - sublabel_change],
+              width: 340
+            )
+            @push_items_table += 10
+          else
+            @payment_box_height -= 10
+          end
+
+          @payment_box_height += 30
+          @push_items_table += 18
+        end
+        if min_height > @payment_box_height
+          @payment_box_height = min_height
+          @push_items_table += 25
         end
-        @pdf.stroke_rounded_rectangle([0, 508 - @push_down], 270, box_height, 6)
+
+        if !@document.account_swift.empty? && !@document.account_iban.empty?
+          @push_items_table += 2
+        end
+
+        @pdf.stroke_rounded_rectangle([0, 508 - @push_down], 270, @payment_box_height, 6)
       end
     end
 
     # Build the following info box:
     #
     #    --------------------------------
-    #   | Issue date: 03/03/2016         |
-    #   | Due date: 03/03/2016           |
+    #   | Issue date:          03/03/2016|
+    #   | Issue date sublabel            |
+    #   | Due date:            03/03/2016|
+    #   | Due date sublabel              |
     #    --------------------------------
     #
     def build_info_box
       issue_date_present = !@document.issue_date.empty?
-      due_date_present = !@document.due_date.empty?
+
       if issue_date_present
         @pdf.text_box(
-          "#{@labels[:issue_date]}:",
-          size: 10,
+          @labels[:issue_date],
+          size: 11,
           at: [290, 498 - @push_down],
           width: 240
         )
         @pdf.text_box(
           @document.issue_date,
-          size: 10,
+          size: 13,
           at: [390, 498 - @push_down],
-          width: 240
+          align: :right
         )
       end
-      if due_date_present
+
+      if used? @labels[:sublabels][:issue_date]
         position = issue_date_present ? 483 : 498
+
         @pdf.text_box(
-          "#{@labels[:due_date]}:",
+          @labels[:sublabels][:issue_date],
           size: 10,
           at: [290, position - @push_down],
           width: 240
         )
+      end
+
+      due_date_present = !@document.due_date.empty?
+
+      if due_date_present
+        position = issue_date_present ? 478 : 493
+        position -= 10 if used? @labels[:sublabels][:issue_date]
+
+        @pdf.text_box(
+          @labels[:due_date],
+          size: 11,
+          at: [290, position - @push_down],
+          width: 240
+        )
         @pdf.text_box(
           @document.due_date,
-          size: 10,
+          size: 13,
           at: [390, position - @push_down],
+          align: :right
+        )
+      end
+
+      if used? @labels[:sublabels][:due_date]
+        position = issue_date_present ? 463 : 478
+        position -= 10 if used? @labels[:sublabels][:issue_date]
+
+        @pdf.text_box(
+          @labels[:sublabels][:due_date],
+          size: 10,
+          at: [290, position - @push_down],
           width: 240
         )
       end
+
       if issue_date_present || due_date_present
-        height = (issue_date_present && due_date_present) ? 45 : 30
+        height = (issue_date_present && due_date_present) ? 75 : 60
+        height = @payment_box_height if @payment_box_height > height
+
         @pdf.stroke_rounded_rectangle([280, 508 - @push_down], 270, height, 6)
       end
     end
@@ -438,15 +572,24 @@ module InvoicePrinter
     # Build the following table for document items:
     #
     #   =================================================================
-    #   |Item | Quantity | Unit | Price per item | Tax | Total per item |
+    #   |Item |  Quantity|  Unit|  Price per item|  Tax|  Total per item|
     #   |-----|----------|------|----------------|-----|----------------|
-    #   | x   | 2        | hr   | $ 2            | $1  | $ 4            |
+    #   |x    |         2|    hr|              $2|   $1|              $4|
     #   =================================================================
     #
     # If a specific column miss data, it's omittted.
-    # Tax2 and tax3 fields can be added as well if necessary.
+    # tax2 and tax3 fields can be added as well if necessary.
+    #
+    # Using sublabels one can change the table to look as:
+    #
+    #   =================================================================
+    #   |Item |  Quantity|  Unit|  Price per item|  Tax|  Total per item|
+    #   |it.  |      nom.|   un.|            ppi.|   t.|            tpi.|
+    #   |-----|----------|------|----------------|-----|----------------|
+    #   |x    |         2|    hr|              $2|   $1|              $4|
+    #   =================================================================
     def build_items
-      @pdf.move_down(25 + @push_items_table + @push_down)
+      @pdf.move_down(23 + @push_items_table + @push_down)
 
       items_params = determine_items_structure
       items = build_items_data(items_params)
@@ -465,7 +608,8 @@ module InvoicePrinter
           5 => :right,
           6 => :right,
           7 => :right
-        }
+        },
+        font_size: 10
       }
 
       @pdf.table(items, styles) unless items.empty?
@@ -506,17 +650,26 @@ module InvoicePrinter
     # Include only relevant headers
     def build_items_header(items_params)
       headers = []
-      headers << { text: @labels[:item] } if items_params[:names]
-      headers << { text: @labels[:quantity] } if items_params[:quantities]
-      headers << { text: @labels[:unit] } if items_params[:units]
-      headers << { text: @labels[:price_per_item] } if items_params[:prices]
-      headers << { text: @labels[:tax] } if items_params[:taxes]
-      headers << { text: @labels[:tax2] } if items_params[:taxes2]
-      headers << { text: @labels[:tax3] } if items_params[:taxes3]
-      headers << { text: @labels[:amount] } if items_params[:amounts]
+      headers << { text: label_with_sublabel(:item) } if items_params[:names]
+      headers << { text: label_with_sublabel(:quantity) } if items_params[:quantities]
+      headers << { text: label_with_sublabel(:unit) } if items_params[:units]
+      headers << { text: label_with_sublabel(:price_per_item) } if items_params[:prices]
+      headers << { text: label_with_sublabel(:tax) } if items_params[:taxes]
+      headers << { text: label_with_sublabel(:tax2) } if items_params[:taxes2]
+      headers << { text: label_with_sublabel(:tax3) } if items_params[:taxes3]
+      headers << { text: label_with_sublabel(:amount) } if items_params[:amounts]
       headers
     end
 
+    # This merge a label with its sublabel on a new line
+    def label_with_sublabel(symbol)
+      value = @labels[symbol]
+      if used? @labels[:sublabels][symbol]
+        value += "\n#{@labels[:sublabels][symbol]}"
+      end
+      value
+    end
+
     # Build the following summary:
     #
     #   Subtotal: 175
@@ -531,10 +684,14 @@ module InvoicePrinter
       @pdf.move_down(25)
 
       items = []
-      items << ["#{@labels[:subtotal]}:", @document.subtotal] unless @document.subtotal.empty?
-      items << ["#{@labels[:tax]}:", @document.tax] unless @document.tax.empty?
-      items << ["#{@labels[:tax2]}:", @document.tax2] unless @document.tax2.empty?
-      items << ["#{@labels[:tax3]}:", @document.tax3] unless @document.tax3.empty?
+      items << ["#{@labels[:subtotal]}:#{build_sublabel_for_total_table(:subtotal)}", @document.subtotal] \
+        unless @document.subtotal.empty?
+      items << ["#{@labels[:tax]}:#{build_sublabel_for_total_table(:tax)}", @document.tax] \
+        unless @document.tax.empty?
+      items << ["#{@labels[:tax2]}:#{build_sublabel_for_total_table(:tax2)}", @document.tax2] \
+        unless @document.tax2.empty?
+      items << ["#{@labels[:tax3]}:#{build_sublabel_for_total_table(:tax3)}", @document.tax3] \
+        unless @document.tax3.empty?
 
       width = [
         "#{@labels[:subtotal]}#{@document.subtotal}".size,
@@ -557,12 +714,33 @@ module InvoicePrinter
 
       @pdf.move_down(15)
 
-      @pdf.text(
-        "#{@labels[:total]}:   #{@document.total}",
-        size: 16,
-        align: :right,
-        style: :bold
-      )
+      unless @document.total.empty?
+        @pdf.text(
+          "#{@labels[:total]}:   #{@document.total}",
+          size: 16,
+          align: :right,
+          style: :bold
+        )
+
+        @pdf.move_down(5)
+
+        if used? @labels[:sublabels][:total]
+          @pdf.text(
+            "#{@labels[:sublabels][:total]}:   #{@document.total}",
+            size: 12,
+            align: :right
+          )
+        end
+      end
+    end
+
+    # Return sublabel on a new line or empty string
+    def build_sublabel_for_total_table(sublabel)
+      if used? @labels[:sublabels][sublabel]
+        "\n#{@labels[:sublabels][sublabel]}:"
+      else
+        ''
+      end
     end
 
     # Insert a logotype at the left bottom of the document
@@ -604,5 +782,9 @@ module InvoicePrinter
         size: 12
       ) unless @pdf.page_count == 1
     end
+
+    def used?(element)
+      element && !element.empty?
+    end
   end
 end

data/lib/invoice_printer/version.rb

@@ -1,3 +1,3 @@
 module InvoicePrinter
-  VERSION = '0.0.8'
+  VERSION = '0.0.9'
 end