lite-uxid 1.0.1 → 1.0.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: d41dbcc7942d92f457acf001b75e40564c26245df724cc581b3b7c61ea258acd
-  data.tar.gz: 6a68ad1a07b79b5d38cb91ffb6280bc95a9df1a986300cd2bf226c1c762992ac
+  metadata.gz: 3a8f42192c67ad0638ff6b3001a5887b5c5fc1bd9e05cb7e6a757c53d11ce15d
+  data.tar.gz: '058af68572f76f3c6227f2a437e254b25e783e9495e86bddd57b5bf2295b5446'
 SHA512:
-  metadata.gz: def1639ce2619b031236a560de63eaa6175a718b7a780ee013b106b26893740ae9301214341e2ac379caaba38007649ff2f1d866977209a4947155482332c157
-  data.tar.gz: 40f56b1b334ffe41e62b28698a0ee3fdc190e74cefe6a1c8b26d772057e554f03629cfe5f5b7454c6113388e5ca1468a6305c965d2a82965630251ae71436699
+  metadata.gz: c29f1a9f5cd7721cf67f07b5f4077ed1e0aa312bcf7fa095ebaf4a51d4c0ec4b518ab719bd32b3ece0f431c248f1f27ef3aaeb2f60f99d6f197dba8375248539
+  data.tar.gz: d476f672216ee1ee7e136ffe1dd335c3a6ebd15ab29a7ade8d7f1fed7e74416fd3109067d5e1af6ce70fea240b11c6af4a88d59c7f8fed81d620d72178dbd281

data/CHANGELOG.md

@@ -6,8 +6,12 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 
 ## [Unreleased]
 
-## [1.0.1] - 2019-06-25
+## [1.0.2] - 2019-07-30
 ### Added
+- Added nanoid
+
+## [1.0.1] - 2019-06-25
+### Removed
 - Remove unused activesupport dependency
 
 ## [1.0.0] - 2019-06-25

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    lite-uxid (1.0.1)
+    lite-uxid (1.0.2)
 
 GEM
   remote: https://rubygems.org/
@@ -39,7 +39,7 @@ GEM
     database_cleaner (1.7.0)
     diff-lcs (1.3)
     erubi (1.8.0)
-    fasterer (0.5.1)
+    fasterer (0.6.0)
       colorize (~> 0.7)
       ruby_parser (>= 3.13.0)
     generator_spec (0.9.4)
@@ -74,12 +74,12 @@ GEM
       rake (>= 0.8.7)
       thor (>= 0.19.0, < 2.0)
     rainbow (3.0.0)
-    rake (12.3.2)
+    rake (12.3.3)
     rspec (3.8.0)
       rspec-core (~> 3.8.0)
       rspec-expectations (~> 3.8.0)
       rspec-mocks (~> 3.8.0)
-    rspec-core (3.8.1)
+    rspec-core (3.8.2)
       rspec-support (~> 3.8.0)
     rspec-expectations (3.8.4)
       diff-lcs (>= 1.2.0, < 2.0)
@@ -88,16 +88,16 @@ GEM
       diff-lcs (>= 1.2.0, < 2.0)
       rspec-support (~> 3.8.0)
     rspec-support (3.8.2)
-    rubocop (0.72.0)
+    rubocop (0.73.0)
       jaro_winkler (~> 1.5.1)
       parallel (~> 1.10)
       parser (>= 2.6)
       rainbow (>= 2.2.2, < 4.0)
       ruby-progressbar (~> 1.7)
       unicode-display_width (>= 1.4.0, < 1.7)
-    rubocop-performance (1.4.0)
+    rubocop-performance (1.4.1)
       rubocop (>= 0.71.0)
-    rubocop-rspec (1.33.0)
+    rubocop-rspec (1.34.0)
       rubocop (>= 0.60.0)
     ruby-progressbar (1.10.1)
     ruby_parser (3.13.1)

data/README.md

@@ -28,6 +28,7 @@ Or install it yourself as:
 
 * [Configuration](#configuration)
 * [Hash](#hash)
+* [NanoID](#nanoid)
 * [ULID](#ulid)
 * [ActiveRecord](#active_record)
 * [Port](#port)
@@ -54,15 +55,23 @@ Lite::Uxid::Hash.encode(10)         #=> 'q5D8inm0'
 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.
+
+```ruby
+Lite::Uxid::Nanoid.encode #=> '0bmHjB5Gx8FTBqJekX6dS6XIXf'
+```
+
 ## ULID
 
-ULID are not reversible and more performant than Hash Id's.
+ULID are not reversible and more performant than Hash ID's.
 
 ```ruby
 Lite::Uxid::Ulid.encode #=> '1mqfg9qa96s8s5f02o1ucf8lcc'
 ```
 
-## ActiveRecord
+#### ActiveRecord
 
 **Table**
 
@@ -70,19 +79,23 @@ Add the following attribute to all corresponding tables.
 
 ```ruby
 # omitted
-  t.binary :uxid, limit: 16, index: { unique: true }
+  t.binary :uxid, limit: 26, index: { unique: true }
 # omitted
 ```
 
 **Setup**
 
-All `uxid` attributes will be automatically generated and applied when the record is created.
+All `nanoid` and `uxid` attributes will be automatically generated and applied when the record is created.
 
 ```ruby
 class User < ActiveRecord::Base
   include Lite::Uxid::Record::Hash
 
-  # Or
+  # - or -
+
+  include Lite::Uxid::Record::Nanoid
+
+  # - or -
 
   include Lite::Uxid::Record::Ulid
 end
@@ -93,19 +106,18 @@ end
 The following methods are for Hash based Uxid's.
 
 ```ruby
-User.find_by_uxid('x123')   #=> Find record by uxid
-User.find_by_uxid!('x123')  #=> Raises an ActiveRecord::RecordNotFound error if not found
+User.find_by_ulid('x123')   #=> Find record by uxid
+User.find_by_ulid!('x123')  #=> Raises an ActiveRecord::RecordNotFound error if not found
 
 user = User.new
-user.uxid_to_id             #=> Decodes the records uxid to id (only for Hash based Id's)
+user.hash_to_id             #=> Decodes the records uxid to id (only for Hash based Id's)
 ```
 
 ## Port
 
-`Lite::Uxid` is compatible port of [ActiveUxid](https://github.com/drexed/active_uxid).
+`Lite::Uxid` is a compatible port of [ActiveUxid](https://github.com/drexed/active_uxid).
 
-Switching is as easy as renaming `ActiveUxid::Hash` to `Lite::Uxid::Hash`
-and `ActiveUxid::Ulid` to `Lite::Uxid::Ulid`.
+Switching is as easy as renaming `ActiveUxid` to `Lite::Uxid`.
 
 ## Development
 

data/lib/lite/uxid/nanoid.rb

@@ -0,0 +1,26 @@
+# frozen_string_literal: true
+
+require 'securerandom'
+
+module Lite
+  module Uxid
+    class Nanoid < Lite::Uxid::Base
+
+      class << self
+
+        def encode
+          klass = new
+          klass.nanoid_encode
+        end
+
+      end
+
+      def nanoid_encode
+        encoding_length.times.with_object('') do |_i, str|
+          str + encoding_chars[(SecureRandom.rand * encoding_base).floor]
+        end
+      end
+
+    end
+  end
+end

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

@@ -0,0 +1,37 @@
+# frozen_string_literal: true
+
+require 'active_record'
+require 'active_support'
+
+module Lite
+  module Uxid
+    module Record
+      module Nanoid
+
+        extend ActiveSupport::Concern
+
+        included do
+          before_create :callback_generate_uxid!, if: proc { respond_to?(:uxid) }
+
+          def self.find_by_uxid(uxid)
+            find_by(uxid: uxid)
+          end
+
+          def self.find_by_uxid!(uxid)
+            record = find_by_uxid(uxid)
+            return record unless record.nil?
+
+            raise ActiveRecord::RecordNotFound
+          end
+        end
+
+        private
+
+        def callback_generate_uxid!
+          self.uxid = Lite::Uxid::Nanoid.encode
+        end
+
+      end
+    end
+  end
+end

data/lib/lite/uxid/version.rb

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

data/lib/lite/uxid.rb

@@ -4,7 +4,7 @@
   require "lite/uxid/#{name}"
 end
 
-%w[hash ulid].each do |name|
+%w[hash nanoid ulid].each do |name|
   require "lite/uxid/record/#{name}"
   require "lite/uxid/#{name}"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: lite-uxid
 version: !ruby/object:Gem::Version
-  version: 1.0.1
+  version: 1.0.2
 platform: ruby
 authors:
 - Juan Gomez
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2019-06-25 00:00:00.000000000 Z
+date: 2019-07-30 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activerecord
@@ -192,7 +192,9 @@ files:
 - lib/lite/uxid/base.rb
 - lib/lite/uxid/configuration.rb
 - lib/lite/uxid/hash.rb
+- lib/lite/uxid/nanoid.rb
 - lib/lite/uxid/record/hash.rb
+- lib/lite/uxid/record/nanoid.rb
 - lib/lite/uxid/record/ulid.rb
 - lib/lite/uxid/ulid.rb
 - lib/lite/uxid/version.rb