brazilian_documents 0.1.1 → 0.1.2

data/lib/br_documents/documents/ie.rb

@@ -0,0 +1,43 @@
+require_relative 'ie/base'
+
+Dir[File.expand_path("ie/{**/**,**}.rb", File.dirname(__FILE__))].each {|file| require file }
+
+module BRDocuments
+  module IE
+
+    AVAILABLE_STATES = [
+      'AC',
+      'AL',
+      'AM',
+      'AP',
+      'BA',
+      'CE',
+      'DF',
+      'ES',
+      'GO',
+      'MA',
+      'MG',
+      'MS',
+      'MT',
+      'PA',
+      'PB',
+      'PE',
+      'PI',
+      'PR',
+      'RJ',
+      'RN',
+      'RO',
+      'RR',
+      'RS',
+      'SE',
+      'SP',
+      'TO'
+    ]
+
+
+    def self.available_states
+      AVAILABLE_STATES
+    end
+
+  end
+end

data/lib/br_documents/documents/ie/ac.rb

@@ -0,0 +1,15 @@
+# http://www.sintegra.gov.br/Cad_Estados/cad_AC.html
+module BRDocuments
+  class IE::AC < IE::Base
+
+    set_verify_digits_weights first: %w(4 3 2 9 8 7 6 5 4 3 2),
+                              last:  %w(5 4 3 2 9 8 7 6 5 4 3 2)
+
+    set_format_regexp %r{^(01)[-.]?(\d{3})[-.]?(\d{3})[\/-]?(\d{3})[-.]?(\d{2})}
+
+    set_pretty_format_mask %(%s.%s.%s/%s-%s)
+
+    set_fixed_digits [0, 1]
+
+  end
+end

data/lib/br_documents/documents/ie/al.rb

@@ -0,0 +1,50 @@
+# http://www.sintegra.gov.br/Cad_Estados/cad_AL.html
+module BRDocuments
+  class IE::AL < IE::Base
+
+    set_verify_digits_weights first: %w(9 8 7 6 5 4 3 2)
+
+    set_format_regexp %r{^(24)[-.]?(\d{3})[-.]?(\d{3})[-.]?(\d{1})}
+
+    set_pretty_format_mask %(%s.%s.%s-%s)
+
+    set_fixed_digits [2, 4]
+
+    COMPANIES_TYPES = {
+      "0": "Normal",
+      "3": "Produtor Rural",
+      "5": "Substituta",
+      "7": "Micro-Empresa Ambulante",
+      "8": "Micro-Empresa"
+    }
+
+    class << self
+      def companies_types_labels
+        COMPANIES_TYPES.values
+      end
+
+      def sample_company_type_digit
+        COMPANIES_TYPES.keys.sample.to_s
+      end
+
+      def generate_root_numbers
+        numbers = super
+        # force digit
+        numbers[2] = sample_company_type_digit.to_i
+
+        numbers
+      end
+
+      def company_type(number)
+        # .to_s.to_sym to avoid nil.to_sym
+        COMPANIES_TYPES[company_type_digit(number).to_s.to_sym]
+      end
+
+      def company_type_digit(number)
+        number = new(number).strip
+
+        number.match(/^\d{2}(\d{1})/) && $1
+      end
+    end
+  end
+end

data/lib/br_documents/documents/ie/am.rb

@@ -0,0 +1,12 @@
+# http://www.sintegra.gov.br/Cad_Estados/cad_AM.html
+module BRDocuments
+  class IE::AM < IE::Base
+
+    set_verify_digits_weights first: %w(9 8 7 6 5 4 3 2)
+
+    set_format_regexp %r{^(\d{2})[-.]?(\d{3})[-.]?(\d{3})[-.]?(\d{1})}
+
+    set_pretty_format_mask %(%s.%s.%s-%s)
+
+  end
+end

data/lib/br_documents/documents/ie/ap.rb

@@ -0,0 +1,61 @@
+# http://www.sintegra.gov.br/Cad_Estados/cad_AP.html
+module BRDocuments
+  class IE::AP < IE::Base
+
+    set_verify_digits_weights first: %w(9 8 7 6 5 4 3 2)
+
+    set_format_regexp %r{^(03)[-.]?(\d{6})[-.]?(\d{1})}
+
+    set_pretty_format_mask %(%s.%s-%s)
+
+    set_fixed_digits [0, 3]
+
+    # In RANGE_VALUES we remove the first '0' character so
+    # numbers are't treated as octal numberss
+    # see: :obtain_range_aux_value method
+    RANGE_VALUES = {
+      3000001..3017000 => [5, 0],
+      3017001..3019022 => [9, 1]
+    }.freeze
+
+    DEFAULT_RANGE_CONF = [0, 0]
+
+    def range_aux_values_hash
+      range_conf = obtain_range_aux_value(@number.dup)
+
+      {
+        :p => range_conf[0],
+        :d => range_conf[1]
+      } # equivalent to Hash[[:p, :d].zip(range_conf)]
+    end
+
+    def reduce_digits_weights(number, weights)
+      range_aux_values_hash[:p] + super(number, weights)
+    end
+
+    def calc_verify_digit(quotient_rest)
+      if ([11].member?(get_division_modulo - quotient_rest))
+        return range_aux_values_hash[:d]
+      end
+
+      super
+    end
+
+    private
+    def obtain_range_aux_value(number)
+      remove_verify_digits(number)
+
+      # remove first '0' digit so number is not a octal
+      number = (stripped(number)[1..-1]).to_i
+
+      # We try to check if `number` is include in one of the pre defined range
+      range_conf = RANGE_VALUES.map do |range, aux_values|
+        range.include?(number) ? aux_values : nil
+      end.compact
+
+      # One of the configured values or the default
+      range_conf.shift || DEFAULT_RANGE_CONF
+    end
+
+  end
+end

data/lib/br_documents/documents/ie/ba.rb

@@ -0,0 +1,84 @@
+# This class is a wrapper/interface to glue all Bahia IE generators and validators
+module BRDocuments
+  module IE::BA
+    class << self
+
+      DIGITS_MOD_10 = [0,1,2,3,4,5,8]
+      DIGITS_MOD_11 = [6,7,9]
+
+      # Delegate all methods to specific class
+      def method_missing(method, *args)
+        class_for_number(args[0]).public_send(method, *args)
+      end
+
+      def generate(formatted = true, digits_count = 9, modulo = 10)
+        generator_class(digits_count, modulo).generate(formatted)
+      end
+
+      def generate_root_numbers(digits_count = 9, modulo = 10)
+        generator_class(digits_count, modulo).generate_root_numbers
+      end
+
+      def class_for_number(number)
+        class_name = class_name_for_number(number)
+        IE::BA.const_get(class_name)
+      end
+
+      def rand_generate(formatted = true)
+        generate(formatted, rand_digits_count, rand_modulo)
+      end
+
+      protected
+      def generator_class(digits_count = 9, modulo = 10)
+        IE::BA.const_get("Digits#{digits_count}::Modulo#{modulo}")
+      end
+
+      def class_name_for_number(number)
+        [
+          digits_module_for(number),
+          modulo_class_for(number)
+        ].join("::")
+      end
+
+      def digits_module_for(number)
+        eight_digits?(number) ? "Digits8" : "Digits9"
+      end
+
+      def modulo_class_for(number)
+        number = normalize_number(number)
+
+        # for eigth numbers documents, the first digit is cheched
+        # otherwhise the second digit is checked
+        check_position = eight_digits?(number) ? 0 : 1
+        check_digit = number.slice(check_position, 1).to_i
+
+        DIGITS_MOD_11.member?(check_digit) ? 'Modulo11' : 'Modulo10'
+      end
+
+      def eight_digits?(number)
+        normalize_number(number).size == 8
+      end
+
+      def nine_digits?(number)
+        normalize_number(number).size == 9
+      end
+
+      def normalize_number(number)
+        number.to_s.gsub(/[^\d+]/, '')
+      end
+
+      def rand_digits_count
+        rand_boolean ? 9 : 8
+      end
+
+      def rand_modulo
+        (rand_boolean ? 10 : 11)
+      end
+
+      def rand_boolean
+        # 50%/50% of chance
+        rand(2) > 0
+      end
+    end
+  end
+end

data/lib/br_documents/documents/ie/ba/base.rb

@@ -0,0 +1,37 @@
+# http://www.sintegra.gov.br/Cad_Estados/cad_BA.html
+module BRDocuments
+  module IE
+    module BA
+      class Base < IE::Base
+
+        set_format_regexp %r{(\d{3})[-.]?(\d{3})[-.]?(\d{2,3})}
+
+        set_pretty_format_mask %(%s.%s.%s)
+
+        # I don't know why in Bahia they calculate the LAST digit FIRST and
+        # the FIRST digit LAST, wtf
+        def calculate_verify_digits
+          super.reverse
+        end
+
+        def self.valid_fixed_digits?(number)
+          number = new(number).normalize
+          fixed_numbers = self.const_get('FIXED_INITIAL_NUMBERS')
+
+          fixed_numbers.member?(number[fixed_digits_positions].to_s)
+        end
+
+        def self.fixed_digits
+          [super.sample.to_i]
+        end
+      end
+    end
+  end
+end
+
+module BRDocuments::IE::BA
+  module Digits8
+  end
+  module Digits9
+  end
+end

data/lib/br_documents/documents/ie/ba/digits8/modulo_10.rb

@@ -0,0 +1,12 @@
+require_relative '../modulo_10'
+
+module BRDocuments
+  module IE
+    class BA::Digits8::Modulo10 < IE::BA::Modulo10
+
+      set_verify_digits_weights first: %w(7 6 5 4 3 2),
+                                last:  %w(8 7 6 5 4 3 2)
+
+    end
+  end
+end

data/lib/br_documents/documents/ie/ba/digits8/modulo_11.rb

@@ -0,0 +1,12 @@
+require_relative '../modulo_11'
+
+module BRDocuments
+  module IE
+    class BA::Digits8::Modulo11 < IE::BA::Modulo11
+      set_verify_digits_weights first: %w(7 6 5 4 3 2),
+                                last: %w(8 7 6 5 4 3 2)
+
+    end
+  end
+end
+

data/lib/br_documents/documents/ie/ba/digits9/modulo_10.rb

@@ -0,0 +1,19 @@
+require_relative '../modulo_10'
+
+module BRDocuments
+  module IE
+    class BA::Digits9::Modulo10 < IE::BA::Modulo10
+
+      set_verify_digits_weights first: %w(8 7 6 5 4 3 2),
+                                last:  %w(9 8 7 6 5 4 3 2)
+
+
+      # 9 digits IE from bahia have FIXED NUMBER in the second position
+      INITIAL_FIX_NUMBERS_POSITION = 1
+
+      def fixed_digits_positions
+        self.const_get('INITIAL_FIX_NUMBERS_POSITION')
+      end
+    end
+  end
+end

data/lib/br_documents/documents/ie/ba/digits9/modulo_11.rb

@@ -0,0 +1,20 @@
+require_relative '../modulo_11'
+
+module BRDocuments
+  module IE
+    class BA::Digits9::Modulo11 < IE::BA::Modulo11
+
+      set_verify_digits_weights first: %w(8 7 6 5 4 3 2),
+                                last:  %w(9 8 7 6 5 4 3 2)
+
+
+      # 9 digits IE from bahia have FIXED NUMBER in the second position
+      INITIAL_FIX_NUMBERS_POSITION = 1
+
+      def fixed_digits_positions
+        self.const_get('INITIAL_FIX_NUMBERS_POSITION')
+      end
+    end
+  end
+end
+

data/lib/br_documents/documents/ie/ba/modulo_10.rb

@@ -0,0 +1,19 @@
+require_relative 'base'
+
+# http://www.sintegra.gov.br/Cad_Estados/cad_BA.html
+module BRDocuments
+  module IE
+    module BA
+      class Modulo10 < IE::BA::Base
+
+        # All documents generated through modulo 11 may start
+        # with one of theses values
+        FIXED_INITIAL_NUMBERS = %w(0 1 2 3 4 5 8)
+
+        # Force modulo 10
+        set_division_modulo 10
+
+      end
+    end
+  end
+end

data/lib/br_documents/documents/ie/ba/modulo_11.rb

@@ -0,0 +1,18 @@
+require_relative 'base'
+
+# http://www.sintegra.gov.br/Cad_Estados/cad_BA.html
+module BRDocuments
+  module IE
+    module BA
+      class Modulo11 < IE::BA::Base
+
+        # All documents generated through modulo 11 may start
+        # with one of theses values
+        FIXED_INITIAL_NUMBERS = %w(6 7 9)
+
+        # Force modulo 11
+        set_division_modulo 11
+      end
+    end
+  end
+end

data/lib/br_documents/documents/ie/base.rb

@@ -0,0 +1,79 @@
+# http://www.sintegra.gov.br/insc_est.html
+module BRDocuments
+  module IE
+    class Base < ::DigitChecksum::BaseDocument
+      # MOD 11
+      set_division_modulo 11
+
+      # remove any non digit from document number
+      set_clear_number_regexp %r{[^(\d+)]}
+
+      # numbers sampled to generate new document numbers
+      set_generator_numbers (0..9).to_a
+
+      # Start from first position
+      INITIAL_FIX_NUMBERS_POSITION = 0
+      # No one
+      FIXED_INITIAL_NUMBERS = []
+
+      def valid?
+        return false unless valid_fixed_digits?
+
+        return super
+      end
+
+      def valid_fixed_digits?
+        return true unless validate_fixed_digits?
+
+        self.class.valid_fixed_digits?(self.number)
+      end
+
+      def validate_fixed_digits?
+        true
+      end
+
+      class << self
+        def valid_fixed_digits?(number)
+          number = new(number).normalize
+
+          initial_pos = fixed_digits_positions
+          fixed_numbers = fixed_digits
+
+          return (number.slice(initial_pos, fixed_numbers.size) == fixed_numbers)
+        end
+
+        def generate_root_numbers
+          numbers = (root_digits_count - fixed_digits.size).times.map {
+            get_generator_numbers.sample.to_i
+          }
+
+          append_fixed_digits(numbers)
+
+          numbers
+        end
+
+        def fixed_digits_positions
+          self.const_get('INITIAL_FIX_NUMBERS_POSITION')
+        end
+
+        def fixed_digits
+          self.const_get('FIXED_INITIAL_NUMBERS')
+        end
+
+        def set_fixed_digits(initial_numbers)
+          self.const_set('FIXED_INITIAL_NUMBERS', initial_numbers).freeze
+        end
+
+        protected
+        def append_fixed_digits(numbers)
+          fixed_digits.each_with_index {|number, index|
+            numbers.insert(fixed_digits_positions + index, number)
+          }
+
+          numbers
+        end
+      end
+
+    end
+  end
+end