lite-uxid 1.0.5 → 1.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 8be203a82fb5be33425623c0bd52bc6110f4f97de51501da2c8c763b668dc465
-  data.tar.gz: 253bc5163a665d238902c9374d0dbe61d0fd12a6994bd26e4cc1747b171ebf2a
+  metadata.gz: ba3ace509b30efb7ec9d3c4a44b64d6391a57f00b6dd8944361ba2a302bd2b78
+  data.tar.gz: e4da3231b451b9f47269b54a7498e2d1bf8c668480e2fd9e7a4c34c6b46879f1
 SHA512:
-  metadata.gz: b343368500c61fccbfc03b4abeae974fca94b48bb74582048e58abeec23b2b8dfb2693db1e5860c7b50f8477fb898b7574e32cec49da663a03cf3c295d823107
-  data.tar.gz: ed19875ca19e5619d328143373ddeb687a3b541fd14b9575bb3b233ec102b38faaa68ec4db736738b8e383ac9e4599933e21311ee39d00f21374b9e4fc1b0924
+  metadata.gz: c35db134cd36fdff0135be45fe8b8c77ead4f24e1d95bfb7d6c48392754783e206f2bfa034dc44cfdff858df5e42464959f44c290fc7f24211e94e51316b6f34
+  data.tar.gz: 16c21a1ddbf0423c095ad89fc2ed604e4692829a180bd01acd62c29cc3df85e1d5e6984162599423b5c080ff5aa78f83c9da564ba8dcb00ddfeb3252a0a0262d

data/.rubocop.yml

@@ -1,12 +1,16 @@
 require:
   - rubocop-performance
+  - rubocop-rake
   - rubocop-rspec
 AllCops:
-  TargetRubyVersion: 2.6
+  TargetRubyVersion: 3.0
+  NewCops: enable
   DisplayCopNames: true
   DisplayStyleGuide: true
-LineLength:
-  Max: 100
+Gemspec/RequiredRubyVersion:
+  Enabled: false
+Layout/EmptyLinesAroundAttributeAccessor:
+  Enabled: true
 Layout/EmptyLinesAroundBlockBody:
   Exclude:
     - 'spec/**/**/*'
@@ -14,13 +18,25 @@ Layout/EmptyLinesAroundClassBody:
   EnforcedStyle: empty_lines_except_namespace
 Layout/EmptyLinesAroundModuleBody:
   EnforcedStyle: empty_lines_except_namespace
+Layout/LineLength:
+  Max: 100
+Layout/SpaceAroundMethodCallOperator:
+  Enabled: true
+Lint/RaiseException:
+  Enabled: true
+Lint/StructNewOverride:
+  Enabled: true
 Metrics/BlockLength:
   Exclude:
     - 'spec/**/**/*'
     - '*.gemspec'
 RSpec/MultipleExpectations:
   Enabled: false
+Style/ArgumentsForwarding:
+  Enabled: false
 Style/Documentation:
   Enabled: false
 Style/ExpandPathArguments:
   Enabled: false
+Style/SlicingWithRange:
+  Enabled: false

data/.travis.yml

@@ -4,6 +4,7 @@ cache: bundler
 rvm:
 - 2.5
 - 2.6
+- 2.7
 - ruby-head
 matrix:
   fast_finish: true

data/CHANGELOG.md

@@ -6,9 +6,30 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 
 ## [Unreleased]
 
+## [1.1.0] - 2021-07-19
+### Added
+- Added Ruby 3.0 support
+
+## [1.0.8] - 2021-05-07
+### Changed
+- Linter fixes
+
+## [1.0.7] - 2019-08-26
+### Added
+- Added ruby 2.7 support
+- 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 active_record requirement that are already provided by Rails
+
 ## [1.0.5] - 2019-08-24
 ### Changed
-- Imporved how configuration works
+- Improved how configuration works
 
 ## [1.0.4] - 2019-08-15
 ### Changed
@@ -19,16 +40,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,120 +1,136 @@
 PATH
   remote: .
   specs:
-    lite-uxid (1.0.5)
+    lite-uxid (1.1.0)
 
 GEM
   remote: https://rubygems.org/
   specs:
-    actionpack (6.0.0)
-      actionview (= 6.0.0)
-      activesupport (= 6.0.0)
-      rack (~> 2.0)
+    actionpack (6.1.4)
+      actionview (= 6.1.4)
+      activesupport (= 6.1.4)
+      rack (~> 2.0, >= 2.0.9)
       rack-test (>= 0.6.3)
       rails-dom-testing (~> 2.0)
       rails-html-sanitizer (~> 1.0, >= 1.2.0)
-    actionview (6.0.0)
-      activesupport (= 6.0.0)
+    actionview (6.1.4)
+      activesupport (= 6.1.4)
       builder (~> 3.1)
       erubi (~> 1.4)
       rails-dom-testing (~> 2.0)
       rails-html-sanitizer (~> 1.1, >= 1.2.0)
-    activemodel (6.0.0)
-      activesupport (= 6.0.0)
-    activerecord (6.0.0)
-      activemodel (= 6.0.0)
-      activesupport (= 6.0.0)
-    activesupport (6.0.0)
+    activemodel (6.1.4)
+      activesupport (= 6.1.4)
+    activerecord (6.1.4)
+      activemodel (= 6.1.4)
+      activesupport (= 6.1.4)
+    activesupport (6.1.4)
       concurrent-ruby (~> 1.0, >= 1.0.2)
-      i18n (>= 0.7, < 2)
-      minitest (~> 5.1)
-      tzinfo (~> 1.1)
-      zeitwerk (~> 2.1, >= 2.1.8)
-    ast (2.4.0)
-    builder (3.2.3)
+      i18n (>= 1.6, < 2)
+      minitest (>= 5.1)
+      tzinfo (~> 2.0)
+      zeitwerk (~> 2.3)
+    ast (2.4.2)
+    builder (3.2.4)
     colorize (0.8.1)
-    concurrent-ruby (1.1.5)
-    crass (1.0.4)
-    database_cleaner (1.7.0)
-    diff-lcs (1.3)
-    erubi (1.8.0)
-    fasterer (0.6.0)
+    concurrent-ruby (1.1.9)
+    crass (1.0.6)
+    database_cleaner (2.0.1)
+      database_cleaner-active_record (~> 2.0.0)
+    database_cleaner-active_record (2.0.1)
+      activerecord (>= 5.a)
+      database_cleaner-core (~> 2.0.0)
+    database_cleaner-core (2.0.1)
+    diff-lcs (1.4.4)
+    erubi (1.10.0)
+    fasterer (0.9.0)
       colorize (~> 0.7)
-      ruby_parser (>= 3.13.0)
+      ruby_parser (>= 3.14.1)
     generator_spec (0.9.4)
       activesupport (>= 3.0.0)
       railties (>= 3.0.0)
-    i18n (1.6.0)
+    i18n (1.8.10)
       concurrent-ruby (~> 1.0)
-    jaro_winkler (1.5.3)
-    loofah (2.2.3)
+    loofah (2.10.0)
       crass (~> 1.0.2)
       nokogiri (>= 1.5.9)
-    method_source (0.9.2)
-    mini_portile2 (2.4.0)
-    minitest (5.11.3)
-    nokogiri (1.10.4)
-      mini_portile2 (~> 2.4.0)
-    parallel (1.17.0)
-    parser (2.6.3.0)
-      ast (~> 2.4.0)
-    rack (2.0.7)
+    method_source (1.0.0)
+    mini_portile2 (2.5.3)
+    minitest (5.14.4)
+    nokogiri (1.11.7)
+      mini_portile2 (~> 2.5.0)
+      racc (~> 1.4)
+    parallel (1.20.1)
+    parser (3.0.2.0)
+      ast (~> 2.4.1)
+    racc (1.5.2)
+    rack (2.2.3)
     rack-test (1.1.0)
       rack (>= 1.0, < 3)
     rails-dom-testing (2.0.3)
       activesupport (>= 4.2.0)
       nokogiri (>= 1.6)
-    rails-html-sanitizer (1.2.0)
-      loofah (~> 2.2, >= 2.2.2)
-    railties (6.0.0)
-      actionpack (= 6.0.0)
-      activesupport (= 6.0.0)
+    rails-html-sanitizer (1.3.0)
+      loofah (~> 2.3)
+    railties (6.1.4)
+      actionpack (= 6.1.4)
+      activesupport (= 6.1.4)
       method_source
-      rake (>= 0.8.7)
-      thor (>= 0.20.3, < 2.0)
+      rake (>= 0.13)
+      thor (~> 1.0)
     rainbow (3.0.0)
-    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.2)
-      rspec-support (~> 3.8.0)
-    rspec-expectations (3.8.4)
+    rake (13.0.6)
+    regexp_parser (2.1.1)
+    rexml (3.2.5)
+    rspec (3.10.0)
+      rspec-core (~> 3.10.0)
+      rspec-expectations (~> 3.10.0)
+      rspec-mocks (~> 3.10.0)
+    rspec-core (3.10.1)
+      rspec-support (~> 3.10.0)
+    rspec-expectations (3.10.1)
       diff-lcs (>= 1.2.0, < 2.0)
-      rspec-support (~> 3.8.0)
-    rspec-mocks (3.8.1)
+      rspec-support (~> 3.10.0)
+    rspec-mocks (3.10.2)
       diff-lcs (>= 1.2.0, < 2.0)
-      rspec-support (~> 3.8.0)
-    rspec-support (3.8.2)
-    rubocop (0.74.0)
-      jaro_winkler (~> 1.5.1)
+      rspec-support (~> 3.10.0)
+    rspec-support (3.10.2)
+    rubocop (1.18.3)
       parallel (~> 1.10)
-      parser (>= 2.6)
+      parser (>= 3.0.0.0)
       rainbow (>= 2.2.2, < 4.0)
+      regexp_parser (>= 1.8, < 3.0)
+      rexml
+      rubocop-ast (>= 1.7.0, < 2.0)
       ruby-progressbar (~> 1.7)
-      unicode-display_width (>= 1.4.0, < 1.7)
-    rubocop-performance (1.4.1)
-      rubocop (>= 0.71.0)
-    rubocop-rspec (1.35.0)
-      rubocop (>= 0.60.0)
-    ruby-progressbar (1.10.1)
-    ruby_parser (3.13.1)
-      sexp_processor (~> 4.9)
-    sexp_processor (4.12.1)
-    sqlite3 (1.4.1)
-    thor (0.20.3)
-    thread_safe (0.3.6)
-    tzinfo (1.2.5)
-      thread_safe (~> 0.1)
-    unicode-display_width (1.6.0)
-    zeitwerk (2.1.9)
+      unicode-display_width (>= 1.4.0, < 3.0)
+    rubocop-ast (1.8.0)
+      parser (>= 3.0.1.1)
+    rubocop-performance (1.11.4)
+      rubocop (>= 1.7.0, < 2.0)
+      rubocop-ast (>= 0.4.0)
+    rubocop-rake (0.6.0)
+      rubocop (~> 1.0)
+    rubocop-rspec (2.4.0)
+      rubocop (~> 1.0)
+      rubocop-ast (>= 1.1.0)
+    ruby-progressbar (1.11.0)
+    ruby_parser (3.16.0)
+      sexp_processor (~> 4.15, >= 4.15.1)
+    sexp_processor (4.15.3)
+    sqlite3 (1.4.2)
+    thor (1.1.0)
+    tzinfo (2.0.4)
+      concurrent-ruby (~> 1.0)
+    unicode-display_width (2.0.0)
+    zeitwerk (2.4.2)
 
 PLATFORMS
   ruby
 
 DEPENDENCIES
   activerecord
+  activesupport
   bundler
   database_cleaner
   fasterer
@@ -124,8 +140,9 @@ DEPENDENCIES
   rspec
   rubocop
   rubocop-performance
+  rubocop-rake
   rubocop-rspec
   sqlite3
 
 BUNDLED WITH
-   2.0.1
+   2.2.24

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
@@ -80,7 +80,7 @@ Add the following attribute to all corresponding tables.
 
 ```ruby
 # omitted
-  t.binary :uxid, limit: 26, index: { unique: true }
+  t.binary :uxid, index: { unique: true }
 # omitted
 ```
 
@@ -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/nanoid.rb

@@ -14,16 +14,7 @@ module Lite
       end
 
       def encode
-        str = ''
-        len = encoding_length
-        chars = encoding_chars.split(str)
-
-        while len.positive?
-          str += chars.sample
-          len -= 1
-        end
-
-        str
+        encoding_chars.chars.sample(encoding_length).join
       end
 
     end

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

@@ -1,12 +1,11 @@
 # frozen_string_literal: true
 
-require 'active_record'
 require 'active_support'
 
 module Lite
   module Uxid
     module Record
-      module Hash
+      module Hashid
 
         extend ActiveSupport::Concern
 
@@ -16,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
 
@@ -31,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

@@ -1,6 +1,5 @@
 # frozen_string_literal: true
 
-require 'active_record'
 require 'active_support'
 
 module Lite
@@ -30,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/record/ulid.rb

@@ -1,6 +1,5 @@
 # frozen_string_literal: true
 
-require 'active_record'
 require 'active_support'
 
 module Lite

data/lib/lite/uxid/ulid.rb

@@ -6,7 +6,7 @@ module Lite
   module Uxid
     class Ulid < Lite::Uxid::Base
 
-      MASK ||= 0x1f
+      MASK = 0x1f
 
       class << self
 

data/lib/lite/uxid/version.rb

@@ -3,7 +3,7 @@
 module Lite
   module Uxid
 
-    VERSION ||= '1.0.5'
+    VERSION = '1.1.0'
 
   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'
 
@@ -25,7 +25,7 @@ Gem::Specification.new do |spec|
     )
   else
     raise 'RubyGems 2.0 or newer is required to protect against ' \
-      'public gem pushes.'
+          'public gem pushes.'
   end
 
   # Specify which files should be added to the gem when it is released.
@@ -38,6 +38,7 @@ Gem::Specification.new do |spec|
   spec.require_paths = %w[lib]
 
   spec.add_development_dependency 'activerecord'
+  spec.add_development_dependency 'activesupport'
   spec.add_development_dependency 'bundler'
   spec.add_development_dependency 'database_cleaner'
   spec.add_development_dependency 'fasterer'
@@ -46,6 +47,7 @@ Gem::Specification.new do |spec|
   spec.add_development_dependency 'rspec'
   spec.add_development_dependency 'rubocop'
   spec.add_development_dependency 'rubocop-performance'
+  spec.add_development_dependency 'rubocop-rake'
   spec.add_development_dependency 'rubocop-rspec'
   spec.add_development_dependency 'sqlite3'
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: lite-uxid
 version: !ruby/object:Gem::Version
-  version: 1.0.5
+  version: 1.1.0
 platform: ruby
 authors:
 - Juan Gomez
-autorequire: 
+autorequire:
 bindir: exe
 cert_chain: []
-date: 2019-08-24 00:00:00.000000000 Z
+date: 2021-07-20 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activerecord
@@ -24,6 +24,20 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
+- !ruby/object:Gem::Dependency
+  name: activesupport
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: bundler
   requirement: !ruby/object:Gem::Requirement
@@ -136,6 +150,20 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
+- !ruby/object:Gem::Dependency
+  name: rubocop-rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: rubocop-rspec
   requirement: !ruby/object:Gem::Requirement
@@ -164,7 +192,7 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
-description: 
+description:
 email:
 - j.gomez@drexed.com
 executables: []
@@ -192,9 +220,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
@@ -204,7 +232,7 @@ homepage: http://drexed.github.io/lite-uxid
 licenses:
 - MIT
 metadata: {}
-post_install_message: 
+post_install_message:
 rdoc_options: []
 require_paths:
 - lib
@@ -219,8 +247,8 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.0.4
-signing_key: 
+rubygems_version: 3.2.24
+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: []