lite-uxid 1.2.0 → 1.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 8119c92432950cdd4fd849aafd041832a8f4ceee022c7f38009681726bb1181a
-  data.tar.gz: 121d26ff5203b65b8a4b148f9f82aad5585c4baeae6ae1008e71cc057d6fc1f8
+  metadata.gz: e12d0fcd0ea1e1653d22eea382fb4d770aa50dda8d9cfebc3a0633e50e01c64d
+  data.tar.gz: 4eb22adb047d392dc1ee1645b9465c98940137f2b562635f8678d08398dc06af
 SHA512:
-  metadata.gz: 4ed1ddf45549eef5ee6b6950b000272b8d62dfa8ac5b403fa5e6ffc70dfabd9a03978a7e96259184b3222b42e3b1dc240e44984ee89086cfe3f396e7fcfa3d8c
-  data.tar.gz: c63df74d2affbda2f3fefc86a0b5d44364dfef7417b22c6c56f7d411808d3935d1b26f06de92d8699f3ababaf8c84a9e3a0149123a3ed66d52e92bf59f064192
+  metadata.gz: 831968f72b1e450f5caaa4b330f236b2c0b1c6780dfe4153d68265f7a53752e12090b589c7235e92c16fd2e1ce2e58da8df7ef6321b47d13c02d514c4bb9f7f1
+  data.tar.gz: d8491cec5de3a930c968992b2b159691b041549c890ed77a9369b5edaffda1bb6592cba992ad4f7284cd297cc7646c9b5dcefe6f64156fba08e959be57280c68

data/CHANGELOG.md

@@ -6,6 +6,10 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 
 ## [Unreleased]
 
+## [1.3.0] - 2022-11-20
+### Added
+- Added uuid option
+
 ## [1.2.0] - 2022-11-19
 ### Added
 - Added individual character and length options

data/Gemfile.lock

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

data/README.md

@@ -28,6 +28,7 @@ Or install it yourself as:
 * [Hashid](#hashid)
 * [NanoID](#nanoid)
 * [ULID](#ulid)
+* [UUID](#uuid)
 * [Options](#options)
 * [ActiveRecord](#active_record)
 * [Benchmarks](#benchmarks)
@@ -49,27 +50,35 @@ end
 
 ## 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)       #=> '67wGI0'
+Lite::Uxid::Hashid.decode('67wGI0') #=> 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 #=> '01gial8st6qrroptaks2tj4smq'
+```
+
+## UUID
+
+[More information](https://en.wikipedia.org/wiki/Universally_unique_identifier)
+
+```ruby
+Lite::Uxid::Uuid.encode #=> '4376a67e-1189-44b3-a599-7f7566bf105b'
 ```
 
 ## Options
@@ -115,6 +124,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 +150,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/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/uuid.rb

@@ -0,0 +1,15 @@
+# frozen_string_literal: true
+
+require "securerandom" unless defined?(SecureRandom)
+
+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.3.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.3.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