sec_id 4.3.0 → 4.4.0

data/lib/sec_id/isin.rb

@@ -14,6 +14,8 @@ module SecId
   # @example Restore check digit
   #   SecId::ISIN.restore!('US594918104')  #=> 'US5949181045'
   class ISIN < Base
+    include Checkable
+
     # Regular expression for parsing ISIN components.
     ID_REGEX = /\A
       (?<identifier>
@@ -25,12 +27,35 @@ module SecId
     # Country codes that use CUSIP Global Services (CGS) for NSIN assignment.
     CGS_COUNTRY_CODES = Set.new(
       %w[
-        US CA AG AI AN AR AS AW BB BL BM BO BQ BR BS BZ CL CO CR CW DM DO EC FM
-        GD GS GU GY HN HT JM KN KY LC MF MH MP MX NI PA PE PH PR PW PY SR SV SX
-        TT UM UY VC VE VG VI YT
+        US CA AG AI AN AR AS AW BB BL BM BO BQ BS BZ CL CO CR CW DM DO EC FM GD
+        GS GU GY HN HT JM KN KY LC MF MH MP MX NI PA PE PH PR PW PY SR SV SX TT
+        UM UY VC VE VG VI YT
       ]
     ).freeze
 
+    # Maps country codes to their NSIN identifier types.
+    # Countries not in this map return :generic (CGS countries handled via {#cgs?}).
+    NSIN_COUNTRY_TYPES = {
+      # SEDOL countries (UK, Ireland, Crown Dependencies, and Overseas Territories)
+      'GB' => :sedol,
+      'IE' => :sedol,
+      'GG' => :sedol,
+      'IM' => :sedol,
+      'JE' => :sedol,
+      'FK' => :sedol,
+      # WKN country (Germany)
+      'DE' => :wkn,
+      # Valoren countries (Switzerland and Liechtenstein)
+      'CH' => :valoren,
+      'LI' => :valoren
+    }.freeze
+
+    # Country codes that use SEDOL as their national identifier.
+    SEDOL_COUNTRY_CODES = Set.new(%w[GB IE IM JE GG FK]).freeze
+
+    # Country codes that use Valoren as their national identifier.
+    VALOREN_COUNTRY_CODES = Set.new(%w[CH LI]).freeze
+
     # @return [String, nil] the ISO 3166-1 alpha-2 country code
     attr_reader :country_code
 
@@ -50,7 +75,7 @@ module SecId
     # @raise [InvalidFormatError] if the ISIN format is invalid
     def calculate_check_digit
       validate_format_for_calculation!
-      mod10(luhn_sum)
+      mod10(luhn_sum_standard(reversed_digits_multi(identifier)))
     end
 
     # @return [CUSIP] a new CUSIP instance
@@ -66,21 +91,68 @@ module SecId
       CGS_COUNTRY_CODES.include?(country_code)
     end
 
-    private
+    # @return [Boolean] true if the country code uses SEDOL
+    def sedol?
+      SEDOL_COUNTRY_CODES.include?(country_code)
+    end
 
-    # @return [Integer] the Luhn sum
-    # @see https://en.wikipedia.org/wiki/Luhn_algorithm
-    def luhn_sum
-      reversed_id_digits.each_slice(2).reduce(0) do |sum, (even, odd)|
-        double_even = (even || 0) * 2
-        double_even -= 9 if double_even > 9
-        sum + double_even + (odd || 0)
-      end
+    # @return [Boolean] true if the country code uses WKN
+    def wkn?
+      country_code == 'DE'
+    end
+
+    # @return [Boolean] true if the country code uses Valoren
+    def valoren?
+      VALOREN_COUNTRY_CODES.include?(country_code)
+    end
+
+    # @return [SEDOL] a new SEDOL instance
+    # @raise [InvalidFormatError] if the country code is not valid for SEDOL
+    def to_sedol
+      raise InvalidFormatError, "'#{country_code}' is not a SEDOL country code!" unless sedol?
+
+      SEDOL.new(nsin[2..])
     end
 
-    # @return [Array<Integer>] the reversed digit array
-    def reversed_id_digits
-      identifier.each_char.flat_map(&method(:char_to_digits)).reverse!
+    # @return [WKN] a new WKN instance
+    # @raise [InvalidFormatError] if the country code is not DE
+    def to_wkn
+      raise InvalidFormatError, "'#{country_code}' is not a WKN country code!" unless wkn?
+
+      WKN.new(nsin[3..])
+    end
+
+    # @return [Valoren] a new Valoren instance
+    # @raise [InvalidFormatError] if the country code is not CH or LI
+    def to_valoren
+      raise InvalidFormatError, "'#{country_code}' is not a Valoren country code!" unless valoren?
+
+      Valoren.new(nsin)
+    end
+
+    # Returns the type of NSIN embedded in this ISIN.
+    #
+    # @return [Symbol] :cusip, :sedol, :wkn, :valoren, or :generic
+    def nsin_type
+      return :cusip if cgs?
+
+      NSIN_COUNTRY_TYPES.fetch(country_code, :generic)
+    end
+
+    # Extracts the national identifier from this ISIN.
+    #
+    # @return [CUSIP, SEDOL, WKN, Valoren, String] the extracted identifier
+    # @raise [InvalidFormatError] if ISIN format is invalid
+    def to_nsin
+      raise InvalidFormatError, 'Invalid ISIN format' unless valid_format?
+
+      case nsin_type
+      when :cusip   then to_cusip
+      when :sedol   then SEDOL.new(nsin[2..])
+      when :wkn     then WKN.new(nsin[3..])
+      when :valoren then Valoren.new(nsin)
+      else nsin # :generic - return raw string
+      end
     end
   end
 end

data/lib/sec_id/lei.rb

@@ -15,6 +15,8 @@ module SecId
   # @example Calculate check digit
   #   SecId::LEI.check_digit('529900T8BM49AURSDO')  #=> 55
   class LEI < Base
+    include Checkable
+
     # Regular expression for parsing LEI components.
     ID_REGEX = /\A
       (?<identifier>
@@ -61,7 +63,7 @@ module SecId
 
     # @return [String] the numeric string representation
     def numeric_identifier
-      identifier.each_char.map { |char| char_to_digit(char) }.join
+      identifier.each_char.map { |char| CHAR_TO_DIGIT.fetch(char) }.join
     end
   end
 end

data/lib/sec_id/occ.rb

@@ -97,12 +97,6 @@ module SecId
       @date_str = symbol_parts[:date]
       @type = symbol_parts[:type]
       @strike_mills = symbol_parts[:strike_mills]
-      @check_digit = nil
-    end
-
-    # @return [Boolean] always false
-    def has_check_digit?
-      false
     end
 
     # Normalizes the OCC symbol to standard format with 6-char padded underlying and 8-digit strike.

data/lib/sec_id/sedol.rb

@@ -15,6 +15,8 @@ module SecId
   # @example Calculate check digit
   #   SecId::SEDOL.check_digit('B19GKT')  #=> 4
   class SEDOL < Base
+    include Checkable
+
     # Regular expression for parsing SEDOL components.
     # Excludes vowels (A, E, I, O, U) from valid characters.
     ID_REGEX = /\A
@@ -32,6 +34,23 @@ module SecId
       @check_digit = sedol_parts[:check_digit]&.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
+    # @raise [InvalidFormatError] if the country code is not valid for SEDOL
+    def to_isin(country_code = 'GB')
+      unless ISIN_COUNTRY_CODES.include?(country_code)
+        raise InvalidFormatError, "'#{country_code}' is not a valid SEDOL country code!"
+      end
+
+      restore!
+      isin = ISIN.new("#{country_code}00#{full_number}")
+      isin.restore!
+      isin
+    end
+
     # @return [Integer] the calculated check digit (0-9)
     # @raise [InvalidFormatError] if the SEDOL format is invalid
     def calculate_check_digit
@@ -58,7 +77,7 @@ module SecId
 
     # @return [Array<Integer>] array of digit values
     def id_digits
-      @id_digits ||= identifier.each_char.map(&method(:char_to_digit))
+      @id_digits ||= identifier.each_char.map { |c| CHAR_TO_DIGIT.fetch(c) }
     end
   end
 end

data/lib/sec_id/valoren.rb

@@ -0,0 +1,74 @@
+# frozen_string_literal: true
+
+module SecId
+  # Valoren (Swiss Security Number) - a numeric identifier for securities
+  # in Switzerland, Liechtenstein, and Belgium.
+  #
+  # Format: 5-9 numeric digits
+  #
+  # @note Valoren identifiers have no check digit. The {#has_check_digit?} method
+  #   returns false and validation is based solely on format.
+  #
+  # @see https://en.wikipedia.org/wiki/Valoren_number
+  #
+  # @example Validate a Valoren
+  #   SecId::Valoren.valid?('3886335')    #=> true
+  #   SecId::Valoren.valid?('003886335')  #=> true
+  #
+  # @example Normalize a Valoren to 9 digits
+  #   SecId::Valoren.normalize!('3886335')  #=> '003886335'
+  class Valoren < Base
+    include Normalizable
+
+    # Regular expression for parsing Valoren components.
+    ID_REGEX = /\A
+      (?=\d{5,9}\z)(?<padding>0*)(?<identifier>[1-9]\d{4,8})
+    \z/x
+
+    # Valid country codes for Valoren to ISIN conversion.
+    ISIN_COUNTRY_CODES = Set.new(%w[CH LI]).freeze
+
+    # @return [String, nil] the leading zeros in the Valoren
+    attr_reader :padding
+
+    # @param valoren [String, Integer] the Valoren to parse
+    def initialize(valoren)
+      valoren_parts = parse(valoren)
+      @padding = valoren_parts[:padding]
+      @identifier = valoren_parts[:identifier]
+    end
+
+    # @param country_code [String] the ISO 3166-1 alpha-2 country code (default: 'CH')
+    # @return [ISIN] a new ISIN instance with calculated check digit
+    # @raise [InvalidFormatError] if the country code is not CH or LI
+    def to_isin(country_code = 'CH')
+      unless ISIN_COUNTRY_CODES.include?(country_code)
+        raise InvalidFormatError, "'#{country_code}' is not a valid Valoren country code!"
+      end
+
+      normalize!
+      isin = ISIN.new(country_code + full_number)
+      isin.restore!
+      isin
+    end
+
+    # Normalizes the Valoren to a 9-digit zero-padded format.
+    # Updates both @full_number and @padding to reflect the normalized state.
+    #
+    # @return [String] the normalized 9-digit Valoren
+    # @raise [InvalidFormatError] if the Valoren format is invalid
+    def normalize!
+      raise InvalidFormatError, "Valoren '#{full_number}' is invalid and cannot be normalized!" unless valid_format?
+
+      @full_number = @identifier.rjust(9, '0')
+      @padding = @full_number[0, 9 - @identifier.length]
+      @full_number
+    end
+
+    # @return [String]
+    def to_s
+      full_number
+    end
+    alias to_str to_s
+  end
+end

data/lib/sec_id/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module SecId
-  VERSION = '4.3.0'
+  VERSION = '4.4.0'
 end

data/lib/sec_id/wkn.rb

@@ -0,0 +1,41 @@
+# frozen_string_literal: true
+
+module SecId
+  # Wertpapierkennnummer (WKN) - a 6-character alphanumeric code
+  # used to identify securities in Germany.
+  #
+  # Format: 6 alphanumeric characters (excluding I and O)
+  # Note: WKN excludes letters I and O to avoid confusion with 1 and 0.
+  #
+  # @see https://en.wikipedia.org/wiki/Wertpapierkennnummer
+  #
+  # @example Validate a WKN
+  #   SecId::WKN.valid?('514000')  #=> true
+  #   SecId::WKN.valid?('CBK100')  #=> true
+  class WKN < Base
+    # Regular expression for parsing WKN components.
+    # Excludes letters I and O to avoid confusion with 1 and 0.
+    ID_REGEX = /\A
+      (?<identifier>[0-9A-HJ-NP-Z]{6})
+    \z/x
+
+    # @param wkn [String] the WKN string to parse
+    def initialize(wkn)
+      wkn_parts = parse(wkn)
+      @identifier = wkn_parts[:identifier]
+    end
+
+    # @param country_code [String] the ISO 3166-1 alpha-2 country code (default: 'DE')
+    # @return [ISIN] a new ISIN instance with calculated check digit
+    # @raise [InvalidFormatError] if the country code is not DE
+    # @raise [InvalidFormatError] if the WKN format is invalid
+    def to_isin(country_code = 'DE')
+      raise InvalidFormatError, "'#{country_code}' is not a valid WKN country code!" unless country_code == 'DE'
+      raise InvalidFormatError, "WKN '#{full_number}' is invalid!" unless valid_format?
+
+      isin = ISIN.new("#{country_code}000#{identifier}")
+      isin.restore!
+      isin
+    end
+  end
+end

data/lib/sec_id.rb

@@ -2,7 +2,8 @@
 
 require 'set'
 require 'sec_id/version'
-require 'sec_id/normalizable'
+require 'sec_id/concerns/normalizable'
+require 'sec_id/concerns/checkable'
 require 'sec_id/base'
 require 'sec_id/isin'
 require 'sec_id/cusip'
@@ -12,8 +13,13 @@ require 'sec_id/lei'
 require 'sec_id/iban'
 require 'sec_id/cik'
 require 'sec_id/occ'
+require 'sec_id/wkn'
+require 'sec_id/valoren'
+require 'sec_id/cei'
+require 'sec_id/cfi'
+require 'sec_id/fisn'
 
 module SecId
-  Error = Class.new(StandardError)
-  InvalidFormatError = Class.new(Error)
+  class Error < StandardError; end
+  class InvalidFormatError < Error; end
 end

data/sec_id.gemspec

@@ -12,7 +12,8 @@ Gem::Specification.new do |spec|
 
   spec.summary       = 'Validate securities identification numbers with ease!'
   spec.description   = 'Validate, calculate check digits, and parse components of securities identifiers. ' \
-                       'Supports ISIN, CUSIP, SEDOL, FIGI, LEI, IBAN, CIK, and OCC standards.'
+                       'Supports ISIN, CUSIP, CEI, SEDOL, FIGI, LEI, IBAN, CIK, OCC, WKN, Valoren, CFI, ' \
+                       'and FISN standards.'
   spec.homepage      = 'https://github.com/svyatov/sec_id'
   spec.license       = 'MIT'
 

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: sec_id
 version: !ruby/object:Gem::Version
-  version: 4.3.0
+  version: 4.4.0
 platform: ruby
 authors:
 - Leonid Svyatov
@@ -10,7 +10,8 @@ cert_chain: []
 date: 1980-01-02 00:00:00.000000000 Z
 dependencies: []
 description: Validate, calculate check digits, and parse components of securities
-  identifiers. Supports ISIN, CUSIP, SEDOL, FIGI, LEI, IBAN, CIK, and OCC standards.
+  identifiers. Supports ISIN, CUSIP, CEI, SEDOL, FIGI, LEI, IBAN, CIK, OCC, WKN, Valoren,
+  CFI, and FISN standards.
 email:
 - leonid@svyatov.ru
 executables: []
@@ -22,17 +23,23 @@ files:
 - README.md
 - lib/sec_id.rb
 - lib/sec_id/base.rb
+- lib/sec_id/cei.rb
+- lib/sec_id/cfi.rb
 - lib/sec_id/cik.rb
+- lib/sec_id/concerns/checkable.rb
+- lib/sec_id/concerns/normalizable.rb
 - lib/sec_id/cusip.rb
 - lib/sec_id/figi.rb
+- lib/sec_id/fisn.rb
 - lib/sec_id/iban.rb
 - lib/sec_id/iban/country_rules.rb
 - lib/sec_id/isin.rb
 - lib/sec_id/lei.rb
-- lib/sec_id/normalizable.rb
 - lib/sec_id/occ.rb
 - lib/sec_id/sedol.rb
+- lib/sec_id/valoren.rb
 - lib/sec_id/version.rb
+- lib/sec_id/wkn.rb
 - sec_id.gemspec
 homepage: https://github.com/svyatov/sec_id
 licenses:
@@ -53,7 +60,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 4.0.3
+rubygems_version: 4.0.4
 specification_version: 4
 summary: Validate securities identification numbers with ease!
 test_files: []