lite-uxid 1.0.2 → 1.0.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 3a8f42192c67ad0638ff6b3001a5887b5c5fc1bd9e05cb7e6a757c53d11ce15d
-  data.tar.gz: '058af68572f76f3c6227f2a437e254b25e783e9495e86bddd57b5bf2295b5446'
+  metadata.gz: f097d6940ba5a48c1e0abc585373595a1445cca093efb20f8e1043a1d68befb0
+  data.tar.gz: 55883b58633a5cdf3e01e5cd85d3c8ede048b43ac73c3fa7706e49ddf81c816d
 SHA512:
-  metadata.gz: c29f1a9f5cd7721cf67f07b5f4077ed1e0aa312bcf7fa095ebaf4a51d4c0ec4b518ab719bd32b3ece0f431c248f1f27ef3aaeb2f60f99d6f197dba8375248539
-  data.tar.gz: d476f672216ee1ee7e136ffe1dd335c3a6ebd15ab29a7ade8d7f1fed7e74416fd3109067d5e1af6ce70fea240b11c6af4a88d59c7f8fed81d620d72178dbd281
+  metadata.gz: f0a0f82a7509fb845d5a86c0f52fe8ce7138fa602203dc7a0296d98325787e8f9aa2feecfb2edd839ef41605d23e81d6072b36e53c27d3fb0ef47f5a172fcc82
+  data.tar.gz: 85bda358c26cd64b5a9b2d1e994543eca653250748a4df35a22428daf973041dc63654ac5fd7d046108248c7da61727ca579b9ace9b2556c5d014a4f0c85ac90

data/.rubocop.yml

@@ -18,6 +18,8 @@ Metrics/BlockLength:
   Exclude:
     - 'spec/**/**/*'
     - '*.gemspec'
+RSpec/MultipleExpectations:
+  Enabled: false
 Style/Documentation:
   Enabled: false
 Style/ExpandPathArguments:

data/CHANGELOG.md

@@ -6,6 +6,14 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 
 ## [Unreleased]
 
+## [1.0.3] - 2019-07-31
+### Added
+- Added benchmarks
+### Changed
+- Changed instance method names to match class names
+- Changed nanoid encoder to be faster
+- Changed ulid encoder to be faster
+
 ## [1.0.2] - 2019-07-30
 ### Added
 - Added nanoid

data/Gemfile.lock

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

data/README.md

@@ -31,6 +31,7 @@ Or install it yourself as:
 * [NanoID](#nanoid)
 * [ULID](#ulid)
 * [ActiveRecord](#active_record)
+* [Benchmarks](#benchmarks)
 * [Port](#port)
 
 ## Configuration
@@ -48,7 +49,7 @@ end
 
 ## Hash
 
-Hash ID's are reversible but less performant than ULID.
+Hash ID's are reversible and is the most performant generator.
 
 ```ruby
 Lite::Uxid::Hash.encode(10)         #=> 'q5D8inm0'
@@ -57,7 +58,7 @@ Lite::Uxid::Hash.decode('q5D8inm0') #=> 10
 
 ## NanoID
 
-NanoID are not reversible and are the most performant random ID's but while unlikely can produce collisions.
+NanoID are not reversible and are the second fastest ID generator but while unlikely can produce collisions.
 
 ```ruby
 Lite::Uxid::Nanoid.encode #=> '0bmHjB5Gx8FTBqJekX6dS6XIXf'
@@ -65,7 +66,7 @@ Lite::Uxid::Nanoid.encode #=> '0bmHjB5Gx8FTBqJekX6dS6XIXf'
 
 ## ULID
 
-ULID are not reversible and more performant than Hash ID's.
+ULID are not reversible but provide information outside of just randomness.
 
 ```ruby
 Lite::Uxid::Ulid.encode #=> '1mqfg9qa96s8s5f02o1ucf8lcc'
@@ -113,6 +114,12 @@ user = User.new
 user.hash_to_id             #=> Decodes the records uxid to id (only for Hash based Id's)
 ```
 
+## Benchmarks
+
+The classes ranked from fastest to slowest are `Hash`, `Nanoid`, and `Ulid`.
+
+View how each compares by running the [benchmarks](https://github.com/drexed/lite-uxid/tree/master/benchmarks).
+
 ## Port
 
 `Lite::Uxid` is a compatible port of [ActiveUxid](https://github.com/drexed/active_uxid).

data/benchmarks/compare.rb

@@ -0,0 +1,22 @@
+# frozen_string_literal: true
+
+%w[lib benchmarks].each { |name| $LOAD_PATH.unshift(name) }
+
+require 'benchmark/ips'
+require 'lite/uxid'
+
+Benchmark.ips do |x|
+  x.report('Hash') do
+    Lite::Uxid::Hash.encode(rand(1..1_000_000))
+  end
+
+  x.report('NanoID') do
+    Lite::Uxid::Nanoid.encode
+  end
+
+  x.report('ULID') do
+    Lite::Uxid::Ulid.encode
+  end
+
+  x.compare!
+end

data/lib/lite/uxid/hash.rb

@@ -13,25 +13,27 @@ module Lite
 
         def encode(id)
           klass = new(id)
-          klass.encode_uxid
+          klass.encode
         end
 
-      end
+        def decode(id)
+          klass = new(id)
+          klass.decode
+        end
 
-      def self.decode(id)
-        klass = new(id)
-        klass.decode_uxid
       end
 
-      def encode_uxid
-        uxid_encode_chars((@id + encoding_salt) << encoding_length)
+      def encode
+        encode_chars((@id + encoding_salt) << encoding_length)
       end
 
-      def decode_uxid
-        (uxid_decode_chars(@id) >> encoding_length) - encoding_salt
+      def decode
+        (decode_chars(@id) >> encoding_length) - encoding_salt
       end
 
-      def uxid_encode_chars(id)
+      private
+
+      def encode_chars(id)
         return '0' if id.zero?
         return nil if id.negative?
 
@@ -45,7 +47,7 @@ module Lite
         str
       end
 
-      def uxid_decode_chars(id)
+      def decode_chars(id)
         pos = 0
         num = 0
         len = id.length

data/lib/lite/uxid/nanoid.rb

@@ -1,7 +1,5 @@
 # frozen_string_literal: true
 
-require 'securerandom'
-
 module Lite
   module Uxid
     class Nanoid < Lite::Uxid::Base
@@ -10,15 +8,22 @@ module Lite
 
         def encode
           klass = new
-          klass.nanoid_encode
+          klass.encode
         end
 
       end
 
-      def nanoid_encode
-        encoding_length.times.with_object('') do |_i, str|
-          str + encoding_chars[(SecureRandom.rand * encoding_base).floor]
+      def encode
+        str = ''
+        len = encoding_length
+        chars = encoding_chars.split(str)
+
+        while len.positive?
+          str += chars.sample
+          len -= 1
         end
+
+        str
       end
 
     end

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

@@ -12,13 +12,15 @@ module Lite
 
         included do
           after_create :callback_generate_uxid!, if: proc { respond_to?(:uxid) }
+        end
 
-          def self.find_by_uxid(uxid)
+        class_methods do
+          def find_by_uxid(uxid)
             decoded_id = Lite::Uxid::Hash.decode(uxid)
             find_by(id: decoded_id)
           end
 
-          def self.find_by_uxid!(uxid)
+          def find_by_uxid!(uxid)
             record = find_by_uxid(uxid)
             return record unless record.nil?
 

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

@@ -12,12 +12,14 @@ module Lite
 
         included do
           before_create :callback_generate_uxid!, if: proc { respond_to?(:uxid) }
+        end
 
-          def self.find_by_uxid(uxid)
+        class_methods do
+          def find_by_uxid(uxid)
             find_by(uxid: uxid)
           end
 
-          def self.find_by_uxid!(uxid)
+          def find_by_uxid!(uxid)
             record = find_by_uxid(uxid)
             return record unless record.nil?
 

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

@@ -12,12 +12,14 @@ module Lite
 
         included do
           before_create :callback_generate_uxid!, if: proc { respond_to?(:uxid) }
+        end
 
-          def self.find_by_uxid(uxid)
+        class_methods do
+          def find_by_uxid(uxid)
             find_by(uxid: uxid)
           end
 
-          def self.find_by_uxid!(uxid)
+          def find_by_uxid!(uxid)
             record = find_by_uxid(uxid)
             return record unless record.nil?
 

data/lib/lite/uxid/ulid.rb

@@ -6,38 +6,49 @@ module Lite
   module Uxid
     class Ulid < Lite::Uxid::Base
 
+      MASK ||= 0x1f
+
       class << self
 
         def encode
           klass = new
-          klass.uxid_encode
+          klass.encode
         end
 
       end
 
-      def uxid_encode
-        (1..encoding_length).reduce('') do |str, num|
-          shift = 128 - 5 * num
-          "#{str}#{encoding_chars[(uxid_octect >> shift) & 0x1f]}"
+      def encode
+        oct = octect
+        ele = '0' * encoding_length
+        pos = encoding_length - 1
+
+        while oct.positive?
+          ele[pos] = encoding_chars[oct & MASK]
+          oct >>= 5
+          pos -= 1
         end
+
+        ele
       end
 
-      def uxid_bytes
-        "#{uxid_unixtime_48bit}#{SecureRandom.random_bytes(10)}"
+      private
+
+      def bytes
+        "#{unixtime_48bit}#{SecureRandom.random_bytes(10)}"
       end
 
-      def uxid_octect
-        (hi, lo) = uxid_bytes.unpack('Q>Q>')
+      def octect
+        (hi, lo) = bytes.unpack('Q>Q>')
         (hi << 64) | lo
       end
 
-      def uxid_unixtime_flex
+      def unixtime_ms
         time = Time.respond_to?(:current) ? Time.current : Time.now
-        (time.to_f * 10_000).to_i
+        (time.to_f * 1_000).to_i
       end
 
-      def uxid_unixtime_48bit
-        [uxid_unixtime_flex].pack('Q>')[2..-1]
+      def unixtime_48bit
+        [unixtime_ms].pack('Q>')[2..-1]
       end
 
     end

data/lib/lite/uxid/version.rb

@@ -3,7 +3,7 @@
 module Lite
   module Uxid
 
-    VERSION ||= '1.0.2'
+    VERSION ||= '1.0.3'
 
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: lite-uxid
 version: !ruby/object:Gem::Version
-  version: 1.0.2
+  version: 1.0.3
 platform: ruby
 authors:
 - Juan Gomez
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2019-07-30 00:00:00.000000000 Z
+date: 2019-07-31 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activerecord
@@ -184,6 +184,7 @@ files:
 - README.md
 - Rakefile
 - _config.yml
+- benchmarks/compare.rb
 - bin/console
 - bin/setup
 - lib/generators/lite/uxid/install_generator.rb