receipts 2.0.0 → 2.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 875a1ff6a3a1dcca7a1de7c21362ce0837426c3f5b3299cd9f15f38daf97cfa2
-  data.tar.gz: 2aed77f22588a1675b558eccbe1122cc94912e04fa692aacaa7a40b16429495e
+  metadata.gz: 9dd904f28ec977eac50dff178d568a07708de3c80deddd2119047ff8728337f7
+  data.tar.gz: 28e46c6f307fef00ccce4c4f1a7358ae1b528fb4f6ee65795aba514218ec3929
 SHA512:
-  metadata.gz: f54fc0957bccf87ebd1ae377d275f9dfe0f39a8b2cd0e8c4b5a96635183abd24f229eea142631a98d5a61156fc87cd366864e35a044a53e60ec072de08ada3e5
-  data.tar.gz: 87745a1fe2f9cb84c69a00d816e254c4cc7b2dfee02457ece89d9e543a39b65813bfd427e7fa789e5a56feea1a3837ac3e8cc5d4574e4894805b535de76cf630
+  metadata.gz: 99713c6cecafbf19d75c298e94eb66ef11c3e643ec102214eb9d5010ec947b8719ec1df7261afb5a15a796fb7d3994acdab001cede3499bbbd526e5fe29f2d65
+  data.tar.gz: b6f3e79761afdd71d4b5c482763732eac98881ac4394ddc522def91ebaada25685ef968b5614088f1d4361d9921f320764f8614cb66dfa29c8b7c1081aebc2c0

data/CHANGELOG.md

@@ -1,12 +1,20 @@
 ### Unreleased
 
+* 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
 
 * New, consistent layouts between Receipts, Invoices, and Statements - @excid3
 * PDFs can now be completely customized - @excid3
 * Add line_items to Receipts - @excid3
 
-### 1.2.0
+### 1.1.2
 
 * Update design to give more room for longer product names, addresses, etc - @excid3
 

data/README.md

@@ -59,12 +59,23 @@ r = Receipts::Receipt.new(
 )
 
 # Returns a string of the raw PDF
-r.render 
+r.render
 
 # Writes the PDF to disk
 r.render_file "examples/receipt.pdf"
 ```
 
+### Configuration
+
+You can specify the default font for all PDFs by defining the following in an initializer:
+
+```ruby
+Receipts.default_font = {
+  bold: Rails.root.join('app/assets/fonts/tradegothic/TradeGothic-Bold.ttf'),
+  normal: Rails.root.join('app/assets/fonts/tradegothic/TradeGothic.ttf'),
+}
+```
+
 ### Options
 
 You can pass the following options to generate a PDF:
@@ -106,16 +117,27 @@ 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)
 
 ### 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` 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.
@@ -192,13 +214,13 @@ class ChargesController < ApplicationController
     def set_charge
       @charge = current_user.charges.find(params[:id])
     end
-  
+
   	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",
-          type: "application/pdf",
-          disposition: :inline # or :attachment to download
+        filename: "#{@charge.created_at.strftime("%Y-%m-%d")}-gorails-receipt.pdf",
+        type: "application/pdf",
+        disposition: :inline # or :attachment to download
     end
 end
 ```

data/lib/receipts/base.rb

@@ -7,8 +7,8 @@ module Receipts
     end
 
     def initialize(attributes = {})
-      super(page_size: "LETTER")
-      setup_fonts attributes[:font]
+      super page_size: attributes.delete(:page_size) || "LETTER"
+      setup_fonts attributes.fetch(:font, Receipts.default_font)
 
       @title = attributes.fetch(:title, self.class.title)
 
@@ -19,7 +19,7 @@ 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)

data/lib/receipts/version.rb

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

data/lib/receipts.rb

@@ -8,4 +8,19 @@ module Receipts
   autoload :Invoice, "receipts/invoice"
   autoload :Receipt, "receipts/receipt"
   autoload :Statement, "receipts/statement"
+
+  @@default_font = nil
+
+  # Customize the default font hash
+  # default_font = {
+  #   bold: "path/to/font",
+  #   normal: "path/to/font",
+  # }
+  def self.default_font=(path)
+    @@default_font = path
+  end
+
+  def self.default_font
+    @@default_font
+  end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: receipts
 version: !ruby/object:Gem::Version
-  version: 2.0.0
+  version: 2.2.0
 platform: ruby
 authors:
 - Chris Oliver
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2022-01-30 00:00:00.000000000 Z
+date: 2023-01-17 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.2.32
+rubygems_version: 3.4.4
 signing_key:
 specification_version: 4
 summary: Receipts for your Rails application that works with any payment provider.