polish_invoicer 0.0.21 → 0.0.26

checksums.yaml

@@ -1,7 +1,7 @@
 ---
-SHA1:
-  metadata.gz: bda191d866cc449891ddda539f7d4488596ce329
-  data.tar.gz: ac4b56ac399d2605d877ed5e8cb9edc80ae9191b
+SHA256:
+  metadata.gz: 802e9cbe1c6b7ab58930b191e60ccab3655e9eb53b21d04eb657af483cca946b
+  data.tar.gz: 5b352fff7ac09baa01e2b8120b18fd4e665e507c5887266b6fe355e5f0285c9d
 SHA512:
-  metadata.gz: 4c1b33a78b3da1dc507ea771709ffb1411ba230d89fd7cd03c920cdbcb4aded9613c374267bb29689364ef3db5f450c1e74c29044a1cc562097838c6e6c40b2c
-  data.tar.gz: 95ffbb8601037dda21507c02285beb0c78301815babdcfed0e2069be11ca08e2d27f17e9aecf9bd257252b763b29470c17db5ffb6343c56deb498f3fe603eeda
+  metadata.gz: 86879c72be1a1e96e436863823192e00b933db64a9f9e2389a065bdb6211c87b2fd2cdacbc6e82aef44e9b582436199eceea73ade75cfc3d8e0fc1ad3b4f2c2a
+  data.tar.gz: 06bebb6a1a4743d5cb607332697d4b7bfbc80b7639c235358e363d356a0b3a63ae89892eaaafcc089f367925f98ad29f3e77f2ff4086062ab382cc9bd79ba945

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

@@ -108,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/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)
@@ -22,6 +23,10 @@ module PolishInvoicer
       :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
       :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)
@@ -80,6 +85,30 @@ 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
+
+    def template_lang
+      lang || (foreign_buyer ? 'pl_en' : 'pl')
+    end
+
+    def template_file
+      proforma ? "proforma-#{template_lang}.slim" : "invoice-#{template_lang}.slim"
+    end
+
     private
 
     def set_defaults

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,10 +15,12 @@ module PolishInvoicer
       check_arrays
       check_booleans
       check_price
+      check_price_paid
       check_vat
       check_proforma
       check_create_and_payment_date
       check_currency
+      check_lang
       @errors.empty?
     end
 
@@ -82,6 +84,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)
@@ -111,6 +125,13 @@ module PolishInvoicer
       @errors[:currency] = 'Nieznana waluta'
     end
 
+    def check_lang
+      return if blank?(@invoice.lang)
+      return if %w[pl pl_en en].include?(@invoice.lang)
+
+      @errors[:lang] = 'Nieznany język'
+    end
+
     def blank?(value)
       value.to_s.strip == ''
     end

data/lib/polish_invoicer/version.rb

@@ -1,3 +1,3 @@
 module PolishInvoicer
-  VERSION = '0.0.21'.freeze
+  VERSION = '0.0.26'.freeze
 end

data/lib/polish_invoicer/writer.rb

@@ -21,11 +21,7 @@ module PolishInvoicer
     end
 
     def template_path
-      tpl = if invoice.proforma
-              invoice.foreign_buyer ? 'proforma-en.slim' : 'proforma.slim'
-            else
-              invoice.foreign_buyer ? 'invoice-en.slim' : 'invoice.slim'
-            end
+      tpl = invoice.template_file
       invoice.template_path || File.expand_path("../../../tpl/#{tpl}", __FILE__)
     end
 

data/test/invoice_test.rb

@@ -133,5 +133,97 @@ 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
+
+    def test_template_lang
+      i = Invoice.new
+      assert_equal 'pl', i.template_lang
+      i.foreign_buyer = true
+      assert_equal 'pl_en', i.template_lang
+      i.lang = 'en'
+      assert_equal 'en', i.template_lang
+    end
+
+    def test_template_file
+      i = Invoice.new(proforma: true)
+      assert_equal 'proforma-pl.slim', i.template_file
+      i.foreign_buyer = true
+      assert_equal 'proforma-pl_en.slim', i.template_file
+      i.lang = 'en'
+      assert_equal 'proforma-en.slim', i.template_file
+      i.lang = 'pl'
+      assert_equal 'proforma-pl.slim', i.template_file
+      i.lang = 'pl_en'
+      assert_equal 'proforma-pl_en.slim', i.template_file
+
+      i = Invoice.new
+      assert_equal 'invoice-pl.slim', i.template_file
+      i.foreign_buyer = true
+      assert_equal 'invoice-pl_en.slim', i.template_file
+      i.lang = 'en'
+      assert_equal 'invoice-en.slim', i.template_file
+      i.lang = 'pl'
+      assert_equal 'invoice-pl.slim', i.template_file
+      i.lang = 'pl_en'
+      assert_equal 'invoice-pl_en.slim', i.template_file
+    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')
@@ -168,6 +178,20 @@ module PolishInvoicer
       refute v.errors[:exchange_rate]
     end
 
+    def test_lang
+      v = Validator.new(@invoice)
+      v.valid?
+      refute v.errors[:lang]
+      @invoice.lang = 'xx'
+      v = Validator.new(@invoice)
+      v.valid?
+      assert v.errors[:lang]
+      @invoice.lang = 'en'
+      v = Validator.new(@invoice)
+      v.valid?
+      refute v.errors[:lang]
+    end
+
     private
 
     def check_error(field, value = nil)

data/tpl/invoice-en.slim

@@ -2,7 +2,7 @@ doctype html
 html
   head
     meta charset="utf-8"
-    title = "Faktura nr #{number}"
+    title = "Invoice number #{number}"
     css:
       /*!
        * Bootstrap v3.3.7 (http://getbootstrap.com)
@@ -16,32 +16,24 @@ html
   body
     .container
 
-      h3 = "Faktura nr #{number}"
-      h6.small
-        em = "Invoice number #{number}"
+      h3 = "Invoice number #{number}"
 
       .row
         .col-xs-6
-          h4 Sprzedawca
-          h6.small
-            em Seller
+          h4 Seller
           - seller.each do |line|
             = line
             br
-          = "VAT no: #{seller_nip}"
+          = "TAX ID: #{seller_nip}"
         .col-xs-6
-          h4 Nabywca
-          h6.small
-            em Buyer
+          h4 Buyer
           - buyer.each do |line|
             = line
             br
           - if buyer_nip.to_s.strip != ''
-            = "VAT no: #{buyer_nip}"
+            = "TAX ID: #{buyer_nip}"
           - if recipient.any?
-            h4 Odbiorca
-            h6.small
-              em Recipient
+            h4 Recipient
             - recipient.each do |line|
               = line
               br
@@ -50,96 +42,50 @@ html
       br
 
       .row
-        .col-xs-3
-          | Data wystawienia:
-          .small
-            em Date of issue:
-        .col-xs-3
-          = create_date
-        .col-xs-3
-          | Termin płatności:
-          .small
-            em Payment deadline:
-        .col-xs-3
-          = payment_date
+        .col-xs-3 Date of issue:
+        .col-xs-3 = create_date
+        .col-xs-3 Payment deadline:
+        .col-xs-3 = payment_date
       .row
-        .col-xs-3
-          | Data sprzedaży:
-          .small
-            em Date of sale:
-        .col-xs-3
-          = trade_date
-        .col-xs-3
-          | Sposób zapłaty:
-          .small
-            em Method of payment:
-        .col-xs-3
-          = payment_type
-          .small
-            em = payment_type.to_s.downcase == 'przelew' ? 'bank transfer' : 'cash'
+        .col-xs-3 Date of sale:
+        .col-xs-3 = trade_date
+        .col-xs-3 Method of payment:
+        .col-xs-3 = payment_type.to_s.downcase == 'przelew' ? 'bank transfer' : 'cash'
 
       br
       br
 
       table.table.table-condensed
         tr
-          th width="40%"
-            | Usługa
-            .small
-              em Service
+          th width="40%" Service
           - if pkwiu
             th.text-center width="1%" PKWiU
-          th.text-center width="7%"
-            | Ilość
-            .small
-              em Qty
-          th.text-center width="7%"
-            | Cena netto
-            .small
-              em Unit price
-          th.text-center width="7%"
-            | Wart. netto
-            .small
-              em Net amount
+          th.text-center width="7%" Qty
+          th.text-center width="7%" Unit price
+          th.text-center width="7%" Net amount
           - unless reverse_charge
-            th.text-center width="1%"
-              | VAT
-              .small
-                em VAT
-            th.text-center width="7%"
-              | Kwota VAT
-              .small
-                em VAT amount
-            th.text-center width="7%"
-              | Wart. brutto
-              .small
-                em Gross amount
+            th.text-center width="1%" VAT
+            th.text-center width="7%" VAT amount
+            th.text-center width="7%" Gross amount
         tr
           td = item_name
           - if pkwiu
             td.text-center = pkwiu
-          td.text-center
-            | 1 usł.
-            .small
-              em 1 service
+          td.text-center 1 service
           td.text-center = net_value
           td.text-center = net_value
           - 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}"
-            |  
-          th.text-center
-            | Razem
-            .small
-              em Total
+          td colspan="#{pkwiu ? 3 : 2}"  
+          th.text-center Total
           td.text-center = net_value
           - 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
 
@@ -147,45 +93,19 @@ html
         .col-xs-6
           .row
             .col-xs-6
-              b Razem do zapłaty:
-              .small
-                em Total to pay:
+              b 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 Amount paid:
+            .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}"
-          - if currency != 'PLN'
-            .row
-              .col-xs-6
-                | Kurs waluty:
-                .small
-                  em Exchange rate:
-              .col-xs-6
-                = exchange_rate
-
+            .col-xs-6 Left to pay:
+            .col-xs-6 = "#{to_pay_value} #{currency}"
         .col-xs-6
           - if comments.any?
-            b Uwagi:
-            .small
-              em Remarks:
+            b Remarks:
+            br
             - comments.each do |line|
               = line
               br
@@ -194,6 +114,4 @@ html
         br
         br
 
-        b Do rozliczenia podatku VAT zobowiązany jest nabywca usługi (odwrotne obciążenie)
-        .small
-          em Levy of VAT reverse charged to recipient of service (reverse charge)
+        b Levy of VAT reverse charged to recipient of service (reverse charge)