invoice_printer 2.0.0.beta1 → 2.1.0

data/lib/invoice_printer/pdf_document.rb

@@ -94,41 +94,7 @@ module InvoicePrinter
       end
 
       if used? @font
-        if File.exist?(@font)
-          set_fonts(@font) if @font
-        else
-          raise FontFileNotFound, "Font file not found at #{@font}"
-        end
-      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
+        use_font(@font)
       end
 
       build_pdf
@@ -146,8 +112,28 @@ module InvoicePrinter
 
     private
 
+    def use_font(font)
+      if File.exist?(@font)
+        set_font_from_path(@font)
+      else
+        set_builtin_font(@font)
+      end
+    end
+
+    def set_builtin_font(font)
+      require 'invoice_printer/fonts'
+
+      @pdf.font_families.update(
+        "#{font}" => InvoicePrinter::Fonts.paths_for(font)
+      )
+      @pdf.font(font)
+
+    rescue StandardError
+      raise FontFileNotFound, "Font file not found for #{font}"
+    end
+
     # Add font family in Prawn for a given +font+ file
-    def set_fonts(font)
+    def set_font_from_path(font)
       font_name = Pathname.new(font).basename
       @pdf.font_families.update(
         "#{font_name}" => {
@@ -165,6 +151,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
@@ -447,7 +434,6 @@ module InvoicePrinter
       end
 
       # 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
@@ -467,7 +453,8 @@ module InvoicePrinter
           at: [10, y(483) - @push_down],
           width: x(234)
         )
-        @pdf.stroke_rounded_rectangle([0, 508 - @push_down], 270, 45, 6)
+
+        @pdf.stroke_rounded_rectangle([0, y(508) - @push_down], x(266), @payment_box_height, 6)
       else
         @payment_box_height = 60
         @push_iban = 0
@@ -654,6 +641,7 @@ module InvoicePrinter
         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
       end
     end
 
@@ -683,26 +671,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
@@ -726,15 +716,15 @@ 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: 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
@@ -742,15 +732,15 @@ module InvoicePrinter
     # 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
 
@@ -777,13 +767,13 @@ module InvoicePrinter
       @pdf.move_down(25)
 
       items = []
-      items << ["#{@labels[:subtotal]}:#{build_sublabel_for_total_table(:subtotal)}", @document.subtotal] \
+      items << [{ content: "#{@labels[:subtotal]}:#{build_sublabel_for_total_table(:subtotal)}", align: :right }, @document.subtotal] \
         unless @document.subtotal.empty?
-      items << ["#{@labels[:tax]}:#{build_sublabel_for_total_table(:tax)}", @document.tax] \
+      items << [{ content: "#{@labels[:tax]}:#{build_sublabel_for_total_table(:tax)}", align: :right }, @document.tax] \
         unless @document.tax.empty?
-      items << ["#{@labels[:tax2]}:#{build_sublabel_for_total_table(:tax2)}", @document.tax2] \
+      items << [{ content: "#{@labels[:tax2]}:#{build_sublabel_for_total_table(:tax2)}", align: :right }, @document.tax2] \
         unless @document.tax2.empty?
-      items << ["#{@labels[:tax3]}:#{build_sublabel_for_total_table(:tax3)}", @document.tax3] \
+      items << [{ content: "#{@labels[:tax3]}:#{build_sublabel_for_total_table(:tax3)}", align: :right }, @document.tax3] \
         unless @document.tax3.empty?
 
       width = [
@@ -793,16 +783,14 @@ module InvoicePrinter
         "#{@labels[:tax3]}#{@document.tax3}".size
       ].max * 8
 
-      styles = {
-        border_width: 0,
-        align: {
-          0 => :right,
-          1 => :left
+      options = {
+        cell_style: {
+          borders: []
         }
       }
 
       @pdf.span(x(width), position: :right) do
-        @pdf.table(items, styles) unless items.empty?
+        @pdf.table(items, options) unless items.empty?
       end
 
       @pdf.move_down(15)
@@ -841,7 +829,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
@@ -859,12 +847,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(

data/lib/invoice_printer/version.rb

@@ -1,3 +1,3 @@
 module InvoicePrinter
-  VERSION = '2.0.0.beta1'
+  VERSION = '2.1.0'
 end

data/test/api_test.rb

@@ -31,7 +31,7 @@ class ApiTest < Minitest::Test
   end
 
   def test_print_with_valid_document
-    invoice = InvoicePrinter::Document.new(default_document_params)
+    invoice = InvoicePrinter::Document.new(**default_document_params)
 
     json = {
       'document' => invoice.to_h,
@@ -60,7 +60,7 @@ class ApiTest < Minitest::Test
   end
 
   def test_render_with_valid_document
-    invoice  = InvoicePrinter::Document.new(default_document_params)
+    invoice  = InvoicePrinter::Document.new(**default_document_params)
     output   = InvoicePrinter.render(document: invoice)
 
     json = {
@@ -73,6 +73,6 @@ class ApiTest < Minitest::Test
     body = JSON.parse last_response.body
 
     assert last_response.ok?
-    assert_equal body, { 'result' => 'ok', 'data' => Base64.encode64(output) }
+    assert_equal body, { 'result' => 'ok', 'data' => Base64.strict_encode64(output) }
   end
 end

data/test/background_test.rb

@@ -4,7 +4,7 @@ class BackgroundTest < Minitest::Test
   include InvoicePrinterHelpers
 
   def setup
-    @invoice = InvoicePrinter::Document.new(default_document_params)
+    @invoice = InvoicePrinter::Document.new(**default_document_params)
   end
 
   def test_background_render

data/test/cli_test.rb

@@ -8,7 +8,7 @@ class CLITest < Minitest::Test
     t = Time.now.strftime("%Y%m%d")
     tmpname = "/tmp/invoice-#{t}-#{$$}-#{rand(0x100000000).to_s(36)}-fd"
 
-    @invoice         = InvoicePrinter::Document.new(default_document_params)
+    @invoice         = InvoicePrinter::Document.new(**default_document_params)
     @invoice_as_json = @invoice.to_json
     @output_path     = tmpname
   end

data/test/dates_box_test.rb

@@ -8,7 +8,7 @@ class DatesBoxTest < Minitest::Test
       issue_date: '05/03/2016',
       due_date: '14/03/2016'
     )
-    invoice = InvoicePrinter::Document.new(params)
+    invoice = InvoicePrinter::Document.new(**params)
     rendered_pdf = InvoicePrinter.render(document: invoice)
     pdf_analysis = PDF::Inspector::Text.analyze(rendered_pdf)
 
@@ -21,7 +21,7 @@ class DatesBoxTest < Minitest::Test
       issue_date: '05/03/2016',
       due_date: ''
     )
-    invoice = InvoicePrinter::Document.new(params)
+    invoice = InvoicePrinter::Document.new(**params)
     rendered_pdf = InvoicePrinter.render(document: invoice)
     pdf_analysis = PDF::Inspector::Text.analyze(rendered_pdf)
 
@@ -34,7 +34,7 @@ class DatesBoxTest < Minitest::Test
       issue_date: nil,
       due_date: '05/03/2016'
     )
-    invoice = InvoicePrinter::Document.new(params)
+    invoice = InvoicePrinter::Document.new(**params)
     rendered_pdf = InvoicePrinter.render(document: invoice)
     pdf_analysis = PDF::Inspector::Text.analyze(rendered_pdf)
 
@@ -47,7 +47,7 @@ class DatesBoxTest < Minitest::Test
       issue_date: '',
       due_date: nil
     )
-    invoice = InvoicePrinter::Document.new(params)
+    invoice = InvoicePrinter::Document.new(**params)
     rendered_pdf = InvoicePrinter.render(document: invoice)
     pdf_analysis = PDF::Inspector::Text.analyze(rendered_pdf)
 

data/test/examples_test.rb

@@ -11,7 +11,7 @@ class ExamplesTest < Minitest::Test
   end
 
   def teardown
-    FileUtils.rm_rf @test_dir if File.exists?(@test_dir)
+    FileUtils.rm_rf @test_dir if File.exist?(@test_dir)
   end
 
   # 1, copy example to the test directory

data/test/inputs_test.rb

@@ -28,12 +28,12 @@ class InputsTest < Minitest::Test
     )
 
     # No exceptions should be raised
-    invoice = InvoicePrinter::Document.new(params)
+    invoice = InvoicePrinter::Document.new(**params)
     InvoicePrinter.render(document: invoice)
   end
 
   def test_missing_font_raises_an_exception
-    invoice = InvoicePrinter::Document.new(default_document_params)
+    invoice = InvoicePrinter::Document.new(**default_document_params)
 
     assert_raises(InvoicePrinter::PDFDocument::FontFileNotFound) do
       InvoicePrinter.render(document: invoice, font: 'missing.font')
@@ -41,7 +41,7 @@ class InputsTest < Minitest::Test
   end
 
   def test_missing_logo_raises_an_exception
-    invoice = InvoicePrinter::Document.new(default_document_params)
+    invoice = InvoicePrinter::Document.new(**default_document_params)
 
     assert_raises(InvoicePrinter::PDFDocument::LogoFileNotFound) do
       InvoicePrinter.render(document: invoice, logo: 'missing.png')
@@ -49,7 +49,7 @@ class InputsTest < Minitest::Test
   end
 
   def test_missing_stamp_raises_an_exception
-    invoice = InvoicePrinter::Document.new(default_document_params)
+    invoice = InvoicePrinter::Document.new(**default_document_params)
 
     assert_raises(InvoicePrinter::PDFDocument::StampFileNotFound) do
       InvoicePrinter.render(document: invoice, stamp: 'missing.png')

data/test/invoice_printer_test.rb

@@ -4,7 +4,7 @@ class InvoicePrinterTest < Minitest::Test
   include InvoicePrinterHelpers
 
   def test_render_document
-    invoice      = InvoicePrinter::Document.new(default_document_params)
+    invoice      = InvoicePrinter::Document.new(**default_document_params)
     rendered_pdf = InvoicePrinter.render(document: invoice)
     pdf_analysis = PDF::Inspector::Text.analyze(rendered_pdf)
     strings      = InvoicePrinter::PDFDocument.new(document: invoice).to_a
@@ -13,7 +13,7 @@ class InvoicePrinterTest < Minitest::Test
   end
 
   def test_render_document_from_json
-    invoice           = InvoicePrinter::Document.new(default_document_params)
+    invoice           = InvoicePrinter::Document.new(**default_document_params)
     invoice_json      = JSON.parse(invoice.to_json)
     invoice_from_json = InvoicePrinter::Document.from_json(invoice_json)
     rendered_pdf      = InvoicePrinter.render(document: invoice_from_json)

data/test/items_table_test.rb

@@ -41,10 +41,10 @@ class ItemsTableTest < Minitest::Test
 
   def invoice_without_item_column(column)
     InvoicePrinter::Document.new(
-      default_document_params.merge(
+      **default_document_params.merge(
         items: [
           InvoicePrinter::Document::Item.new(
-            default_document_item_params.merge("#{column}": nil)
+            **default_document_item_params.merge("#{column}": nil)
           )
         ]
       )

data/test/labels_test.rb

@@ -6,7 +6,7 @@ class LabelsTest < Minitest::Test
   def test_setting_global_labels
     labels = { provider: 'Default Provider', purchaser: 'Default Purchaser' }
     InvoicePrinter.labels = labels
-    invoice = InvoicePrinter::Document.new(default_document_params)
+    invoice = InvoicePrinter::Document.new(**default_document_params)
     rendered_pdf = InvoicePrinter.render(document: invoice)
     pdf_analysis = PDF::Inspector::Text.analyze(rendered_pdf)
 
@@ -16,7 +16,7 @@ class LabelsTest < Minitest::Test
 
   def test_setting_instant_labels
     labels = { provider: 'Current Provider', purchaser: 'Current Purchaser' }
-    invoice = InvoicePrinter::Document.new(default_document_params)
+    invoice = InvoicePrinter::Document.new(**default_document_params)
     rendered_pdf = InvoicePrinter.render(document: invoice, labels: labels)
     pdf_analysis = PDF::Inspector::Text.analyze(rendered_pdf)
 

data/test/notes_test.rb

@@ -7,7 +7,7 @@ class NotesTest < Minitest::Test
     params = default_document_params.merge(
       note: 'ABC is a registered trademark.'
     )
-    invoice = InvoicePrinter::Document.new(params)
+    invoice = InvoicePrinter::Document.new(**params)
     rendered_pdf = InvoicePrinter.render(document: invoice)
     pdf_analysis = PDF::Inspector::Text.analyze(rendered_pdf)