receipts 1.1.2 → 2.1.0

data/Rakefile

@@ -1,12 +1,15 @@
+# frozen_string_literal: true
+
 require "bundler/gem_tasks"
-require "rspec/core/rake_task"
-require "open-uri"
+require "rake/testtask"
 
-RSpec::Core::RakeTask.new("spec")
+Rake::TestTask.new(:test) do |t|
+  t.libs << "test"
+  t.libs << "lib"
+  t.test_files = FileList["test/**/test_*.rb"]
+end
 
-# If you want to make this the default task
-task default: :spec
-task test: :spec
+task default: :test
 
 task :console do
   exec "irb -r receipts -I ./lib"
@@ -14,60 +17,74 @@ 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"
 
-  Receipts::Receipt.new(
-    id: "123",
-    subheading: "RECEIPT FOR CHARGE #1",
-    product: "GoRails",
+  r = Receipts::Receipt.new(
+    recipient: [
+      "<b>Bill To</b>",
+      "Customer",
+      "Address",
+      "City, State Zipcode",
+      "customer@example.org"
+    ],
     company: {
-      name: "GoRails, LLC",
+      name: "Example, LLC",
       address: "123 Fake Street\nNew York City, NY 10012",
+      phone: "(555) 867-5309",
       email: "support@example.com",
-      logo: "https://www.ruby-lang.org/images/header-ruby-logo@2x.png"
+      logo: File.expand_path("./examples/images/logo.png")
     },
+    details: [
+      ["Receipt Number", "123"],
+      ["Date paid", Date.today.strftime("%B %d, %Y")],
+      ["Payment method", "ACH super long super long super long super long super long"]
+    ],
     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"]
+      ["<b>Item</b>", "<b>Unit Cost</b>", "<b>Quantity</b>", "<b>Amount</b>"],
+      ["Subscription", "$19.00", "1", "$19.00"],
+      [nil, nil, "Subtotal", "$19.00"],
+      [nil, nil, "Tax", "$1.12"],
+      [nil, nil, "Total", "$20.12"],
+      [nil, nil, "<b>Amount paid</b>", "$20.12"],
+      [nil, nil, "Refunded on #{Date.today.strftime("%B %d, %Y")}", "$5.00"]
     ]
-  ).render_file "examples/receipt.pdf"
+  )
+  r.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",
+    details: [
+      ["Invoice Number", "123"],
+      ["Issue Date", Date.today.strftime("%B %d, %Y")],
+      ["Due Date", Date.today.strftime("%B %d, %Y")],
+      ["Status", "<b><color rgb='#5eba7d'>PAID</color></b>"]
+    ],
+    recipient: [
+      "<b>Bill To</b>",
+      "Customer",
       "Address",
       "City, State Zipcode",
-      nil,
-      "mail@example.com"
+      "customer@example.org"
     ],
     company: {
-      name: "GoRails, LLC",
+      name: "Example, LLC",
       address: "123 Fake Street\nNew York City, NY 10012",
+      phone: "(555) 867-5309",
       email: "support@example.com",
-      # logo: Rails.root.join("app/assets/images/gorails.png")
-      # logo: File.expand_path("./examples/gorails.png")
-      logo: File.open("./examples/gorails.png")
+      # logo: Rails.root.join("app/assets/images/logo.png")
+      # logo: File.open("./examples/images/logo.png")
+      logo: File.expand_path("./examples/images/logo.png")
     },
     line_items: [
       ["<b>Item</b>", "<b>Unit Cost</b>", "<b>Quantity</b>", "<b>Amount</b>"],
-      ["GoRails Subscription", "$19.00", "1", "$19.00"],
+      ["Subscription", "$19.00", "1", "$19.00"],
       [nil, nil, "Subtotal", "$19.00"],
       [nil, nil, "Tax Rate", "0%"],
       [nil, nil, "Amount Due", "$19.00"]
@@ -79,26 +96,28 @@ task :statement do
   require "./lib/receipts"
 
   Receipts::Statement.new(
-    id: "123",
-    issue_date: Date.today,
-    start_date: Date.today - 30,
-    end_date: Date.today,
-    bill_to: [
-      "GoRails, LLC",
-      "123 Fake Street",
-      "New York City, NY 10012",
-      nil,
-      "mail@example.com"
+    details: [
+      ["Statement Number", "123"],
+      ["Issue Date", Date.today.strftime("%B %d, %Y")],
+      ["Period", "#{(Date.today - 30).strftime("%B %d, %Y")} - #{Date.today.strftime("%B %d, %Y")}"]
+    ],
+    recipient: [
+      "<b>Bill To</b>",
+      "Customer",
+      "Address",
+      "City, State Zipcode",
+      "customer@example.org"
     ],
     company: {
-      name: "GoRails, LLC",
+      name: "Example, LLC",
       address: "123 Fake Street\nNew York City, NY 10012",
       email: "support@example.com",
-      logo: File.expand_path("./examples/gorails.png")
+      phone: "(555) 867-5309",
+      logo: File.expand_path("./examples/images/logo.png")
     },
     line_items: [
       ["<b>Item</b>", "<b>Unit Cost</b>", "<b>Quantity</b>", "<b>Amount</b>"],
-      ["GoRails Subscription", "$19.00", "1", "$19.00"],
+      ["Subscription", "$19.00", "1", "$19.00"],
       [nil, nil, "Subtotal", "$19.00"],
       [nil, nil, "Tax Rate", "0%"],
       [nil, nil, "Total", "$19.00"]

data/lib/receipts/base.rb

@@ -0,0 +1,102 @@
+module Receipts
+  class Base < Prawn::Document
+    attr_accessor :title, :company
+
+    class << self
+      attr_reader :title
+    end
+
+    def initialize(attributes = {})
+      super(page_size: "LETTER")
+      setup_fonts attributes.fetch(:font, Receipts.default_font)
+
+      @title = attributes.fetch(:title, self.class.title)
+
+      generate_from(attributes)
+    end
+
+    def generate_from(attributes)
+      return if attributes.empty?
+
+      company = attributes.fetch(:company)
+      header company: company
+      render_details attributes.fetch(:details)
+      render_billing_details company: company, recipient: attributes.fetch(:recipient)
+      render_line_items attributes.fetch(:line_items)
+      render_footer attributes.fetch(:footer, default_message(company: company))
+    end
+
+    def setup_fonts(custom_font = nil)
+      if !!custom_font
+        font_families.update "Primary" => custom_font
+        font "Primary"
+      end
+
+      font_size 8
+    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 header(company: {}, height: 16)
+      logo = company[:logo]
+
+      if logo.nil?
+        text company.fetch(:name), align: :right, style: :bold, size: 16, color: "4b5563"
+      else
+        image load_image(logo), height: height, position: :right
+      end
+
+      move_up height
+      text title, style: :bold, size: 16
+    end
+
+    def render_details(details, margin_top: 16)
+      move_down margin_top
+      table(details, cell_style: {borders: [], inline_format: true, padding: [0, 8, 2, 0]})
+    end
+
+    def render_billing_details(company:, recipient:, margin_top: 16)
+      move_down margin_top
+
+      company_details = [
+        company[:address],
+        company[:phone],
+        company[:email]
+      ].compact.join("\n")
+
+      line_items = [
+        [
+          {content: "<b>#{company.fetch(:name)}</b>\n#{company_details}", padding: [0, 12, 0, 0]},
+          {content: Array(recipient).join("\n"), padding: [0, 12, 0, 0]}
+        ]
+      ]
+      table(line_items, width: bounds.width, cell_style: {borders: [], inline_format: true, overflow: :expand})
+    end
+
+    def render_line_items(line_items, margin_top: 30)
+      move_down margin_top
+
+      borders = line_items.length - 2
+      table(line_items, width: bounds.width, cell_style: {border_color: "eeeeee", inline_format: true}) do
+        cells.padding = 6
+        cells.borders = []
+        row(0..borders).borders = [:bottom]
+      end
+    end
+
+    def render_footer(message, margin_top: 30)
+      move_down margin_top
+      text message, inline_format: true
+    end
+
+    def default_message(company:)
+      "For questions, contact us anytime at <color rgb='326d92'><link href='mailto:#{company.fetch(:email)}?subject=Question about my receipt'><b>#{company.fetch(:email)}</b></link></color>."
+    end
+  end
+end

data/lib/receipts/invoice.rb

@@ -1,91 +1,5 @@
-require "prawn"
-require "prawn/table"
-
 module Receipts
   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)
-      @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(page_size: "LETTER")
-
-      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 generate
-      header
-      description
-      invoice_details
-      charge_details
-      footer
-    end
-
-    def header(height: 24)
-      logo = company[:logo]
-      return if logo.nil?
-      image load_image(logo), height: height
-    end
-
-    def description
-      move_down 8
-      text label(subheading % {id: id}), inline_format: true, leading: 4
-    end
-
-    def invoice_details
-      move_down 10
-      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
-
-    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, overflow: :shrink_to_fit}) do
-        cells.padding = 10
-        cells.borders = []
-        row(0..borders).borders = [:bottom]
-      end
-    end
-
-    def footer
-      move_down 30
-      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
+    @title = "Invoice"
   end
 end

data/lib/receipts/receipt.rb

@@ -1,70 +1,5 @@
 module Receipts
   class Receipt < Base
-    attr_reader :attributes, :id, :company, :custom_font, :line_items, :logo, :message, :product, :subheading
-
-    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 }
-
-      super(page_size: "LETTER")
-
-      setup_fonts if custom_font.any?
-      generate
-    end
-
-    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)}?subject=Charge ##{id}'><b>#{company.fetch(:email)}</b></link></color>."
-    end
-
-    def default_subheading
-      "RECEIPT FOR CHARGE #%{id}"
-    end
-
-    def generate
-      header
-      description
-      charge_details
-      footer
-    end
-
-    def header(height: 24)
-      logo = company[:logo]
-      return if logo.nil?
-      image load_image(logo), height: height
-    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, 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 = 10
-        cells.borders = []
-        row(0..borders).borders = [:bottom]
-      end
-    end
-
-    def footer
-      move_down 45
-      text company.fetch(:name), inline_format: true
-      text "<color rgb='888888'>#{company.fetch(:address)}</color>", inline_format: true
-    end
+    @title = "Receipt"
   end
 end

data/lib/receipts/statement.rb

@@ -1,88 +1,5 @@
 module Receipts
   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)
-      @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)
-      @start_date = attributes.fetch(:start_date)
-      @end_date = attributes.fetch(:end_date)
-
-      super(page_size: "LETTER")
-
-      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
-      "STATEMENT #%{id}"
-    end
-
-    def generate
-      header
-      description
-      statement_details
-      charge_details
-      footer
-    end
-
-    def header(height: 24)
-      logo = company[:logo]
-      return if logo.nil?
-      image load_image(logo), height: height
-    end
-
-    def description
-      move_down 8
-      text label(subheading % {id: id}), inline_format: true, leading: 4
-    end
-
-    def statement_details
-      move_down 10
-      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
-
-    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 = 10
-        cells.borders = []
-        row(0..borders).borders = [:bottom]
-      end
-    end
-
-    def footer
-      move_down 30
-      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
+    @title = "Statement"
   end
 end

data/lib/receipts/version.rb

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

data/lib/receipts.rb

@@ -4,26 +4,23 @@ require "prawn"
 require "prawn/table"
 
 module Receipts
+  autoload :Base, "receipts/base"
   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
+  @@default_font = nil
 
-    def load_image(logo)
-      if logo.is_a? String
-        logo.start_with?("http") ? URI.parse(logo).open : File.open(logo)
-      else
-        logo
-      end
-    end
+  # 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 label(text)
-      "<font size='8'><color rgb='a6a6a6'>#{text}</color></font>"
-    end
+  def self.default_font
+    @@default_font
   end
 end

data/receipts.gemspec

@@ -1,27 +1,32 @@
-lib = File.expand_path("../lib", __FILE__)
-$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
-require "receipts/version"
+# frozen_string_literal: true
+
+require_relative "lib/receipts/version"
 
 Gem::Specification.new do |spec|
   spec.name = "receipts"
   spec.version = Receipts::VERSION
   spec.authors = ["Chris Oliver"]
   spec.email = ["excid3@gmail.com"]
+
   spec.summary = "Receipts for your Rails application that works with any payment provider."
   spec.description = "Receipts for your Rails application that works with any payment provider."
-  spec.homepage = ""
+  spec.homepage = "https://github.com/excid3/receipts"
   spec.license = "MIT"
 
-  spec.files = `git ls-files -z`.split("\x0")
-  spec.executables = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
-  spec.test_files = spec.files.grep(%r{^(test|spec|features)/})
-  spec.require_paths = ["lib"]
+  spec.metadata["homepage_uri"] = spec.homepage
+  spec.metadata["source_code_uri"] = spec.homepage
+  spec.metadata["changelog_uri"] = "https://github.com/excid3/receipts/blob/master/CHANGELOG.md"
 
-  spec.add_development_dependency "bundler"
-  spec.add_development_dependency "rake", "~> 10.0"
-  spec.add_development_dependency "rspec"
-  spec.add_development_dependency "pry"
-  spec.add_development_dependency "standard"
+  # Specify which files should be added to the gem when it is released.
+  # The `git ls-files -z` loads the files in the RubyGem that have been added into git.
+  spec.files = Dir.chdir(File.expand_path(__dir__)) do
+    `git ls-files -z`.split("\x0").reject do |f|
+      (f == __FILE__) || f.match(%r{\A(?:(?:test|spec|features)/|\.(?:git|travis|circleci)|appveyor)})
+    end
+  end
+  spec.bindir = "exe"
+  spec.executables = spec.files.grep(%r{\Aexe/}) { |f| File.basename(f) }
+  spec.require_paths = ["lib"]
 
   spec.add_dependency "prawn", ">= 1.3.0", "< 3.0.0"
   spec.add_dependency "prawn-table", "~> 0.2.1"