invoice_printer 0.0.1

data/lib/invoice_printer/version.rb

@@ -0,0 +1,3 @@
+module InvoicePrinter
+  VERSION = '0.0.1'
+end

data/test/dates_box_test.rb

@@ -0,0 +1,53 @@
+require 'test_helper'
+
+class DatesBoxTest < Minitest::Test
+  include InvoicePrinterHelpers
+
+  def test_setting_issue_date_and_due_date
+    params = default_document_params.merge(
+      issue_date: '05/03/2016',
+      due_date: '14/03/2016'
+    )
+    invoice = InvoicePrinter::Document.new(params)
+    rendered_pdf = InvoicePrinter.render(document: invoice)
+    pdf_analysis = PDF::Inspector::Text.analyze(rendered_pdf)
+    assert_equal true, pdf_analysis.strings.include?('Issue date:')
+    assert_equal true, pdf_analysis.strings.include?('Due date:')
+  end
+
+  def test_setting_only_issue_date
+    params = default_document_params.merge(
+      issue_date: '05/03/2016',
+      due_date: ''
+    )
+    invoice = InvoicePrinter::Document.new(params)
+    rendered_pdf = InvoicePrinter.render(document: invoice)
+    pdf_analysis = PDF::Inspector::Text.analyze(rendered_pdf)
+    assert_equal true, pdf_analysis.strings.include?('Issue date:')
+    assert_equal false, pdf_analysis.strings.include?('Due date:')
+  end
+
+  def test_setting_only_due_date
+    params = default_document_params.merge(
+      issue_date: nil,
+      due_date: '05/03/2016'
+    )
+    invoice = InvoicePrinter::Document.new(params)
+    rendered_pdf = InvoicePrinter.render(document: invoice)
+    pdf_analysis = PDF::Inspector::Text.analyze(rendered_pdf)
+    assert_equal false, pdf_analysis.strings.include?('Issue date:')
+    assert_equal true, pdf_analysis.strings.include?('Due date:')
+  end
+
+  def test_setting_no_dates
+    params = default_document_params.merge(
+      issue_date: '',
+      due_date: nil
+    )
+    invoice = InvoicePrinter::Document.new(params)
+    rendered_pdf = InvoicePrinter.render(document: invoice)
+    pdf_analysis = PDF::Inspector::Text.analyze(rendered_pdf)
+    assert_equal false, pdf_analysis.strings.include?('Issue date:')
+    assert_equal false, pdf_analysis.strings.include?('Due date:')
+  end
+end

data/test/invoice_printer_test.rb

@@ -0,0 +1,14 @@
+require 'test_helper'
+
+class InvoicePrinterTest < Minitest::Test
+  include InvoicePrinterHelpers
+
+  def test_render_document
+    invoice = InvoicePrinter::Document.new(default_document_params)
+    rendered_pdf = InvoicePrinter.render(document: invoice)
+    pdf_analysis = PDF::Inspector::Text.analyze(rendered_pdf)
+
+    strings = InvoicePrinter::PDFDocument.new(document: invoice).to_a
+    assert_equal strings, pdf_analysis.strings
+  end
+end

data/test/items_table_test.rb

@@ -0,0 +1,55 @@
+require 'test_helper'
+
+class ItemsTableTest < Minitest::Test
+  include InvoicePrinterHelpers
+
+  def test_omitting_name_column
+    test_ommiting_column(column: 'name', label: :item)
+  end
+
+  def test_omitting_quantity_column
+    test_ommiting_column(column: 'quantity', label: :quantity)
+  end
+
+  def test_omitting_unit_column
+    test_ommiting_column(column: 'unit', label: :unit)
+  end
+
+  def test_omitting_price_column
+    test_ommiting_column(column: 'price', label: :price_per_item)
+  end
+
+  # TODO: We need to distinguish between items' taxes and document taxes
+  #
+  #def test_omitting_tax_column
+  #  test_ommiting_column(column: 'tax', label: :tax)
+  #end
+
+  def test_omitting_amount_column
+    test_ommiting_column(column: 'amount', label: :amount)
+  end
+
+  private
+
+  def test_ommiting_column(column:, label:)
+    invoice = invoice_without_item_column(column)
+    rendered_pdf = InvoicePrinter.render(document: invoice)
+    pdf_analysis = PDF::Inspector::Text.analyze(rendered_pdf)
+    assert_equal false, pdf_analysis.strings.include?(InvoicePrinter.labels[label])
+
+    strings = InvoicePrinter::PDFDocument.new(document: invoice).to_a
+    assert_equal strings, pdf_analysis.strings
+  end
+
+  def invoice_without_item_column(column)
+    InvoicePrinter::Document.new(
+      default_document_params.merge(
+        items: [
+          InvoicePrinter::Document::Item.new(
+            default_document_item_params.merge("#{column}": nil)
+          )
+        ]
+      )
+    )
+  end
+end

data/test/labels_test.rb

@@ -0,0 +1,28 @@
+require 'test_helper'
+
+class LabelsTest < Minitest::Test
+  include InvoicePrinterHelpers
+
+  def test_setting_global_labels
+    labels = { provider: 'Default Provider', purchaser: 'Default Purchaser' }
+    InvoicePrinter.labels = labels
+
+    invoice = InvoicePrinter::Document.new(default_document_params)
+    rendered_pdf = InvoicePrinter.render(document: invoice)
+    pdf_analysis = PDF::Inspector::Text.analyze(rendered_pdf)
+
+    assert_equal true, pdf_analysis.strings.include?('Default Provider')
+    assert_equal true, pdf_analysis.strings.include?('Default Purchaser')
+  end
+
+  def test_setting_instant_labels
+    labels = { provider: 'Current Provider', purchaser: 'Current Purchaser' }
+
+    invoice = InvoicePrinter::Document.new(default_document_params)
+    rendered_pdf = InvoicePrinter.render(document: invoice, labels: labels)
+    pdf_analysis = PDF::Inspector::Text.analyze(rendered_pdf)
+
+    assert_equal true, pdf_analysis.strings.include?('Current Provider')
+    assert_equal true, pdf_analysis.strings.include?('Current Purchaser')
+  end
+end

data/test/payment_box_test.rb

@@ -0,0 +1,92 @@
+require 'test_helper'
+
+class PaymentBoxTest < Minitest::Test
+  include InvoicePrinterHelpers
+
+  def test_setting_no_bank_account_number
+    params = default_document_params.merge(
+      bank_account_number: nil,
+      account_iban: 'IBAN'
+    )
+    invoice = InvoicePrinter::Document.new(params)
+    rendered_pdf = InvoicePrinter.render(document: invoice)
+    pdf_analysis = PDF::Inspector::Text.analyze(rendered_pdf)
+
+    assert_equal true, pdf_analysis.strings.include?('Payment in cash')
+    assert_equal false, pdf_analysis.strings.include?('Payment by bank transfer on the account below:')
+    assert_equal false, pdf_analysis.strings.include?('SWIFT:')
+    assert_equal false, pdf_analysis.strings.include?('IBAN:')
+  end
+
+  def test_setting_only_local_bank_account_number
+    params = default_document_params.merge(
+      bank_account_number: '218291829/0100',
+      account_iban: nil,
+      account_swift: nil
+    )
+    invoice = InvoicePrinter::Document.new(params)
+    rendered_pdf = InvoicePrinter.render(document: invoice)
+    pdf_analysis = PDF::Inspector::Text.analyze(rendered_pdf)
+
+    assert_equal false, pdf_analysis.strings.include?('Payment in cash')
+    assert_equal true, pdf_analysis.strings.include?('Payment by bank transfer on the account below:')
+    assert_equal true, pdf_analysis.strings.include?('218291829/0100')
+    assert_equal false, pdf_analysis.strings.include?('SWIFT:')
+    assert_equal false, pdf_analysis.strings.include?('IBAN:')
+  end
+
+  def test_setting_bank_account_number_and_iban
+    params = default_document_params.merge(
+      bank_account_number: '218291829/0100',
+      account_iban: 'SAMPLE_IBAN',
+      account_swift: nil
+    )
+    invoice = InvoicePrinter::Document.new(params)
+    rendered_pdf = InvoicePrinter.render(document: invoice)
+    pdf_analysis = PDF::Inspector::Text.analyze(rendered_pdf)
+
+    assert_equal false, pdf_analysis.strings.include?('Payment in cash')
+    assert_equal true, pdf_analysis.strings.include?('Payment by bank transfer on the account below:')
+    assert_equal true, pdf_analysis.strings.include?('218291829/0100')
+    assert_equal false, pdf_analysis.strings.include?('SWIFT:')
+    assert_equal true, pdf_analysis.strings.include?('IBAN:')
+    assert_equal true, pdf_analysis.strings.include?('SAMPLE_IBAN')
+  end
+
+  def test_setting_bank_account_number_and_iban
+    params = default_document_params.merge(
+      bank_account_number: '218291829/0100',
+      account_iban: nil,
+      account_swift: 'SAMPLE_SWIFT'
+    )
+    invoice = InvoicePrinter::Document.new(params)
+    rendered_pdf = InvoicePrinter.render(document: invoice)
+    pdf_analysis = PDF::Inspector::Text.analyze(rendered_pdf)
+
+    assert_equal false, pdf_analysis.strings.include?('Payment in cash')
+    assert_equal true, pdf_analysis.strings.include?('Payment by bank transfer on the account below:')
+    assert_equal true, pdf_analysis.strings.include?('218291829/0100')
+    assert_equal true, pdf_analysis.strings.include?('SWIFT:')
+    assert_equal true, pdf_analysis.strings.include?('SAMPLE_SWIFT')
+    assert_equal false, pdf_analysis.strings.include?('IBAN:')
+  end
+
+  def test_setting_bank_account_number_iban_and_swift
+    params = default_document_params.merge(
+      bank_account_number: '218291829/0100',
+      account_iban: 'SAMPLE_IBAN',
+      account_swift: 'SAMPLE_SWIFT'
+    )
+    invoice = InvoicePrinter::Document.new(params)
+    rendered_pdf = InvoicePrinter.render(document: invoice)
+    pdf_analysis = PDF::Inspector::Text.analyze(rendered_pdf)
+
+    assert_equal false, pdf_analysis.strings.include?('Payment in cash')
+    assert_equal true, pdf_analysis.strings.include?('Payment by bank transfer on the account below:')
+    assert_equal true, pdf_analysis.strings.include?('218291829/0100')
+    assert_equal true, pdf_analysis.strings.include?('SWIFT:')
+    assert_equal true, pdf_analysis.strings.include?('SAMPLE_SWIFT')
+    assert_equal true, pdf_analysis.strings.include?('IBAN:')
+    assert_equal true, pdf_analysis.strings.include?('SAMPLE_IBAN')
+  end
+end

data/test/test_ext.rb

@@ -0,0 +1,102 @@
+module InvoicePrinter
+  class PDFDocument
+    # Expose the document as an array of attributes in order as their
+    # appear on PDF
+    def to_a
+      strings = []
+
+      strings << @labels[:name]
+      strings << @document.number
+
+      strings << @labels[:provider]
+      strings << @document.provider_name
+      strings << "#{@document.provider_street}    #{@document.provider_street_number}".strip
+      strings << @document.provider_postcode
+      strings << @document.provider_city
+      strings << @document.provider_city_part
+      strings << @document.provider_extra_address_line
+
+      strings << "#{@labels[:ic]}:    #{@document.provider_ic}" unless @document.provider_ic.nil?
+      strings << "#{@labels[:dic]}:    #{@document.provider_dic}" unless @document.provider_dic.nil?
+
+      strings << @labels[:purchaser]
+      strings << @document.purchaser_name
+      strings << "#{@document.purchaser_street}    #{@document.purchaser_street_number}".strip
+      strings << @document.purchaser_postcode
+      strings << @document.purchaser_city
+      strings << @document.purchaser_city_part
+      strings << @document.purchaser_extra_address_line
+
+      strings << "#{@labels[:ic]}:    #{@document.purchaser_ic}" unless @document.purchaser_ic.nil?
+      strings << "#{@labels[:dic]}:    #{@document.purchaser_dic}" unless @document.purchaser_dic.nil?
+
+      # Account
+      if @document.bank_account_number.nil?
+        strings << @labels[:payment_in_cash]
+      else
+        strings << @labels[:payment_by_transfer]
+      end
+
+      strings << "#{@labels[:account_number]}:"
+      strings << @document.bank_account_number
+      strings << "#{@labels[:swift]}:"
+      strings << @document.account_swift
+      strings << "#{@labels[:iban]}:"
+      strings << @document.account_iban
+
+      # Dates
+      strings << "#{@labels[:issue_date]}:"
+      strings << @document.issue_date
+      strings << "#{@labels[:due_date]}:"
+      strings << @document.due_date
+
+      # Items table
+      strings << @labels[:item] if determine_items_structure[:names]
+      strings << @labels[:quantity] if determine_items_structure[:quantities]
+      strings << @labels[:unit] if determine_items_structure[:units]
+      strings << @labels[:price_per_item] if determine_items_structure[:prices]
+      strings << @labels[:tax] if determine_items_structure[:taxes]
+      strings << @labels[:amount] if determine_items_structure[:amounts]
+      strings << items_to_a(@document.items)
+
+      # Total table
+      strings << "#{@labels[:subtotal]}:"
+      strings << @document.subtotal
+      strings << "#{@labels[:tax]}:"
+      strings << @document.tax
+      strings << "#{@labels[:tax2]}:"
+      strings << @document.tax2
+      strings << "#{@labels[:tax3]}:"
+      strings << @document.tax3
+      strings << "#{@labels[:total]}:   #{@document.total}"
+
+      # TODO: dynamically test page numbers
+      strings << '1 / 1'
+
+      strings.flatten.reject(&:empty?)
+    end
+
+    private
+
+    def items_to_a(items)
+      ary = []
+      items.each do |item|
+        ary << item_to_a(item)
+      end
+      ary.flatten
+    end
+
+    def item_to_a(item)
+      ary = []
+      ary << item.name
+      ary << item.quantity
+      ary << item.unit
+      ary << item.price
+      ary << item.tax
+      ary << item.tax2
+      ary << item.tax3
+      ary << item.amount
+      ary.compact
+    end
+  end
+end

data/test/test_helper.rb

@@ -0,0 +1,57 @@
+require 'pdf/inspector'
+require 'invoice_printer'
+require 'test_ext'
+require 'minitest/autorun'
+
+# Helpers for easy-to-build documents
+module InvoicePrinterHelpers
+  def default_document_params
+    {
+      number: '198900000001',
+      provider_name: 'Business s.r.o.',
+      provider_ic: '56565656',
+      provider_dic: '465454',
+      provider_street: 'Rolnicka',
+      provider_street_number: '1',
+      provider_postcode: '747 05',
+      provider_city: 'Opava',
+      provider_city_part: 'Katerinky',
+      provider_extra_address_line: 'Czech Republic',
+      purchaser_name: 'Adam',
+      purchaser_ic: nil,
+      purchaser_dic: nil,
+      purchaser_street: 'Ostravska',
+      purchaser_street_number: '1',
+      purchaser_postcode: '747 70',
+      purchaser_city: 'Opava',
+      purchaser_city_part: '',
+      purchaser_extra_address_line: '',
+      issue_date: '19/03/3939',
+      due_date: '19/03/3939',
+      subtotal: '175',
+      tax: '5',
+      tax2: '10',
+      tax3: '20',
+      total: '$ 200',
+      bank_account_number: '156546546465',
+      account_iban: 'IBAN464545645',
+      account_swift: 'SWIFT5456',
+      items: [
+        InvoicePrinter::Document::Item.new(
+          default_document_item_params
+        )
+      ]
+    }
+  end
+
+  def default_document_item_params
+    {
+      name: 'Web consultation',
+      quantity: '2',
+      unit: 'hours',
+      price: '$ 25',
+      tax: '$ 1',
+      amount: '$ 100'
+    }
+  end
+end

metadata

@@ -0,0 +1,129 @@
+--- !ruby/object:Gem::Specification
+name: invoice_printer
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- Josef Strzibny
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2016-04-10 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: prawn
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: prawn-table
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.7'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.7'
+- !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'
+description: Super simple PDF invoicing in pure Ruby (based on Prawn library).
+email:
+- strzibny@strzibny.name
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- examples/czech_invoice.pdf
+- examples/czech_invoice.rb
+- examples/example.jpg
+- invoice_printer.gemspec
+- lib/invoice_printer.rb
+- lib/invoice_printer/document.rb
+- lib/invoice_printer/document/item.rb
+- lib/invoice_printer/pdf_document.rb
+- lib/invoice_printer/version.rb
+- test/dates_box_test.rb
+- test/invoice_printer_test.rb
+- test/items_table_test.rb
+- test/labels_test.rb
+- test/payment_box_test.rb
+- test/test_ext.rb
+- test/test_helper.rb
+homepage: https://github.com/strzibny/invoice_printer
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.4.8
+signing_key: 
+specification_version: 4
+summary: Super simple PDF invoicing in pure Ruby
+test_files:
+- test/dates_box_test.rb
+- test/invoice_printer_test.rb
+- test/items_table_test.rb
+- test/labels_test.rb
+- test/payment_box_test.rb
+- test/test_ext.rb
+- test/test_helper.rb
+has_rdoc: