polish_invoicer 0.0.34 → 0.0.36

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: a28a6aa9425c98da6aa3779b3c1251438efcd6976f876448d6c2bab5acedf5d1
-  data.tar.gz: b6f4c0ed789da7f1333fad67ebb02a624dc63545db19f314e6e7a209888f67ee
+  metadata.gz: 7841efb19f4004918611cfdf6285d00bea3eabb9b30668ed4c3c66a30beb051b
+  data.tar.gz: a0adea29111258609c515d5a3e7bb4fe918e450fbe0382ea6513663f128ec1da
 SHA512:
-  metadata.gz: 1ef7113d42bb6cf1eb62b5cd6fab2dd5fd08612594618cf5d449fe18b796cc4686771293f8d4d5c9f4dcc667a39553ff4d8969a73e074b8b7cb06e969ec54ecf
-  data.tar.gz: 3a6f869d6ff8618b83c9d2e97bedfab5231ab7aca08bf516a1a5e79882d9098c1dcdd5b811a483984530c5cda92409401d5d7225ad463c320ea13d7cb69163d6
+  metadata.gz: ce0507874aed78cd6ee23153d427133ebd76a9b47fe46a69581730937ffce0b60a219e56e1bebf0df49b31c9310de4e3416cdd4d667e10facb3f2955d3968766
+  data.tar.gz: 7474c626f98a89cdb58e3f25e6dc2bd558ae78127593ef72b891ca684ee8eebbd8e7808961ce315fbf77a8fc5f65049b4d712c0b42bdb180824f15d2848907bf

data/.gitignore

@@ -15,3 +15,6 @@ test/tmp
 test/version_tmp
 tmp
 /.idea
+/bin
+/.env*
+opencode.json

data/.rubocop.yml

@@ -1,4 +1,4 @@
-require:
+plugins:
   - rubocop-minitest
   - rubocop-rake
 

data/.rubocop_todo.yml

@@ -36,7 +36,7 @@ Metrics/AbcSize:
 # Offense count: 4
 # Configuration parameters: CountComments, CountAsOne.
 Metrics/ClassLength:
-  Max: 196
+  Max: 220
 
 # Offense count: 14
 # Configuration parameters: CountComments, CountAsOne, AllowedMethods, AllowedPatterns.

data/.ruby-version

@@ -1 +1 @@
-3.3.10
+3.4.9

data/README.md

@@ -95,6 +95,10 @@ invoice.save_to_pdf('/path/to/invoice.pdf')
                           # wartość domyślna: false
     :reverse_charge       # faktura z odwrotnym obciążeniem VAT (boolean)
                           # wartość domyślna: false
+    :vat_cash_accounting  # faktura z metodą kasową (boolean)
+                          # wartość domyślna: false
+    :prepayment_invoice   # faktura zaliczkowa (boolean)
+                          # wartość domyślna: false
     :currency             # waluta rozliczeniowa (string)
                           # wartość domyślna: PLN                      
     :exchange_rate        # kurs waluty rozliczeniowej (float)

data/doc/invoice.rb

@@ -20,6 +20,7 @@ invoice = PolishInvoicer::Invoice.new(
   gross_price: false,
   # proforma: true,
   # paid: false,
+  # prepayment_invoice: true,
   foreign_buyer: true,
   reverse_charge: true,
   currency: 'EUR',

data/lib/polish_invoicer/invoice.rb

@@ -3,37 +3,39 @@
 module PolishInvoicer
   class Invoice
     AVAILABLE_PARAMS = [
-      :number,            # numer faktury (string)
-      :ksef_number,       # numer faktury w KSeF (string)
-      :ksef_qr_code_url,  # adres URL kodu QR dla faktury w KSeF
-      :create_date,       # data wystawienia faktury (date)
-      :trade_date,        # data sprzedaży (date)
-      :seller,            # adres sprzedawcy (tablica stringów)
-      :seller_nip,        # NIP sprzedawcy (string)
-      :buyer,             # adres nabywcy (tablica stringów)
-      :buyer_nip,         # NIP nabywcy (string)
-      :recipient,         # odbiorca faktury (tablica stringów)
-      :item_name,         # nazwa usługi (string)
-      :price,             # cena w złotych (float)
-      :price_paid,        # kwota częściowego opłacenia faktury w złotych
-      :gross_price,       # znacznik rodzaju ceny (netto/brutto), domyślnie: true (boolean)
-      :vat,               # stawka vat, domyślnie: 23 (integer)
-      :pkwiu,             # numer PKWiU (string)
-      :payment_type,      # rodzaj płatności, domyślnie: 'Przelew' (string)
-      :payment_date,      # termin płatności (date)
-      :comments,          # uwagi (string lub tablica stringów)
-      :paid,              # znacznik opłacenia faktury, domyślnie: true (boolean)
-      :footer,            # treść umieszczana w stopce faktury (string)
-      :proforma,          # znacznik faktury pro-forma, domyślnie: false (boolean)
-      :no_vat_reason,     # podstawa prawna zwolnienia z VAT (string)
-      :foreign_buyer,     # nabywcą jest firma spoza Polski, domyślnie: false (boolean)
-      :lang,              # język na fakturze, domyślnie: zależny od ustawienia foreign_buyer
-                          # foreign_buyer = false => lang = 'pl'
-                          # foreign_buyer = true => lang = 'pl_en'
-                          # możliwe wartości: pl | pl_en | en | es
-      :reverse_charge,    # faktura z odwrotnym obciążeniem VAT
-      :currency,          # waluta rozliczeniowa, domyślnie: PLN (string)
-      :exchange_rate      # kurs waluty rozliczeniowej, domyślnie: 1.0000 (float)
+      :number,              # numer faktury (string)
+      :ksef_number,         # numer faktury w KSeF (string)
+      :ksef_qr_code_url,    # adres URL kodu QR dla faktury w KSeF
+      :create_date,         # data wystawienia faktury (date)
+      :trade_date,          # data sprzedaży (date)
+      :seller,              # adres sprzedawcy (tablica stringów)
+      :seller_nip,          # NIP sprzedawcy (string)
+      :buyer,               # adres nabywcy (tablica stringów)
+      :buyer_nip,           # NIP nabywcy (string)
+      :recipient,           # odbiorca faktury (tablica stringów)
+      :item_name,           # nazwa usługi (string)
+      :price,               # cena w złotych (float)
+      :price_paid,          # kwota częściowego opłacenia faktury w złotych
+      :gross_price,         # znacznik rodzaju ceny (netto/brutto), domyślnie: true (boolean)
+      :vat,                 # stawka vat, domyślnie: 23 (integer)
+      :pkwiu,               # numer PKWiU (string)
+      :payment_type,        # rodzaj płatności, domyślnie: 'Przelew' (string)
+      :payment_date,        # termin płatności (date)
+      :comments,            # uwagi (string lub tablica stringów)
+      :paid,                # znacznik opłacenia faktury, domyślnie: true (boolean)
+      :footer,              # treść umieszczana w stopce faktury (string)
+      :proforma,            # znacznik faktury pro-forma, domyślnie: false (boolean)
+      :no_vat_reason,       # podstawa prawna zwolnienia z VAT (string)
+      :foreign_buyer,       # nabywcą jest firma spoza Polski, domyślnie: false (boolean)
+      :lang,                # język na fakturze, domyślnie: zależny od ustawienia foreign_buyer
+                            # foreign_buyer = false => lang = 'pl'
+                            # foreign_buyer = true => lang = 'pl_en'
+                            # możliwe wartości: pl | pl_en | en | es
+      :reverse_charge,      # faktura z odwrotnym obciążeniem VAT
+      :vat_cash_accounting, # faktura z metodą kasową
+      :prepayment_invoice,  # faktura zaliczkowa
+      :currency,            # waluta rozliczeniowa, domyślnie: PLN (string)
+      :exchange_rate        # kurs waluty rozliczeniowej, domyślnie: 1.0000 (float)
     ].freeze
 
     attr_accessor(*AVAILABLE_PARAMS, :template_path, :logger, :wkhtmltopdf_path, :wkhtmltopdf_command)
@@ -130,6 +132,8 @@ module PolishInvoicer
       @proforma = false
       @foreign_buyer = false
       @reverse_charge = false
+      @vat_cash_accounting = false
+      @prepayment_invoice = false
       @currency = 'PLN'
       @exchange_rate = 1.0000
       @recipient = []

data/lib/polish_invoicer/validator.rb

@@ -57,6 +57,7 @@ module PolishInvoicer
       @errors[:buyer] = 'Nabywca musi być podany jako tablica stringów' unless @invoice.buyer.is_a?(Array)
     end
 
+    # rubocop:disable Metrics/CyclomaticComplexity
     def check_booleans
       unless [true, false].include?(@invoice.gross_price)
         @errors[:gross_price] = 'Znacznik rodzaju ceny musi być podany jako boolean'
@@ -69,10 +70,17 @@ module PolishInvoicer
       unless [true, false].include?(@invoice.foreign_buyer)
         @errors[:foreign_buyer] = 'Znacznik zagranicznego nabywcy musi być podany jako boolean'
       end
+      unless [true, false].include?(@invoice.vat_cash_accounting)
+        @errors[:vat_cash_accounting] = 'Znacznik metody kasowej musi być podany jako boolean'
+      end
+      unless [true, false].include?(@invoice.prepayment_invoice)
+        @errors[:prepayment_invoice] = 'Znacznik faktury zaliczkowej musi być podany jako boolean'
+      end
       return if [true, false].include?(@invoice.reverse_charge)
 
       @errors[:reverse_charge] = 'Znacznik odwrotnego obciążenia VAT musi być podany jako boolean'
     end
+    # rubocop:enable Metrics/CyclomaticComplexity
 
     def check_dates
       @errors[:create_date] = 'Data wystawienia musi być typu Date' unless @invoice.create_date.is_a?(Date)

data/lib/polish_invoicer/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module PolishInvoicer
-  VERSION = '0.0.34'
+  VERSION = '0.0.36'
 end

data/test/invoice_test.rb

@@ -14,6 +14,12 @@ module PolishInvoicer
       i = Invoice.new(number: '1/2014')
 
       assert_equal '1/2014', i.number
+      i = Invoice.new(vat_cash_accounting: true)
+
+      assert i.vat_cash_accounting
+      i = Invoice.new(prepayment_invoice: true)
+
+      assert i.prepayment_invoice
     end
 
     def test_set_unavailable_param
@@ -127,6 +133,8 @@ module PolishInvoicer
       assert_equal 'Przelew', i.payment_type
       assert i.paid
       refute i.proforma
+      refute i.vat_cash_accounting
+      refute i.prepayment_invoice
     end
 
     def test_raise_when_save_to_html_and_not_valid

data/test/test_generator.rb

@@ -15,6 +15,12 @@ i = PolishInvoicer::Invoice.new(
 )
 
 i.save_to_pdf('/tmp/invoice-default.pdf')
+i.prepayment_invoice = true
+i.save_to_pdf('/tmp/invoice-prepayment.pdf')
+i.prepayment_invoice = false
+i.vat_cash_accounting = true
+i.save_to_pdf('/tmp/invoice-vat-cash-accounting.pdf')
+i.vat_cash_accounting = false
 i.recipient = ['Szkoła Podstawowa Nr 1', 'ul. Zielona 10', '81-222 Gdynia', 'Nr ewid: SP1/2017']
 i.save_to_pdf('/tmp/invoice-with-recipient.pdf')
 i.paid = false
@@ -33,9 +39,27 @@ i.save_to_pdf('/tmp/invoice-pkwiu-fv-reason.pdf')
 i.foreign_buyer = true
 i.lang = 'pl_en'
 i.save_to_pdf('/tmp/invoice-foreign-buyer.pdf')
+i.prepayment_invoice = true
+i.save_to_pdf('/tmp/invoice-prepayment-pl-en.pdf')
+i.prepayment_invoice = false
+i.vat_cash_accounting = true
+i.save_to_pdf('/tmp/invoice-vat-cash-accounting-pl-en.pdf')
+i.vat_cash_accounting = false
 i.reverse_charge = true
 i.save_to_pdf('/tmp/invoice-reverse-charge.pdf')
 i.lang = 'en'
+i.prepayment_invoice = true
+i.save_to_pdf('/tmp/invoice-prepayment-en.pdf')
+i.prepayment_invoice = false
+i.vat_cash_accounting = true
+i.save_to_pdf('/tmp/invoice-vat-cash-accounting-en.pdf')
+i.vat_cash_accounting = false
 i.save_to_pdf('/tmp/invoice-foreign-buyer-reverse-charge.pdf')
 i.lang = 'es'
+i.prepayment_invoice = true
+i.save_to_pdf('/tmp/invoice-prepayment-es.pdf')
+i.prepayment_invoice = false
 i.save_to_pdf('/tmp/invoice-foreign-buyer-reverse-charge-es.pdf')
+i.vat_cash_accounting = true
+i.save_to_pdf('/tmp/invoice-vat-cash-accounting-es.pdf')
+i.vat_cash_accounting = false

data/test/test_helper.rb

@@ -2,7 +2,7 @@
 
 require 'simplecov'
 SimpleCov.start do
-  add_filter '/test/'
+  skip '/test/'
 end
 
 $LOAD_PATH.unshift File.expand_path('../lib', __dir__)

data/test/validator_test.rb

@@ -108,6 +108,20 @@ module PolishInvoicer
       check_ok(:proforma, false)
     end
 
+    def test_vat_cash_accounting_validation
+      check_error(:vat_cash_accounting)
+      check_error(:vat_cash_accounting, 'test')
+      check_ok(:vat_cash_accounting, true)
+      check_ok(:vat_cash_accounting, false)
+    end
+
+    def test_prepayment_invoice_validation
+      check_error(:prepayment_invoice)
+      check_error(:prepayment_invoice, 'test')
+      check_ok(:prepayment_invoice, true)
+      check_ok(:prepayment_invoice, false)
+    end
+
     def test_proforma_not_paid
       @invoice.paid = true
       @invoice.proforma = true

data/test/writer_test.rb

@@ -35,5 +35,51 @@ module PolishInvoicer
       assert_equal 'FakeLogger', writer.logger
       assert_equal 'wkhtmltopdf_fake_command', writer.wkhtmltopdf_command
     end
+
+    def test_vat_cash_accounting_note_in_templates
+      expected_label_per_lang = {
+        'pl' => 'Metoda kasowa',
+        'pl_en' => 'VAT cash accounting',
+        'en' => 'VAT cash accounting',
+        'es' => 'Contabilidad de caja de IVA'
+      }
+
+      expected_label_per_lang.each do |lang, label|
+        invoice = create_valid_invoice
+        invoice.lang = lang
+        invoice.vat_cash_accounting = true
+        path = "/tmp/test-vat-cash-accounting-#{lang}.html"
+
+        invoice.save_to_html(path)
+
+        assert_includes File.read(path), label
+        File.unlink(path)
+      end
+    end
+
+    def test_prepayment_invoice_header_in_templates
+      expected_labels_per_lang = {
+        'pl' => ['Faktura zaliczkowa nr 1/2014'],
+        'pl_en' => ['Faktura zaliczkowa nr 1/2014', 'Prepayment Invoice number 1/2014'],
+        'en' => ['Prepayment Invoice number 1/2014'],
+        'es' => ['Factura de anticipo No. 1/2014']
+      }
+
+      expected_labels_per_lang.each do |lang, labels|
+        invoice = create_valid_invoice
+        invoice.lang = lang
+        invoice.prepayment_invoice = true
+        path = "/tmp/test-prepayment-invoice-#{lang}.html"
+
+        invoice.save_to_html(path)
+
+        html = File.read(path)
+
+        labels.each do |label|
+          assert_includes html, label
+        end
+        File.unlink(path)
+      end
+    end
   end
 end

data/tpl/invoice-en.slim

@@ -2,7 +2,7 @@ doctype html
 html
   head
     meta charset="utf-8"
-    title = "Invoice number #{number}"
+    title = prepayment_invoice ? "Prepayment Invoice number #{number}" : "Invoice number #{number}"
     css:
       /*!
        * Bootstrap v3.3.7 (http://getbootstrap.com)
@@ -16,7 +16,10 @@ html
   body
     .container
 
-      h3 = "Invoice number #{number}"
+      h3 = prepayment_invoice ? "Prepayment Invoice number #{number}" : "Invoice number #{number}"
+
+      - if vat_cash_accounting
+        b VAT cash accounting
 
       .row
         .col-xs-6

data/tpl/invoice-es.slim

@@ -2,7 +2,7 @@ doctype html
 html
   head
     meta charset="utf-8"
-    title = "Factura No. #{number}"
+    title = prepayment_invoice ? "Factura de anticipo No. #{number}" : "Factura No. #{number}"
     css:
       /*!
        * Bootstrap v3.3.7 (http://getbootstrap.com)
@@ -16,7 +16,10 @@ html
   body
     .container
 
-      h3 = "Factura No. #{number}"
+      h3 = prepayment_invoice ? "Factura de anticipo No. #{number}" : "Factura No. #{number}"
+
+      - if vat_cash_accounting
+        b Contabilidad de caja de IVA
 
       .row
         .col-xs-6

data/tpl/invoice-pl.slim

@@ -2,7 +2,7 @@ doctype html
 html
   head
     meta charset="utf-8"
-    title = "Faktura nr #{number}"
+    title = prepayment_invoice ? "Faktura zaliczkowa nr #{number}" : "Faktura nr #{number}"
     css:
       /*!
        * Bootstrap v3.3.7 (http://getbootstrap.com)
@@ -16,7 +16,10 @@ html
   body
     .container
 
-      h3 = "Faktura nr #{number}"
+      h3 = prepayment_invoice ? "Faktura zaliczkowa nr #{number}" : "Faktura nr #{number}"
+
+      - if vat_cash_accounting
+        b Metoda kasowa
 
       .row
         .col-xs-6

data/tpl/invoice-pl_en.slim

@@ -2,7 +2,7 @@ doctype html
 html
   head
     meta charset="utf-8"
-    title = "Faktura nr #{number}"
+    title = prepayment_invoice ? "Faktura zaliczkowa nr #{number}" : "Faktura nr #{number}"
     css:
       /*!
        * Bootstrap v3.3.7 (http://getbootstrap.com)
@@ -16,9 +16,14 @@ html
   body
     .container
 
-      h3 = "Faktura nr #{number}"
+      h3 = prepayment_invoice ? "Faktura zaliczkowa nr #{number}" : "Faktura nr #{number}"
       h6.small
-        em = "Invoice number #{number}"
+        em = prepayment_invoice ? "Prepayment Invoice number #{number}" : "Invoice number #{number}"
+
+      - if vat_cash_accounting
+        b Metoda kasowa
+        .small
+          em VAT cash accounting
 
       .row
         .col-xs-6

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: polish_invoicer
 version: !ruby/object:Gem::Version
-  version: 0.0.34
+  version: 0.0.36
 platform: ruby
 authors:
 - Piotr Macuk
@@ -199,7 +199,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.7.2
+rubygems_version: 4.0.9
 specification_version: 4
 summary: Creates polish invoices and proforms as HTML or PDF files
 test_files: []