receipts 0.2.0 → 1.0.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
-SHA1:
-  metadata.gz: ffe69c912de6f283a23d70695c3c83c3e3fdcb9e
-  data.tar.gz: d02dcdf880e8d20a212fb2dad00a30908169ed4f
+SHA256:
+  metadata.gz: '065796e25d569a927cf67ebaa208b8d33c189a4ce3786196dc236c563191bb89'
+  data.tar.gz: 4f59197b6b35a5cbd71f23586b69a3808655b79127c2c520dd13ee9d6c7efc3d
 SHA512:
-  metadata.gz: 17f10bce71d24b7b7a1c7f578786610fc10b0cea401457e3990d7ab9de49426ddfaeaa68a8d086475511a0b16089d5bf0bb5991d83186ca974174e99c09552c9
-  data.tar.gz: 1f0142ca8dfd892f54b8050db23da2b7e51a2e69ad64b7cb34f6aa44b72eaf13f499a58083a7d6ed405b0406a3e0bf7d529a26385446b3bb51aa94214fa79fd0
+  metadata.gz: d44d166eef2ea75f01ffe9c990b42e6a59ab932bc4e9a773ba00b7f11944448e1e4a16b426c6fc0649b472839825244f84e9825860bae0efb7d1d8c34209541b
+  data.tar.gz: 6c2a3f9378751854d21daf34de2940a8a09f112a629fbaccbfb90f35c7e8bef56179cbae596d319749f165dd77e5413f712a8bdbb3d7b7e23f85cea9ecd6d321

data/.github/FUNDING.yml

@@ -0,0 +1,12 @@
+# These are supported funding model platforms
+
+github: [excid3] # Replace with up to 4 GitHub Sponsors-enabled usernames e.g., [user1, user2]
+patreon: # Replace with a single Patreon username
+open_collective: # Replace with a single Open Collective username
+ko_fi: # Replace with a single Ko-fi username
+tidelift: # Replace with a single Tidelift platform-name/package-name e.g., npm/babel
+community_bridge: # Replace with a single Community Bridge project-name e.g., cloud-foundry
+liberapay: # Replace with a single Liberapay username
+issuehunt: # Replace with a single IssueHunt username
+otechie: # Replace with a single Otechie username
+custom: # Replace with up to 4 custom sponsorship URLs e.g., ['link1', 'link2']

data/.gitignore

@@ -12,3 +12,4 @@
 *.o
 *.a
 mkmf.log
+.DS_Store

data/.travis.yml

@@ -1,4 +1,4 @@
 language: ruby
 rvm:
-  - 1.9.3
-  - 2.2.2
+  - 2.3.3
+  - 2.4.0

data/CHANGELOG.md

@@ -0,0 +1,7 @@
+### 1.0.1
+
+* [FIX] Make tables full width
+
+### 1.0.0
+
+* [NEW] Invoices!

data/README.md

@@ -4,7 +4,7 @@
 
 Receipts for your Rails application that works with any payment provider.
 
-Check out an [example PDF receipt](https://github.com/excid3/receipts/blob/master/examples/receipt.pdf?raw=true)
+Check out the [example receipt](https://github.com/excid3/receipts/blob/master/examples/receipt.pdf?raw=true) and [example invoice](https://github.com/excid3/receipts/blob/master/examples/invoice.pdf?raw=true) PDFs.
 
 ## Installation
 
@@ -60,11 +60,12 @@ class Charge < ActiveRecord::Base
   def receipt
     Receipts::Receipt.new(
       id: id,
+      subheading: "RECEIPT FOR CHARGE #%{id}",
       product: "GoRails",
       company: {
-        name: "One Month, Inc.",
-        address: "37 Great Jones\nFloor 2\nNew York City, NY 10012",
-        email: "teachers@onemonth.com",
+        name: "GoRails, LLC.",
+        address: "123 Fake Street\nNew York City, NY 10012",
+        email: "support@example.com",
         logo: Rails.root.join("app/assets/images/one-month-dark.png")
       },
       line_items: [
@@ -169,9 +170,52 @@ resources :charges
 <%= link_to "Download Receipt", charge_path(@charge, format: :pdf) %>
 ```
 
+## Invoices
+
+Invoices follow the exact same set of steps as above, with a few minor changes and have a few extra arguments you can use:
+
+* `issue_date` - Date the invoice was issued
+
+* `due_date` - Date the invoice payment is due
+
+* `status` - A status for the invoice (Pending, Paid, etc)
+
+* `bill_to` - A string or Array of lines with billing details
+
+You can also use line_items to flexibly generate and display the table with items in it, including subtotal, taxes, and total amount.
+
+```ruby
+  Receipts::Invoice.new(
+    id: "123",
+    issue_date: Date.today,
+    due_date: Date.today + 30,
+    status: "<b><color rgb='#5eba7d'>PAID</color></b>",
+    bill_to: [
+      "GoRails, LLC",
+      "123 Fake Street",
+      "New York City, NY 10012",
+      nil,
+      "mail@example.com",
+    ],
+    company: {
+      name: "GoRails, LLC",
+      address: "123 Fake Street\nNew York City, NY 10012",
+      email: "support@example.com",
+      logo: File.expand_path("./examples/gorails.png")
+    },
+    line_items: [
+      ["<b>Item</b>", "<b>Unit Cost</b>", "<b>Quantity</b>", "<b>Amount</b>"],
+      ["GoRails Subscription", "$19.00", "1", "$19.00"],
+      [nil, nil, "Subtotal", "$19.00"],
+      [nil, nil, "Tax Rate", "0%"],
+      [nil, nil, "Total", "$19.00"],
+    ],
+  )
+```
+
 ## Contributing
 
-1. Fork it ( https://github.com/[my-github-username]/receipts/fork )
+1. Fork it ( 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`)

data/Rakefile

@@ -10,3 +10,58 @@ task :test => :spec
 task :console do
   exec "irb -r receipts -I ./lib"
 end
+
+task :receipt do
+  require "./lib/receipts"
+
+  Receipts::Receipt.new(
+    id: "123",
+    subheading: "RECEIPT FOR CHARGE #1",
+    product: "GoRails",
+    company: {
+      name: "GoRails, LLC",
+      address: "123 Fake Street\nNew York City, NY 10012",
+      email: "support@example.com",
+      logo: File.expand_path("./examples/gorails.png")
+    },
+    line_items: [
+      ["Date",           Time.now.to_s],
+      ["Account Billed", "Example User (user@example.com)"],
+      ["Product",        "GoRails"],
+      ["Amount",         "$19.00"],
+      ["Charged to",     "Visa (**** **** **** 1234)"],
+      ["Transaction ID", "123456"]
+    ],
+  ).render_file "examples/receipt.pdf"
+end
+
+task :invoice do
+  require "./lib/receipts"
+
+  Receipts::Invoice.new(
+    id: "123",
+    issue_date: Date.today,
+    due_date: Date.today + 30,
+    status: "<b><color rgb='#5eba7d'>PAID</color></b>",
+    bill_to: [
+      "GoRails, LLC",
+      "Address",
+      "City, State Zipcode",
+      nil,
+      "mail@example.com",
+    ],
+    company: {
+      name: "GoRails, LLC",
+      address: "123 Fake Street\nNew York City, NY 10012",
+      email: "support@example.com",
+      logo: File.expand_path("./examples/gorails.png")
+    },
+    line_items: [
+      ["<b>Item</b>", "<b>Unit Cost</b>", "<b>Quantity</b>", "<b>Amount</b>"],
+      ["GoRails Subscription", "$19.00", "1", "$19.00"],
+      [nil, nil, "Subtotal", "$19.00"],
+      [nil, nil, "Tax Rate", "0%"],
+      [nil, nil, "Amount Due", "$19.00"],
+    ],
+  ).render_file "examples/invoice.pdf"
+end

data/lib/receipts.rb

@@ -1,2 +1,3 @@
 require "receipts/version"
 require "receipts/receipt"
+require "receipts/invoice"

data/lib/receipts/invoice.rb

@@ -0,0 +1,123 @@
+require 'prawn'
+require 'prawn/table'
+
+module Receipts
+  class Invoice < Prawn::Document
+    attr_reader :attributes, :id, :company, :custom_font, :line_items, :logo, :message, :product, :subheading, :bill_to, :issue_date, :due_date, :status
+
+    def initialize(attributes)
+      @attributes  = attributes
+      @id          = attributes.fetch(:id)
+      @company     = attributes.fetch(:company)
+      @line_items  = attributes.fetch(:line_items)
+      @custom_font = attributes.fetch(:font, {})
+      @message     = attributes.fetch(:message) { default_message }
+      @subheading  = attributes.fetch(:subheading) { default_subheading }
+      @bill_to     = Array(attributes.fetch(:bill_to)).join("\n")
+      @issue_date  = attributes.fetch(:issue_date)
+      @due_date    = attributes.fetch(:due_date)
+      @status      = attributes.fetch(:status)
+
+      super(margin: 0)
+
+      setup_fonts if custom_font.any?
+      generate
+    end
+
+    private
+
+      def default_message
+        "For questions, contact us anytime at <color rgb='326d92'><link href='mailto:#{company.fetch(:email)}?subject=Charge ##{id}'><b>#{company.fetch(:email)}</b></link></color>."
+      end
+
+      def default_subheading
+        "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
+      end
+
+      def header
+        move_down 60
+
+        logo_path = company.fetch(:logo, '')
+
+        if logo_path.empty?
+          move_down 32
+        else
+          image open(logo_path), height: 32
+        end
+
+        move_down 8
+        label (subheading % {id: id})
+
+        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
+        end
+      end
+
+      def charge_details
+        move_down 30
+
+        borders = line_items.length - 2
+
+        table(line_items, width: bounds.width, cell_style: { border_color: 'cccccc', inline_format: true }) do
+          cells.padding = 12
+          cells.borders = []
+          row(0..borders).borders = [:bottom]
+        end
+      end
+
+      def footer
+        move_down 30
+        text message, inline_format: true, size: 12, 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

@@ -3,7 +3,7 @@ require 'prawn/table'
 
 module Receipts
   class Receipt < Prawn::Document
-    attr_reader :attributes, :id, :company, :custom_font, :line_items, :logo, :message, :product
+    attr_reader :attributes, :id, :company, :custom_font, :line_items, :logo, :message, :product, :subheading
 
     def initialize(attributes)
       @attributes  = attributes
@@ -12,6 +12,7 @@ module Receipts
       @line_items  = attributes.fetch(:line_items)
       @custom_font = attributes.fetch(:font, {})
       @message     = attributes.fetch(:message) { default_message }
+      @subheading  = attributes.fetch(:subheading) { default_subheading }
 
       super(margin: 0)
 
@@ -22,7 +23,11 @@ module Receipts
     private
 
       def default_message
-        "We've received your payment for #{attributes.fetch(:product)}. You can keep this receipt for your records. For questions, contact us anytime at <color rgb='326d92'><link href='mailto:#{company.fetch(:email)}.com?subject=\"Charge ##{id}\"'><b>#{company.fetch(:email)}</b></link></color>."
+        "We've received your payment for #{attributes.fetch(:product)}. You can keep this receipt for your records. For questions, contact us anytime at <color rgb='326d92'><link href='mailto:#{company.fetch(:email)}?subject=Charge ##{id}'><b>#{company.fetch(:email)}</b></link></color>."
+      end
+
+      def default_subheading
+        "RECEIPT FOR CHARGE #%{id}"
       end
 
       def setup_fonts
@@ -43,14 +48,16 @@ module Receipts
       def header
         move_down 60
 
-        if company.has_key? :logo
-          image open(company.fetch(:logo)), height: 32
-        else
+        logo_path = company.fetch(:logo, '')
+
+        if logo_path.empty?
           move_down 32
+        else
+          image open(logo_path), height: 32
         end
 
         move_down 8
-        text "<color rgb='a6a6a6'>RECEIPT FOR CHARGE ##{id}</color>", inline_format: true
+        text "<color rgb='a6a6a6'>#{subheading % { id: id }}</color>", inline_format: true
 
         move_down 30
         text message, inline_format: true, size: 12.5, leading: 4
@@ -61,7 +68,7 @@ module Receipts
 
         borders = line_items.length - 2
 
-        table(line_items, cell_style: { border_color: 'cccccc' }) do
+        table(line_items, width: bounds.width, cell_style: { border_color: 'cccccc', inline_format: true }) do
           cells.padding = 12
           cells.borders = []
           row(0..borders).borders = [:bottom]

data/lib/receipts/version.rb

@@ -1,3 +1,3 @@
 module Receipts
-  VERSION = "0.2.0"
+  VERSION = "1.0.1"
 end

data/receipts.gemspec

@@ -18,11 +18,12 @@ Gem::Specification.new do |spec|
   spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
   spec.require_paths = ["lib"]
 
-  spec.add_development_dependency "bundler", "~> 1.7"
+  spec.add_development_dependency "bundler"
   spec.add_development_dependency "rake", "~> 10.0"
   spec.add_development_dependency "rspec"
   spec.add_development_dependency "pry"
 
   spec.add_dependency 'prawn', '>= 1.3.0', '< 3.0.0'
   spec.add_dependency 'prawn-table', '~> 0.2.1'
+  spec.add_dependency 'ttfunk', '~> 1.5.1'
 end

metadata

@@ -1,29 +1,29 @@
 --- !ruby/object:Gem::Specification
 name: receipts
 version: !ruby/object:Gem::Version
-  version: 0.2.0
+  version: 1.0.1
 platform: ruby
 authors:
 - Chris Oliver
-autorequire: 
+autorequire:
 bindir: bin
 cert_chain: []
-date: 2016-12-28 00:00:00.000000000 Z
+date: 2020-06-27 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '1.7'
+        version: '0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '1.7'
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: rake
   requirement: !ruby/object:Gem::Requirement
@@ -100,6 +100,20 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: 0.2.1
+- !ruby/object:Gem::Dependency
+  name: ttfunk
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 1.5.1
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 1.5.1
 description: Receipts for your Rails application that works with any payment provider.
 email:
 - excid3@gmail.com
@@ -107,14 +121,19 @@ executables: []
 extensions: []
 extra_rdoc_files: []
 files:
+- ".github/FUNDING.yml"
 - ".gitignore"
 - ".travis.yml"
+- CHANGELOG.md
 - Gemfile
 - LICENSE.txt
 - README.md
 - Rakefile
+- examples/gorails.png
+- examples/invoice.pdf
 - examples/receipt.pdf
 - lib/receipts.rb
+- lib/receipts/invoice.rb
 - lib/receipts/receipt.rb
 - lib/receipts/version.rb
 - receipts.gemspec
@@ -124,7 +143,7 @@ homepage: ''
 licenses:
 - MIT
 metadata: {}
-post_install_message: 
+post_install_message:
 rdoc_options: []
 require_paths:
 - lib
@@ -139,9 +158,8 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubyforge_project: 
-rubygems_version: 2.6.8
-signing_key: 
+rubygems_version: 3.1.4
+signing_key:
 specification_version: 4
 summary: Receipts for your Rails application that works with any payment provider.
 test_files: