invoice_printer 2.0.0.beta3 → 2.2.0

data/lib/invoice_printer/pdf_document.rb

@@ -11,6 +11,7 @@ module InvoicePrinter
   #     document: invoice,
   #     labels: {},
   #     font: 'font.ttf',
+  #     bold_font: 'bold_font.ttf',
   #     stamp: 'stamp.jpg',
   #     logo: 'example.jpg'
   #   )
@@ -20,7 +21,7 @@ module InvoicePrinter
     class StampFileNotFound < StandardError; end
     class InvalidInput < StandardError; end
 
-    attr_reader :invoice, :labels, :file_name, :font, :stamp, :logo
+    attr_reader :invoice, :labels, :file_name, :font, :bold_font, :stamp, :logo
 
     DEFAULT_LABELS = {
       name: 'Invoice',
@@ -36,6 +37,7 @@ module InvoicePrinter
       iban: 'IBAN',
       issue_date: 'Issue date',
       due_date: 'Due date',
+      variable_symbol: 'Variable symbol',
       item: 'Item',
       variable: '',
       quantity: 'Quantity',
@@ -65,10 +67,20 @@ module InvoicePrinter
       @@labels = DEFAULT_LABELS.merge(labels)
     end
 
-    def initialize(document: Document.new, labels: {}, font: nil, stamp: nil, logo: nil, background: nil, page_size: :letter)
+    def initialize(
+      document: Document.new,
+      labels: {},
+      font: nil,
+      bold_font: nil,
+      stamp: nil,
+      logo: nil,
+      background: nil,
+      page_size: :letter
+    )
       @document  = document
       @labels    = merge_custom_labels(labels)
       @font      = font
+      @bold_font = bold_font
       @stamp     = stamp
       @logo      = logo
       @page_size = page_size ? PAGE_SIZES[page_size.to_sym] : PAGE_SIZES[:letter]
@@ -93,38 +105,10 @@ module InvoicePrinter
         end
       end
 
-      if used? @font
-        use_font(@font)
-      end
-
-      # Version 2.1 deprecation warnings
-      warnings = [
-        @document.provider_street,
-        @document.provider_street_number,
-        @document.provider_postcode,
-        @document.provider_city,
-        @document.provider_city_part,
-        @document.provider_extra_address_line,
-        @document.purchaser_street,
-        @document.purchaser_street_number,
-        @document.purchaser_postcode,
-        @document.purchaser_city,
-        @document.purchaser_city_part,
-        @document.purchaser_extra_address_line
-      ].delete_if(&:empty?)
-
-      unless warnings.empty?
-        warning = <<~WARN
-          WARNING: Following values are used in deprecated fields and
-          won't be rendered in future versions of InvoicePrinter:
-
-          #{warnings.join(", ")}
-
-          Use new provider_lines and purchaser_lines fields instead of
-          the old address fields.
-        WARN
-
-        $stderr.puts warning
+      if used?(@font) && used?(@bold_font)
+        use_font(@font, @bold_font)
+      elsif used?(@font)
+        use_font(@font, @font)
       end
 
       build_pdf
@@ -142,11 +126,11 @@ module InvoicePrinter
 
     private
 
-    def use_font(font)
-      if File.exist?(@font)
-        set_font_from_path(@font)
+    def use_font(font, bold_font)
+      if File.exist?(font) && File.exist?(bold_font)
+        set_font_from_path(font, bold_font)
       else
-        set_builtin_font(@font)
+        set_builtin_font(font)
       end
     end
 
@@ -163,14 +147,14 @@ module InvoicePrinter
     end
 
     # Add font family in Prawn for a given +font+ file
-    def set_font_from_path(font)
+    def set_font_from_path(font, bold_font)
       font_name = Pathname.new(font).basename
       @pdf.font_families.update(
         "#{font_name}" => {
           normal: font,
           italic: font,
-          bold: font,
-          bold_italic: font
+          bold: bold_font,
+          bold_italic: bold_font
         }
       )
       @pdf.font(font_name)
@@ -181,6 +165,7 @@ module InvoicePrinter
       @push_down = 0
       @push_items_table = 0
       @pdf.fill_color '000000'
+      @pdf.stroke_color 'aaaaaa'
       build_header
       build_provider_box
       build_purchaser_box
@@ -281,41 +266,6 @@ module InvoicePrinter
             width: x(240)
           )
         end
-      else
-        @pdf.text_box(
-          "#{@document.provider_street}    #{@document.provider_street_number}",
-          size: 10,
-          at: [10, y(620) - @push_down],
-          width: x(240)
-        )
-        @pdf.text_box(
-          @document.provider_postcode,
-          size: 10,
-          at: [10, y(605) - @push_down],
-          width: x(240)
-        )
-        @pdf.text_box(
-          @document.provider_city,
-          size: 10,
-          at: [60, y(605) - @push_down],
-          width: x(240)
-        )
-        unless @document.provider_city_part.empty?
-          @pdf.text_box(
-            @document.provider_city_part,
-            size: 10,
-            at: [60, y(590) - @push_down],
-            width: x(240)
-          )
-        end
-        unless @document.provider_extra_address_line.empty?
-          @pdf.text_box(
-            @document.provider_extra_address_line,
-            size: 10,
-            at: [10, y(575) - @push_down],
-            width: x(240)
-          )
-        end
       end
       unless @document.provider_tax_id.empty?
         @pdf.text_box(
@@ -386,41 +336,6 @@ module InvoicePrinter
             width: x(240)
           )
         end
-      else
-        @pdf.text_box(
-          "#{@document.purchaser_street}    #{@document.purchaser_street_number}",
-          size: 10,
-          at: [x(284), y(620) - @push_down],
-          width: x(240)
-        )
-        @pdf.text_box(
-          @document.purchaser_postcode,
-          size: 10,
-          at: [x(284), y(605) - @push_down],
-          width: x(240)
-        )
-        @pdf.text_box(
-          @document.purchaser_city,
-          size: 10,
-          at: [x(334), y(605) - @push_down],
-          width: x(240)
-        )
-        unless @document.purchaser_city_part.empty?
-          @pdf.text_box(
-            @document.purchaser_city_part,
-            size: 10,
-            at: [x(334), y(590) - @push_down],
-            width: x(240)
-          )
-        end
-        unless @document.purchaser_extra_address_line.empty?
-          @pdf.text_box(
-            @document.purchaser_extra_address_line,
-            size: 10,
-            at: [x(284), y(575) - @push_down],
-            width: x(240)
-          )
-        end
       end
       unless @document.purchaser_tax_id.empty?
         @pdf.text_box(
@@ -469,6 +384,10 @@ module InvoicePrinter
       end
       @payment_box_height = min_height
 
+      if big_info_box?
+        @payment_box_height = 110
+      end
+
       if @document.bank_account_number.empty?
         @pdf.text_box(
           @labels[:payment],
@@ -580,6 +499,7 @@ module InvoicePrinter
           @payment_box_height += 30
           @push_items_table += 18
         end
+
         if min_height > @payment_box_height
           @payment_box_height = min_height
           @push_items_table += 25
@@ -600,6 +520,8 @@ module InvoicePrinter
     #   | Issue date sublabel            |
     #   | Due date:            03/03/2016|
     #   | Due date sublabel              |
+    #   | Variable symbol:     VS12345678|
+    #   | Variable symbol sublabel       |
     #    --------------------------------
     #
     def build_info_box
@@ -619,17 +541,17 @@ module InvoicePrinter
           width: x(146),
           align: :right
         )
-      end
 
-      if used? @labels[:sublabels][:issue_date]
-        position = issue_date_present ? 483 : 498
+        if used? @labels[:sublabels][:issue_date]
+          position = issue_date_present ? 483 : 498
 
-        @pdf.text_box(
-          @labels[:sublabels][:issue_date],
-          size: 10,
-          at: [x(284), y(position) - @push_down],
-          width: x(240)
-        )
+          @pdf.text_box(
+            @labels[:sublabels][:issue_date],
+            size: 10,
+            at: [x(284), y(position) - @push_down],
+            width: x(240)
+          )
+        end
       end
 
       due_date_present = !@document.due_date.empty?
@@ -651,29 +573,83 @@ module InvoicePrinter
           width: x(146),
           align: :right
         )
+
+        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: [x(284), y(position) - @push_down],
+            width: x(240)
+          )
+        end
       end
 
-      if used? @labels[:sublabels][:due_date]
-        position = issue_date_present ? 463 : 478
+      variable_symbol_present = !@document.variable_symbol.empty?
+
+      if variable_symbol_present
+        position = (issue_date_present || due_date_present) ? 483 : 498
+        position = issue_date_present && due_date_present ? 458 : 463
         position -= 10 if used? @labels[:sublabels][:issue_date]
+        position -= 10 if used? @labels[:sublabels][:due_date]
 
         @pdf.text_box(
-          @labels[:sublabels][:due_date],
-          size: 10,
+          @labels[:variable_symbol],
+          size: 11,
           at: [x(284), y(position) - @push_down],
           width: x(240)
         )
+        @pdf.text_box(
+          @document.variable_symbol,
+          size: 13,
+          at: [x(384), y(position) - @push_down],
+          width: x(146),
+          align: :right
+        )
+
+        if used? @labels[:sublabels][:variable_symbol]
+          position = issue_date_present ? 443 : 458
+          position -= 10 if used? @labels[:sublabels][:issue_date]
+          position -= 10 if used? @labels[:sublabels][:due_date]
+
+          @pdf.text_box(
+            @labels[:sublabels][:variable_symbol],
+            size: 10,
+            at: [x(284), y(position) - @push_down],
+            width: x(240)
+          )
+        end
       end
 
-      if issue_date_present || due_date_present
+      if issue_date_present || due_date_present || variable_symbol_present
+        big_box = (issue_date_present && due_date_present && variable_symbol_present && info_box_sublabels_used?)
         height = (issue_date_present && due_date_present) ? 75 : 60
+        height = big_box ? 110 : height
         height = @payment_box_height if @payment_box_height > height
 
         @pdf.stroke_rounded_rectangle([x(274), y(508) - @push_down], x(266), height, 6)
-        @push_items_table += 12 if @push_items_table <= 18
+        @push_items_table += 23 if @push_items_table <= 18
+        @push_items_table += 24 if big_box
+
+        #@push_items_table += 30
       end
     end
 
+    def big_info_box?
+      !@document.issue_date.empty? &&
+      !@document.due_date.empty? &&
+      !@document.variable_symbol.empty? &&
+      info_box_sublabels_used?
+    end
+
+    def info_box_sublabels_used?
+      used?(@labels[:sublabels][:issue_date]) ||
+      used?(@labels[:sublabels][:due_date]) ||
+      used?(@labels[:sublabels][:variable_symbol])
+    end
+
     # Build the following table for document items:
     #
     #   =================================================================
@@ -700,26 +676,28 @@ module InvoicePrinter
       items_params = determine_items_structure
       items = build_items_data(items_params)
       headers = build_items_header(items_params)
+      data = items.prepend(headers)
 
-      styles = {
-        headers: headers,
-        row_colors: ['F5F5F5', nil],
+      options = {
+        header: true,
+        row_colors: [nil, 'ededed'],
         width: x(540, 2),
-        align: {
-          0 => :left,
-          1 => :right,
-          2 => :right,
-          3 => :right,
-          4 => :right,
-          5 => :right,
-          6 => :right,
-          7 => :right,
-          8 => :right
-        },
-        font_size: 10
+        cell_style: {
+          borders: []
+        }
       }
 
-      @pdf.table(items, styles) unless items.empty?
+      unless items.empty?
+        @pdf.font_size(10) do
+          @pdf.table(data, options) do
+            row(0).background_color = 'e3e3e3'
+            row(0).border_color = 'aaaaaa'
+            row(0).borders = [:bottom]
+            row(items.size - 1).borders = [:bottom]
+            row(items.size - 1).border_color = 'd9d9d9'
+          end
+        end
+      end
     end
 
     # Determine sections of the items table to show based on provided data
@@ -743,31 +721,53 @@ module InvoicePrinter
     def build_items_data(items_params)
       @document.items.map do |item|
         line = []
-        line << item.name if items_params[:names]
-        line << item.variable if items_params[:variables]
-        line << item.quantity if items_params[:quantities]
-        line << item.unit if items_params[:units]
-        line << item.price if items_params[:prices]
-        line << item.tax if items_params[:taxes]
-        line << item.tax2 if items_params[:taxes2]
-        line << item.tax3 if items_params[:taxes3]
-        line << item.amount if items_params[:amounts]
+        line << { content: name_cell(item), borders: [:bottom] } if items_params[:names]
+        #line << { content: item.name, borders: [:bottom], align: :left } if items_params[:names]
+        line << { content: item.variable, align: :right } if items_params[:variables]
+        line << { content: item.quantity, align: :right } if items_params[:quantities]
+        line << { content: item.unit, align: :right } if items_params[:units]
+        line << { content: item.price, align: :right } if items_params[:prices]
+        line << { content: item.tax, align: :right } if items_params[:taxes]
+        line << { content: item.tax2, align: :right } if items_params[:taxes2]
+        line << { content: item.tax3, align: :right } if items_params[:taxes3]
+        line << { content: item.amount, align: :right } if items_params[:amounts]
         line
       end
     end
 
+    # Display item's name and breakdown if present
+    def name_cell(item)
+      data = if used?(item.breakdown)
+        data = [
+          [{ content: item.name, padding: [5, 0, 0, 5] }],
+          [{ content: item.breakdown, size: 8, padding: [2, 0, 5, 5] }]
+        ]
+
+        options = {
+          cell_style: {
+            borders: []
+          },
+          position: :left
+        }
+
+        @pdf.make_table(data, options)
+      else
+        item.name
+      end
+    end
+
     # Include only relevant headers
     def build_items_header(items_params)
       headers = []
-      headers << { text: label_with_sublabel(:item) } if items_params[:names]
-      headers << { text: label_with_sublabel(:variable) } if items_params[:variables]
-      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 << { content: label_with_sublabel(:item), align: :left } if items_params[:names]
+      headers << { content: label_with_sublabel(:variable), align: :right } if items_params[:variables]
+      headers << { content: label_with_sublabel(:quantity), align: :right } if items_params[:quantities]
+      headers << { content: label_with_sublabel(:unit), align: :right } if items_params[:units]
+      headers << { content: label_with_sublabel(:price_per_item), align: :right } if items_params[:prices]
+      headers << { content: label_with_sublabel(:tax), align: :right } if items_params[:taxes]
+      headers << { content: label_with_sublabel(:tax2), align: :right } if items_params[:taxes2]
+      headers << { content: label_with_sublabel(:tax3), align: :right } if items_params[:taxes3]
+      headers << { content: label_with_sublabel(:amount), align: :right } if items_params[:amounts]
       headers
     end
 
@@ -794,54 +794,40 @@ module InvoicePrinter
       @pdf.move_down(25)
 
       items = []
-      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,
-        "#{@labels[:tax]}#{@document.tax}".size,
-        "#{@labels[:tax2]}#{@document.tax2}".size,
-        "#{@labels[:tax3]}#{@document.tax3}".size
-      ].max * 8
-
-      styles = {
-        border_width: 0,
-        align: {
-          0 => :right,
-          1 => :left
-        }
-      }
-
-      @pdf.span(x(width), position: :right) do
-        @pdf.table(items, styles) unless items.empty?
-      end
-
-      @pdf.move_down(15)
 
-      unless @document.total.empty?
-        @pdf.text(
-          "#{@labels[:total]}:   #{@document.total}",
-          size: 16,
-          align: :right,
-          style: :bold
-        )
-
-        @pdf.move_down(5)
+      items << [
+        { content: "#{@labels[:subtotal]}:#{build_sublabel_for_total_table(:subtotal)}", align: :left },
+        { content: @document.subtotal, align: :right }
+      ] unless @document.subtotal.empty?
+
+      items << [
+        { content: "#{@labels[:tax]}:#{build_sublabel_for_total_table(:tax)}", align: :left },
+        { content:  @document.tax, align: :right }
+      ] unless @document.tax.empty?
+
+      items << [
+        { content: "#{@labels[:tax2]}:#{build_sublabel_for_total_table(:tax2)}", align: :left },
+        { content:  @document.tax2, align: :right }
+      ] unless @document.tax2.empty?
+
+      items << [
+        { content: "#{@labels[:tax3]}:#{build_sublabel_for_total_table(:tax3)}", align: :left },
+        { content:  @document.tax3, align: :right }
+      ] unless @document.tax3.empty?
+
+      items << [
+        { content: "\n#{@labels[:total]}:#{build_sublabel_for_total_table(:total)}", align: :left, font_style: :bold, size: 16 },
+        { content:  "\n#{@document.total}", align: :right, font_style: :bold, size: 16 }
+      ] unless @document.total.empty?
+
+      options = {
+        cell_style: {
+          borders: []
+        },
+        position: :right
+      }
 
-        if used? @labels[:sublabels][:total]
-          @pdf.text(
-            "#{@labels[:sublabels][:total]}:   #{@document.total}",
-            size: 12,
-            align: :right
-          )
-        end
-      end
+      @pdf.table(items, options) unless items.empty?
     end
 
     # Return sublabel on a new line or empty string
@@ -858,7 +844,7 @@ module InvoicePrinter
     # If a note is present, position it on top of it.
     def build_logo
       if @logo && !@logo.empty?
-        bottom = @document.note.empty? ? 75 : 85
+        bottom = @document.note.empty? ? 75 : (75 + note_height)
         @pdf.image(@logo, at: [0, bottom], fit: [200, 50])
       end
     end
@@ -876,12 +862,19 @@ module InvoicePrinter
       @pdf.text_box(
         "#{@document.note}",
         size: 10,
-        at: [0, 10],
+        at: [0, note_height],
         width: x(450),
         align: :left
       )
     end
 
+    def note_height
+      @note_height ||= begin
+        num_of_lines = @document.note.lines.count
+        (num_of_lines * 11)
+      end
+    end
+
     # Include page numbers if we got more than one page
     def build_footer
       @pdf.number_pages(