receipts 1.1.2 → 2.0.0

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[: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.0.0"
 end

data/lib/receipts.rb

@@ -4,26 +4,8 @@ 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
-
-    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

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"

metadata

@@ -1,85 +1,15 @@
 --- !ruby/object:Gem::Specification
 name: receipts
 version: !ruby/object:Gem::Version
-  version: 1.1.2
+  version: 2.0.0
 platform: ruby
 authors:
 - Chris Oliver
 autorequire:
-bindir: bin
+bindir: exe
 cert_chain: []
-date: 2021-09-04 00:00:00.000000000 Z
+date: 2022-01-30 00:00:00.000000000 Z
 dependencies:
-- !ruby/object:Gem::Dependency
-  name: bundler
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '0'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '0'
-- !ruby/object:Gem::Dependency
-  name: rake
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '10.0'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '10.0'
-- !ruby/object:Gem::Dependency
-  name: rspec
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '0'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '0'
-- !ruby/object:Gem::Dependency
-  name: pry
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '0'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '0'
-- !ruby/object:Gem::Dependency
-  name: standard
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '0'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '0'
 - !ruby/object:Gem::Dependency
   name: prawn
   requirement: !ruby/object:Gem::Requirement
@@ -121,31 +51,30 @@ executables: []
 extensions: []
 extra_rdoc_files: []
 files:
-- ".github/FUNDING.yml"
-- ".github/workflows/ci.yml"
-- ".gitignore"
-- ".travis.yml"
 - CHANGELOG.md
 - Gemfile
 - LICENSE.txt
 - README.md
 - Rakefile
-- examples/gorails.png
+- examples/images/logo.png
+- examples/images/options.jpg
 - examples/invoice.pdf
 - examples/receipt.pdf
 - examples/statement.pdf
 - lib/receipts.rb
+- lib/receipts/base.rb
 - lib/receipts/invoice.rb
 - lib/receipts/receipt.rb
 - lib/receipts/statement.rb
 - lib/receipts/version.rb
 - receipts.gemspec
-- spec/receipts_spec.rb
-- spec/spec_helper.rb
-homepage: ''
+homepage: https://github.com/excid3/receipts
 licenses:
 - MIT
-metadata: {}
+metadata:
+  homepage_uri: https://github.com/excid3/receipts
+  source_code_uri: https://github.com/excid3/receipts
+  changelog_uri: https://github.com/excid3/receipts/blob/master/CHANGELOG.md
 post_install_message:
 rdoc_options: []
 require_paths:
@@ -161,10 +90,8 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.2.22
+rubygems_version: 3.2.32
 signing_key:
 specification_version: 4
 summary: Receipts for your Rails application that works with any payment provider.
-test_files:
-- spec/receipts_spec.rb
-- spec/spec_helper.rb
+test_files: []

data/.github/FUNDING.yml

@@ -1,12 +0,0 @@
-# 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/.github/workflows/ci.yml

@@ -1,36 +0,0 @@
-name: Tests
-
-on:
-  pull_request:
-    branches:
-      - '*'
-  push:
-    branches:
-      - master
-jobs:
-  tests:
-    runs-on: ubuntu-latest
-    strategy:
-      matrix:
-        ruby: ['2.7', '3.0']
-    env:
-      BUNDLE_PATH_RELATIVE_TO_CWD: true
-
-    steps:
-      - uses: actions/checkout@master
-
-      - name: Set up Ruby
-        uses: ruby/setup-ruby@v1
-        with:
-          ruby-version: ${{ matrix.ruby }}
-          bundler: default
-          bundler-cache: true
-
-      - name: StandardRb check
-        run: bundle exec standardrb
-
-      - name: Run tests
-        env:
-          RAILS_ENV: test
-        run: |
-          bundle exec rspec

data/.gitignore

@@ -1,15 +0,0 @@
-/.bundle/
-/.yardoc
-/Gemfile.lock
-/_yardoc/
-/coverage/
-/doc/
-/pkg/
-/spec/reports/
-/tmp/
-*.bundle
-*.so
-*.o
-*.a
-mkmf.log
-.DS_Store

data/.travis.yml

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

data/spec/receipts_spec.rb

@@ -1,18 +0,0 @@
-require "spec_helper"
-
-describe Receipts do
-  it "lets you create a new receipt" do
-    expect(Receipts::Receipt.new(
-      id: 1,
-      product: "GoRails",
-      company: {
-        name: "One Month, Inc.",
-        address: "37 Great Jones\nFloor 2\nNew York City, NY 10012",
-        email: "teachers@onemonth.com"
-      },
-      line_items: [
-        ["Product", "GoRails"]
-      ]
-    ).class.name).to eq("Receipts::Receipt")
-  end
-end

data/spec/spec_helper.rb

@@ -1,9 +0,0 @@
-begin
-  require "pry"
-rescue LoadError
-end
-
-require "receipts"
-
-RSpec.configure do |config|
-end