sec_id 6.1.0 → 7.0.0

data/sig/sec_id/deprecation.rbs

@@ -0,0 +1,6 @@
+module SecID
+  # Emits standardized, silenceable deprecation warnings for the v7 → v8 rename bridge.
+  module Deprecation
+    def self.warn: (old: String, new: String, ?removed_in: String) -> void
+  end
+end

data/sig/sec_id/dti.rbs

@@ -15,13 +15,18 @@ module SecID
     GRANDFATHERED_CODES: Hash[String, String]
 
     def initialize: (SecID::input dti) -> void
+    def calculate_checksum: () -> String
+    def self.checksum: (SecID::input id) -> String
+    # @deprecated v7 bridge alias for `calculate_checksum`; removed in v8.
     def calculate_check_digit: () -> String
+    # @deprecated v7 bridge alias for `checksum`; removed in v8.
+    def self.check_digit: (SecID::input id) -> String
     private def self.generate_body: (Random random) -> String
 
     private
 
     def components: () -> Hash[Symbol, untyped]
-    def grandfathered_check_digit: (untyped base) -> String?
+    def grandfathered_checksum: (untyped base) -> String?
     def iso7064_mod31_30_check_char: (untyped base) -> String
   end
 end

data/sig/sec_id/figi.rbs

@@ -17,7 +17,11 @@ module SecID
 
     def initialize: (SecID::input figi) -> void
     def to_pretty_s: () -> String?
+    def calculate_checksum: () -> Integer
+    def self.checksum: (SecID::input id) -> Integer
+    # @deprecated v7 bridge alias for `calculate_checksum`; removed in v8.
     def calculate_check_digit: () -> Integer
+    # @deprecated v7 bridge alias for `checksum`; removed in v8.
     def self.check_digit: (SecID::input id) -> Integer
     private def self.generate_body: (Random random) -> String
 

data/sig/sec_id/iban.rbs

@@ -26,7 +26,11 @@ module SecID
 
     def initialize: (SecID::input iban) -> void
     def restore: () -> String
+    def calculate_checksum: () -> Integer
+    def self.checksum: (SecID::input id) -> Integer
+    # @deprecated v7 bridge alias for `calculate_checksum`; removed in v8.
     def calculate_check_digit: () -> Integer
+    # @deprecated v7 bridge alias for `checksum`; removed in v8.
     def self.check_digit: (SecID::input id) -> Integer
     private def self.generate_body: (Random random) -> String
     def valid_bban_format?: () -> bool
@@ -38,13 +42,13 @@ module SecID
     private
 
     def components: () -> Hash[Symbol, untyped]
-    def check_digit_width: () -> Integer
+    def checksum_width: () -> Integer
     def valid_format?: () -> bool
     def detect_errors: () -> Array[Symbol]
     def validation_message: (Symbol code) -> String?
-    def extract_check_digit_and_bban: (String rest) -> void
+    def extract_checksum_and_bban: (String rest) -> void
     def expected_bban_length_for_country: () -> Integer?
-    def check_digits?: (untyped rest, Integer? expected_bban_length) -> bool
+    def checksum?: (untyped rest, Integer? expected_bban_length) -> bool
     def extract_bban_components: () -> void
     def valid_bban_length_only?: () -> bool
     def numeric_string_for_check: () -> String

data/sig/sec_id/isin.rbs

@@ -19,7 +19,11 @@ module SecID
 
     def initialize: (SecID::input isin) -> void
     def to_pretty_s: () -> String?
+    def calculate_checksum: () -> Integer
+    def self.checksum: (SecID::input id) -> Integer
+    # @deprecated v7 bridge alias for `calculate_checksum`; removed in v8.
     def calculate_check_digit: () -> Integer
+    # @deprecated v7 bridge alias for `checksum`; removed in v8.
     def self.check_digit: (SecID::input id) -> Integer
     private def self.generate_body: (Random random) -> String
     def to_cusip: () -> CUSIP

data/sig/sec_id/lei.rbs

@@ -20,14 +20,18 @@ module SecID
 
     def initialize: (SecID::input lei) -> void
     def to_pretty_s: () -> String?
+    def calculate_checksum: () -> Integer
+    def self.checksum: (SecID::input id) -> Integer
+    # @deprecated v7 bridge alias for `calculate_checksum`; removed in v8.
     def calculate_check_digit: () -> Integer
+    # @deprecated v7 bridge alias for `checksum`; removed in v8.
     def self.check_digit: (SecID::input id) -> Integer
     private def self.generate_body: (Random random) -> String
 
     private
 
     def components: () -> Hash[Symbol, untyped]
-    def check_digit_width: () -> Integer
+    def checksum_width: () -> Integer
     def numeric_identifier: () -> String
   end
 end

data/sig/sec_id/sedol.rbs

@@ -19,7 +19,11 @@ module SecID
 
     def initialize: (SecID::input sedol) -> void
     def to_isin: (?String country_code) -> ISIN
+    def calculate_checksum: () -> Integer
+    def self.checksum: (SecID::input id) -> Integer
+    # @deprecated v7 bridge alias for `calculate_checksum`; removed in v8.
     def calculate_check_digit: () -> Integer
+    # @deprecated v7 bridge alias for `checksum`; removed in v8.
     def self.check_digit: (SecID::input id) -> Integer
     private def self.generate_body: (Random random) -> String
 

data/sig/sec_id/upi.rbs

@@ -0,0 +1,29 @@
+module SecID
+  # Unique Product Identifier (UPI, ISO 4914).
+  class UPI < Base
+    include Checkable
+    extend Checkable::ClassMethods
+
+    FULL_NAME: String
+    ID_LENGTH: Integer
+    EXAMPLE: String
+    VALID_CHARS_REGEX: ::Regexp
+    ID_REGEX: ::Regexp
+    ALPHABET: Array[String]
+    ALPHABET_VALUE: Hash[String, Integer]
+    GENERATE_CHARSET: Array[String]
+
+    def initialize: (SecID::input upi) -> void
+    def calculate_checksum: () -> String
+    def self.checksum: (SecID::input id) -> String
+    # @deprecated v7 bridge alias for `calculate_checksum`; removed in v8.
+    def calculate_check_digit: () -> String
+    # @deprecated v7 bridge alias for `checksum`; removed in v8.
+    def self.check_digit: (SecID::input id) -> String
+    private def self.generate_body: (Random random) -> String
+
+    private
+
+    def components: () -> Hash[Symbol, untyped]
+  end
+end

data/sig/sec_id.rbs

@@ -7,10 +7,13 @@ module SecID
   class InvalidFormatError < Error
   end
 
-  # Raised when the check digit does not match the calculated value.
-  class InvalidCheckDigitError < Error
+  # Raised when the checksum does not match the calculated value.
+  class InvalidChecksumError < Error
   end
 
+  # @deprecated v7 bridge constant alias for `InvalidChecksumError` (same class object); removed in v8.
+  InvalidCheckDigitError: singleton(InvalidChecksumError)
+
   # Raised for type-specific structural errors.
   class InvalidStructureError < Error
   end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: sec_id
 version: !ruby/object:Gem::Version
-  version: 6.1.0
+  version: 7.0.0
 platform: ruby
 authors:
 - Leonid Svyatov
@@ -11,10 +11,10 @@ date: 1980-01-02 00:00:00.000000000 Z
 dependencies: []
 description: Validate, normalize, parse, convert, generate, and classify securities
   identifiers. Auto-detect identifier type from any string. Calculate and restore
-  check digits. Generate format-valid identifiers as test fixtures. Decode CFI codes
+  checksums. Generate format-valid identifiers as test fixtures. Decode CFI codes
   to full ISO 10962:2021 classifications. Includes an opt-in ActiveModel/Rails validator
   that adds no runtime dependency. Supports ISIN, CUSIP, CEI, SEDOL, FIGI, LEI, IBAN,
-  CIK, OCC, WKN, Valoren, CFI, FISN, BIC, and DTI.
+  CIK, OCC, WKN, Valoren, CFI, FISN, BIC, DTI, and UPI.
 email:
 - leonid@svyatov.ru
 executables: []
@@ -44,6 +44,7 @@ files:
 - lib/sec_id/concerns/validatable.rb
 - lib/sec_id/cusip.rb
 - lib/sec_id/deep_freeze.rb
+- lib/sec_id/deprecation.rb
 - lib/sec_id/detector.rb
 - lib/sec_id/dti.rb
 - lib/sec_id/errors.rb
@@ -57,6 +58,7 @@ files:
 - lib/sec_id/railtie.rb
 - lib/sec_id/scanner.rb
 - lib/sec_id/sedol.rb
+- lib/sec_id/upi.rb
 - lib/sec_id/valoren.rb
 - lib/sec_id/version.rb
 - lib/sec_id/wkn.rb
@@ -79,6 +81,7 @@ files:
 - sig/sec_id/concerns/validatable.rbs
 - sig/sec_id/cusip.rbs
 - sig/sec_id/deep_freeze.rbs
+- sig/sec_id/deprecation.rbs
 - sig/sec_id/detector.rbs
 - sig/sec_id/dti.rbs
 - sig/sec_id/errors.rbs
@@ -91,6 +94,7 @@ files:
 - sig/sec_id/occ.rbs
 - sig/sec_id/scanner.rbs
 - sig/sec_id/sedol.rbs
+- sig/sec_id/upi.rbs
 - sig/sec_id/valoren.rbs
 - sig/sec_id/version.rbs
 - sig/sec_id/wkn.rbs