boleto_bancario 0.0.2 → 1.0.0

data/lib/boleto_bancario/calculos/documento.rb

@@ -0,0 +1,191 @@
+# frozen_string_literal: true
+
+module BoletoBancario
+  module Calculos
+    # Classe responsável pela validação e formatação de documentos (CPF e CNPJ).
+    #
+    # === Validação de CPF
+    #
+    # O CPF possui 11 dígitos e é validado através de dois dígitos verificadores
+    # calculados pelo módulo 11.
+    #
+    # === Validação de CNPJ
+    #
+    # O CNPJ possui 14 dígitos e é validado através de dois dígitos verificadores
+    # calculados pelo módulo 11.
+    #
+    # @example Validação
+    #
+    #    Documento.valid?('111.444.777-35')
+    #    #=> true
+    #
+    #    Documento.valid?('11.222.333/0001-81')
+    #    #=> true
+    #
+    # @example Formatação
+    #
+    #    Documento.format('11144477735')
+    #    #=> '111.444.777-35'
+    #
+    #    Documento.format('11222333000181')
+    #    #=> '11.222.333/0001-81'
+    #
+    class Documento
+      CPF_SIZE = 11
+      CNPJ_SIZE = 14
+
+      # CPF weights for first digit calculation
+      CPF_WEIGHTS_FIRST = [10, 9, 8, 7, 6, 5, 4, 3, 2].freeze
+
+      # CPF weights for second digit calculation
+      CPF_WEIGHTS_SECOND = [11, 10, 9, 8, 7, 6, 5, 4, 3, 2].freeze
+
+      # CNPJ weights for first digit calculation
+      CNPJ_WEIGHTS_FIRST = [5, 4, 3, 2, 9, 8, 7, 6, 5, 4, 3, 2].freeze
+
+      # CNPJ weights for second digit calculation
+      CNPJ_WEIGHTS_SECOND = [6, 5, 4, 3, 2, 9, 8, 7, 6, 5, 4, 3, 2].freeze
+
+      class << self
+        # Valida se o documento é um CPF ou CNPJ válido.
+        #
+        # @param [String] documento O documento a ser validado
+        # @return [Boolean] true se válido, false caso contrário
+        #
+        def valid?(documento)
+          return false if documento.blank?
+
+          digits = only_digits(documento)
+
+          case digits.size
+          when CPF_SIZE
+            valid_cpf?(digits)
+          when CNPJ_SIZE
+            valid_cnpj?(digits)
+          else
+            false
+          end
+        end
+
+        # Formata o documento com pontuação.
+        #
+        # @param [String] documento O documento a ser formatado
+        # @return [String] O documento formatado
+        #
+        def format(documento)
+          return documento if documento.blank?
+
+          digits = only_digits(documento)
+
+          case digits.size
+          when CPF_SIZE
+            format_cpf(digits)
+          when CNPJ_SIZE
+            format_cnpj(digits)
+          else
+            documento.to_s
+          end
+        end
+
+        # Verifica se o documento é um CPF.
+        #
+        # @param [String] documento O documento a ser verificado
+        # @return [Boolean]
+        #
+        def cpf?(documento)
+          only_digits(documento).size == CPF_SIZE
+        end
+
+        # Verifica se o documento é um CNPJ.
+        #
+        # @param [String] documento O documento a ser verificado
+        # @return [Boolean]
+        #
+        def cnpj?(documento)
+          only_digits(documento).size == CNPJ_SIZE
+        end
+
+        private
+
+        # Remove caracteres não numéricos.
+        #
+        # @param [String] value
+        # @return [String]
+        #
+        def only_digits(value)
+          value.to_s.gsub(/\D/, '')
+        end
+
+        # Valida um CPF.
+        #
+        # @param [String] digits Os 11 dígitos do CPF
+        # @return [Boolean]
+        #
+        def valid_cpf?(digits)
+          return false if invalid_sequence?(digits)
+
+          first_digit = calculate_digit(digits[0, 9], CPF_WEIGHTS_FIRST)
+          second_digit = calculate_digit(digits[0, 10], CPF_WEIGHTS_SECOND)
+
+          digits[9].to_i == first_digit && digits[10].to_i == second_digit
+        end
+
+        # Valida um CNPJ.
+        #
+        # @param [String] digits Os 14 dígitos do CNPJ
+        # @return [Boolean]
+        #
+        def valid_cnpj?(digits)
+          return false if invalid_sequence?(digits)
+
+          first_digit = calculate_digit(digits[0, 12], CNPJ_WEIGHTS_FIRST)
+          second_digit = calculate_digit(digits[0, 13], CNPJ_WEIGHTS_SECOND)
+
+          digits[12].to_i == first_digit && digits[13].to_i == second_digit
+        end
+
+        # Verifica se todos os dígitos são iguais (sequência inválida).
+        #
+        # @param [String] digits
+        # @return [Boolean]
+        #
+        def invalid_sequence?(digits)
+          digits.chars.uniq.size == 1
+        end
+
+        # Calcula um dígito verificador usando módulo 11.
+        #
+        # @param [String] digits Os dígitos base
+        # @param [Array<Integer>] weights Os pesos para multiplicação
+        # @return [Integer] O dígito calculado
+        #
+        def calculate_digit(digits, weights)
+          sum = digits.chars.each_with_index.sum do |digit, index|
+            digit.to_i * weights[index]
+          end
+
+          remainder = sum % 11
+          remainder < 2 ? 0 : 11 - remainder
+        end
+
+        # Formata CPF com pontuação.
+        #
+        # @param [String] digits
+        # @return [String]
+        #
+        def format_cpf(digits)
+          "#{digits[0, 3]}.#{digits[3, 3]}.#{digits[6, 3]}-#{digits[9, 2]}"
+        end
+
+        # Formata CNPJ com pontuação.
+        #
+        # @param [String] digits
+        # @return [String]
+        #
+        def format_cnpj(digits)
+          "#{digits[0, 2]}.#{digits[2, 3]}.#{digits[5, 3]}/#{digits[8, 4]}-#{digits[12, 2]}"
+        end
+      end
+    end
+  end
+end

data/lib/boleto_bancario/calculos/fator_vencimento.rb

@@ -1,33 +1,44 @@
-# encoding: utf-8
+# frozen_string_literal: true
+
 module BoletoBancario
   module Calculos
     # Classe responsável pelo cálculo de Fator de Vencimento do boleto bancário.
     #
-    # === Descricão
+    # === Descrição
     #
     # Conforme Carta-circular 002926 do Banco Central do Brasil, de 24/07/2000, recomenda-se a indicação do Fator de Vencimento no Código de Barras.
     # A partir de 02/04/2001, o Banco acolhedor/recebedor não será mais responsável por eventuais diferenças de recebimento de BOLETOs fora do prazo,
     # ou sem a indicação do fator de vencimento.
     #
+    # === Atualização FEBRABAN 2025
+    #
+    # Em 22/02/2025, o fator de vencimento atingiu o limite de 9999 (baseado em 07/10/1997).
+    # A partir desta data, o cálculo utiliza uma nova data base (29/05/2022) e reinicia em 1000.
+    #
     # === Forma para obtenção do Fator de Vencimento
     #
-    # Calcula-se <b>o número de dias corridos</b> entre a data base (<b>“Fixada” em 07/10/1997</b>) e a do vencimento desejado:
+    # Calcula-se <b>o número de dias corridos</b> entre a data base e a do vencimento desejado:
+    #
+    # Para datas anteriores a 22/02/2025:
+    #    Data base: 07/10/1997
+    #    Vencimento: 04/07/2000 => Fator: 1001
     #
-    #    Vencimento desejado:   04/07/2000
-    #    Data base          : - 07/10/1997
-    #    # => 1001
+    # Para datas a partir de 22/02/2025:
+    #    Data base: 29/05/2022
+    #    Fator inicial: 1000
+    #    Vencimento: 22/02/2025 => Fator: 1000
     #
     # === Atenção
     #
-    # Caso ocorra divergência entre a data impressa no campo “data de vencimento” e a constante no código de barras,
+    # Caso ocorra divergência entre a data impressa no campo "data de vencimento" e a constante no código de barras,
     # o recebimento se dará da seguinte forma:
     #
-    # * Quando pago por sistemas eletrônicos (Home-Banking, Auto-Atendimento, Internet, SISPAG, telefone, etc.), prevalecerá à representada no “código de barras”;
-    # * Quando quitado na rede de agências, diretamente no caixa, será considerada a data impressa no campo “vencimento” do BOLETO.
+    # * Quando pago por sistemas eletrônicos (Home-Banking, Auto-Atendimento, Internet, SISPAG, telefone, etc.), prevalecerá à representada no "código de barras";
+    # * Quando quitado na rede de agências, diretamente no caixa, será considerada a data impressa no campo "vencimento" do BOLETO.
     #
     # @return [String] retorna o resultado do cálculo. <b>Deve conter 4 dígitos</b>.
     #
-    # @example
+    # @example Datas anteriores à transição
     #
     #    FatorVencimento.new(Date.parse("2012-12-02"))
     #    #=> "5535"
@@ -35,51 +46,87 @@ module BoletoBancario
     #    FatorVencimento.new(Date.parse("1997-10-08"))
     #    #=> "0001"
     #
-    #    FatorVencimento.new(Date.parse("2012-12-16"))
-    #    #=> "5549"
+    # @example Datas após a transição FEBRABAN 2025
     #
-    #    FatorVencimento.new(Date.parse("2014-12-15"))
-    #    #=> "6278"
+    #    FatorVencimento.new(Date.parse("2025-02-21"))
+    #    #=> "9999"
+    #
+    #    FatorVencimento.new(Date.parse("2025-02-22"))
+    #    #=> "1000"
+    #
+    #    FatorVencimento.new(Date.parse("2025-02-23"))
+    #    #=> "1001"
     #
     class FatorVencimento < String
+      # Data base original utilizada até 21/02/2025
+      OLD_BASE_DATE = Date.new(1997, 10, 7).freeze
+
+      # Nova data base utilizada a partir de 22/02/2025
+      NEW_BASE_DATE = Date.new(2022, 5, 29).freeze
+
+      # Data de transição para o novo cálculo
+      TRANSITION_DATE = Date.new(2025, 2, 22).freeze
+
+      # Fator inicial para a nova data base
+      NEW_BASE_FACTOR = 1000
+
       attr_reader :base_date
-      # @param [Date] expiration_date
-      # @param [Date] base_date
+
+      # @param [Date] expiration_date Data de vencimento do boleto
+      # @param [Date] base_date Data base para cálculo (opcional, determinado automaticamente)
       # @return [String] retorna o resultado do cálculo. <b>Deve conter 4 dígitos</b>.
-      # @example
-      #    FatorVencimento.new(Date.parse("2012-09-02"))
-      #    #=> "5444"
-      #
-      #    FatorVencimento.new(Date.parse("1999-10-01"))
-      #    #=> "0724"
       #
-      #    FatorVencimento.new(Date.parse("2022-12-16"))
-      #    #=> "9201"
+      # @example
+      #    FatorVencimento.new(Date.parse("2025-03-01"))
+      #    #=> "1007"
       #
-      def initialize(expiration_date, base_date = Date.new(1997, 10, 7))
-        @base_date       = base_date
+      def initialize(expiration_date, base_date = nil)
         @expiration_date = expiration_date
+        @base_date = base_date || determine_base_date
 
         if @expiration_date.present?
           super(calculate)
+        else
+          super()
         end
       end
 
       # Cálculo da data de vencimento com a data base.
+      # Para ambos os períodos, o fator é simplesmente o número de dias desde a data base.
+      # A nova data base (29/05/2022) foi escolhida para que 22/02/2025 resulte em fator 1000.
       #
       # @return [String] exatamente 4 dígitos
       #
       def calculate
-        expiration_date_minus_base_date.to_s.rjust(4, '0')
+        days_from_base.to_s.rjust(4, '0')
       end
 
-      # @api private
+      private
+
+      # Determina qual data base usar com base na data de vencimento
       #
-      # Cálculo da data de vencimento com a data base.
+      # @return [Date] a data base apropriada
+      #
+      def determine_base_date
+        return OLD_BASE_DATE unless @expiration_date
+
+        uses_new_calculation? ? NEW_BASE_DATE : OLD_BASE_DATE
+      end
+
+      # Verifica se deve usar o novo cálculo (pós-transição FEBRABAN)
+      #
+      # @return [Boolean]
+      #
+      def uses_new_calculation?
+        @expiration_date.is_a?(Date) && @expiration_date >= TRANSITION_DATE
+      end
+
+      # Calcula a diferença em dias entre a data de vencimento e a data base.
       # Chamando #to_i para não retornar um Float.
-      # @return [Integer] diff between this two dates.
       #
-      def expiration_date_minus_base_date
+      # @return [Integer] diferença em dias
+      #
+      def days_from_base
         (@expiration_date - @base_date).to_i
       end
     end

data/lib/boleto_bancario/core/boleto.rb

@@ -1,4 +1,5 @@
-# encoding: utf-8
+# frozen_string_literal: true
+
 module BoletoBancario
   module Core
     # @abstract Métodos { #codigo_banco, #digito_codigo_banco, #agencia_codigo_cedente, #nosso_numero, #codigo_de_barras_do_banco}
@@ -502,6 +503,34 @@ module BoletoBancario
         false
       end
 
+      # Renderiza o boleto em formato PDF.
+      #
+      # @return [String] Conteúdo binário do PDF
+      # @raise [ArgumentError] Se o boleto não for válido
+      #
+      def to_pdf
+        Renderers::PdfRenderer.new(self).render
+      end
+
+      # Renderiza o boleto em formato HTML.
+      #
+      # @return [String] Conteúdo HTML do boleto
+      # @raise [ArgumentError] Se o boleto não for válido
+      #
+      def to_html
+        Renderers::HtmlRenderer.new(self).render
+      end
+
+      # Renderiza o código de barras em formato PNG.
+      #
+      # @param [Hash] options Opções para o renderizador PNG
+      # @return [String] Conteúdo binário do PNG
+      # @raise [ArgumentError] Se o boleto não for válido
+      #
+      def to_png(options = {})
+        Renderers::PngRenderer.new(self, options).render
+      end
+
       # Método usado para verificar se deve realizar a validação de tamanho do campo 'agência'.
       # <b>Sobrescreva esse método na subclasse, caso você mesmo queira fazer as validações</b>.
       #

data/lib/boleto_bancario/core/c6_bank.rb

@@ -0,0 +1,155 @@
+# frozen_string_literal: true
+
+module BoletoBancario
+  module Core
+    # Implementação de emissão de boleto bancário pelo C6 Bank.
+    #
+    # === Documentação Implementada
+    #
+    # A documentação na qual essa implementação foi baseada está localizada na pasta
+    # 'documentacoes_dos_boletos/c6_bank' dentro dessa biblioteca.
+    #
+    # === Contrato das classes de emissão de boletos
+    #
+    # Para ver o "<b>contrato</b>" da Emissão de Boletos veja a classe BoletoBancario::Core::Boleto.
+    #
+    # === Carteiras suportadas
+    #
+    # O C6 Bank trabalha com carteira de cobrança registrada.
+    #
+    #      ___________________________________________________________________________
+    #     | Carteira | Descrição                           | Testada/Homologada     |
+    #     |    1     | Cobrança Registrada                 | Esperando Contribuição |
+    #     ----------------------------------------------------------------------------
+    #
+    class C6Bank < Boleto
+      # Tamanho máximo de uma conta corrente no C6 Bank.
+      #
+      # @return [Integer] 10
+      #
+      def self.tamanho_maximo_conta_corrente
+        10
+      end
+
+      # Tamanho máximo de uma agência no C6 Bank.
+      #
+      # @return [Integer] 4
+      #
+      def self.tamanho_maximo_agencia
+        4
+      end
+
+      # Tamanho máximo do número do documento.
+      #
+      # @return [Integer] 11
+      #
+      def self.tamanho_maximo_numero_documento
+        11
+      end
+
+      # Tamanho máximo do código do cedente.
+      #
+      # @return [Integer] 10
+      #
+      def self.tamanho_maximo_codigo_cedente
+        10
+      end
+
+      # Carteiras suportadas pelo C6 Bank.
+      #
+      # @return [Array]
+      #
+      def self.carteiras_suportadas
+        %w[1]
+      end
+
+      validates :agencia, :conta_corrente, presence: true
+      validates :numero_documento, length: { maximum: tamanho_maximo_numero_documento }, if: :deve_validar_numero_documento?
+      validates :conta_corrente, length: { maximum: tamanho_maximo_conta_corrente }, if: :deve_validar_conta_corrente?
+      validates :agencia, length: { maximum: tamanho_maximo_agencia }, if: :deve_validar_agencia?
+      validates :carteira, inclusion: { in: ->(object) { object.class.carteiras_suportadas } }, if: :deve_validar_carteira?
+
+      # @return [String] Número do documento com 11 dígitos.
+      #
+      def numero_documento
+        @numero_documento.to_s.rjust(11, '0') if @numero_documento.present?
+      end
+
+      # @return [String] Agência com 4 dígitos.
+      #
+      def agencia
+        @agencia.to_s.rjust(4, '0') if @agencia.present?
+      end
+
+      # @return [String] Conta corrente com 10 dígitos.
+      #
+      def conta_corrente
+        @conta_corrente.to_s.rjust(10, '0') if @conta_corrente.present?
+      end
+
+      # @return [String] Código do cedente com 10 dígitos.
+      #
+      def codigo_cedente
+        @codigo_cedente.to_s.rjust(10, '0') if @codigo_cedente.present?
+      end
+
+      # Código do C6 Bank.
+      #
+      # @return [String] '336'
+      #
+      def codigo_banco
+        '336'
+      end
+
+      # Dígito do código do banco.
+      #
+      # @return [String] '5'
+      #
+      def digito_codigo_banco
+        '5'
+      end
+
+      # Dígito verificador da conta corrente.
+      #
+      # @return [String]
+      #
+      def digito_conta_corrente
+        Modulo10.new(conta_corrente.to_s)
+      end
+
+      # Agência e código do cedente formatados.
+      #
+      # @return [String]
+      #
+      def agencia_codigo_cedente
+        "#{agencia} / #{conta_corrente}-#{digito_conta_corrente}"
+      end
+
+      # Nosso Número formatado.
+      #
+      # @return [String]
+      #
+      def nosso_numero
+        "#{numero_documento}-#{digito_nosso_numero}"
+      end
+
+      # Dígito verificador do nosso número.
+      #
+      # @return [String]
+      #
+      def digito_nosso_numero
+        Modulo11FatorDe2a9.new(numero_documento.to_s)
+      end
+
+      # Segunda parte do código de barras (campo livre).
+      # 25 posições específicas do C6 Bank.
+      #
+      # @return [String]
+      #
+      def codigo_de_barras_do_banco
+        codigo = "#{agencia}#{carteira.to_s.rjust(1, '0')}#{numero_documento}#{conta_corrente.to_s[0, 9]}"
+        "#{codigo.ljust(25, '0')}"
+      end
+    end
+  end
+end

data/lib/boleto_bancario/core/inter.rb

@@ -0,0 +1,155 @@
+# frozen_string_literal: true
+
+module BoletoBancario
+  module Core
+    # Implementação de emissão de boleto bancário pelo Banco Inter.
+    #
+    # === Documentação Implementada
+    #
+    # A documentação na qual essa implementação foi baseada está localizada na pasta
+    # 'documentacoes_dos_boletos/inter' dentro dessa biblioteca.
+    #
+    # === Contrato das classes de emissão de boletos
+    #
+    # Para ver o "<b>contrato</b>" da Emissão de Boletos veja a classe BoletoBancario::Core::Boleto.
+    #
+    # === Carteiras suportadas
+    #
+    # O Banco Inter trabalha com carteira de cobrança registrada.
+    #
+    #      ___________________________________________________________________________
+    #     | Carteira | Descrição                           | Testada/Homologada     |
+    #     |   112    | Cobrança Registrada                 | Esperando Contribuição |
+    #     ----------------------------------------------------------------------------
+    #
+    class Inter < Boleto
+      # Tamanho máximo de uma conta corrente no Banco Inter.
+      #
+      # @return [Integer] 10
+      #
+      def self.tamanho_maximo_conta_corrente
+        10
+      end
+
+      # Tamanho máximo de uma agência no Banco Inter.
+      #
+      # @return [Integer] 4
+      #
+      def self.tamanho_maximo_agencia
+        4
+      end
+
+      # Tamanho máximo do número do documento.
+      #
+      # @return [Integer] 11
+      #
+      def self.tamanho_maximo_numero_documento
+        11
+      end
+
+      # Tamanho máximo do código do cedente.
+      #
+      # @return [Integer] 10
+      #
+      def self.tamanho_maximo_codigo_cedente
+        10
+      end
+
+      # Carteiras suportadas pelo Banco Inter.
+      #
+      # @return [Array]
+      #
+      def self.carteiras_suportadas
+        %w[112]
+      end
+
+      validates :agencia, :conta_corrente, presence: true
+      validates :numero_documento, length: { maximum: tamanho_maximo_numero_documento }, if: :deve_validar_numero_documento?
+      validates :conta_corrente, length: { maximum: tamanho_maximo_conta_corrente }, if: :deve_validar_conta_corrente?
+      validates :agencia, length: { maximum: tamanho_maximo_agencia }, if: :deve_validar_agencia?
+      validates :carteira, inclusion: { in: ->(object) { object.class.carteiras_suportadas } }, if: :deve_validar_carteira?
+
+      # @return [String] Número do documento com 11 dígitos.
+      #
+      def numero_documento
+        @numero_documento.to_s.rjust(11, '0') if @numero_documento.present?
+      end
+
+      # @return [String] Agência com 4 dígitos.
+      #
+      def agencia
+        @agencia.to_s.rjust(4, '0') if @agencia.present?
+      end
+
+      # @return [String] Conta corrente com 10 dígitos.
+      #
+      def conta_corrente
+        @conta_corrente.to_s.rjust(10, '0') if @conta_corrente.present?
+      end
+
+      # @return [String] Código do cedente com 10 dígitos.
+      #
+      def codigo_cedente
+        @codigo_cedente.to_s.rjust(10, '0') if @codigo_cedente.present?
+      end
+
+      # Código do Banco Inter.
+      #
+      # @return [String] '077'
+      #
+      def codigo_banco
+        '077'
+      end
+
+      # Dígito do código do banco.
+      #
+      # @return [String] '9'
+      #
+      def digito_codigo_banco
+        '9'
+      end
+
+      # Dígito verificador da conta corrente.
+      #
+      # @return [String]
+      #
+      def digito_conta_corrente
+        Modulo10.new(conta_corrente.to_s)
+      end
+
+      # Agência e código do cedente formatados.
+      #
+      # @return [String]
+      #
+      def agencia_codigo_cedente
+        "#{agencia} / #{conta_corrente}-#{digito_conta_corrente}"
+      end
+
+      # Nosso Número formatado.
+      #
+      # @return [String]
+      #
+      def nosso_numero
+        "#{numero_documento}-#{digito_nosso_numero}"
+      end
+
+      # Dígito verificador do nosso número.
+      #
+      # @return [String]
+      #
+      def digito_nosso_numero
+        Modulo11FatorDe2a9.new(numero_documento.to_s)
+      end
+
+      # Segunda parte do código de barras (campo livre).
+      # 25 posições específicas do Banco Inter.
+      #
+      # @return [String]
+      #
+      def codigo_de_barras_do_banco
+        codigo = "#{agencia}#{carteira}#{numero_documento}#{conta_corrente.to_s[0, 7]}"
+        "#{codigo.ljust(25, '0')}"
+      end
+    end
+  end
+end