lite-uxid 1.1.3 → 1.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 6f8006571de0a1f66c804d3c3e5fd9aeab60be7ef80d5e04b30d08cdee9a4426
-  data.tar.gz: 6ec85db8db509ff3fc06aafc2a3095aba7761bf6688923bbff25f7167b1daf97
+  metadata.gz: 8119c92432950cdd4fd849aafd041832a8f4ceee022c7f38009681726bb1181a
+  data.tar.gz: 121d26ff5203b65b8a4b148f9f82aad5585c4baeae6ae1008e71cc057d6fc1f8
 SHA512:
-  metadata.gz: 185195e88da652756f517b592c274b07737309f42fe6dd7a10701e3677629c224e4247f20d2e51706f933ee4153635af06f39169e1ec0eaedc6db6cc2f66c585
-  data.tar.gz: '0686eed4e263e0719107af86fb9aa3c55acb82ddcd30694a1fbcac6d5d5b383e2b365b1f17c29be60deb76717b8e6734d31a052c0fa75e799e53c8a69b5026bf'
+  metadata.gz: 4ed1ddf45549eef5ee6b6950b000272b8d62dfa8ac5b403fa5e6ffc70dfabd9a03978a7e96259184b3222b42e3b1dc240e44984ee89086cfe3f396e7fcfa3d8c
+  data.tar.gz: c63df74d2affbda2f3fefc86a0b5d44364dfef7417b22c6c56f7d411808d3935d1b26f06de92d8699f3ababaf8c84a9e3a0149123a3ed66d52e92bf59f064192

data/.rubocop.yml

@@ -3,7 +3,6 @@ require:
   - rubocop-rake
   - rubocop-rspec
 AllCops:
-  TargetRubyVersion: 3.0
   NewCops: enable
   DisplayCopNames: true
   DisplayStyleGuide: true
@@ -19,7 +18,7 @@ Layout/EmptyLinesAroundClassBody:
 Layout/EmptyLinesAroundModuleBody:
   EnforcedStyle: empty_lines_except_namespace
 Layout/LineLength:
-  Max: 100
+  Enabled: false
 Layout/SpaceAroundMethodCallOperator:
   Enabled: true
 Lint/RaiseException:
@@ -30,6 +29,8 @@ Metrics/BlockLength:
   Exclude:
     - 'spec/**/**/*'
     - '*.gemspec'
+Metrics/MethodLength:
+  Enabled: false
 RSpec/MultipleExpectations:
   Enabled: false
 Style/ArgumentsForwarding:
@@ -38,5 +39,9 @@ Style/Documentation:
   Enabled: false
 Style/ExpandPathArguments:
   Enabled: false
+Style/HashSyntax:
+  EnforcedShorthandSyntax: never
 Style/SlicingWithRange:
   Enabled: false
+Style/StringLiterals:
+  EnforcedStyle: double_quotes

data/CHANGELOG.md

@@ -6,6 +6,14 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 
 ## [Unreleased]
 
+## [1.2.0] - 2022-11-19
+### Added
+- Added individual character and length options
+### Changed
+- Improved docs
+- Improved internal setup
+- Improved rubocop setup
+
 ## [1.1.3] - 2021-07-30
 ### Changed
 - Skip uxid callback on records where its being assigned

data/Gemfile

@@ -1,6 +1,6 @@
 # frozen_string_literal: true
 
-source 'https://rubygems.org'
+source "https://rubygems.org"
 
 # Specify your gem's dependencies in lite-uxid.gemspec
 gemspec

data/Gemfile.lock

@@ -1,39 +1,38 @@
 PATH
   remote: .
   specs:
-    lite-uxid (1.1.3)
+    lite-uxid (1.2.0)
 
 GEM
   remote: https://rubygems.org/
   specs:
-    actionpack (6.1.4)
-      actionview (= 6.1.4)
-      activesupport (= 6.1.4)
-      rack (~> 2.0, >= 2.0.9)
+    actionpack (7.0.4)
+      actionview (= 7.0.4)
+      activesupport (= 7.0.4)
+      rack (~> 2.0, >= 2.2.0)
       rack-test (>= 0.6.3)
       rails-dom-testing (~> 2.0)
       rails-html-sanitizer (~> 1.0, >= 1.2.0)
-    actionview (6.1.4)
-      activesupport (= 6.1.4)
+    actionview (7.0.4)
+      activesupport (= 7.0.4)
       builder (~> 3.1)
       erubi (~> 1.4)
       rails-dom-testing (~> 2.0)
       rails-html-sanitizer (~> 1.1, >= 1.2.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)
+    activemodel (7.0.4)
+      activesupport (= 7.0.4)
+    activerecord (7.0.4)
+      activemodel (= 7.0.4)
+      activesupport (= 7.0.4)
+    activesupport (7.0.4)
       concurrent-ruby (~> 1.0, >= 1.0.2)
       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.9)
+    concurrent-ruby (1.1.10)
     crass (1.0.6)
     database_cleaner (2.0.1)
       database_cleaner-active_record (~> 2.0.0)
@@ -41,89 +40,92 @@ GEM
       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)
+    diff-lcs (1.5.0)
+    erubi (1.11.0)
+    fasterer (0.10.0)
       colorize (~> 0.7)
-      ruby_parser (>= 3.14.1)
+      ruby_parser (>= 3.19.1)
     generator_spec (0.9.4)
       activesupport (>= 3.0.0)
       railties (>= 3.0.0)
-    i18n (1.8.10)
+    i18n (1.12.0)
       concurrent-ruby (~> 1.0)
-    loofah (2.10.0)
+    json (2.6.2)
+    loofah (2.19.0)
       crass (~> 1.0.2)
       nokogiri (>= 1.5.9)
     method_source (1.0.0)
-    mini_portile2 (2.5.3)
-    minitest (5.14.4)
-    nokogiri (1.11.7)
-      mini_portile2 (~> 2.5.0)
+    mini_portile2 (2.8.0)
+    minitest (5.16.3)
+    nokogiri (1.13.9)
+      mini_portile2 (~> 2.8.0)
       racc (~> 1.4)
-    parallel (1.20.1)
-    parser (3.0.2.0)
+    parallel (1.22.1)
+    parser (3.1.2.1)
       ast (~> 2.4.1)
-    racc (1.5.2)
-    rack (2.2.3)
-    rack-test (1.1.0)
-      rack (>= 1.0, < 3)
+    racc (1.6.0)
+    rack (2.2.4)
+    rack-test (2.0.2)
+      rack (>= 1.3)
     rails-dom-testing (2.0.3)
       activesupport (>= 4.2.0)
       nokogiri (>= 1.6)
-    rails-html-sanitizer (1.3.0)
+    rails-html-sanitizer (1.4.3)
       loofah (~> 2.3)
-    railties (6.1.4)
-      actionpack (= 6.1.4)
-      activesupport (= 6.1.4)
+    railties (7.0.4)
+      actionpack (= 7.0.4)
+      activesupport (= 7.0.4)
       method_source
-      rake (>= 0.13)
+      rake (>= 12.2)
       thor (~> 1.0)
-    rainbow (3.0.0)
+      zeitwerk (~> 2.5)
+    rainbow (3.1.1)
     rake (13.0.6)
-    regexp_parser (2.1.1)
+    regexp_parser (2.6.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)
+    rspec (3.12.0)
+      rspec-core (~> 3.12.0)
+      rspec-expectations (~> 3.12.0)
+      rspec-mocks (~> 3.12.0)
+    rspec-core (3.12.0)
+      rspec-support (~> 3.12.0)
+    rspec-expectations (3.12.0)
       diff-lcs (>= 1.2.0, < 2.0)
-      rspec-support (~> 3.10.0)
-    rspec-mocks (3.10.2)
+      rspec-support (~> 3.12.0)
+    rspec-mocks (3.12.0)
       diff-lcs (>= 1.2.0, < 2.0)
-      rspec-support (~> 3.10.0)
-    rspec-support (3.10.2)
-    rubocop (1.18.4)
+      rspec-support (~> 3.12.0)
+    rspec-support (3.12.0)
+    rubocop (1.39.0)
+      json (~> 2.3)
       parallel (~> 1.10)
-      parser (>= 3.0.0.0)
+      parser (>= 3.1.2.1)
       rainbow (>= 2.2.2, < 4.0)
       regexp_parser (>= 1.8, < 3.0)
-      rexml
-      rubocop-ast (>= 1.8.0, < 2.0)
+      rexml (>= 3.2.5, < 4.0)
+      rubocop-ast (>= 1.23.0, < 2.0)
       ruby-progressbar (~> 1.7)
       unicode-display_width (>= 1.4.0, < 3.0)
-    rubocop-ast (1.8.0)
-      parser (>= 3.0.1.1)
-    rubocop-performance (1.11.4)
+    rubocop-ast (1.23.0)
+      parser (>= 3.1.1.0)
+    rubocop-performance (1.15.1)
       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)
+    rubocop-rspec (2.15.0)
+      rubocop (~> 1.33)
     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)
+    ruby_parser (3.19.1)
+      sexp_processor (~> 4.16)
+    sexp_processor (4.16.1)
+    sqlite3 (1.5.4)
+      mini_portile2 (~> 2.8.0)
+    thor (1.2.1)
+    tzinfo (2.0.5)
       concurrent-ruby (~> 1.0)
-    unicode-display_width (2.0.0)
-    zeitwerk (2.4.2)
+    unicode-display_width (2.3.0)
+    zeitwerk (2.6.6)
 
 PLATFORMS
   ruby
@@ -145,4 +147,4 @@ DEPENDENCIES
   sqlite3
 
 BUNDLED WITH
-   2.2.24
+   2.3.26

data/README.md

@@ -3,11 +3,9 @@
 [![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 different patterns.
+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.
-
 ## Installation
 
 Add this line to your application's Gemfile:
@@ -30,20 +28,22 @@ Or install it yourself as:
 * [Hashid](#hashid)
 * [NanoID](#nanoid)
 * [ULID](#ulid)
+* [Options](#options)
 * [ActiveRecord](#active_record)
 * [Benchmarks](#benchmarks)
-* [Port](#port)
 
 ## Configuration
 
-`rails g lite:uxid:install` will generate the following file:
-`../config/initalizers/lite_uxid.rb`
+`rails g lite:uxid:install` will generate the following file in your application root:
+`config/initalizers/lite_uxid.rb`
 
 ```ruby
 Lite::Uxid.configure do |config|
   config.encoding_chars = '0123456789abcdefghijklmnopqrstuvwxyzABCDEFGHIJKLMNOPQRSTUVWXYZ'
-  config.encoding_length = 26
   config.encoding_salt = 1_369_136
+  config.hashid_length = 12
+  config.nanoid_length = 21
+  config.ulid_length = 26
 end
 ```
 
@@ -58,7 +58,7 @@ Lite::Uxid::Hashid.decode('q5D8inm0') #=> 10
 
 ## NanoID
 
-NanoID are not reversible and are the second fastest ID generator but while unlikely can produce collisions.
+NanoID are irreversible and are the second fastest ID generator but while unlikely can produce collisions.
 
 ```ruby
 Lite::Uxid::Nanoid.encode #=> '0bmHjB5Gx8FTBqJekX6dS6XIXf'
@@ -66,38 +66,51 @@ Lite::Uxid::Nanoid.encode #=> '0bmHjB5Gx8FTBqJekX6dS6XIXf'
 
 ## ULID
 
-ULID are not reversible but provide information outside of just randomness.
+ULID are irreversible but provide information outside of just randomness.
 
 ```ruby
 Lite::Uxid::Ulid.encode #=> '1mqfg9qa96s8s5f02o1ucf8lcc'
 ```
 
-#### ActiveRecord
+## Options
+
+Local options can be passed to override global options.
+
+```ruby
+Lite::Uxid::Ulid.encode(chars: 'abc123', length: 12) #=> 'a3b12c12c3ca'
+```
+
+## ActiveRecord
 
 **Table**
 
 Add the following attribute to all corresponding tables.
 
 ```ruby
-# omitted
-  t.binary :uxid, index: { unique: true }
-# omitted
+t.string :uxid, index: { unique: true }
 ```
 
 **Setup**
 
-All `nanoid` and `uxid` attributes will be automatically generated and applied when the record is created.
+`uxid` attribute will be automatically generated and applied when the record is created.
 
+#### HashID
 ```ruby
 class User < ActiveRecord::Base
   include Lite::Uxid::Record::Hashid
+end
+```
 
-  # - or -
-
+#### NanoID
+```ruby
+class User < ActiveRecord::Base
   include Lite::Uxid::Record::Nanoid
+end
+```
 
-  # - or -
-
+#### ULID
+```ruby
+class User < ActiveRecord::Base
   include Lite::Uxid::Record::Ulid
 end
 ```
@@ -106,13 +119,17 @@ end
 
 Using one of the mixins above provides a handy method to find records by uxid.
 
+#### HashID methods
 ```ruby
-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.uxid_to_id             #=> Decodes the records uxid to id (only for Hashid based Id's)
+user.id_to_uxid #=> Encodes the records id to uxid
+user.uxid_to_id #=> Decodes the records uxid to id
+```
+
+#### Finder methods
+```ruby
+User.find_by_uxid('x123')  #=> Find record by uxid
+User.find_by_uxid!('x123') #=> Raises an ActiveRecord::RecordNotFound error if not found
 ```
 
 ## Benchmarks
@@ -121,12 +138,6 @@ 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).
 
-## Port
-
-`Lite::Uxid` is a compatible port of [ActiveUxid](https://github.com/drexed/active_uxid).
-
-Switching is as easy as renaming `ActiveUxid` to `Lite::Uxid`.
-
 ## 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.
@@ -135,7 +146,7 @@ To install this gem onto your local machine, run `bundle exec rake install`. To
 
 ## Contributing
 
-Bug reports and pull requests are welcome on GitHub at https://github.com/[USERNAME]/lite-uxid. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [Contributor Covenant](http://contributor-covenant.org) code of conduct.
+Bug reports and pull requests are welcome on GitHub at https://github.com/drexed/lite-uxid. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [Contributor Covenant](http://contributor-covenant.org) code of conduct.
 
 ## License
 
@@ -143,4 +154,4 @@ The gem is available as open source under the terms of the [MIT License](https:/
 
 ## Code of Conduct
 
-Everyone interacting in the Lite::Uxid project’s codebases, issue trackers, chat rooms and mailing lists is expected to follow the [code of conduct](https://github.com/[USERNAME]/lite-uxid/blob/master/CODE_OF_CONDUCT.md).
+Everyone interacting in the Lite::Uxid project’s codebases, issue trackers, chat rooms and mailing lists is expected to follow the [code of conduct](https://github.com/drexed/lite-uxid/blob/master/CODE_OF_CONDUCT.md).

data/Rakefile

@@ -1,7 +1,7 @@
 # frozen_string_literal: true
 
-require 'bundler/gem_tasks'
-require 'rspec/core/rake_task'
+require "bundler/gem_tasks"
+require "rspec/core/rake_task"
 
 RSpec::Core::RakeTask.new(:spec)
 

data/benchmarks/compare.rb

@@ -2,19 +2,19 @@
 
 %w[lib benchmarks].each { |name| $LOAD_PATH.unshift(name) }
 
-require 'benchmark/ips'
-require 'lite/uxid'
+require "benchmark/ips"
+require "lite/uxid"
 
 Benchmark.ips do |x|
-  x.report('Hashid') do
+  x.report("Hashid") do
     Lite::Uxid::Hashid.encode(rand(1..1_000_000))
   end
 
-  x.report('NanoID') do
+  x.report("NanoID") do
     Lite::Uxid::Nanoid.encode
   end
 
-  x.report('ULID') do
+  x.report("ULID") do
     Lite::Uxid::Ulid.encode
   end
 

data/bin/console

@@ -1,8 +1,8 @@
 #!/usr/bin/env ruby
 # frozen_string_literal: true
 
-require 'bundler/setup'
-require 'lite/uxid'
+require "bundler/setup"
+require "lite/uxid"
 
 # You can add fixtures and/or initialization code here to make experimenting
 # with your gem easier. You can also use a different console, if you like.
@@ -11,5 +11,5 @@ require 'lite/uxid'
 # require "pry"
 # Pry.start
 
-require 'irb'
+require "irb"
 IRB.start(__FILE__)

data/lib/generators/lite/uxid/install_generator.rb

@@ -4,10 +4,10 @@ module Lite
   module Uxid
     class InstallGenerator < Rails::Generators::Base
 
-      source_root File.expand_path('../templates', __FILE__)
+      source_root File.expand_path("../templates", __FILE__)
 
       def copy_initializer_file
-        copy_file('install.rb', 'config/initializers/lite_uxid.rb')
+        copy_file("install.rb", "config/initializers/lite_uxid.rb")
       end
 
     end

data/lib/generators/lite/uxid/templates/install.rb

@@ -1,7 +1,9 @@
 # frozen_string_literal: true
 
 Lite::Uxid.configure do |config|
-  config.encoding_chars = '0123456789abcdefghijklmnopqrstuvwxyzABCDEFGHIJKLMNOPQRSTUVWXYZ'
-  config.encoding_length = 26
+  config.encoding_chars = "0123456789abcdefghijklmnopqrstuvwxyzABCDEFGHIJKLMNOPQRSTUVWXYZ"
   config.encoding_salt = 1_369_136
+  config.hashid_length = 12
+  config.nanoid_length = 21
+  config.ulid_length = 26
 end

data/lib/lite/uxid/configuration.rb

@@ -5,12 +5,14 @@ module Lite
 
     class Configuration
 
-      attr_accessor :encoding_chars, :encoding_length, :encoding_salt
+      attr_accessor :encoding_chars, :encoding_salt, :hashid_length, :nanoid_length, :ulid_length
 
       def initialize
-        @encoding_chars = '0123456789abcdefghijklmnopqrstuvwxyzABCDEFGHIJKLMNOPQRSTUVWXYZ'
-        @encoding_length = 26
+        @encoding_chars = "0123456789abcdefghijklmnopqrstuvwxyzABCDEFGHIJKLMNOPQRSTUVWXYZ"
         @encoding_salt = 1_369_136
+        @hashid_length = 12
+        @nanoid_length = 21
+        @ulid_length = 26
       end
 
     end

data/lib/lite/uxid/hashid.rb

@@ -2,60 +2,41 @@
 
 module Lite
   module Uxid
-    class Hashid < Lite::Uxid::Base
-
-      def initialize(id)
-        @id = id
-        super()
-      end
-
-      class << self
-
-        def encode(id)
-          klass = new(id)
-          klass.encode
-        end
-
-        def decode(id)
-          klass = new(id)
-          klass.decode
-        end
-
-      end
+    class Hashid < Reversible
 
       def encode
-        encode_chars((@id + encoding_salt) << encoding_length)
+        encode_chars((id + coder_salt) << coder_length)
       end
 
       def decode
-        (decode_chars(@id) >> encoding_length) - encoding_salt
+        (decode_chars(id) >> coder_length) - coder_salt
       end
 
       private
 
-      def encode_chars(id)
-        return '0' if id.zero?
-        return nil if id.negative?
+      def encode_chars(decoded_id)
+        return "0" if decoded_id.zero?
+        return nil if decoded_id.negative?
 
-        str = ''
+        str = ""
 
-        while id.positive?
-          str = "#{encoding_chars[id % encoding_base]}#{str}"
-          id /= encoding_base
+        while decoded_id.positive?
+          str = "#{coder_chars[decoded_id % coder_base]}#{str}"
+          decoded_id /= coder_base
         end
 
         str
       end
 
-      def decode_chars(id)
+      def decode_chars(encoded_id)
         pos = 0
         num = 0
-        len = id.length
+        len = encoded_id.length
         max = len - 1
 
         while pos < len
-          pow = encoding_base**(max - pos)
-          num += encoding_chars.index(id[pos]) * pow
+          pow = coder_base**(max - pos)
+          num += coder_chars.index(encoded_id[pos]) * pow
           pos += 1
         end
 

data/lib/lite/uxid/irreversible.rb

@@ -0,0 +1,65 @@
+# frozen_string_literal: true
+
+module Lite
+  module Uxid
+    class Irreversible
+
+      attr_reader :opts
+
+      def initialize(opts = {})
+        @opts = opts
+      end
+
+      class << self
+
+        def encode(opts = {})
+          klass = new(opts)
+          klass.encode
+        end
+
+        def decode(opts = {})
+          klass = new(opts)
+          klass.decode
+        end
+
+      end
+
+      def encode
+        raise NotImplementedError, "override method in #{coder_class}"
+      end
+
+      def decode
+        raise NotImplementedError, "coder does not support decoding"
+      end
+
+      private
+
+      def coder_base
+        @coder_base ||= coder_chars.length
+      end
+
+      def coder_chars
+        @coder_chars ||=
+          opts.delete(:chars) ||
+          Lite::Uxid.configuration.encoding_chars
+      end
+
+      def coder_class
+        @coder_class ||= self.class.name.split("::").last
+      end
+
+      def coder_length
+        @coder_length ||=
+          opts.delete(:length) ||
+          Lite::Uxid.configuration.send("#{coder_class.downcase}_length")
+      end
+
+      def coder_salt
+        @coder_salt ||=
+          opts.delete(:salt) ||
+          Lite::Uxid.configuration.encoding_salt
+      end
+
+    end
+  end
+end

data/lib/lite/uxid/nanoid.rb

@@ -2,19 +2,10 @@
 
 module Lite
   module Uxid
-    class Nanoid < Lite::Uxid::Base
-
-      class << self
-
-        def encode
-          klass = new
-          klass.encode
-        end
-
-      end
+    class Nanoid < Irreversible
 
       def encode
-        encoding_chars.chars.sample(encoding_length).join
+        coder_chars.chars.sample(coder_length).join
       end
 
     end

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

@@ -1,6 +1,6 @@
 # frozen_string_literal: true
 
-require 'active_support' unless defined?(ActiveSupport)
+require "active_support" unless defined?(ActiveSupport)
 
 module Lite
   module Uxid
@@ -27,6 +27,12 @@ module Lite
           end
         end
 
+        def id_to_uxid
+          return unless respond_to?(:uxid)
+
+          Lite::Uxid::Hashid.encode(id)
+        end
+
         def uxid_to_id
           return unless respond_to?(:uxid)
 
@@ -36,8 +42,7 @@ module Lite
         private
 
         def callback_generate_uxid!
-          hash = Lite::Uxid::Hashid.encode(id)
-          update_column(:uxid, hash)
+          update_column(:uxid, id_to_uxid)
         end
 
       end

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

@@ -1,6 +1,6 @@
 # frozen_string_literal: true
 
-require 'active_support' unless defined?(ActiveSupport)
+require "active_support" unless defined?(ActiveSupport)
 
 module Lite
   module Uxid
@@ -13,19 +13,6 @@ module Lite
           before_create :callback_generate_uxid!, if: proc { respond_to?(:uxid) && !uxid? }
         end
 
-        class_methods do
-          def find_by_uxid(uxid)
-            find_by(uxid: uxid)
-          end
-
-          def find_by_uxid!(uxid)
-            record = find_by_uxid(uxid)
-            return record unless record.nil?
-
-            raise ActiveRecord::RecordNotFound
-          end
-        end
-
         private
 
         def callback_generate_uxid!

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

@@ -1,6 +1,6 @@
 # frozen_string_literal: true
 
-require 'active_support' unless defined?(ActiveSupport)
+require "active_support" unless defined?(ActiveSupport)
 
 module Lite
   module Uxid
@@ -13,19 +13,6 @@ module Lite
           before_create :callback_generate_uxid!, if: proc { respond_to?(:uxid) && !uxid? }
         end
 
-        class_methods do
-          def find_by_uxid(uxid)
-            find_by(uxid: uxid)
-          end
-
-          def find_by_uxid!(uxid)
-            record = find_by_uxid(uxid)
-            return record unless record.nil?
-
-            raise ActiveRecord::RecordNotFound
-          end
-        end
-
         private
 
         def callback_generate_uxid!

data/lib/lite/uxid/reversible.rb

@@ -0,0 +1,34 @@
+# frozen_string_literal: true
+
+module Lite
+  module Uxid
+    class Reversible < Irreversible
+
+      attr_reader :id
+
+      def initialize(id, opts = {})
+        @id = id
+        super(opts)
+      end
+
+      class << self
+
+        def encode(id, opts = {})
+          klass = new(id, opts)
+          klass.encode
+        end
+
+        def decode(id, opts = {})
+          klass = new(id, opts)
+          klass.decode
+        end
+
+      end
+
+      def decode
+        raise NotImplementedError, "override method in #{coder_class}"
+      end
+
+    end
+  end
+end

data/lib/lite/uxid/ulid.rb

@@ -1,29 +1,20 @@
 # frozen_string_literal: true
 
-require 'securerandom' unless defined?(SecureRandom)
+require "securerandom" unless defined?(SecureRandom)
 
 module Lite
   module Uxid
-    class Ulid < Lite::Uxid::Base
+    class Ulid < Irreversible
 
       MASK = 0x1f
 
-      class << self
-
-        def encode
-          klass = new
-          klass.encode
-        end
-
-      end
-
       def encode
         oct = octect
-        ele = '0' * encoding_length
-        pos = encoding_length - 1
+        ele = "0" * coder_length
+        pos = coder_length - 1
 
         while oct.positive?
-          ele[pos] = encoding_chars[oct & MASK]
+          ele[pos] = coder_chars[oct & MASK]
           oct >>= 5
           pos -= 1
         end
@@ -38,7 +29,7 @@ module Lite
       end
 
       def octect
-        (hi, lo) = bytes.unpack('Q>Q>')
+        (hi, lo) = bytes.unpack("Q>Q>")
         (hi << 64) | lo
       end
 
@@ -48,7 +39,7 @@ module Lite
       end
 
       def unixtime_48bit
-        [unixtime_ms].pack('Q>')[2..-1]
+        [unixtime_ms].pack("Q>")[2..-1]
       end
 
     end

data/lib/lite/uxid/version.rb

@@ -3,7 +3,7 @@
 module Lite
   module Uxid
 
-    VERSION = '1.1.3'
+    VERSION = "1.2.0"
 
   end
 end

data/lib/lite/uxid.rb

@@ -1,13 +1,14 @@
 # frozen_string_literal: true
 
-require 'generators/lite/uxid/install_generator' if defined?(Rails::Generators)
+require "generators/lite/uxid/install_generator" if defined?(Rails::Generators)
 
-require 'lite/uxid/version'
-require 'lite/uxid/configuration'
-require 'lite/uxid/base'
-require 'lite/uxid/record/hashid'
-require 'lite/uxid/record/nanoid'
-require 'lite/uxid/record/ulid'
-require 'lite/uxid/hashid'
-require 'lite/uxid/nanoid'
-require 'lite/uxid/ulid'
+require "lite/uxid/version"
+require "lite/uxid/configuration"
+require "lite/uxid/irreversible"
+require "lite/uxid/reversible"
+require "lite/uxid/record/hashid"
+require "lite/uxid/record/nanoid"
+require "lite/uxid/record/ulid"
+require "lite/uxid/hashid"
+require "lite/uxid/nanoid"
+require "lite/uxid/ulid"

data/lite-uxid.gemspec

@@ -1,53 +1,47 @@
 # frozen_string_literal: true
 
-lib = File.expand_path('../lib', __FILE__)
+lib = File.expand_path("../lib", __FILE__)
 $LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
-require 'lite/uxid/version'
+require "lite/uxid/version"
 
 Gem::Specification.new do |spec|
-  spec.name = 'lite-uxid'
+  spec.name = "lite-uxid"
   spec.version = Lite::Uxid::VERSION
-  spec.authors = ['Juan Gomez']
+  spec.authors = ["Juan Gomez"]
   spec.email = %w[j.gomez@drexed.com]
 
   spec.summary = "Generate or obfuscate Id's using different patterns"
-  spec.homepage = 'http://drexed.github.io/lite-uxid'
-  spec.license = 'MIT'
+  spec.homepage = "http://drexed.github.io/lite-uxid"
+  spec.license = "MIT"
 
   # Prevent pushing this gem to RubyGems.org. To allow pushes either set the 'allowed_push_host'
   # to allow pushing to a single host or delete this section to allow pushing to any host.
-  if spec.respond_to?(:metadata)
-    spec.metadata.merge(
-      'allowed_push_host' => 'https://rubygems.org',
-      'changelog_uri' => 'https://github.com/drexed/lite-uxid/blob/master/CHANGELOG.md',
-      'homepage_uri' => spec.homepage,
-      'source_code_uri' => 'https://github.com/drexed/lite-uxid'
-    )
-  else
-    raise 'RubyGems 2.0 or newer is required to protect against ' \
-          'public gem pushes.'
-  end
+  spec.metadata["allowed_push_host"] = "https://rubygems.org"
+  spec.metadata["changelog_uri"] = "https://github.com/drexed/lite-uxid/blob/master/CHANGELOG.md"
+  spec.metadata["homepage_uri"] = spec.homepage
+  spec.metadata["rubygems_mfa_required"] = "true"
+  spec.metadata["source_code_uri"] = "https://github.com/drexed/lite-uxid"
 
   # Specify which files should be added to the gem when it is released.
   # The `git ls-files -z` loads the files in the RubyGem that have been added into git.
-  spec.files = Dir.chdir(File.expand_path('..', __FILE__)) do
+  spec.files = Dir.chdir(File.expand_path("..", __FILE__)) do
     `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
   end
-  spec.bindir = 'exe'
+  spec.bindir = "exe"
   spec.executables = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
   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'
-  spec.add_development_dependency 'generator_spec'
-  spec.add_development_dependency 'rake'
-  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'
+  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"
+  spec.add_development_dependency "generator_spec"
+  spec.add_development_dependency "rake"
+  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.1.3
+  version: 1.2.0
 platform: ruby
 authors:
 - Juan Gomez
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2021-07-31 00:00:00.000000000 Z
+date: 2022-11-19 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activerecord
@@ -203,7 +203,6 @@ files:
 - ".gitignore"
 - ".rspec"
 - ".rubocop.yml"
-- ".travis.yml"
 - CHANGELOG.md
 - CODE_OF_CONDUCT.md
 - Gemfile
@@ -218,20 +217,26 @@ files:
 - lib/generators/lite/uxid/install_generator.rb
 - lib/generators/lite/uxid/templates/install.rb
 - lib/lite/uxid.rb
-- lib/lite/uxid/base.rb
 - lib/lite/uxid/configuration.rb
 - lib/lite/uxid/hashid.rb
+- lib/lite/uxid/irreversible.rb
 - lib/lite/uxid/nanoid.rb
 - lib/lite/uxid/record/hashid.rb
 - lib/lite/uxid/record/nanoid.rb
 - lib/lite/uxid/record/ulid.rb
+- lib/lite/uxid/reversible.rb
 - lib/lite/uxid/ulid.rb
 - lib/lite/uxid/version.rb
 - lite-uxid.gemspec
 homepage: http://drexed.github.io/lite-uxid
 licenses:
 - MIT
-metadata: {}
+metadata:
+  allowed_push_host: https://rubygems.org
+  changelog_uri: https://github.com/drexed/lite-uxid/blob/master/CHANGELOG.md
+  homepage_uri: http://drexed.github.io/lite-uxid
+  rubygems_mfa_required: 'true'
+  source_code_uri: https://github.com/drexed/lite-uxid
 post_install_message:
 rdoc_options: []
 require_paths:
@@ -247,7 +252,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.2.24
+rubygems_version: 3.3.26
 signing_key:
 specification_version: 4
 summary: Generate or obfuscate Id's using different patterns

data/.travis.yml

@@ -1,25 +0,0 @@
-sudo: false
-language: ruby
-cache: bundler
-rvm:
-- 2.5
-- 2.6
-- 2.7
-- ruby-head
-matrix:
-  fast_finish: true
-  allow_failures:
-  - rvm: ruby-head
-before_install:
-- gem update --system
-- gem install bundler
-install:
-- bundle install --jobs=3 --retry=3
-script:
-- bundle exec rspec
-- bundle exec rubocop
-- bundle exec fasterer
-notifications:
-  email: false
-  slack:
-    secure: tGjUBos/5ypoNmEc2L05h0qTKpizE/g/Mx5McqJo390y3NniU9Quc7ci8JqTzPJq3kvZugMKo33SMvOFBN6drwcNN6I3BQyfGv77ZIt9coJOnz3ASr55fLtnO5gPcDxYdRAV5sOXBtaudY39mXRby/YEJx7PX6AE2NHpdhqwco3gsTWp77VxQ0cHxyPUvW0v+vEBaozzsduUKh1pH6+OckzH9/7lBQSGdljRAlhOM4KBnYD0bttw9bZk1QTyoGnmjAReTpbIPaIPFG28d9uVWD2WgQvyMGjpjdEzM8vTa7htNyfT71Hu7gToUDU9vknHQINuDPsBfpMZqKDtEUbGQwgfRAsdEzoBX/QRh9ArWDQ+ycmX+UuDT7+E5lt73Y6CX59EECMYQKM9LVNd08utDkhfYPH5r0MUs5kNblFi4NIUtgbHKFw2b4lmzNYuhdSUwVoUgdpW8NHtg4I4LzdTgFMI5or8r8Pbn2djGiGYq9kMC8eu5BksiAlZq8w0UcMlGz+uRtbpkf9IJNB+VuaeXohqIT8NKGfcC1j7kbbxrvQEbOW36TA09n34IGNF7iS/FWL4Rb2OhrsE16VPZ397GbSDXZsH7JzB1E3BW2lhONrw3U332RW+QSBxCdQZ9ig+xsoxfOfJVoqho6jHoNxJxDYvo7WWTY2Ashb7yu62RNo=

data/lib/lite/uxid/base.rb

@@ -1,22 +0,0 @@
-# frozen_string_literal: true
-
-module Lite
-  module Uxid
-    class Base
-
-      def initialize
-        @config = Lite::Uxid.configuration
-      end
-
-      def encoding_base
-        encoding_chars.length
-      end
-
-      Lite::Uxid.configuration.instance_variables.each do |setting|
-        setting = setting.to_s.tr(':@', '')
-        define_method(setting) { @config.send(setting) }
-      end
-
-    end
-  end
-end