sqids 0.2.0 → 0.2.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: f504d0947f3ffd6f0fe3f9dfb4044a056b4c0d30a9d2b95a8ac5b5a043a5c45b
-  data.tar.gz: 62fc2e00992383a7632b5f2a155ecfc09a2d221db4e2a31c505b8c54ea6ec12e
+  metadata.gz: 8738a24714961747ba8fb004ffba899f34889de1e65ba3932a59a50b85558aef
+  data.tar.gz: 6b26a781bd07bc2b805af36d29bd0cc838351569a3a44988e171b6083e75a3e4
 SHA512:
-  metadata.gz: 596b48c403f99904706390dfeb23cfd9c59a075da4d970fada135aa75b9a54e39744bfd810de68b62852c7effe64fe21e3edf376d8f965455a8add0a594ab66e
-  data.tar.gz: 74fbcc76ed257c80fd0a03fc4133ccb1b897ec62381c5377c84b873e372bc58d777194359e2765a67d9e4e38cbac5927a89336eec9a2b0241fe11e29d2e92bc6
+  metadata.gz: 4dbacb914b13fc4a8125f3b313359db82afe1251d5f9ef7d5eaa724fb8b474521e102ec00ef938d621259c52541bf9f6b63647ef1d24243e3bd72a1ab07f6926
+  data.tar.gz: 33660c785f18c7a2692e3e184c275c104c73dd72ac5aa6bca940f1da7dda1a5b3f66c30f55c4010d488bec694bafd0329979bcce3f3e0db20bfb87bdf01a6f4b

data/CHANGELOG.md

@@ -1,5 +1,8 @@
 # CHANGELOG
 
+**v0.2.1:**
+- Improvement: speeding up Sqids.new: [[PR #7](https://github.com/sqids/sqids-ruby/pull/7)] (thanks to [@lawrencegripper](https://github.com/lawrencegripper))
+
 **v0.2.0:** **⚠️ BREAKING CHANGE**
 - **Breaking change**: IDs change. Algorithm has been fine-tuned for better performance [[Issue #11](https://github.com/sqids/sqids-spec/issues/11)]
 - `alphabet` cannot contain multibyte characters

data/README.md

@@ -86,6 +86,11 @@ id = sqids.encode([1, 2, 3]) # 'se8ojk'
 numbers = sqids.decode(id) # [1, 2, 3]
 ```
 
+> [!WARNING]  
+> If you provide a large custom blocklist and/or custom alphabet, calls to `Sqid.new` can take 
+> ~1ms. You should create a singleton instance of `Sqid` at service start and reusing that rather than
+> repeatedly calling `Squid.new`
+
 ## 📝 License
 
 [MIT](LICENSE)

data/lib/sqids.rb

@@ -29,9 +29,19 @@ class Sqids
             "Minimum length has to be between 0 and #{min_length_limit}"
     end
 
-    filtered_blocklist = blocklist.select do |word|
-      word.length >= 3 && (word.downcase.chars - alphabet.downcase.chars).empty?
-    end.to_set(&:downcase)
+    filtered_blocklist = if blocklist == DEFAULT_BLOCKLIST && alphabet == DEFAULT_ALPHABET
+                           # If the blocklist is the default one, we don't need to filter it
+                           # we already know it's valid (lowercase and words longer than 3 chars)
+                           blocklist
+                         else
+                           # Downcase the alphabet once, rather than in the loop, to save significant time
+                           # with large blocklists
+                           downcased_alphabet = alphabet.downcase.chars
+                           # Filter the blocklist
+                           blocklist.select do |word|
+                             word.length >= 3 && (word.downcase.chars - downcased_alphabet).empty?
+                           end.to_set(&:downcase)
+                         end
 
     @alphabet = shuffle(alphabet)
     @min_length = min_length

data/sqids.gemspec

@@ -7,7 +7,7 @@ require 'sqids'
 
 Gem::Specification.new do |gem|
   gem.name          = 'sqids'
-  gem.version       = '0.2.0'
+  gem.version       = '0.2.1'
   gem.authors       = ['Sqids Maintainers']
   gem.summary       = 'Generate YouTube-like ids from numbers.'
   gem.homepage      = 'https://sqids.org/ruby'

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: sqids
 version: !ruby/object:Gem::Version
-  version: 0.2.0
+  version: 0.2.1
 platform: ruby
 authors:
 - Sqids Maintainers
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2023-09-10 00:00:00.000000000 Z
+date: 2024-07-25 00:00:00.000000000 Z
 dependencies: []
 description:
 email:
@@ -27,7 +27,6 @@ files:
 - spec/blocklist_spec.rb
 - spec/encoding_spec.rb
 - spec/minlength_spec.rb
-- spec/uniques_spec.rb
 - sqids.gemspec
 homepage: https://sqids.org/ruby
 licenses:

data/spec/uniques_spec.rb

@@ -1,62 +0,0 @@
-# frozen_string_literal: true
-
-require 'rspec'
-require_relative '../lib/sqids'
-
-upper = 1_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