polish_invoicer 0.0.33 → 0.0.35

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 1bc150b3394d7c7b2f413aa60b1786497feee7c3fc2e5636e538757decae08a9
-  data.tar.gz: 6050884b9617130c8c5af7b56c729b77b07d2d967306f99a409a34a4268e3536
+  metadata.gz: 5d9264ab4e0ba871b374cfdfd43cdf887426b8f9da6c17498cad7e9f3d02a8ea
+  data.tar.gz: 44eb2add8debce3cbf7fc32c7cd76a3d3f20dd4021621e161d0d189344ed7835
 SHA512:
-  metadata.gz: bad0d1bd56b0fa9179ae8a1a2a8f846cebbfa8f16ed6d7429799ba1e55621d362b51bae19f95f9b7f938149a52d5c8c0772e94aace04fea8a11c4eeb42b7f79b
-  data.tar.gz: 5e707f06500268e19d0e8c5fb1a3f699d3e73351c702e74042e6845adae0e14b615422a476f5a7c2b9647999c37137cb1dd5997578a21aa3b6e495e2429db3fd
+  metadata.gz: 634fb2a77a974aaae43274d21874501945b590a3650d45ac4ceb873928f7af728b80fd52cd19d24b58d66250740462d7a00ebc4232fb74df632f214757533ba6
+  data.tar.gz: 3ea7b9b8da655dc18f0b5847c5480161d6bfc3af7d8330af7c54bee512872586dbbeffdf870a8e5097cc36b2859a7fd94fb3424fa10540ffec933fa9f9d339a5

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,8 @@ 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
     :currency             # waluta rozliczeniowa (string)
                           # wartość domyślna: PLN                      
     :exchange_rate        # kurs waluty rozliczeniowej (float)
@@ -110,6 +112,7 @@ invoice.save_to_pdf('/path/to/invoice.pdf')
     :footer,              # treść umieszczana w stopce faktury (string)
     :price_paid,          # kwota częściowego opłacenia faktury w złotych (float)
     :ksef_number,         # numer faktury w KSeF (string)
+    :ksef_qr_code_url,    # adres URL kodu QR dla faktury w KSeF (string)
 
 ### Parametry systemowe
 

data/lib/polish_invoicer/invoice.rb

@@ -3,36 +3,38 @@
 module PolishInvoicer
   class Invoice
     AVAILABLE_PARAMS = [
-      :number,            # numer faktury (string)
-      :ksef_number,       # numer faktury w KSeF (string)
-      :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ą
+      :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)
@@ -113,6 +115,12 @@ module PolishInvoicer
       proforma ? "proforma-#{template_lang}.slim" : "invoice-#{template_lang}.slim"
     end
 
+    def qr_code_data_url
+      return unless ksef_qr_code_url
+
+      RQRCode::QRCode.new(ksef_qr_code_url).as_png(size: 220).to_data_url
+    end
+
     private
 
     def set_defaults
@@ -123,6 +131,7 @@ module PolishInvoicer
       @proforma = false
       @foreign_buyer = false
       @reverse_charge = false
+      @vat_cash_accounting = false
       @currency = 'PLN'
       @exchange_rate = 1.0000
       @recipient = []

data/lib/polish_invoicer/presenter.rb

@@ -33,7 +33,7 @@ module PolishInvoicer
     end
 
     def copy_additional_params
-      %w[net_value vat_value gross_value exchanged_tax].each do |field|
+      %w[net_value vat_value gross_value exchanged_tax qr_code_data_url].each do |field|
         @out[field.to_sym] = @invoice.send(field)
       end
     end

data/lib/polish_invoicer/validator.rb

@@ -69,6 +69,9 @@ 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
       return if [true, false].include?(@invoice.reverse_charge)
 
       @errors[:reverse_charge] = 'Znacznik odwrotnego obciążenia VAT musi być podany jako boolean'

data/lib/polish_invoicer/version.rb

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

data/lib/polish_invoicer.rb

@@ -7,6 +7,7 @@ require 'polish_invoicer/version'
 require 'polish_invoicer/vat'
 require 'polish_invoicer/validator'
 require 'slim2pdf'
+require 'rqrcode'
 require 'polish_invoicer/writer'
 require 'polish_invoicer/presenter'
 require 'polish_invoicer/invoice'

data/polish_invoicer.gemspec

@@ -28,5 +28,6 @@ Gem::Specification.new do |spec|
   spec.add_development_dependency 'rubocop-rake'
   spec.add_development_dependency 'simplecov'
 
+  spec.add_dependency 'rqrcode'
   spec.add_dependency 'slim2pdf'
 end

data/test/invoice_test.rb

@@ -14,6 +14,9 @@ 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
     end
 
     def test_set_unavailable_param
@@ -127,6 +130,7 @@ module PolishInvoicer
       assert_equal 'Przelew', i.payment_type
       assert i.paid
       refute i.proforma
+      refute i.vat_cash_accounting
     end
 
     def test_raise_when_save_to_html_and_not_valid

data/test/test_generator.rb

@@ -9,10 +9,15 @@ i = PolishInvoicer::Invoice.new(
   item_name: 'Jakiś długi tytuł i jeszcze jakieś informacje na różne tematy oraz dodatkowy komentarz w sprawie różnej.',
   price: 123.45, payment_date: Date.today,
   comments: 'Test uwag', footer: 'Stopka faktury plus tekst promocyjny',
-  seller_nip: '123-456-78-90', buyer_nip: '987-654-32-10'
+  seller_nip: '123-456-78-90', buyer_nip: '987-654-32-10',
+  ksef_number: '1234567890-20260211-0200C0785341-F8',
+  ksef_qr_code_url: 'https://qr-test.ksef.mf.gov.pl/invoice/1234567890/11-02-2026/vgAXyW8BGst1ply1ag8hwbZ84Qz4Fgi0GDw6r84u6Pg'
 )
 
 i.save_to_pdf('/tmp/invoice-default.pdf')
+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
@@ -31,9 +36,18 @@ 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.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.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.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/validator_test.rb

@@ -108,6 +108,13 @@ 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_proforma_not_paid
       @invoice.paid = true
       @invoice.proforma = true

data/test/writer_test.rb

@@ -35,5 +35,26 @@ 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
   end
 end

data/tpl/invoice-en.slim

@@ -18,8 +18,8 @@ html
 
       h3 = "Invoice number #{number}"
 
-      - if ksef_number
-        h4 = "KSeF number: #{ksef_number}"
+      - if vat_cash_accounting
+        b VAT cash accounting
 
       .row
         .col-xs-6
@@ -117,3 +117,16 @@ html
         br
         br
         b Levy of VAT reverse charged to recipient of service (reverse charge)
+
+      - if ksef_number && ksef_qr_code_url
+        hr
+        .row
+          .col-xs-4
+            img src=qr_code_data_url
+          .col-xs-8
+            br
+            h4 KSeF
+            = ksef_number
+            br
+            br
+            a href=ksef_qr_code_url #{ksef_qr_code_url}

data/tpl/invoice-es.slim

@@ -18,8 +18,8 @@ html
 
       h3 = "Factura No. #{number}"
 
-      - if ksef_number
-        h4 = "Número KSeF: #{ksef_number}"
+      - if vat_cash_accounting
+        b Contabilidad de caja de IVA
 
       .row
         .col-xs-6
@@ -117,3 +117,16 @@ html
         br
         br
         b Recaudación del IVA con cargo revertido al destinatario del servicio (cargo revertido)
+
+      - if ksef_number && ksef_qr_code_url
+        hr
+        .row
+          .col-xs-4
+            img src=qr_code_data_url
+          .col-xs-8
+            br
+            h4 KSeF
+            = ksef_number
+            br
+            br
+            a href=ksef_qr_code_url #{ksef_qr_code_url}

data/tpl/invoice-pl.slim

@@ -18,8 +18,8 @@ html
 
       h3 = "Faktura nr #{number}"
 
-      - if ksef_number
-        h4 = "Numer KSeF: #{ksef_number}"
+      - if vat_cash_accounting
+        b Metoda kasowa
 
       .row
         .col-xs-6
@@ -135,3 +135,16 @@ html
           b Podstawa zwolnienia z podatku VAT:
           br
           = no_vat_reason
+
+      - if ksef_number && ksef_qr_code_url
+        hr
+        .row
+          .col-xs-4
+            img src=qr_code_data_url
+          .col-xs-8
+            br
+            h4 KSeF
+            = ksef_number
+            br
+            br
+            a href=ksef_qr_code_url #{ksef_qr_code_url}

data/tpl/invoice-pl_en.slim

@@ -20,11 +20,10 @@ html
       h6.small
         em = "Invoice number #{number}"
 
-      - if ksef_number
-        h4 = "Numer KSeF: #{ksef_number}"
-        h6.small
-          em = "KSeF number: #{ksef_number}"
-
+      - if vat_cash_accounting
+        b Metoda kasowa
+        .small
+          em VAT cash accounting
 
       .row
         .col-xs-6
@@ -210,3 +209,16 @@ html
         .small
           em Basis for VAT exemption:
         = no_vat_reason
+
+      - if ksef_number && ksef_qr_code_url
+        hr
+        .row
+          .col-xs-4
+            img src=qr_code_data_url
+          .col-xs-8
+            br
+            h4 KSeF
+            = ksef_number
+            br
+            br
+            a href=ksef_qr_code_url #{ksef_qr_code_url}

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: polish_invoicer
 version: !ruby/object:Gem::Version
-  version: 0.0.33
+  version: 0.0.35
 platform: ruby
 authors:
 - Piotr Macuk
@@ -107,6 +107,20 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
+- !ruby/object:Gem::Dependency
+  name: rqrcode
+  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: slim2pdf
   requirement: !ruby/object:Gem::Requirement
@@ -185,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: []