receipts 1.1.1 → 1.1.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: dfed87396d5ed2beb0064ead6f0ac9ca457e06a7b67427ec8963b9f6404db0ce
-  data.tar.gz: a8a4cbff0f9eadf7552ad5a533522dd6e6746cefa548f3d146a7a3e6bb0f07d3
+  metadata.gz: fead98b1a43ff6d6c86b13f9c8114ebcfa322b809f9f2b068b80e03370c63f65
+  data.tar.gz: e7e29ceceac61563c182626d3d47ab697584e67896aff884097bb955236d44ca
 SHA512:
-  metadata.gz: b6f01ec38f45f6d6e2ed3642ef004185e1b52f7d53a23802014e338d52965099865d5e6c0269ee5528c45c959bec4d4a3fcecf1cbc6774190efa424f01f73c51
-  data.tar.gz: 338d4628dd34e5af7d4e7de7a00d3c1758b19a26b7fb5c5f1ea561c0f4ce71150841a5c915b20e2270b16e3f63c25ea6d789fe6641a8818b605935fc3b814d63
+  metadata.gz: de764a9d7466e6680243ac5b2f033534a6140048f99eb5bc15aaad5b38d27063e4ed7e70f2d45167064dec7b3f941d34b0cab29aab1977e876c926ded6e80839
+  data.tar.gz: 7da1873655534b34d80bb735b8fe80da1d84d6f0618f1d1c7be35991e2d5ffeb197aa4b07390a3ba3aba4317ef42c7a874756b075213422d164ed296b9bb7a2b

data/CHANGELOG.md

@@ -1,5 +1,9 @@
 ### Unreleased
 
+### 1.2.0
+
+* Update design to give more room for longer product names, addresses, etc - @excid3
+
 ### 1.1.1
 
 * [FIX] Use `URI.parse().open` instead - @excid3 @reckerswartz

data/Rakefile

@@ -12,6 +12,12 @@ task :console do
   exec "irb -r receipts -I ./lib"
 end
 
+task :examples do
+  [:receipt, :invoice, :statement].each { |t| Rake::Task[t].invoke }
+
+  puts "Use `open examples` to view example PDFs."
+end
+
 task :receipt do
   require "./lib/receipts"
 
@@ -23,7 +29,7 @@ task :receipt do
       name: "GoRails, LLC",
       address: "123 Fake Street\nNew York City, NY 10012",
       email: "support@example.com",
-      logo: URI.open("https://www.ruby-lang.org/images/header-ruby-logo@2x.png")
+      logo: "https://www.ruby-lang.org/images/header-ruby-logo@2x.png"
     },
     line_items: [
       ["Date", Time.now.to_s],

data/lib/receipts/invoice.rb

@@ -2,7 +2,7 @@ require "prawn"
 require "prawn/table"
 
 module Receipts
-  class Invoice < Prawn::Document
+  class Invoice < Base
     attr_reader :attributes, :id, :company, :custom_font, :line_items, :logo, :message, :product, :subheading, :bill_to, :issue_date, :due_date, :status
 
     def initialize(attributes)
@@ -18,7 +18,7 @@ module Receipts
       @due_date = attributes.fetch(:due_date)
       @status = attributes.fetch(:status)
 
-      super(margin: 0)
+      super(page_size: "LETTER")
 
       setup_fonts if custom_font.any?
       generate
@@ -34,65 +34,36 @@ module Receipts
       "INVOICE #%{id}"
     end
 
-    def setup_fonts
-      font_families.update "Primary" => custom_font
-      font "Primary"
-    end
-
     def generate
-      bounding_box [0, 792], width: 612, height: 792 do
-        bounding_box [85, 792], width: 442, height: 792 do
-          header
-          charge_details
-          footer
-        end
-      end
+      header
+      description
+      invoice_details
+      charge_details
+      footer
     end
 
-    def header
-      move_down 60
-
+    def header(height: 24)
       logo = company[:logo]
+      return if logo.nil?
+      image load_image(logo), height: height
+    end
 
-      if logo.nil?
-        move_down 32
-      elsif logo.is_a?(String)
-        image URI.parse(logo).open, height: 32
-      else
-        image logo, height: 32
-      end
-
+    def description
       move_down 8
-      label(subheading % {id: id})
+      text label(subheading % {id: id}), inline_format: true, leading: 4
+    end
 
+    def invoice_details
       move_down 10
-
-      # Cache the Y value so we can have both boxes at the same height
-      top = y
-      bounding_box([0, y], width: 200) do
-        label "BILL TO"
-
-        move_down 5
-        text_box bill_to, at: [0, cursor], width: 200, height: 75, inline_format: true, size: 10, leading: 4, overflow: :shrink_to_fit
-      end
-
-      bounding_box([250, top], width: 200) do
-        label "INVOICE DATE"
-
-        move_down 5
-        text issue_date.to_s, inline_format: true, size: 12, leading: 4
-
-        move_down 10
-        label "DUE DATE"
-
-        move_down 5
-        text due_date.to_s, inline_format: true, size: 12, leading: 4
-
-        move_down 10
-        label "STATUS"
-
-        move_down 5
-        text status, inline_format: true, size: 12, leading: 4
+      font_size 9
+
+      line_items = [
+        [{content: "#{label("BILL TO")}\n#{bill_to}", rowspan: 3, padding: [0, 12, 0, 0]}, "#{label("INVOICE DATE")}\n#{issue_date}"],
+        ["#{label("DUE DATE")}\n#{due_date}"],
+        ["#{label("STATUS")}\n#{status}"]
+      ]
+      table(line_items, width: bounds.width, cell_style: {inline_format: true, overflow: :shrink_to_fit}) do
+        cells.borders = []
       end
     end
 
@@ -101,8 +72,8 @@ module Receipts
 
       borders = line_items.length - 2
 
-      table(line_items, width: bounds.width, cell_style: {border_color: "cccccc", inline_format: true}) do
-        cells.padding = 12
+      table(line_items, width: bounds.width, cell_style: {border_color: "cccccc", inline_format: true, overflow: :shrink_to_fit}) do
+        cells.padding = 10
         cells.borders = []
         row(0..borders).borders = [:bottom]
       end
@@ -110,15 +81,11 @@ module Receipts
 
     def footer
       move_down 30
-      text message, inline_format: true, size: 12, leading: 4
+      text message, inline_format: true, leading: 4
 
       move_down 30
       text company.fetch(:name), inline_format: true
       text "<color rgb='888888'>#{company.fetch(:address)}</color>", inline_format: true
     end
-
-    def label(text)
-      text "<color rgb='a6a6a6'>#{text}</color>", inline_format: true, size: 8
-    end
   end
 end

data/lib/receipts/receipt.rb

@@ -1,8 +1,5 @@
-require "prawn"
-require "prawn/table"
-
 module Receipts
-  class Receipt < Prawn::Document
+  class Receipt < Base
     attr_reader :attributes, :id, :company, :custom_font, :line_items, :logo, :message, :product, :subheading
 
     def initialize(attributes)
@@ -14,7 +11,7 @@ module Receipts
       @message = attributes.fetch(:message) { default_message }
       @subheading = attributes.fetch(:subheading) { default_subheading }
 
-      super(margin: 0)
+      super(page_size: "LETTER")
 
       setup_fonts if custom_font.any?
       generate
@@ -30,48 +27,35 @@ module Receipts
       "RECEIPT FOR CHARGE #%{id}"
     end
 
-    def setup_fonts
-      font_families.update "Primary" => custom_font
-      font "Primary"
-    end
-
     def generate
-      bounding_box [0, 792], width: 612, height: 792 do
-        bounding_box [85, 792], width: 442, height: 792 do
-          header
-          charge_details
-          footer
-        end
-      end
+      header
+      description
+      charge_details
+      footer
     end
 
-    def header
-      move_down 60
-
+    def header(height: 24)
       logo = company[:logo]
+      return if logo.nil?
+      image load_image(logo), height: height
+    end
 
-      if logo.nil?
-        move_down 32
-      elsif logo.is_a?(String)
-        image URI.parse(logo).open, height: 32
-      else
-        image logo, height: 32
-      end
-
+    def description
       move_down 8
       text "<color rgb='a6a6a6'>#{subheading % {id: id}}</color>", inline_format: true
 
       move_down 30
-      text message, inline_format: true, size: 12.5, leading: 4
+      text message, inline_format: true, leading: 4
     end
 
     def charge_details
       move_down 30
+      font_size 9
 
       borders = line_items.length - 2
 
       table(line_items, width: bounds.width, cell_style: {border_color: "cccccc", inline_format: true}) do
-        cells.padding = 12
+        cells.padding = 10
         cells.borders = []
         row(0..borders).borders = [:bottom]
       end

data/lib/receipts/statement.rb

@@ -1,8 +1,5 @@
-require "prawn"
-require "prawn/table"
-
 module Receipts
-  class Statement < Prawn::Document
+  class Statement < Base
     attr_reader :attributes, :id, :company, :custom_font, :line_items, :logo, :message, :product, :subheading, :bill_to, :issue_date, :start_date, :end_date
 
     def initialize(attributes)
@@ -18,7 +15,7 @@ module Receipts
       @start_date = attributes.fetch(:start_date)
       @end_date = attributes.fetch(:end_date)
 
-      super(margin: 0)
+      super(page_size: "LETTER")
 
       setup_fonts if custom_font.any?
       generate
@@ -34,57 +31,36 @@ module Receipts
       "STATEMENT #%{id}"
     end
 
-    def setup_fonts
-      font_families.update "Primary" => custom_font
-      font "Primary"
-    end
-
     def generate
-      bounding_box [0, 792], width: 612, height: 792 do
-        bounding_box [85, 792], width: 442, height: 792 do
-          header
-          charge_details
-          footer
-        end
-      end
+      header
+      description
+      statement_details
+      charge_details
+      footer
     end
 
-    def header
-      move_down 60
-
+    def header(height: 24)
       logo = company[:logo]
+      return if logo.nil?
+      image load_image(logo), height: height
+    end
 
-      if logo.nil?
-        move_down 32
-      elsif logo.is_a?(String)
-        image URI.parse(logo).open, height: 32
-      else
-        image logo, height: 32
-      end
-
+    def description
       move_down 8
-      label(subheading % {id: id})
+      text label(subheading % {id: id}), inline_format: true, leading: 4
+    end
 
+    def statement_details
       move_down 10
-
-      # Cache the Y value so we can have both boxes at the same height
-      top = y
-      bounding_box([0, y], width: 200) do
-        move_down 5
-        text_box bill_to, at: [0, cursor], width: 200, height: 75, inline_format: true, size: 10, leading: 4, overflow: :shrink_to_fit
-      end
-
-      bounding_box([250, top], width: 200) do
-        label "STATEMENT DATE"
-
-        move_down 5
-        text issue_date.to_s, inline_format: true, size: 12, leading: 4
-
-        move_down 10
-        label "STATEMENT PERIOD"
-
-        move_down 5
-        text "#{start_date} - #{end_date}", inline_format: true, size: 12, leading: 4
+      font_size 9
+
+      line_items = [
+        [{content: "#{label("BILL TO")}\n#{bill_to}", rowspan: 3, padding: [0, 12, 0, 0]}, "#{label("INVOICE DATE")}\n#{issue_date}"],
+        ["#{label("STATEMENT DATE")}\n#{issue_date}"],
+        ["#{label("STATEMENT PERIOD")}\n#{start_date} - #{end_date}"]
+      ]
+      table(line_items, width: bounds.width, cell_style: {inline_format: true, overflow: :shrink_to_fit}) do
+        cells.borders = []
       end
     end
 
@@ -94,7 +70,7 @@ module Receipts
       borders = line_items.length - 2
 
       table(line_items, width: bounds.width, cell_style: {border_color: "cccccc", inline_format: true}) do
-        cells.padding = 12
+        cells.padding = 10
         cells.borders = []
         row(0..borders).borders = [:bottom]
       end
@@ -102,15 +78,11 @@ module Receipts
 
     def footer
       move_down 30
-      text message, inline_format: true, size: 12, leading: 4
+      text message, inline_format: true, leading: 4
 
       move_down 30
       text company.fetch(:name), inline_format: true
       text "<color rgb='888888'>#{company.fetch(:address)}</color>", inline_format: true
     end
-
-    def label(text)
-      text "<color rgb='a6a6a6'>#{text}</color>", inline_format: true, size: 8
-    end
   end
 end

data/lib/receipts/version.rb

@@ -1,3 +1,3 @@
 module Receipts
-  VERSION = "1.1.1"
+  VERSION = "1.1.2"
 end

data/lib/receipts.rb

@@ -1,8 +1,29 @@
-require "open-uri"
 require "receipts/version"
+require "open-uri"
+require "prawn"
+require "prawn/table"
 
 module Receipts
   autoload :Invoice, "receipts/invoice"
   autoload :Receipt, "receipts/receipt"
   autoload :Statement, "receipts/statement"
+
+  class Base < Prawn::Document
+    def setup_fonts
+      font_families.update "Primary" => custom_font
+      font "Primary"
+    end
+
+    def load_image(logo)
+      if logo.is_a? String
+        logo.start_with?("http") ? URI.parse(logo).open : File.open(logo)
+      else
+        logo
+      end
+    end
+
+    def label(text)
+      "<font size='8'><color rgb='a6a6a6'>#{text}</color></font>"
+    end
+  end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: receipts
 version: !ruby/object:Gem::Version
-  version: 1.1.1
+  version: 1.1.2
 platform: ruby
 authors:
 - Chris Oliver
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2021-08-01 00:00:00.000000000 Z
+date: 2021-09-04 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -161,7 +161,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.2.15
+rubygems_version: 3.2.22
 signing_key:
 specification_version: 4
 summary: Receipts for your Rails application that works with any payment provider.