uxid 0.1.0 → 0.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 1c5ebc6fc8f88263e841c870bb1191ac2769933134e68557bcf8c5472c4a9f3b
-  data.tar.gz: 0bea747a87b5ad069325004ea48d9b38e3bd7935e8769f3056e5ceea550b684d
+  metadata.gz: 307443b03ac5b5b09a4d9f9da47fb1fe49c0756a003686e4dc91befd7826b46f
+  data.tar.gz: 4ccd6a17d53a456c353c4e3d227c8d49e5d3d46f41a5cf07ecd7de4b8c29da81
 SHA512:
-  metadata.gz: ebd95c6ed10c5bd1272c598bb7d0538fb72888e7e11842ab4aa30cecccb8a92d839d278fba4d5ec62f512df8a5509ac1f93dc7d4102e8262c7b3f0241a4c145a
-  data.tar.gz: 6e4bb57c8369218d3015cf81ec967625e33f51cf66e5641b4c63c4b32bba9dad424def094b86ba88464d906176c16d9c187fc4c89cb5caa85234be8d99c9d0f7
+  metadata.gz: 80f7234fa2c8497a2c5077b4a267ce9cfc2bbe9638891a539ec9471e63570a6be128cf26289a2453b8f5fd8555cee779bc1fb65737f100b4b7bb75585469ba35
+  data.tar.gz: 8ec73e770fed7334cbe650143032286a635ecabd8861417bc12b3340639b162aa23cc544cb980ebb825b1cb2ca6c9b5b4279a5e95ce992fb3955f1c4c1beb65d

data/CHANGELOG.md

@@ -1,3 +1,10 @@
+## 0.2.0 / 2020-11-24
+
+* Deprecates :size option with integers
+* Adds T-Shirt sizes (:size option)
+* Adds :rand_size option (:rand_size option)
+
+
 ## 0.1.0 / 2020-11-08
 
 * Adds basic UXID generation

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    uxid (0.0.1)
+    uxid (0.2.0)
 
 GEM
   remote: https://rubygems.org/

data/README.md

@@ -3,17 +3,18 @@
 ![MIT License][badge_license_url]
 ![Gem Version][badge_version_url]
 
-UXIDs are identifiers which:
+
+**U**ser e**X**perience focused **ID**entifiers (UXIDs) are identifiers which:
 
 * Describe the resource (aid in debugging and investigation)
-* Prononounceable - easily and accurately transmit characters to another human using a telephone
 * Work well with copy and paste (double clicking selects the entire ID)
 * Can be shortened for low cardinality resources
-* Are very unlikely to collide (more likely with less randomness)
 * Are secure against enumeration attacks
 * Can be generated by application code (not tied to the datastore)
 * Are K-sortable (lexicographically sortable by time - works well with datastore indexing)
 * Do not require any coordination (human or automated) at startup, or generation
+* Are very unlikely to collide (more likely with less randomness)
+* Are easily and accurately transmitted to another human using a telephone
 
 Many of the concepts of Stripe IDs have been used in this library.
 
@@ -29,7 +30,8 @@ UXID.generate # "01EMDGJF0DQXQJ8FM78XE97Y3H"
 UXID.generate prefix: "cus" # "cus_01EMDGJF0DQXQJ8FM78XE97Y3H"
 
 # The amount of entropy can be decreased for smaller cardinality resources
-UXID.generate prefix: "cus", size: 4 # "cus_01EMDGN5QAGPWSKN2"
+# T-Shirt sizes can be used (:xs, :s, :m, :l, :xl) or (:xsmall, :small, :medium, :large, :xlarge)
+UXID.generate prefix: "cus", size: :small # "cus_01EQRH884AQYY1"
 ```
 
 
@@ -38,7 +40,7 @@ UXID.generate prefix: "cus", size: 4 # "cus_01EMDGN5QAGPWSKN2"
 Add this line to your application's Gemfile:
 
 ```ruby
-gem 'uxid'
+gem "uxid"
 ```
 
 And then execute:

data/lib/uxid.rb

@@ -14,6 +14,12 @@ module UXID
   CROCKFORD_ENCODING = "0123456789ABCDEFGHJKMNPQRSTVWXYZ"
   DELIMITER = "_"
 
+  SIZE_WARNING_MESSAGE = <<-EOM
+WARN: The UXID :size param is for Symbol T-Shirt sizes only.
+      Please use the :size param with Symbols (:xs, :s, :m, :l, :xl, or :xsmall, :small, :medium, :large, :xlarge),
+      or use the :rand_size param for specific size of random bytes.
+  EOM
+
   class Error < StandardError; end
 
   def self.generate attrs = {}
@@ -25,9 +31,39 @@ module UXID
     model = ::UXID::Model.new
 
     model.time = attrs[:time] || Time.now
-    model.size = attrs[:size] || 10
     model.prefix = attrs[:prefix] || ""
 
+    if attrs[:rand_size]
+      model.rand_size = attrs[:rand_size]
+    else
+      model.size = attrs[:size]
+      case model.size
+      when Integer
+        puts SIZE_WARNING_MESSAGE
+        model.rand_size = model.size
+
+      when String
+        puts SIZE_WARNING_MESSAGE
+        model.rand_size = 10
+
+      when :xs, :xsmall
+        model.rand_size = 0
+
+      when :s, :small
+        model.rand_size = 2
+
+      when :m, :medium
+        model.rand_size = 5
+
+      when :l, :large
+        model.rand_size = 7
+
+      else
+        model.rand_size = 10
+      end
+
+    end
+
     model
   end
 end

data/lib/uxid/encoder.rb

@@ -10,7 +10,7 @@ module UXID
 
     def encode
       @model.time_encoded = encode_time
-      @model.entropy_encoded = public_send "encode_entropy_#{@model.size}"
+      @model.entropy_encoded = public_send "encode_entropy_#{@model.rand_size}"
 
       @model.encoded
     end
@@ -35,17 +35,6 @@ module UXID
       UXID::CROCKFORD_ENCODING[((b1&1)<<4)]
     end
 
-    def encode_entropy_2
-      b0, b1 = @model.entropy_bytes
-
-      UXID::CROCKFORD_ENCODING[(b0&248)>>3] +
-      UXID::CROCKFORD_ENCODING[((b0&7)<<2)] +
-      UXID::CROCKFORD_ENCODING[(b0&248)>>3] +
-      UXID::CROCKFORD_ENCODING[((b0&7)<<2)  | ((b1&192)>>6)] +
-      UXID::CROCKFORD_ENCODING[(b1&62)>>1] +
-      UXID::CROCKFORD_ENCODING[((b1&1)<<4)]
-    end
-
     def encode_entropy_3
       b0, b1, b2 = @model.entropy_bytes
 

data/lib/uxid/model.rb

@@ -2,7 +2,7 @@ require "uxid/encoder"
 
 module UXID
   class Model
-    attr_accessor :time, :time_encoded, :entropy, :entropy_encoded, :prefix, :size
+    attr_accessor :time, :time_encoded, :entropy, :entropy_encoded, :prefix, :size, :rand_size
 
     def encode
       encoder = ::UXID::Encoder.new self
@@ -22,7 +22,7 @@ module UXID
     def entropy_bytes
       return @entropy_bytes if @entropy_bytes
 
-      bytes_string = SecureRandom.random_bytes @size
+      bytes_string = SecureRandom.random_bytes @rand_size
       @entropy_bytes = bytes_string.bytes
       return @entropy_bytes
     end

data/lib/uxid/version.rb

@@ -1,3 +1,3 @@
 module UXID
-  VERSION = "0.1.0"
+  VERSION = "0.2.0"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: uxid
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.2.0
 platform: ruby
 authors:
 - JohnnyT
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2020-11-08 00:00:00.000000000 Z
+date: 2020-11-24 00:00:00.000000000 Z
 dependencies: []
 description: 'Generates IDs like: cus_01EPEY1JMKXVBT and txn_01EPEY2P06TR1RTV07XA82ZGJJ
   (similar to Stripe identifiers).'