sec_id 4.1.0 → 4.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: a3391006ed4c0e135a0e94ef0d43da6aae3146a178f13c6237aec8d940931c52
-  data.tar.gz: a572d9b26de1c8c97476cd954caeefacc9fe44ac8ffff7f25d9b4a72ca058e54
+  metadata.gz: 58a56c99692f66ae9ff3be10064ab29e729f34d6877456a6c998ee1a3509478d
+  data.tar.gz: ed1ead1827a544b8c48894739916781ea62337aa75e26f7263dd54c08f70b074
 SHA512:
-  metadata.gz: 1d380490f4a25d1044734b7724bf7e752e7dbb43097a468d3210e8fd9f4efd185beac207d9b5adfc5cce0cedfd5ea944be269785f444fd7a4bbb449b63ea9962
-  data.tar.gz: 30434ebe94c7f2c7f3a311ab2a3857af1ae0b66b5993c3b659fd9f6852633171cd7e4ce3c73f7d1e554211cbb53259e1e7679236df243f8dfaf311a0a61cebee
+  metadata.gz: 437a5b95d0e14cead4d0392dbaa2da4fbc7c3325a01252f17032ca50e9dc3609a6dfe8e73947535de2e2fe228c460c33847635f90c0d99fddf6ff32c66117fbb
+  data.tar.gz: d2e44281f824c033add9074633432291794789b4f1b89e50b5977b1dfd34efd68e5dd2883c7c9076cf5e30316b6a8e487853185824f988827cad61e44e2c38c9

data/CHANGELOG.md

@@ -1,13 +1,31 @@
 # Changelog
 
+## [4.2.0] - 2025-01-12
+
+### Added
+
+- OCC support ([@wtn](https://github.com/wtn), [#93](https://github.com/svyatov/sec_id/pull/93))
+
+### Fixed
+
+- CUSIP#cins? usage example in README ([@wtn](https://github.com/wtn), [#91](https://github.com/svyatov/sec_id/pull/91))
+
+### Updated
+
+- Separate CIK from Base for cleaner architecture ([@wtn](https://github.com/wtn), [#92](https://github.com/svyatov/sec_id/pull/92))
+- Use rubocop-rspec plugin ([@wtn](https://github.com/wtn), [#90](https://github.com/svyatov/sec_id/pull/90))
+- Replace CodeClimate with Codecov
+- Add permissions to CI workflow
+- Clean up gemspec: update description and simplify files list
+
 ## [4.1.0] - 2024-09-23
 
 ### Added
 
-- FIGI support ([@wtn][], #84)
-- CIK support ([@wtn][], #85)
-- Convert between CUSIPs and ISINs ([@wtn][], #86, #88)
-- CINS check method for CUSIPs ([@wtn][], #87)
+- FIGI support ([@wtn](https://github.com/wtn), [#84](https://github.com/svyatov/sec_id/pull/84))
+- CIK support ([@wtn](https://github.com/wtn), [#85](https://github.com/svyatov/sec_id/pull/85))
+- Convert between CUSIPs and ISINs ([@wtn](https://github.com/wtn), [#86](https://github.com/svyatov/sec_id/pull/86), [#88](https://github.com/svyatov/sec_id/pull/88))
+- CINS check method for CUSIPs ([@wtn](https://github.com/wtn), [#87](https://github.com/svyatov/sec_id/pull/87))
 
 ### Updated
 

data/README.md

@@ -1,8 +1,7 @@
 # SecId
 [![Gem Version](https://badge.fury.io/rb/sec_id.svg)](https://badge.fury.io/rb/sec_id)
+[![codecov](https://codecov.io/gh/svyatov/sec_id/graph/badge.svg)](https://codecov.io/gh/svyatov/sec_id)
 ![Build Status](https://github.com/svyatov/sec_id/actions/workflows/main.yml/badge.svg?branch=main)
-[![Maintainability](https://api.codeclimate.com/v1/badges/a4759963a5ddc4d55b24/maintainability)](https://codeclimate.com/github/svyatov/sec_id/maintainability)
-[![Test Coverage](https://api.codeclimate.com/v1/badges/a4759963a5ddc4d55b24/test_coverage)](https://codeclimate.com/github/svyatov/sec_id/test_coverage)
 
 Validate securities identification numbers with ease!
 
@@ -13,7 +12,8 @@ Currently supported standards:
 [CUSIP](https://en.wikipedia.org/wiki/CUSIP),
 [SEDOL](https://en.wikipedia.org/wiki/SEDOL),
 [FIGI](https://en.wikipedia.org/wiki/Financial_Instrument_Global_Identifier),
-[CIK](https://en.wikipedia.org/wiki/Central_Index_Key).
+[CIK](https://en.wikipedia.org/wiki/Central_Index_Key),
+[OCC](https://en.wikipedia.org/wiki/Option_symbol#The_OCC_Option_Symbol).
 
 Work in progress:
 [IBAN](https://en.wikipedia.org/wiki/International_Bank_Account_Number).
@@ -23,7 +23,7 @@ Work in progress:
 Add this line to your application's Gemfile:
 
 ```ruby
-gem 'sec_id', '~> 4.1'
+gem 'sec_id', '~> 4.2'
 ```
 
 And then execute:
@@ -140,7 +140,7 @@ cusip.valid_format?         # => true
 cusip.restore!              # => '594918104'
 cusip.calculate_check_digit # => 4
 cusip.to_isin('US')         # => #<SecId::ISIN>
-cusip.cins?                 # => true
+cusip.cins?                 # => false
 ```
 
 ### SecId::SEDOL full example
@@ -189,19 +189,54 @@ figi.calculate_check_digit # => 2
 # class level
 SecId::CIK.valid?('0001094517')        # => true
 SecId::CIK.valid_format?('0001094517') # => true
-SecId::CIK.restore!('1094517')         # => '0001094517'
-SecId::CIK.check_digit('0001094517')   # raises NotImplementedError
+SecId::CIK.normalize!('1094517')       # => '0001094517'
 
 # instance level
 cik = SecId::CIK.new('0001094517')
-cik.full_number           # => '0001094517'
-cik.padding               # => '000'
-cik.identifier            # => '1094517'
-cik.valid?                # => true
-cik.valid_format?         # => true
-cik.restore!              # => '0001094517'
-cik.calculate_check_digit # raises NotImplementedError
-cik.check_digit           # => nil
+cik.full_number   # => '0001094517'
+cik.padding       # => '000'
+cik.identifier    # => '1094517'
+cik.valid?        # => true
+cik.valid_format? # => true
+cik.normalize!    # => '0001094517'
+cik.to_s          # => '0001094517'
+```
+
+### SecId::OCC full example
+
+```ruby
+# class level
+SecId::OCC.valid?('BRKB  100417C00090000')        # => true
+SecId::OCC.valid_format?('BRKB  100417C00090000') # => true
+SecId::OCC.normalize!('BRKB100417C00090000')      # => 'BRKB  100417C00090000'
+SecId::OCC.build(
+  underlying: 'BRKB',
+  date: Date.new(2010, 4, 17),
+  type: 'C',
+  strike: 90,
+)                                                 # => #<SecId::OCC>
+
+# instance level
+occ = SecId::OCC.new('BRKB  100417C00090000')
+occ.full_symbol   # => 'BRKB  100417C00090000'
+occ.underlying    # => 'BRKB'
+occ.date_str      # => '100417'
+occ.date_obj      # => #<Date: 2010-04-17>
+occ.type          # => 'C'
+occ.strike        # => 90.0
+occ.valid?        # => true
+occ.valid_format? # => true
+occ.normalize!    # => 'BRKB  100417C00090000'
+
+occ = SecId::OCC.new('BRKB 2010-04-17C00090000')
+occ.valid_format? # => false
+occ.normalize!    # raises SecId::InvalidFormatError
+
+occ = SecId::OCC.new('X 250620C00050000')
+occ.full_symbol   # => 'X 250620C00050000'
+occ.valid?        # => true
+occ.normalize!    # => 'X     250620C00050000'
+occ.full_symbol   # => 'X     250620C00050000'
 ```
 
 ## Development

data/lib/sec_id/cik.rb

@@ -2,15 +2,29 @@
 
 module SecId
   # https://en.wikipedia.org/wiki/Central_Index_Key
-  class CIK < Base
+  class CIK
     ID_REGEX = /\A
       (?=\d{1,10}\z)(?<padding>0*)(?<identifier>[1-9]\d{0,9})
     \z/x
 
-    attr_reader :padding
+    attr_reader :full_number, :identifier, :padding
+
+    class << self
+      def valid?(id)
+        new(id).valid?
+      end
+
+      def valid_format?(id)
+        new(id).valid_format?
+      end
+
+      def normalize!(id)
+        new(id).normalize!
+      end
+    end
 
     def initialize(cik)
-      cik_parts = parse cik
+      cik_parts = parse(cik)
       @padding = cik_parts[:padding]
       @identifier = cik_parts[:identifier]
     end
@@ -23,11 +37,23 @@ module SecId
       !identifier.nil?
     end
 
-    def restore!
-      raise InvalidFormatError, "CIK '#{full_number}' is invalid and cannot be restored!" unless valid_format?
+    def normalize!
+      raise InvalidFormatError, "CIK '#{full_number}' is invalid and cannot be normalized!" unless valid_format?
 
       @padding = '0' * (10 - @identifier.length)
       @full_number = @identifier.rjust(10, '0')
     end
+
+    def to_s
+      full_number
+    end
+    alias to_str to_s
+
+    private
+
+    def parse(cik_number)
+      @full_number = cik_number.to_s.strip
+      @full_number.match(ID_REGEX) || {}
+    end
   end
 end

data/lib/sec_id/occ.rb

@@ -0,0 +1,103 @@
+# frozen_string_literal: true
+
+require 'date'
+
+module SecId
+  # https://en.wikipedia.org/wiki/Option_symbol#The_OCC_Option_Symbol
+  # https://web.archive.org/web/20120507220143/http://www.theocc.com/components/docs/initiatives/symbology/symbology_initiative_v1_8.pdf
+  class OCC
+    ID_REGEX = /\A
+      (?<initial>
+        (?=.{1,6})(?<underlying>\d?[A-Z]{1,5}\d?)(?<padding>[ ]*))
+      (?<date>\d{6})
+      (?<type>[CP])
+      (?<strike_mills>\d{8})
+    \z/x
+
+    attr_reader :full_symbol, :underlying, :date_str, :type
+
+    def initialize(symbol)
+      symbol_parts = parse symbol
+      @initial = symbol_parts[:initial]
+      @underlying = symbol_parts[:underlying]
+      @date_str = symbol_parts[:date]
+      @type = symbol_parts[:type]
+      @strike_mills = symbol_parts[:strike_mills]
+    end
+
+    def date
+      return @date if @date
+
+      @date = Date.strptime(date_str, '%y%m%d') if date_str
+    rescue Date::Error
+      nil
+    end
+    alias date_obj date
+
+    def strike
+      @strike ||= @strike_mills.to_i / 1000.0
+    end
+
+    def valid?
+      valid_format? && !date.nil?
+    end
+
+    def valid_format?
+      !@initial.nil?
+    end
+
+    def normalize!
+      raise InvalidFormatError, "OCC '#{full_symbol}' is invalid and cannot be normalized!" unless valid?
+
+      @strike_mills.length > 8 && @strike_mills = format('%08d', @strike_mills.to_i)
+      @initial.length < 6 && @initial = underlying.ljust(6, "\s")
+
+      @full_symbol = "#{@initial}#{date_str}#{type}#{@strike_mills}"
+    end
+
+    def to_s
+      full_symbol
+    end
+    alias to_str to_s
+
+    class << self
+      def valid?(id)
+        new(id).valid?
+      end
+
+      def valid_format?(id)
+        new(id).valid_format?
+      end
+
+      def normalize!(id)
+        new(id).normalize!
+      end
+
+      # rubocop:disable Metrics/MethodLength
+      def build(underlying:, date:, type:, strike:)
+        initial = underlying.to_s.ljust(6, "\s")
+        date = Date.parse(date.to_s) unless date.is_a?(Date)
+
+        case strike
+        when Numeric
+          strike_mills = format('%08d', (strike * 1000).to_i)
+        when /\A\d{8}\z/
+          strike_mills = strike
+        else
+          raise ArgumentError, 'Strike must be numeric or an 8-char string!'
+        end
+
+        symbol = "#{initial}#{date.strftime('%y%m%d')}#{type}#{strike_mills}"
+        new(symbol)
+      end
+      # rubocop:enable Metrics/MethodLength
+    end
+
+    private
+
+    def parse(symbol)
+      @full_symbol = symbol.to_s.strip
+      @full_symbol.match(ID_REGEX) || {}
+    end
+  end
+end

data/lib/sec_id/version.rb

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

data/lib/sec_id.rb

@@ -8,6 +8,7 @@ require 'sec_id/cusip'
 require 'sec_id/sedol'
 require 'sec_id/figi'
 require 'sec_id/cik'
+require 'sec_id/occ'
 
 module SecId
   Error = Class.new(StandardError)

data/sec_id.gemspec

@@ -11,16 +11,14 @@ Gem::Specification.new do |spec|
   spec.email         = ['leonid@svyatov.ru']
 
   spec.summary       = 'Validate securities identification numbers with ease!'
-  spec.description   = %(#{spec.summary} Currently supported standards: ISIN, CUSIP, SEDOL.)
+  spec.description   = %(#{spec.summary} Currently supported standards: ISIN, CUSIP, SEDOL, FIGI, CIK, OCC.)
   spec.homepage      = 'https://github.com/svyatov/sec_id'
   spec.license       = 'MIT'
 
   spec.required_ruby_version = '>= 3.1.0'
 
   spec.require_paths = ['lib']
-  spec.files = `git ls-files -z`.split("\x0").reject do |f|
-    f.match(%r{^(test|spec|features)/})
-  end
+  spec.files = Dir['lib/**/*.rb'] + %w[CHANGELOG.md LICENSE.txt README.md sec_id.gemspec]
 
   spec.metadata['rubygems_mfa_required'] = 'true'
 end

metadata

@@ -1,41 +1,32 @@
 --- !ruby/object:Gem::Specification
 name: sec_id
 version: !ruby/object:Gem::Version
-  version: 4.1.0
+  version: 4.2.0
 platform: ruby
 authors:
 - Leonid Svyatov
-autorequire:
 bindir: bin
 cert_chain: []
-date: 2024-09-23 00:00:00.000000000 Z
+date: 1980-01-02 00:00:00.000000000 Z
 dependencies: []
 description: 'Validate securities identification numbers with ease! Currently supported
-  standards: ISIN, CUSIP, SEDOL.'
+  standards: ISIN, CUSIP, SEDOL, FIGI, CIK, OCC.'
 email:
 - leonid@svyatov.ru
 executables: []
 extensions: []
 extra_rdoc_files: []
 files:
-- ".github/dependabot.yml"
-- ".github/workflows/main.yml"
-- ".gitignore"
-- ".rspec"
-- ".rubocop.yml"
 - CHANGELOG.md
-- Gemfile
 - LICENSE.txt
 - README.md
-- Rakefile
-- bin/console
-- bin/setup
 - lib/sec_id.rb
 - lib/sec_id/base.rb
 - lib/sec_id/cik.rb
 - lib/sec_id/cusip.rb
 - lib/sec_id/figi.rb
 - lib/sec_id/isin.rb
+- lib/sec_id/occ.rb
 - lib/sec_id/sedol.rb
 - lib/sec_id/version.rb
 - sec_id.gemspec
@@ -44,7 +35,6 @@ licenses:
 - MIT
 metadata:
   rubygems_mfa_required: 'true'
-post_install_message:
 rdoc_options: []
 require_paths:
 - lib
@@ -59,8 +49,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.5.15
-signing_key:
+rubygems_version: 4.0.3
 specification_version: 4
 summary: Validate securities identification numbers with ease!
 test_files: []

data/.github/dependabot.yml

@@ -1,11 +0,0 @@
-# To get started with Dependabot version updates, you'll need to specify which
-# package ecosystems to update and where the package manifests are located.
-# Please see the documentation for all configuration options:
-# https://docs.github.com/code-security/dependabot/dependabot-version-updates/configuration-options-for-the-dependabot.yml-file
-
-version: 2
-updates:
-  - package-ecosystem: "bundler" # See documentation for possible values
-    directory: "/" # Location of package manifests
-    schedule:
-      interval: "weekly"

data/.github/workflows/main.yml

@@ -1,39 +0,0 @@
-name: CI
-
-concurrency:
-  group: ${{ github.workflow }}-${{ github.ref }}
-  cancel-in-progress: true
-
-on:
-  push:
-    branches: ["main"]
-  pull_request:
-    branches: ["main"]
-
-jobs:
-  build:
-    runs-on: ubuntu-latest
-    name: Ruby ${{ matrix.ruby_version }}
-    strategy:
-      matrix:
-        ruby_version: [ruby-head, '3.3', '3.2', '3.1']
-
-    env:
-      COVERAGE: true
-      CC_TEST_REPORTER_ID: ${{ vars.CC_TEST_REPORTER_ID }}
-
-    steps:
-    - uses: actions/checkout@v4
-
-    - uses: ruby/setup-ruby@v1
-      with:
-        ruby-version: ${{ matrix.ruby_version }}
-        bundler-cache: true
-      continue-on-error: ${{ matrix.ruby_version == 'ruby-head' }}
-
-    - run: bundle exec rake
-      continue-on-error:  ${{ matrix.ruby_version == 'ruby-head' }}
-
-    - uses: paambaati/codeclimate-action@v8.0.0
-      # Only upload coverage for the latest Ruby and don't run for PRs from forks
-      if: ${{ matrix.ruby_version == '3.3' && github.event.pull_request.head.repo.fork == false }}

data/.gitignore

@@ -1,12 +0,0 @@
-/.bundle/
-/.yardoc
-/Gemfile.lock
-/_yardoc/
-/coverage/
-/doc/
-/pkg/
-/spec/reports/
-/tmp/
-
-# rspec failure tracking
-.rspec_status

data/.rspec

@@ -1,3 +0,0 @@
---format documentation
---color
---require spec_helper

data/.rubocop.yml

@@ -1,39 +0,0 @@
-require:
-  - rubocop-rspec
-
-AllCops:
-  TargetRubyVersion: 3.1
-  DisplayCopNames: true
-  DisplayStyleGuide: true
-  ExtraDetails: true
-  SuggestExtensions: false
-  NewCops: enable
-
-Layout/LineLength:
-  Max: 120
-
-Style/Documentation:
-  Enabled: false
-
-Style/HashEachMethods:
-  Enabled: true
-
-Style/HashTransformKeys:
-  Enabled: true
-
-Style/HashTransformValues:
-  Enabled: true
-
-Metrics/BlockLength:
-  Exclude:
-    - 'spec/**/*'
-
-Lint/MissingSuper:
-  AllowedParentClasses:
-    - Base
-
-RSpec/MultipleExpectations:
-  Max: 5
-
-RSpec/ExampleLength:
-  Max: 10

data/Gemfile

@@ -1,20 +0,0 @@
-# frozen_string_literal: true
-
-source 'https://rubygems.org'
-
-git_source(:github) { |repo_name| "https://github.com/#{repo_name}" }
-
-# Specify your gem's dependencies in sec_id.gemspec
-gemspec
-
-# Specify your gem's development dependencies below
-gem 'rake', '>= 13'
-
-gem 'rspec', '~> 3.9'
-gem 'rspec_junit_formatter'
-
-gem 'rubocop', '~> 1.64'
-gem 'rubocop-rspec', '~> 3.0'
-
-gem 'simplecov', '~> 0.22', require: false
-gem 'simplecov_json_formatter', require: false

data/Rakefile

@@ -1,13 +0,0 @@
-# frozen_string_literal: true
-
-require 'bundler/gem_tasks'
-require 'rspec/core/rake_task'
-require 'rubocop/rake_task'
-
-RSpec::Core::RakeTask.new(:spec)
-
-RuboCop::RakeTask.new do |task|
-  task.requires << 'rubocop-rspec'
-end
-
-task default: %i[rubocop spec]

data/bin/console

@@ -1,15 +0,0 @@
-#!/usr/bin/env ruby
-# frozen_string_literal: true
-
-require 'bundler/setup'
-require 'sec_id'
-
-# You can add fixtures and/or initialization code here to make experimenting
-# with your gem easier. You can also use a different console, if you like.
-
-# (If you use this, don't forget to add pry to your Gemfile!)
-# require "pry"
-# Pry.start
-
-require 'irb'
-IRB.start(__FILE__)

data/bin/setup

@@ -1,8 +0,0 @@
-#!/usr/bin/env bash
-set -euo pipefail
-IFS=$'\n\t'
-set -vx
-
-bundle install
-
-# Do any other automated setup that you need to do here