receipts 2.3.0 → 3.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 1606d916a395c1e22c80566221f2db3ad1ed035ec3d426d2500b4beffe1f0f8d
-  data.tar.gz: a5d29e51729f90104dceb3ff6faf6a4b3a27f7a404789664895821e62b416752
+  metadata.gz: a47085bc4aed90ea312b2824ded3d8160c62479d59041b482ff8bb0cdf7776b3
+  data.tar.gz: 7d356f573664804db0684f104f3a8df60549413fc0d16918f9062ede95d604ff
 SHA512:
-  metadata.gz: 8a372a3605d3535d4f5fca1bac41a22470541b8717ed51fb8383e0250df0c1a97b7ef104fc388d8e3439572854cb82b925441cb8196336ef6996e411e8b68b2c
-  data.tar.gz: 971fe78bd36d9858a45afcdf4035575c51f373f33b1defb9637cde49f38501d322874132e22f06209ed1a05ed6e56a5fe7a1ea56bbbafd49f46977c4214e19b5
+  metadata.gz: 329d7d5947440183086281c55a54e340550783fbbc8f9c21fff7dee0c02b9c6e0a0ba3bd7512efb2a15bf3ce091f0c10b98fe49909e8a09e7208f9a5adc3fd45
+  data.tar.gz: b390f51b8bc9e506b90cc4ab8486f278edde18945f726498faf27c4ab2b022c0e3f31adb4d0793a86992440e1db394ba9d3aaa04889c51b18c1669055587d727

data/.standard.yml

@@ -0,0 +1 @@
+ruby_version: 2.7

data/CHANGELOG.md

@@ -1,5 +1,34 @@
 ### Unreleased
 
+### 3.0.0
+
+* Replace Prawn with a built-in, pure Ruby PDF generator. Receipts no longer has any gem dependencies.
+* Embed the Inter font by default, adding Unicode support (Latin, Greek, Cyrillic) without configuring a custom font
+* Custom fonts must be TrueType (`.ttf`) files; only used characters are embedded
+* **Breaking:** Receipts objects inherit from `Receipts::PDF::Document` instead of `Prawn::Document`. Custom content using Prawn APIs beyond `text`, `image`, `table`, `move_down`/`move_up`, `font`, `font_size`, `bounds` and `start_new_page` needs updating.
+* **Breaking:** Table cells no longer accept Prawn's `overflow:` option. Rows always grow to fit their content, so remove `overflow:` from any custom `cell_style`.
+
+### 2.4.0
+
+* Add `display: []` for configuring company details that are rendered #38 - @excid3
+
+```ruby
+r = Receipts::Receipt.new(
+  company: {
+    name: "Example, LLC",
+    address: "123 Fake Street\nNew York City, NY 10012",
+    phone: "(555) 867-5309",
+    email: "support@example.com",
+    iban: "123456789",
+    logo: File.expand_path("./examples/images/logo.png"),
+    display: [:address, :phone, :email, :iban]
+  },
+  # ...
+)
+```
+
+* Fix Prawn docs link in README #36 - @ocarreterom
+
 ### 2.3.0
 
 * Add `column_widths:` option to specify line item column widths #35

data/Gemfile

@@ -6,4 +6,3 @@ gemspec
 gem "minitest", "~> 5.0"
 gem "rake", "~> 13.0"
 gem "standard"
-gem "matrix", "~> 0.4"

data/README.md

@@ -2,7 +2,7 @@
 
 # Receipts Gem
 
-Receipts, Invoices, and Statements for your Rails application that works with any payment provider. Receipts uses Prawn to generate the PDFs.
+Receipts, Invoices, and Statements for your Rails application that works with any payment provider. PDFs are generated in pure Ruby with no dependencies.
 
 Check out the [example PDFs](https://github.com/excid3/receipts/blob/master/examples/).
 
@@ -72,7 +72,9 @@ r.render_file "examples/receipt.pdf"
 
 ### Configuration
 
-You can specify the default font for all PDFs by defining the following in an initializer:
+PDFs use the bundled [Inter](https://rsms.me/inter/) font by default, which supports Latin, Greek, and Cyrillic characters.
+
+You can specify a different default font for all PDFs by defining the following in an initializer:
 
 ```ruby
 Receipts.default_font = {
@@ -81,6 +83,8 @@ Receipts.default_font = {
 }
 ```
 
+Fonts must be TrueType (`.ttf`) files. Only the characters used are embedded in each PDF. You may also provide `italic:` and `bold_italic:` fonts; otherwise italic text is simulated by slanting the normal font.
+
 ### Options
 
 You can pass the following options to generate a PDF:
@@ -107,6 +111,8 @@ You can pass the following options to generate a PDF:
     logo: "https://www.ruby-lang.org/images/header-ruby-logo@2x.png" # Downloaded with OpenURI
     ```
 
+  * `display: []` - Customize the company details rendered. By default, renders `[:address, :phone, :email]` under the company name. Items in the array should be Symbols matching keys in the `company` hash to be displayed.
+
 * `details` - Array of details about the Receipt, Invoice, Statement. Typically, this is receipt numbers, issue date, due date, status, etc.
 
 * `line_items` - Array of line items to be displayed in table format.
@@ -130,8 +136,7 @@ Here's an example of where each option is displayed.
 
 #### Line Items Table - Column Widths
 
-You may set an option to configure the line items table's columns width in order to accommodate shortcomings of Prawn's width guessing ability to render header and content reasonably sized.
-The configuration depends on your line item column count and follows the prawn/table configuration as documented [here](https://prawnpdf.org/prawn-table-manual.pdf):
+By default, columns are sized to fit their content and any leftover space is split evenly between columns. You may set the width of specific columns in points (1/72 inch) to override this.
 
 This will size the second column to 400 and the fourth column to 50.
 
@@ -145,13 +150,18 @@ This will set all column widths, considering your table has 4 columns.
 column_widths: [100, 200, 240]
 ```
 
-If not set, it will fall back to Prawn's default behavior.
+Columns without a width are sized automatically.
 
 ### Formatting
 
-`details` and `line_items` allow inline formatting with Prawn. This allows you to use HTML tags to format text: `<b>` `<i>` `<u>` `<strikethrough>` `<sub>` `<sup>` `<font>` `<color>` `<link>`
+`details`, `line_items`, `recipient` and `footer` allow inline formatting using HTML-like tags:
 
-See [the Prawn docs](https://prawnpdf.org/api-docs/2.3.0/Prawn/Text.html#text-instance_method) for more information.
+* `<b>` / `<strong>`, `<i>` / `<em>`, `<u>`, `<strikethrough>`, `<sub>`, `<sup>`, `<br>`
+* `<font name="Primary" size="12" character_spacing="1">`
+* `<color rgb="#5eba7d">` or `<color c="0" m="100" y="100" k="0">`
+* `<link href="https://example.com">`
+
+Use `&lt;`, `&gt;` and `&amp;` for literal `<`, `>` and `&` characters.
 
 #### Page Size
 
@@ -181,17 +191,28 @@ You can change the entire PDF content by instantiating an Receipts object withou
 receipt = Receipts::Receipt.new # creates an empty PDF
 ```
 
-Each Receipts object inherits from Prawn::Document. This allows you to choose what is rendered and include any custom Prawn content you like.
+Each Receipts object inherits from `Receipts::PDF::Document`, which provides a small, Prawn-like API for adding your own content:
 
 ```ruby
-receipt.text("hello world")
+receipt.text("hello world", size: 12, style: :bold, align: :center, color: "4b5563")
+receipt.text("<b>Bold</b> and <i>italic</i>", inline_format: true)
+receipt.move_down 20
+receipt.image "logo.png", height: 24, position: :right
+receipt.table([["Item", "Amount"], ["Product", "$10"]], width: receipt.bounds.width) do
+  row(0).font_style = :bold
+  column(1).align = :right
+end
+receipt.stroke_horizontal_rule
+receipt.start_new_page
 ```
 
+Images must be PNG (non-interlaced) or JPEG files.
+
 You can also use the Receipts helpers in your custom PDFs at the current cursor position.
 
 ```ruby
 receipt.text("Custom header")
-receipt.render_line_items([
+receipt.render_line_items(line_items: [
   ["my line items"]
 ])
 receipt.render_footer("This is a custom footer using the Receipts helper")

data/Rakefile

@@ -36,7 +36,9 @@ task :receipt do
       address: "123 Fake Street\nNew York City, NY 10012",
       phone: "(555) 867-5309",
       email: "support@example.com",
-      logo: File.expand_path("./examples/images/logo.png")
+      iban: "123456789",
+      logo: File.expand_path("./examples/images/logo.png"),
+      display: [:address, :phone, :email, nil, :iban]
     },
     details: [
       ["Receipt Number", "123"],

data/lib/receipts/base.rb

@@ -1,5 +1,5 @@
 module Receipts
-  class Base < Prawn::Document
+  class Base < PDF::Document
     attr_accessor :title, :company
 
     class << self
@@ -39,11 +39,7 @@ module Receipts
     end
 
     def load_image(logo)
-      if logo.is_a? String
-        logo.start_with?("http") ? URI.parse(logo).open : File.open(logo)
-      else
-        logo
-      end
+      (logo.is_a?(String) && logo.start_with?("http")) ? URI.parse(logo).open : logo
     end
 
     def header(company: {}, height: 16)
@@ -64,14 +60,11 @@ module Receipts
       table(details, cell_style: {borders: [], inline_format: true, padding: [0, 8, 2, 0]})
     end
 
-    def render_billing_details(company:, recipient:, margin_top: 16)
+    def render_billing_details(company:, recipient:, margin_top: 16, display_values: nil)
       move_down margin_top
 
-      company_details = [
-        company[:address],
-        company[:phone],
-        company[:email]
-      ].compact.join("\n")
+      display_values ||= company.fetch(:display, [:address, :phone, :email])
+      company_details = company.values_at(*display_values).compact.join("\n")
 
       line_items = [
         [
@@ -79,7 +72,7 @@ module Receipts
           {content: Array(recipient).join("\n"), padding: [0, 12, 0, 0]}
         ]
       ]
-      table(line_items, width: bounds.width, cell_style: {borders: [], inline_format: true, overflow: :expand})
+      table(line_items, width: bounds.width, cell_style: {borders: [], inline_format: true})
     end
 
     def render_line_items(line_items:, margin_top: 30, column_widths: nil)

data/lib/receipts/fonts/OFL.txt

@@ -0,0 +1,92 @@
+Copyright (c) 2016 The Inter Project Authors (https://github.com/rsms/inter)
+
+This Font Software is licensed under the SIL Open Font License, Version 1.1.
+This license is copied below, and is also available with a FAQ at:
+http://scripts.sil.org/OFL
+
+-----------------------------------------------------------
+SIL OPEN FONT LICENSE Version 1.1 - 26 February 2007
+-----------------------------------------------------------
+
+PREAMBLE
+The goals of the Open Font License (OFL) are to stimulate worldwide
+development of collaborative font projects, to support the font creation
+efforts of academic and linguistic communities, and to provide a free and
+open framework in which fonts may be shared and improved in partnership
+with others.
+
+The OFL allows the licensed fonts to be used, studied, modified and
+redistributed freely as long as they are not sold by themselves. The
+fonts, including any derivative works, can be bundled, embedded,
+redistributed and/or sold with any software provided that any reserved
+names are not used by derivative works. The fonts and derivatives,
+however, cannot be released under any other type of license. The
+requirement for fonts to remain under this license does not apply
+to any document created using the fonts or their derivatives.
+
+DEFINITIONS
+"Font Software" refers to the set of files released by the Copyright
+Holder(s) under this license and clearly marked as such. This may
+include source files, build scripts and documentation.
+
+"Reserved Font Name" refers to any names specified as such after the
+copyright statement(s).
+
+"Original Version" refers to the collection of Font Software components as
+distributed by the Copyright Holder(s).
+
+"Modified Version" refers to any derivative made by adding to, deleting,
+or substituting -- in part or in whole -- any of the components of the
+Original Version, by changing formats or by porting the Font Software to a
+new environment.
+
+"Author" refers to any designer, engineer, programmer, technical
+writer or other person who contributed to the Font Software.
+
+PERMISSION AND CONDITIONS
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of the Font Software, to use, study, copy, merge, embed, modify,
+redistribute, and sell modified and unmodified copies of the Font
+Software, subject to the following conditions:
+
+1) Neither the Font Software nor any of its individual components,
+in Original or Modified Versions, may be sold by itself.
+
+2) Original or Modified Versions of the Font Software may be bundled,
+redistributed and/or sold with any software, provided that each copy
+contains the above copyright notice and this license. These can be
+included either as stand-alone text files, human-readable headers or
+in the appropriate machine-readable metadata fields within text or
+binary files as long as those fields can be easily viewed by the user.
+
+3) No Modified Version of the Font Software may use the Reserved Font
+Name(s) unless explicit written permission is granted by the corresponding
+Copyright Holder. This restriction only applies to the primary font name as
+presented to the users.
+
+4) The name(s) of the Copyright Holder(s) or the Author(s) of the Font
+Software shall not be used to promote, endorse or advertise any
+Modified Version, except to acknowledge the contribution(s) of the
+Copyright Holder(s) and the Author(s) or with their explicit written
+permission.
+
+5) The Font Software, modified or unmodified, in part or in whole,
+must be distributed entirely under this license, and must not be
+distributed under any other license. The requirement for fonts to
+remain under this license does not apply to any document created
+using the Font Software.
+
+TERMINATION
+This license becomes null and void if any of the above conditions are
+not met.
+
+DISCLAIMER
+THE FONT SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO ANY WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT
+OF COPYRIGHT, PATENT, TRADEMARK, OR OTHER RIGHT. IN NO EVENT SHALL THE
+COPYRIGHT HOLDER BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY,
+INCLUDING ANY GENERAL, SPECIAL, INDIRECT, INCIDENTAL, OR CONSEQUENTIAL
+DAMAGES, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING
+FROM, OUT OF THE USE OR INABILITY TO USE THE FONT SOFTWARE OR FROM
+OTHER DEALINGS IN THE FONT SOFTWARE.