br_boleto 0.1.0

data/lib/br_boleto/calculos/modulo11.rb

@@ -0,0 +1,54 @@
+module BrBoleto
+	module Calculos
+		# Classe que possue a convenção de calculo do modulo 11.
+		# O que muda para cada classe é a forma de verificar o total do cálculo.
+		#
+		# @abstract Precisa implementar { #fatores, #calculate } nas subclasses.
+		#
+		class Modulo11 < String
+			# Número que será feito o cálculo do módulo 11.
+			#
+			attr_reader :number
+
+			# @param [String ou Integer] number (Corresponde ao número a ser calculado pelo Módulo 11)
+			# @return [String]
+			#
+			def initialize(number)
+				@number  = number
+
+				super(calculate.to_s)
+			end
+
+			# @return [Array] Fatores que serão multiplicados por cada digito do
+			# número passado como argumento no initialize.
+			# @raise [NotImplementedError] Precisa implementar na subclasse
+			#
+			def fatores
+				raise NotImplementedError, "Not implemented #fatores in subclass."
+			end
+
+			# @return [Fixnum]
+			# @raise [NotImplementedError] Precisa implementar na subclasse
+			#
+			def calculate
+				raise NotImplementedError, "Not implemented #calculate in subclass."
+			end
+
+			# Realiza o cálculo retornando o resto da divisão do cálculo dos fatores por 11.
+			#
+			# @return [Fixnum] Resto da divisão por 11.
+			#
+			def mod_division
+				@mod_division ||= FatoresDeMultiplicacao.new(@number, fatores: fatores).sum % 11
+			end
+
+			# Subtrai 11 do resto da divisão para se ter o total do módulo 11.
+			#
+			# @return [Fixnum]
+			#
+			def total
+				@total ||= 11 - mod_division
+			end
+		end
+	end
+end

data/lib/br_boleto/calculos/modulo11_fator3197.rb

@@ -0,0 +1,88 @@
+module BrBoleto
+  module Calculos
+    # === Módulo 11 Fator 3197
+    #
+    # === Passos
+    #
+    # 1) Tomando-se os algarismos multiplique-os, iniciando-se da direita para a esquerda,
+    # pela seqüência numérica (3, 1, 9 ,7, 3, 1, 9 ,7 ... e assim por diante).
+    #
+    # 2) Some o resultado de cada produto efetuado e determine o total como (N).
+    #
+    # 3) Divida o total (N) por 11 e determine o resto obtido da divisão como Mod 11(N).
+    #
+    # 4) Calcule o dígito verificador (DAC) através da expressão:
+    #
+    #     DIGIT = 11 - Mod 11 (n)
+    #
+    # <b>OBS.:</b> Se o resto da divisão for “1” ou "0", o resultado deve ser = 0
+    #
+    # ==== Exemplo
+    #
+    # Considerando o seguinte número: '306900008281900010005'.
+    #
+    # 1) Multiplicando a seqüência de multiplicadores:
+    #
+    #      3  0  6  9  0  0  0  0  8  2  8  1  9  0  0  0  1  0  0  0  5
+    #      *  *  *  *  *  *  *  *  *  *  *  *  *  *  *  *  *  *  *  *  *
+    #      3  1  9  7  3  1  9  7  3  1  9  7  3  1  9  7  3  1  9  7  3
+    #
+    # 2) Soma-se o resultado dos produtos obtidos no item “1” acima:
+    #
+    #      9  0  54 63 0  0  0  0  24 2  72 7  27 0  0  0  3  0  0  0  15 
+    #      # => 204
+    #
+    # 3) Determina-se o resto da Divisão:
+    #
+    #      204 % 11
+    #      # => 55
+    #      Como é maior que 10, então pega-se 60-55 = 5
+    #      Por exemplo, se fosse 27, então pegaria 30-27 = 3
+    #
+    # 4) Calcula-se o DAC:
+    #
+    #      11 - 5
+    #      # => 6 =============> Resultado final retornado.
+    #
+    # @param [String]: Corresponde ao número a ser calculado o Módulo 11 no fator de 2 a 7.
+    # @return [String] Retorna o resultado do cálculo descrito acima.
+    #
+    # @example
+    #
+    #    BrBoleto::Calculos::Modulo11FatorDe2a7.new('20')
+    #    # => '5'
+    #
+    #    BrBoleto::Calculos::Modulo11FatorDe2a7.new('64')
+    #    # => '7'
+    #
+    #    BrBoleto::Calculos::Modulo11FatorDe2a7.new('26')
+    #    # => '4'
+    #
+    #    BrBoleto::Calculos::Modulo11FatorDe2a7.new('6')
+    #    # => 'P'
+    #
+    #    BrBoleto::Calculos::Modulo11FatorDe2a7.new('14')
+    #    # => '0'
+    #
+    class Modulo11Fator3197 < Modulo11
+      # Sequência numérica 3197 que será feito a multiplicação de cada dígito
+      # do número passado no #initialize.
+      #
+      # @return [Array] Sequência numérica
+      #
+      def fatores
+        [3,7,9,1]
+      end
+
+      # @return [Fixnum]
+      #
+      def calculate
+        if mod_division.equal?(1) or mod_division.equal?(0)
+          0
+        else
+          total
+        end
+      end
+    end
+  end
+end

data/lib/br_boleto/calculos/modulo11_fator_de2a7.rb

@@ -0,0 +1,97 @@
+module BrBoleto
+  module Calculos
+    # === Módulo 11 Fator de 2 a 7
+    #
+    # === Passos
+    #
+    # 1) Tomando-se os algarismos multiplique-os, iniciando-se da direita para a esquerda,
+    # pela seqüência numérica de 2 a 7 (2, 3, 4, 5, 6, 7 ... e assim por diante).
+    #
+    # 2) Some o resultado de cada produto efetuado e determine o total como (N).
+    #
+    # 3) Divida o total (N) por 11 e determine o resto obtido da divisão como Mod 11(N).
+    #
+    # 4) Calcule o dígito verificador (DAC) através da expressão:
+    #
+    #     DIGIT = 11 - Mod 11 (n)
+    #
+    # <b>OBS.:</b> Se o resto da divisão for “1”, desprezar a diferença entre o divisor
+    # menos o resto que será “10” e considerar o dígito como “P”.
+    #
+    # <b>OBS.:</b> Se o resto da divisão for “0”, desprezar o cálculo de subtração entre
+    # divisor e resto, e considerar o “0” como dígito.
+    #
+    # ==== Exemplo
+    #
+    # Considerando o seguinte número: '89234560'.
+    #
+    # 1) Multiplicando a seqüência de multiplicadores:
+    #
+    #      1    9    0    0    0    0    0    0    0    0    0    0    2
+    #      *    *    *    *    *    *    *    *    *    *    *    *    *
+    #      2    7    6    5    4    3    2    7    6    5    4    3    2
+    #
+    # 2) Soma-se o resultado dos produtos obtidos no item “1” acima:
+    #
+    #      2 +  63 + 0  + 0  + 0  + 0  + 0  + 0  + 0  + 0  + 0  + 0  + 4
+    #      # => 69
+    #
+    # 3) Determina-se o resto da Divisão:
+    #
+    #      69 % 11
+    #      # => 3
+    #
+    # 4) Calcula-se o DAC:
+    #
+    #      11 - 3
+    #      # => 8 =============> Resultado final retornado.
+    #
+    # @param [String]: Corresponde ao número a ser calculado o Módulo 11 no fator de 2 a 7.
+    # @return [String] Retorna o resultado do cálculo descrito acima.
+    #
+    # @example
+    #
+    #    BrBoleto::Calculos::Modulo11FatorDe2a7.new('20')
+    #    # => '5'
+    #
+    #    BrBoleto::Calculos::Modulo11FatorDe2a7.new('64')
+    #    # => '7'
+    #
+    #    BrBoleto::Calculos::Modulo11FatorDe2a7.new('26')
+    #    # => '4'
+    #
+    #    BrBoleto::Calculos::Modulo11FatorDe2a7.new('6')
+    #    # => 'P'
+    #
+    #    BrBoleto::Calculos::Modulo11FatorDe2a7.new('14')
+    #    # => '0'
+    #
+    class Modulo11FatorDe2a7 < Modulo11
+      # Sequência numérica de 2 a 7 que será feito a multiplicação de cada dígito
+      # do número passado no #initialize.
+      #
+      # @return [Array] Sequência numérica
+      #
+      def fatores
+        [2, 3, 4, 5, 6, 7]
+      end
+
+      # Calcula o número pelos fatores de multiplicação de 2 a 7.
+      # Depois calcula o resto da divisão por 11 e subtrai por 11.
+      # Se o resultado desse cálculo for igual a 11, considere DAC = 0.
+      # Se o resultado desse cálculo for igual a 10, considere DAC = P.
+      #
+      # @return [Fixnum]
+      #
+      def calculate
+        return 0 if total.equal?(11)
+
+        if total == 10
+          'P'
+        else
+          total
+        end
+      end
+    end
+  end
+end

data/lib/br_boleto/calculos/modulo11_fator_de2a9.rb

@@ -0,0 +1,83 @@
+# encoding: utf-8
+module BrBoleto
+  module Calculos
+    # === Módulo 11 Fator de 2 a 9
+    #
+    # === Passos
+    #
+    # 1) Tomando-se os algarismos multiplique-os, iniciando-se da direita para a esquerda,
+    # pela seqüência numérica de 2 a 9 (2, 3, 4, 5, 6, 7, 8, 9 ... e assim por diante).
+    #
+    # 2) Some o resultado de cada produto efetuado e determine o total como (N).
+    #
+    # 3) Divida o total (N) por 11 e determine o resto obtido da divisão como Mod 11(N).
+    #
+    # 4) Calcule o dígito verificador (DAC) através da expressão:
+    #
+    #     DIGIT = 11 - Mod 11 (n)
+    #
+    # <b>OBS.:</b> Se o resultado desta expressão for igual a 0, 1, 10 ou 11, considere DAC = 1.
+    #
+    # ==== Exemplo
+    #
+    # Considerando o seguinte número: '89234560'.
+    #
+    # 1) Multiplicando a seqüência de multiplicadores:
+    #
+    #      8    9    2    3    4    5    6    0
+    #      *    *    *    *    *    *    *    *
+    #      9    8    7    6    5    4    3    2
+    #
+    # 2) Soma-se o resultado dos produtos obtidos no item “1” acima:
+    #
+    #      72 + 72 + 14 + 18 + 20 + 20 + 18 + 0
+    #      # => 234
+    #
+    # 3) Determina-se o resto da Divisão:
+    #
+    #      234 % 11
+    #      # => 3
+    #
+    # 4) Calcula-se o DAC:
+    #
+    #      11 - 3
+    #      # => 8 =============> Resultado final retornado.
+    #
+    # @param [String]: Corresponde ao número a ser calculado o Módulo 11 no fator de 2 a 9.
+    # @return [String] Retorna o resultado do cálculo descrito acima.
+    #
+    # @example
+    #
+    #    BrBoleto::Calculos::Modulo11FatorDe2a9.new('1')
+    #    # => '9'
+    #
+    #    BrBoleto::Calculos::Modulo11FatorDe2a9.new('91')
+    #    # => '4'
+    #
+    #    BrBoleto::Calculos::Modulo11FatorDe2a9.new('189')
+    #    # => '9'
+    #
+    class Modulo11FatorDe2a9 < Modulo11
+      # Sequência numérica de 2 a 9 que será feito a multiplicação de cada dígito
+      # do número passado no #initialize.
+      #
+      # @return [Array] Sequência numérica
+      #
+      def fatores
+        [2, 3, 4, 5, 6, 7, 8, 9]
+      end
+
+      # Calcula o número pelos fatores de multiplicação de 2 a 9.
+      # Depois calcula o resto da divisão por 11 e subtrai por 11.
+      # Se o resultado desse cálculo for igual a 0, 1, 10 ou 11, considere DAC = 1.
+      #
+      # @return [Fixnum]
+      #
+      def calculate
+        return 1 if total > 9
+
+        total
+      end
+    end
+  end
+end

data/lib/br_boleto/calculos/modulo11_fator_de2a9_resto_zero.rb

@@ -0,0 +1,29 @@
+module BrBoleto
+  module Calculos
+    # Classe responsável por calcular o módulo 11 com fatores de 2 a 9.
+    # <b>Essa classe difere da outra com Modulo11FatorDe2a9, no momento de verificar o resto da divisão por 11.</b>
+    #
+    # <b>Para mais detalhes veja a classe Modulo11FatorDe2a9.</b>
+    #
+    class Modulo11FatorDe2a9RestoZero < Modulo11FatorDe2a9
+      # Realiza o cálculo do módulo 11 com fatores de 2 a 9.
+      #
+      # === Resto Da divisão por 11
+      #
+      # * Se o resto da divisão por 11 for igual a 10, o digito será '1' (um),
+      # * Se o resto da divisão por 11 for igual a 1 (um) ou 0 (zero) o digito será 0 (zero).
+      #
+      # Qualquer “RESTO” diferente de “0, 1 ou 10”, subtrair o resto de 11 para obter o digíto.
+      #
+      # @return [Fixnum] Resultado da subtração ou resultado da verificação do resto da divisão.
+      #
+      def calculate
+        if mod_division.equal?(1) or mod_division.equal?(0)
+          0
+        else
+          total
+        end
+      end
+    end
+  end
+end

data/lib/br_boleto/calculos/modulo11_fator_de9a2.rb

@@ -0,0 +1,65 @@
+module BrBoleto
+  module Calculos
+    # === Módulo 11 Fator de 9 a 2
+    #
+    # === Passos
+    #
+    # 1) Tomando-se os algarismos multiplique-os, iniciando-se da direita para a esquerda,
+    # pela seqüência numérica de 9 a 2 (9, 8, 7, 6, 5, 4, 3, 2 ... e assim por diante).
+    #
+    # 2) Some o resultado de cada produto efetuado e determine o total como (N).
+    #
+    # 3) Divida o total (N) por 11 e determine o resto obtido da divisão como Mod 11(N).
+    #
+    # ==== Exemplo Normal
+    #
+    # Considerando o seguinte número: '89234560'.
+    #
+    # 1) Multiplicando a seqüência de multiplicadores:
+    #
+    #      8    9    2    3    4    5    6    0
+    #      *    *    *    *    *    *    *    *
+    #      2    3    4    5    6    7    8    9
+    #
+    # 2) Soma-se o resultado dos produtos obtidos no item “1” acima:
+    #
+    #      16 + 27 + 8 + 15 + 24 + 35 + 48 + 0
+    #      # => 173
+    #
+    # 3) Determina-se o resto da Divisão:
+    #
+    #      173 % 11
+    #      # => 8 =============> Resultado final retornado.
+    #
+    # @param [String]: Corresponde ao número a ser calculado o Módulo 11 no fator de 9 a 2.
+    # @return [String] Retorna o resultado do cálculo descrito acima.
+    #
+    # @example
+    #
+    #    BrBoleto::Calculos::Modulo11FatorDe9a2.new('12345')
+    #    # => '5'
+    #
+    #    BrBoleto::Calculos::Modulo11FatorDe9a2.new('246')
+    #    # => '1'
+    #
+    class Modulo11FatorDe9a2 < Modulo11
+      # Sequência numérica de 9 a 2 que será feito a multiplicação de cada dígito
+      # do número passado no #initialize.
+      #
+      # @return [Array] Sequência numérica
+      #
+      def fatores
+        [9, 8, 7, 6, 5, 4, 3, 2]
+      end
+
+      # Calcula o número pelos fatores de multiplicação de 9 a 2.
+      # Depois calcula o resto da divisão por 11.
+      #
+      # @return [Fixnum]
+      #
+      def calculate
+        mod_division
+      end
+    end
+  end
+end

data/lib/br_boleto/calculos/modulo11_fator_de9a2_resto_x.rb

@@ -0,0 +1,55 @@
+module BrBoleto
+  module Calculos
+    #  === Módulo 11 Fator de 9 a 2 - Resto 10, sendo X
+    # <b>Essa classe difere da outra com Modulo11FatorDe9a2, no momento de verificar o resto da divisão por 11.</b>
+    #
+    # <b>Para mais detalhes veja a classe Modulo11FatorDe9a2.</b>
+    #
+    # ==== Exemplo 10 como resto da divisão
+    #
+    # Considerando o seguinte número: '100008'.
+    #
+    # 1) Multiplicando a seqüência de multiplicadores:
+    #
+    #      1    0    0    0    0    8
+    #      *    *    *    *    *    *
+    #      4    5    6    7    8    9
+    #
+    # 2) Soma-se o resultado dos produtos obtidos no item “1” acima:
+    #
+    #      4  + 0  + 0  + 0  + 0 + 72
+    #      # => 76
+    #
+    # 3) Determina-se o resto da Divisão:
+    #
+    #      76 % 11
+    #      # => 10
+    #
+    # 4) Quando o resultado for '10', o dígito será:
+    #
+    #     resultado == 10
+    #     # => 'X' =============> Resultado final retornado.
+    #
+    # @example
+    #
+    #    BrBoleto::Calculos::Modulo11FatorDe9a2RestoX.new('184122')
+    #    # => 'X'
+    #
+    class Modulo11FatorDe9a2RestoX < Modulo11FatorDe9a2
+      # Calcula o número pelos fatores de multiplicação de 9 a 2.
+      # Depois calcula o resto da divisão por 11.
+      # Se o resultado desse cálculo for igual a 10, então o DAC = X.
+      # Se o resultado desse cálculo for menor que 10, retornar o resultado.
+      #
+      # @return [Fixnum]
+      #
+      def calculate
+        if mod_division.equal?(10)
+          'X'
+        else
+          mod_division
+        end
+      end
+    end
+  end
+end