lite-uxid 2.0.0 → 2.0.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 767645737040b210cc058a0a781f89751f447e991aa03c527f5d12b039d1980a
-  data.tar.gz: 1c777db2675144f26b24ed2ec75d175c83f55d5ede9e83ab5d0d75ca2b76e692
+  metadata.gz: 9078e4e13dc6877ed30a6a0028ad4327ff95d3056a5303f789137272e2bb0f12
+  data.tar.gz: c25e8acbb22ad4e4381bf9b07018eaf12daaf8e1d0123cee24f5fa9c8af8e87a
 SHA512:
-  metadata.gz: 313da972f69d52e8951d552c3269500767e7fb80255de25c44d1bbe0d6497aaa3b0c398736b2e451d393ad0642446e298ebbad36a225528f010a96a8684f221e
-  data.tar.gz: 61ce05436d5e2793164007f1b28edd28ea138c9efbf02f0a6ac6ef021708d3171b61c77e2811dfe9c65ef764b46d55713e6121eefd57d87a22cb10e80a9c0eef
+  metadata.gz: bd5d7ef2cd4c425fb798dea874a7f395e20e5514ca07fb807d673feb75187e8a236236bd7f833084983a820d71a05a7a27c80d72138a13f888fb5b088a4c869f
+  data.tar.gz: 24462c53958076c1435e1012f3608002d23fdb01b3d59d00ac9d7d78c81f8f1d91b3a80fcac78d9a6a9ce358d9db728af6dd6df3d6815037a1c7dfa25515ba3f

data/CHANGELOG.md

@@ -6,6 +6,12 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 
 ## [Unreleased]
 
+## [2.0.1] - 2024-09-23
+### Changed
+- Renamed `Scatterid` to `Obfuscateid`
+### Removed
+- Removed prefix option from obfuscateid
+
 ## [2.0.0] - 2024-09-23
 ### Added
 - Scatterid reversible lib

data/Gemfile.lock

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

data/README.md

@@ -27,9 +27,9 @@ Or install it yourself as:
 
 * [Configuration](#configuration)
 * [Usage](#usage)
-* [Hashid](#hashid)
+* [HashID](#hashid)
 * [NanoID](#nanoid)
-* [Scatterid](#scatterid)
+* [ObfuscateID](#obfuscateid)
 * [ULID](#ulid)
 * [UUID](#uuid)
 * [Options](#options)
@@ -88,13 +88,13 @@ Lite::Uxid::Reversible::Hashid.decode('1zWr1m0') #=> 10
 Lite::Uxid::Irreversible::Nanoid.encode #=> 'sMuNUa3Cegn6r5GRQ4Ij2'
 ```
 
-## ScatterID
+## ObfuscateID
 
 [More information](https://github.com/namick/scatter_swap)
 
 ```ruby
-Lite::Uxid::Reversible::Scatterid.encode(10)           #=> '2056964183'
-Lite::Uxid::Reversible::Scatterid.decode('2056964183') #=> 10
+Lite::Uxid::Reversible::Obfuscateid.encode(10)         #=> '2056964183'
+Lite::Uxid::Reversible::Obfuscateid.decode(2056964183) #=> 10
 ```
 
 ## ULID
@@ -128,7 +128,7 @@ Passable options are:
   charset: 'string',  # Available for: hashid, nanoid, ulid
   salt:    'string',  # Available for: hashid
   size:    'integer', # Available for: hashid, nanoid, ulid
-  spin:    'integer', # Available for: scatterid
+  spin:    'integer', # Available for: obfuscateid
   version: 'integer', # Available for: uuid
   prefix:  'string'   # Available for: hashid, nanoid
 }
@@ -159,34 +159,11 @@ t.uuid :uxid, null: false, index: { unique: true }
 #### HashID
 ```ruby
 class User < ActiveRecord::Base
+  # Pick one:
   include Lite::Uxid::Record::Hashid
-end
-```
-
-#### NanoID
-```ruby
-class User < ActiveRecord::Base
   include Lite::Uxid::Record::Nanoid
-end
-```
-
-#### ScatterID
-```ruby
-class User < ActiveRecord::Base
-  include Lite::Uxid::Record::Scatterid
-end
-```
-
-#### ULID
-```ruby
-class User < ActiveRecord::Base
+  include Lite::Uxid::Record::Obfuscateid
   include Lite::Uxid::Record::Ulid
-end
-```
-
-#### UUID
-```ruby
-class User < ActiveRecord::Base
   include Lite::Uxid::Record::Uuid
 end
 ```
@@ -198,16 +175,16 @@ class User < ActiveRecord::Base
   include Lite::Uxid::Record::Hashid
 
   def uxid_prefix
-    "sub_"
+    "usr_"
   end
 end
 ```
 
 **Usage**
 
-Using one of the mixins above provides a handy method to find records by uxid.
+Using the `hashid` and `nanoid` above provide handy methods to find records by uxid.
 
-#### HashID methods
+#### Hashing methods
 ```ruby
 user = User.new
 user.id_to_uxid #=> Encodes the records id to uxid
@@ -222,15 +199,10 @@ User.find_by_uxid!('x123') #=> Raises an ActiveRecord::RecordNotFound error if n
 
 ## Benchmarks
 
-The classes ranked from fastest to slowest are `UUID`, `Hashid`, `Nanoid`, and `Ulid`.
+The classes ranked from fastest to slowest are `UUID`, `HashID`, `NanoID`, `ULID`, and `ObfuscateID`.
 
 View how each compares by running the [benchmarks](https://github.com/drexed/lite-uxid/tree/master/benchmarks).
 
-#### Alternatives
-
-Learn more about alternative functions and more advance hashing setups:
-[hashids.org](https://hashids.org)
-
 ## 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.

data/benchmarks/compare.rb

@@ -8,22 +8,30 @@ require "lite/uxid"
 Benchmark.ips do |x|
   x.report("Hashid") do
     id = rand(1..1_000_000)
-    Lite::Uxid::Hashid.encode(id)
+    Lite::Uxid::Reversible::Hashid.encode(id)
   end
 
+  x.report("Obfuscateid") do
+    id = rand(1..1_000_000)
+    Lite::Uxid::Reversible::Obfuscateid.encode(id)
+  end
+
+  # The irreversible examples include `rand` simulate
+  # the extra work just like reversible examples.
+
   x.report("NanoID") do
-    _id = rand(1..1_000_000) # To simulate the extra work from `rand`
-    Lite::Uxid::Nanoid.encode
+    _id = rand(1..1_000_000)
+    Lite::Uxid::Irreversible::Nanoid.encode
   end
 
   x.report("ULID") do
-    _id = rand(1..1_000_000) # To simulate the extra work from `rand`
-    Lite::Uxid::Ulid.encode
+    _id = rand(1..1_000_000)
+    Lite::Uxid::Irreversible::Ulid.encode
   end
 
   x.report("UUID") do
-    _id = rand(1..1_000_000) # To simulate the extra work from `rand`
-    Lite::Uxid::Uuid.encode
+    _id = rand(1..1_000_000)
+    Lite::Uxid::Irreversible::Uuid.encode
   end
 
   x.compare!

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

@@ -6,7 +6,7 @@ Lite::Uxid.configure do |config|
   config.hashid_size = 16
   config.nanoid_charset = "_-0123456789abcdefghijklmnopqrstuvwxyzABCDEFGHIJKLMNOPQRSTUVWXYZ"
   config.nanoid_size = 21
-  config.scatterid_spin = 0
+  config.obfuscateid_spin = 0
   config.ulid_charset = "0123456789ABCDEFGHIJKLMNOPQRSTUVWXYZ"
   config.ulid_size = 26
   config.uuid_version = 4

data/lib/lite/uxid/configuration.rb

@@ -11,7 +11,7 @@ module Lite
 
       attr_accessor :hashid_charset, :hashid_size, :hashid_salt,
                     :nanoid_charset, :nanoid_size,
-                    :scatterid_spin,
+                    :obfuscateid_spin,
                     :ulid_charset, :ulid_size,
                     :uuid_version
 
@@ -21,7 +21,7 @@ module Lite
         @hashid_size = 16
         @nanoid_charset = WEB_SAFE
         @nanoid_size = 21
-        @scatterid_spin = 0
+        @obfuscateid_spin = 0
         @ulid_charset = COCKFORDS_32
         @ulid_size = 26
         @uuid_version = 4

data/lib/lite/uxid/record/{scatterid.rb → obfuscateid.rb}

@@ -3,7 +3,7 @@
 module Lite
   module Uxid
     module Record
-      module Scatterid
+      module Obfuscateid
 
         def self.included(base)
           base.extend ClassMethods
@@ -17,7 +17,7 @@ module Lite
         module ClassMethods
 
           def find_by_uxid(uxid)
-            decoded_id = Lite::Uxid::Reversible::Scatterid.decode(uxid, prefix: new.uxid_prefix)
+            decoded_id = Lite::Uxid::Reversible::Obfuscateid.decode(uxid)
             find_by(id: decoded_id)
           end
 
@@ -33,17 +33,13 @@ module Lite
         def id_to_uxid
           return unless respond_to?(:uxid)
 
-          Lite::Uxid::Reversible::Scatterid.encode(id, prefix: uxid_prefix)
+          Lite::Uxid::Reversible::Obfuscateid.encode(id)
         end
 
         def uxid_to_id
           return unless respond_to?(:uxid)
 
-          Lite::Uxid::Reversible::Scatterid.decode(uxid, prefix: uxid_prefix)
-        end
-
-        def uxid_prefix
-          nil
+          Lite::Uxid::Reversible::Obfuscateid.decode(uxid)
         end
 
         private

data/lib/lite/uxid/reversible/{scatterid.rb → obfuscateid.rb}

@@ -3,21 +3,18 @@
 module Lite
   module Uxid
     module Reversible
-      class Scatterid < Base
+      class Obfuscateid < Base
 
         def encode
           swap
           scatter
-
-          "#{coder_prefix}#{joined_array}"
+          result
         end
 
         def decode
-          @id = id.delete_prefix(coder_prefix.to_s)
-
           unscatter
           unswap
-          joined_array.to_i
+          result
         end
 
         private
@@ -30,8 +27,8 @@ module Lite
           @coder_array ||= zero_padded_id.chars.collect(&:to_i)
         end
 
-        def joined_array
-          coder_array.join
+        def result
+          coder_array.join.to_i
         end
 
         def swapper_map(index)

data/lib/lite/uxid/version.rb

@@ -3,7 +3,7 @@
 module Lite
   module Uxid
 
-    VERSION = "2.0.0"
+    VERSION = "2.0.1"
 
   end
 end

data/lib/lite/uxid.rb

@@ -12,9 +12,9 @@ require "lite/uxid/irreversible/ulid"
 require "lite/uxid/irreversible/uuid"
 require "lite/uxid/reversible/base"
 require "lite/uxid/reversible/hashid"
-require "lite/uxid/reversible/scatterid"
+require "lite/uxid/reversible/obfuscateid"
 require "lite/uxid/record/hashid"
 require "lite/uxid/record/nanoid"
-require "lite/uxid/record/scatterid"
+require "lite/uxid/record/obfuscateid"
 require "lite/uxid/record/ulid"
 require "lite/uxid/record/uuid"

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: lite-uxid
 version: !ruby/object:Gem::Version
-  version: 2.0.0
+  version: 2.0.1
 platform: ruby
 authors:
 - Juan Gomez
@@ -225,12 +225,12 @@ files:
 - lib/lite/uxid/irreversible/uuid.rb
 - lib/lite/uxid/record/hashid.rb
 - lib/lite/uxid/record/nanoid.rb
-- lib/lite/uxid/record/scatterid.rb
+- lib/lite/uxid/record/obfuscateid.rb
 - lib/lite/uxid/record/ulid.rb
 - lib/lite/uxid/record/uuid.rb
 - lib/lite/uxid/reversible/base.rb
 - lib/lite/uxid/reversible/hashid.rb
-- lib/lite/uxid/reversible/scatterid.rb
+- lib/lite/uxid/reversible/obfuscateid.rb
 - lib/lite/uxid/version.rb
 - lite-uxid.gemspec
 homepage: http://drexed.github.io/lite-uxid