invoice_printer 0.0.8 → 0.0.9

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: b1a1a8627880008c1a2649c81e9c111293174f7a
-  data.tar.gz: f3b9a8bbd8f68c316497ef0d20c41d7bcfe43585
+  metadata.gz: fd883b1301d64bf81e14e413d1a51bd7a69bfc6b
+  data.tar.gz: ae4140c675734a8d7a48d6cea50ab473557b044d
 SHA512:
-  metadata.gz: 64c5b2e41e6699883cef4771215cc5010519dcbaf81c37a2807347e6a5529aa3fe63c890d4f3f9cf1d9eef29f7a24775bafac185b410a11fdbc52ec96538d2bb
-  data.tar.gz: fa516cb4c41cdf47e70de492bac1fee3411db89af8c795af1f706b83792791bbe450068c39295985dc9d15b5fb38d7e8063180e803f900f8048384eb2694b007
+  metadata.gz: 27898b9d38d273d53b40029db2b278a5999424da9e808ad32bf104afc7aae8133cdbda60c6afa731b0c100a2ae01f0bd1bef1895c9bf4c7d5de1911d1a842488
+  data.tar.gz: b7fac7291599fa038ddaf3457735ee19da5426b90acbb60e1fc245c659ed32dcd0acbd9261b291c97f1cbba81e0750688904b461fa150001d4fde6ba09cbb7d3

data/README.md

@@ -22,7 +22,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
+- Configurable labels & sublabels (optional little labels)
 - Configurable font file
 - Logotype (as image scaled to fit 50px of height)
 - Background (as image)
@@ -65,6 +65,11 @@ InvoicePrinter.print(
   document: invoice,
   file_name: 'invoice.pdf'
 )
+
+# Or render PDF directly
+InvoicePrinter.render(
+  document: invoice
+)
 ```
 
 Here is an full example for creating the document object:
@@ -114,6 +119,29 @@ invoice = InvoicePrinter::Document.new(
 )
 ```
 
+### Ruby on Rails
+
+If you want to use InvoicePrinter for printing PDF documents directly from Rails
+actions, you can:
+
+```ruby
+# GET /invoices/1
+def show
+  invoice = InvoicePrinter::Document.new(...)
+
+  respond_to do |format|
+    format.pdf {
+      @pdf = InvoicePrinter.render(
+        document: invoice
+      )
+      send_data @pdf, type: 'application/pdf', disposition: 'inline'
+    }
+  end
+end
+```
+
+## Customization
+
 ### Localization
 
 To localize your documents you can set both global defaults or instance
@@ -166,6 +194,41 @@ InvoicePrinter.labels = {
 }
 ```
 
+You can also use sublabels feature to provide the document in two languages:
+
+```ruby
+labels = {
+  ...
+}
+
+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',
+  quantity: 'Počet',
+  unit: 'MJ',
+  price_per_item: 'Cena za položku',
+  amount: 'Celkem bez daně',
+  subtotal: 'Cena bez daně',
+  tax: 'DPH 21 %',
+  total: 'Celkem'
+}
+
+labels.merge!({ sublabels: sublabels })
+
+...
+```
+
+Now the document will have a little sublabels next to the original labels in Czech.
+
 ### Font
 
 To support specific characters you might need to specify a TTF font to be used:
@@ -181,17 +244,17 @@ We recommend you DejaVuSans and Overpass fonts.
 
 ### Background
 
-To include a background image you might need to create the file according to the size and resolution to be used (see: [examples/background.jpg](https://github.com/strzibny/invoice_printer/blob/master/examples/background.jpg)):
+To include a background image you might need to create the file according to the size and resolution to be used (see: [examples/background.png](https://github.com/strzibny/invoice_printer/blob/master/examples/background.png)):
 
 ``` ruby
 InvoicePrinter.print(
   ...
-  background: File.expand_path('../background.jpg', __FILE__)
+  background: File.expand_path('../background.png', __FILE__)
 )
 ```
 
 ## Copyright
 
-Copyright 2015-2016 © [Josef Strzibny](http://strzibny.name/). MIT licensed.
+Copyright 2015-2017 © [Josef Strzibny](http://strzibny.name/). MIT licensed.
 
 Originally extracted from and created for an open source single-entry invoicing app [InvoiceBar](https://github.com/strzibny/invoicebar).