sqids 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: d51e2c5981c5b59b42e1cd3ddcf953ca6f1f5dfa21998b066064081888523a07
+  data.tar.gz: f3279de8aa60f40dbe20f338d18731f71018958784aaf5e95b65e22a57cd5664
+SHA512:
+  metadata.gz: 510e16706f4310fdaab202bfef003d2cd7ce622e79b606d2ea948bf8b04a5f5c0d000e06102447782a87ff25ee0395b7e02e3b24b242af7fe6038b1682e34bde
+  data.tar.gz: 9232d0467cf326a4860d09fcb5e820893e426f6963e0296f821baef7e9873d1ccdd9bba98846f82d02f5ea55c9780c4bd8b136167c2bd8e858cb8b6653409947

data/.github/workflows/tests.yml

@@ -0,0 +1,20 @@
+name: Ruby
+on:
+  push:
+    branches: [ main ]
+  pull_request:
+    branches: [ main ]
+jobs:
+  test:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v3
+      - name: Set up Ruby
+        uses: ruby/setup-ruby@v1
+        with:
+          ruby-version: '3.1'
+          bundler-cache: true
+      - name: Install dependencies
+        run: bundle install
+      - name: Run tests
+        run: bundle exec rspec

data/.rubocop.yml

@@ -0,0 +1,3 @@
+AllCops:
+  NewCops: enable
+  TargetRubyVersion: 3.1

data/CHANGELOG.md

@@ -0,0 +1,4 @@
+# CHANGELOG
+
+**v0.1.0:**
+- First implementation of [the spec](https://github.com/sqids/sqids-spec)

data/Gemfile

@@ -0,0 +1,14 @@
+# frozen_string_literal: true
+
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in sqids.gemspec
+gemspec
+
+group :development do
+  gem 'rake'
+end
+
+group :test do
+  gem 'rspec'
+end

data/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2023-present Sqids maintainers.
+
+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,63 @@
+# [Sqids Ruby](https://sqids.org/ruby)
+
+[![Github Actions](https://img.shields.io/github/actions/workflow/status/sqids/sqids-ruby/tests.yml)](https://github.com/sqids/sqids-ruby/actions)
+
+Sqids (pronounced "squids") is a small library that lets you generate YouTube-looking IDs from numbers. It's good for link shortening, fast & URL-safe ID generation and decoding back into numbers for quicker database lookups.
+
+## Getting started
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'sqids'
+```
+
+And then execute:
+
+```bash
+bundle
+```
+
+Or install it via:
+
+```bash
+gem install sqids
+```
+
+## Examples
+
+Simple encode & decode:
+
+```ruby
+sqids = Sqids.new
+id = sqids.encode([1, 2, 3]) # '8QRLaD'
+numbers = sqids.decode(id) # [1, 2, 3]
+```
+
+Randomize IDs by providing a custom alphabet:
+
+```ruby
+sqids = Sqids.new(alphabet: 'FxnXM1kBN6cuhsAvjW3Co7l2RePyY8DwaU04Tzt9fHQrqSVKdpimLGIJOgb5ZE')
+id = sqids.encode([1, 2, 3]) # 'B5aMa3'
+numbers = sqids.decode(id) # [1, 2, 3]
+```
+
+Enforce a *minimum* length for IDs:
+
+```ruby
+sqids = Sqids.new(min_length: 10)
+id = sqids.encode([1, 2, 3]) # '75JT1cd0dL'
+numbers = sqids.decode(id) # [1, 2, 3]
+```
+
+Prevent specific words from appearing anywhere in the auto-generated IDs:
+
+```ruby
+sqids = Sqids.new(blocklist: Set.new(%w[word1 word2]))
+id = sqids.encode([1, 2, 3]) # '8QRLaD'
+numbers = sqids.decode(id) # [1, 2, 3]
+```
+
+## License
+
+[MIT](LICENSE)

data/lib/sqids.rb

@@ -0,0 +1,209 @@
+# frozen_string_literal: true
+
+require 'set'
+
+class Sqids
+  DEFAULT_ALPHABET = 'abcdefghijklmnopqrstuvwxyzABCDEFGHIJKLMNOPQRSTUVWXYZ0123456789'
+  DEFAULT_MIN_LENGTH = 0
+  # rubocop:disable Metrics/CollectionLiteralLength, Layout/LineLength
+  DEFAULT_BLOCKLIST = %w[0rgasm 1d10t 1d1ot 1di0t 1diot 1eccacu10 1eccacu1o 1eccacul0
+                         1eccaculo 1mbec11e 1mbec1le 1mbeci1e 1mbecile a11upat0 a11upato a1lupat0 a1lupato aand ah01e ah0le aho1e ahole al1upat0 al1upato allupat0 allupato ana1 ana1e anal anale anus arrapat0 arrapato arsch arse ass b00b b00be b01ata b0ceta b0iata b0ob b0obe b0sta b1tch b1te b1tte ba1atkar balatkar bastard0 bastardo batt0na battona bitch bite bitte bo0b bo0be bo1ata boceta boiata boob boobe bosta bran1age bran1er bran1ette bran1eur bran1euse branlage branler branlette branleur branleuse c0ck c0g110ne c0g11one c0g1i0ne c0g1ione c0gl10ne c0gl1one c0gli0ne c0glione c0na c0nnard c0nnasse c0nne c0u111es c0u11les c0u1l1es c0u1lles c0ui11es c0ui1les c0uil1es c0uilles c11t c11t0 c11to c1it c1it0 c1ito cabr0n cabra0 cabrao cabron caca cacca cacete cagante cagar cagare cagna cara1h0 cara1ho caracu10 caracu1o caracul0 caraculo caralh0 caralho cazz0 cazz1mma cazzata cazzimma cazzo ch00t1a ch00t1ya ch00tia ch00tiya ch0d ch0ot1a ch0ot1ya ch0otia ch0otiya ch1asse ch1avata ch1er ch1ng0 ch1ngadaz0s ch1ngadazos ch1ngader1ta ch1ngaderita ch1ngar ch1ngo ch1ngues ch1nk chatte chiasse chiavata chier ching0 chingadaz0s chingadazos chingader1ta chingaderita chingar chingo chingues chink cho0t1a cho0t1ya cho0tia cho0tiya chod choot1a choot1ya chootia chootiya cl1t cl1t0 cl1to clit clit0 clito cock cog110ne cog11one cog1i0ne cog1ione cogl10ne cogl1one cogli0ne coglione cona connard connasse conne cou111es cou11les cou1l1es cou1lles coui11es coui1les couil1es couilles cracker crap cu10 cu1att0ne cu1attone cu1er0 cu1ero cu1o cul0 culatt0ne culattone culer0 culero culo cum cunt d11d0 d11do d1ck d1ld0 d1ldo damn de1ch deich depp di1d0 di1do dick dild0 dildo dyke encu1e encule enema enf01re enf0ire enfo1re enfoire estup1d0 estup1do estupid0 estupido etr0n etron f0da f0der f0ttere f0tters1 f0ttersi f0tze f0utre f1ca f1cker f1ga fag fica ficker figa foda foder fottere fotters1 fottersi fotze foutre fr0c10 fr0c1o fr0ci0 fr0cio fr0sc10 fr0sc1o fr0sci0 fr0scio froc10 froc1o froci0 frocio frosc10 frosc1o frosci0 froscio fuck g00 g0o g0u1ne g0uine gandu go0 goo gou1ne gouine gr0gnasse grognasse haram1 harami haramzade hund1n hundin id10t id1ot idi0t idiot imbec11e imbec1le imbeci1e imbecile j1zz jerk jizz k1ke kam1ne kamine kike leccacu10 leccacu1o leccacul0 leccaculo m1erda m1gn0tta m1gnotta m1nch1a m1nchia m1st mam0n mamahuev0 mamahuevo mamon masturbat10n masturbat1on masturbate masturbati0n masturbation merd0s0 merd0so merda merde merdos0 merdoso mierda mign0tta mignotta minch1a minchia mist musch1 muschi n1gger neger negr0 negre negro nerch1a nerchia nigger orgasm p00p p011a p01la p0l1a p0lla p0mp1n0 p0mp1no p0mpin0 p0mpino p0op p0rca p0rn p0rra p0uff1asse p0uffiasse p1p1 p1pi p1r1a p1rla p1sc10 p1sc1o p1sci0 p1scio p1sser pa11e pa1le pal1e palle pane1e1r0 pane1e1ro pane1eir0 pane1eiro panele1r0 panele1ro paneleir0 paneleiro patakha pec0r1na pec0rina pecor1na pecorina pen1s pendej0 pendejo penis pip1 pipi pir1a pirla pisc10 pisc1o pisci0 piscio pisser po0p po11a po1la pol1a polla pomp1n0 pomp1no pompin0 pompino poop porca porn porra pouff1asse pouffiasse pr1ck prick pussy put1za puta puta1n putain pute putiza puttana queca r0mp1ba11e r0mp1ba1le r0mp1bal1e r0mp1balle r0mpiba11e r0mpiba1le r0mpibal1e r0mpiballe rand1 randi rape recch10ne recch1one recchi0ne recchione retard romp1ba11e romp1ba1le romp1bal1e romp1balle rompiba11e rompiba1le rompibal1e rompiballe ruff1an0 ruff1ano ruffian0 ruffiano s1ut sa10pe sa1aud sa1ope sacanagem sal0pe salaud salope saugnapf sb0rr0ne sb0rra sb0rrone sbattere sbatters1 sbattersi sborr0ne sborra sborrone sc0pare sc0pata sch1ampe sche1se sche1sse scheise scheisse schlampe schwachs1nn1g schwachs1nnig schwachsinn1g schwachsinnig schwanz scopare scopata sexy sh1t shit slut sp0mp1nare sp0mpinare spomp1nare spompinare str0nz0 str0nza str0nzo stronz0 stronza stronzo stup1d stupid succh1am1 succh1ami succhiam1 succhiami sucker t0pa tapette test1c1e test1cle testic1e testicle tette topa tr01a tr0ia tr0mbare tr1ng1er tr1ngler tring1er tringler tro1a troia trombare turd twat vaffancu10 vaffancu1o vaffancul0 vaffanculo vag1na vagina verdammt verga w1chsen wank wichsen x0ch0ta x0chota xana xoch0ta xochota z0cc01a z0cc0la z0cco1a z0ccola z1z1 z1zi ziz1 zizi zocc01a zocc0la zocco1a zoccola].freeze
+  # rubocop:enable Metrics/CollectionLiteralLength, Layout/LineLength
+
+  def initialize(options = {})
+    alphabet = options[:alphabet] || DEFAULT_ALPHABET
+    min_length = options[:min_length] || DEFAULT_MIN_LENGTH
+    blocklist = options[:blocklist] || DEFAULT_BLOCKLIST
+
+    raise ArgumentError, 'Alphabet length must be at least 5' if alphabet.length < 5
+
+    if alphabet.chars.uniq.size != alphabet.length
+      raise ArgumentError,
+            'Alphabet must contain unique characters'
+    end
+
+    unless min_length.is_a?(Integer) && min_length >= Sqids.min_value && min_length <= alphabet.length
+      raise TypeError,
+            "Minimum length has to be between #{Sqids.min_value} and #{alphabet.length}"
+    end
+
+    filtered_blocklist = blocklist.select do |word|
+      word.length >= 3 && (word.chars - alphabet.chars).empty?
+    end.to_set(&:downcase)
+
+    @alphabet = shuffle(alphabet)
+    @min_length = min_length
+    @blocklist = filtered_blocklist
+  end
+
+  def encode(numbers)
+    return '' if numbers.empty?
+
+    in_range_numbers = numbers.select { |n| n >= Sqids.min_value && n <= Sqids.max_value }
+    unless in_range_numbers.length == numbers.length
+      raise ArgumentError,
+            "Encoding supports numbers between #{Sqids.min_value} and #{Sqids.max_value}"
+    end
+
+    encode_numbers(in_range_numbers, partitioned: false)
+  end
+
+  def decode(id)
+    ret = []
+
+    return ret if id.empty?
+
+    alphabet_chars = @alphabet.chars
+    id.chars.each do |c|
+      return ret unless alphabet_chars.include?(c)
+    end
+
+    prefix = id[0]
+    offset = @alphabet.index(prefix)
+    alphabet = @alphabet.slice(offset, @alphabet.length) + @alphabet.slice(0, offset)
+    partition = alphabet[1]
+    alphabet = alphabet.slice(2, alphabet.length)
+
+    id = id[1, id.length]
+
+    partition_index = id.index(partition)
+    if !partition_index.nil? && partition_index.positive? && partition_index < id.length - 1
+      id = id[partition_index + 1, id.length]
+      alphabet = shuffle(alphabet)
+    end
+
+    while id.length.positive?
+      separator = alphabet[-1]
+      chunks = id.split(separator, 2)
+
+      if chunks.any?
+        alphabet_without_separator = alphabet.slice(0, alphabet.length - 1)
+        return [] unless chunks[0].chars.all? { |c| alphabet_without_separator.include?(c) }
+
+        ret.push(to_number(chunks[0], alphabet_without_separator))
+        alphabet = shuffle(alphabet) if chunks.length > 1
+      end
+
+      id = chunks.length > 1 ? chunks[1] : ''
+    end
+
+    ret
+  end
+
+  def self.min_value
+    0
+  end
+
+  def self.max_value
+    defined?(Integer::MAX) ? Integer::MAX : ((2**((0.size * 8) - 2)) - 1)
+  end
+
+  private
+
+  def shuffle(alphabet)
+    chars = alphabet.chars
+
+    i = 0
+    j = chars.length - 1
+    while j.positive?
+      r = ((i * j) + chars[i].ord + chars[j].ord) % chars.length
+      chars[i], chars[r] = chars[r], chars[i]
+      i += 1
+      j -= 1
+    end
+
+    chars.join
+  end
+
+  def encode_numbers(numbers, partitioned: false)
+    offset = numbers.length
+    numbers.each_with_index do |v, i|
+      offset += @alphabet[v % @alphabet.length].ord + i
+    end
+    offset = offset % @alphabet.length
+
+    alphabet = @alphabet.slice(offset, @alphabet.length) + @alphabet.slice(0, offset)
+    prefix = alphabet[0]
+    partition = alphabet[1]
+    alphabet = alphabet.slice(2, alphabet.length)
+    ret = [prefix]
+
+    numbers.each_with_index do |num, i|
+      alphabet_without_separator = alphabet.slice(0, alphabet.length - 1)
+      ret.push(to_id(num, alphabet_without_separator))
+
+      next unless i < numbers.length - 1
+
+      separator = alphabet[-1]
+      if partitioned && i.zero?
+        ret.push(partition)
+      else
+        ret.push(separator)
+      end
+
+      alphabet = shuffle(alphabet)
+    end
+
+    id = ret.join
+
+    if @min_length > id.length
+      unless partitioned
+        numbers = [0] + numbers
+        id = encode_numbers(numbers, partitioned: true)
+      end
+
+      if @min_length > id.length
+        id = id[0] + alphabet[0,
+                              @min_length - id.length] + id[1,
+                                                            id.length - 1]
+      end
+    end
+
+    if blocked_id?(id)
+      if partitioned
+        numbers[0] += 1
+      else
+        numbers = [0] + numbers
+      end
+
+      id = encode_numbers(numbers, partitioned: true)
+    end
+
+    id
+  end
+
+  def to_id(num, alphabet)
+    id = []
+    chars = alphabet.chars
+
+    result = num
+    loop do
+      id.unshift(chars[result % chars.length])
+      result /= chars.length
+      break unless result.positive?
+    end
+
+    id.join
+  end
+
+  def to_number(id, alphabet)
+    chars = alphabet.chars
+    id.chars.reduce(0) { |a, v| (a * chars.length) + chars.index(v) }
+  end
+
+  def blocked_id?(id)
+    id = id.downcase
+
+    @blocklist.any? do |word|
+      if word.length <= id.length
+        if id.length <= 3 || word.length <= 3
+          id == word
+        elsif word.match?(/\d/)
+          id.start_with?(word) || id.end_with?(word)
+        else
+          id.include?(word)
+        end
+      end
+    end
+  end
+end

data/spec/alphabet_spec.rb

@@ -0,0 +1,47 @@
+# frozen_string_literal: true
+
+require 'rspec'
+require_relative '../lib/sqids'
+
+describe Sqids do
+  it 'encodes and decodes using simple alphabet' do
+    sqids = Sqids.new(alphabet: '0123456789abcdef')
+
+    numbers = [1, 2, 3]
+    id = '4d9fd2'
+
+    expect(sqids.encode(numbers)).to eq(id)
+    expect(sqids.decode(id)).to eq(numbers)
+  end
+
+  it 'decodes after encoding with a short alphabet' do
+    sqids = Sqids.new(alphabet: 'abcde')
+
+    numbers = [1, 2, 3]
+    encoded = sqids.encode(numbers)
+
+    expect(sqids.decode(encoded)).to eq(numbers)
+  end
+
+  it 'decodes after encoding with a long alphabet' do
+    sqids = Sqids.new(alphabet:
+      'abcdefghijklmnopqrstuvwxyzABCDEFGHIJKLMNOPQRSTUVWXYZ0123456789!@#$%^&*()-_+|{}[];:\'"/?.>,<`~')
+
+    numbers = [1, 2, 3]
+    encoded = sqids.encode(numbers)
+
+    expect(sqids.decode(encoded)).to eq(numbers)
+  end
+
+  it 'fails when alphabet characters are repeated' do
+    expect do
+      Sqids.new(alphabet: 'aabcdefg')
+    end.to raise_error(ArgumentError)
+  end
+
+  it 'fails when alphabet is too short' do
+    expect do
+      Sqids.new(alphabet: 'abcd')
+    end.to raise_error(ArgumentError)
+  end
+end

data/spec/blocklist_spec.rb

@@ -0,0 +1,55 @@
+# frozen_string_literal: true
+
+require 'rspec'
+require 'set'
+require_relative '../lib/sqids'
+
+describe Sqids do
+  it 'uses default blocklist if no custom blocklist is provided' do
+    sqids = Sqids.new
+
+    expect(sqids.decode('sexy')).to eq([200_044])
+    expect(sqids.encode([200_044])).to eq('d171vI')
+  end
+
+  it 'does not use any blocklist if an empty blocklist is provided' do
+    sqids = Sqids.new(blocklist: Set.new([]))
+
+    expect(sqids.decode('sexy')).to eq([200_044])
+    expect(sqids.encode([200_044])).to eq('sexy')
+  end
+
+  it 'uses provided blocklist if non-empty blocklist is provided' do
+    sqids = Sqids.new(blocklist: Set.new(['AvTg']))
+
+    expect(sqids.decode('sexy')).to eq([200_044])
+    expect(sqids.encode([200_044])).to eq('sexy')
+
+    expect(sqids.decode('AvTg')).to eq([100_000])
+    expect(sqids.encode([100_000])).to eq('7T1X8k')
+    expect(sqids.decode('7T1X8k')).to eq([100_000])
+  end
+
+  it 'uses blocklist to prevent certain encodings' do
+    sqids = Sqids.new(blocklist: Set.new(%w[8QRLaD 7T1cd0dL UeIe imhw LfUQ]))
+
+    expect(sqids.encode([1, 2, 3])).to eq('TM0x1Mxz')
+    expect(sqids.decode('TM0x1Mxz')).to eq([1, 2, 3])
+  end
+
+  it 'can decode blocklist words' do
+    sqids = Sqids.new(blocklist: Set.new(%w[8QRLaD 7T1cd0dL RA8UeIe7 WM3Limhw LfUQh4HN]))
+
+    expect(sqids.decode('8QRLaD')).to eq([1, 2, 3])
+    expect(sqids.decode('7T1cd0dL')).to eq([1, 2, 3])
+    expect(sqids.decode('RA8UeIe7')).to eq([1, 2, 3])
+    expect(sqids.decode('WM3Limhw')).to eq([1, 2, 3])
+    expect(sqids.decode('LfUQh4HN')).to eq([1, 2, 3])
+  end
+
+  it 'matches against a short blocklist word' do
+    sqids = Sqids.new(blocklist: Set.new(['pPQ']))
+
+    expect(sqids.decode(sqids.encode([1_000]))).to eq([1_000])
+  end
+end

data/spec/encoding_spec.rb

@@ -0,0 +1,123 @@
+# frozen_string_literal: true
+
+require 'rspec'
+require_relative '../lib/sqids'
+
+describe 'Sqids' do
+  it 'simple' do
+    sqids = Sqids.new
+
+    numbers = [1, 2, 3]
+    id = '8QRLaD'
+
+    expect(sqids.encode(numbers)).to eq(id)
+    expect(sqids.decode(id)).to eq(numbers)
+  end
+
+  it 'different inputs' do
+    sqids = Sqids.new
+
+    numbers = [0, 0, 0, 1, 2, 3, 100, 1_000, 100_000, 1_000_000, Sqids.max_value]
+    expect(sqids.decode(sqids.encode(numbers))).to eq(numbers)
+  end
+
+  it 'incremental numbers' do
+    sqids = Sqids.new
+
+    ids = {
+      'bV' => [0],
+      'U9' => [1],
+      'g8' => [2],
+      'Ez' => [3],
+      'V8' => [4],
+      'ul' => [5],
+      'O3' => [6],
+      'AF' => [7],
+      'ph' => [8],
+      'n8' => [9]
+    }
+
+    ids.each do |id, numbers|
+      expect(sqids.encode(numbers)).to eq(id)
+      expect(sqids.decode(id)).to eq(numbers)
+    end
+  end
+
+  it 'incremental numbers, same index 0' do
+    sqids = Sqids.new
+
+    ids = {
+      'SrIu' => [0, 0],
+      'nZqE' => [0, 1],
+      'tJyf' => [0, 2],
+      'e86S' => [0, 3],
+      'rtC7' => [0, 4],
+      'sQ8R' => [0, 5],
+      'uz2n' => [0, 6],
+      '7Td9' => [0, 7],
+      '3nWE' => [0, 8],
+      'mIxM' => [0, 9]
+    }
+
+    ids.each do |id, numbers|
+      expect(sqids.encode(numbers)).to eq(id)
+      expect(sqids.decode(id)).to eq(numbers)
+    end
+  end
+
+  it 'incremental numbers, same index 1' do
+    sqids = Sqids.new
+
+    ids = {
+      'SrIu' => [0, 0],
+      'nbqh' => [1, 0],
+      't4yj' => [2, 0],
+      'eQ6L' => [3, 0],
+      'r4Cc' => [4, 0],
+      'sL82' => [5, 0],
+      'uo2f' => [6, 0],
+      '7Zdq' => [7, 0],
+      '36Wf' => [8, 0],
+      'm4xT' => [9, 0]
+    }
+
+    ids.each do |id, numbers|
+      expect(sqids.encode(numbers)).to eq(id)
+      expect(sqids.decode(id)).to eq(numbers)
+    end
+  end
+
+  it 'multi input' do
+    sqids = Sqids.new
+
+    numbers = (0..99).to_a
+    output = sqids.decode(sqids.encode(numbers))
+    expect(numbers).to eq(output)
+  end
+
+  it 'encoding no numbers' do
+    sqids = Sqids.new
+    expect(sqids.encode([])).to eq('')
+  end
+
+  it 'decoding empty string' do
+    sqids = Sqids.new
+    expect(sqids.decode('')).to eq([])
+  end
+
+  it 'decoding an ID with an invalid character' do
+    sqids = Sqids.new
+    expect(sqids.decode('*')).to eq([])
+  end
+
+  it 'decoding an invalid ID with a repeating reserved character' do
+    sqids = Sqids.new
+    expect(sqids.decode('fff')).to eq([])
+  end
+
+  it 'encode out-of-range numbers' do
+    sqids = Sqids.new
+    expect { sqids.encode([Sqids.min_value - 1]) }.to raise_error(ArgumentError)
+    expect { sqids.encode([Sqids.max_value + 1]) }.to raise_error(ArgumentError)
+  end
+end

data/spec/minlength_spec.rb

@@ -0,0 +1,65 @@
+# frozen_string_literal: true
+
+require 'rspec'
+require_relative '../lib/sqids'
+
+describe Sqids do
+  let(:default_alphabet) { Sqids::DEFAULT_ALPHABET }
+
+  it 'encodes and decodes simple numbers' do
+    sqids = Sqids.new(min_length: default_alphabet.length)
+
+    numbers = [1, 2, 3]
+    id = '75JILToVsGerOADWmHlY38xvbaNZKQ9wdFS0B6kcMEtnRpgizhjU42qT1cd0dL'
+
+    expect(sqids.encode(numbers)).to eq(id)
+    expect(sqids.decode(id)).to eq(numbers)
+  end
+
+  it 'encodes and decodes incremental numbers' do
+    sqids = Sqids.new(min_length: default_alphabet.length)
+
+    ids = {
+      'jf26PLNeO5WbJDUV7FmMtlGXps3CoqkHnZ8cYd19yIiTAQuvKSExzhrRghBlwf' => [0, 0],
+      'vQLUq7zWXC6k9cNOtgJ2ZK8rbxuipBFAS10yTdYeRa3ojHwGnmMV4PDhESI2jL' => [0, 1],
+      'YhcpVK3COXbifmnZoLuxWgBQwtjsSaDGAdr0ReTHM16yI9vU8JNzlFq5Eu2oPp' => [0, 2],
+      'OTkn9daFgDZX6LbmfxI83RSKetJu0APihlsrYoz5pvQw7GyWHEUcN2jBqd4kJ9' => [0, 3],
+      'h2cV5eLNYj1x4ToZpfM90UlgHBOKikQFvnW36AC8zrmuJ7XdRytIGPawqYEbBe' => [0, 4],
+      '7Mf0HeUNkpsZOTvmcj836P9EWKaACBubInFJtwXR2DSzgYGhQV5i4lLxoT1qdU' => [0, 5],
+      'APVSD1ZIY4WGBK75xktMfTev8qsCJw6oyH2j3OnLcXRlhziUmpbuNEar05QCsI' => [0, 6],
+      'P0LUhnlT76rsWSofOeyRGQZv1cC5qu3dtaJYNEXwk8Vpx92bKiHIz4MgmiDOF7' => [0, 7],
+      'xAhypZMXYIGCL4uW0te6lsFHaPc3SiD1TBgw5O7bvodzjqUn89JQRfk2Nvm4JI' => [0, 8],
+      '94dRPIZ6irlXWvTbKywFuAhBoECQOVMjDJp53s2xeqaSzHY8nc17tmkLGwfGNl' => [0, 9]
+    }
+
+    ids.each do |id, numbers|
+      expect(sqids.encode(numbers)).to eq(id)
+      expect(sqids.decode(id)).to eq(numbers)
+    end
+  end
+
+  it 'encodes with different min lengths' do
+    [0, 1, 5, 10, default_alphabet.length].each do |min_length|
+      [
+        [Sqids.min_value],
+        [0, 0, 0, 0, 0],
+        [1, 2, 3, 4, 5, 6, 7, 8, 9, 10],
+        [100, 200, 300],
+        [1_000, 2_000, 3_000],
+        [1_000_000],
+        [Sqids.max_value]
+      ].each do |numbers|
+        sqids = Sqids.new(min_length:)
+
+        id = sqids.encode(numbers)
+        expect(id.length).to be >= min_length
+        expect(sqids.decode(id)).to eq(numbers)
+      end
+    end
+  end
+
+  it 'raises error for out-of-range invalid min lengths' do
+    expect { Sqids.new(min_length: -1) }.to raise_error(TypeError)
+    expect { Sqids.new(min_length: default_alphabet.length + 1) }.to raise_error(TypeError)
+  end
+end

data/spec/uniques_spec.rb

@@ -0,0 +1,62 @@
+# frozen_string_literal: true
+
+require 'rspec'
+require_relative '../lib/sqids'
+
+upper = 1_000_000
+
+describe Sqids do
+  let(:sqids) { Sqids.new(min_length: Sqids::DEFAULT_ALPHABET.length) }
+
+  it 'uniques, with padding' do
+    set = Set.new
+
+    (0...upper).each do |i|
+      numbers = [i]
+      id = sqids.encode(numbers)
+      set.add(id)
+      expect(sqids.decode(id)).to eq(numbers)
+    end
+
+    expect(set.size).to eq(upper)
+  end
+
+  it 'uniques, low ranges' do
+    set = Set.new
+
+    (0...upper).each do |i|
+      numbers = [i]
+      id = sqids.encode(numbers)
+      set.add(id)
+      expect(sqids.decode(id)).to eq(numbers)
+    end
+
+    expect(set.size).to eq(upper)
+  end
+
+  it 'uniques, high ranges' do
+    set = Set.new
+
+    (100_000_000...(100_000_000 + upper)).each do |i|
+      numbers = [i]
+      id = sqids.encode(numbers)
+      set.add(id)
+      expect(sqids.decode(id)).to eq(numbers)
+    end
+
+    expect(set.size).to eq(upper)
+  end
+
+  it 'uniques, multi' do
+    set = Set.new
+
+    (0...upper).each do |i|
+      numbers = [i, i, i, i, i]
+      id = sqids.encode(numbers)
+      set.add(id)
+      expect(sqids.decode(id)).to eq(numbers)
+    end
+
+    expect(set.size).to eq(upper)
+  end
+end

data/sqids.gemspec

@@ -0,0 +1,21 @@
+# frozen_string_literal: true
+
+require 'English'
+lib = File.expand_path('lib', __dir__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'sqids'
+
+Gem::Specification.new do |gem|
+  gem.name          = 'sqids'
+  gem.version       = '0.1.0'
+  gem.authors       = ['Sqids Maintainers']
+  gem.summary       = 'Generate YouTube-like ids from numbers.'
+  gem.homepage      = 'https://sqids.org/ruby'
+  gem.license       = 'MIT'
+
+  gem.required_ruby_version = '>= 3.1'
+
+  gem.files         = `git ls-files`.split($INPUT_RECORD_SEPARATOR)
+  gem.require_paths = ['lib']
+  gem.metadata['rubygems_mfa_required'] = 'true'
+end

metadata

@@ -0,0 +1,56 @@
+--- !ruby/object:Gem::Specification
+name: sqids
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Sqids Maintainers
+autorequire:
+bindir: bin
+cert_chain: []
+date: 2023-08-12 00:00:00.000000000 Z
+dependencies: []
+description:
+email:
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".github/workflows/tests.yml"
+- ".rubocop.yml"
+- CHANGELOG.md
+- Gemfile
+- LICENSE
+- README.md
+- lib/sqids.rb
+- spec/alphabet_spec.rb
+- spec/blocklist_spec.rb
+- spec/encoding_spec.rb
+- spec/minlength_spec.rb
+- spec/uniques_spec.rb
+- sqids.gemspec
+homepage: https://sqids.org/ruby
+licenses:
+- MIT
+metadata:
+  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: '3.1'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.4.10
+signing_key:
+specification_version: 4
+summary: Generate YouTube-like ids from numbers.
+test_files: []