receipts 2.2.0 → 2.4.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 9dd904f28ec977eac50dff178d568a07708de3c80deddd2119047ff8728337f7
-  data.tar.gz: 28e46c6f307fef00ccce4c4f1a7358ae1b528fb4f6ee65795aba514218ec3929
+  metadata.gz: a074319e14c0aaf9a5e4776d854c90810273092e58d7672046f7a6ef4d01a6d5
+  data.tar.gz: e4d3bf9feb0a135357a6666ca46a8c9298d0d623223101c0649c7c9b2b45248f
 SHA512:
-  metadata.gz: 99713c6cecafbf19d75c298e94eb66ef11c3e643ec102214eb9d5010ec947b8719ec1df7261afb5a15a796fb7d3994acdab001cede3499bbbd526e5fe29f2d65
-  data.tar.gz: b6f3e79761afdd71d4b5c482763732eac98881ac4394ddc522def91ebaada25685ef968b5614088f1d4361d9921f320764f8614cb66dfa29c8b7c1081aebc2c0
+  metadata.gz: e22ececba2faf58b41ed4b677bbf351b6dadb51eb0c2e54b9930949eceb7bbc68d29aba7a642e44c47d76d9486669d324cd642befb920576398a13d392e8e303
+  data.tar.gz: 179cbdbf4fbaa3de6de2d1e76a0c9087bc91b9fa36c639f3d5824f112a32a1199662fd0ae87efa3d18f69be6744d3762e495e85cb111e67106a7bde81b90c7e3

data/CHANGELOG.md

@@ -1,12 +1,34 @@
 ### Unreleased
 
+* Add `display: []` for configuring company details that are rendered
+
+```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]
+  },
+  # ...
+)
+```
+
+### 2.3.0
+
+* Add `column_widths:` option to specify line item column widths #35
+
+### 2.2.0
+
 * Allow specifiying other page sizes - @excid3
 * Add `logo_height:` option to specify the height of the logo image
 
 ### 2.1.0
 
 * Add `Receipts.default_font` - @excid3
->>>>>>> 65dc0260770f3d751f67dc5433be09127367b83b
 
 ### 2.0.0
 

data/README.md

@@ -1,4 +1,4 @@
-![travisci](https://api.travis-ci.org/excid3/receipts.svg)
+[![Tests](https://github.com/excid3/receipts/actions/workflows/ci.yml/badge.svg)](https://github.com/excid3/receipts/actions/workflows/ci.yml)
 
 # Receipts Gem
 
@@ -16,11 +16,15 @@ gem 'receipts'
 
 And then execute:
 
-    $ bundle
+```sh
+$ bundle
+```
 
 Or install it yourself as:
 
-    $ gem install receipts
+```sh
+$ gem install receipts
+```
 
 ## Usage
 
@@ -28,6 +32,7 @@ To generate a Receipt, Invoice, or Statement, create an instance and provide con
 
 ```ruby
 r = Receipts::Receipt.new(
+  # title: "Receipt",
   details: [
     ["Receipt Number", "123"],
     ["Date paid", Date.today],
@@ -102,6 +107,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.
@@ -123,14 +130,32 @@ Here's an example of where each option is displayed.
 
 ![options](examples/images/options.jpg)
 
+#### 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):
+
+This will size the second column to 400 and the fourth column to 50.
+
+```ruby
+column_widths: {1 => 400,3 => 50 }
+```
+
+This will set all column widths, considering your table has 4 columns.
+
+```ruby
+column_widths: [100, 200, 240]
+```
+
+If not set, it will fall back to Prawn's default behavior.
+
 ### 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>`
 
-See [the Prawn docs](https://prawnpdf.org/api-docs/2.3.0/Prawn/Text.html#text-instance_method) for more information.
+See [the Prawn docs](https://prawnpdf.org/) for more information.
 
-
-##### Page Size
+#### Page Size
 
 You can specify a different page size by passing in the `page_size` keyword argument:
 
@@ -215,7 +240,7 @@ class ChargesController < ApplicationController
       @charge = current_user.charges.find(params[:id])
     end
 
-  	def send_pdf
+    def send_pdf
       # Render the PDF in memory and send as the response
       send_data @charge.receipt.render,
         filename: "#{@charge.created_at.strftime("%Y-%m-%d")}-gorails-receipt.pdf",
@@ -242,6 +267,7 @@ Invoices follow the exact same set of steps as above. You'll simply want to modi
 
 ```ruby
 Receipts::Invoice.new(
+  # title: "Invoice",
   details: [
     ["Invoice Number", "123"],
     ["Issue Date", Date.today.strftime("%B %d, %Y")],
@@ -278,6 +304,7 @@ Statements follow the exact same set of steps as above. You'll simply want to mo
 
 ```ruby
 Receipts::Statement.new(
+  # title: "Statement",
   details: [
     ["Statement Number", "123"],
     ["Issue Date", Date.today.strftime("%B %d, %Y")],
@@ -309,9 +336,8 @@ Receipts::Statement.new(
 
 ## Contributing
 
-1. Fork it ( https://github.com/excid3/receipts/fork )
+1. Fork it [https://github.com/excid3/receipts/fork](https://github.com/excid3/receipts/fork)
 2. Create your feature branch (`git checkout -b my-new-feature`)
 3. Commit your changes (`git commit -am 'Add some feature'`)
 4. Push to the branch (`git push origin my-new-feature`)
 5. Create a new Pull Request
-

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

@@ -7,7 +7,7 @@ module Receipts
     end
 
     def initialize(attributes = {})
-      super page_size: attributes.delete(:page_size) || "LETTER"
+      super(page_size: attributes.delete(:page_size) || "LETTER")
       setup_fonts attributes.fetch(:font, Receipts.default_font)
 
       @title = attributes.fetch(:title, self.class.title)
@@ -22,7 +22,10 @@ module Receipts
       header company: company, height: attributes.fetch(:logo_height, 16)
       render_details attributes.fetch(:details)
       render_billing_details company: company, recipient: attributes.fetch(:recipient)
-      render_line_items attributes.fetch(:line_items)
+      render_line_items(
+        line_items: attributes.fetch(:line_items),
+        column_widths: attributes[:column_widths]
+      )
       render_footer attributes.fetch(:footer, default_message(company: company))
     end
 
@@ -61,14 +64,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,11 +79,18 @@ module Receipts
       table(line_items, width: bounds.width, cell_style: {borders: [], inline_format: true, overflow: :expand})
     end
 
-    def render_line_items(line_items, margin_top: 30)
+    def render_line_items(line_items:, margin_top: 30, column_widths: nil)
       move_down margin_top
 
       borders = line_items.length - 2
-      table(line_items, width: bounds.width, cell_style: {border_color: "eeeeee", inline_format: true}) do
+
+      table_options = {
+        width: bounds.width,
+        cell_style: {border_color: "eeeeee", inline_format: true},
+        column_widths: column_widths
+      }.compact
+
+      table(line_items, table_options) do
         cells.padding = 6
         cells.borders = []
         row(0..borders).borders = [:bottom]

data/lib/receipts/version.rb

@@ -1,3 +1,3 @@
 module Receipts
-  VERSION = "2.2.0"
+  VERSION = "2.4.0"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: receipts
 version: !ruby/object:Gem::Version
-  version: 2.2.0
+  version: 2.4.0
 platform: ruby
 authors:
 - Chris Oliver
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2023-01-17 00:00:00.000000000 Z
+date: 2024-03-26 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: prawn
@@ -90,7 +90,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.4.4
+rubygems_version: 3.5.4
 signing_key:
 specification_version: 4
 summary: Receipts for your Rails application that works with any payment provider.