sec_id 6.0.0 → 7.0.0

data/lib/sec_id/detector.rb

@@ -58,7 +58,7 @@ module SecID
 
       candidates = filter_candidates(input.upcase)
       matches = candidates.filter_map { |klass| (i = klass.new(input)).valid? ? i : nil }
-      matches.min_by { |instance| @priority_for[instance.class] }
+      matches.min_by { |instance| instance.class.detection_priority }
     end
 
     private
@@ -81,16 +81,14 @@ module SecID
     # @return [Array<Symbol>]
     def validate_and_sort(input, candidates)
       matches = candidates.select { |klass| klass.valid?(input) }
-      matches.sort_by! { |klass| @priority_for[klass] }
-      matches.map! { |klass| @key_for[klass] }
+      matches.sort_by!(&:detection_priority)
+      matches.map!(&:type_key)
     end
 
     # @return [void]
     def precompute
       build_discriminator_sets
       build_length_table
-      build_priority_table
-      build_key_table
     end
 
     # Classifies types by which special characters their VALID_CHARS_REGEX accepts.
@@ -114,27 +112,6 @@ module SecID
       @candidates_by_length.each_value(&:freeze)
     end
 
-    # Builds composite sort keys: check-digit types first, then smaller range, then load order.
-    #
-    # @return [void]
-    def build_priority_table
-      @priority_for = {}
-      @classes.each_with_index do |klass, index|
-        check_digit_rank = klass.has_check_digit? ? 0 : 1
-        @priority_for[klass] = [check_digit_rank, klass.length_specificity, index].freeze
-      end
-      @priority_for.freeze
-    end
-
-    # Maps each class to its registry symbol key.
-    #
-    # @return [void]
-    def build_key_table
-      @key_for = {}
-      @classes.each { |klass| @key_for[klass] = klass.short_name.downcase.to_sym }
-      @key_for.freeze
-    end
-
     # Stage 1: route strings with special characters to the only types that accept them.
     # Returns nil if no special chars found (fall through to stage 2).
     #

data/lib/sec_id/dti.rb

@@ -13,7 +13,7 @@ module SecID
   # @example Validate a DTI
   #   SecID::DTI.valid?('X9J9K872S')  #=> true
   #
-  # @example Restore check digit
+  # @example Restore checksum
   #   SecID::DTI.restore('X9J9K872')  #=> 'X9J9K872S'
   class DTI < Base
     include Checkable
@@ -33,7 +33,7 @@ module SecID
       (?<identifier>
         [1-9B-DF-HJ-NP-TV-XZ]
         [0-9B-DF-HJ-NP-TV-XZ]{7})
-      (?<check_digit>[0-9B-DF-HJ-NP-TV-XZ])?
+      (?<checksum>[0-9B-DF-HJ-NP-TV-XZ])?
     \z/x
 
     # The 30-symbol DTI alphabet, ordered by check-character value (0-29).
@@ -55,14 +55,14 @@ module SecID
     def initialize(dti)
       dti_parts = parse dti
       @identifier = dti_parts[:identifier]
-      @check_digit = dti_parts[:check_digit]
+      @checksum = dti_parts[:checksum]
     end
 
     # @return [String] the calculated or grandfathered check character
     # @raise [InvalidFormatError] if the DTI format is invalid
-    def calculate_check_digit
+    def calculate_checksum
       validate_format_for_calculation!
-      grandfathered_check_digit(identifier) || iso7064_mod31_30_check_char(identifier)
+      grandfathered_checksum(identifier) || iso7064_mod31_30_check_char(identifier)
     end
 
     # Generates a random DTI body: first character non-zero, 8 characters total,
@@ -79,11 +79,11 @@ module SecID
     private
 
     # @return [Hash]
-    def components = { check_digit: }
+    def components = { checksum: }
 
     # @param base [String] the 8-character DTI base
     # @return [String, nil] the registered check character, or nil if not grandfathered
-    def grandfathered_check_digit(base)
+    def grandfathered_checksum(base)
       GRANDFATHERED_CODES[base]&.delete_prefix(base)
     end
 
@@ -92,13 +92,7 @@ module SecID
     # @param base [String] the 8-character DTI base
     # @return [String] the single computed check character
     def iso7064_mod31_30_check_char(base)
-      perm = 30
-      base.each_char do |c|
-        s = (perm + ALPHABET_VALUE.fetch(c)) % 30
-        s = 30 if s.zero?
-        perm = (s * 2) % 31
-      end
-      ALPHABET.fetch((31 - perm) % 30)
+      mod31_30_check_char(base, ALPHABET, ALPHABET_VALUE)
     end
   end
 end

data/lib/sec_id/figi.rb

@@ -4,7 +4,7 @@ module SecID
   # Financial Instrument Global Identifier (FIGI) - a 12-character alphanumeric code
   # that uniquely identifies financial instruments.
   #
-  # Format: 2-character prefix + 'G' + 8-character random part + 1-digit check digit
+  # Format: 2-character prefix + 'G' + 8-character random part + 1-digit checksum
   # Note: FIGI excludes vowels (A, E, I, O, U) from valid characters.
   #
   # @see https://en.wikipedia.org/wiki/Financial_Instrument_Global_Identifier
@@ -12,7 +12,7 @@ module SecID
   # @example Validate a FIGI
   #   SecID::FIGI.valid?('BBG000BLNQ16')  #=> true
   #
-  # @example Restore check digit
+  # @example Restore checksum
   #   SecID::FIGI.restore!('BBG000BLNQ1')  #=> #<SecID::FIGI>
   class FIGI < Base
     include Checkable
@@ -33,7 +33,7 @@ module SecID
         (?<prefix>[B-DF-HJ-NP-TV-Z0-9]{2})
         G
         (?<random_part>[B-DF-HJ-NP-TV-Z0-9]{8}))
-      (?<check_digit>\d)?
+      (?<checksum>\d)?
     \z/x
 
     # Country-code prefixes that are restricted from use in FIGI.
@@ -54,19 +54,19 @@ module SecID
       @identifier = figi_parts[:identifier]
       @prefix = figi_parts[:prefix]
       @random_part = figi_parts[:random_part]
-      @check_digit = figi_parts[:check_digit]&.to_i
+      @checksum = figi_parts[:checksum]&.to_i
     end
 
     # @return [String, nil]
     def to_pretty_s
       return nil unless valid?
 
-      "#{prefix}G #{random_part} #{check_digit}"
+      "#{prefix}G #{random_part} #{checksum}"
     end
 
-    # @return [Integer] the calculated check digit (0-9)
+    # @return [Integer] the calculated checksum (0-9)
     # @raise [InvalidFormatError] if the FIGI format is invalid
-    def calculate_check_digit
+    def calculate_checksum
       validate_format_for_calculation!
       mod10(luhn_sum_indexed(reversed_digits_single(identifier)))
     end
@@ -74,7 +74,7 @@ module SecID
     # Generates a random FIGI body: non-reserved 2-char prefix + 'G' + 8-char random part.
     #
     # @param random [Random] source of randomness
-    # @return [String] an 11-character FIGI body without check digit
+    # @return [String] an 11-character FIGI body without checksum
     def self.generate_body(random)
       prefix = random_string(GENERATE_CHARSET, 2, random: random)
       prefix = random_string(GENERATE_CHARSET, 2, random: random) while RESTRICTED_PREFIXES.include?(prefix)
@@ -85,7 +85,7 @@ module SecID
     private
 
     # @return [Hash]
-    def components = { prefix:, random_part:, check_digit: }
+    def components = { prefix:, random_part:, checksum: }
 
     # @return [Boolean]
     def valid_format?

data/lib/sec_id/iban.rb

@@ -6,8 +6,8 @@ module SecID
   # International Bank Account Number (IBAN) - an international standard for identifying
   # bank accounts across national borders (ISO 13616).
   #
-  # Format: 2-letter country code + 2-digit check digits + BBAN (Basic Bank Account Number, 11-30 chars)
-  # Note: Unlike other SecID identifiers, the check digits are in positions 3-4, not at the end.
+  # Format: 2-letter country code + 2-digit checksum + BBAN (Basic Bank Account Number, 11-30 chars)
+  # Note: Unlike other SecID identifiers, the checksum are in positions 3-4, not at the end.
   #
   # @see https://en.wikipedia.org/wiki/International_Bank_Account_Number
   # @see https://www.iban.com/structure
@@ -15,7 +15,7 @@ module SecID
   # @example Validate an IBAN
   #   SecID::IBAN.valid?('DE89370400440532013000')  #=> true
   #
-  # @example Restore check digits
+  # @example Restore checksum
   #   SecID::IBAN.restore!('DE00370400440532013000')  #=> #<SecID::IBAN>
   class IBAN < Base
     include Checkable
@@ -30,7 +30,7 @@ module SecID
     VALID_CHARS_REGEX = /\A[A-Z0-9]+\z/
 
     # Regular expression for parsing IBAN components.
-    # Note: Check digit positioning is handled in initialize, not in the regex.
+    # Note: Checksum positioning is handled in initialize, not in the regex.
     ID_REGEX = /\A
       (?<country_code>[A-Z]{2})
       (?<rest>[A-Z0-9]{13,32})
@@ -62,7 +62,7 @@ module SecID
     # @return [String, nil] the account number (extracted from BBAN if country rules define it)
     attr_reader :account_number
 
-    # @return [String, nil] the national check digit (extracted from BBAN if country rules define it)
+    # @return [String, nil] the national checksum (extracted from BBAN if country rules define it)
     attr_reader :national_check
 
     # @param iban [String] the IBAN string to parse
@@ -72,7 +72,7 @@ module SecID
       rest = iban_parts[:rest]
 
       if @country_code && rest
-        extract_check_digit_and_bban(rest)
+        extract_checksum_and_bban(rest)
         @identifier = "#{@country_code}#{@bban}" if @bban
       end
 
@@ -82,19 +82,19 @@ module SecID
     # @return [String]
     # @raise [InvalidFormatError] if the IBAN format is invalid
     def restore
-      cd = calculate_check_digit
+      cd = calculate_checksum
       "#{country_code}#{cd.to_s.rjust(2, '0')}#{bban}"
     end
 
     # @return [Integer] the calculated 2-digit check value (1-98)
     # @raise [InvalidFormatError] if the IBAN format is invalid
-    def calculate_check_digit
+    def calculate_checksum
       validate_format_for_calculation!
       mod97(numeric_string_for_check)
     end
 
-    # Generates a random IBAN body for a numeric-BBAN country with placeholder check digits.
-    # The default {Generatable::ClassMethods#generate} restores the real check digits via `restore!`.
+    # Generates a random IBAN body for a numeric-BBAN country with placeholder checksum.
+    # The default {Generatable::ClassMethods#generate} restores the real checksum via `restore!`.
     #
     # @param random [Random] source of randomness
     # @return [String] a country code + "00" + numeric BBAN
@@ -126,9 +126,9 @@ module SecID
 
     # @return [String]
     def to_s
-      return full_id unless check_digit
+      return full_id unless checksum
 
-      "#{country_code}#{check_digit.to_s.rjust(2, '0')}#{bban}"
+      "#{country_code}#{checksum.to_s.rjust(2, '0')}#{bban}"
     end
 
     # @return [String, nil]
@@ -140,7 +140,7 @@ module SecID
 
     # @return [Hash]
     def components
-      hash = { country_code:, bban:, check_digit: }
+      hash = { country_code:, bban:, checksum: }
       hash[:bank_code] = bank_code if bank_code
       hash[:branch_code] = branch_code if branch_code
       hash[:account_number] = account_number if account_number
@@ -149,7 +149,7 @@ module SecID
     end
 
     # @return [Integer]
-    def check_digit_width
+    def checksum_width
       2
     end
 
@@ -177,14 +177,14 @@ module SecID
 
     # @param rest [String] the IBAN string after country code
     # @return [void]
-    def extract_check_digit_and_bban(rest)
+    def extract_checksum_and_bban(rest)
       expected = expected_bban_length_for_country
 
-      if check_digits?(rest, expected)
-        @check_digit = rest[0, 2].to_i
+      if checksum?(rest, expected)
+        @checksum = rest[0, 2].to_i
         @bban = rest[2..]
       else
-        @check_digit = nil
+        @checksum = nil
         @bban = rest
       end
     end
@@ -197,11 +197,11 @@ module SecID
     # @param rest [String] the IBAN string after country code
     # @param expected_bban_length [Integer, nil] the expected BBAN length for the country
     # @return [Boolean]
-    def check_digits?(rest, expected_bban_length)
+    def checksum?(rest, expected_bban_length)
       return false unless rest[0, 2].match?(/\A\d{2}\z/)
       return true unless expected_bban_length
 
-      # If we know expected BBAN length, check if rest matches with or without check digits
+      # If we know expected BBAN length, check if rest matches with or without checksum
       rest.length == expected_bban_length + 2 || rest.length != expected_bban_length
     end
 

data/lib/sec_id/isin.rb

@@ -4,14 +4,14 @@ module SecID
   # International Securities Identification Number (ISIN) - a 12-character alphanumeric code
   # that uniquely identifies a security globally.
   #
-  # Format: 2-letter country code + 9-character NSIN + 1-digit check digit
+  # Format: 2-letter country code + 9-character NSIN + 1-digit checksum
   #
   # @see https://en.wikipedia.org/wiki/International_Securities_Identification_Number
   #
   # @example Validate an ISIN
   #   SecID::ISIN.valid?('US5949181045')  #=> true
   #
-  # @example Restore check digit
+  # @example Restore checksum
   #   SecID::ISIN.restore!('US594918104')  #=> #<SecID::ISIN>
   class ISIN < Base
     include Checkable
@@ -30,7 +30,7 @@ module SecID
       (?<identifier>
         (?<country_code>[A-Z]{2})
         (?<nsin>[A-Z0-9]{9}))
-      (?<check_digit>\d)?
+      (?<checksum>\d)?
     \z/x
 
     # Country codes that use CUSIP Global Services (CGS) for NSIN assignment.
@@ -71,19 +71,19 @@ module SecID
       @identifier = isin_parts[:identifier]
       @country_code = isin_parts[:country_code]
       @nsin = isin_parts[:nsin]
-      @check_digit = isin_parts[:check_digit]&.to_i
+      @checksum = isin_parts[:checksum]&.to_i
     end
 
     # @return [String, nil]
     def to_pretty_s
       return nil unless valid?
 
-      "#{country_code} #{nsin} #{check_digit}"
+      "#{country_code} #{nsin} #{checksum}"
     end
 
-    # @return [Integer] the calculated check digit (0-9)
+    # @return [Integer] the calculated checksum (0-9)
     # @raise [InvalidFormatError] if the ISIN format is invalid
-    def calculate_check_digit
+    def calculate_checksum
       validate_format_for_calculation!
       mod10(luhn_sum_standard(reversed_digits_multi(identifier)))
     end
@@ -91,7 +91,7 @@ module SecID
     # Generates a random ISIN body: 2-letter country code + 9-character NSIN.
     #
     # @param random [Random] source of randomness
-    # @return [String] an 11-character ISIN body without check digit
+    # @return [String] an 11-character ISIN body without checksum
     def self.generate_body(random)
       "#{random_string(ALPHA, 2, random: random)}#{random_string(ALPHANUMERIC, 9, random: random)}"
     end
@@ -177,6 +177,6 @@ module SecID
     private
 
     # @return [Hash]
-    def components = { country_code:, nsin:, check_digit: }
+    def components = { country_code:, nsin:, checksum: }
   end
 end

data/lib/sec_id/lei.rb

@@ -4,7 +4,7 @@ module SecID
   # Legal Entity Identifier (LEI) - a 20-character alphanumeric code that
   # uniquely identifies legal entities participating in financial transactions.
   #
-  # Format: 4-character LOU ID + 2-character reserved + 12-character entity ID + 2-digit check digit
+  # Format: 4-character LOU ID + 2-character reserved + 12-character entity ID + 2-digit checksum
   #
   # @see https://en.wikipedia.org/wiki/Legal_Entity_Identifier
   # @see https://www.gleif.org/en/about-lei/iso-17442-the-lei-code-structure
@@ -12,8 +12,8 @@ module SecID
   # @example Validate a LEI
   #   SecID::LEI.valid?('529900T8BM49AURSDO55')  #=> true
   #
-  # @example Calculate check digit
-  #   SecID::LEI.check_digit('529900T8BM49AURSDO')  #=> 55
+  # @example Calculate checksum
+  #   SecID::LEI.checksum('529900T8BM49AURSDO')  #=> 55
   class LEI < Base
     include Checkable
 
@@ -32,7 +32,7 @@ module SecID
         (?<lou_id>[0-9A-Z]{4})
         (?<reserved>[0-9A-Z]{2})
         (?<entity_id>[0-9A-Z]{12}))
-      (?<check_digit>\d{2})?
+      (?<checksum>\d{2})?
     \z/x
 
     # @return [String, nil] the 4-character Local Operating Unit (LOU) identifier
@@ -51,7 +51,7 @@ module SecID
       @lou_id = lei_parts[:lou_id]
       @reserved = lei_parts[:reserved]
       @entity_id = lei_parts[:entity_id]
-      @check_digit = lei_parts[:check_digit]&.to_i
+      @checksum = lei_parts[:checksum]&.to_i
     end
 
     # @return [String, nil]
@@ -61,9 +61,9 @@ module SecID
       to_s.scan(/.{1,4}/).join(' ')
     end
 
-    # @return [Integer] the calculated 2-digit check digit (1-98)
+    # @return [Integer] the calculated 2-digit checksum (1-98)
     # @raise [InvalidFormatError] if the LEI format is invalid
-    def calculate_check_digit
+    def calculate_checksum
       validate_format_for_calculation!
       mod97("#{numeric_identifier}00")
     end
@@ -71,7 +71,7 @@ module SecID
     # Generates a random LEI body: 18 alphanumeric characters.
     #
     # @param random [Random] source of randomness
-    # @return [String] an 18-character LEI body without check digits
+    # @return [String] an 18-character LEI body without checksum
     def self.generate_body(random)
       random_string(ALPHANUMERIC, 18, random: random)
     end
@@ -80,10 +80,10 @@ module SecID
     private
 
     # @return [Hash]
-    def components = { lou_id:, reserved:, entity_id:, check_digit: }
+    def components = { lou_id:, reserved:, entity_id:, checksum: }
 
     # @return [Integer]
-    def check_digit_width
+    def checksum_width
       2
     end
 

data/lib/sec_id/occ.rb

@@ -6,7 +6,7 @@ module SecID
   # OCC Option Symbol - standardized option symbol format used by Option Clearing Corporation.
   # Format: 6-char underlying (padded) + 6-char date (YYMMDD) + type (C/P) + 8-digit strike (in mills).
   #
-  # @note OCC identifiers have no check digit and validation includes both format
+  # @note OCC identifiers have no checksum and validation includes both format
   #   and date parseability checks.
   #
   # @see https://en.wikipedia.org/wiki/Option_symbol#The_OCC_Option_Symbol

data/lib/sec_id/scanner.rb

@@ -51,12 +51,24 @@ module SecID
     private
 
     # @return [void]
-    def precompute # rubocop:disable Metrics/AbcSize
-      build_key_table
-      build_priority_table
+    def precompute
+      build_candidate_partitions
+      build_length_table
+    end
+
+    # Splits the registered classes by which CANDIDATE_RE group routes to them.
+    #
+    # @return [void]
+    def build_candidate_partitions
       @fisn_classes = @classes.select { |k| k.short_name == 'FISN' }
       @occ_classes = @classes.select { |k| k.short_name == 'OCC' }
       @simple_classes = @classes - @fisn_classes - @occ_classes
+    end
+
+    # Builds a Hash mapping each possible length to the classes that accept it.
+    #
+    # @return [void]
+    def build_length_table
       @candidates_by_length = Hash.new { |h, k| h[k] = [] }
       @classes.each do |klass|
         klass.length_values.each { |len| @candidates_by_length[len] << klass }
@@ -64,23 +76,6 @@ module SecID
       @candidates_by_length.each_value(&:freeze)
     end
 
-    # @return [void]
-    def build_key_table
-      @key_for = {}
-      @classes.each { |klass| @key_for[klass] = klass.short_name.downcase.to_sym }
-      @key_for.freeze
-    end
-
-    # @return [void]
-    def build_priority_table
-      @priority_for = {}
-      @classes.each_with_index do |klass, index|
-        check_digit_rank = klass.has_check_digit? ? 0 : 1
-        @priority_for[klass] = [check_digit_rank, klass.length_specificity, index].freeze
-      end
-      @priority_for.freeze
-    end
-
     # @param input [String]
     # @param target_classes [Array<Class>]
     # @return [void]
@@ -123,7 +118,7 @@ module SecID
       return unless best
 
       end_pos = start_pos + raw.length
-      Match.new(type: @key_for[best], raw: raw, range: start_pos...end_pos, identifier: best.new(cleaned))
+      Match.new(type: best.type_key, raw: raw, range: start_pos...end_pos, identifier: best.new(cleaned))
     end
 
     # @return [Class, nil]
@@ -134,7 +129,7 @@ module SecID
       return if candidates.empty?
 
       validated = candidates.select { |k| cleaned.match?(k::VALID_CHARS_REGEX) && k.valid?(cleaned) }
-      validated.min_by { |k| @priority_for[k] }
+      validated.min_by(&:detection_priority)
     end
   end
 end

data/lib/sec_id/sedol.rb

@@ -4,7 +4,7 @@ module SecID
   # Stock Exchange Daily Official List (SEDOL) - a 7-character alphanumeric code
   # that identifies securities traded on the London Stock Exchange and other UK exchanges.
   #
-  # Format: 6-character identifier + 1-digit check digit
+  # Format: 6-character identifier + 1-digit checksum
   # Note: SEDOL excludes vowels (A, E, I, O, U) to avoid forming words.
   #
   # @see https://en.wikipedia.org/wiki/SEDOL
@@ -12,8 +12,8 @@ module SecID
   # @example Validate a SEDOL
   #   SecID::SEDOL.valid?('B19GKT4')  #=> true
   #
-  # @example Calculate check digit
-  #   SecID::SEDOL.check_digit('B19GKT')  #=> 4
+  # @example Calculate checksum
+  #   SecID::SEDOL.checksum('B19GKT')  #=> 4
   class SEDOL < Base
     include Checkable
 
@@ -30,10 +30,10 @@ module SecID
     # Excludes vowels (A, E, I, O, U) from valid characters.
     ID_REGEX = /\A
       (?<identifier>[0-9BCDFGHJKLMNPQRSTVWXYZ]{6})
-      (?<check_digit>\d)?
+      (?<checksum>\d)?
     \z/x
 
-    # Weights applied to each character position in the check digit calculation.
+    # Weights applied to each character position in the checksum calculation.
     CHARACTER_WEIGHTS = [1, 3, 1, 7, 3, 9].freeze
 
     # Characters valid in a SEDOL body (alphanumeric excluding vowels).
@@ -43,14 +43,14 @@ module SecID
     def initialize(sedol)
       sedol_parts = parse sedol
       @identifier = sedol_parts[:identifier]
-      @check_digit = sedol_parts[:check_digit]&.to_i
+      @checksum = sedol_parts[:checksum]&.to_i
     end
 
     # Valid country codes for SEDOL to ISIN conversion.
     ISIN_COUNTRY_CODES = Set.new(%w[GB IE GG IM JE FK]).freeze
 
     # @param country_code [String] the ISO 3166-1 alpha-2 country code (default: 'GB')
-    # @return [ISIN] a new ISIN instance with calculated check digit
+    # @return [ISIN] a new ISIN instance with calculated checksum
     # @raise [InvalidFormatError] if the country code is not valid for SEDOL
     def to_isin(country_code = 'GB')
       unless ISIN_COUNTRY_CODES.include?(country_code)
@@ -60,9 +60,9 @@ module SecID
       ISIN.new("#{country_code}00#{restore}").restore!
     end
 
-    # @return [Integer] the calculated check digit (0-9)
+    # @return [Integer] the calculated checksum (0-9)
     # @raise [InvalidFormatError] if the SEDOL format is invalid
-    def calculate_check_digit
+    def calculate_checksum
       validate_format_for_calculation!
       mod10(weighted_sum)
     end
@@ -70,7 +70,7 @@ module SecID
     # Generates a random SEDOL body: 6 characters excluding vowels.
     #
     # @param random [Random] source of randomness
-    # @return [String] a 6-character SEDOL body without check digit
+    # @return [String] a 6-character SEDOL body without checksum
     def self.generate_body(random)
       random_string(GENERATE_CHARSET, 6, random: random)
     end
@@ -79,7 +79,7 @@ module SecID
     private
 
     # @return [Hash]
-    def components = { check_digit: }
+    def components = { checksum: }
 
     # NOTE: Not idiomatic Ruby, but optimized for performance.
     #