receipts 2.1.0 → 2.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: a0b0deba0350c50dd06db780729513d9c65d020c9d625b3c61c174078738ef44
-  data.tar.gz: 6b508e3232031df8d6952b9c2da80d5910022b2b53ba29e54f84080c12d522da
+  metadata.gz: 1606d916a395c1e22c80566221f2db3ad1ed035ec3d426d2500b4beffe1f0f8d
+  data.tar.gz: a5d29e51729f90104dceb3ff6faf6a4b3a27f7a404789664895821e62b416752
 SHA512:
-  metadata.gz: f734ad542b0405e91370fd960ab93283bd493cdd0523900b6f97a26f91bc8a57834512c7778c551af55e1208c232020743d39b73428bafe118679439838479f0
-  data.tar.gz: baca857094d744fa1ff47617940a9a665df5fc7da11ebc25e4ac180b9a324b1f00f82f85cfbba09952708e596cbdbe425d73abfab4371f319e7882e3d8dac59e
+  metadata.gz: 8a372a3605d3535d4f5fca1bac41a22470541b8717ed51fb8383e0250df0c1a97b7ef104fc388d8e3439572854cb82b925441cb8196336ef6996e411e8b68b2c
+  data.tar.gz: 971fe78bd36d9858a45afcdf4035575c51f373f33b1defb9637cde49f38501d322874132e22f06209ed1a05ed6e56a5fe7a1ea56bbbafd49f46977c4214e19b5

data/CHANGELOG.md

@@ -1,5 +1,14 @@
 ### Unreleased
 
+### 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

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],
@@ -76,7 +81,6 @@ Receipts.default_font = {
 }
 ```
 
-
 ### Options
 
 You can pass the following options to generate a PDF:
@@ -118,16 +122,45 @@ You can pass the following options to generate a PDF:
   }
   ```
 
+* `logo_height` - An integer value of how tall the logo should be. Defaults to `16`
+
 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.
 
+#### Page Size
+
+You can specify a different page size by passing in the `page_size` keyword argument:
+
+```ruby
+receipt = Receipts::Receipt.new page_size: "A4"
+```
+
 ### Internationalization (I18n)
 
 You can use `I18n.t` when rendering your receipts to internationalize them.
@@ -205,7 +238,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",
@@ -232,6 +265,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")],
@@ -268,6 +302,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")],
@@ -299,9 +334,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/lib/receipts/base.rb

@@ -7,7 +7,7 @@ module Receipts
     end
 
     def initialize(attributes = {})
-      super(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)
@@ -19,10 +19,13 @@ module Receipts
       return if attributes.empty?
 
       company = attributes.fetch(:company)
-      header company: company
+      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
 
@@ -79,11 +82,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.1.0"
+  VERSION = "2.3.0"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: receipts
 version: !ruby/object:Gem::Version
-  version: 2.1.0
+  version: 2.3.0
 platform: ruby
 authors:
 - Chris Oliver
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2022-11-24 00:00:00.000000000 Z
+date: 2024-03-05 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.3.7
+rubygems_version: 3.5.4
 signing_key:
 specification_version: 4
 summary: Receipts for your Rails application that works with any payment provider.