polish_invoicer 0.0.25 → 0.0.28

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: e50ba77f3a3539b5a75c12e3213dd8e0f56bc7788c7ab74d43ec661ef8e12d94
-  data.tar.gz: 9193da0b3dd714fa51ac52e06a2b87191a493f7539132b41115ce89c86851632
+  metadata.gz: 80d547e5b447b0bdd6116f666ebc332a8e586cdc0513da03d75f69d83219253c
+  data.tar.gz: 988303b13fe261a44aa22cf1141ee18c834b5f8ba813f117b14596f552c97700
 SHA512:
-  metadata.gz: f0839922dbbab96b6e580f5c63ca86d4b2789c6b3f771d0195c5251cb48e9c6ef3b23fccd22ebfe3fb8f603ba007836d073f71a33f876af85a77f4e7e5a7d38d
-  data.tar.gz: 3f608c82265282b14e5c1af278e3b38fefb9830005ea0bf3c9517c552dc5a76e5c10052f684f056a180db45f7d5599a2bc4b12d25ef4901c2ab3858f73272ef5
+  metadata.gz: 44849946ede47b60e85c1fc53c91ba6cc58c04e218a03ca15e6a41fb33b94cda982af279fa68aaa537512a660b502ca05e31e37df89b79d5b2b84882368b7755
+  data.tar.gz: c52f5c7de68dc7369976056b08357198405e6fcea846cb87abeea94fe5b51040ee6ff067b4b725c9a296c14f46a8014bc52649d63fc96c6edc32ad674aec14da

data/.github/workflows/ruby.yml

@@ -0,0 +1,37 @@
+# This workflow uses actions that are not certified by GitHub.
+# They are provided by a third-party and are governed by
+# separate terms of service, privacy policy, and support
+# documentation.
+# This workflow will download a prebuilt Ruby version, install dependencies and run tests with Rake
+# For more information see: https://github.com/marketplace/actions/setup-ruby-jruby-and-truffleruby
+
+name: Ruby
+
+on:
+  push:
+    branches: [ "master" ]
+  pull_request:
+    branches: [ "master" ]
+
+permissions:
+  contents: read
+
+jobs:
+  test:
+
+    runs-on: ubuntu-22.04
+    strategy:
+      matrix:
+        ruby-version: ['3.0', '3.1', '3.2']
+
+    steps:
+      - uses: actions/checkout@v4
+      - name: Set up Ruby
+        uses: ruby/setup-ruby@v1
+        with:
+          ruby-version: ${{ matrix.ruby-version }}
+          bundler-cache: true # runs 'bundle install' and caches installed gems automatically
+      - name: Run tests
+        run: bundle exec rake
+      - name: Run linter
+        run: bundle exec rubocop

data/.rubocop.yml

@@ -1,6 +1,8 @@
-Style/Documentation:
-  Enabled: false
+require:
+  - rubocop-minitest
+  - rubocop-rake
 
-Metrics/LineLength:
-  Enabled: true
-  Max: 100
+inherit_from: .rubocop_todo.yml
+
+AllCops:
+  NewCops: enable

data/.rubocop_todo.yml

@@ -0,0 +1,66 @@
+# This configuration was generated by
+# `rubocop --auto-gen-config`
+# on 2023-10-24 20:10:00 UTC using RuboCop version 1.57.1.
+# The point is for the user to remove these configuration records
+# one by one as the offenses are removed from the code base.
+# Note that changes in the inspected code, or installation of new
+# versions of RuboCop, may require this file to be generated again.
+
+# Offense count: 7
+# Configuration parameters: EnforcedStyle, AllowedGems, Include.
+# SupportedStyles: Gemfile, gems.rb, gemspec
+# Include: **/*.gemspec, **/Gemfile, **/gems.rb
+Gemspec/DevelopmentDependencies:
+  Exclude:
+    - 'polish_invoicer.gemspec'
+
+# Offense count: 1
+# Configuration parameters: Severity, Include.
+# Include: **/*.gemspec
+Gemspec/RequiredRubyVersion:
+  Exclude:
+    - 'polish_invoicer.gemspec'
+
+# Offense count: 1
+# This cop supports safe autocorrection (--autocorrect).
+# Configuration parameters: AllowForAlignment.
+Layout/CommentIndentation:
+  Exclude:
+    - 'lib/polish_invoicer/invoice.rb'
+
+# Offense count: 12
+# Configuration parameters: AllowedMethods, AllowedPatterns, CountRepeatedAttributes.
+Metrics/AbcSize:
+  Max: 32
+
+# Offense count: 4
+# Configuration parameters: CountComments, CountAsOne.
+Metrics/ClassLength:
+  Max: 196
+
+# Offense count: 14
+# Configuration parameters: CountComments, CountAsOne, AllowedMethods, AllowedPatterns.
+Metrics/MethodLength:
+  Max: 20
+
+# Offense count: 11
+Minitest/MultipleAssertions:
+  Max: 12
+
+# Offense count: 5
+# Configuration parameters: AllowedConstants.
+Style/Documentation:
+  Exclude:
+    - 'spec/**/*'
+    - 'test/**/*'
+    - 'lib/polish_invoicer/invoice.rb'
+    - 'lib/polish_invoicer/presenter.rb'
+    - 'lib/polish_invoicer/validator.rb'
+    - 'lib/polish_invoicer/vat.rb'
+    - 'lib/polish_invoicer/writer.rb'
+
+# Offense count: 2
+Style/OpenStructUse:
+  Exclude:
+    - 'test/presenter_test.rb'
+    - 'test/validator_test.rb'

data/.ruby-version

@@ -0,0 +1 @@
+3.2.2

data/Gemfile

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 source 'https://rubygems.org'
 
 # Specify your gem's dependencies in polish_invoicer.gemspec

data/README.md

@@ -1,4 +1,4 @@
-# PolishInvoicer [![Code Climate](https://codeclimate.com/github/macuk/polish_invoicer.png)](https://codeclimate.com/github/macuk/polish_invoicer) [![Build Status](https://travis-ci.org/macuk/polish_invoicer.png?branch=master)](https://travis-ci.org/macuk/polish_invoicer)
+# PolishInvoicer [![Code Climate](https://codeclimate.com/github/macuk/polish_invoicer.png)](https://codeclimate.com/github/macuk/polish_invoicer)
 
 PolishInvoicer gem creates Polish invoices and proforms in HTML and PDF formats.
 

data/Rakefile

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require 'bundler/gem_tasks'
 require 'rake/testtask'
 

data/doc/invoice.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require 'polish_invoicer'
 
 invoice = PolishInvoicer::Invoice.new(

data/doc/proforma.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require 'polish_invoicer'
 
 invoice = PolishInvoicer::Invoice.new(

data/lib/polish_invoicer/invoice.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module PolishInvoicer
   class Invoice
     AVAILABLE_PARAMS = [
@@ -23,19 +25,22 @@ 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 | 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)
     ].freeze
 
-    attr_accessor(*AVAILABLE_PARAMS)
-    attr_accessor :template_path
-    attr_accessor :logger, :wkhtmltopdf_path, :wkhtmltopdf_command
+    attr_accessor(*AVAILABLE_PARAMS, :template_path, :logger, :wkhtmltopdf_path, :wkhtmltopdf_command)
 
     def initialize(params = {})
       set_defaults
       params.each do |k, v|
         raise "Nierozpoznany parametr #{k}" unless AVAILABLE_PARAMS.include?(k)
+
         send("#{k}=", v)
       end
       @validator = PolishInvoicer::Validator.new(self)
@@ -52,7 +57,8 @@ module PolishInvoicer
     # cena/wartość netto
     def net_value
       return price unless gross_price
-      price / (1 + Vat.to_i(vat) / 100.0)
+
+      price / (1 + (Vat.to_i(vat) / 100.0))
     end
 
     # kwota VAT
@@ -63,7 +69,8 @@ module PolishInvoicer
     # cena/wartość brutto
     def gross_value
       return price if gross_price
-      price + price * Vat.to_i(vat) / 100.0
+
+      price + (price * Vat.to_i(vat) / 100.0)
     end
 
     def save_to_html(path)
@@ -97,6 +104,14 @@ module PolishInvoicer
       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
@@ -114,6 +129,7 @@ module PolishInvoicer
 
     def validate!
       return if valid?
+
       error_messages = errors.map { |k, v| "#{k}: #{v}" }.join(', ')
       raise "Parametry do wystawienia faktury są nieprawidłowe: #{error_messages}"
     end

data/lib/polish_invoicer/presenter.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module PolishInvoicer
   class Presenter
     attr_accessor :invoice
@@ -40,6 +42,7 @@ module PolishInvoicer
       %w[trade_date create_date payment_date].each do |field|
         v = @invoice.send(field)
         next unless v
+
         @out[field.to_sym] = v.strftime '%d.%m.%Y'
       end
     end
@@ -48,7 +51,8 @@ module PolishInvoicer
       %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('.', ',')
+
+        @out[field.to_sym] = format('%02.2f', v).tr('.', ',')
       end
     end
 

data/lib/polish_invoicer/validator.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module PolishInvoicer
   class Validator
     attr_reader :errors
@@ -20,6 +22,7 @@ module PolishInvoicer
       check_proforma
       check_create_and_payment_date
       check_currency
+      check_lang
       @errors.empty?
     end
 
@@ -40,7 +43,10 @@ module PolishInvoicer
     end
 
     def check_not_nil
-      @errors[:gross_price] = 'Konieczne jest ustawienie znacznika rodzaju ceny (netto/brutto)' if @invoice.gross_price.nil?
+      if @invoice.gross_price.nil?
+        @errors[:gross_price] =
+          'Konieczne jest ustawienie znacznika rodzaju ceny (netto/brutto)'
+      end
       @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?
@@ -55,18 +61,17 @@ module PolishInvoicer
       unless [true, false].include?(@invoice.gross_price)
         @errors[:gross_price] = 'Znacznik rodzaju ceny musi być podany jako boolean'
       end
-      unless [true, false].include?(@invoice.paid)
-        @errors[:paid] = 'Znacznik opłacenia faktury musi być podany jako boolean'
-      end
+      @errors[:paid] = 'Znacznik opłacenia faktury musi być podany jako boolean' unless [true,
+                                                                                         false].include?(@invoice.paid)
       unless [true, false].include?(@invoice.proforma)
         @errors[:proforma] = 'Znacznik faktury pro-forma musi być podany jako boolean'
       end
       unless [true, false].include?(@invoice.foreign_buyer)
         @errors[:foreign_buyer] = 'Znacznik zagranicznego nabywcy musi być podany jako boolean'
       end
-      unless [true, false].include?(@invoice.reverse_charge)
-        @errors[:reverse_charge] = 'Znacznik odwrotnego obciążenia VAT 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
 
     def check_dates
@@ -77,7 +82,7 @@ module PolishInvoicer
 
     def check_price
       if @invoice.price.is_a?(Numeric)
-        @errors[:price] = 'Cena musi być liczbą dodatnią' unless @invoice.price > 0
+        @errors[:price] = 'Cena musi być liczbą dodatnią' unless @invoice.price.positive?
       else
         @errors[:price] = 'Cena musi być liczbą'
       end
@@ -89,7 +94,10 @@ module PolishInvoicer
 
       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
+        unless @invoice.price_paid <= @invoice.price
+          @errors[:price_paid] =
+            'Kwota zapłacona musi być mniejsza lub równa cenie'
+        end
       else
         @errors[:price_paid] = 'Kwota zapłacona musi być liczbą'
       end
@@ -108,6 +116,7 @@ module PolishInvoicer
     def check_proforma
       return unless @invoice.proforma
       return unless @invoice.paid
+
       @errors[:paid] = 'Proforma nie może być opłacona'
     end
 
@@ -115,15 +124,24 @@ module PolishInvoicer
       return if @errors[:create_date]
       return if @errors[:payment_date]
       return if @invoice.create_date <= @invoice.payment_date
+
       @errors[:payment_date] = 'Termin płatności nie może być wcześniejszy niż data wystawienia'
     end
 
     def check_currency
       return if @errors[:currency]
       return if %w[PLN EUR USD GBP].include?(@invoice.currency)
+
       @errors[:currency] = 'Nieznana waluta'
     end
 
+    def check_lang
+      return if blank?(@invoice.lang)
+      return if %w[pl pl_en en es].include?(@invoice.lang)
+
+      @errors[:lang] = 'Nieznany język'
+    end
+
     def blank?(value)
       value.to_s.strip == ''
     end

data/lib/polish_invoicer/vat.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module PolishInvoicer
   class Vat
     def self.rates
@@ -6,6 +8,7 @@ module PolishInvoicer
 
     def self.valid?(rate)
       return true if zw?(rate)
+
       rates.include?(rate)
     end
 
@@ -16,6 +19,7 @@ module PolishInvoicer
 
     def self.to_s(rate)
       return 'zw.' if zw?(rate)
+
       "#{rate}%"
     end
 

data/lib/polish_invoicer/version.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module PolishInvoicer
-  VERSION = '0.0.25'.freeze
+  VERSION = '0.0.28'
 end

data/lib/polish_invoicer/writer.rb

@@ -1,7 +1,8 @@
+# frozen_string_literal: true
+
 module PolishInvoicer
   class Writer
-    attr_accessor :invoice
-    attr_accessor :logger, :wkhtmltopdf_path, :wkhtmltopdf_command
+    attr_accessor :invoice, :logger, :wkhtmltopdf_path, :wkhtmltopdf_command
 
     def initialize(invoice)
       @invoice = invoice
@@ -21,11 +22,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/lib/polish_invoicer.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require 'date'
 require 'pathname'
 

data/polish_invoicer.gemspec

@@ -1,4 +1,7 @@
-lib = File.expand_path('../lib', __FILE__)
+# frozen_string_literal: true
+
+require 'English'
+lib = File.expand_path('lib', __dir__)
 $LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
 require 'polish_invoicer/version'
 
@@ -12,16 +15,18 @@ Gem::Specification.new do |spec|
   spec.homepage      = ''
   spec.license       = 'MIT'
 
-  spec.files         = `git ls-files`.split($/)
+  spec.files         = `git ls-files`.split($INPUT_RECORD_SEPARATOR)
   spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
-  spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
   spec.require_paths = ['lib']
+  spec.metadata['rubygems_mfa_required'] = 'true'
 
   spec.add_development_dependency 'bundler'
-  spec.add_development_dependency 'rake'
   spec.add_development_dependency 'minitest'
-  spec.add_development_dependency 'simplecov'
+  spec.add_development_dependency 'rake'
   spec.add_development_dependency 'rubocop'
+  spec.add_development_dependency 'rubocop-minitest'
+  spec.add_development_dependency 'rubocop-rake'
+  spec.add_development_dependency 'simplecov'
 
   spec.add_dependency 'slim2pdf'
 end