clinvoice 1.0.0 → 1.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 91cafc96e465f58bae419d2fa0c98afd7deb9c87fefbd1fd012503f95da54a3e
-  data.tar.gz: 3896731fa5455499b5a244f255a4783cb1a9188d9598712cae1b2af830d7bbde
+  metadata.gz: 1b15d22bdc4eac1154f8ff91961d2ad3675f3046b17792a418310b02242478a5
+  data.tar.gz: 0ec6a774d8e43916edf4d408aef4ac883195dd232262016f7fbe939721c2c70a
 SHA512:
-  metadata.gz: a2b92a43c80a24486f82e75e447090319af551ba96bd2bcf48b6d33c9ffcdd326b3e91f3ae645ef91e20d5e24ea94beb278c239de36fa5538631e4b752a645d0
-  data.tar.gz: d146ee8a6259498a254dd30212f2c7d625346deb5998d443b5e10f409e4d22960d2a02a842b12226050e0cfda63988c5063baae2400347315debc207fb7260f4
+  metadata.gz: 9828213ba2f5e4fa094bdbcb538811f8bd592a0f3f014a67142889630e591b2da66be54d9b4d1567a053635fa0d494255ff9e98d520f1faea1ae2bc235c6e969
+  data.tar.gz: 9048ed41925013e8ee3326dd77daa039c79e2fd8c4155e98fb0b31c7330e23170039fe1717cf89bf65db0c72984ad5690b054e43f4e047f4d4921481ab2d1504

data/Gemfile.lock

@@ -0,0 +1,29 @@
+PATH
+  remote: .
+  specs:
+    clinvoice (1.0.0)
+      prawn (~> 2.2)
+      prawn-table (~> 0.2.2)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    pdf-core (0.7.0)
+    prawn (2.2.2)
+      pdf-core (~> 0.7.0)
+      ttfunk (~> 1.5)
+    prawn-table (0.2.2)
+      prawn (>= 1.3.0, < 3.0.0)
+    rake (10.5.0)
+    ttfunk (1.5.1)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  bundler (~> 1.16)
+  clinvoice!
+  rake (~> 10.0)
+
+BUNDLED WITH
+   1.16.4

data/README.md

@@ -32,6 +32,32 @@ Or install it yourself as:
 
 This will create a `doge-client-1.yml` data file.
 
+```yaml
+data:
+  id: 1
+  currency: "USD"
+  contractor:
+    name: "You"
+    address:
+      line1: "123, Street, 451233"
+      line2: "City, State, Country"
+  client:
+    name: "Your Client"
+    address:
+      line1: "123, Street, 451233"
+      line2: "City, State, Country"
+  items:
+    -
+      description: "Example service 1"
+      quantity: 1
+      unit_cost: 1.00
+    -
+      description: "Example service 2"
+      quantity: 1
+      unit_cost: 2.00
+  notes: "footer notes optional"
+```
+
 2 - Edit the data file:
 
     $ vim doge-client-1.yml

data/lib/clinvoice/data.rb

@@ -4,15 +4,22 @@ require 'yaml'
 
 module Clinvoice
   class Data
-    attr_reader :invoice_id, :contractor, :client, :items, :notes, :total, :file
+    attr_reader :invoice_id,
+                :currency,
+                :contractor,
+                :client,
+                :items,
+                :notes,
+                :total,
+                :file
 
     def initialize(file)
-      @file = file
-
       data = YAML.load_file("#{file}.yml")['data']
 
+      @file = file
       @invoice_id = data['id']
       @currency = data['currency']
+      @issue_date = data['issue_date']
       @contractor = data['contractor']
       @client = data['client']
       @items = data['items'].map do |item|

data/lib/clinvoice/generate_pdf.rb

@@ -4,8 +4,9 @@ require 'prawn'
 require 'prawn/table'
 require 'clinvoice/data'
 require 'clinvoice/helper'
-require 'clinvoice/render_items'
+require 'clinvoice/render_basic_info'
 require 'clinvoice/render_name_and_address'
+require 'clinvoice/render_items'
 require 'clinvoice/render_notes'
 require 'clinvoice/render_title'
 require 'clinvoice/render_total'
@@ -24,6 +25,7 @@ module Clinvoice
 
         pdf.font_size 9
 
+        Clinvoice::RenderBasicInfo.call(pdf, data)
         Clinvoice::RenderNameAndAddress.call(pdf, 'From', data.contractor)
         Clinvoice::RenderNameAndAddress.call(pdf, 'To', data.client)
         Clinvoice::RenderItems.call(pdf, data.items)

data/lib/clinvoice/helper.rb

@@ -5,5 +5,17 @@ module Clinvoice
     def self.format_currency(number)
       format('$%.2f', number.to_f)
     end
+
+    def self.new_line(pdf, text)
+      pdf.text_box text.to_s, at: [8, pdf.cursor]
+      pdf.move_down 12
+    end
+
+    def self.new_bold_line(pdf, text)
+      pdf.font 'Helvetica', style: :bold
+      pdf.text_box text.to_s, at: [8,  pdf.cursor]
+      pdf.font 'Helvetica', style: :normal
+      pdf.move_down 12
+    end
   end
 end

data/lib/clinvoice/render_basic_info.rb

@@ -0,0 +1,17 @@
+# frozen_string_literal: true
+
+module Clinvoice
+  module RenderBasicInfo
+    def self.call(pdf, data)
+      Clinvoice::Helper.new_bold_line(pdf, "Invoice ID")
+      Clinvoice::Helper.new_line(pdf, data.invoice_id)
+
+      pdf.move_down 10
+
+      Clinvoice::Helper.new_bold_line(pdf, "Currency")
+      Clinvoice::Helper.new_line(pdf, data.currency)
+
+      pdf.move_down 10
+    end
+  end
+end

data/lib/clinvoice/render_items.rb

@@ -2,24 +2,10 @@
 
 module Clinvoice
   module RenderItems
-    def self.call(pdf, items)
+    def self.call(pdf, data_items)
       pdf.move_down 20
 
-      header = ['Description', 'Unit Cost', 'Quantity', 'Line Total']
-      blank_line = [' ', ' ', ' ', ' ']
-
-      formatted_items = items.map do |item|
-        [
-          item[0],
-          Clinvoice::Helper.format_currency(item[1]),
-          item[2],
-          Clinvoice::Helper.format_currency(item[3])
-        ]
-      end
-
-      rows = [header] + formatted_items + [blank_line]
-
-      pdf.table(rows, width: pdf.bounds.width) do
+      pdf.table(items(data_items), width: pdf.bounds.width) do
         style(row(1..-1).columns(0..-1), padding: [4, 5, 4, 5], borders: [:bottom], border_color: 'dddddd')
         style(row(0), background_color: 'e9e9e9', border_color: 'dddddd', font_style: :bold)
         style(row(0).columns(0..-1), borders: %i[top bottom])
@@ -32,5 +18,25 @@ module Clinvoice
 
       pdf.move_down 10
     end
+
+    private
+
+    def self.items(data_items)
+      header = ['Description', 'Unit Cost', 'Quantity', 'Line Total']
+      blank_line = [' ', ' ', ' ', ' ']
+
+      [header] + formatted_items(data_items) + [blank_line]
+    end
+
+    def self.formatted_items(items)
+      items.map do |item|
+        [
+          item[0],
+          Clinvoice::Helper.format_currency(item[1]),
+          item[2],
+          Clinvoice::Helper.format_currency(item[3])
+        ]
+      end
+    end
   end
 end

data/lib/clinvoice/render_name_and_address.rb

@@ -3,18 +3,12 @@
 module Clinvoice
   module RenderNameAndAddress
     def self.call(pdf, label, entity)
-      pdf.font 'Helvetica', style: :bold
-      pdf.text_box label, at: [8,  pdf.cursor]
-      pdf.font 'Helvetica', style: :normal
+      Clinvoice::Helper.new_bold_line(pdf, label)
+      Clinvoice::Helper.new_line(pdf, entity['name'])
 
-      pdf.move_down 12
-      pdf.text_box entity['name'], at: [8, pdf.cursor]
-      pdf.move_down 12
       if entity['address']
-        pdf.text_box entity['address']['line1'], at: [8, pdf.cursor]
-        pdf.move_down 12
-        pdf.text_box entity['address']['line2'], at: [8, pdf.cursor]
-        pdf.move_down 12
+        Clinvoice::Helper.new_line(pdf, entity['address']['line1'])
+        Clinvoice::Helper.new_line(pdf, entity['address']['line2'])
       end
 
       pdf.move_down 10

data/lib/clinvoice/render_notes.rb

@@ -5,10 +5,16 @@ module Clinvoice
     def self.call(pdf, notes)
       return unless notes
 
-      pdf.table([['Notes'], [notes]], width: 275) do
-        style(row(0..-1).columns(0..-1), padding: [1, 0, 1, 0], borders: [])
+      pdf.table(items(notes), width: 275) do
         style(row(0).columns(0), font_style: :bold)
+        style(row(0..-1).columns(0..-1), padding: [1, 0, 1, 0], borders: [])
       end
     end
+
+    private
+
+    def self.items(notes)
+      [['Notes'], [notes]]
+    end
   end
 end

data/lib/clinvoice/render_total.rb

@@ -3,18 +3,20 @@
 module Clinvoice
   module RenderTotal
     def self.call(pdf, total)
-      invoice_services_totals_data = [
-        ['Total', Clinvoice::Helper.format_currency(total)]
-      ]
-
-      pdf.table(invoice_services_totals_data, position: 425, width: 115) do
+      pdf.table(items(total), position: 425, width: 115) do
         style(row(0), font_style: :bold)
         style(row(0), background_color: 'e9e9e9', border_color: 'dddddd', font_style: :bold)
-        style(row(0..1).columns(0..1), padding: [3, 5, 3, 5], borders: [])
         style(column(1), align: :right)
+        style(row(0..1).columns(0..1), padding: [3, 5, 3, 5], borders: [])
       end
 
       pdf.move_down 25
     end
+
+    private
+
+    def self.items(total)
+      [['Total', Clinvoice::Helper.format_currency(total)]]
+    end
   end
 end

data/lib/clinvoice/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module Clinvoice
-  VERSION = '1.0.0'
+  VERSION = '1.1.0'
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: clinvoice
 version: !ruby/object:Gem::Version
-  version: 1.0.0
+  version: 1.1.0
 platform: ruby
 authors:
 - Andrew S Aguiar
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2019-02-18 00:00:00.000000000 Z
+date: 2019-02-20 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -71,7 +71,6 @@ email:
 - andrewaguiar6@gmail.com
 executables:
 - clinvoice
-- console
 - setup
 extensions: []
 extra_rdoc_files: []
@@ -81,11 +80,11 @@ files:
 - ".travis.yml"
 - CODE_OF_CONDUCT.md
 - Gemfile
+- Gemfile.lock
 - LICENSE.txt
 - README.md
 - Rakefile
 - bin/clinvoice
-- bin/console
 - bin/setup
 - clinvoice.gemspec
 - lib/clinvoice.rb
@@ -94,6 +93,7 @@ files:
 - lib/clinvoice/generate_pdf.rb
 - lib/clinvoice/helper.rb
 - lib/clinvoice/initialize_template.rb
+- lib/clinvoice/render_basic_info.rb
 - lib/clinvoice/render_items.rb
 - lib/clinvoice/render_name_and_address.rb
 - lib/clinvoice/render_notes.rb

data/bin/console

@@ -1,15 +0,0 @@
-#!/usr/bin/env ruby
-# frozen_string_literal: true
-
-require 'bundler/setup'
-require 'clinvoice'
-
-# You can add fixtures and/or initialization code here to make experimenting
-# with your gem easier. You can also use a different console, if you like.
-
-# (If you use this, don't forget to add pry to your Gemfile!)
-# require "pry"
-# Pry.start
-
-require 'irb'
-IRB.start(__FILE__)