invoice_printer 2.3.0 → 2.4.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 2f98cb9145f19c42e95490c56afbb156408c5049c766d9ddcb1c776ee112c5fe
-  data.tar.gz: 77c6280ab4566b41ad6b040113f3ccf99b0c4bf5e2bccce28c3d0740644a1e57
+  metadata.gz: 0b35b038445eb5790a3241093f031314db880f037dbabd1800cff2a5548081ea
+  data.tar.gz: bd668a85987b9c72793724ce3a6d13d37478f7a747ae0d1e75f1b8a013809b6c
 SHA512:
-  metadata.gz: c1be305d2988483f0912598cbcd523b3f8f020667f61cb253e7b5c3f455ed188efebcec20fe4d1f77148ce984c9866c723c3e645a9e4515b50a67aceb85d45a5
-  data.tar.gz: f4764ce73b9c8f696cdd8bfa975ab1f3cbd8d85bb62a3b335a321eb7fb860b08a03835cc875c3dd774b670af3baeffc48f590e53d0c763ccece20e9e22b74657
+  metadata.gz: 1e16688d404cc7097f773babe821c62ddf6d06b87e23a80b1454e87bc6299549521b2e3a9bed556d8e35370a1c78843f6eca192618d4dd66da9e143b17ab60b4
+  data.tar.gz: 81f49267c2b967d6b3ac9596d06e330e112bbfb5b8ac51fa200f958e41c1a3a9fe6ad7624df08e069d2f697d625acf3484ca461a7523e32361122e06d23b3a85

data/.github/workflows/ci.yml

@@ -0,0 +1,37 @@
+---
+name: CI
+
+on:
+  - pull_request
+  - push
+
+env:
+  TESTOPT: "-v"
+
+concurrency:
+  group: ${{ github.ref_name }}
+  cancel-in-progress: true
+
+jobs:
+  test:
+    name: Ruby
+    runs-on: ubuntu-latest
+    strategy:
+      fail-fast: false
+      matrix:
+        ruby:
+          - "3.1"
+          - "3.2"
+          # - "ruby-head"
+    steps:
+      - name: Install system dependencies
+        run: sudo apt-get install imagemagick libmagickwand-dev
+      - name: Check out code
+        uses: actions/checkout@v4
+      - name: Install Ruby dependencies
+        uses: ruby/setup-ruby@v1
+        with:
+          ruby-version: ${{ matrix.ruby }}
+          bundler-cache: true
+      - name: Run tests
+        run: bundle exec rake test

data/Dockerfile

@@ -26,10 +26,10 @@ RUN apk update && apk upgrade
 RUN apk add build-base bash ruby ruby-etc ruby-dev
 
 # Install builtin fonts
-RUN gem install invoice_printer_fonts --version 2.3.0 --no-document
+RUN gem install invoice_printer_fonts --version 2.4.0 --no-document
 
 # Install the gem from RubyGems.org
-RUN gem install invoice_printer_server --version 2.3.0 --no-document
+RUN gem install invoice_printer_server --version 2.4.0 --no-document
 
 # Clean APK cache
 RUN rm -rf /var/cache/apk/*

data/README.md

@@ -26,6 +26,7 @@ See more usecases in the `examples/` directory.
 - Payment method box showing banking details including SWIFT and IBAN fields
 - Issue/due dates box
 - Configurable items' table with item description, breakdown, quantity, unit, price per unit, tax and item's total amount fields
+- Description above the table
 - Final subtotal/tax/total info box
 - Page numbers
 - Configurable field labels & sublabels (optional little labels)
@@ -50,8 +51,22 @@ See more usecases in the `examples/` directory.
 
 I am developing InvoicePrinter as a free and MIT-licensed library for several years now.
 
-I would appreciate if you consider [buying my book](https://deploymentfromscratch.com/).
+Please consider [buying my book](https://deploymentfromscratch.com/) or [my Rails starter kit](https://businessclasskit.com/) so I can work more on Open Source.
+
+## Contributing
+
+Contributions are welcome. Make sure the tests are passing before submitting a PR:
+
+```bash
+$ bundle && bundle exec rake test
+```
+
+You can also quickly regenerate the examples if necessary:
+
+```bash
+$ ruby regenerate.rb
+```
 
 ## Copyright
 
-Copyright 2015-2021 © [Josef Strzibny](http://strzibny.name/). MIT licensed.
+Copyright 2015-2024 © [Josef Strzibny](http://strzibny.name/). MIT licensed.

data/invoice_printer.gemspec

@@ -33,8 +33,8 @@ Gem::Specification.new do |spec|
   package_files = `git ls-files -z`.split("\x0")
                     .reject{ |file| ONLY_SERVER_FILES.include?(file) }
                     .reject{ |file| ONLY_FONTS_FILES.include?(file) }
-                    .reject{ |file| file.match /.*\.png/ }
-                    .reject{ |file| file.match /.*\.pdf/ }
+                    .reject{ |file| file.match(/.*\.png/) }
+                    .reject{ |file| file.match(/.*\.pdf/) }
 
   spec.files         = package_files
   spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
@@ -42,7 +42,7 @@ Gem::Specification.new do |spec|
   spec.require_paths = ['lib']
   spec.bindir        = 'bin'
 
-  spec.required_ruby_version = '>= 2.4'
+  spec.required_ruby_version = '>= 3.1'
 
   spec.add_dependency 'json', '~> 2.1'
   spec.add_dependency 'prawn', '~> 2.4'

data/lib/invoice_printer/pdf_document.rb

@@ -297,8 +297,10 @@ module InvoicePrinter
     #    ------------------------------------------
     #
     def build_purchaser_box
+      purchaser = [@document.purchaser_name, @document.purchaser_lines].join("\n")
+
       @pdf.text_box(
-        @document.purchaser_name,
+        purchaser.lines.first,
         size: 15,
         at: [x(284), y(640) - @push_down],
         width: x(240)
@@ -320,9 +322,9 @@ module InvoicePrinter
         )
       end
       # Render purchaser_lines if present
-      if !@document.purchaser_lines.empty?
+      if purchaser.lines.size > 1
         @pdf.text_box(
-          @document.purchaser_lines,
+          purchaser.lines(chomp: true)[1..].join("\n"),
           size: 10,
           at: [x(284), y(618) - @push_down],
           width: x(246),
@@ -655,7 +657,7 @@ module InvoicePrinter
       end
     end
 
-     def description_height
+    def description_height
       @description_height ||= begin
         num_of_lines = @document.description.lines.count
         (num_of_lines * 13)
@@ -692,7 +694,6 @@ module InvoicePrinter
 
       options = {
         header: true,
-        row_colors: [nil, 'ededed'],
         width: x(540, 2),
         cell_style: {
           borders: []
@@ -731,10 +732,13 @@ module InvoicePrinter
 
     # Include only items params with provided data
     def build_items_data(items_params)
-      @document.items.map do |item|
+      colspan = items_params.select { |k, v| v }.count
+      color_background = false
+
+      items = []
+      @document.items.each do |item|
         line = []
-        line << { content: name_cell(item), borders: [:bottom] } if items_params[:names]
-        #line << { content: item.name, borders: [:bottom], align: :left } if items_params[:names]
+        line << { content: item.name, align: :left } if items_params[:names]
         line << { content: item.variable, align: :right } if items_params[:variables]
         line << { content: item.quantity, align: :right } if items_params[:quantities]
         line << { content: item.unit, align: :right } if items_params[:units]
@@ -743,29 +747,19 @@ module InvoicePrinter
         line << { content: item.tax2, align: :right } if items_params[:taxes2]
         line << { content: item.tax3, align: :right } if items_params[:taxes3]
         line << { content: item.amount, align: :right } if items_params[:amounts]
-        line
-      end
-    end
 
-    # Display item's name and breakdown if present
-    def name_cell(item)
-      data = if used?(item.breakdown)
-        data = [
-          [{ content: item.name, padding: [5, 0, 0, 5] }],
-          [{ content: item.breakdown, size: 8, padding: [2, 0, 5, 5] }]
-        ]
+        line.each {|c| c[:background_color] = 'ededed'} if color_background
 
-        options = {
-          cell_style: {
-            borders: []
-          },
-          position: :left
-        }
+        items << line
 
-        @pdf.make_table(data, options)
-      else
-        item.name
+        if used?(item.breakdown)
+          items << [{ content: item.breakdown, align: :left, size: 8, colspan: colspan, padding: [0, 0, 5, 5] }]
+          items.last.first[:background_color] = 'ededed' if color_background
+        end
+
+        color_background = !color_background
       end
+      items
     end
 
     # Include only relevant headers

data/lib/invoice_printer/version.rb

@@ -1,3 +1,3 @@
 module InvoicePrinter
-  VERSION = '2.3.0'
+  VERSION = '2.4.0'
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: invoice_printer
 version: !ruby/object:Gem::Version
-  version: 2.3.0
+  version: 2.4.0
 platform: ruby
 authors:
 - Josef Strzibny
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2023-02-11 00:00:00.000000000 Z
+date: 2024-10-13 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: json
@@ -116,10 +116,10 @@ executables:
 extensions: []
 extra_rdoc_files: []
 files:
+- ".github/workflows/ci.yml"
 - ".gitignore"
 - Dockerfile
 - Gemfile
-- Gemfile.lock
 - LICENSE.txt
 - README.md
 - Rakefile
@@ -179,14 +179,14 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: '2.4'
+      version: '3.1'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.3.3
+rubygems_version: 3.4.10
 signing_key:
 specification_version: 4
 summary: Super simple PDF invoicing in pure Ruby

data/Gemfile.lock

@@ -1,77 +0,0 @@
-PATH
-  remote: .
-  specs:
-    invoice_printer (2.2.0)
-      e2mmap
-      json (~> 2.1)
-      matrix
-      prawn (~> 2.4)
-      prawn-table (~> 0.2.2)
-    invoice_printer_server (2.2.0)
-      invoice_printer (= 2.2.0)
-      json (~> 2.1)
-      puma (>= 3.9.0)
-      roda (~> 3.5)
-
-GEM
-  remote: https://rubygems.org/
-  specs:
-    Ascii85 (1.1.0)
-    afm (0.2.2)
-    benchmark_driver (0.15.17)
-    benchmark_driver-output-gruff (0.3.1)
-      benchmark_driver (>= 0.12.0)
-      gruff
-    e2mmap (0.1.0)
-    gruff (0.14.0)
-      histogram
-      rmagick
-    hashery (2.1.2)
-    histogram (0.2.4.1)
-    json (2.6.3)
-    matrix (0.1.0)
-    minitest (5.15.0)
-    nio4r (2.5.8)
-    pdf-core (0.9.0)
-    pdf-inspector (1.3.0)
-      pdf-reader (>= 1.0, < 3.0.a)
-    pdf-reader (2.11.0)
-      Ascii85 (~> 1.0)
-      afm (~> 0.2.1)
-      hashery (~> 2.0)
-      ruby-rc4
-      ttfunk
-    pkg-config (1.5.1)
-    prawn (2.4.0)
-      pdf-core (~> 0.9.0)
-      ttfunk (~> 1.7)
-    prawn-table (0.2.2)
-      prawn (>= 1.3.0, < 3.0.0)
-    puma (6.0.2)
-      nio4r (~> 2.0)
-    rack (3.0.4.1)
-    rack-test (2.0.2)
-      rack (>= 1.3)
-    rake (13.0.6)
-    rmagick (5.1.0)
-      pkg-config (~> 1.4)
-    roda (3.64.0)
-      rack
-    ruby-rc4 (0.1.5)
-    ttfunk (1.7.0)
-
-PLATFORMS
-  x86_64-linux
-
-DEPENDENCIES
-  benchmark_driver (= 0.15.17)
-  benchmark_driver-output-gruff
-  bundler (>= 1.7)
-  invoice_printer_server!
-  minitest
-  pdf-inspector
-  rack-test
-  rake (>= 10.0)
-
-BUNDLED WITH
-   2.4.3