lite-uxid 1.0.6 → 1.0.7

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: b0f574e15cdd7048ec0fa01a581ffc9b87cc23280232bd65be19cecfde8f2bec
-  data.tar.gz: 729e58e8c0c9bb0dd4946d864897a412503aac7501e79716fdd0664b589cf53b
+  metadata.gz: fe547bd3a8fdf44914843620a6cdc666e1b03bbac050011461978e576941a81e
+  data.tar.gz: ce9f35b1eeedb1fff9c49d95f5786198a1ab7ddde2edd7ba7f3611e3394e73ea
 SHA512:
-  metadata.gz: 4ef8ffeaf8e8a1eebfd8e42b0a372613471de344947db842bb5016cc960cd4b0a9b907ae9f8542984ef87b5690ddf932de1d020c1997d02e653317df06f7842f
-  data.tar.gz: 3a2a1be1875ee5e1d54d0547b954f749a3ba9b5cd494556fe8a38143c282c38500c333d280edbdd15a4b71cf789043705335a9476fc8dcdd39d43f4d1743bb36
+  metadata.gz: 4af9d9462065e6b115617b3eedff718cce01a2220efba39e646463b320e24fd7865dbdb02f653de45c98778e2b8c4687a5bedbd0d5fe04bc27ad25e52bcc2dc6
+  data.tar.gz: 2d55a27063cbd1a3273f8d1212c56a1145484aa4c97dfe4950809555d2ddcd24c121fee54eb169f775e88d5ce11bb53c75fecd794c026d0f67e9f37427c75cc5

data/CHANGELOG.md

@@ -6,11 +6,17 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 
 ## [Unreleased]
 
+## [1.0.7] - 2019-08-26
+### Added
+- Added prevention of Nanoid collision when using with active_record
+### Changed
+- Renamed Hash to Hashid
+
 ## [1.0.6] - 2019-08-26
 ### Changed
 - Improved how configuration works
 ### Removed
-- Remove activerecord and activesupport requirements that are already provided by Rails
+- Remove active_record requirement that are already provided by Rails
 
 ## [1.0.5] - 2019-08-24
 ### Changed
@@ -25,16 +31,16 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 - Added benchmarks
 ### Changed
 - Changed instance method names to match class names
-- Changed nanoid encoder to be faster
-- Changed ulid encoder to be faster
+- Changed Nanoid encoder to be faster
+- Changed Ulid encoder to be faster
 
 ## [1.0.2] - 2019-07-30
 ### Added
-- Added nanoid
+- Added Nanoid
 
 ## [1.0.1] - 2019-06-25
 ### Removed
-- Remove unused activesupport dependency
+- Remove unused active_support dependency
 
 ## [1.0.0] - 2019-06-25
 ### Added

data/Gemfile.lock

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

data/README.md

@@ -3,7 +3,7 @@
 [![Gem Version](https://badge.fury.io/rb/lite-uxid.svg)](http://badge.fury.io/rb/lite-uxid)
 [![Build Status](https://travis-ci.org/drexed/lite-uxid.svg?branch=master)](https://travis-ci.org/drexed/lite-uxid)
 
-Lite::Uxid is a library for generating or obfuscating Id's based on Hash and ULID algorithms.
+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.
 
 **NOTE:** If you are coming from `ActiveUxid`, please read the [port](#port) section.
@@ -27,7 +27,7 @@ Or install it yourself as:
 ## Table of Contents
 
 * [Configuration](#configuration)
-* [Hash](#hash)
+* [Hashid](#hashid)
 * [NanoID](#nanoid)
 * [ULID](#ulid)
 * [ActiveRecord](#active_record)
@@ -47,13 +47,13 @@ Lite::Uxid.configure do |config|
 end
 ```
 
-## Hash
+## Hashid
 
-Hash ID's are reversible and is the most performant generator.
+Hashid's are reversible and is the most performant generator.
 
 ```ruby
-Lite::Uxid::Hash.encode(10)         #=> 'q5D8inm0'
-Lite::Uxid::Hash.decode('q5D8inm0') #=> 10
+Lite::Uxid::Hashid.encode(10)         #=> 'q5D8inm0'
+Lite::Uxid::Hashid.decode('q5D8inm0') #=> 10
 ```
 
 ## NanoID
@@ -90,7 +90,7 @@ All `nanoid` and `uxid` attributes will be automatically generated and applied w
 
 ```ruby
 class User < ActiveRecord::Base
-  include Lite::Uxid::Record::Hash
+  include Lite::Uxid::Record::Hashid
 
   # - or -
 
@@ -104,19 +104,20 @@ end
 
 **Usage**
 
-The following methods are for Hash based Uxid's.
+Using one of the mixins above provides a handy method to find records by uxid.
 
 ```ruby
-User.find_by_ulid('x123')   #=> Find record by uxid
-User.find_by_ulid!('x123')  #=> Raises an ActiveRecord::RecordNotFound error if not found
+User.find_by_uxid('x123')   #=> Find record by uxid
+User.find_by_uxid!('x123')  #=> Raises an ActiveRecord::RecordNotFound error if not found
 
+# The following method is for Hashid based Uxid's.
 user = User.new
-user.hash_to_id             #=> Decodes the records uxid to id (only for Hash based Id's)
+user.uxid_to_id             #=> Decodes the records uxid to id (only for Hashid based Id's)
 ```
 
 ## Benchmarks
 
-The classes ranked from fastest to slowest are `Hash`, `Nanoid`, and `Ulid`.
+The classes ranked from fastest to slowest are `Hashid`, `Nanoid`, and `Ulid`.
 
 View how each compares by running the [benchmarks](https://github.com/drexed/lite-uxid/tree/master/benchmarks).
 

data/benchmarks/compare.rb

@@ -6,8 +6,8 @@ require 'benchmark/ips'
 require 'lite/uxid'
 
 Benchmark.ips do |x|
-  x.report('Hash') do
-    Lite::Uxid::Hash.encode(rand(1..1_000_000))
+  x.report('Hashid') do
+    Lite::Uxid::Hashid.encode(rand(1..1_000_000))
   end
 
   x.report('NanoID') do

data/lib/lite/uxid.rb

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

data/lib/lite/uxid/{hash.rb → hashid.rb}

@@ -2,7 +2,7 @@
 
 module Lite
   module Uxid
-    class Hash < Lite::Uxid::Base
+    class Hashid < Lite::Uxid::Base
 
       def initialize(id)
         @id = id

data/lib/lite/uxid/record/{hash.rb → hashid.rb}

@@ -5,7 +5,7 @@ require 'active_support'
 module Lite
   module Uxid
     module Record
-      module Hash
+      module Hashid
 
         extend ActiveSupport::Concern
 
@@ -15,7 +15,7 @@ module Lite
 
         class_methods do
           def find_by_uxid(uxid)
-            decoded_id = Lite::Uxid::Hash.decode(uxid)
+            decoded_id = Lite::Uxid::Hashid.decode(uxid)
             find_by(id: decoded_id)
           end
 
@@ -30,13 +30,13 @@ module Lite
         def uxid_to_id
           return unless respond_to?(:uxid)
 
-          Lite::Uxid::Hash.decode(uxid)
+          Lite::Uxid::Hashid.decode(uxid)
         end
 
         private
 
         def callback_generate_uxid!
-          hash = Lite::Uxid::Hash.encode(id)
+          hash = Lite::Uxid::Hashid.encode(id)
           update_column(:uxid, hash)
         end
 

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

@@ -29,7 +29,14 @@ module Lite
         private
 
         def callback_generate_uxid!
-          self.uxid = Lite::Uxid::Nanoid.encode
+          random_nanoid = nil
+
+          loop do
+            random_nanoid = Lite::Uxid::Nanoid.encode
+            break unless self.class.exists?(uxid: random_nanoid)
+          end
+
+          self.uxid = random_nanoid
         end
 
       end

data/lib/lite/uxid/version.rb

@@ -3,7 +3,7 @@
 module Lite
   module Uxid
 
-    VERSION ||= '1.0.6'
+    VERSION ||= '1.0.7'
 
   end
 end

data/lite-uxid.gemspec

@@ -10,7 +10,7 @@ Gem::Specification.new do |spec|
   spec.authors = ['Juan Gomez']
   spec.email = %w[j.gomez@drexed.com]
 
-  spec.summary = "Generate or obfuscate Hash or ULID based Id's"
+  spec.summary = "Generate or obfuscate Id's using different patterns"
   spec.homepage = 'http://drexed.github.io/lite-uxid'
   spec.license = 'MIT'
 

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: lite-uxid
 version: !ruby/object:Gem::Version
-  version: 1.0.6
+  version: 1.0.7
 platform: ruby
 authors:
 - Juan Gomez
@@ -206,9 +206,9 @@ files:
 - lib/lite/uxid.rb
 - lib/lite/uxid/base.rb
 - lib/lite/uxid/configuration.rb
-- lib/lite/uxid/hash.rb
+- lib/lite/uxid/hashid.rb
 - lib/lite/uxid/nanoid.rb
-- lib/lite/uxid/record/hash.rb
+- lib/lite/uxid/record/hashid.rb
 - lib/lite/uxid/record/nanoid.rb
 - lib/lite/uxid/record/ulid.rb
 - lib/lite/uxid/ulid.rb
@@ -236,5 +236,5 @@ requirements: []
 rubygems_version: 3.0.4
 signing_key: 
 specification_version: 4
-summary: Generate or obfuscate Hash or ULID based Id's
+summary: Generate or obfuscate Id's using different patterns
 test_files: []