lite-uxid 1.2.0 → 1.4.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 8119c92432950cdd4fd849aafd041832a8f4ceee022c7f38009681726bb1181a
-  data.tar.gz: 121d26ff5203b65b8a4b148f9f82aad5585c4baeae6ae1008e71cc057d6fc1f8
+  metadata.gz: 1f8fdc0fac3f66d26f1fa5ed7944775912fedb7ef4a8c1d8d582ca3b8ddad11c
+  data.tar.gz: 9e0b2729d115fab68c449034c95ce38706680eaf0327a1f46bea2e4afb654a66
 SHA512:
-  metadata.gz: 4ed1ddf45549eef5ee6b6950b000272b8d62dfa8ac5b403fa5e6ffc70dfabd9a03978a7e96259184b3222b42e3b1dc240e44984ee89086cfe3f396e7fcfa3d8c
-  data.tar.gz: c63df74d2affbda2f3fefc86a0b5d44364dfef7417b22c6c56f7d411808d3935d1b26f06de92d8699f3ababaf8c84a9e3a0149123a3ed66d52e92bf59f064192
+  metadata.gz: 8cdb90bf7523761fe7fe9673195d888419ffc5fd0199c52bd353e39b779746b5e4bbe7e18232baf97a8bfd106afb0eb593e68818eac886aa5cc17cfa20a6bc56
+  data.tar.gz: 07c960b84a617349cd65c74639dbf3fee6e82ea519d0bf64ff3f52dcb75b8e6b8ff3d06c935cd58170e5987ed06ff5b47913bce7866964e24abe935c6749b383

data/CHANGELOG.md

@@ -6,9 +6,18 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 
 ## [Unreleased]
 
+## [1.4.0] - 2022-11-20
+### Changed
+- Improved global config flexibility
+- Update config generator to generate dynamic salt
+
+## [1.3.0] - 2022-11-20
+### Added
+- Added uuid option
+
 ## [1.2.0] - 2022-11-19
 ### Added
-- Added individual character and length options
+- Added individual character and size options
 ### Changed
 - Improved docs
 - Improved internal setup

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    lite-uxid (1.2.0)
+    lite-uxid (1.4.0)
 
 GEM
   remote: https://rubygems.org/

data/README.md

@@ -5,6 +5,7 @@
 
 Lite::Uxid is a library for generating or obfuscating ID's based on different patterns.
 It's very useful to hide the number of resources in your database and protect against enumeration attacks.
+By default, it implements websafe variants of each type.
 
 ## Installation
 
@@ -25,9 +26,11 @@ Or install it yourself as:
 ## Table of Contents
 
 * [Configuration](#configuration)
+* [Usage](#usage)
 * [Hashid](#hashid)
 * [NanoID](#nanoid)
 * [ULID](#ulid)
+* [UUID](#uuid)
 * [Options](#options)
 * [ActiveRecord](#active_record)
 * [Benchmarks](#benchmarks)
@@ -39,37 +42,60 @@ Or install it yourself as:
 
 ```ruby
 Lite::Uxid.configure do |config|
-  config.encoding_chars = '0123456789abcdefghijklmnopqrstuvwxyzABCDEFGHIJKLMNOPQRSTUVWXYZ'
-  config.encoding_salt = 1_369_136
-  config.hashid_length = 12
-  config.nanoid_length = 21
-  config.ulid_length = 26
+  config.hashid_charset = "0123456789abcdefghijklmnopqrstuvwxyzABCDEFGHIJKLMNOPQRSTUVWXYZ"
+  config.hashid_salt = 1_369_136
+  config.hashid_size = 16
+  config.nanoid_charset = "_-0123456789abcdefghijklmnopqrstuvwxyzABCDEFGHIJKLMNOPQRSTUVWXYZ"
+  config.nanoid_size = 21
+  config.ulid_charset = "0123456789ABCDEFGHIJKLMNOPQRSTUVWXYZ"
+  config.ulid_size = 26
 end
 ```
 
+## Usage
+
+#### Instance
+```ruby
+coder = Lite::Uxid::Hashid.new(10, size: 12)
+coder.encode #=> '67wGI0'
+```
+
+#### Class
+```ruby
+Lite::Uxid::Hashid.decode('67wGI0', size: 12) #=> 10
+```
+
 ## Hashid
 
-Hashid's are reversible and is the most performant generator.
+[More information](https://hashids.org)
 
 ```ruby
-Lite::Uxid::Hashid.encode(10)         #=> 'q5D8inm0'
-Lite::Uxid::Hashid.decode('q5D8inm0') #=> 10
+Lite::Uxid::Hashid.encode(10)        #=> '1zWr1m0'
+Lite::Uxid::Hashid.decode('1zWr1m0') #=> 10
 ```
 
 ## NanoID
 
-NanoID are irreversible and are the second fastest ID generator but while unlikely can produce collisions.
+[More information](https://github.com/ai/nanoid)
 
 ```ruby
-Lite::Uxid::Nanoid.encode #=> '0bmHjB5Gx8FTBqJekX6dS6XIXf'
+Lite::Uxid::Nanoid.encode #=> 'sMuNUa3Cegn6r5GRQ4Ij2'
 ```
 
 ## ULID
 
-ULID are irreversible but provide information outside of just randomness.
+[More information](https://github.com/ulid/spec)
 
 ```ruby
-Lite::Uxid::Ulid.encode #=> '1mqfg9qa96s8s5f02o1ucf8lcc'
+Lite::Uxid::Ulid.encode #=> '01GJAY9KGR539EZF4QWYEJGSN7'
+```
+
+## UUID
+
+Implements v4 of the specification. [More information](https://en.wikipedia.org/wiki/Universally_unique_identifier)
+
+```ruby
+Lite::Uxid::Uuid.encode #=> '4376a67e-1189-44b3-a599-7f7566bf105b'
 ```
 
 ## Options
@@ -77,7 +103,7 @@ Lite::Uxid::Ulid.encode #=> '1mqfg9qa96s8s5f02o1ucf8lcc'
 Local options can be passed to override global options.
 
 ```ruby
-Lite::Uxid::Ulid.encode(chars: 'abc123', length: 12) #=> 'a3b12c12c3ca'
+Lite::Uxid::Ulid.encode(chars: 'abc123', size: 12) #=> 'a3b12c12c3ca'
 ```
 
 ## ActiveRecord
@@ -115,6 +141,13 @@ class User < ActiveRecord::Base
 end
 ```
 
+#### UUID
+```ruby
+class User < ActiveRecord::Base
+  include Lite::Uxid::Record::Uuid
+end
+```
+
 **Usage**
 
 Using one of the mixins above provides a handy method to find records by uxid.
@@ -134,10 +167,15 @@ User.find_by_uxid!('x123') #=> Raises an ActiveRecord::RecordNotFound error if n
 
 ## Benchmarks
 
-The classes ranked from fastest to slowest are `Hashid`, `Nanoid`, and `Ulid`.
+The classes ranked from fastest to slowest are `UUID`, `Hashid`, `Nanoid`, and `Ulid`.
 
 View how each compares by running the [benchmarks](https://github.com/drexed/lite-uxid/tree/master/benchmarks).
 
+#### Alternatives
+
+Learn more about alternative functions and more advance hashing setups:
+[hashids.org](https://hashids.org)
+
 ## Development
 
 After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake spec` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.

data/benchmarks/compare.rb

@@ -7,16 +7,24 @@ require "lite/uxid"
 
 Benchmark.ips do |x|
   x.report("Hashid") do
-    Lite::Uxid::Hashid.encode(rand(1..1_000_000))
+    id = rand(1..1_000_000)
+    Lite::Uxid::Hashid.encode(id)
   end
 
   x.report("NanoID") do
+    _id = rand(1..1_000_000) # To simulate the extra work from `rand`
     Lite::Uxid::Nanoid.encode
   end
 
   x.report("ULID") do
+    _id = rand(1..1_000_000) # To simulate the extra work from `rand`
     Lite::Uxid::Ulid.encode
   end
 
+  x.report("UUID") do
+    _id = rand(1..1_000_000) # To simulate the extra work from `rand`
+    Lite::Uxid::Uuid.encode
+  end
+
   x.compare!
 end

data/lib/generators/lite/uxid/templates/install.rb

@@ -1,9 +1,11 @@
 # frozen_string_literal: true
 
 Lite::Uxid.configure do |config|
-  config.encoding_chars = "0123456789abcdefghijklmnopqrstuvwxyzABCDEFGHIJKLMNOPQRSTUVWXYZ"
-  config.encoding_salt = 1_369_136
-  config.hashid_length = 12
-  config.nanoid_length = 21
-  config.ulid_length = 26
+  config.hashid_charset = "0123456789abcdefghijklmnopqrstuvwxyzABCDEFGHIJKLMNOPQRSTUVWXYZ"
+  config.hashid_salt = 1_369_136
+  config.hashid_size = 16
+  config.nanoid_charset = "_-0123456789abcdefghijklmnopqrstuvwxyzABCDEFGHIJKLMNOPQRSTUVWXYZ"
+  config.nanoid_size = 21
+  config.ulid_charset = "0123456789ABCDEFGHIJKLMNOPQRSTUVWXYZ"
+  config.ulid_size = 26
 end

data/lib/lite/uxid/configuration.rb

@@ -5,14 +5,16 @@ module Lite
 
     class Configuration
 
-      attr_accessor :encoding_chars, :encoding_salt, :hashid_length, :nanoid_length, :ulid_length
+      attr_accessor :hashid_charset, :hashid_salt, :hashid_size, :nanoid_charset, :nanoid_size, :ulid_charset, :ulid_size
 
       def initialize
-        @encoding_chars = "0123456789abcdefghijklmnopqrstuvwxyzABCDEFGHIJKLMNOPQRSTUVWXYZ"
-        @encoding_salt = 1_369_136
-        @hashid_length = 12
-        @nanoid_length = 21
-        @ulid_length = 26
+        @hashid_charset = "0123456789abcdefghijklmnopqrstuvwxyzABCDEFGHIJKLMNOPQRSTUVWXYZ"
+        @hashid_salt = 1_369_136
+        @hashid_size = 16
+        @nanoid_charset = "_-0123456789abcdefghijklmnopqrstuvwxyzABCDEFGHIJKLMNOPQRSTUVWXYZ"
+        @nanoid_size = 21
+        @ulid_charset = "0123456789ABCDEFGHJKMNPQRSTVWXYZ"
+        @ulid_size = 26
       end
 
     end

data/lib/lite/uxid/hashid.rb

@@ -5,11 +5,11 @@ module Lite
     class Hashid < Reversible
 
       def encode
-        encode_chars((id + coder_salt) << coder_length)
+        encode_chars((id + coder_salt) << coder_size)
       end
 
       def decode
-        (decode_chars(id) >> coder_length) - coder_salt
+        (decode_chars(id) >> coder_size) - coder_salt
       end
 
       private
@@ -21,8 +21,8 @@ module Lite
         str = ""
 
         while decoded_id.positive?
-          str = "#{coder_chars[decoded_id % coder_base]}#{str}"
-          decoded_id /= coder_base
+          str = "#{coder_charset[decoded_id % coder_length]}#{str}"
+          decoded_id /= coder_length
         end
 
         str
@@ -31,12 +31,12 @@ module Lite
       def decode_chars(encoded_id)
         pos = 0
         num = 0
-        len = encoded_id.length
+        len = encoded_id.size
         max = len - 1
 
         while pos < len
-          pow = coder_base**(max - pos)
-          num += coder_chars.index(encoded_id[pos]) * pow
+          pow = coder_length**(max - pos)
+          num += coder_charset.index(encoded_id[pos]) * pow
           pos += 1
         end
 

data/lib/lite/uxid/irreversible.rb

@@ -1,5 +1,7 @@
 # frozen_string_literal: true
 
+require "securerandom" unless defined?(SecureRandom)
+
 module Lite
   module Uxid
     class Irreversible
@@ -34,14 +36,14 @@ module Lite
 
       private
 
-      def coder_base
-        @coder_base ||= coder_chars.length
+      def coder_bytes
+        @coder_bytes ||= SecureRandom.random_bytes(coder_size).bytes
       end
 
-      def coder_chars
-        @coder_chars ||=
-          opts.delete(:chars) ||
-          Lite::Uxid.configuration.encoding_chars
+      def coder_charset
+        @coder_charset ||=
+          opts.delete(:charset) ||
+          Lite::Uxid.configuration.send("#{coder_class.downcase}_charset")
       end
 
       def coder_class
@@ -49,15 +51,19 @@ module Lite
       end
 
       def coder_length
-        @coder_length ||=
-          opts.delete(:length) ||
-          Lite::Uxid.configuration.send("#{coder_class.downcase}_length")
+        @coder_length ||= coder_charset.size
       end
 
       def coder_salt
         @coder_salt ||=
           opts.delete(:salt) ||
-          Lite::Uxid.configuration.encoding_salt
+          Lite::Uxid.configuration.send("#{coder_class.downcase}_salt")
+      end
+
+      def coder_size
+        @coder_size ||=
+          opts.delete(:size) ||
+          Lite::Uxid.configuration.send("#{coder_class.downcase}_size")
       end
 
     end

data/lib/lite/uxid/nanoid.rb

@@ -5,7 +5,9 @@ module Lite
     class Nanoid < Irreversible
 
       def encode
-        coder_chars.chars.sample(coder_length).join
+        (0...coder_size).each_with_object(+"") do |i, str|
+          str << coder_charset[coder_bytes[i] & 63]
+        end
       end
 
     end

data/lib/lite/uxid/record/uuid.rb

@@ -0,0 +1,25 @@
+# frozen_string_literal: true
+
+require "active_support" unless defined?(ActiveSupport)
+
+module Lite
+  module Uxid
+    module Record
+      module Uuid
+
+        extend ActiveSupport::Concern
+
+        included do
+          before_create :callback_generate_uxid!, if: proc { respond_to?(:uxid) && !uxid? }
+        end
+
+        private
+
+        def callback_generate_uxid!
+          self.uxid = Lite::Uxid::Uuid.encode
+        end
+
+      end
+    end
+  end
+end

data/lib/lite/uxid/ulid.rb

@@ -1,7 +1,5 @@
 # frozen_string_literal: true
 
-require "securerandom" unless defined?(SecureRandom)
-
 module Lite
   module Uxid
     class Ulid < Irreversible
@@ -10,11 +8,11 @@ module Lite
 
       def encode
         oct = octect
-        ele = "0" * coder_length
-        pos = coder_length - 1
+        ele = "0" * coder_size
+        pos = coder_size - 1
 
         while oct.positive?
-          ele[pos] = coder_chars[oct & MASK]
+          ele[pos] = coder_charset[oct & MASK]
           oct >>= 5
           pos -= 1
         end
@@ -35,7 +33,7 @@ module Lite
 
       def unixtime_ms
         time = Time.respond_to?(:current) ? Time.current : Time.now
-        (time.to_f * 1_000).to_i
+        time.to_i * 1_000
       end
 
       def unixtime_48bit

data/lib/lite/uxid/uuid.rb

@@ -0,0 +1,13 @@
+# frozen_string_literal: true
+
+module Lite
+  module Uxid
+    class Uuid < Irreversible
+
+      def encode
+        SecureRandom.uuid
+      end
+
+    end
+  end
+end

data/lib/lite/uxid/version.rb

@@ -3,7 +3,7 @@
 module Lite
   module Uxid
 
-    VERSION = "1.2.0"
+    VERSION = "1.4.0"
 
   end
 end

data/lib/lite/uxid.rb

@@ -9,6 +9,8 @@ require "lite/uxid/reversible"
 require "lite/uxid/record/hashid"
 require "lite/uxid/record/nanoid"
 require "lite/uxid/record/ulid"
+require "lite/uxid/record/uuid"
 require "lite/uxid/hashid"
 require "lite/uxid/nanoid"
 require "lite/uxid/ulid"
+require "lite/uxid/uuid"

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: lite-uxid
 version: !ruby/object:Gem::Version
-  version: 1.2.0
+  version: 1.4.0
 platform: ruby
 authors:
 - Juan Gomez
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2022-11-19 00:00:00.000000000 Z
+date: 2022-11-20 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activerecord
@@ -224,8 +224,10 @@ files:
 - lib/lite/uxid/record/hashid.rb
 - lib/lite/uxid/record/nanoid.rb
 - lib/lite/uxid/record/ulid.rb
+- lib/lite/uxid/record/uuid.rb
 - lib/lite/uxid/reversible.rb
 - lib/lite/uxid/ulid.rb
+- lib/lite/uxid/uuid.rb
 - lib/lite/uxid/version.rb
 - lite-uxid.gemspec
 homepage: http://drexed.github.io/lite-uxid