polish_invoicer 0.0.20 → 0.0.25

checksums.yaml

@@ -1,7 +1,7 @@
 ---
-SHA1:
-  metadata.gz: 644beb638eed958e59e1975f1c05c01c925622f5
-  data.tar.gz: b8b85f18b71cce1b17f039af4d03df5eb28f4c4e
+SHA256:
+  metadata.gz: e50ba77f3a3539b5a75c12e3213dd8e0f56bc7788c7ab74d43ec661ef8e12d94
+  data.tar.gz: 9193da0b3dd714fa51ac52e06a2b87191a493f7539132b41115ce89c86851632
 SHA512:
-  metadata.gz: 392e24d56f6e06c8c584da31b42292a653db624f59796ea809cdb17f62f534179b296fab8b2ccba018841f7f5de89e01ab0ebcfd1f69c7e43f85ebbd3ca935eb
-  data.tar.gz: b046255d9abd0474c8a4289ae96fbe36f7643965216dfe46ac8905f390cda8c45e121b912da87abc24ce2ba2140e7a188cf455da1f45dc85db5c0afc109ebeb3
+  metadata.gz: f0839922dbbab96b6e580f5c63ca86d4b2789c6b3f771d0195c5251cb48e9c6ef3b23fccd22ebfe3fb8f603ba007836d073f71a33f876af85a77f4e7e5a7d38d
+  data.tar.gz: 3f608c82265282b14e5c1af278e3b38fefb9830005ea0bf3c9517c552dc5a76e5c10052f684f056a180db45f7d5599a2bc4b12d25ef4901c2ab3858f73272ef5

data/.travis.yml

@@ -1,6 +1,5 @@
 language: ruby
 rvm:
-  - 2.2.10
-  - 2.3.7
-  - 2.4.4
-  - 2.5.1
+  - 2.5.8
+  - 2.6.6
+  - 2.7.2

data/README.md

@@ -97,6 +97,8 @@ invoice.save_to_pdf('/path/to/invoice.pdf')
                           # wartość domyślna: false
     :currency             # waluta rozliczeniowa (string)
                           # wartość domyślna: PLN                      
+    :exchange_rate        # kurs waluty rozliczeniowej (float)
+                          # wartość domyślna: 1.0000
 
 ### Parametry dodatkowe
 
@@ -106,6 +108,7 @@ invoice.save_to_pdf('/path/to/invoice.pdf')
     :pkwiu,               # numer PKWiU (string)
     :no_vat_reason,       # podstawa prawna zwolnienia z VAT (string)
     :footer,              # treść umieszczana w stopce faktury (string)
+    :price_paid,          # kwota częściowego opłacenia faktury w złotych (float)
 
 ### Parametry systemowe
 

data/doc/invoice.rb

@@ -20,7 +20,9 @@ invoice = PolishInvoicer::Invoice.new(
   # paid: false,
   foreign_buyer: true,
   reverse_charge: true,
-  currency: 'USD'
+  currency: 'EUR',
+  exchange_rate: 3.5432,
+  comments: 'To jest komentarz w ważnej sprawie do dokumentu'
 )
 invoice.save_to_html('/tmp/invoice.html')
 invoice.save_to_pdf('/tmp/invoice.pdf')

data/lib/polish_invoicer/invoice.rb

@@ -11,6 +11,7 @@ module PolishInvoicer
       :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)
@@ -23,7 +24,8 @@ module PolishInvoicer
       :no_vat_reason,     # podstawa prawna zwolnienia z VAT (string)
       :foreign_buyer,     # nabywcą jest firma spoza Polski, domyślnie: false (boolean)
       :reverse_charge,    # faktura z odwrotnym obciążeniem VAT
-      :currency           # waluta rozliczeniowa, domyślnie: PLN (string)
+      :currency,          # waluta rozliczeniowa, domyślnie: PLN (string)
+      :exchange_rate      # kurs waluty rozliczeniowej, domyślnie: 1.0000 (float)
     ].freeze
 
     attr_accessor(*AVAILABLE_PARAMS)
@@ -79,6 +81,22 @@ module PolishInvoicer
       Presenter.new(self).data
     end
 
+    def exchanged_tax
+      (vat_value * exchange_rate)
+    end
+
+    def total_to_pay_value
+      reverse_charge ? net_value : gross_value
+    end
+
+    def paid_value
+      paid ? total_to_pay_value : price_paid.to_f
+    end
+
+    def to_pay_value
+      paid ? 0 : (total_to_pay_value - price_paid.to_f)
+    end
+
     private
 
     def set_defaults
@@ -90,6 +108,7 @@ module PolishInvoicer
       @foreign_buyer = false
       @reverse_charge = false
       @currency = 'PLN'
+      @exchange_rate = 1.0000
       @recipient = []
     end
 

data/lib/polish_invoicer/presenter.rb

@@ -31,7 +31,7 @@ module PolishInvoicer
     end
 
     def copy_additional_params
-      %w[net_value vat_value gross_value].each do |field|
+      %w[net_value vat_value gross_value exchanged_tax].each do |field|
         @out[field.to_sym] = @invoice.send(field)
       end
     end
@@ -45,7 +45,7 @@ module PolishInvoicer
     end
 
     def format_prices
-      %w[net_value vat_value gross_value].each do |field|
+      %w[net_value vat_value gross_value exchanged_tax total_to_pay_value paid_value to_pay_value].each do |field|
         v = @invoice.send(field)
         next unless v
         @out[field.to_sym] = sprintf('%02.2f', v).tr('.', ',')

data/lib/polish_invoicer/validator.rb

@@ -15,6 +15,7 @@ module PolishInvoicer
       check_arrays
       check_booleans
       check_price
+      check_price_paid
       check_vat
       check_proforma
       check_create_and_payment_date
@@ -42,6 +43,7 @@ module PolishInvoicer
       @errors[:gross_price] = 'Konieczne jest ustawienie znacznika rodzaju ceny (netto/brutto)' if @invoice.gross_price.nil?
       @errors[:paid] = 'Konieczne jest ustawienie znacznika opłacenia faktury' if @invoice.paid.nil?
       @errors[:currency] = 'Konieczne jest ustawienie waluty rozliczeniowej' if @invoice.currency.nil?
+      @errors[:exchange_rate] = 'Konieczne jest podanie kursu waluty rozliczeniowej' if @invoice.exchange_rate.nil?
     end
 
     def check_arrays
@@ -81,6 +83,18 @@ module PolishInvoicer
       end
     end
 
+    def check_price_paid
+      return if @invoice.price_paid.nil?
+      return if @invoice.price.nil?
+
+      if @invoice.price_paid.is_a?(Numeric)
+        @errors[:price_paid] = 'Kwota zapłacona musi być liczbą dodatnią' unless @invoice.price_paid >= 0
+        @errors[:price_paid] = 'Kwota zapłacona musi być mniejsza lub równa cenie' unless @invoice.price_paid <= @invoice.price
+      else
+        @errors[:price_paid] = 'Kwota zapłacona musi być liczbą'
+      end
+    end
+
     def check_vat
       if Vat.valid?(@invoice.vat)
         if Vat.zw?(@invoice.vat) && blank?(@invoice.no_vat_reason)

data/lib/polish_invoicer/version.rb

@@ -1,3 +1,3 @@
 module PolishInvoicer
-  VERSION = '0.0.20'.freeze
+  VERSION = '0.0.25'.freeze
 end

data/test/invoice_test.rb

@@ -133,5 +133,64 @@ module PolishInvoicer
       assert_equal false, h[:gross_price] # params
       assert_equal '123,45', h[:net_value] # presenter
     end
+
+    def test_total_to_pay_value
+      assert_equal 123, Invoice.new(price: 123).paid_value
+      assert_equal 100, Invoice.new(price: 123, reverse_charge: true).paid_value
+    end
+
+    def test_paid_value
+      assert_equal 123, Invoice.new(price: 123).paid_value
+      assert_equal 123, Invoice.new(price: 123, price_paid: 100).paid_value
+      assert_equal 0, Invoice.new(price: 123, paid: false).paid_value
+      assert_equal 100, Invoice.new(price: 123, paid: false, price_paid: 100).paid_value
+      assert_equal 100, Invoice.new(price: 123, gross_price: false, paid: false, price_paid: 100).paid_value
+      assert_equal 100, Invoice.new(price: 123, reverse_charge: true, paid: false, price_paid: 100).paid_value
+    end
+
+    def test_to_pay_value
+      assert_equal 0, Invoice.new(price: 123).to_pay_value
+      assert_equal 0, Invoice.new(price: 123, price_paid: 100).to_pay_value
+      assert_equal 123, Invoice.new(price: 123, paid: false).to_pay_value
+      assert_equal 23, Invoice.new(price: 123, paid: false, price_paid: 100).to_pay_value
+      assert_equal 23, Invoice.new(price: 100, gross_price: false, paid: false, price_paid: 100).to_pay_value
+      assert_equal 50, Invoice.new(price: 123, reverse_charge: true, paid: false, price_paid: 50).to_pay_value
+    end
+
+    def test_gross_and_net_price
+      gross_invoice = Invoice.new(price: 123, price_paid: 60, paid: false)
+      assert_equal 100, gross_invoice.net_value
+      assert_equal 23, gross_invoice.vat_value
+      assert_equal 123, gross_invoice.gross_value
+      assert_equal 123, gross_invoice.total_to_pay_value
+      assert_equal 60, gross_invoice.paid_value
+      assert_equal 63, gross_invoice.to_pay_value
+
+      net_invoice = Invoice.new(price: 100, price_paid: 60, paid: false, gross_price: false)
+      assert_equal 100, net_invoice.net_value
+      assert_equal 23, net_invoice.vat_value
+      assert_equal 123, net_invoice.gross_value
+      assert_equal 123, net_invoice.total_to_pay_value
+      assert_equal 60, net_invoice.paid_value
+      assert_equal 63, net_invoice.to_pay_value
+    end
+
+    def test_reverse_charge
+      gross_invoice = Invoice.new(price: 123, price_paid: 60, paid: false, reverse_charge: true)
+      assert_equal 100, gross_invoice.net_value
+      assert_equal 23, gross_invoice.vat_value
+      assert_equal 123, gross_invoice.gross_value
+      assert_equal 100, gross_invoice.total_to_pay_value
+      assert_equal 60, gross_invoice.paid_value
+      assert_equal 40, gross_invoice.to_pay_value
+
+      net_invoice = Invoice.new(price: 100, price_paid: 60, paid: false, gross_price: false, reverse_charge: true)
+      assert_equal 100, net_invoice.net_value
+      assert_equal 23, net_invoice.vat_value
+      assert_equal 123, net_invoice.gross_value
+      assert_equal 100, net_invoice.total_to_pay_value
+      assert_equal 60, net_invoice.paid_value
+      assert_equal 40, net_invoice.to_pay_value
+    end
   end
 end

data/test/validator_test.rb

@@ -54,6 +54,16 @@ module PolishInvoicer
       check_ok(:price, 19.99)
     end
 
+    def test_price_paid_validation
+      @invoice.price = 200
+      check_ok(:price_paid)
+      check_error(:price_paid, 'test')
+      check_error(:price_paid, '100')
+      check_error(:price_paid, -10)
+      check_error(:price_paid, 300)
+      check_ok(:price_paid, 19.99)
+    end
+
     def test_gross_price_validation
       check_error(:gross_price)
       check_error(:gross_price, 'test')
@@ -157,6 +167,17 @@ module PolishInvoicer
       refute v.errors[:currency]
     end
 
+    def test_exchange_rate
+      @invoice.exchange_rate = nil
+      v = Validator.new(@invoice)
+      v.valid?
+      assert v.errors[:exchange_rate]
+      @invoice.exchange_rate = 4,1234
+      v = Validator.new(@invoice)
+      v.valid?
+      refute v.errors[:exchange_rate]
+    end
+
     private
 
     def check_error(field, value = nil)

data/tpl/invoice-en.slim

@@ -127,7 +127,7 @@ html
           - unless reverse_charge
             td.text-center = vat
             td.text-center = vat_value
-            td.text-center = gross_value
+            td.text-center = total_to_pay_value
         tr
           td colspan="#{pkwiu ? 3 : 2}"
             |  
@@ -139,7 +139,7 @@ html
           - unless reverse_charge
             td.text-center = vat
             td.text-center = vat_value
-            th.text-center = gross_value
+            th.text-center = total_to_pay_value
 
       br
 
@@ -151,27 +151,35 @@ html
               .small
                 em Total to pay:
             .col-xs-6
-              b = "#{reverse_charge == true ? net_value : gross_value} #{currency}"
+              b = "#{total_to_pay_value} #{currency}"
           .row
             .col-xs-6
               | Zapłacono:
               .small
                 em Amount paid:
-            .col-xs-6
-              - if paid
-                = "#{reverse_charge == true ? net_value : gross_value} #{currency}"
-              - else
-                = "0,00 #{currency}"
+            .col-xs-6 = "#{paid_value} #{currency}"
           .row
             .col-xs-6
               | Zostało do zapłaty:
               .small
                 em Left to pay:
-            .col-xs-6
-              - if paid
-                = "0,00 #{currency}"
-              - else
-                = "#{reverse_charge == true ? net_value : gross_value} #{currency}"
+            .col-xs-6 = "#{to_pay_value} #{currency}"
+          - if currency != 'PLN'
+            .row
+              .col-xs-6
+                | Kurs waluty:
+                .small
+                  em Exchange rate:
+              .col-xs-6
+                = exchange_rate
+            - unless reverse_charge
+              .row
+                .col-xs-6
+                  | Podatek w PLN:
+                  .small
+                    em Exchanged tax amount:
+                .col-xs-6
+                  = "#{exchanged_tax} PLN"
 
         .col-xs-6
           - if comments.any?

data/tpl/invoice.slim

@@ -83,7 +83,7 @@ html
           td.text-center = net_value
           td.text-center = vat
           td.text-center = vat_value
-          td.text-center = gross_value
+          td.text-center = total_to_pay_value
         tr
           td colspan="#{pkwiu ? 3 : 2}"
             |  
@@ -91,7 +91,7 @@ html
           td.text-center = net_value
           td.text-center = vat
           td.text-center = vat_value
-          th.text-center = gross_value
+          th.text-center = total_to_pay_value
 
       br
 
@@ -102,18 +102,22 @@ html
           | Zapłacono:
           br
           | Zostało do zapłaty:
+          - if currency != 'PLN'
+            br
+            | Kurs waluty:
+            br
+            | Podatek w PLN:
         .col-xs-3
-          b = "#{gross_value} #{currency}"
+          b = "#{total_to_pay_value} #{currency}"
           br
-          - if paid
-            = "#{gross_value} #{currency}"
-          - else
-            = "0,00 #{currency}"
+          = "#{paid_value} #{currency}"
           br
-          - if paid
-            = "0,00 #{currency}"
-          - else
-            = "#{gross_value} #{currency}"
+          = "#{to_pay_value} #{currency}"
+          - if currency != 'PLN'
+            br
+            = exchange_rate
+            br
+            = "#{exchanged_tax} PLN"
         - if comments.any?
           .col-xs-6
             b Uwagi:

data/tpl/proforma-en.slim

@@ -115,7 +115,7 @@ html
               em 1 service
           td.text-center = net_value
           td.text-center = net_value
-          td.text-center = (reverse_charge == true ? net_value : gross_value)
+          td.text-center = total_to_pay_value
         tr
           td colspan="#{pkwiu ? 3 : 2}"
             |  
@@ -124,7 +124,7 @@ html
             .small
               em Total
           td.text-center = net_value
-          th.text-center = (reverse_charge == true ? net_value : gross_value)
+          th.text-center = total_to_pay_value
 
       br
 
@@ -136,27 +136,19 @@ html
               .small
                 em Total to pay:
             .col-xs-6
-              b = "#{reverse_charge == true ? net_value : gross_value} #{currency}"
+              b = "#{total_to_pay_value} #{currency}"
           .row
             .col-xs-6
               | Zapłacono:
               .small
                 em Amount paid:
-            .col-xs-6
-              - if paid
-                = "#{reverse_charge == true ? net_value : gross_value} #{currency}"
-              - else
-                = "0,00 #{currency}"
+            .col-xs-6 = "#{paid_value} #{currency}"
           .row
             .col-xs-6
               | Zostało do zapłaty:
               .small
                 em Left to pay:
-            .col-xs-6
-              - if paid
-                = "0,00 #{currency}"
-              - else
-                = "#{reverse_charge == true ? net_value : gross_value} #{currency}"
+            .col-xs-6 = "#{to_pay_value} #{currency}"
 
         .col-xs-6
           - if comments.any?

data/tpl/proforma.slim

@@ -77,13 +77,13 @@ html
             | 1 usł.
           td.text-center = net_value
           td.text-center = net_value
-          td.text-center = gross_value
+          td.text-center = total_to_pay_value
         tr
           td colspan="#{pkwiu ? 3 : 2}"
             |  
           th.text-center Razem
           td.text-center = net_value
-          th.text-center = gross_value
+          th.text-center = total_to_pay_value
 
       br
 
@@ -95,17 +95,11 @@ html
           br
           | Zostało do zapłaty:
         .col-xs-3
-          b = "#{gross_value} #{currency}"
+          b = "#{total_to_pay_value} #{currency}"
           br
-          - if paid
-            = "#{gross_value} #{currency}"
-          - else
-            = "0,00 #{currency}"
+          = "#{paid_value} #{currency}"
           br
-          - if paid
-            = "0,00 #{currency}"
-          - else
-            = "#{gross_value} #{currency}"
+          = "#{to_pay_value} #{currency}"
         - if comments.any?
           .col-xs-6
             b Uwagi:

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: polish_invoicer
 version: !ruby/object:Gem::Version
-  version: 0.0.20
+  version: 0.0.25
 platform: ruby
 authors:
 - Piotr Macuk
-autorequire: 
+autorequire:
 bindir: bin
 cert_chain: []
-date: 2018-07-11 00:00:00.000000000 Z
+date: 2020-10-29 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -137,7 +137,7 @@ homepage: ''
 licenses:
 - MIT
 metadata: {}
-post_install_message: 
+post_install_message:
 rdoc_options: []
 require_paths:
 - lib
@@ -152,9 +152,8 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubyforge_project: 
-rubygems_version: 2.6.14.1
-signing_key: 
+rubygems_version: 3.1.4
+signing_key:
 specification_version: 4
 summary: Creates polish invoices and proforms as HTML or PDF files
 test_files: