invoice_printer 0.0.2 → 0.0.3

data/lib/invoice_printer/pdf_document.rb

@@ -96,19 +96,24 @@ module InvoicePrinter
 
     private
 
+    # Add font family in Prawn for a given +font+ file
     def set_fonts(font)
       font_name = Pathname.new(font).basename
-      @pdf.font_families.update("#{font_name}" => {
-        normal: font,
-        italic: font,
-        bold: font,
-        bold_italic: font
-      })
+      @pdf.font_families.update(
+        "#{font_name}" => {
+          normal: font,
+          italic: font,
+          bold: font,
+          bold_italic: font
+        }
+      )
       @pdf.font(font_name)
     end
 
+    # Build the PDF version of the document (@pdf)
     def build_pdf
-      @push_down = 40
+      @push_down = 0
+      @push_items_table = 0
       @pdf.fill_color '000000'
       build_header
       build_provider_box
@@ -121,54 +126,74 @@ module InvoicePrinter
       build_footer
     end
 
+    # Build the document name and number
     def build_header
-      @pdf.text @labels[:name], size: 20
+      @pdf.text_box(
+        @labels[:name],
+        size: 20,
+        at: [0, 720 - @push_down],
+        width: 300,
+        align: :left
+      )
       @pdf.text_box(
         @document.number,
         size: 20,
-        at: [240, 720],
+        at: [240, 720 - @push_down],
         width: 300,
         align: :right
       )
       @pdf.move_down(250)
     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     |
+    #    -------------------------------------
+    #
     def build_provider_box
       @pdf.text_box(
         @labels[:provider],
         size: 10,
-        at: [10, 660],
+        at: [10, 660 - @push_down],
         width: 240
       )
       @pdf.text_box(
         @document.provider_name,
         size: 14,
-        at: [10, 640],
+        at: [10, 640 - @push_down],
         width: 240
       )
       @pdf.text_box(
         "#{@document.provider_street}    #{@document.provider_street_number}",
         size: 10,
-        at: [10, 620],
+        at: [10, 620 - @push_down],
         width: 240
       )
       @pdf.text_box(
         @document.provider_postcode,
         size: 10,
-        at: [10, 605],
+        at: [10, 605 - @push_down],
         width: 240
       )
       @pdf.text_box(
         @document.provider_city,
         size: 10,
-        at: [60, 605],
+        at: [60, 605 - @push_down],
         width: 240
       )
       unless @document.provider_city_part.empty?
         @pdf.text_box(
           @document.provider_city_part,
           size: 10,
-          at: [60, 590],
+          at: [60, 590 - @push_down],
           width: 240
         )
       end
@@ -176,7 +201,7 @@ module InvoicePrinter
         @pdf.text_box(
           @document.provider_extra_address_line,
           size: 10,
-          at: [10, 575],
+          at: [10, 575 - @push_down],
           width: 240
         )
       end
@@ -184,7 +209,7 @@ module InvoicePrinter
         @pdf.text_box(
           "#{@labels[:ic]}:    #{@document.provider_ic}",
           size: 10,
-          at: [10, 550],
+          at: [10, 550 - @push_down],
           width: 240
         )
       end
@@ -192,48 +217,62 @@ module InvoicePrinter
         @pdf.text_box(
           "#{@labels[:dic]}:    #{@document.provider_dic}",
           size: 10,
-          at: [10, 535],
+          at: [10, 535 - @push_down],
           width: 240
         )
       end
+      @pdf.stroke_rounded_rectangle([0, 670 - @push_down], 270, 150, 6)
     end
 
+    # Build the following purchaser box:
+    #
+    #    -------------------------------------
+    #   | Purchaser                           |
+    #   | 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],
+        at: [290, 660 - @push_down],
         width: 240
       )
       @pdf.text_box(
         @document.purchaser_name,
         size: 14,
-        at: [290, 640],
+        at: [290, 640 - @push_down],
         width: 240
       )
       @pdf.text_box(
         "#{@document.purchaser_street}    #{@document.purchaser_street_number}",
         size: 10,
-        at: [290, 620],
+        at: [290, 620 - @push_down],
         width: 240
       )
       @pdf.text_box(
         @document.purchaser_postcode,
         size: 10,
-        at: [290, 605],
+        at: [290, 605 - @push_down],
         width: 240
       )
       @pdf.text_box(
         @document.purchaser_city,
         size: 10,
-        at: [340, 605],
+        at: [340, 605 - @push_down],
         width: 240
       )
       unless @document.purchaser_city_part.empty?
         @pdf.text_box(
           @document.purchaser_city_part,
           size: 10,
-          at: [340, 590],
+          at: [340, 590 - @push_down],
           width: 240
         )
       end
@@ -241,17 +280,15 @@ module InvoicePrinter
         @pdf.text_box(
           @document.purchaser_extra_address_line,
           size: 10,
-          at: [290, 575],
+          at: [290, 575 - @push_down],
           width: 240
         )
       end
-      @pdf.stroke_rounded_rectangle([0, 670], 270, 150, 6)
-      @pdf.stroke_rounded_rectangle([280, 670], 270, 150, 6)
       unless @document.purchaser_dic.empty?
         @pdf.text_box(
           "#{@labels[:dic]}:    #{@document.purchaser_dic}",
           size: 10,
-          at: [290, 550],
+          at: [290, 550 - @push_down],
           width: 240
         )
       end
@@ -259,83 +296,104 @@ module InvoicePrinter
         @pdf.text_box(
           "#{@labels[:ic]}:    #{@document.purchaser_ic}",
           size: 10,
-          at: [290, 535],
+          at: [290, 535 - @push_down],
           width: 240
         )
       end
+      @pdf.stroke_rounded_rectangle([280, 670 - @push_down], 270, 150, 6)
     end
 
+    # Build the following payment box:
+    #
+    #    -----------------------------------------
+    #   | Payment on the following bank account:  |
+    #   | Number: 3920392032                      |
+    #   | SWIFT: ...                              |
+    #   | IBAN: ...                               |
+    #    -----------------------------------------
+    #
+    # If the bank account number is not provided include a note about payment
+    # in cash.
     def build_payment_method_box
       if @document.bank_account_number.empty?
-        @pdf.stroke_rounded_rectangle([0, 540 - @push_down], 270, 45, 6)
         @pdf.text_box(
           @labels[:payment],
           size: 10,
-          at: [10, 530 - @push_down],
+          at: [10, 498 - @push_down],
           width: 240
         )
         @pdf.text_box(
           @labels[:payment_in_cash],
           size: 10,
-          at: [10, 515 - @push_down],
-          width: 240
-        )
-        return
-      end
-      box_height = 45
-      push_iban = 0
-      @pdf.text_box(
-        @labels[:payment_by_transfer],
-        size: 10,
-        at: [10, 530 - @push_down],
-        width: 240
-      )
-      @pdf.text_box(
-        "#{@labels[:account_number]}:",
-        size: 10,
-        at: [10, 515 - @push_down],
-        width: 240
-      )
-      @pdf.text_box(
-        @document.bank_account_number,
-        size: 10,
-        at: [75, 515 - @push_down],
-        width: 240
-      )
-      unless @document.account_swift.empty?
-        @pdf.text_box(
-          "#{@labels[:swift]}:",
-          size: 10,
-          at: [10, 500 - @push_down],
+          at: [10, 483 - @push_down],
           width: 240
         )
+        @pdf.stroke_rounded_rectangle([0, 508 - @push_down], 270, 45, 6)
+      else
+        box_height = 45
+        push_iban = 0
         @pdf.text_box(
-          @document.account_swift,
+          @labels[:payment_by_transfer],
           size: 10,
-          at: [75, 500 - @push_down],
+          at: [10, 498 - @push_down],
           width: 240
         )
-        box_height += 15
-        push_iban = 15
-      end
-      unless @document.account_iban.empty?
         @pdf.text_box(
-          "#{@labels[:iban]}:",
+          "#{@labels[:account_number]}:",
           size: 10,
-          at: [10, 500 - push_iban - @push_down],
+          at: [10, 483 - @push_down],
           width: 240
         )
         @pdf.text_box(
-          @document.account_iban,
+          @document.bank_account_number,
           size: 10,
-          at: [75, 500 - push_iban - @push_down],
+          at: [75, 483 - @push_down],
           width: 240
         )
-        box_height += 15
+        unless @document.account_swift.empty?
+          @pdf.text_box(
+            "#{@labels[:swift]}:",
+            size: 10,
+            at: [10, 468 - @push_down],
+            width: 240
+          )
+          @pdf.text_box(
+            @document.account_swift,
+            size: 10,
+            at: [75, 468 - @push_down],
+            width: 240
+          )
+          box_height += 15
+          push_iban = 15
+          @push_items_table += 15
+        end
+        unless @document.account_iban.empty?
+          @pdf.text_box(
+            "#{@labels[:iban]}:",
+            size: 10,
+            at: [10, 468 - push_iban - @push_down],
+            width: 240
+          )
+          @pdf.text_box(
+            @document.account_iban,
+            size: 10,
+            at: [75, 468 - push_iban - @push_down],
+            width: 240
+          )
+          box_height += 15
+          @push_items_table += 15
+        end
+        @pdf.stroke_rounded_rectangle([0, 508 - @push_down], 270, box_height, 6)
       end
-      @pdf.stroke_rounded_rectangle([0, 540 - @push_down], 270, box_height, 6)
     end
 
+    # Build the following info box:
+    #
+    #    --------------------------------
+    #   | Issue date: 03/03/2016         |
+    #   | Due date: 03/03/2016           |
+    #    --------------------------------
+    #
     def build_info_box
       issue_date_present = !@document.issue_date.empty?
       due_date_present = !@document.due_date.empty?
@@ -343,18 +401,18 @@ module InvoicePrinter
         @pdf.text_box(
           "#{@labels[:issue_date]}:",
           size: 10,
-          at: [290, 530 - @push_down],
+          at: [290, 498 - @push_down],
           width: 240
         )
         @pdf.text_box(
           @document.issue_date,
           size: 10,
-          at: [390, 530 - @push_down],
+          at: [390, 498 - @push_down],
           width: 240
         )
       end
       if due_date_present
-        position = issue_date_present ? 515 : 530
+        position = issue_date_present ? 483 : 498
         @pdf.text_box(
           "#{@labels[:due_date]}:",
           size: 10,
@@ -370,22 +428,22 @@ module InvoicePrinter
       end
       if issue_date_present || due_date_present
         height = (issue_date_present && due_date_present) ? 45 : 30
-        @pdf.stroke_rounded_rectangle([280, 540 - @push_down], 270, height, 6)
+        @pdf.stroke_rounded_rectangle([280, 508 - @push_down], 270, height, 6)
       end
     end
 
     # Build the following table for document items:
     #
-    #   |===============================================================|
+    #   =================================================================
     #   |Item | Quantity | Unit | Price per item | Tax | Total per item |
     #   |-----|----------|------|----------------|-----|----------------|
     #   | 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.
     def build_items
-      @pdf.move_down(25 + @push_down)
+      @pdf.move_down(25 + @push_items_table + @push_down)
 
       items_params = determine_items_structure
       items = build_items_data(items_params)
@@ -413,7 +471,6 @@ module InvoicePrinter
     # Determine sections of the items table to show based on provided data
     def determine_items_structure
       items_params = {}
-
       @document.items.each do |item|
         items_params[:names] = true unless item.name.empty?
         items_params[:quantities] = true unless item.quantity.empty?
@@ -424,7 +481,6 @@ module InvoicePrinter
         items_params[:taxes3] = true unless item.tax3.empty?
         items_params[:amounts] = true unless item.amount.empty?
       end
-
       items_params
     end
 
@@ -506,6 +562,7 @@ module InvoicePrinter
       )
     end
 
+    # Insert a logotype at the left bottom of the document
     def build_logo
       @pdf.image(@logo, at: [0, 50]) if @logo && !@logo.empty?
     end
@@ -515,7 +572,7 @@ module InvoicePrinter
       @pdf.number_pages(
         '<page> / <total>',
         start_count_at: 1,
-        page_filter: ->(page) { page != 0 },
+        page_filter: ->(page) { page != 1 },
         at: [@pdf.bounds.right - 50, 0],
         align: :right,
         size: 12

data/lib/invoice_printer/version.rb

@@ -1,3 +1,3 @@
 module InvoicePrinter
-  VERSION = '0.0.2'
+  VERSION = '0.0.3'
 end