base58_id 1.0.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 350af1c45ca377d67a9d8223e069a2fe4d7578ba2a1428f54fa0ed9dfc3935e0
+  data.tar.gz: bb0a090804ba8890d5d3c1a851932dd137ff64985b806c01736c1b3c9b63fe0a
+SHA512:
+  metadata.gz: 39220e72e36409269d9d6d6dc74bf54a6aef3c40a45096f049190e3e89a0b68df150e6ab843deadb951b99c6e630981a29b05db18a757293845caeaea938a2b6
+  data.tar.gz: 5450dc9d8a03b82716ba14c8bb9000654b80918200586b10c1ba1211626962d73fbb9a0f698ec8098e6c6951608373537cdb746790130034e7a816e87be4cca6

data/.gitignore

@@ -0,0 +1,2 @@
+coverage/
+*.gem

data/.rubocop.yml

@@ -0,0 +1,49 @@
+require:
+  - rubocop-performance
+  - rubocop-rspec
+
+AllCops:
+  TargetRubyVersion: 2.7
+  NewCops: enable
+
+Metrics/BlockLength:
+  Exclude:
+    - 'spec/**/*.rb'
+Metrics/MethodLength:
+  Exclude:
+    - 'spec/**/*.rb'
+
+Layout/LineLength:
+  Max: 120
+Layout/HashAlignment:
+  Enabled: false
+Layout/SpaceInsideArrayPercentLiteral:
+  Enabled: false
+Layout/ArrayAlignment:
+  Enabled: false
+
+Style/Documentation:
+  Enabled: false
+Style/WhileUntilModifier:
+  Enabled: false
+Style/WordArray:
+  Enabled: false
+Style/SymbolArray:
+  Enabled: false
+Style/NumericLiterals:
+  Enabled: false
+Style/StringLiterals:
+  Enabled: false
+Style/TrailingCommaInArrayLiteral:
+  Enabled: false
+Style/TrailingCommaInHashLiteral:
+  Enabled: false
+
+RSpec/ExampleLength:
+  Enabled: false
+RSpec/MultipleExpectations:
+  Enabled: false
+RSpec/NestedGroups:
+  Enabled: false
+RSpec/LetBeforeExamples:
+  Enabled: false

data/Gemfile

@@ -0,0 +1,5 @@
+# frozen_string_literal: true
+
+source 'https://rubygems.org'
+
+gemspec

data/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2022 Elias Rodrigues
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

data/README.md

@@ -0,0 +1,129 @@
+# Base58Id
+
+Convert an Integer ID or a UUID String to/from Base58 String
+
+## Install
+
+Install it from rubygems.org in your terminal:
+
+```sh
+gem install base58_id
+```
+
+Or via `Gemfile` in your project:
+
+```sh
+source 'https://rubygems.org'
+
+gem 'base58_id', '~> 1.0'
+```
+
+Or build and install the gem locally:
+
+```sh
+gem build base58_id.gemspec
+gem install base58_id-1.0.0.gem
+```
+
+Require it in your Ruby code and the `Base58Id` class will be available:
+
+```rb
+require 'base58_id'
+```
+
+## Alphabet
+
+It is based on Base64 URL-safe alphabet but with `I`, `O`, `l`, `0`, `-`, `_` removed:
+
+```
+A B C D E F G H   J K L M N   P Q R S T U V W X Y Z
+a b c d e f g h i j k   m n o p q r s t u v w x y z
+  1 2 3 4 5 6 7 8 9
+```
+
+## Example
+
+```rb
+require 'base58_id'
+
+Base58Id.uuid_to_base58('058917af-0d2e-4755-b0bd-25b02b249824')
+# => "qocqGYw9LEfu4WVujMzJv"
+
+Base58Id.base58_to_uuid('qocqGYw9LEfu4WVujMzJv')
+# => "058917af-0d2e-4755-b0bd-25b02b249824"
+
+Base58Id.uuid_to_integer('058917af-0d2e-4755-b0bd-25b02b249824')
+# => 7357965012972427318415208560898381860
+
+Base58Id.integer_to_uuid(7357965012972427318415208560898381860)
+# => "058917af-0d2e-4755-b0bd-25b02b249824"
+
+Base58Id.base58_to_integer('qocqGYw9LEfu4WVujMzJv')
+# => 7357965012972427318415208560898381860
+
+Base58Id.integer_to_base58(7357965012972427318415208560898381860)
+# => "qocqGYw9LEfu4WVujMzJv"
+
+Base58Id.valid_base58?('qocqGYw9LEfu4WVujMzJv')
+# => true
+
+Base58Id.valid_base58?('IOl0-_')
+# => false
+
+# It accepts UUID String in many formats:
+[
+  '058917af0d2e4755b0bd25b02b249824',
+  '058917AF0D2E4755B0BD25B02B249824',
+  '0x058917af0d2e4755b0bd25b02b249824',
+].map { |uuid| Base58Id.valid_uuid?(uuid) }
+# => [true, true, true]
+
+Base58Id::UUID_PATTERN
+# => /\A(0x)?[0-9a-f]{8}-?[0-9a-f]{4}-?[0-9a-f]{4}-?[0-9a-f]{4}-?[0-9a-f]{12}\z/i
+```
+
+### Note
+
+As it performs an integer conversion, Base58 leading zeros (represented by `A`)
+are ignored/lost:
+
+```rb
+Base58Id.base58_to_integer('A') == Base58Id.base58_to_integer('AAAAAA')
+# => true
+
+Base58Id.base58_to_integer('AAAAAAqocqGYw9LEfu4WVujMzJv') ==
+Base58Id.base58_to_integer('qocqGYw9LEfu4WVujMzJv')
+# => true
+
+Base58Id.integer_to_base58(Base58Id.base58_to_integer('AAAAAAqocqGYw9LEfu4WVujMzJv'))
+# => "qocqGYw9LEfu4WVujMzJv"
+```
+
+And an empty Base58 String also represents zero:
+
+```rb
+Base58Id.base58_to_integer('')
+# => 0
+
+Base58Id.base58_to_uuid('')
+# => "00000000-0000-0000-0000-000000000000"
+
+Base58Id.base58_to_integer('') == Base58Id.base58_to_integer('A')
+# => true
+```
+
+## Tests
+
+Run tests with:
+
+```sh
+bundle exec rspec
+```
+
+## Linter
+
+Check your code with:
+
+```sh
+bundle exec rubocop
+```

data/base58_id.gemspec

@@ -0,0 +1,37 @@
+# frozen_string_literal: true
+
+require_relative 'lib/base58_id/version'
+
+Gem::Specification.new do |s|
+  s.name     = 'base58_id'
+  s.version  = Base58Id::VERSION
+  s.license  = 'MIT'
+  s.summary  = 'Convert an Integer ID or a UUID String to/from Base58 String'
+  s.homepage = 'https://github.com/elias19r/base58_id'
+  s.author   = 'Elias Rodrigues'
+
+  s.files = Dir[
+    'lib/**/*',
+    'spec/**/*',
+    '.gitignore',
+    '.rubocop.yml',
+    'Gemfile',
+    'LICENSE',
+    'README.md',
+    'base58_id.gemspec'
+  ]
+
+  s.required_ruby_version = '>= 2.7'
+  s.metadata = {
+    'source_code_uri'       => "https://github.com/elias19r/base58_id/tree/v#{Base58Id::VERSION}",
+    'rubygems_mfa_required' => 'true'
+  }
+
+  s.add_development_dependency 'bundler', '~> 2.1'
+  s.add_development_dependency 'pry-byebug', '~> 3.9'
+  s.add_development_dependency 'rspec', '~> 3.11'
+  s.add_development_dependency 'rubocop', '~> 1.31'
+  s.add_development_dependency 'rubocop-performance', '~> 1.14'
+  s.add_development_dependency 'rubocop-rspec', '~> 2.11'
+  s.add_development_dependency 'simplecov', '~> 0.21.0'
+end

data/lib/base58_id/version.rb

@@ -0,0 +1,5 @@
+# frozen_string_literal: true
+
+class Base58Id
+  VERSION = '1.0.0'
+end

data/lib/base58_id.rb

@@ -0,0 +1,73 @@
+# frozen_string_literal: true
+
+class Base58Id
+  # Based on Base64 URL-safe alphabet but with I, O, l, 0, -, _ removed.
+  ALPHABET_58 = %w[
+    A B C D E F G H   J K L M N   P Q R S T U V W X Y Z
+    a b c d e f g h i j k   m n o p q r s t u v w x y z
+      1 2 3 4 5 6 7 8 9
+  ].freeze
+
+  ALPHABET_58_INVERT = ALPHABET_58.each_with_index.to_h
+  ALPHABET_58_CHARS = ALPHABET_58.join
+  CARET_ALPHABET_58_CHARS = "^#{ALPHABET_58_CHARS}"
+
+  UUID_PATTERN = /\A(0x)?[0-9a-f]{8}-?[0-9a-f]{4}-?[0-9a-f]{4}-?[0-9a-f]{4}-?[0-9a-f]{12}\z/i.freeze
+  UUID_BYTES_FORMAT = '%02x%02x%02x%02x-%02x%02x-%02x%02x-%02x%02x-%02x%02x%02x%02x%02x%02x'
+
+  def self.integer_to_base58(integer)
+    raise ArgumentError, 'argument must be an Integer' unless integer.is_a?(Integer)
+    raise ArgumentError, 'argument must be greater than or equal to zero' if integer.negative?
+
+    integer.digits(58).reduce('') { |str, digit| ALPHABET_58[digit] + str }
+  end
+
+  def self.base58_to_integer(base58)
+    raise ArgumentError, 'argument must be a valid Base58 String' unless valid_base58?(base58)
+
+    base58.chars.reduce(0) { |integer, digit| (integer * 58) + ALPHABET_58_INVERT[digit] }
+  end
+
+  def self.uuid_to_base58(uuid)
+    raise ArgumentError, 'argument must be a valid UUID String' unless valid_uuid?(uuid)
+
+    integer_to_base58(uuid_to_integer(uuid))
+  end
+
+  def self.base58_to_uuid(base58)
+    integer_to_uuid(base58_to_integer(base58))
+  end
+
+  def self.uuid_to_integer(uuid)
+    raise ArgumentError, 'argument must be a valid UUID String' unless valid_uuid?(uuid)
+
+    uuid.delete('-').to_i(16)
+  end
+
+  def self.integer_to_uuid(integer)
+    raise ArgumentError, 'argument must be an Integer' unless integer.is_a?(Integer)
+    raise ArgumentError, 'argument must be greater than or equal to zero' if integer.negative?
+
+    bytes_array = integer.digits(256)
+
+    raise ArgumentError, 'argument size must not require more than 16 bytes' if bytes_array.size > 16
+
+    while bytes_array.size < 16
+      bytes_array.push(0)
+    end
+
+    UUID_BYTES_FORMAT % bytes_array.reverse
+  end
+
+  def self.valid_base58?(value)
+    raise ArgumentError, 'argument must be a String' unless value.is_a?(String)
+
+    value.count(CARET_ALPHABET_58_CHARS).zero?
+  end
+
+  def self.valid_uuid?(value)
+    raise ArgumentError, 'argument must be a String' unless value.is_a?(String)
+
+    value.match?(UUID_PATTERN)
+  end
+end

data/spec/base58_id_spec.rb

@@ -0,0 +1,494 @@
+# frozen_string_literal: true
+
+require 'spec_helper'
+require 'base58_id'
+
+RSpec.describe Base58Id do
+  it 'converts an Integer ID or a UUID String to/from Base58 String' do
+    base58 = generate_base58
+
+    expect(
+      described_class.integer_to_base58(
+        described_class.base58_to_integer(base58)
+      )
+    ).to eq(base58)
+
+    expect(
+      described_class.uuid_to_base58(
+        described_class.base58_to_uuid(base58)
+      )
+    ).to eq(base58)
+
+    base58_with_leading_zeros = "AAAAAAAA#{base58}"
+
+    expect(
+      described_class.integer_to_base58(
+        described_class.base58_to_integer(base58_with_leading_zeros)
+      )
+    ).to eq(base58)
+
+    expect(
+      described_class.uuid_to_base58(
+        described_class.base58_to_uuid(base58_with_leading_zeros)
+      )
+    ).to eq(base58)
+
+    base58_empty = ''
+
+    expect(
+      described_class.integer_to_base58(
+        described_class.base58_to_integer(base58_empty)
+      )
+    ).to eq('A')
+
+    expect(
+      described_class.uuid_to_base58(
+        described_class.base58_to_uuid(base58_empty)
+      )
+    ).to eq('A')
+
+    integer = generate_non_negative_integer
+
+    expect(
+      described_class.base58_to_integer(
+        described_class.integer_to_base58(integer)
+      )
+    ).to eq(integer)
+
+    expect(
+      described_class.uuid_to_integer(
+        described_class.integer_to_uuid(integer)
+      )
+    ).to eq(integer)
+
+    uuid = generate_uuid
+
+    expect(
+      described_class.base58_to_uuid(
+        described_class.uuid_to_base58(uuid)
+      )
+    ).to eq(uuid)
+
+    expect(
+      described_class.integer_to_uuid(
+        described_class.uuid_to_integer(uuid)
+      )
+    ).to eq(uuid)
+  end
+
+  describe '.integer_to_base58' do
+    context 'when argument is not an Integer' do
+      it 'raises an ArgumentError' do
+        non_integer = Object.new
+
+        expect do
+          described_class.integer_to_base58(non_integer)
+        end.to raise_error(ArgumentError, 'argument must be an Integer')
+      end
+    end
+
+    context 'when argument is an Integer but negative' do
+      it 'raises an ArgumentError' do
+        negative_integer = generate_negative_integer
+
+        expect do
+          described_class.integer_to_base58(negative_integer)
+        end.to raise_error(ArgumentError, 'argument must be greater than or equal to zero')
+      end
+    end
+
+    context 'when argument is a non-negative Integer' do
+      it 'formats unsigned integer as Base58 String' do
+        integer = generate_non_negative_integer
+
+        expect(described_class.integer_to_base58(integer).count("^#{base58_chars.join}")).to eq(0)
+
+        some_test_cases.each do |test_case|
+          expect(described_class.integer_to_base58(test_case[:integer])).to eq(test_case[:base58])
+        end
+      end
+    end
+  end
+
+  describe '.base58_to_integer' do
+    context 'when value is not a valid Base58 String' do
+      it 'raises an ArgumentError' do
+        non_string = Object.new
+
+        expect do
+          described_class.base58_to_integer(non_string)
+        end.to raise_error(ArgumentError, 'argument must be a String')
+
+        non_base58_chars.each do |non_base58|
+          expect do
+            described_class.base58_to_integer(non_base58)
+          end.to raise_error(ArgumentError, 'argument must be a valid Base58 String')
+        end
+      end
+    end
+
+    context 'when value is a valid Base58 String' do
+      it 'returns the corresponding Integer' do
+        big_base58 = generate_big_base58
+
+        expect(described_class.base58_to_integer(big_base58)).to be_an(Integer)
+
+        base58_empty = ''
+
+        expect(described_class.base58_to_integer(base58_empty)).to eq(0)
+
+        some_test_cases.each do |test_case|
+          expect(described_class.base58_to_integer(test_case[:base58])).to eq(test_case[:integer])
+        end
+      end
+    end
+  end
+
+  describe '.uuid_to_base58' do
+    context 'when argument is not a valid UUID String' do
+      it 'raises an ArgumentError' do
+        non_string = Object.new
+
+        expect do
+          described_class.uuid_to_base58(non_string)
+        end.to raise_error(ArgumentError, 'argument must be a String')
+
+        non_uuid = '123'
+
+        expect do
+          described_class.uuid_to_base58(non_uuid)
+        end.to raise_error(ArgumentError, 'argument must be a valid UUID String')
+      end
+    end
+
+    context 'when argument is a valid UUID String' do
+      it 'returns the corresponding Base58' do
+        uuid = generate_uuid
+
+        expect(described_class.uuid_to_base58(uuid).count("^#{base58_chars.join}")).to eq(0)
+
+        some_test_cases.each do |test_case|
+          expect(described_class.uuid_to_base58(test_case[:uuid])).to eq(test_case[:base58])
+        end
+      end
+    end
+  end
+
+  describe '.base58_to_uuid' do
+    context 'when value is not a valid Base58 String' do
+      it 'raises an ArgumentError' do
+        non_string = Object.new
+
+        expect do
+          described_class.base58_to_uuid(non_string)
+        end.to raise_error(ArgumentError, 'argument must be a String')
+
+        non_base58_chars.each do |non_base58|
+          expect do
+            described_class.base58_to_uuid(non_base58)
+          end.to raise_error(ArgumentError, 'argument must be a valid Base58 String')
+        end
+      end
+    end
+
+    context 'when value is a valid Base58 String but numeric value requires more than 16 bytes' do
+      it 'raises an ArgumentError' do
+        big_base58 = generate_big_base58
+
+        expect do
+          described_class.base58_to_uuid(big_base58)
+        end.to raise_error(ArgumentError, 'argument size must not require more than 16 bytes')
+      end
+    end
+
+    context 'when value is a valid Base58 String and numeric value does not require more than 16 bytes' do
+      it 'returns the corresponding UUID String' do
+        base58 = generate_base58
+
+        expect(described_class.base58_to_uuid(base58))
+          .to match(/\A[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}\z/)
+
+        base58_empty = ''
+
+        expect(described_class.base58_to_uuid(base58_empty)).to eq('00000000-0000-0000-0000-000000000000')
+
+        some_test_cases.each do |test_case|
+          expect(described_class.base58_to_uuid(test_case[:base58])).to eq(test_case[:uuid])
+        end
+      end
+    end
+  end
+
+  describe '.uuid_to_integer' do
+    context 'when argument is not a valid UUID String' do
+      it 'raises an ArgumentError' do
+        non_string = Object.new
+
+        expect do
+          described_class.uuid_to_integer(non_string)
+        end.to raise_error(ArgumentError, 'argument must be a String')
+
+        non_uuid = '123'
+
+        expect do
+          described_class.uuid_to_integer(non_uuid)
+        end.to raise_error(ArgumentError, 'argument must be a valid UUID String')
+      end
+    end
+
+    context 'when argument is a valid UUID String' do
+      it 'returns the corresponding Integer' do
+        uuid = generate_uuid
+
+        expect(described_class.uuid_to_integer(uuid)).to be_an(Integer)
+
+        some_test_cases.each do |test_case|
+          expect(described_class.uuid_to_integer(test_case[:uuid])).to eq(test_case[:integer])
+        end
+      end
+    end
+  end
+
+  describe '.integer_to_uuid' do
+    context 'when argument is not an Integer' do
+      it 'raises an ArgumentError' do
+        non_integer = Object.new
+
+        expect do
+          described_class.integer_to_uuid(non_integer)
+        end.to raise_error(ArgumentError, 'argument must be an Integer')
+      end
+    end
+
+    context 'when argument is an Integer but negative' do
+      it 'raises an ArgumentError' do
+        negative_integer = generate_negative_integer
+
+        expect do
+          described_class.integer_to_uuid(negative_integer)
+        end.to raise_error(ArgumentError, 'argument must be greater than or equal to zero')
+      end
+    end
+
+    context 'when argument is a non-negative Integer but requires more than 16 bytes' do
+      it 'raises an ArgumentError' do
+        big_integer = generate_big_integer
+
+        expect do
+          described_class.integer_to_uuid(big_integer)
+        end.to raise_error(ArgumentError, 'argument size must not require more than 16 bytes')
+      end
+    end
+
+    context 'when argument is a non-negative Integer and does not require more than 16 bytes' do
+      it 'formats 128-bit unsigned integer as UUID String' do
+        uuid = generate_uuid
+        integer = uuid.delete('-').to_i(16)
+
+        expect(described_class.integer_to_uuid(integer)).to eq(uuid)
+
+        some_test_cases.each do |test_case|
+          expect(described_class.integer_to_uuid(test_case[:integer])).to eq(test_case[:uuid])
+        end
+      end
+    end
+  end
+
+  describe '.valid_base58?' do
+    context 'when value is not a String' do
+      it 'raises an ArgumentError' do
+        value = Object.new
+
+        expect do
+          described_class.valid_base58?(value)
+        end.to raise_error(ArgumentError, 'argument must be a String')
+      end
+    end
+
+    context 'when value is a String but contains chars not present in the Base58 alphabet' do
+      it 'returns false' do
+        non_base58_chars.each do |value|
+          expect(described_class.valid_base58?(value)).to be(false)
+        end
+      end
+    end
+
+    context 'when value is a String and contains only chars present in the Base58 alphabet' do
+      it 'returns true' do
+        base58_chars.each do |value|
+          expect(described_class.valid_base58?(value)).to be(true)
+        end
+
+        value = ''
+
+        expect(described_class.valid_base58?(value)).to be(true)
+
+        value = generate_big_base58
+
+        expect(described_class.valid_base58?(value)).to be(true)
+      end
+    end
+  end
+
+  describe '.valid_uuid?' do
+    context 'when value is not a String' do
+      it 'raises an ArgumentError' do
+        value = Object.new
+
+        expect do
+          described_class.valid_uuid?(value)
+        end.to raise_error(ArgumentError, 'argument must be a String')
+      end
+    end
+
+    context 'when value is a String but does not match the UUID pattern' do
+      it 'returns false' do
+        value = '123'
+
+        expect(described_class.valid_uuid?(value)).to be(false)
+      end
+    end
+
+    context 'when value is a String and matches the UUID pattern' do
+      it 'returns true' do
+        value = generate_uuid
+
+        expect(described_class.valid_uuid?(value)).to be(true)
+        expect(described_class.valid_uuid?(value.delete('-'))).to be(true)
+        expect(described_class.valid_uuid?("0x#{value.delete('-')}")).to be(true)
+        expect(described_class.valid_uuid?("0X#{value.delete('-')}")).to be(true)
+
+        expect(described_class.valid_uuid?(value.upcase)).to be(true)
+        expect(described_class.valid_uuid?(value.upcase.delete('-'))).to be(true)
+        expect(described_class.valid_uuid?("0x#{value.upcase.delete('-')}")).to be(true)
+        expect(described_class.valid_uuid?("0X#{value.upcase.delete('-')}")).to be(true)
+      end
+    end
+  end
+
+  def generate_uuid
+    SecureRandom.uuid
+  end
+
+  def generate_negative_integer
+    rand((-2**63)..-1)
+  end
+
+  def generate_non_negative_integer
+    rand(0..((2**63) - 1))
+  end
+
+  def generate_big_integer
+    rand((2**128)..(2**144))
+  end
+
+  def generate_base58
+    generate_non_zero_base58_digit + base58_chars.sample(19).join
+  end
+
+  def generate_big_base58
+    generate_non_zero_base58_digit + base58_chars.sample(24).join
+  end
+
+  def generate_non_zero_base58_digit
+    base58_chars[1..].sample
+  end
+
+  let(:base58_chars) do
+    %w[
+      A B C D E F G H   J K L M N   P Q R S T U V W X Y Z
+      a b c d e f g h i j k   m n o p q r s t u v w x y z
+        1 2 3 4 5 6 7 8 9
+    ]
+  end
+
+  let(:non_base58_chars) do
+    (' '..'~').to_a - base58_chars
+  end
+
+  let(:some_test_cases) do
+    [
+      { integer: 0,  base58: 'A',  uuid: '00000000-0000-0000-0000-000000000000' },
+      { integer: 1,  base58: 'B',  uuid: '00000000-0000-0000-0000-000000000001' },
+      { integer: 2,  base58: 'C',  uuid: '00000000-0000-0000-0000-000000000002' },
+      { integer: 3,  base58: 'D',  uuid: '00000000-0000-0000-0000-000000000003' },
+      { integer: 4,  base58: 'E',  uuid: '00000000-0000-0000-0000-000000000004' },
+      { integer: 5,  base58: 'F',  uuid: '00000000-0000-0000-0000-000000000005' },
+      { integer: 6,  base58: 'G',  uuid: '00000000-0000-0000-0000-000000000006' },
+      { integer: 7,  base58: 'H',  uuid: '00000000-0000-0000-0000-000000000007' },
+      { integer: 8,  base58: 'J',  uuid: '00000000-0000-0000-0000-000000000008' },
+      { integer: 9,  base58: 'K',  uuid: '00000000-0000-0000-0000-000000000009' },
+      { integer: 10, base58: 'L',  uuid: '00000000-0000-0000-0000-00000000000a' },
+      { integer: 11, base58: 'M',  uuid: '00000000-0000-0000-0000-00000000000b' },
+      { integer: 12, base58: 'N',  uuid: '00000000-0000-0000-0000-00000000000c' },
+      { integer: 13, base58: 'P',  uuid: '00000000-0000-0000-0000-00000000000d' },
+      { integer: 14, base58: 'Q',  uuid: '00000000-0000-0000-0000-00000000000e' },
+      { integer: 15, base58: 'R',  uuid: '00000000-0000-0000-0000-00000000000f' },
+      { integer: 16, base58: 'S',  uuid: '00000000-0000-0000-0000-000000000010' },
+      { integer: 17, base58: 'T',  uuid: '00000000-0000-0000-0000-000000000011' },
+      { integer: 18, base58: 'U',  uuid: '00000000-0000-0000-0000-000000000012' },
+      { integer: 19, base58: 'V',  uuid: '00000000-0000-0000-0000-000000000013' },
+      { integer: 20, base58: 'W',  uuid: '00000000-0000-0000-0000-000000000014' },
+      { integer: 21, base58: 'X',  uuid: '00000000-0000-0000-0000-000000000015' },
+      { integer: 22, base58: 'Y',  uuid: '00000000-0000-0000-0000-000000000016' },
+      { integer: 23, base58: 'Z',  uuid: '00000000-0000-0000-0000-000000000017' },
+      { integer: 24, base58: 'a',  uuid: '00000000-0000-0000-0000-000000000018' },
+      { integer: 25, base58: 'b',  uuid: '00000000-0000-0000-0000-000000000019' },
+      { integer: 26, base58: 'c',  uuid: '00000000-0000-0000-0000-00000000001a' },
+      { integer: 27, base58: 'd',  uuid: '00000000-0000-0000-0000-00000000001b' },
+      { integer: 28, base58: 'e',  uuid: '00000000-0000-0000-0000-00000000001c' },
+      { integer: 29, base58: 'f',  uuid: '00000000-0000-0000-0000-00000000001d' },
+      { integer: 30, base58: 'g',  uuid: '00000000-0000-0000-0000-00000000001e' },
+      { integer: 31, base58: 'h',  uuid: '00000000-0000-0000-0000-00000000001f' },
+      { integer: 32, base58: 'i',  uuid: '00000000-0000-0000-0000-000000000020' },
+      { integer: 33, base58: 'j',  uuid: '00000000-0000-0000-0000-000000000021' },
+      { integer: 34, base58: 'k',  uuid: '00000000-0000-0000-0000-000000000022' },
+      { integer: 35, base58: 'm',  uuid: '00000000-0000-0000-0000-000000000023' },
+      { integer: 36, base58: 'n',  uuid: '00000000-0000-0000-0000-000000000024' },
+      { integer: 37, base58: 'o',  uuid: '00000000-0000-0000-0000-000000000025' },
+      { integer: 38, base58: 'p',  uuid: '00000000-0000-0000-0000-000000000026' },
+      { integer: 39, base58: 'q',  uuid: '00000000-0000-0000-0000-000000000027' },
+      { integer: 40, base58: 'r',  uuid: '00000000-0000-0000-0000-000000000028' },
+      { integer: 41, base58: 's',  uuid: '00000000-0000-0000-0000-000000000029' },
+      { integer: 42, base58: 't',  uuid: '00000000-0000-0000-0000-00000000002a' },
+      { integer: 43, base58: 'u',  uuid: '00000000-0000-0000-0000-00000000002b' },
+      { integer: 44, base58: 'v',  uuid: '00000000-0000-0000-0000-00000000002c' },
+      { integer: 45, base58: 'w',  uuid: '00000000-0000-0000-0000-00000000002d' },
+      { integer: 46, base58: 'x',  uuid: '00000000-0000-0000-0000-00000000002e' },
+      { integer: 47, base58: 'y',  uuid: '00000000-0000-0000-0000-00000000002f' },
+      { integer: 48, base58: 'z',  uuid: '00000000-0000-0000-0000-000000000030' },
+      { integer: 49, base58: '1',  uuid: '00000000-0000-0000-0000-000000000031' },
+      { integer: 50, base58: '2',  uuid: '00000000-0000-0000-0000-000000000032' },
+      { integer: 51, base58: '3',  uuid: '00000000-0000-0000-0000-000000000033' },
+      { integer: 52, base58: '4',  uuid: '00000000-0000-0000-0000-000000000034' },
+      { integer: 53, base58: '5',  uuid: '00000000-0000-0000-0000-000000000035' },
+      { integer: 54, base58: '6',  uuid: '00000000-0000-0000-0000-000000000036' },
+      { integer: 55, base58: '7',  uuid: '00000000-0000-0000-0000-000000000037' },
+      { integer: 56, base58: '8',  uuid: '00000000-0000-0000-0000-000000000038' },
+      { integer: 57, base58: '9',  uuid: '00000000-0000-0000-0000-000000000039' },
+      { integer: 58, base58: 'BA', uuid: '00000000-0000-0000-0000-00000000003a' },
+
+      { integer: 58 * 2,  base58: 'CA',  uuid: '00000000-0000-0000-0000-000000000074' },
+      { integer: 58 * 3,  base58: 'DA',  uuid: '00000000-0000-0000-0000-0000000000ae' },
+      { integer: 58 * 10, base58: 'LA',  uuid: '00000000-0000-0000-0000-000000000244' },
+      { integer: 58 * 20, base58: 'WA',  uuid: '00000000-0000-0000-0000-000000000488' },
+      { integer: 58 * 58, base58: 'BAA', uuid: '00000000-0000-0000-0000-000000000d24' },
+
+      { integer: 231, base58: 'D9', uuid: '00000000-0000-0000-0000-0000000000e7' },
+      { integer: 232, base58: 'EA', uuid: '00000000-0000-0000-0000-0000000000e8' },
+      { integer: 255, base58: 'EZ', uuid: '00000000-0000-0000-0000-0000000000ff' },
+      { integer: 256, base58: 'Ea', uuid: '00000000-0000-0000-0000-000000000100' },
+      { integer: 280, base58: 'Ez', uuid: '00000000-0000-0000-0000-000000000118' },
+      { integer: 281, base58: 'E1', uuid: '00000000-0000-0000-0000-000000000119' },
+      { integer: 289, base58: 'E9', uuid: '00000000-0000-0000-0000-000000000121' },
+      { integer: 290, base58: 'FA', uuid: '00000000-0000-0000-0000-000000000122' },
+
+      { integer: (58**10) - 1, base58: '9999999999',            uuid: '00000000-0000-0000-05fa-8624c7fba3ff' },
+      { integer: 58**10,       base58: 'BAAAAAAAAAA',           uuid: '00000000-0000-0000-05fa-8624c7fba400' },
+      { integer: 58**20,       base58: 'BAAAAAAAAAAAAAAAAAAAA', uuid: '0023be67-b5f0-f288-9aaf-505301100000' },
+
+      { integer: (2**128) - 2, base58: 'hmep7uZkFTa9zuEuQB3XV4', uuid: 'ffffffff-ffff-ffff-ffff-fffffffffffe' },
+      { integer: (2**128) - 1, base58: 'hmep7uZkFTa9zuEuQB3XV5', uuid: 'ffffffff-ffff-ffff-ffff-ffffffffffff' },
+    ]
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,8 @@
+# frozen_string_literal: true
+
+require 'simplecov'
+SimpleCov.start
+
+require 'securerandom'
+require 'rspec'
+require 'pry-byebug'

metadata

@@ -0,0 +1,152 @@
+--- !ruby/object:Gem::Specification
+name: base58_id
+version: !ruby/object:Gem::Version
+  version: 1.0.0
+platform: ruby
+authors:
+- Elias Rodrigues
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2022-06-30 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.1'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.1'
+- !ruby/object:Gem::Dependency
+  name: pry-byebug
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.9'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.9'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.11'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.11'
+- !ruby/object:Gem::Dependency
+  name: rubocop
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.31'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.31'
+- !ruby/object:Gem::Dependency
+  name: rubocop-performance
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.14'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.14'
+- !ruby/object:Gem::Dependency
+  name: rubocop-rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.11'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.11'
+- !ruby/object:Gem::Dependency
+  name: simplecov
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.21.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.21.0
+description: 
+email: 
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rubocop.yml"
+- Gemfile
+- LICENSE
+- README.md
+- base58_id.gemspec
+- lib/base58_id.rb
+- lib/base58_id/version.rb
+- spec/base58_id_spec.rb
+- spec/spec_helper.rb
+homepage: https://github.com/elias19r/base58_id
+licenses:
+- MIT
+metadata:
+  source_code_uri: https://github.com/elias19r/base58_id/tree/v1.0.0
+  rubygems_mfa_required: 'true'
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '2.7'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.1.6
+signing_key: 
+specification_version: 4
+summary: Convert an Integer ID or a UUID String to/from Base58 String
+test_files: []