invoice_printer 2.0.0.beta1 → 2.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 1a929bb5d414cc64bf5f30a97baa8b7b39e9a3bb12eb03efe96eab827bc417b4
-  data.tar.gz: a1ab11498fed952e4d008aa93d00e2ab2be4b73a65cb38d03e04aa226d027e5e
+  metadata.gz: c3af0c9fadd39c8a23600e405aa0dcf2d31945f0fef9aa4bb40a13768ea156c7
+  data.tar.gz: 124c1a57d4c11a99da95301ac1be5715f358bfd2654d350345f9e23afefc6035
 SHA512:
-  metadata.gz: e93b4d97f28e264dd6385776a49852614ad454fdbe80d00e2d66d3dd98c7614a9c74953a02d30744eb5a148ce250e6418c20a7107a32d0400062e5311f79ac49
-  data.tar.gz: 2c1907bb3b0e0fc111139f9fdf808dd869c0dc41d359cee43cd1178919670c312be30361c362e74a0a76f8771b6d925a1edaff358348bba68676e3e821ec316b
+  metadata.gz: f9a788d351c01c97b99bb50653bf883b363909b54d5d0d65d7b0421a6ec444b2886e6ef7bbb18bc332d59977c0f60700c60efe1ec0cc67c62b075edf3306297e
+  data.tar.gz: 3051327dd4011d6ca954981fdfcc05edf2af1ad242355cb029d2c40a29de0e1b18d430b77131b572fe2db975a9ff371c91317a4cf345d7510801d7b594e76257

data/Dockerfile

@@ -11,21 +11,25 @@
 #
 #   $ sudo docker login
 #   $ sudo docker tag printer docker.io/strzibnyj/invoice_printer_server:latest
+#   $ sudo docker push strzibnyj/invoice_printer_server:$VERSION
 #   $ sudo docker push strzibnyj/invoice_printer_server:latest
-FROM alpine:3.10
+FROM alpine:3.13
 MAINTAINER Josef Strzibny <strzibny@strzibny.name>
 
 ENV GEM_HOME="/usr/local/bundle"
 ENV PATH $GEM_HOME/bin:$GEM_HOME/gems/bin:$PATH
 
 # Update system
-RUN apk update &&  apk upgrade
+RUN apk update && apk upgrade
 
 # Install Ruby and build dependencies
 RUN apk add build-base bash ruby ruby-etc ruby-dev
 
-# Install gem from RubyGems.org
-RUN gem install invoice_printer_server --version 2.0.0.beta1 --no-document
+# Install builtin fonts
+RUN gem install invoice_printer_fonts --version 2.1.0 --no-document
+
+# Install the gem from RubyGems.org
+RUN gem install invoice_printer_server --version 2.1.0 --no-document
 
 # Clean APK cache
 RUN rm -rf /var/cache/apk/*

data/Gemfile

@@ -10,7 +10,7 @@ group :test do
 end
 
 group :benchmark do
-  gem 'benchmark_driver', '0.14.11'
+  gem 'benchmark_driver', '0.15.17'
   # For generating benchmark reports with --output gruff
   gem 'benchmark_driver-output-gruff'
 end

data/Gemfile.lock

@@ -1,7 +1,12 @@
 PATH
   remote: .
   specs:
-    invoice_printer_server (2.0.0.alpha1)
+    invoice_printer (2.1.0.rc1)
+      json (~> 2.1)
+      prawn (~> 2.2)
+      prawn-table (~> 0.2.2)
+    invoice_printer_server (2.1.0.rc1)
+      invoice_printer (= 2.1.0.rc1)
       json (~> 2.1)
       puma (>= 3.9.0)
       roda (~> 3.5)
@@ -11,41 +16,49 @@ GEM
   specs:
     Ascii85 (1.0.3)
     afm (0.2.2)
-    benchmark_driver (0.14.11)
+    benchmark_driver (0.15.17)
     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.3.1)
+    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.0)
+    pdf-reader (2.4.1)
       Ascii85 (~> 1.0.0)
       afm (~> 0.2.1)
       hashery (~> 2.0)
       ruby-rc4
       ttfunk
-    puma (4.0.0)
+    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 (5.0.2)
       nio4r (~> 2.0)
-    rack (2.0.6)
+    rack (2.2.3)
     rack-test (1.1.0)
       rack (>= 1.0, < 3)
-    rake (10.5.0)
-    rmagick (2.16.0)
-    roda (3.21.0)
+    rake (13.0.1)
+    rmagick (4.1.2)
+    roda (3.36.0)
       rack
     ruby-rc4 (0.1.5)
-    ttfunk (1.4.0)
+    ttfunk (1.7.0)
 
 PLATFORMS
   ruby
 
 DEPENDENCIES
-  benchmark_driver (= 0.14.11)
+  benchmark_driver (= 0.15.17)
   benchmark_driver-output-gruff
   bundler (>= 1.7)
   invoice_printer_server!
@@ -55,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)
@@ -46,6 +46,12 @@ See more usecases in the `examples/` directory.
 - [Server](./docs/SERVER.md)
 - [Command line](./docs/COMMAND_LINE.md)
 
+## Support
+
+I am developing InvoicePrinter as a free and MIT-licensed library for several years now.
+
+I would appreciate if you consider [buying my book](https://deploymentfromscratch.com/).
+
 ## 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

@@ -1,13 +1,25 @@
 # Run the benchmark with benchmark_driver as:
 #
-#   $ benchmark-driver benchmarks/render.yml --output gruff --runner ips -e '/path/to/bin/ruby;/path/to/bin/ruby-2.6.0 --jit'
-#   $ benchmark-driver benchmarks/render.yml --output compare --runner memory -e '/path/to/bin/ruby;/path/to/bin/ruby-2.6.0 --jit--jit'
-loop_count: 10000
+#   $ benchmark-driver benchmarks/render.yml --output gruff --runner ips -e '/path/to/bin/ruby;/path/to/bin/ruby-3.0.0 --jit'
+#   $ benchmark-driver benchmarks/render.yml --output compare --runner memory -e '/path/to/bin/ruby;/path/to/bin/ruby-3.0.0 --jit'
+#   $ benchmark-driver benchmarks/render.yml -e '/home/strzibny/.rubies/ruby-2.7.0/bin/ruby;/home/strzibny/.rubies/ruby-3.0.0/bin/ruby;/home/strzibny/.rubies/ruby-3.0.0/bin/ruby --jit'
+#
+# Note: You need to install invoice_printer as a gem for the require to work.
+loop_count: 3000
 prelude: |
-  lib = File.expand_path('../lib', __FILE__)
-  $LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
   require 'invoice_printer'
 
+  provider_address = <<ADDRESS
+  Rolnicka 1
+  747 05  Opava
+  Katerinky
+  ADDRESS
+
+  purchaser_address = <<ADDRESS
+  Ostravska 1
+  747 70  Opava
+  ADDRESS
+
   item = InvoicePrinter::Document::Item.new(
     name: 'Programming',
     quantity: '10',
@@ -19,15 +31,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/bin/invoice_printer

@@ -18,7 +18,7 @@ def show_help
 
       -d, --document   document as JSON
         -l, --labels   labels as JSON
-              --font   path to font
+              --font   path to font or builtin font name
          -s, --stamp   path to stamp
               --logo   path to logotype
         --background   path to background image

data/docs/COMMAND_LINE.md

@@ -12,7 +12,7 @@ Options:
 
   -d, --document   document as JSON
     -l, --labels   labels as JSON
-          --font   path to font
+          --font   path to font or builtin font name
      -s, --stamp   path to stamp
           --logo   path to logotype
     --background   path to background image
@@ -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/INSTALLATION.md

@@ -12,6 +12,10 @@ Or the server version as:
 
     $ gem install invoice_printer_server
 
+To have builtin fonts available install:
+
+    $ gem install invoice_printer_fonts
+
 ### With Bundler
 
 Add this line to your application's Gemfile:
@@ -26,6 +30,12 @@ For the server:
 gem 'invoice_printer_server'
 ```
 
+To have builtin fonts available add:
+
+```ruby
+gem 'invoice_printer_fonts'
+```
+
 And then execute:
 
     $ bundle

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,14 +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__)
 )
 ```
 
-We recommend you DejaVuSans and Overpass fonts.
+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 `roboto`. Note that searching the path takes preference.
 
 ### Background
 

data/docs/SERVER.md

@@ -23,11 +23,15 @@ 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.
+
 ### As a mountable Rack app
 
 If you want you can always run the server from your custom program or mount it directly from a Rack app.
@@ -56,12 +60,14 @@ Options:
 
 - `document` - JSON representation of the document
 - `labels` - JSON for labels
-- `font` - path to font file
+- `font` - path to font file or builtin font name
 - `stamp` - path to stamp file
 - `logo` - path to logotype file
 - `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
@@ -96,7 +102,7 @@ Options:
 
 - `document` - JSON representation of the document
 - `labels` - JSON for labels
-- `font` - path to font file
+- `font` - path to font file or builtin font name
 - `stamp` - path to stamp file
 - `logo` - path to logotype file
 - `background` - path to background file