invoice_printer 1.3.0 → 2.0.0.alpha1

data/examples/simple_invoice.rb

@@ -16,11 +16,15 @@ item = InvoicePrinter::Document::Item.new(
 invoice = InvoicePrinter::Document.new(
   number: 'NO. 198900000001',
   provider_name: 'John White',
+  # Deprecated 1.3 API, use provider_lines
+  # Here for compatibility test
   provider_street: '5th Avenue',
   provider_street_number: '1',
   provider_postcode: '747 05',
   provider_city: 'NYC',
   purchaser_name: 'Will Black',
+  # Deprecated 1.3 API, use purchaser_lines
+  # Here for compatibility test
   purchaser_street: '7th Avenue',
   purchaser_street_number: '1',
   purchaser_postcode: '747 70',

data/invoice_printer.gemspec

@@ -2,6 +2,11 @@ lib = File.expand_path('../lib', __FILE__)
 $LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
 require 'invoice_printer/version'
 
+SERVER_FILES = [
+  'bin/invoice_printer_server',
+  'lib/invoice_printer/server.rb'
+]
+
 Gem::Specification.new do |spec|
   spec.name          = 'invoice_printer'
   spec.version       = InvoicePrinter::VERSION
@@ -12,8 +17,10 @@ Gem::Specification.new do |spec|
   spec.homepage      = 'https://github.com/strzibny/invoice_printer'
   spec.license       = 'MIT'
 
+  # Remove server files
   # Remove .pdf files as they take a lot of space
   package_files = `git ls-files -z`.split("\x0")
+                    .reject{ |file| SERVER_FILES.include?(file) }
                     .reject{ |file| file.match /.*\.pdf/ }
 
   spec.files         = package_files
@@ -23,11 +30,9 @@ Gem::Specification.new do |spec|
   spec.bindir        = 'bin'
 
   spec.add_dependency 'json', '~> 2.1'
-  spec.add_dependency 'roda', '3.5.0'
-  spec.add_dependency 'puma', '~> 3.9'
-  spec.add_dependency 'prawn', '2.1.0'
-  spec.add_dependency 'prawn-layout', '0.8.4'
+  spec.add_dependency 'prawn', '~> 2.1.0'
+  spec.add_dependency 'prawn-layout', '~> 0.8.4'
 
-  spec.add_development_dependency 'bundler', '~> 1.7'
-  spec.add_development_dependency 'rake', '~> 10.0'
+  spec.add_development_dependency 'bundler', '>= 1.7'
+  spec.add_development_dependency 'rake', '>= 10.0'
 end

data/invoice_printer_server.gemspec

@@ -0,0 +1,35 @@
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'invoice_printer/version'
+
+SERVER_FILES = [
+  'bin/invoice_printer_server',
+  'lib/invoice_printer/server.rb',
+  'lib/invoice_printer/version.rb'
+]
+
+Gem::Specification.new do |spec|
+  spec.name          = 'invoice_printer_server'
+  spec.version       = InvoicePrinter::VERSION
+  spec.authors       = ['Josef Strzibny']
+  spec.email         = ['strzibny@strzibny.name']
+  spec.summary       = 'Super simple PDF invoicing in pure Ruby'
+  spec.description   = 'Super simple and fast PDF invoicing in pure Ruby (based on Prawn library).'
+  spec.homepage      = 'https://github.com/strzibny/invoice_printer'
+  spec.license       = 'MIT'
+
+  # Include only server files
+  spec.files         = SERVER_FILES
+  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.bindir        = 'bin'
+
+  spec.add_dependency 'invoice_printer', InvoicePrinter::VERSION
+  spec.add_dependency 'json', '~> 2.1'
+  spec.add_dependency 'roda', '~> 3.5'
+  spec.add_dependency 'puma', '>= 3.9.0'
+
+  spec.add_development_dependency 'bundler', '>= 1.7'
+  spec.add_development_dependency 'rake', '>= 10.0'
+end

data/lib/invoice_printer/document.rb

@@ -8,21 +8,11 @@ module InvoicePrinter
   #     provider_name: 'Business s.r.o.',
   #     provider_tax_id: '56565656',
   #     provider_tax_id2: '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',
+  #     provider_lines: "Rolnicka 1\n747 05 Opava",
   #     purchaser_name: 'Adam',
   #     purchaser_tax_id: '',
   #     purchaser_tax_id2: '',
-  #     purchaser_street: 'Ostravska',
-  #     purchaser_street_number: '1',
-  #     purchaser_postcode: '747 70',
-  #     purchaser_city: 'Opava',
-  #     purchaser_city_part: '',
-  #     purchaser_extra_address_line: '',
+  #     purchaser_lines: "Ostravska 2\n747 05 Opava",
   #     issue_date: '19/03/3939',
   #     due_date: '19/03/3939',
   #     subtotal: '$ 150',
@@ -48,6 +38,7 @@ module InvoicePrinter
                 :provider_name,
                 :provider_tax_id,
                 :provider_tax_id2,
+                :provider_lines,
                 # Provider address fields
                 :provider_street,
                 :provider_street_number,
@@ -59,6 +50,7 @@ module InvoicePrinter
                 :purchaser_name,
                 :purchaser_tax_id,
                 :purchaser_tax_id2,
+                :purchaser_lines,
                 # Purchaser address fields
                 :purchaser_street,
                 :purchaser_street_number,
@@ -94,6 +86,7 @@ module InvoicePrinter
           provider_city:                json['provider_city'],
           provider_city_part:           json['provider_city_part'],
           provider_extra_address_line:  json['provider_extra_address_line'],
+          provider_lines:               json['provider_lines'],
           purchaser_name:               json['purchaser_name'],
           purchaser_tax_id:             json['purchaser_tax_id'],
           purchaser_tax_id2:            json['purchaser_tax_id2'],
@@ -103,6 +96,7 @@ module InvoicePrinter
           purchaser_city:               json['purchaser_city'],
           purchaser_city_part:          json['purchaser_city_part'],
           purchaser_extra_address_line: json['purchaser_extra_address_line'],
+          purchaser_lines:              json['purchaser_lines'],
           issue_date:                   json['issue_date'],
           due_date:                     json['due_date'],
           subtotal:                     json['subtotal'],
@@ -130,6 +124,7 @@ module InvoicePrinter
                    provider_city:                nil,
                    provider_city_part:           nil,
                    provider_extra_address_line:  nil,
+                   provider_lines:               nil,
                    purchaser_name:               nil,
                    purchaser_tax_id:             nil,
                    purchaser_tax_id2:            nil,
@@ -139,6 +134,7 @@ module InvoicePrinter
                    purchaser_city:               nil,
                    purchaser_city_part:          nil,
                    purchaser_extra_address_line: nil,
+                   purchaser_lines:              nil,
                    issue_date:                   nil,
                    due_date:                     nil,
                    subtotal:                     nil,
@@ -162,6 +158,7 @@ module InvoicePrinter
       @provider_city                = String(provider_city)
       @provider_city_part           = String(provider_city_part)
       @provider_extra_address_line  = String(provider_extra_address_line)
+      @provider_lines               = String(provider_lines)
       @purchaser_name               = String(purchaser_name)
       @purchaser_tax_id             = String(purchaser_tax_id)
       @purchaser_tax_id2            = String(purchaser_tax_id2)
@@ -171,6 +168,7 @@ module InvoicePrinter
       @purchaser_city               = String(purchaser_city)
       @purchaser_city_part          = String(purchaser_city_part)
       @purchaser_extra_address_line = String(purchaser_extra_address_line)
+      @purchaser_lines              = String(purchaser_lines)
       @issue_date                   = String(issue_date)
       @due_date                     = String(due_date)
       @subtotal                     = String(subtotal)
@@ -184,6 +182,8 @@ module InvoicePrinter
       @items                        = items
       @note                         = String(note)
 
+
+
       raise InvalidInput, 'items are not only a type of InvoicePrinter::Document::Item' \
         unless @items.select{ |i| !i.is_a?(InvoicePrinter::Document::Item) }.empty?
     end
@@ -200,6 +200,7 @@ module InvoicePrinter
         'provider_city':                @provider_city,
         'provider_city_part':           @provider_city_part,
         'provider_extra_address_line':  @provider_extra_address_line,
+        'provider_lines':               @provider_lines,
         'purchaser_name':               @purchaser_name,
         'purchaser_tax_id':             @purchaser_tax_id,
         'purchaser_tax_id2':            @purchaser_tax_id2,
@@ -209,6 +210,7 @@ module InvoicePrinter
         'purchaser_city':               @purchaser_city,
         'purchaser_city_part':          @purchaser_city_part,
         'purchaser_extra_address_line': @purchaser_extra_address_line,
+        'purchaser_lines':              @purchaser_lines,
         'issue_date':                   @issue_date,
         'due_date':                     @due_date,
         'subtotal':                     @subtotal,

data/lib/invoice_printer/pdf_document.rb

@@ -101,6 +101,36 @@ module InvoicePrinter
         end
       end
 
+      # Version 2.1 deprecation warnings
+      warnings = [
+        @document.provider_street,
+        @document.provider_street_number,
+        @document.provider_postcode,
+        @document.provider_city,
+        @document.provider_city_part,
+        @document.provider_extra_address_line,
+        @document.purchaser_street,
+        @document.purchaser_street_number,
+        @document.purchaser_postcode,
+        @document.purchaser_city,
+        @document.purchaser_city_part,
+        @document.purchaser_extra_address_line
+      ].delete_if(&:empty?)
+
+      unless warnings.empty?
+        warning = <<~WARN
+          WARNING: Following values are used in deprecated fields and
+          won't be rendered in future versions of InvoicePrinter:
+
+          #{warnings.join(", ")}
+
+          Use new provider_lines and purchaser_lines fields instead of
+          the old address fields.
+        WARN
+
+        $stderr.puts warning
+      end
+
       build_pdf
     end
 
@@ -189,7 +219,7 @@ module InvoicePrinter
     # Build the following provider box:
     #
     #    ------------------------------------------
-    #   | Provider        Optinal provider sublabel|
+    #   | Provider       Optional provider sublabel|
     #   | PROVIDER co.                             |
     #   | 5th Street                               |
     #   | 747 27    City                           |
@@ -221,39 +251,55 @@ module InvoicePrinter
           align: :right
         )
       end
-      @pdf.text_box(
-        "#{@document.provider_street}    #{@document.provider_street_number}",
-        size: 10,
-        at: [10, y(620) - @push_down],
-        width: x(240)
-      )
-      @pdf.text_box(
-        @document.provider_postcode,
-        size: 10,
-        at: [10, y(605) - @push_down],
-        width: x(240)
-      )
-      @pdf.text_box(
-        @document.provider_city,
-        size: 10,
-        at: [60, y(605) - @push_down],
-        width: x(240)
-      )
-      unless @document.provider_city_part.empty?
+      # Render provider_lines if present
+      if !@document.provider_lines.empty?
+        lines = @document.provider_lines.split("\n")
+        line_y = 618
+        lines.each_with_index do |line, index|
+          next if index > 3
+
+          @pdf.text_box(
+            "#{line}",
+            size: 10,
+            at: [10, y(line_y - index*15) - @push_down],
+            width: x(240)
+          )
+        end
+      else
         @pdf.text_box(
-          @document.provider_city_part,
+          "#{@document.provider_street}    #{@document.provider_street_number}",
           size: 10,
-          at: [60, y(590) - @push_down],
+          at: [10, y(620) - @push_down],
           width: x(240)
         )
-      end
-      unless @document.provider_extra_address_line.empty?
         @pdf.text_box(
-          @document.provider_extra_address_line,
+          @document.provider_postcode,
           size: 10,
-          at: [10, y(575) - @push_down],
+          at: [10, y(605) - @push_down],
           width: x(240)
         )
+        @pdf.text_box(
+          @document.provider_city,
+          size: 10,
+          at: [60, y(605) - @push_down],
+          width: x(240)
+        )
+        unless @document.provider_city_part.empty?
+          @pdf.text_box(
+            @document.provider_city_part,
+            size: 10,
+            at: [60, y(590) - @push_down],
+            width: x(240)
+          )
+        end
+        unless @document.provider_extra_address_line.empty?
+          @pdf.text_box(
+            @document.provider_extra_address_line,
+            size: 10,
+            at: [10, y(575) - @push_down],
+            width: x(240)
+          )
+        end
       end
       unless @document.provider_tax_id.empty?
         @pdf.text_box(
@@ -310,39 +356,55 @@ module InvoicePrinter
           align: :right
         )
       end
-      @pdf.text_box(
-        "#{@document.purchaser_street}    #{@document.purchaser_street_number}",
-        size: 10,
-        at: [x(284), y(620) - @push_down],
-        width: x(240)
-      )
-      @pdf.text_box(
-        @document.purchaser_postcode,
-        size: 10,
-        at: [x(284), y(605) - @push_down],
-        width: x(240)
-      )
-      @pdf.text_box(
-        @document.purchaser_city,
-        size: 10,
-        at: [x(334), y(605) - @push_down],
-        width: x(240)
-      )
-      unless @document.purchaser_city_part.empty?
+      # Render purchaser_lines if present
+      if !@document.purchaser_lines.empty?
+        lines = @document.purchaser_lines.split("\n")
+        line_y = 618
+        lines.each_with_index do |line, index|
+          next if index > 3
+
+          @pdf.text_box(
+            "#{line}",
+            size: 10,
+            at: [x(284), y(line_y - index*15) - @push_down],
+            width: x(240)
+          )
+        end
+      else
         @pdf.text_box(
-          @document.purchaser_city_part,
+          "#{@document.purchaser_street}    #{@document.purchaser_street_number}",
           size: 10,
-          at: [x(334), y(590) - @push_down],
+          at: [x(284), y(620) - @push_down],
           width: x(240)
         )
-      end
-      unless @document.purchaser_extra_address_line.empty?
         @pdf.text_box(
-          @document.purchaser_extra_address_line,
+          @document.purchaser_postcode,
           size: 10,
-          at: [x(284), y(575) - @push_down],
+          at: [x(284), y(605) - @push_down],
           width: x(240)
         )
+        @pdf.text_box(
+          @document.purchaser_city,
+          size: 10,
+          at: [x(334), y(605) - @push_down],
+          width: x(240)
+        )
+        unless @document.purchaser_city_part.empty?
+          @pdf.text_box(
+            @document.purchaser_city_part,
+            size: 10,
+            at: [x(334), y(590) - @push_down],
+            width: x(240)
+          )
+        end
+        unless @document.purchaser_extra_address_line.empty?
+          @pdf.text_box(
+            @document.purchaser_extra_address_line,
+            size: 10,
+            at: [x(284), y(575) - @push_down],
+            width: x(240)
+          )
+        end
       end
       unless @document.purchaser_tax_id.empty?
         @pdf.text_box(

data/lib/invoice_printer/version.rb

@@ -1,3 +1,3 @@
 module InvoicePrinter
-  VERSION = '1.3.0'
+  VERSION = '2.0.0.alpha1'
 end

data/test/cli_test.rb

@@ -5,9 +5,12 @@ class CLITest < Minitest::Test
   include InvoicePrinterHelpers
 
   def setup
+    t = Time.now.strftime("%Y%m%d")
+    tmpname = "/tmp/invoice-#{t}-#{$$}-#{rand(0x100000000).to_s(36)}-fd"
+
     @invoice         = InvoicePrinter::Document.new(default_document_params)
     @invoice_as_json = @invoice.to_json
-    @output_path     = Dir::Tmpname.make_tmpname('/tmp/invoice', nil)
+    @output_path     = tmpname
   end
 
   def teardown

data/test/test_ext.rb

@@ -25,11 +25,9 @@ module InvoicePrinter
       strings = []
       strings << @document.provider_name
       strings << @labels[:provider]
-      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
+      @document.provider_lines.split("\n").each do |line|
+        strings << line
+      end
       strings << "#{@labels[:tax_id]}:    #{@document.provider_tax_id}" \
         unless @document.provider_tax_id.empty?
       strings << "#{@labels[:tax_id2]}:    #{@document.provider_tax_id2}" \
@@ -42,11 +40,9 @@ module InvoicePrinter
       strings = []
       strings << @document.purchaser_name
       strings << @labels[:purchaser]
-      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
+      @document.purchaser_lines.split("\n").each do |line|
+        strings << line
+      end
       strings << "#{@labels[:tax_id]}:    #{@document.purchaser_tax_id}" \
         unless @document.purchaser_tax_id.empty?
       strings << "#{@labels[:tax_id2]}:    #{@document.purchaser_tax_id2}" \