uxid 0.0.1 → 0.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: ed3424777407d1f5ba89a397eff5afef6856b76f2a297465a5f8f2e8bdb780ea
-  data.tar.gz: 7da99c1c18ff54126c116c2cc8acc3ba8dccf3cff4e2c5de40fbdfd02b2f4ff6
+  metadata.gz: 1c5ebc6fc8f88263e841c870bb1191ac2769933134e68557bcf8c5472c4a9f3b
+  data.tar.gz: 0bea747a87b5ad069325004ea48d9b38e3bd7935e8769f3056e5ceea550b684d
 SHA512:
-  metadata.gz: 7857a6c7493e2bf50428f87d806901e900a3772ed1bfa276c8e56feb0ea37715aac9836f64032c807f4e12bfa906e2b9cd49e521a144d0f2e23a5f82cb58c825
-  data.tar.gz: f913e3af0c61847e0c8eca11497f1d7d51a928d6c666baea7762f73f2c9d14a32d18bb4db308b13b68ab3acda2e451eb597f90fca66e3ed9465007501f125812
+  metadata.gz: ebd95c6ed10c5bd1272c598bb7d0538fb72888e7e11842ab4aa30cecccb8a92d839d278fba4d5ec62f512df8a5509ac1f93dc7d4102e8262c7b3f0241a4c145a
+  data.tar.gz: 6e4bb57c8369218d3015cf81ec967625e33f51cf66e5641b4c63c4b32bba9dad424def094b86ba88464d906176c16d9c187fc4c89cb5caa85234be8d99c9d0f7

data/.rubocop.yml

@@ -0,0 +1,103 @@
+AllCops:
+  TargetRubyVersion: 2.5
+  DisabledByDefault: true
+  Exclude:
+    - pkg/**/*.rb
+    - test/spec/**/*.rb
+
+Bundler/DuplicatedGem:
+  Enabled: true
+Lint:
+  Enabled: true
+Security:
+  Enabled: true
+
+# Single quotes being faster is hardly measurable and only affects parse time.
+# Enforcing double quotes reduces the times where you need to change them
+# when introducing an interpolation. Use single quotes only if their semantics
+# are needed.
+Style/StringLiterals:
+  EnforcedStyle: double_quotes
+  Exclude:
+    - lib/riddler/protobuf/*_pb.rb
+
+# Seattle style
+Style/MethodDefParentheses:
+  EnforcedStyle: require_no_parentheses
+
+# Seattle style
+Style/MethodCallWithoutArgsParentheses:
+  Enabled: true
+
+# Seattle style
+Style/MethodCallWithArgsParentheses:
+  Enabled: true
+  EnforcedStyle: omit_parentheses
+  AllowParenthesesInChaining: true
+  IgnoredMethods:
+    - watch
+
+Style/SpecialGlobalVars:
+  Enabled: false
+
+Layout/FirstArrayElementIndentation:
+  Enabled: true
+  EnforcedStyle: consistent
+
+Style/Lambda:
+  Enabled: true
+  EnforcedStyle: literal
+
+# Allow regex argument in Seattle style
+Lint/AmbiguousRegexpLiteral:
+  Enabled: false
+
+# Allow block argument in Seattle style
+Lint/AmbiguousOperator:
+  Enabled: false
+
+Layout/SpaceInsideHashLiteralBraces:
+  Enabled: true
+  EnforcedStyleForEmptyBraces: no_space
+  EnforcedStyle: no_space
+
+Layout/FirstHashElementIndentation:
+  Enabled: true
+  EnforcedStyle: consistent
+
+Layout/CaseIndentation:
+  Enabled: true
+  EnforcedStyle: end
+
+Layout/EndAlignment:
+  Enabled: true
+  EnforcedStyleAlignWith: variable
+
+Layout/SpaceAroundBlockParameters:
+  Enabled: true
+
+Layout/SpaceBeforeBlockBraces:
+  Enabled: true
+
+Layout/SpaceInsideBlockBraces:
+  Enabled: true
+
+Layout/LineLength:
+  Enabled: true
+  Max: 120
+  Exclude:
+    - lib/riddler/protobuf/*_pb.rb
+
+Metrics/ClassLength:
+  Enabled: true
+  Max: 200
+  Exclude:
+    - test/**/*.rb
+
+Lint/SuppressedException:
+  Exclude:
+    - lib/tasks/**/*.rake
+
+Lint/Debugger:
+  Exclude:
+    - test/**/*

data/.simplecov

@@ -0,0 +1,8 @@
+SimpleCov.start do
+  coverage_dir "reports/coverage"
+
+  add_filter "/config/"
+  add_filter "/lib/tasks/"
+
+  track_files "lib/**/*.rb"
+end

data/CHANGELOG.md

@@ -1,3 +1,8 @@
-### 0.0.1 / 2020-06-17
+## 0.1.0 / 2020-11-08
+
+* Adds basic UXID generation
+
+
+## 0.0.1 / 2020-06-17
 
 * Birthday!

data/Gemfile

@@ -3,5 +3,11 @@ source "https://rubygems.org"
 # Specify your gem's dependencies in uxid.gemspec
 gemspec
 
-gem "rake", "~> 12.0"
 gem "minitest", "~> 5.0"
+gem "minitest-focus"
+gem "minitest-reporters"
+gem "pry-nav"
+gem "rake", "~> 12.0"
+gem "rubycritic", require: false
+gem "rubocop"
+gem "simplecov", require: false

data/Gemfile.lock

@@ -6,15 +6,116 @@ PATH
 GEM
   remote: https://rubygems.org/
   specs:
+    addressable (2.7.0)
+      public_suffix (>= 2.0.2, < 5.0)
+    ansi (1.5.0)
+    ast (2.4.1)
+    axiom-types (0.1.1)
+      descendants_tracker (~> 0.0.4)
+      ice_nine (~> 0.11.0)
+      thread_safe (~> 0.3, >= 0.3.1)
+    builder (3.2.4)
+    coderay (1.1.3)
+    coercible (1.0.0)
+      descendants_tracker (~> 0.0.1)
+    descendants_tracker (0.0.4)
+      thread_safe (~> 0.3, >= 0.3.1)
+    docile (1.3.2)
+    equalizer (0.0.11)
+    erubis (2.7.0)
+    flay (2.12.1)
+      erubis (~> 2.7.0)
+      path_expander (~> 1.0)
+      ruby_parser (~> 3.0)
+      sexp_processor (~> 4.0)
+    flog (4.6.4)
+      path_expander (~> 1.0)
+      ruby_parser (~> 3.1, > 3.1.0)
+      sexp_processor (~> 4.8)
+    ice_nine (0.11.2)
+    kwalify (0.7.2)
+    launchy (2.5.0)
+      addressable (~> 2.7)
+    method_source (0.9.2)
     minitest (5.14.1)
+    minitest-focus (1.2.1)
+      minitest (>= 4, < 6)
+    minitest-reporters (1.4.2)
+      ansi
+      builder
+      minitest (>= 5.0)
+      ruby-progressbar
+    parallel (1.19.2)
+    parser (2.7.1.3)
+      ast (~> 2.4.0)
+    path_expander (1.1.0)
+    pry (0.12.2)
+      coderay (~> 1.1.0)
+      method_source (~> 0.9.0)
+    pry-nav (0.3.0)
+      pry (>= 0.9.10, < 0.13.0)
+    psych (3.1.0)
+    public_suffix (4.0.5)
+    rainbow (3.0.0)
     rake (12.3.3)
+    reek (6.0.1)
+      kwalify (~> 0.7.0)
+      parser (>= 2.5.0.0, < 2.8, != 2.5.1.1)
+      psych (~> 3.1.0)
+      rainbow (>= 2.0, < 4.0)
+    regexp_parser (1.7.1)
+    rexml (3.2.4)
+    rubocop (0.85.1)
+      parallel (~> 1.10)
+      parser (>= 2.7.0.1)
+      rainbow (>= 2.2.2, < 4.0)
+      regexp_parser (>= 1.7)
+      rexml
+      rubocop-ast (>= 0.0.3)
+      ruby-progressbar (~> 1.7)
+      unicode-display_width (>= 1.4.0, < 2.0)
+    rubocop-ast (0.0.3)
+      parser (>= 2.7.0.1)
+    ruby-progressbar (1.10.1)
+    ruby_parser (3.14.2)
+      sexp_processor (~> 4.9)
+    rubycritic (4.5.0)
+      flay (~> 2.8)
+      flog (~> 4.4)
+      launchy (>= 2.0.0)
+      parser (>= 2.6.0)
+      rainbow (~> 3.0)
+      reek (~> 6.0, < 7.0)
+      ruby_parser (~> 3.8)
+      simplecov (>= 0.17.0)
+      tty-which (~> 0.4.0)
+      virtus (~> 1.0)
+    sexp_processor (4.15.0)
+    simplecov (0.18.5)
+      docile (~> 1.1)
+      simplecov-html (~> 0.11)
+    simplecov-html (0.12.2)
+    thread_safe (0.3.6)
+    tty-which (0.4.2)
+    unicode-display_width (1.7.0)
+    virtus (1.0.5)
+      axiom-types (~> 0.1)
+      coercible (~> 1.0)
+      descendants_tracker (~> 0.0, >= 0.0.3)
+      equalizer (~> 0.0, >= 0.0.9)
 
 PLATFORMS
   ruby
 
 DEPENDENCIES
   minitest (~> 5.0)
+  minitest-focus
+  minitest-reporters
+  pry-nav
   rake (~> 12.0)
+  rubocop
+  rubycritic
+  simplecov
   uxid!
 
 BUNDLED WITH

data/README.md

@@ -1,8 +1,37 @@
 # UXID
 
-Welcome to your new gem! In this directory, you'll find the files you need to be able to package up your Ruby library into a gem. Put your Ruby code in the file `lib/uxid`. To experiment with that code, run `bin/console` for an interactive prompt.
+![MIT License][badge_license_url]
+![Gem Version][badge_version_url]
+
+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
+
+Many of the concepts of Stripe IDs have been used in this library.
+
+## Usage
+
+#### Generating UXIDs
+
+```ruby
+# No options generates a basic ULID
+UXID.generate # "01EMDGJF0DQXQJ8FM78XE97Y3H"
+
+# A prefix can be provided
+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"
+```
 
-TODO: Delete this and the text above, and describe your gem
 
 ## Installation
 
@@ -20,9 +49,6 @@ Or install it yourself as:
 
     $ gem install uxid
 
-## Usage
-
-TODO: Write usage instructions here
 
 ## Development
 
@@ -38,3 +64,10 @@ Bug reports and pull requests are welcome on GitHub at https://github.com/riddle
 ## License
 
 The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).
+
+<!-- LINKS -->
+[mit_license_url]: http://opensource.org/licenses/MIT
+
+<!-- BADGES -->
+[badge_license_url]: https://img.shields.io/badge/license-MIT-brightgreen.svg?cacheSeconds=3600?style=flat-square
+[badge_version_url]: https://badge.fury.io/rb/uxid.svg

data/Rakefile

@@ -1,10 +1,3 @@
-require "bundler/gem_tasks"
-require "rake/testtask"
+Rake.add_rakelib "lib/tasks"
 
-Rake::TestTask.new(:test) do |t|
-  t.libs << "test"
-  t.libs << "lib"
-  t.test_files = FileList["test/**/*_test.rb"]
-end
-
-task :default => :test
+task default: :test

data/bin/console

@@ -3,12 +3,5 @@
 require "bundler/setup"
 require "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.
-
-# (If you use this, don't forget to add pry to your Gemfile!)
-# require "pry"
-# Pry.start
-
-require "irb"
-IRB.start(__FILE__)
+require "pry"
+Pry.start

data/lib/tasks/bundler.rake

@@ -0,0 +1,4 @@
+begin
+  require "bundler/gem_tasks"
+rescue LoadError
+end

data/lib/tasks/check.rake

@@ -0,0 +1,2 @@
+desc "Runs tests, linting, audits, ..."
+task check: %w[ test linting:dev metrics:quality ]

data/lib/tasks/linting.rake

@@ -0,0 +1,19 @@
+begin
+  require "rubocop/rake_task"
+
+  desc "Run Linting (RuboCop)"
+  task linting: "linting:dev"
+
+  namespace :linting do
+    common_options = %w[ --display-cop-names --extra-details --config=.rubocop.yml --parallel ]
+
+    RuboCop::RakeTask.new :dev do |t|
+      t.options = common_options
+    end
+
+    RuboCop::RakeTask.new :report do |t|
+      t.options = common_options + %w[ --format=html --out=reports/linting/index.html ]
+    end
+  end
+rescue LoadError
+end

data/lib/tasks/quality.rake

@@ -0,0 +1,12 @@
+begin
+  require "rubycritic/rake_task"
+
+  namespace :metrics do
+    RubyCritic::RakeTask.new do |task|
+      task.name = "quality"
+      task.paths   = FileList["lib/**/*.rb"]
+      task.options = "--format html --no-browser --path reports/quality"
+    end
+  end
+rescue LoadError
+end

data/lib/tasks/test.rake

@@ -0,0 +1,8 @@
+require "rake/testtask"
+
+Rake::TestTask.new :test do |t|
+  t.libs << "lib"
+  t.libs << "test"
+  t.test_files = FileList["test/**/*_test.rb"]
+  t.warning = false
+end

data/lib/uxid.rb

@@ -1,5 +1,33 @@
+# frozen-string-literal: true
+
+if RUBY_VERSION >= "2.5"
+  require "securerandom"
+else
+  require "sysrandom/securerandom"
+end
+
+require "uxid/model"
+require "uxid/encoder"
 require "uxid/version"
 
 module UXID
+  CROCKFORD_ENCODING = "0123456789ABCDEFGHJKMNPQRSTVWXYZ"
+  DELIMITER = "_"
+
   class Error < StandardError; end
+
+  def self.generate attrs = {}
+    model = new attrs
+    model.encode
+  end
+
+  def self.new attrs = {}
+    model = ::UXID::Model.new
+
+    model.time = attrs[:time] || Time.now
+    model.size = attrs[:size] || 10
+    model.prefix = attrs[:prefix] || ""
+
+    model
+  end
 end

data/lib/uxid/crockford.rb

@@ -0,0 +1,50 @@
+module UXID
+  module Crockford
+    ALPHABET = "0123456789ABCDEFGHJKMNPQRSTVWXYZ".freeze
+
+    class Chunk
+      def initialize bytes
+        @bytes = bytes
+      end
+
+      def decode
+        bytes = @bytes.take_while {|c| c != 61} # strip padding
+        n = (bytes.length * 5.0 / 8.0).floor
+        p = bytes.length < 8 ? 5 - (n * 8) % 5 : 0
+        c = bytes.inject(0) do |m,o|
+          i = ALPHABET.index o.chr
+          raise ArgumentError, "invalid character '#{o.chr}'" if i.nil?
+          (m << 5) + i
+        end >> p
+        (0..n-1).to_a.reverse.collect {|i| ((c >> i * 8) & 0xff).chr}
+      end
+
+      def encode
+        n = (@bytes.length * 8.0 / 5.0).ceil
+        p = n < 8 ? 5 - (@bytes.length * 8) % 5 : 0
+        c = @bytes.inject(0) {|m,o| (m << 8) + o} << p
+        [(0..n-1).to_a.reverse.collect {|i| ALPHABET[(c >> i * 5) & 0x1f].chr}]
+      end
+    end
+
+    def self.chunks str, size
+      result = []
+      bytes = str.bytes
+      while bytes.any? do
+        chunk_bytes = bytes.take size
+        bytes = bytes.drop size
+        new_chunk = Chunk.new chunk_bytes
+        result << new_chunk
+      end
+      result
+    end
+
+    def self.encode str
+      chunks(str, 5).collect(&:encode).flatten.join
+    end
+
+    def self.decode str
+      chunks(str, 8).collect(&:decode).flatten.join
+    end
+  end
+end

data/lib/uxid/encoder.rb

@@ -0,0 +1,211 @@
+module UXID
+  class Encoder
+    def self.encode model
+      new(model).encode
+    end
+
+    def initialize model
+      @model = model
+    end
+
+    def encode
+      @model.time_encoded = encode_time
+      @model.entropy_encoded = public_send "encode_entropy_#{@model.size}"
+
+      @model.encoded
+    end
+
+    def encode_entropy_0; ""; end
+
+    def encode_entropy_1
+      b0, _b1 = @model.entropy_bytes
+
+      UXID::CROCKFORD_ENCODING[(b0&248)>>3] +
+      UXID::CROCKFORD_ENCODING[((b0&7)<<2)]
+    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_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
+
+      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)  | ((b2&240)>>4)] +
+      UXID::CROCKFORD_ENCODING[((b2&15)<<1)]
+    end
+
+    def encode_entropy_4
+      b0, b1, b2, b3 = @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)  | ((b2&240)>>4)] +
+      UXID::CROCKFORD_ENCODING[((b2&15)<<1) | ((b3&128)>>7)] +
+      UXID::CROCKFORD_ENCODING[(b3&124)>>2] +
+      UXID::CROCKFORD_ENCODING[((b3&3)<<3)]
+    end
+
+    def encode_entropy_5
+      b0, b1, b2, b3, b4 = @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)  | ((b2&240)>>4)] +
+      UXID::CROCKFORD_ENCODING[((b2&15)<<1) | ((b3&128)>>7)] +
+      UXID::CROCKFORD_ENCODING[(b3&124)>>2] +
+      UXID::CROCKFORD_ENCODING[((b3&3)<<3)  | ((b4&224)>>5)] +
+      UXID::CROCKFORD_ENCODING[b4&31]
+    end
+
+    def encode_entropy_6
+      b0, b1, b2, b3, b4, b5 = @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)  | ((b2&240)>>4)] +
+      UXID::CROCKFORD_ENCODING[((b2&15)<<1) | ((b3&128)>>7)] +
+      UXID::CROCKFORD_ENCODING[(b3&124)>>2] +
+      UXID::CROCKFORD_ENCODING[((b3&3)<<3)  | ((b4&224)>>5)] +
+      UXID::CROCKFORD_ENCODING[b4&31] +
+      UXID::CROCKFORD_ENCODING[(b5&248)>>3] +
+      UXID::CROCKFORD_ENCODING[((b5&7)<<2)]
+    end
+
+    def encode_entropy_7
+      b0, b1, b2, b3, b4, b5, b6 = @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)  | ((b2&240)>>4)] +
+      UXID::CROCKFORD_ENCODING[((b2&15)<<1) | ((b3&128)>>7)] +
+      UXID::CROCKFORD_ENCODING[(b3&124)>>2] +
+      UXID::CROCKFORD_ENCODING[((b3&3)<<3)  | ((b4&224)>>5)] +
+      UXID::CROCKFORD_ENCODING[b4&31] +
+      UXID::CROCKFORD_ENCODING[(b5&248)>>3] +
+      UXID::CROCKFORD_ENCODING[((b5&7)<<2)  | ((b6&192)>>6)] +
+      UXID::CROCKFORD_ENCODING[(b6&62)>>1] +
+      UXID::CROCKFORD_ENCODING[((b6&1)<<4)]
+    end
+
+    def encode_entropy_8
+      b0, b1, b2, b3, b4, b5, b6, b7 = @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)  | ((b2&240)>>4)] +
+      UXID::CROCKFORD_ENCODING[((b2&15)<<1) | ((b3&128)>>7)] +
+      UXID::CROCKFORD_ENCODING[(b3&124)>>2] +
+      UXID::CROCKFORD_ENCODING[((b3&3)<<3)  | ((b4&224)>>5)] +
+      UXID::CROCKFORD_ENCODING[b4&31] +
+      UXID::CROCKFORD_ENCODING[(b5&248)>>3] +
+      UXID::CROCKFORD_ENCODING[((b5&7)<<2)  | ((b6&192)>>6)] +
+      UXID::CROCKFORD_ENCODING[(b6&62)>>1] +
+      UXID::CROCKFORD_ENCODING[((b6&1)<<4)  | ((b7&240)>>4)] +
+      UXID::CROCKFORD_ENCODING[((b7&15)<<1)]
+    end
+
+    def encode_entropy_9
+      b0, b1, b2, b3, b4, b5, b6, b7, b8 = @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)  | ((b2&240)>>4)] +
+      UXID::CROCKFORD_ENCODING[((b2&15)<<1) | ((b3&128)>>7)] +
+      UXID::CROCKFORD_ENCODING[(b3&124)>>2] +
+      UXID::CROCKFORD_ENCODING[((b3&3)<<3)  | ((b4&224)>>5)] +
+      UXID::CROCKFORD_ENCODING[b4&31] +
+      UXID::CROCKFORD_ENCODING[(b5&248)>>3] +
+      UXID::CROCKFORD_ENCODING[((b5&7)<<2)  | ((b6&192)>>6)] +
+      UXID::CROCKFORD_ENCODING[(b6&62)>>1] +
+      UXID::CROCKFORD_ENCODING[((b6&1)<<4)  | ((b7&240)>>4)] +
+      UXID::CROCKFORD_ENCODING[((b7&15)<<1)] +
+      UXID::CROCKFORD_ENCODING[((b7&15)<<1) | ((b8&128)>>7)] +
+      UXID::CROCKFORD_ENCODING[(b8&124)>>2] +
+      UXID::CROCKFORD_ENCODING[((b8&3)<<3)]
+    end
+
+    def encode_entropy_10
+      b0, b1, b2, b3, b4, b5, b6, b7, b8, b9 = @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)  | ((b2&240)>>4)] +
+      UXID::CROCKFORD_ENCODING[((b2&15)<<1) | ((b3&128)>>7)] +
+      UXID::CROCKFORD_ENCODING[(b3&124)>>2] +
+      UXID::CROCKFORD_ENCODING[((b3&3)<<3)  | ((b4&224)>>5)] +
+      UXID::CROCKFORD_ENCODING[b4&31] +
+      UXID::CROCKFORD_ENCODING[(b5&248)>>3] +
+      UXID::CROCKFORD_ENCODING[((b5&7)<<2)  | ((b6&192)>>6)] +
+      UXID::CROCKFORD_ENCODING[(b6&62)>>1] +
+      UXID::CROCKFORD_ENCODING[((b6&1)<<4)  | ((b7&240)>>4)] +
+      UXID::CROCKFORD_ENCODING[((b7&15)<<1)] +
+      UXID::CROCKFORD_ENCODING[((b7&15)<<1) | ((b8&128)>>7)] +
+      UXID::CROCKFORD_ENCODING[(b8&124)>>2] +
+      UXID::CROCKFORD_ENCODING[((b8&3)<<3)  | ((b9&224)>>5)] +
+      UXID::CROCKFORD_ENCODING[b9&31]
+    end
+
+    def encode_time
+      # Get the 5 bytes of the 48bit time
+      b0, b1, b2, b3, b4, b5 = @model.time_bytes
+
+      # Split these 5 bytes up into 10 characters using the encoding
+      # and join them together as a string
+      UXID::CROCKFORD_ENCODING[(b0&224)>>5] +
+      UXID::CROCKFORD_ENCODING[b0&31] +
+      UXID::CROCKFORD_ENCODING[(b1&248)>>3] +
+      UXID::CROCKFORD_ENCODING[((b1&7)<<2)  | ((b2&192)>>6)] +
+      UXID::CROCKFORD_ENCODING[(b2&62)>>1] +
+      UXID::CROCKFORD_ENCODING[((b2&1)<<4)  | ((b3&240)>>4)] +
+      UXID::CROCKFORD_ENCODING[((b3&15)<<1) | ((b4&128)>>7)] +
+      UXID::CROCKFORD_ENCODING[(b4&124)>>2] +
+      UXID::CROCKFORD_ENCODING[((b4&3)<<3)  | ((b5&224)>>5)] +
+      UXID::CROCKFORD_ENCODING[b5&31]
+    end
+  end
+end

data/lib/uxid/model.rb

@@ -0,0 +1,44 @@
+require "uxid/encoder"
+
+module UXID
+  class Model
+    attr_accessor :time, :time_encoded, :entropy, :entropy_encoded, :prefix, :size
+
+    def encode
+      encoder = ::UXID::Encoder.new self
+      encoder.encode
+    end
+
+    # Returns time as 48 bits
+    def time_bytes
+      return @time_bytes if @time_bytes
+
+      time_ms = (@time.to_f * 1000).to_i
+      bytes = [time_ms].pack "Q>"
+      bytes_string = bytes[2..-1]
+      @time_bytes = bytes_string.bytes
+    end
+
+    def entropy_bytes
+      return @entropy_bytes if @entropy_bytes
+
+      bytes_string = SecureRandom.random_bytes @size
+      @entropy_bytes = bytes_string.bytes
+      return @entropy_bytes
+    end
+
+    def encoded
+      id = time_encoded + entropy_encoded
+
+      if has_prefix?
+        [prefix, id].join UXID::DELIMITER
+      else
+        id
+      end
+    end
+
+    def has_prefix?
+      !(prefix.nil? || prefix == "")
+    end
+  end
+end

data/lib/uxid/version.rb

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

data/uxid.gemspec

@@ -1,4 +1,5 @@
-require_relative 'lib/uxid/version'
+require_relative "lib/uxid/version"
+here = File.expand_path "..", __FILE__
 
 Gem::Specification.new do |spec|
   spec.name          = "uxid"
@@ -6,21 +7,21 @@ Gem::Specification.new do |spec|
   spec.authors       = ["JohnnyT"]
   spec.email         = ["ubergeek3141@gmail.com"]
 
-  spec.summary       = "User eXperience focused IDentifiers"
+  spec.summary       = "Generates IDs like: cus_01EPEY1JMKXVBT and txn_01EPEY2P06TR1RTV07XA82ZGJJ (similar to Stripe identifiers)."
   spec.description   = spec.summary
   spec.homepage      = "https://github.com/riddler/uxid"
   spec.license       = "MIT"
-  spec.required_ruby_version = Gem::Requirement.new(">= 2.3.0")
+  spec.required_ruby_version = Gem::Requirement.new ">= 2.3.0"
 
   spec.metadata["homepage_uri"] = spec.homepage
   spec.metadata["source_code_uri"] = spec.homepage
 
   # 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
-    `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
+  spec.files         = Dir.chdir here do
+    `git ls-files -z`.split("\x0").reject { |f| f.match %r{^(test|spec|features)/} }
   end
   spec.bindir        = "exe"
-  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename f }
   spec.require_paths = ["lib"]
 end

metadata

@@ -1,22 +1,25 @@
 --- !ruby/object:Gem::Specification
 name: uxid
 version: !ruby/object:Gem::Version
-  version: 0.0.1
+  version: 0.1.0
 platform: ruby
 authors:
 - JohnnyT
-autorequire: 
+autorequire:
 bindir: exe
 cert_chain: []
-date: 2020-06-18 00:00:00.000000000 Z
+date: 2020-11-08 00:00:00.000000000 Z
 dependencies: []
-description: User eXperience focused IDentifiers
+description: 'Generates IDs like: cus_01EPEY1JMKXVBT and txn_01EPEY2P06TR1RTV07XA82ZGJJ
+  (similar to Stripe identifiers).'
 email:
 - ubergeek3141@gmail.com
 executables: []
 extensions: []
 extra_rdoc_files: []
 files:
+- ".rubocop.yml"
+- ".simplecov"
 - CHANGELOG.md
 - Gemfile
 - Gemfile.lock
@@ -25,7 +28,15 @@ files:
 - Rakefile
 - bin/console
 - bin/setup
+- lib/tasks/bundler.rake
+- lib/tasks/check.rake
+- lib/tasks/linting.rake
+- lib/tasks/quality.rake
+- lib/tasks/test.rake
 - lib/uxid.rb
+- lib/uxid/crockford.rb
+- lib/uxid/encoder.rb
+- lib/uxid/model.rb
 - lib/uxid/version.rb
 - uxid.gemspec
 homepage: https://github.com/riddler/uxid
@@ -34,7 +45,7 @@ licenses:
 metadata:
   homepage_uri: https://github.com/riddler/uxid
   source_code_uri: https://github.com/riddler/uxid
-post_install_message: 
+post_install_message:
 rdoc_options: []
 require_paths:
 - lib
@@ -49,8 +60,9 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.1.2
-signing_key: 
+rubygems_version: 3.1.4
+signing_key:
 specification_version: 4
-summary: User eXperience focused IDentifiers
+summary: 'Generates IDs like: cus_01EPEY1JMKXVBT and txn_01EPEY2P06TR1RTV07XA82ZGJJ
+  (similar to Stripe identifiers).'
 test_files: []