inss_calculator 0.4.0 → 0.4.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: a05163c92393153a574007ef8c0f932f0f203d94563ba4757c94b8250ae019b5
-  data.tar.gz: cc17641c475339eb14d34b8a66d6f691d5a16afc00773c2da021b742249a5d1c
+  metadata.gz: b0c5d044bf05b0f50ac8c9b4b6fe0634e0f809fd18918fd84a8a15a5fcbfd09a
+  data.tar.gz: 56906b9378630a07cb21ab2fab31caf77511a2808b78d347270ccde37df6ea08
 SHA512:
-  metadata.gz: 1dbe2a8d65e5c6c6bc96fc31a5bdafa456b5cb216bb8758b0076ba8651e5b44e73de7355a9bfd84b582d285c3be1b345aab4255838942a1739fb5045ad5c4da1
-  data.tar.gz: 42a4e83b651b23f20108dd414a93ac2ec308a8e03e686e13ab1c61f5b24c8e534d734ce5b55658a82c0e33a3634e428d63c57670091d0db3a87e893bed7c5f32
+  metadata.gz: 54a10e9bda6faff9e6ce0765aa5ae6ceb92dbd0fe333995312860acc68bb15a6c085eb0a17097a0937fdb56d392f4fb61f4912676ae77e80d2bfd387e17e244a
+  data.tar.gz: 1ed31865a00db8bd38a9b782bcd0d7cd2e899e3743b221de2de85e8ffcf391e3dfaa5fb7308d7763c0df02c777fbbbad1554ecf82a6bf61b087f39166c732cd3

data/.rubocop.yml

@@ -1,7 +1,8 @@
 AllCops:
   TargetRubyVersion: 3.2.2
   Include:
-    - 'lib/**/*.rb'
+    - 'lib/inss_calculator/*.rb'
+    - 'inss_calculator.rb'
 
 Style/StringLiterals:
   Enabled: true

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    inss_calculator (0.3.2)
+    inss_calculator (0.4.1)
 
 GEM
   remote: https://rubygems.org/
@@ -10,7 +10,7 @@ GEM
     diff-lcs (1.5.1)
     json (2.7.2)
     language_server-protocol (3.17.0.3)
-    parallel (1.26.0)
+    parallel (1.26.3)
     parser (3.3.4.2)
       ast (~> 2.4.1)
       racc

data/README.md

@@ -78,6 +78,21 @@ Desta forma, uma requisição que busca somente a primeira faixa salarial seria:
 YourModel.where("salary <= ?", InssCalculator::FIRST_SALARY_LIMIT)
 ```
 
+## Decorators
+
+`InssCalculator::Decorator::Text` explica no formato de texto o que o trabalhador precisa saber.
+Ideal para uso no parágrafo do HTML. Retire da view esta responsabildade e deixe com este decorator.
+Você ainda tem acesso à classe original com `#calculator`.
+
+```
+calculator = InssCalculator::DiscountPrevidenceCalculator.new(3000)
+text_decorator = InssCalculator::Decorator::Text.new(calculator)
+text_decorator.present => "Com o salário de R$ 3.000,00, sua contribuição é de R$ 258,81. Seu salário líquido, portanto, é de R$ 2.741,19."
+
+text_decorator.calculator => InssCalculator::DiscountPrevidenceCalculator.new(3000)
+
+```
+
 ## Nota sobre trabalhar com números decimais em Ruby
 
 Após investigar os resultados dos exemplos contábeis, concluiu-se que os números são truncados.

data/lib/dinheiro.rb

@@ -0,0 +1,303 @@
+# frozen_string_literal: true
+
+# Com base em https://github.com/tapajos/brazilian-rails/blob/master/brdinheiro/lib/brdinheiro/dinheiro.rb
+class Dinheiro
+  include Comparable
+
+  attr_reader :quantia
+
+  FORMATO_VALIDO_BR  = /^([R|r]\$\s*)?(([+-]?\d{1,3}(\.?\d{3})*))?(,\d{0,2})?$/
+  FORMATO_VALIDO_EUA = /^([R|r]\$\s*)?(([+-]?\d{1,3}(,?\d{3})*))?(\.\d{0,2})?$/
+  SEPARADOR_MILHAR = '.'
+  SEPARADOR_FRACIONARIO = ','
+  QUANTIDADE_DIGITOS = 3
+  PRECISAO_DECIMAL = 100
+
+  def initialize(quantia)
+    self.quantia = quantia
+  end
+
+  # Retorna o valor em Float quando uma coleção
+  # ou objeto é convertido para JSON
+  #
+  # Exemplo:
+  #  produto = Produto.find 1
+  #  produto.to_json // {"nome": "MacBook", "valor": 3500.0}
+  def as_json
+    to_f
+  end
+
+  # Retorna o valor armazenado em string.
+  #
+  # Exemplo:
+  #  1000.to_s ==> '1.000,00'
+  def to_s
+    inteiro_com_milhar(parte_inteira) + parte_decimal
+  end
+
+  # Compara com outro dinheiro se eh igual.
+  #
+  # Exemplo:
+  #  um_real = Dinheiro.new(1)
+  #  um_real == Dinheiro.new(1) ==> true
+  #  um_real == Dinheiro.new(2) ==> false
+  def ==(other)
+    begin
+      other = Dinheiro.new(other) unless other.is_a?(Dinheiro)
+    rescue StandardError
+      return false
+    end
+    @quantia == other.quantia
+  end
+
+  # Compara com outro dinheiro se eh maior ou menor.
+  #
+  # Exemplo:
+  #  1.real < 2.reais ==> true
+  #  1.real > 2.reais ==> false
+  #  2.real < 1.reais ==> false
+  #  2.real > 1.reais ==> true
+  def <=>(other)
+    other = Dinheiro.new(other) unless other.is_a?(Dinheiro)
+    @quantia <=> other.quantia
+  end
+
+  # Retorna a adicao entre dinheiros.
+  #
+  # Exemplo:
+  #  1.real + 1.real == 2.reais
+  #  1.real + 1 == 2.reais
+  def +(other)
+    Dinheiro.new(transforma_em_string_que_represente_a_quantia(@quantia + quantia_de(other)))
+  end
+
+  # Retorna a subtracao entre dinheiros.
+  #
+  # Exemplo:
+  #  10.reais - 2.reais == 8.reais
+  #  10.reais - 2 == 8.reais
+  def -(other)
+    Dinheiro.new(transforma_em_string_que_represente_a_quantia(@quantia - quantia_de(other)))
+  end
+
+  # Retorna a multiplicacao entre dinheiros.
+  #
+  # Exemplo:
+  #  5.reais * 2 == 10.reais
+  #  5.reais * 2.reais == 10.reais
+  def *(other)
+    return Dinheiro.new(to_f * other) unless other.is_a? Dinheiro
+
+    other * to_f
+  end
+
+  # Retorna a divisao entre dinheiros.
+  #
+  # Exemplo:
+  #  5.reais / 2 == (2.5).reais
+  #  5.reais / 2.reais == DivisaPorNaoEscalarError
+  #  5.reais / 0 == ZeroDivisionError
+  #
+  # Veja também o método parcelar
+  def /(other)
+    raise DivisaPorNaoEscalarError unless other.is_a?(Numeric)
+    return @quantia / other if other.zero?
+
+    Dinheiro.new(to_f / other)
+  end
+
+  # Retorna um array de dinheiro com as parcelas
+  #
+  # Exemplo:
+  #  6.reais.parcelar(2) == [3.reais, 3.reais]
+  #  6.reais.parcelar(2.reais) == DisivaPorNaoEscalarError
+  #  6.reais.parcelar(0) == ZeroDivisionError
+  def parcelar(numero_de_parcelar)
+    raise DivisaPorNaoEscalarError unless numero_de_parcelar.is_a?(Integer)
+
+    resto = @quantia % numero_de_parcelar
+    valor_menor = Dinheiro.new((@quantia / numero_de_parcelar) / 100.0)
+    valor_maior = Dinheiro.new((@quantia / numero_de_parcelar + 1) / 100.0)
+    [valor_menor] * (numero_de_parcelar - resto) + [valor_maior] * resto
+  end
+
+  # Escreve o valor por extenso.
+  #
+  # Exemplo:
+  #  1.real.to_extenso ==> 'um real'
+  #  (100.58).to_extenso ==> 'cem reais e cinquenta e oito centavos'
+  def to_extenso
+    (@quantia / 100.0).por_extenso_em_reais
+  end
+
+  # Alias para o metodo to_extenso.
+  alias por_extenso to_extenso
+
+  # Alias para o metodo to_extenso.
+  alias por_extenso_em_reais to_extenso
+
+  # Verifica se o valor é zero.
+  def zero?
+    to_f.zero?
+  end
+
+  # Retorna um Float.
+  def to_f
+    to_s.gsub('.', '').gsub(',', '.').to_f
+  end
+
+  def coerce(outro) # :nodoc:
+    [Dinheiro.new(outro), self]
+  end
+
+  # Retorna a própria instância/
+  def real
+    self
+  end
+
+  # Alias para real.
+  alias reais real
+
+  # Retorna uma string formatada com sigla em valor monetário.
+  # Exemplo:
+  #  Dinheiro.new(1).real_formatado ==> 'R$ 1,00'
+  #  Dinheiro.new(-1).real_formatado ==> 'R$ -1,00'
+  def real_formatado
+    "R$ #{self}"
+  end
+
+  # Alias para real_formatado.
+  alias reais_formatado real_formatado
+
+  # Retorna uma string formatada com sigla em valor contábil.
+  #
+  # Exemplo:
+  #  Dinheiro.new(1).real_contabil ==> 'R$ 1,00'
+  #  Dinheiro.new(-1).real_contabil ==> 'R$ (1,00)'
+  def real_contabil
+    "R$ #{contabil}"
+  end
+
+  # Alias para real_contabil.
+  alias reais_contabeis real_contabil
+
+  # Retorna uma string formatada sem sigla.
+  #
+  # Exemplo:
+  #  Dinheiro.new(1).contabil ==> '1,00'
+  #  Dinheiro.new(-1).contabil ==> '(1,00)'
+  def contabil
+    if @quantia >= 0
+      to_s
+    else
+      "(#{to_s[1..]})"
+    end
+  end
+
+  # Method missing para retorna um BigDecinal quando chamada .
+  def method_missing(symbol, *args) # :nodoc:
+    # Ex: Chama ao método valor_decimal()
+    if (symbol.to_s =~ /^(.*)_decimal$/) && args.empty?
+      BigDecimal quantia_sem_separacao_milhares.gsub(',', '.')
+    else
+      super.method_missing(symbol, *args)
+    end
+  end
+
+  private
+
+  def quantia_de(outro)
+    outro = outro.to_f if outro.is_a?(BigDecimal)
+    return outro.quantia if outro.is_a?(Dinheiro)
+
+    (outro * 100).round
+  end
+
+  def transforma_em_string_que_represente_a_quantia(quantia)
+    if /^([+-]?)(\d)$/ =~ quantia.to_s
+      return "#{::Regexp.last_match(1)}0.0#{::Regexp.last_match(2)}"
+    end
+
+    /^([+-]?)(\d*)(\d\d)$/ =~ quantia.to_s
+    "#{::Regexp.last_match(1)}#{::Regexp.last_match(2).to_i}.#{::Regexp.last_match(3)}"
+  end
+
+  def quantia=(quantia)
+    @quantia = (quantia * 100).round if quantia.is_a?(Numeric)
+    @quantia = extrai_quantia_como_inteiro(quantia) if quantia.is_a?(String)
+  end
+
+  def parte_inteira
+    quantia_sem_separacao_milhares[0, quantia_sem_separacao_milhares.length - QUANTIDADE_DIGITOS]
+  end
+
+  def parte_decimal
+    quantia_sem_separacao_milhares[-QUANTIDADE_DIGITOS, QUANTIDADE_DIGITOS]
+  end
+
+  def inteiro_com_milhar(inteiro)
+    return inteiro if quantidade_de_passos(inteiro).zero?
+
+    resultado = ''
+    quantidade_de_passos(inteiro).times do |passo|
+      resultado = ".#{inteiro[-QUANTIDADE_DIGITOS + passo * -QUANTIDADE_DIGITOS, QUANTIDADE_DIGITOS]}#{resultado}"
+    end
+    resultado = inteiro[0, digitos_que_sobraram(inteiro)] + resultado
+    resultado.gsub(/^(-?)\./, '\1')
+  end
+
+  def quantia_sem_separacao_milhares
+    format('%.2f', (@quantia.to_f / PRECISAO_DECIMAL)).gsub(SEPARADOR_MILHAR, SEPARADOR_FRACIONARIO)
+  end
+
+  def quantidade_de_passos(inteiro)
+    resultado = inteiro.length / QUANTIDADE_DIGITOS
+    resultado = (resultado - 1) if (inteiro.length % QUANTIDADE_DIGITOS).zero?
+    resultado
+  end
+
+  def digitos_que_sobraram(inteiro)
+    inteiro.length - (quantidade_de_passos(inteiro) * QUANTIDADE_DIGITOS)
+  end
+
+  def quantia_valida?(quantia)
+    return false if quantia.is_a?(String) && !quantia_respeita_formato?(quantia)
+
+    quantia.is_a?(String) || quantia.is_a?(Numeric)
+  end
+
+  def extrai_quantia_como_inteiro(quantia)
+    return sem_milhar(::Regexp.last_match(2), ::Regexp.last_match(5), '.') if FORMATO_VALIDO_BR =~ quantia
+    return unless FORMATO_VALIDO_EUA =~ quantia
+
+    sem_milhar(::Regexp.last_match(2), ::Regexp.last_match(5), ',')
+  end
+
+  def sem_milhar(parte_inteira, parte_decimal, delimitador_de_milhar)
+    (inteiro(parte_inteira, delimitador_de_milhar) + decimal(parte_decimal)).to_i
+  end
+
+  def inteiro(inteiro_com_separador_milhar, separador)
+    return inteiro_com_separador_milhar.gsub(separador, '') unless inteiro_com_separador_milhar.blank?
+
+    ''
+  end
+
+  def decimal(parte_fracionaria)
+    unless parte_fracionaria.blank?
+      return sem_delimitador_decimal(parte_fracionaria) if parte_fracionaria.length == 3
+      return "#{sem_delimitador_decimal(parte_fracionaria)}0" if parte_fracionaria.length == 2
+    end
+    '00'
+  end
+
+  def sem_delimitador_decimal(parte_fracionaria)
+    parte_fracionaria.to_s.gsub(/[.|,]/, '')
+  end
+
+  def quantia_respeita_formato?(quantia)
+    return true if FORMATO_VALIDO_BR.match(quantia) || FORMATO_VALIDO_EUA.match(quantia)
+
+    false
+  end
+end

data/lib/inss_calculator/decorator/text.rb

@@ -0,0 +1,43 @@
+# frozen_string_literal: true
+
+module InssCalculator
+  # It extends Calculator contribution to a presentable format.
+  module Decorator
+    require 'forwardable'
+    # InssCalculator::Decorator::Text implements the same Calculator interface
+    # and its #present method presents the contribution result in a text format.
+    class Text
+      extend Forwardable
+
+      def_delegators :@calculator, :salary, :net_salary
+
+      attr_reader :calculator
+
+      def initialize(inss_calculator)
+        @calculator = inss_calculator
+      end
+
+      def contribution
+        Dinheiro.new(calculator.contribution).real_formatado
+      end
+
+      def present
+        "#{salary_text} #{contribution_text} #{net_salary_text}"
+      end
+
+      private
+
+      def salary_text
+        "Com o salário de #{Dinheiro.new(calculator.salary).real_formatado},"
+      end
+
+      def contribution_text
+        "sua contribuição é de #{Dinheiro.new(calculator.contribution).real_formatado}."
+      end
+
+      def net_salary_text
+        "Seu salário líquido, portanto, é de #{Dinheiro.new(calculator.net_salary).real_formatado}."
+      end
+    end
+  end
+end

data/lib/inss_calculator/discount_previdence_calculator.rb

@@ -22,5 +22,9 @@ module InssCalculator
     def net_salary
       (salary - contribution).round(2)
     end
+
+    def present
+      raise InssCalculator::NoMethodError, message: 'Use a decorator instead!'
+    end
   end
 end

data/lib/inss_calculator/error/no_method_error.rb

@@ -0,0 +1,5 @@
+module InssCalculator
+  class NoMethodError < InssCalculator::Error
+  end
+end
+

data/lib/inss_calculator/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module InssCalculator
-  VERSION = '0.4.0'
+  VERSION = '0.4.2'
 end

data/lib/inss_calculator.rb

@@ -1,6 +1,7 @@
 # frozen_string_literal: true
 
 require_relative 'inss_calculator/version'
+require_relative './dinheiro'
 require_relative 'inss_calculator/discount_calculator_base'
 require_relative 'inss_calculator/discount_previdence_calculator'
 require_relative 'inss_calculator/public_inss_calculator'
@@ -12,6 +13,7 @@ require_relative 'inss_calculator/fifth_discount_calculator'
 require_relative 'inss_calculator/sixth_discount_calculator'
 require_relative 'inss_calculator/seventh_discount_calculator'
 require_relative 'inss_calculator/eigth_discount_calculator'
+require_relative 'inss_calculator/decorator/text'
 
 module InssCalculator
   class Error < StandardError; end
@@ -40,3 +42,5 @@ module InssCalculator
   EIGTH_SALARY_BASE = 52_000.55
   EIGTH_SALARY_LIMIT = Float::INFINITY
 end
+
+require_relative 'inss_calculator/error/no_method_error'

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: inss_calculator
 version: !ruby/object:Gem::Version
-  version: 0.4.0
+  version: 0.4.2
 platform: ruby
 authors:
 - Paulo Felipe Souza
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2024-08-08 00:00:00.000000000 Z
+date: 2025-01-19 00:00:00.000000000 Z
 dependencies: []
 description: Calcula o valor a descontar de acordo com a faixa salarial. Os novos
   valores corrente em 2024.
@@ -29,10 +29,13 @@ files:
 - README.md
 - Rakefile
 - inss_calculator.gemspec
+- lib/dinheiro.rb
 - lib/inss_calculator.rb
+- lib/inss_calculator/decorator/text.rb
 - lib/inss_calculator/discount_calculator_base.rb
 - lib/inss_calculator/discount_previdence_calculator.rb
 - lib/inss_calculator/eigth_discount_calculator.rb
+- lib/inss_calculator/error/no_method_error.rb
 - lib/inss_calculator/fifth_discount_calculator.rb
 - lib/inss_calculator/first_discount_calculator.rb
 - lib/inss_calculator/fourth_discount_calculator.rb