invoice_printer 2.0.0 → 2.1.0.rc1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 97ea4a809c4a18acd04d91edcef4d1950468c230a417e7df3908ecc03eb53766
-  data.tar.gz: ffc3a08b88914e8761fa925b6a3b6ff11e47b2e49e9c2542d566f358c378adbb
+  metadata.gz: 926ffa0b9c6ce419a715122202dbc5e5b6489323c0daafe1da259cb86efb0acc
+  data.tar.gz: d0a6882d42b488d4df932f8b5981a188beb515af31ec3a0d5eb49a6b64a28882
 SHA512:
-  metadata.gz: 45b38f99524e0a0b6b44028ec55e4cdce79fcdfcf8c9cf6a40b8cc4878a26da59cb55cf90038bbb56142cd210873f9e534cc8e5156b5a426a19d0305bf404239
-  data.tar.gz: d5369bc2301aaa7ae07d7196a2ccc3363fb8827776c155bf668747775699e3c6f7691a5a090f3ce2fdda325891a2e39ccb7a5c9fbf07c0619ccb13820eb8aeae
+  metadata.gz: 383e3dc9b714a1faf3a585ed9313db8d0e77031d4556643894395757de723a787b216f5af2eba8ea7aa5c183c0d5ea55bc69534bf9bc40def043767f10c9aeb3
+  data.tar.gz: b53666c983492ffc59668c305b4b1e1e914f78488a44ec8c048c83de847a4a3559a0092534795d985a61c0192698ab99a2f0b3ecdf8d74a91dde1ff3a7f524af

data/Gemfile.lock

@@ -1,12 +1,12 @@
 PATH
   remote: .
   specs:
-    invoice_printer (2.0.0.beta3)
+    invoice_printer (2.0.0)
       json (~> 2.1)
       prawn (~> 2.2)
       prawn-table (~> 0.2.2)
-    invoice_printer_server (2.0.0.beta3)
-      invoice_printer (= 2.0.0.beta3)
+    invoice_printer_server (2.0.0)
+      invoice_printer (= 2.0.0)
       json (~> 2.1)
       puma (>= 3.9.0)
       roda (~> 3.5)
@@ -20,37 +20,39 @@ GEM
     benchmark_driver-output-gruff (0.3.1)
       benchmark_driver (>= 0.12.0)
       gruff
-    gruff (0.7.0)
-      rmagick (~> 2.13, >= 2.13.4)
+    gruff (0.11.0)
+      histogram
+      rmagick
     hashery (2.1.2)
-    json (2.2.0)
-    minitest (5.11.3)
-    nio4r (2.5.1)
-    pdf-core (0.7.0)
+    histogram (0.2.4.1)
+    json (2.3.1)
+    minitest (5.14.2)
+    nio4r (2.5.4)
+    pdf-core (0.9.0)
     pdf-inspector (1.3.0)
       pdf-reader (>= 1.0, < 3.0.a)
-    pdf-reader (2.2.1)
+    pdf-reader (2.4.1)
       Ascii85 (~> 1.0.0)
       afm (~> 0.2.1)
       hashery (~> 2.0)
       ruby-rc4
       ttfunk
-    prawn (2.2.2)
-      pdf-core (~> 0.7.0)
-      ttfunk (~> 1.5)
+    prawn (2.4.0)
+      pdf-core (~> 0.9.0)
+      ttfunk (~> 1.7)
     prawn-table (0.2.2)
       prawn (>= 1.3.0, < 3.0.0)
-    puma (4.1.0)
+    puma (5.0.2)
       nio4r (~> 2.0)
-    rack (2.0.7)
+    rack (2.2.3)
     rack-test (1.1.0)
       rack (>= 1.0, < 3)
-    rake (12.3.3)
-    rmagick (2.16.0)
-    roda (3.23.0)
+    rake (13.0.1)
+    rmagick (4.1.2)
+    roda (3.36.0)
       rack
     ruby-rc4 (0.1.5)
-    ttfunk (1.5.1)
+    ttfunk (1.7.0)
 
 PLATFORMS
   ruby
@@ -66,4 +68,4 @@ DEPENDENCIES
   rake (>= 10.0)
 
 BUNDLED WITH
-   1.17.2
+   2.1.4

data/README.md

@@ -28,7 +28,7 @@ See more usecases in the `examples/` directory.
 - Configurable items' table with item description, quantity, unit, price per unit, tax and item's total amount fields
 - Final subtotal/tax/total info box
 - Page numbers
-- Configurable labels & sublabels (optional little labels)
+- Configurable field labels & sublabels (optional little labels)
 - Configurable font file
 - Logotype (as image scaled to fit 50px of height)
 - Background (as image)
@@ -48,4 +48,4 @@ See more usecases in the `examples/` directory.
 
 ## Copyright
 
-Copyright 2015-2019 © [Josef Strzibny](http://strzibny.name/). MIT licensed.
+Copyright 2015-2021 © [Josef Strzibny](http://strzibny.name/). MIT licensed.

data/benchmarks/render.yml

@@ -8,6 +8,17 @@ prelude: |
   $LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
   require 'invoice_printer'
 
+  provider_address = <<ADDRESS
+  Rolnická 1
+  747 05  Opava
+  Kateřinky
+  ADDRESS
+
+  purchaser_address = <<ADDRESS
+  Ostravská 1
+  747 70  Opava
+  ADDRESS
+
   item = InvoicePrinter::Document::Item.new(
     name: 'Programming',
     quantity: '10',
@@ -19,15 +30,9 @@ prelude: |
   invoice = InvoicePrinter::Document.new(
     number: 'NO. 198900000001',
     provider_name: 'John White',
-    provider_street: '5th Avenue',
-    provider_street_number: '1',
-    provider_postcode: '747 05',
-    provider_city: 'NYC',
+    provider_lines: provider_address,
     purchaser_name: 'Will Black',
-    purchaser_street: '7th Avenue',
-    purchaser_street_number: '1',
-    purchaser_postcode: '747 70',
-    purchaser_city: 'NYC',
+    purchaser_lines: purchaser_address,
     issue_date: '05/03/2016',
     due_date: '19/03/2016',
     total: '$ 900',

data/docs/COMMAND_LINE.md

@@ -20,6 +20,125 @@ Options:
   -f, --filename   output path
     -r, --render   directly render PDF stream (filename option will be ignored)
 ```
+
+## Document
+
+JSON document with all possible fields filled:
+
+```json
+{
+  "number":"c. 198900000001",
+  "provider_name":"Petr Novy",
+  "provider_tax_id":"56565656",
+  "provider_tax_id2":"",
+  "provider_lines":"Rolnická 1\n747 05  Opava\nKateřinky",
+  "purchaser_name":"Adam Cerny",
+  "purchaser_tax_id":"",
+  "purchaser_tax_id2":"",
+  "purchaser_lines":"Ostravská 1\n747 70  Opava",
+  "issue_date":"05/03/2016",
+  "due_date":"19/03/2016",
+  "subtotal":"Kc 10.000",
+  "tax":"Kc 2.100",
+  "tax2":"",
+  "tax3":"",
+  "variable":"Extra column",
+  "total":"Kc 12.100,-",
+  "bank_account_number":"156546546465",
+  "account_iban":"IBAN464545645",
+  "account_swift":"SWIFT5456",
+  "items":[
+    {
+       "name":"Konzultace",
+       "variable": "",
+       "quantity":"2",
+       "unit":"hod",
+       "price":"Kc 500",
+       "tax":"",
+       "tax2":"",
+       "tax3":"",
+       "amount":"Kc 1.000"
+    },
+    {
+       "name":"Programovani",
+       "variable": "",
+       "quantity":"10",
+       "unit":"hod",
+       "price":"Kc 900",
+       "tax":"",
+       "tax2":"",
+       "tax3":"",
+       "amount":"Kc 9.000"
+    }
+  ],
+  "note":"Osoba je zapsána v zivnostenském rejstríku."
+}
+```
+
+**Note**: `provider_lines` and `purchaser_lines` are 4 lines of data separated by new line character`\n`. Other lines are being stripped.
+
+**Note**: There is `variable` field that can be used for any
+extra column.
+
+## Field labels
+
+All labels:
+
+```json
+{
+  "name":"Invoice",
+  "provider":"Provider",
+  "purchaser":"Purchaser",
+  "tax_id":"Identification number",
+  "tax_id2":"Identification number",
+  "payment":"Payment",
+  "payment_by_transfer":"Payment by bank transfer on the account below:",
+  "payment_in_cash":"Payment in cash",
+  "account_number":"Account NO",
+  "swift":"SWIFT",
+  "iban":"IBAN",
+  "issue_date":"Issue date",
+  "due_date": "Due date",
+  "item":"Item",
+  "variable":"",
+  "quantity":"Quantity",
+  "unit": "Unit",
+  "price_per_item":"Price per item",
+  "amount":"Amount",
+  "tax":"Tax",
+  "tax2":"Tax 2",
+  "tax3":"Tax 3",
+  "subtotal":"Subtotal",
+  "total":"Total",
+  "sublabels":{
+    "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",
+    "variable:":"",
+    "quantity":"Počet",
+    "unit":"MJ",
+    "price_per_item":"Cena za položku",
+    "amount":"Celkem bez daně",
+    "subtota":"Cena bez daně",
+    "tax":"DPH 21 %",
+    "total":"Celkem"
+  }
+}
+```
+**Note**: Notice the `sublabels` which you might not want to necessary include.
+
+## Built-in fonts
+
+Supported builtin fonts are: `overpass`, `opensans`, and `roboto`.
+
 ## Examples
 
 ```

data/docs/LIBRARY.md

@@ -72,13 +72,11 @@ invoice = InvoicePrinter::Document.new(
 **Note**: `provider_lines` and `purchaser_lines` are 4 lines of data separated by new line character`\n`. Other lines are being stripped.
 
 **Note**: There is `variable` field that can be used for any
-extra column. `tax2` and `tax3` for more complex taxes are
-available as well.
+extra column.
 
 ### Ruby on Rails
 
-If you want to use InvoicePrinter for printing PDF documents directly from Rails
-actions, you can:
+If you want to use InvoicePrinter for printing PDF documents directly from Rails actions, you can:
 
 ```ruby
 # GET /invoices/1
@@ -109,11 +107,8 @@ InvoicePrinter.print(
   document:  document,
   ...
 )
-
 ```
 
-
-
 ## Customization
 
 ### Page size
@@ -153,8 +148,7 @@ InvoicePrinter.print(
 )
 ```
 
-Here is the full list of labels to configure. You can paste and edit this block
-to `initializers/invoice_printer.rb` if you are using Rails.
+Here is the full list of labels to configure. You can paste and edit this block to `initializers/invoice_printer.rb` if you are using Rails.
 
 ```ruby
 InvoicePrinter.labels = {
@@ -226,16 +220,23 @@ Now the document will have little sublabels next to the original labels in Czech
 
 To support specific characters you might need to specify a TTF font to be used:
 
-``` ruby
+```ruby
 InvoicePrinter.print(
   ...
   font: File.expand_path('../Overpass-Regular.ttf', __FILE__)
 )
 ```
 
-If you don't have a font around, you can install `invoice_printer_fonts` gem and specify the supported font name instead.
+If you don't have a font around, you can install `invoice_printer_fonts` gem and specify the supported font name instead:
+
+```ruby
+InvoicePrinter.print(
+  document: invoice,
+  font: "roboto"
+)
+```
 
-Supported builtin fonts are: `overpass`, `opensans`, and `ruboto`. Note that searching the path takes preference.
+Supported builtin fonts are: `overpass`, `opensans`, and `roboto`. Note that searching the path takes preference.
 
 ### Background
 

data/docs/SERVER.md

@@ -23,9 +23,11 @@ By default server binds to `0.0.0.0:9393`.
 Get the public image and run it:
 
 ```bash
-$ sudo docker pull strzibnyj/invoice_printer_server:latest
-$ sudo docker run -d -p 9393:9393 -t docker.io/strzibnyj/invoice_printer_server
+$ sudo docker pull strzibnyj/invoice_printer_server:$VERSION
+$ sudo docker run -d -p 9393:9393 -v ~/path/to/invocies:/data:Z -t docker.io/strzibnyj/invoice_printer_server
 ```
+You can use `latest` as a `$VERSION`. Specifying the `-v` option is only required when using the `/print` action to create the documents at certain path. It will allow you to provide the desired filename as "/data/invoice-name.pdf".
+
 The server will then be available on `0.0.0.0:9393`.
 
 Docker image already contains the optional `invoice_printer_fonts` gem.
@@ -64,6 +66,8 @@ Options:
 - `background` - path to background file
 - `page_size` - letter or A4 page size
 
+These parameters are the same as for the [command line](./COMMAND_LINE.md).
+
 On success a `200` response is returned:
 
 ```json

data/examples/provider_purchaser_lines.rb

@@ -47,7 +47,8 @@ Rolnická 1
 747 05  Opava
 Kateřinky
 
-fith line wont show
+
+6th line wont show
 ADDRESS
 
 purchaser_address = <<ADDRESS
@@ -55,8 +56,7 @@ Ostravská 1
 747 70  Opava
 
 
-
-fith line wont show
+6th line wont show
 ADDRESS
 
 invoice = InvoicePrinter::Document.new(
@@ -64,20 +64,11 @@ invoice = InvoicePrinter::Document.new(
   provider_name: 'Petr Nový',
   provider_tax_id: '56565656',
   provider_tax_id2: 'CZ56565656',
-  provider_street: 'Rolnická',
-  provider_street_number: '1',
-  provider_postcode: '747 05',
-  provider_city: 'Opava',
-  provider_city_part: 'Kateřinky',
   provider_lines: provider_address,
   purchaser_name: 'Adam Černý',
-  purchaser_street: 'Ostravská',
-  purchaser_street_number: '1',
-  purchaser_postcode: '747 70',
-  purchaser_city: 'Opava',
-  purchaser_lines: purchaser_address,
   purchaser_tax_id: '56565656',
   purchaser_tax_id2: 'CZ56565656',
+  purchaser_lines: purchaser_address,
   issue_date: '05/03/2016',
   due_date: '19/03/2016',
   subtotal: 'Kč 10.000',

data/examples/simple_invoice.rb

@@ -5,6 +5,16 @@ lib = File.expand_path('../../lib', __FILE__)
 $LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
 require 'invoice_printer'
 
+provider_address = <<ADDRESS
+5th Avenue
+747 05  NYC
+ADDRESS
+
+purchaser_address = <<ADDRESS
+7th Avenue
+747 70  NYC
+ADDRESS
+
 item = InvoicePrinter::Document::Item.new(
   name: 'Programming',
   quantity: '10',
@@ -16,25 +26,14 @@ item = InvoicePrinter::Document::Item.new(
 invoice = InvoicePrinter::Document.new(
   number: 'NO. 198900000001',
   provider_name: 'John White',
-  # Deprecated 1.3 API, use provider_lines
-  # Here for compatibility test
-  provider_street: '5th Avenue',
-  provider_street_number: '1',
-  provider_postcode: '747 05',
-  provider_city: 'NYC',
-  purchaser_name: 'Will Black',
-  # Deprecated 1.3 API, use purchaser_lines
-  # Here for compatibility test
-  purchaser_street: '7th Avenue',
-  purchaser_street_number: '1',
-  purchaser_postcode: '747 70',
-  purchaser_city: 'NYC',
+  provider_lines: provider_address,
+  purchaser_lines: purchaser_address,
   issue_date: '05/03/2016',
   due_date: '19/03/2016',
   total: '$ 900',
   bank_account_number: '156546546465',
   items: [item],
-  note: 'This is a note at the end.'
+  note: "This is a note at the end.\nA note with two lines."
 )
 
 InvoicePrinter.print(

data/lib/invoice_printer/document.rb

@@ -39,25 +39,11 @@ module InvoicePrinter
                 :provider_tax_id,
                 :provider_tax_id2,
                 :provider_lines,
-                # Provider address fields
-                :provider_street,
-                :provider_street_number,
-                :provider_postcode,
-                :provider_city,
-                :provider_city_part,
-                :provider_extra_address_line,
                 # Purchaser fields
                 :purchaser_name,
                 :purchaser_tax_id,
                 :purchaser_tax_id2,
                 :purchaser_lines,
-                # Purchaser address fields
-                :purchaser_street,
-                :purchaser_street_number,
-                :purchaser_postcode,
-                :purchaser_city,
-                :purchaser_city_part,
-                :purchaser_extra_address_line,
                 :issue_date,
                 :due_date,
                 # Account details
@@ -76,113 +62,75 @@ module InvoicePrinter
     class << self
       def from_json(json)
         new(
-          number:                       json['number'],
-          provider_name:                json['provider_name'],
-          provider_tax_id:              json['provider_tax_id'],
-          provider_tax_id2:             json['provider_tax_id2'],
-          provider_street:              json['provider_street'],
-          provider_street_number:       json['provider_street_number'],
-          provider_postcode:            json['provider_postcode'],
-          provider_city:                json['provider_city'],
-          provider_city_part:           json['provider_city_part'],
-          provider_extra_address_line:  json['provider_extra_address_line'],
-          provider_lines:               json['provider_lines'],
-          purchaser_name:               json['purchaser_name'],
-          purchaser_tax_id:             json['purchaser_tax_id'],
-          purchaser_tax_id2:            json['purchaser_tax_id2'],
-          purchaser_street:             json['purchaser_street'],
-          purchaser_street_number:      json['purchaser_street_number'],
-          purchaser_postcode:           json['purchaser_postcode'],
-          purchaser_city:               json['purchaser_city'],
-          purchaser_city_part:          json['purchaser_city_part'],
-          purchaser_extra_address_line: json['purchaser_extra_address_line'],
-          purchaser_lines:              json['purchaser_lines'],
-          issue_date:                   json['issue_date'],
-          due_date:                     json['due_date'],
-          subtotal:                     json['subtotal'],
-          tax:                          json['tax'],
-          tax2:                         json['tax2'],
-          tax3:                         json['tax3'],
-          total:                        json['total'],
-          bank_account_number:          json['bank_account_number'],
-          account_iban:                 json['account_iban'],
-          account_swift:                json['account_swift'],
-          note:                         json['note'],
+          number: json['number'],
+          provider_name: json['provider_name'],
+          provider_tax_id: json['provider_tax_id'],
+          provider_tax_id2: json['provider_tax_id2'],
+          provider_lines: json['provider_lines'],
+          purchaser_name: json['purchaser_name'],
+          purchaser_tax_id: json['purchaser_tax_id'],
+          purchaser_tax_id2: json['purchaser_tax_id2'],
+          purchaser_lines: json['purchaser_lines'],
+          issue_date: json['issue_date'],
+          due_date: json['due_date'],
+          subtotal: json['subtotal'],
+          tax: json['tax'],
+          tax2: json['tax2'],
+          tax3: json['tax3'],
+          total: json['total'],
+          bank_account_number: json['bank_account_number'],
+          account_iban: json['account_iban'],
+          account_swift: json['account_swift'],
+          note: json['note'],
 
-          items:                        (json['items'] || []).map { |item_json| Item.from_json(item_json) }
+          items: (json['items'] || []).map { |item_json| Item.from_json(item_json) }
         )
       end
     end
 
-    def initialize(number:                       nil,
-                   provider_name:                nil,
-                   provider_tax_id:              nil,
-                   provider_tax_id2:             nil,
-                   provider_street:              nil,
-                   provider_street_number:       nil,
-                   provider_postcode:            nil,
-                   provider_city:                nil,
-                   provider_city_part:           nil,
-                   provider_extra_address_line:  nil,
-                   provider_lines:               nil,
-                   purchaser_name:               nil,
-                   purchaser_tax_id:             nil,
-                   purchaser_tax_id2:            nil,
-                   purchaser_street:             nil,
-                   purchaser_street_number:      nil,
-                   purchaser_postcode:           nil,
-                   purchaser_city:               nil,
-                   purchaser_city_part:          nil,
-                   purchaser_extra_address_line: nil,
-                   purchaser_lines:              nil,
-                   issue_date:                   nil,
-                   due_date:                     nil,
-                   subtotal:                     nil,
-                   tax:                          nil,
-                   tax2:                         nil,
-                   tax3:                         nil,
-                   total:                        nil,
-                   bank_account_number:          nil,
-                   account_iban:                 nil,
-                   account_swift:                nil,
-                   items:                        nil,
-                   note:                         nil)
-
-      @number                       = String(number)
-      @provider_name                = String(provider_name)
-      @provider_tax_id              = String(provider_tax_id)
-      @provider_tax_id2             = String(provider_tax_id2)
-      @provider_street              = String(provider_street)
-      @provider_street_number       = String(provider_street_number)
-      @provider_postcode            = String(provider_postcode)
-      @provider_city                = String(provider_city)
-      @provider_city_part           = String(provider_city_part)
-      @provider_extra_address_line  = String(provider_extra_address_line)
-      @provider_lines               = String(provider_lines)
-      @purchaser_name               = String(purchaser_name)
-      @purchaser_tax_id             = String(purchaser_tax_id)
-      @purchaser_tax_id2            = String(purchaser_tax_id2)
-      @purchaser_street             = String(purchaser_street)
-      @purchaser_street_number      = String(purchaser_street_number)
-      @purchaser_postcode           = String(purchaser_postcode)
-      @purchaser_city               = String(purchaser_city)
-      @purchaser_city_part          = String(purchaser_city_part)
-      @purchaser_extra_address_line = String(purchaser_extra_address_line)
-      @purchaser_lines              = String(purchaser_lines)
-      @issue_date                   = String(issue_date)
-      @due_date                     = String(due_date)
-      @subtotal                     = String(subtotal)
-      @tax                          = String(tax)
-      @tax2                         = String(tax2)
-      @tax3                         = String(tax3)
-      @total                        = String(total)
-      @bank_account_number          = String(bank_account_number)
-      @account_iban                 = String(account_iban)
-      @account_swift                = String(account_swift)
-      @items                        = items
-      @note                         = String(note)
-
+    def initialize(number: nil,
+                   provider_name: nil,
+                   provider_tax_id: nil,
+                   provider_tax_id2: nil,
+                   provider_lines: nil,
+                   purchaser_name: nil,
+                   purchaser_tax_id: nil,
+                   purchaser_tax_id2: nil,
+                   purchaser_lines: nil,
+                   issue_date: nil,
+                   due_date: nil,
+                   subtotal: nil,
+                   tax: nil,
+                   tax2: nil,
+                   tax3: nil,
+                   total: nil,
+                   bank_account_number: nil,
+                   account_iban: nil,
+                   account_swift:  nil,
+                   items: nil,
+                   note: nil)
 
+      @number = String(number)
+      @provider_name = String(provider_name)
+      @provider_tax_id = String(provider_tax_id)
+      @provider_tax_id2 = String(provider_tax_id2)
+      @provider_lines = String(provider_lines)
+      @purchaser_name = String(purchaser_name)
+      @purchaser_tax_id = String(purchaser_tax_id)
+      @purchaser_tax_id2 = String(purchaser_tax_id2)
+      @purchaser_lines = String(purchaser_lines)
+      @issue_date = String(issue_date)
+      @due_date = String(due_date)
+      @subtotal = String(subtotal)
+      @tax = String(tax)
+      @tax2 = String(tax2)
+      @tax3 = String(tax3)
+      @total = String(total)
+      @bank_account_number = String(bank_account_number)
+      @account_iban = String(account_iban)
+      @account_swift = String(account_swift)
+      @items = items
+      @note = String(note)
 
       raise InvalidInput, 'items are not only a type of InvoicePrinter::Document::Item' \
         unless @items.select{ |i| !i.is_a?(InvoicePrinter::Document::Item) }.empty?
@@ -190,39 +138,27 @@ module InvoicePrinter
 
     def to_h
       {
-        'number':                       @number,
-        'provider_name':                @provider_name,
-        'provider_tax_id':              @provider_tax_id,
-        'provider_tax_id2':             @provider_tax_id2,
-        'provider_street':              @provider_street,
-        'provider_street_number':       @provider_street_number,
-        'provider_postcode':            @provider_postcode,
-        'provider_city':                @provider_city,
-        'provider_city_part':           @provider_city_part,
-        'provider_extra_address_line':  @provider_extra_address_line,
-        'provider_lines':               @provider_lines,
-        'purchaser_name':               @purchaser_name,
-        'purchaser_tax_id':             @purchaser_tax_id,
-        'purchaser_tax_id2':            @purchaser_tax_id2,
-        'purchaser_street':             @purchaser_street,
-        'purchaser_street_number':      @purchaser_street_number,
-        'purchaser_postcode':           @purchaser_postcode,
-        'purchaser_city':               @purchaser_city,
-        'purchaser_city_part':          @purchaser_city_part,
-        'purchaser_extra_address_line': @purchaser_extra_address_line,
-        'purchaser_lines':              @purchaser_lines,
-        'issue_date':                   @issue_date,
-        'due_date':                     @due_date,
-        'subtotal':                     @subtotal,
-        'tax':                          @tax,
-        'tax2':                         @tax2,
-        'tax3':                         @tax3,
-        'total':                        @total,
-        'bank_account_number':          @bank_account_number,
-        'account_iban':                 @account_iban,
-        'account_swift':                @account_swift,
-        'items':                        @items.map(&:to_h),
-        'note':                         @note
+        'number': @number,
+        'provider_name': @provider_name,
+        'provider_tax_id': @provider_tax_id,
+        'provider_tax_id2': @provider_tax_id2,
+        'provider_lines': @provider_lines,
+        'purchaser_name': @purchaser_name,
+        'purchaser_tax_id': @purchaser_tax_id,
+        'purchaser_tax_id2': @purchaser_tax_id2,
+        'purchaser_lines': @purchaser_lines,
+        'issue_date': @issue_date,
+        'due_date': @due_date,
+        'subtotal': @subtotal,
+        'tax': @tax,
+        'tax2': @tax2,
+        'tax3': @tax3,
+        'total': @total,
+        'bank_account_number': @bank_account_number,
+        'account_iban': @account_iban,
+        'account_swift': @account_swift,
+        'items': @items.map(&:to_h),
+        'note': @note
       }
     end
 

data/lib/invoice_printer/pdf_document.rb

@@ -97,36 +97,6 @@ module InvoicePrinter
         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
-      end
-
       build_pdf
     end
 
@@ -859,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
@@ -877,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'
+  VERSION = '2.1.0.rc1'
 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 = {

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/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)
 

data/test/page_numbers_test.rb

@@ -5,11 +5,11 @@ class PageNumbersTest < Minitest::Test
 
   # If there is only one page, we skip numbering
   def test_do_not_number_1_page
-    item = InvoicePrinter::Document::Item.new(default_document_item_params)
+    item = InvoicePrinter::Document::Item.new(**default_document_item_params)
     params = default_document_params.merge(
       items: [item]
     )
-    invoice = InvoicePrinter::Document.new(params)
+    invoice = InvoicePrinter::Document.new(**params)
     rendered_pdf = InvoicePrinter.render(document: invoice)
     pdf_analysis = PDF::Inspector::Text.analyze(rendered_pdf)
 
@@ -17,12 +17,12 @@ class PageNumbersTest < Minitest::Test
   end
 
   def test_number_2_and_more_pages
-    item = InvoicePrinter::Document::Item.new(default_document_item_params)
+    item = InvoicePrinter::Document::Item.new(**default_document_item_params)
     items = [item] * 50
     params = default_document_params.merge(
       items: items
     )
-    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/payment_box_test.rb

@@ -8,7 +8,7 @@ class PaymentBoxTest < Minitest::Test
       bank_account_number: nil,
       account_iban: 'IBAN'
     )
-    invoice = InvoicePrinter::Document.new(params)
+    invoice = InvoicePrinter::Document.new(**params)
     rendered_pdf = InvoicePrinter.render(document: invoice)
     pdf_analysis = PDF::Inspector::Text.analyze(rendered_pdf)
 
@@ -24,7 +24,7 @@ class PaymentBoxTest < Minitest::Test
       account_iban: nil,
       account_swift: 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)
 
@@ -41,7 +41,7 @@ class PaymentBoxTest < Minitest::Test
       account_iban: 'SAMPLE_IBAN',
       account_swift: 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)
 
@@ -59,7 +59,7 @@ class PaymentBoxTest < Minitest::Test
       account_iban: nil,
       account_swift: 'SAMPLE_SWIFT'
     )
-    invoice = InvoicePrinter::Document.new(params)
+    invoice = InvoicePrinter::Document.new(**params)
     rendered_pdf = InvoicePrinter.render(document: invoice)
     pdf_analysis = PDF::Inspector::Text.analyze(rendered_pdf)
 
@@ -77,7 +77,7 @@ class PaymentBoxTest < Minitest::Test
       account_iban: 'SAMPLE_IBAN',
       account_swift: 'SAMPLE_SWIFT'
     )
-    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/test_helper.rb

@@ -33,7 +33,7 @@ module InvoicePrinterHelpers
       account_swift: 'SWIFT5456',
       items: [
         InvoicePrinter::Document::Item.new(
-          default_document_item_params
+          **default_document_item_params
         )
       ]
     }

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: invoice_printer
 version: !ruby/object:Gem::Version
-  version: 2.0.0
+  version: 2.1.0.rc1
 platform: ruby
 authors:
 - Josef Strzibny
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2019-10-02 00:00:00.000000000 Z
+date: 2021-03-28 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: json
@@ -153,11 +153,11 @@ required_ruby_version: !ruby/object:Gem::Requirement
       version: '2.4'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
-  - - ">="
+  - - ">"
     - !ruby/object:Gem::Version
-      version: '0'
+      version: 1.3.1
 requirements: []
-rubygems_version: 3.0.3
+rubygems_version: 3.2.0.rc.1
 signing_key: 
 specification_version: 4
 summary: Super simple PDF invoicing in pure Ruby