polish_invoicer 0.0.26 → 0.0.28

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 802e9cbe1c6b7ab58930b191e60ccab3655e9eb53b21d04eb657af483cca946b
-  data.tar.gz: 5b352fff7ac09baa01e2b8120b18fd4e665e507c5887266b6fe355e5f0285c9d
+  metadata.gz: 80d547e5b447b0bdd6116f666ebc332a8e586cdc0513da03d75f69d83219253c
+  data.tar.gz: 988303b13fe261a44aa22cf1141ee18c834b5f8ba813f117b14596f552c97700
 SHA512:
-  metadata.gz: 86879c72be1a1e96e436863823192e00b933db64a9f9e2389a065bdb6211c87b2fd2cdacbc6e82aef44e9b582436199eceea73ade75cfc3d8e0fc1ad3b4f2c2a
-  data.tar.gz: 06bebb6a1a4743d5cb607332697d4b7bfbc80b7639c235358e363d356a0b3a63ae89892eaaafcc089f367925f98ad29f3e77f2ff4086062ab382cc9bd79ba945
+  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 = [
@@ -26,20 +28,19 @@ module PolishInvoicer
       :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
+                          # 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)
@@ -56,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
@@ -67,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)
@@ -126,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
@@ -41,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?
@@ -56,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
@@ -78,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
@@ -90,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
@@ -109,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
 
@@ -116,18 +124,20 @@ 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].include?(@invoice.lang)
+      return if %w[pl pl_en en es].include?(@invoice.lang)
 
       @errors[:lang] = 'Nieznany język'
     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.26'.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

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

data/test/invoice_test.rb

@@ -1,14 +1,18 @@
+# frozen_string_literal: true
+
 require 'test_helper'
 
 module PolishInvoicer
   class InvoiceTest < Minitest::Test
     def test_init
       i = Invoice.new
-      assert i.is_a?(Invoice)
+
+      assert_kind_of Invoice, i
     end
 
     def test_set_available_param
       i = Invoice.new(number: '1/2014')
+
       assert_equal '1/2014', i.number
     end
 
@@ -18,86 +22,111 @@ module PolishInvoicer
 
     def test_validation_delegation
       i = Invoice.new
-      assert_equal false, i.valid?
+
+      refute_predicate i, :valid?
       assert i.errors[:number]
       i.number = '1/2014'
       i.valid?
+
       assert_nil i.errors[:number]
     end
 
     def test_net_value
       i = Invoice.new(price: 123.45, gross_price: false)
       i.vat = 23
+
       assert_in_delta 123.45, i.net_value, 0.01
 
       i.gross_price = true
       i.vat = 23
+
       assert_in_delta 100.37, i.net_value, 0.01
       i.vat = 5.5
+
       assert_in_delta 117.01, i.net_value, 0.01
       i.vat = 0
+
       assert_in_delta 123.45, i.net_value, 0.01
       i.vat = -1
+
       assert_in_delta 123.45, i.net_value, 0.01
 
       i.gross_price = false
       i.vat = 0
+
       assert_in_delta 123.45, i.net_value, 0.01
       i.vat = -1
+
       assert_in_delta 123.45, i.net_value, 0.01
       i.vat = 5.5
+
       assert_in_delta 123.45, i.net_value, 0.01
     end
 
     def test_vat_value
       i = Invoice.new(price: 123.45, gross_price: false)
       i.vat = 23
+
       assert_in_delta 28.39, i.vat_value, 0.01
       i.vat = 5.5
+
       assert_in_delta 6.79, i.vat_value, 0.01
 
       i.gross_price = true
       i.vat = 23
+
       assert_in_delta 23.08, i.vat_value, 0.01
       i.vat = 5.5
+
       assert_in_delta 6.44, i.vat_value, 0.01
       i.vat = 0
-      assert_equal 0.00, i.vat_value
+
+      assert_in_delta(0.00, i.vat_value)
       i.vat = -1
-      assert_equal 0.00, i.vat_value
+
+      assert_in_delta(0.00, i.vat_value)
     end
 
     def test_gross_value
       i = Invoice.new(price: 123.45, gross_price: false)
       i.vat = 23
+
       assert_in_delta 151.84, i.gross_value, 0.01
 
       i.gross_price = true
       i.vat = 23
+
       assert_in_delta 123.45, i.gross_value, 0.01
       i.vat = 5.5
+
       assert_in_delta 123.45, i.gross_value, 0.01
       i.vat = 0
+
       assert_in_delta 123.45, i.gross_value, 0.01
       i.vat = -1
+
       assert_in_delta 123.45, i.gross_value, 0.01
 
       i.gross_price = false
       i.vat = 5.5
+
       assert_in_delta 130.24, i.gross_value, 0.01
       i.vat = 0
+
       assert_in_delta 123.45, i.gross_value, 0.01
       i.vat = -1
+
       assert_in_delta 123.45, i.gross_value, 0.01
     end
 
     def test_defaults
       i = Invoice.new
+
       assert i.gross_price
-      assert 23, i.vat
-      assert 'Przelew', i.payment_type
+      assert_equal 23, i.vat
+      assert_equal 'Przelew', i.payment_type
       assert i.paid
-      assert_equal false, i.proforma
+      refute i.proforma
     end
 
     def test_raise_when_save_to_html_and_not_valid
@@ -114,7 +143,8 @@ module PolishInvoicer
       i = create_valid_invoice
       path = '/tmp/test.html'
       i.save_to_html(path)
-      assert File.exist?(path)
+
+      assert_path_exists path
       File.unlink(path)
     end
 
@@ -122,15 +152,17 @@ module PolishInvoicer
       i = create_valid_invoice
       path = '/tmp/test.pdf'
       i.save_to_pdf(path)
-      assert File.exist?(path)
+
+      assert_path_exists path
       File.unlink(path)
     end
 
     def test_to_hash
       i = Invoice.new(price: 123.45, gross_price: false)
       h = i.to_hash
+
       assert h[:paid] # default
-      assert_equal false, h[:gross_price] # params
+      refute h[:gross_price] # params
       assert_equal '123,45', h[:net_value] # presenter
     end
 
@@ -159,6 +191,7 @@ module PolishInvoicer
 
     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
@@ -167,6 +200,7 @@ module PolishInvoicer
       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
@@ -177,6 +211,7 @@ module PolishInvoicer
 
     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
@@ -185,6 +220,7 @@ module PolishInvoicer
       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
@@ -195,34 +231,47 @@ module PolishInvoicer
 
     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