sqids 0.1.0 → 0.1.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: d51e2c5981c5b59b42e1cd3ddcf953ca6f1f5dfa21998b066064081888523a07
-  data.tar.gz: f3279de8aa60f40dbe20f338d18731f71018958784aaf5e95b65e22a57cd5664
+  metadata.gz: e6375d093506a2d4058cecce28ee9f4e00148e7bde606bb4d64e613cbfb698d8
+  data.tar.gz: c5eb151f25ba5156995c4f7ab9fdf064d931ae619524ddae73cbe420b9ec3c48
 SHA512:
-  metadata.gz: 510e16706f4310fdaab202bfef003d2cd7ce622e79b606d2ea948bf8b04a5f5c0d000e06102447782a87ff25ee0395b7e02e3b24b242af7fe6038b1682e34bde
-  data.tar.gz: 9232d0467cf326a4860d09fcb5e820893e426f6963e0296f821baef7e9873d1ccdd9bba98846f82d02f5ea55c9780c4bd8b136167c2bd8e858cb8b6653409947
+  metadata.gz: 3f92140fe71c4f38875cd66485188b303d46ba3114af2467386256bfa4e8e5bad8f6fff0a0d4f8b478a1ec7bfd2160689c63da46a4d7c9364300383ad43a1894
+  data.tar.gz: 50b51f34611e1d1465fc58cf1f97d406bf4768d7208a77cc2829e55b686806f3189834291dbc12b87774a3852dd41b55c0e994e51909d917fe5002a8adbcbd63

data/.github/workflows/tests.yml

@@ -12,7 +12,7 @@ jobs:
       - name: Set up Ruby
         uses: ruby/setup-ruby@v1
         with:
-          ruby-version: '3.1'
+          ruby-version: '3.0'
           bundler-cache: true
       - name: Install dependencies
         run: bundle install

data/.rubocop.yml

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

data/CHANGELOG.md

@@ -1,4 +1,7 @@
 # CHANGELOG
 
+**v0.1.1:**
+- Lowering Ruby version requirement to 3.0
+
 **v0.1.0:**
 - First implementation of [the spec](https://github.com/sqids/sqids-spec)

data/README.md

@@ -1,10 +1,35 @@
 # [Sqids Ruby](https://sqids.org/ruby)
 
+[![Gem Version](https://badge.fury.io/rb/sqids.svg)](https://rubygems.org/gems/sqids)
 [![Github Actions](https://img.shields.io/github/actions/workflow/status/sqids/sqids-ruby/tests.yml)](https://github.com/sqids/sqids-ruby/actions)
+[![Downloads](https://img.shields.io/gem/dt/sqids)](https://crates.io/crates/sqids)
 
-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.
+[Sqids](https://sqids.org/ruby) (*pronounced "squids"*) is a small library that lets you **generate unique 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
+Features:
+
+- **Encode multiple numbers** - generate short IDs from one or several non-negative numbers
+- **Quick decoding** - easily decode IDs back into numbers
+- **Unique IDs** - generate unique IDs by shuffling the alphabet once
+- **ID padding** - provide minimum length to make IDs more uniform
+- **URL safe** - auto-generated IDs do not contain common profanity
+- **Randomized output** - Sequential input provides nonconsecutive IDs
+- **Many implementations** - Support for [40+ programming languages](https://sqids.org/)
+
+## 🧰 Use-cases
+
+Good for:
+
+- Generating IDs for public URLs (eg: link shortening)
+- Generating IDs for internal systems (eg: event tracking)
+- Decoding for quicker database lookups (eg: by primary keys)
+
+Not good for:
+
+- Sensitive data (this is not an encryption library)
+- User IDs (can be decoded revealing user count)
+
+## 🚀 Getting started
 
 Add this line to your application's Gemfile:
 
@@ -24,7 +49,7 @@ Or install it via:
 gem install sqids
 ```
 
-## Examples
+## 👩‍💻 Examples
 
 Simple encode & decode:
 
@@ -34,6 +59,9 @@ id = sqids.encode([1, 2, 3]) # '8QRLaD'
 numbers = sqids.decode(id) # [1, 2, 3]
 ```
 
+> **Note**
+> 🚧 Because of the algorithm's design, **multiple IDs can decode back into the same sequence of numbers**. If it's important to your design that IDs are canonical, you have to manually re-encode decoded numbers and check that the generated ID matches.
+
 Randomize IDs by providing a custom alphabet:
 
 ```ruby
@@ -58,6 +86,6 @@ id = sqids.encode([1, 2, 3]) # '8QRLaD'
 numbers = sqids.decode(id) # [1, 2, 3]
 ```
 
-## License
+## 📝 License
 
 [MIT](LICENSE)

data/spec/minlength_spec.rb

@@ -49,7 +49,7 @@ describe Sqids do
         [1_000_000],
         [Sqids.max_value]
       ].each do |numbers|
-        sqids = Sqids.new(min_length:)
+        sqids = Sqids.new(min_length: min_length)
 
         id = sqids.encode(numbers)
         expect(id.length).to be >= min_length

data/sqids.gemspec

@@ -7,13 +7,13 @@ require 'sqids'
 
 Gem::Specification.new do |gem|
   gem.name          = 'sqids'
-  gem.version       = '0.1.0'
+  gem.version       = '0.1.1'
   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.required_ruby_version = '>= 3.0'
 
   gem.files         = `git ls-files`.split($INPUT_RECORD_SEPARATOR)
   gem.require_paths = ['lib']

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: sqids
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.1.1
 platform: ruby
 authors:
 - Sqids Maintainers
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2023-08-12 00:00:00.000000000 Z
+date: 2023-08-23 00:00:00.000000000 Z
 dependencies: []
 description:
 email:
@@ -42,7 +42,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: '3.1'
+      version: '3.0'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="