sec_id 2.0.1 → 4.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 39592f5327accec4a952728b6a609c9c2e91adce7fe3097ee7aa980631ed89d9
-  data.tar.gz: e24a61f1e3ebe25096b53c8a59bce72cbb1049fb751fee5b1f7c517aa57e3712
+  metadata.gz: 374eb5eb544fd34d09e5d5008473b5516c3b9ac13e720dd7ea01062478da5248
+  data.tar.gz: 6b785b97c0bd99c56feb8a500f1376f228077f0d58503cb823af3d2abc790ae6
 SHA512:
-  metadata.gz: 87f2852f2c8fae7dcd46e0a731c38df333e210328963f64ce21dab8e4fe9529837740b15681eab82e2c3aeb7129a954d0fb8c08334f22a46673c5954e68a5a8c
-  data.tar.gz: 851b4d5bc78642ca4d184e245b1a163487cc36b51531e187f452a861b89ad378fc01e6b80ac9939b0534215da236c667bb1eee445dd7a733fec4834779d2dea1
+  metadata.gz: ca697d5bf5326587d437f6206e91d419ad11aad3166f6d2c75f423afae1fcaf3736860b313545d85761f9575bf85f56120f5d3d74e92158fa3c1ed9fc4d5be5d
+  data.tar.gz: 1c46330ecd6e07192eaf083dc28e41e7b3edbb83a1ee226f76817df4c3182fc20f4e42415350da9bf343b5e89445e1545d79cf1ca02dea15a380fe94f07bef82

data/.github/dependabot.yml

@@ -0,0 +1,11 @@
+# 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

@@ -0,0 +1,39 @@
+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
+      if: ${{ matrix.ruby_version == '3.3' }}

data/.rubocop.yml

@@ -2,21 +2,36 @@ require:
   - rubocop-rspec
 
 AllCops:
-  TargetRubyVersion: 2.3
+  TargetRubyVersion: 3.1
   DisplayCopNames: true
   DisplayStyleGuide: true
   ExtraDetails: true
+  SuggestExtensions: false
+  NewCops: enable
 
-Metrics/LineLength:
+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
 

data/CHANGELOG.md

@@ -1,5 +1,31 @@
 # Changelog
 
+## [4.0.0] - 2024-07-09
+
+### Breaking changes
+
+- Minimum required Ruby version is 3.1 now
+- Default repository branch renamed to `main`
+
+### Updated
+
+- Small internal refactorings
+- TravisCI -> GitHub Actions
+- Dropped tests for Ruby below 3.1
+- Rubocop's Ruby target version changed to 3.1
+
+## [3.0.0] - 2020-03-10
+
+### Breaking changes
+
+- Minimum required Ruby version is 2.5 now
+
+### Updated
+
+- Small internal refactorings
+- TravisCI config updated: dropped Ruby 2.3 and 2.4, added Ruby 2.7
+- Rubocop's Ruby target version changed to 2.5
+
 ## [2.0.0] - 2019-02-03
 
 ### Added

data/Gemfile

@@ -6,3 +6,15 @@ 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/README.md

@@ -1,7 +1,6 @@
 # SecId
 [![Gem Version](https://badge.fury.io/rb/sec_id.svg)](https://badge.fury.io/rb/sec_id)
-[![Build Status](https://travis-ci.org/svyatov/sec_id.svg?branch=master)](https://travis-ci.org/svyatov/sec_id)
-[![Depfu](https://badges.depfu.com/badges/ccb54ed1642be2d4d102b83d7d6a604c/overview.svg)](https://depfu.com/github/svyatov/sec_id?project_id=6878)
+![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)
 
@@ -22,7 +21,7 @@ Work in progress:
 Add this line to your application's Gemfile:
 
 ```ruby
-gem 'sec_id', '~> 2.0'
+gem 'sec_id', '~> 4.0'
 ```
 
 And then execute:

data/lib/sec_id/base.rb

@@ -1,45 +1,47 @@
 # frozen_string_literal: true
 
 module SecId
-  class Base
-    CHAR_TO_DIGITS = {
-      '0' => 0,      '1' => 1,      '2' => 2,      '3' => 3,      '4' => 4,
-      '5' => 5,      '6' => 6,      '7' => 7,      '8' => 8,      '9' => 9,
-      'A' => [1, 0], 'B' => [1, 1], 'C' => [1, 2], 'D' => [1, 3], 'E' => [1, 4],
-      'F' => [1, 5], 'G' => [1, 6], 'H' => [1, 7], 'I' => [1, 8], 'J' => [1, 9],
-      'K' => [2, 0], 'L' => [2, 1], 'M' => [2, 2], 'N' => [2, 3], 'O' => [2, 4],
-      'P' => [2, 5], 'Q' => [2, 6], 'R' => [2, 7], 'S' => [2, 8], 'T' => [2, 9],
-      'U' => [3, 0], 'V' => [3, 1], 'W' => [3, 2], 'X' => [3, 3], 'Y' => [3, 4], 'Z' => [3, 5],
-      '*' => [3, 6], '@' => [3, 7], '#' => [3, 8]
-    }.freeze
-
-    CHAR_TO_DIGIT = {
-      '0' => 0,  '1' => 1,  '2' => 2,  '3' => 3,  '4' =>  4,
-      '5' => 5,  '6' => 6,  '7' => 7,  '8' => 8,  '9' =>  9,
-      'A' => 10, 'B' => 11, 'C' => 12, 'D' => 13, 'E' => 14,
-      'F' => 15, 'G' => 16, 'H' => 17, 'I' => 18, 'J' => 19,
-      'K' => 20, 'L' => 21, 'M' => 22, 'N' => 23, 'O' => 24,
-      'P' => 25, 'Q' => 26, 'R' => 27, 'S' => 28, 'T' => 29,
-      'U' => 30, 'V' => 31, 'W' => 32, 'X' => 33, 'Y' => 34, 'Z' => 35,
-      '*' => 36, '@' => 37, '#' => 38
-    }.freeze
+  CHAR_TO_DIGITS = {
+    '0' => 0,      '1' => 1,      '2' => 2,      '3' => 3,      '4' => 4,
+    '5' => 5,      '6' => 6,      '7' => 7,      '8' => 8,      '9' => 9,
+    'A' => [1, 0], 'B' => [1, 1], 'C' => [1, 2], 'D' => [1, 3], 'E' => [1, 4],
+    'F' => [1, 5], 'G' => [1, 6], 'H' => [1, 7], 'I' => [1, 8], 'J' => [1, 9],
+    'K' => [2, 0], 'L' => [2, 1], 'M' => [2, 2], 'N' => [2, 3], 'O' => [2, 4],
+    'P' => [2, 5], 'Q' => [2, 6], 'R' => [2, 7], 'S' => [2, 8], 'T' => [2, 9],
+    'U' => [3, 0], 'V' => [3, 1], 'W' => [3, 2], 'X' => [3, 3], 'Y' => [3, 4], 'Z' => [3, 5],
+    '*' => [3, 6], '@' => [3, 7], '#' => [3, 8]
+  }.freeze
+
+  CHAR_TO_DIGIT = {
+    '0' => 0,  '1' => 1,  '2' => 2,  '3' => 3,  '4' =>  4,
+    '5' => 5,  '6' => 6,  '7' => 7,  '8' => 8,  '9' =>  9,
+    'A' => 10, 'B' => 11, 'C' => 12, 'D' => 13, 'E' => 14,
+    'F' => 15, 'G' => 16, 'H' => 17, 'I' => 18, 'J' => 19,
+    'K' => 20, 'L' => 21, 'M' => 22, 'N' => 23, 'O' => 24,
+    'P' => 25, 'Q' => 26, 'R' => 27, 'S' => 28, 'T' => 29,
+    'U' => 30, 'V' => 31, 'W' => 32, 'X' => 33, 'Y' => 34, 'Z' => 35,
+    '*' => 36, '@' => 37, '#' => 38
+  }.freeze
 
+  class Base
     attr_reader :full_number, :identifier, :check_digit
 
-    def self.valid?(id)
-      new(id).valid?
-    end
+    class << self
+      def valid?(id)
+        new(id).valid?
+      end
 
-    def self.valid_format?(id)
-      new(id).valid_format?
-    end
+      def valid_format?(id)
+        new(id).valid_format?
+      end
 
-    def self.restore!(id_without_check_digit)
-      new(id_without_check_digit).restore!
-    end
+      def restore!(id_without_check_digit)
+        new(id_without_check_digit).restore!
+      end
 
-    def self.check_digit(id)
-      new(id).calculate_check_digit
+      def check_digit(id)
+        new(id).calculate_check_digit
+      end
     end
 
     def initialize(_sec_id_number)
@@ -72,7 +74,7 @@ module SecId
 
     private
 
-    def digitized_identifier
+    def id_digits
       raise NotImplementedError
     end
 
@@ -82,18 +84,18 @@ module SecId
     end
 
     def char_to_digits(char)
-      CHAR_TO_DIGITS.fetch(char)
+      SecId::CHAR_TO_DIGITS.fetch(char)
     end
 
     def char_to_digit(char)
-      CHAR_TO_DIGIT.fetch(char)
+      SecId::CHAR_TO_DIGIT.fetch(char)
     end
 
-    def mod_10(sum)
+    def mod10(sum)
       (10 - (sum % 10)) % 10
     end
 
-    def div_10_mod_10(number)
+    def div10mod10(number)
       (number / 10) + (number % 10)
     end
   end

data/lib/sec_id/cusip.rb

@@ -8,7 +8,7 @@ module SecId
         (?<cusip6>[A-Z0-9]{5}[A-Z0-9*@#])
         (?<issue>[A-Z0-9*@#]{2}))
       (?<check_digit>\d)?
-    \z/x.freeze
+    \z/x
 
     attr_reader :cusip6, :issue
 
@@ -21,7 +21,7 @@ module SecId
     end
 
     def calculate_check_digit
-      return mod_10(modified_luhn_sum) if valid_format?
+      return mod10(modified_luhn_sum) if valid_format?
 
       raise InvalidFormatError, "CUSIP '#{full_number}' is invalid and check-digit cannot be calculated!"
     end
@@ -32,16 +32,16 @@ module SecId
     def modified_luhn_sum
       sum = 0
 
-      digitized_identifier.reverse.each_slice(2) do |even, odd|
+      id_digits.reverse.each_slice(2) do |even, odd|
         double_even = (even || 0) * 2
-        sum += div_10_mod_10(double_even) + div_10_mod_10(odd || 0)
+        sum += div10mod10(double_even) + div10mod10(odd || 0)
       end
 
       sum
     end
 
-    def digitized_identifier
-      @digitized_identifier ||= identifier.each_char.map(&method(:char_to_digit))
+    def id_digits
+      @id_digits ||= identifier.each_char.map(&method(:char_to_digit))
     end
   end
 end

data/lib/sec_id/isin.rb

@@ -8,7 +8,7 @@ module SecId
         (?<country_code>[A-Z]{2})
         (?<nsin>[A-Z0-9]{9}))
       (?<check_digit>\d)?
-    \z/x.freeze
+    \z/x
 
     attr_reader :country_code, :nsin
 
@@ -21,7 +21,7 @@ module SecId
     end
 
     def calculate_check_digit
-      return mod_10(luhn_sum) if valid_format?
+      return mod10(luhn_sum) if valid_format?
 
       raise InvalidFormatError, "ISIN '#{full_number}' is invalid and check-digit cannot be calculated!"
     end
@@ -32,7 +32,7 @@ module SecId
     def luhn_sum
       sum = 0
 
-      digitized_identifier.reverse.each_slice(2) do |even, odd|
+      id_digits.reverse.each_slice(2) do |even, odd|
         double_even = (even || 0) * 2
         double_even -= 9 if double_even > 9
         sum += double_even + (odd || 0)
@@ -41,8 +41,8 @@ module SecId
       sum
     end
 
-    def digitized_identifier
-      @digitized_identifier ||= identifier.each_char.flat_map(&method(:char_to_digits))
+    def id_digits
+      @id_digits ||= identifier.each_char.flat_map(&method(:char_to_digits))
     end
   end
 end

data/lib/sec_id/sedol.rb

@@ -6,12 +6,10 @@ module SecId
     ID_REGEX = /\A
       (?<identifier>[0-9BCDFGHJKLMNPQRSTVWXYZ]{6})
       (?<check_digit>\d)?
-    \z/x.freeze
+    \z/x
 
     CHARACTER_WEIGHTS = [1, 3, 1, 7, 3, 9].freeze
 
-    attr_reader :full_number
-
     def initialize(sedol)
       sedol_parts = parse sedol
       @identifier = sedol_parts[:identifier]
@@ -19,7 +17,7 @@ module SecId
     end
 
     def calculate_check_digit
-      return mod_10(weighted_sum) if valid_format?
+      return mod10(weighted_sum) if valid_format?
 
       raise InvalidFormatError, "SEDOL '#{full_number}' is invalid and check-digit cannot be calculated!"
     end
@@ -31,16 +29,16 @@ module SecId
       index = 0
       sum = 0
 
-      while index < digitized_identifier.size
-        sum += digitized_identifier[index] * CHARACTER_WEIGHTS[index]
+      while index < id_digits.size
+        sum += id_digits[index] * CHARACTER_WEIGHTS[index]
         index += 1
       end
 
       sum
     end
 
-    def digitized_identifier
-      @digitized_identifier ||= identifier.each_char.map(&method(:char_to_digit))
+    def id_digits
+      @id_digits ||= identifier.each_char.map(&method(:char_to_digit))
     end
   end
 end

data/lib/sec_id/version.rb

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

data/sec_id.gemspec

@@ -15,17 +15,12 @@ Gem::Specification.new do |spec|
   spec.homepage      = 'https://github.com/svyatov/sec_id'
   spec.license       = 'MIT'
 
-  spec.required_ruby_version = '>= 2.3.0'
+  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.add_development_dependency 'bundler', '>= 1.16'
-  spec.add_development_dependency 'rake', '>= 10.0'
-  spec.add_development_dependency 'rspec', '~> 3.8'
-  spec.add_development_dependency 'rubocop', '~> 0.63.1'
-  spec.add_development_dependency 'rubocop-rspec', '~> 1.32'
-  spec.add_development_dependency 'simplecov', '~> 0.16.1'
+  spec.metadata['rubygems_mfa_required'] = 'true'
 end

metadata

@@ -1,99 +1,15 @@
 --- !ruby/object:Gem::Specification
 name: sec_id
 version: !ruby/object:Gem::Version
-  version: 2.0.1
+  version: 4.0.0
 platform: ruby
 authors:
 - Leonid Svyatov
-autorequire: 
+autorequire:
 bindir: bin
 cert_chain: []
-date: 2019-02-03 00:00:00.000000000 Z
-dependencies:
-- !ruby/object:Gem::Dependency
-  name: bundler
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '1.16'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '1.16'
-- !ruby/object:Gem::Dependency
-  name: rake
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '10.0'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '10.0'
-- !ruby/object:Gem::Dependency
-  name: rspec
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '3.8'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '3.8'
-- !ruby/object:Gem::Dependency
-  name: rubocop
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: 0.63.1
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: 0.63.1
-- !ruby/object:Gem::Dependency
-  name: rubocop-rspec
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '1.32'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '1.32'
-- !ruby/object:Gem::Dependency
-  name: simplecov
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: 0.16.1
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: 0.16.1
+date: 2024-07-09 00:00:00.000000000 Z
+dependencies: []
 description: 'Validate securities identification numbers with ease! Currently supported
   standards: ISIN, CUSIP, SEDOL.'
 email:
@@ -102,10 +18,11 @@ executables: []
 extensions: []
 extra_rdoc_files: []
 files:
+- ".github/dependabot.yml"
+- ".github/workflows/main.yml"
 - ".gitignore"
 - ".rspec"
 - ".rubocop.yml"
-- ".travis.yml"
 - CHANGELOG.md
 - Gemfile
 - LICENSE.txt
@@ -123,8 +40,9 @@ files:
 homepage: https://github.com/svyatov/sec_id
 licenses:
 - MIT
-metadata: {}
-post_install_message: 
+metadata:
+  rubygems_mfa_required: 'true'
+post_install_message:
 rdoc_options: []
 require_paths:
 - lib
@@ -132,15 +50,15 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: 2.3.0
+      version: 3.1.0
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.0.2
-signing_key: 
+rubygems_version: 3.5.14
+signing_key:
 specification_version: 4
 summary: Validate securities identification numbers with ease!
 test_files: []

data/.travis.yml

@@ -1,35 +0,0 @@
----
-sudo: false
-cache: bundler
-language: ruby
-
-env:
-  global:
-    - CC_TEST_REPORTER_ID=48c33b2bc3ccdc6dafe9ed76482eca03cde47b922a7859074fc2be791247e5fd
-
-rvm:
-  - 2.3
-  - 2.4
-  - 2.5
-  - 2.6
-  - ruby-head
-
-matrix:
-  allow_failures:
-    - rvm: ruby-head
-  fast_finish: true
-
-before_script:
-  - curl -L https://codeclimate.com/downloads/test-reporter/test-reporter-latest-linux-amd64 > ./cc-test-reporter
-  - chmod +x ./cc-test-reporter
-  - ./cc-test-reporter before-build
-
-script:
-  - bundle exec rake
-
-after_script:
-  - ./cc-test-reporter after-build --exit-code $TRAVIS_TEST_RESULT
-
-notifications:
-  recipients: leonid@svyatov.ru
-  on_failure: change