lite-uxid 1.3.0 → 1.4.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: e12d0fcd0ea1e1653d22eea382fb4d770aa50dda8d9cfebc3a0633e50e01c64d
-  data.tar.gz: 4eb22adb047d392dc1ee1645b9465c98940137f2b562635f8678d08398dc06af
+  metadata.gz: 1f8fdc0fac3f66d26f1fa5ed7944775912fedb7ef4a8c1d8d582ca3b8ddad11c
+  data.tar.gz: 9e0b2729d115fab68c449034c95ce38706680eaf0327a1f46bea2e4afb654a66
 SHA512:
-  metadata.gz: 831968f72b1e450f5caaa4b330f236b2c0b1c6780dfe4153d68265f7a53752e12090b589c7235e92c16fd2e1ce2e58da8df7ef6321b47d13c02d514c4bb9f7f1
-  data.tar.gz: d8491cec5de3a930c968992b2b159691b041549c890ed77a9369b5edaffda1bb6592cba992ad4f7284cd297cc7646c9b5dcefe6f64156fba08e959be57280c68
+  metadata.gz: 8cdb90bf7523761fe7fe9673195d888419ffc5fd0199c52bd353e39b779746b5e4bbe7e18232baf97a8bfd106afb0eb593e68818eac886aa5cc17cfa20a6bc56
+  data.tar.gz: 07c960b84a617349cd65c74639dbf3fee6e82ea519d0bf64ff3f52dcb75b8e6b8ff3d06c935cd58170e5987ed06ff5b47913bce7866964e24abe935c6749b383

data/CHANGELOG.md

@@ -6,13 +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.3.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,6 +26,7 @@ Or install it yourself as:
 ## Table of Contents
 
 * [Configuration](#configuration)
+* [Usage](#usage)
 * [Hashid](#hashid)
 * [NanoID](#nanoid)
 * [ULID](#ulid)
@@ -40,21 +42,36 @@ 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
 
 [More information](https://hashids.org)
 
 ```ruby
-Lite::Uxid::Hashid.encode(10)       #=> '67wGI0'
-Lite::Uxid::Hashid.decode('67wGI0') #=> 10
+Lite::Uxid::Hashid.encode(10)        #=> '1zWr1m0'
+Lite::Uxid::Hashid.decode('1zWr1m0') #=> 10
 ```
 
 ## NanoID
@@ -70,12 +87,12 @@ Lite::Uxid::Nanoid.encode #=> 'sMuNUa3Cegn6r5GRQ4Ij2'
 [More information](https://github.com/ulid/spec)
 
 ```ruby
-Lite::Uxid::Ulid.encode #=> '01gial8st6qrroptaks2tj4smq'
+Lite::Uxid::Ulid.encode #=> '01GJAY9KGR539EZF4QWYEJGSN7'
 ```
 
 ## UUID
 
-[More information](https://en.wikipedia.org/wiki/Universally_unique_identifier)
+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'
@@ -86,7 +103,7 @@ Lite::Uxid::Uuid.encode #=> '4376a67e-1189-44b3-a599-7f7566bf105b'
 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

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/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

@@ -1,7 +1,5 @@
 # frozen_string_literal: true
 
-require "securerandom" unless defined?(SecureRandom)
-
 module Lite
   module Uxid
     class Uuid < Irreversible

data/lib/lite/uxid/version.rb

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

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: lite-uxid
 version: !ruby/object:Gem::Version
-  version: 1.3.0
+  version: 1.4.0
 platform: ruby
 authors:
 - Juan Gomez