typed_uuid 1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 5c5433e604f5994bc1cb5787813f0948c7b1c5448aa6e78b61e0d5a5dec056bc
+  data.tar.gz: f38b7f09d39467074e06c62e7edb28f34b1426b1f089e61b31457d6a79f002dc
+SHA512:
+  metadata.gz: d5b2fc14ab95352601cdd86218d0594399f6bf838a3bb097a50996536ba1ac41dc1b44398fc1e342c743854069b8120800a80f1067b16922966c244a31fd0c9c
+  data.tar.gz: 561171c47297962e4c0ac880d7515f3fffafabbb07e606f3d551acc080476bab505496994de79296025f179615f868294b1b410a0eda9c96880135980a1805af

data/.gitignore

@@ -0,0 +1,3 @@
+coverage
+*.gem
+.byebug_history

data/.tm_properties

@@ -0,0 +1 @@
+exclude = '{$exclude,log,tmp,.tm_properties,coverage}'

data/Gemfile

@@ -0,0 +1,3 @@
+source "https://rubygems.org"
+
+gemspec

data/Gemfile.lock

@@ -0,0 +1,168 @@
+PATH
+  remote: .
+  specs:
+    typed_uuid (0.1)
+      activerecord (>= 6.0.0)
+      pg
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    actioncable (6.0.2.1)
+      actionpack (= 6.0.2.1)
+      nio4r (~> 2.0)
+      websocket-driver (>= 0.6.1)
+    actionmailbox (6.0.2.1)
+      actionpack (= 6.0.2.1)
+      activejob (= 6.0.2.1)
+      activerecord (= 6.0.2.1)
+      activestorage (= 6.0.2.1)
+      activesupport (= 6.0.2.1)
+      mail (>= 2.7.1)
+    actionmailer (6.0.2.1)
+      actionpack (= 6.0.2.1)
+      actionview (= 6.0.2.1)
+      activejob (= 6.0.2.1)
+      mail (~> 2.5, >= 2.5.4)
+      rails-dom-testing (~> 2.0)
+    actionpack (6.0.2.1)
+      actionview (= 6.0.2.1)
+      activesupport (= 6.0.2.1)
+      rack (~> 2.0, >= 2.0.8)
+      rack-test (>= 0.6.3)
+      rails-dom-testing (~> 2.0)
+      rails-html-sanitizer (~> 1.0, >= 1.2.0)
+    actiontext (6.0.2.1)
+      actionpack (= 6.0.2.1)
+      activerecord (= 6.0.2.1)
+      activestorage (= 6.0.2.1)
+      activesupport (= 6.0.2.1)
+      nokogiri (>= 1.8.5)
+    actionview (6.0.2.1)
+      activesupport (= 6.0.2.1)
+      builder (~> 3.1)
+      erubi (~> 1.4)
+      rails-dom-testing (~> 2.0)
+      rails-html-sanitizer (~> 1.1, >= 1.2.0)
+    activejob (6.0.2.1)
+      activesupport (= 6.0.2.1)
+      globalid (>= 0.3.6)
+    activemodel (6.0.2.1)
+      activesupport (= 6.0.2.1)
+    activerecord (6.0.2.1)
+      activemodel (= 6.0.2.1)
+      activesupport (= 6.0.2.1)
+    activestorage (6.0.2.1)
+      actionpack (= 6.0.2.1)
+      activejob (= 6.0.2.1)
+      activerecord (= 6.0.2.1)
+      marcel (~> 0.3.1)
+    activesupport (6.0.2.1)
+      concurrent-ruby (~> 1.0, >= 1.0.2)
+      i18n (>= 0.7, < 2)
+      minitest (~> 5.1)
+      tzinfo (~> 1.1)
+      zeitwerk (~> 2.2)
+    ansi (1.5.0)
+    builder (3.2.4)
+    byebug (11.0.1)
+    concurrent-ruby (1.1.5)
+    crass (1.0.5)
+    docile (1.3.2)
+    erubi (1.9.0)
+    globalid (0.4.2)
+      activesupport (>= 4.2.0)
+    i18n (1.7.0)
+      concurrent-ruby (~> 1.0)
+    json (2.3.0)
+    loofah (2.4.0)
+      crass (~> 1.0.2)
+      nokogiri (>= 1.5.9)
+    mail (2.7.1)
+      mini_mime (>= 0.1.1)
+    marcel (0.3.3)
+      mimemagic (~> 0.3.2)
+    method_source (0.9.2)
+    mimemagic (0.3.3)
+    mini_mime (1.0.2)
+    mini_portile2 (2.4.0)
+    minitest (5.13.0)
+    minitest-reporters (1.4.2)
+      ansi
+      builder
+      minitest (>= 5.0)
+      ruby-progressbar
+    mocha (1.11.1)
+    nio4r (2.5.2)
+    nokogiri (1.10.7)
+      mini_portile2 (~> 2.4.0)
+    pg (1.1.4)
+    rack (2.0.8)
+    rack-test (1.1.0)
+      rack (>= 1.0, < 3)
+    rails (6.0.2.1)
+      actioncable (= 6.0.2.1)
+      actionmailbox (= 6.0.2.1)
+      actionmailer (= 6.0.2.1)
+      actionpack (= 6.0.2.1)
+      actiontext (= 6.0.2.1)
+      actionview (= 6.0.2.1)
+      activejob (= 6.0.2.1)
+      activemodel (= 6.0.2.1)
+      activerecord (= 6.0.2.1)
+      activestorage (= 6.0.2.1)
+      activesupport (= 6.0.2.1)
+      bundler (>= 1.3.0)
+      railties (= 6.0.2.1)
+      sprockets-rails (>= 2.0.0)
+    rails-dom-testing (2.0.3)
+      activesupport (>= 4.2.0)
+      nokogiri (>= 1.6)
+    rails-html-sanitizer (1.3.0)
+      loofah (~> 2.3)
+    railties (6.0.2.1)
+      actionpack (= 6.0.2.1)
+      activesupport (= 6.0.2.1)
+      method_source
+      rake (>= 0.8.7)
+      thor (>= 0.20.3, < 2.0)
+    rake (13.0.1)
+    ruby-progressbar (1.10.1)
+    simplecov (0.17.1)
+      docile (~> 1.1)
+      json (>= 1.8, < 3)
+      simplecov-html (~> 0.10.0)
+    simplecov-html (0.10.2)
+    sprockets (4.0.0)
+      concurrent-ruby (~> 1.0)
+      rack (> 1, < 3)
+    sprockets-rails (3.2.1)
+      actionpack (>= 4.0)
+      activesupport (>= 4.0)
+      sprockets (>= 3.0.0)
+    thor (1.0.1)
+    thread_safe (0.3.6)
+    tzinfo (1.2.5)
+      thread_safe (~> 0.1)
+    websocket-driver (0.7.1)
+      websocket-extensions (>= 0.1.0)
+    websocket-extensions (0.1.4)
+    zeitwerk (2.2.2)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  activesupport (>= 6.0.0)
+  bundler
+  byebug
+  minitest
+  minitest-reporters
+  mocha
+  rails (>= 6.0.0)
+  rake
+  simplecov
+  typed_uuid!
+
+BUNDLED WITH
+   2.0.2

data/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2019 Jon Bracy
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

data/README.md

@@ -0,0 +1,67 @@
+# TypedUUID
+
+A __Typed UUID__ is an UUID with an enum embeded within the UUID.
+
+UUIDs are 128bit or 16bytes. The hex format is represented below where x is
+a hex representation of 4 bits.
+
+`xxxxxxxx-xxxx-Mxxx-Nxxx-xxxxxxxxxxxx`
+
+Where:
+
+- M is 4 bits and is the Version
+- N is 3 bits and is the Variant of the Version followed a bit
+
+We modify this and use the following structure where the 7th & 8th bytes in the
+UUID are enum XORed with bytes 5 & 6.
+
+`xxxxxxxx-YYYY-TTTT-xxxx-xxxxxxxxxxxx`
+
+Where:
+
+- TTTT is the Class ENUM 0bNNNN_NNNN_NNNN_NNNN (0 - 65,535) XORed with YYYY
+- YYYY are the bytes to be XORed with the Class ENUM to produce the identifying
+  bytes
+
+XORing bytes 7 & 8 with bytes 5 & 6 of the Typed UUID will give us back the ENUM
+of the Type using soley the UUID.
+
+## Install
+
+Add this to your Gemfile:
+
+`gem 'typed_uuid'`
+
+Once bundled you can add an initializer to Rails to register your types as shown
+below. This maps the __table_names__ of the models to an integer between 0 and 255.
+
+```ruby
+# config/initializers/uuid_types.rb
+
+ActiveRecord::Base.register_uuid_types({
+  listings: 	0,
+  buildings: 	65_535
+})
+
+# Or:
+
+ActiveRecord::Base.register_uuid_types({
+  0 		=> :listings,
+  65_535 	=> :buildings
+})
+```
+
+## Usage
+
+In your migrations simply replace `id: :uuid` with `id: :typed_uuid` when creating
+a table.
+
+```ruby
+class CreateProperties < ActiveRecord::Migration[5.2]
+  def change	
+	create_table :properties, id: :typed_uuid do |t|
+      t.string "name", limit: 255
+    end
+  end
+end
+```

data/Rakefile

@@ -0,0 +1,13 @@
+require 'bundler/setup'
+require "bundler/gem_tasks"
+Bundler.require(:development)
+
+require 'fileutils'
+require "rake/testtask"
+
+Rake::TestTask.new do |t|
+    t.libs << 'lib' << 'test'
+    t.test_files = FileList['test/**/*_test.rb']
+    t.warning = true
+    # t.verbose = true
+end

data/db/migrate/20191222234546_add_typed_uuid_function.rb

@@ -0,0 +1,18 @@
+class AddTypedUuidFunction < ActiveRecord::Migration[6.0]
+  def up
+    enable_extension 'pgcrypto'
+    
+    execute <<-SQL
+      CREATE OR REPLACE FUNCTION typed_uuid(t bytea) RETURNS uuid AS $$
+        DECLARE
+          bytes bytea := gen_random_bytes(16);
+          uuid bytea;
+        BEGIN
+          bytes := set_byte(bytes, 6, get_byte(bytes, 4) # get_byte(t, 0));
+          bytes := set_byte(bytes, 7, get_byte(bytes, 5) # get_byte(t, 1));
+          RETURN encode( bytes, 'hex') :: uuid;
+        END;
+      $$ LANGUAGE plpgsql;
+    SQL
+  end
+end

data/lib/typed_uuid/active_record.rb

@@ -0,0 +1,67 @@
+module TypedUUID::ActiveRecord
+  
+  UUID_TYPE_CONFLICT_MESSAGE = \
+    "You tried to define an UUID type %{int} for \"%{table}\", but " \
+    " %{int} is already defined as the type for %{other}"
+  
+  def self.extended(base) # :nodoc:
+    base.class_attribute(:defined_uuid_types, instance_writer: false, default: {})
+    base.class_attribute(:uuid_type_cache, instance_writer: false, default: {})
+  end
+  
+  def register_uuid_type(table, int)
+    if int < 0 || int > 65_535
+      raise ArgumentError, "UUID type must be between 0 and 65,535"
+    elsif defined_uuid_types.has_key?(int)
+      raise ArgumentError, UUID_TYPE_CONFLICT_MESSAGE % {
+        int: int,
+        table: table,
+        other: defined_uuid_types[int]
+      }
+    else
+      defined_uuid_types[int] = table.to_s
+    end
+  end
+  
+  def register_uuid_types(mapping)
+    mapping.each do |k, v|
+      if k.is_a?(Integer)
+        register_uuid_type(v, k)
+      else
+        register_uuid_type(k, v)
+      end
+    end
+  end
+
+  def uuid_type_from_table_name(table)
+    type = defined_uuid_types.key(table.to_s)
+    if type.nil?
+      raise ArgumentError, "UUID Type for \"#{table}\" not defined"
+    end
+    
+    type
+  end
+  
+  def class_from_uuid_type(type)
+    if klass = uuid_type_cache[type]
+      return klass 
+    else
+      # Rails.application.eager_load! if !Rails.application.config.eager_load
+
+      ::ActiveRecord::Base.descendants.select do |klass|
+        next unless ( klass.superclass == ::ActiveRecord::Base || klass.superclass.abstract_class? )
+        next if klass.table_name.nil?
+        
+        uuid_type_cache[defined_uuid_types.key(klass.table_name)] = klass
+      end
+      
+      uuid_type_cache[type]
+    end
+  end
+  
+  def class_from_uuid(uuid)
+    uuid = uuid.gsub('-', '')
+    class_from_uuid_type(uuid[8..11].to_i(16) ^ uuid[12..15].to_i(16))
+  end
+  
+end

data/lib/typed_uuid/psql_column_methods.rb

@@ -0,0 +1,14 @@
+module TypedUUID::PsqlColumnMethods
+
+  def primary_key(name, type = :primary_key, **options)
+    if type == :typed_uuid
+      klass_enum = ::ActiveRecord::Base.uuid_type_from_table_name(self.name)
+      options[:id] = :uuid
+      options[:default] ||= -> { "typed_uuid('\\x#{klass_enum.to_s(16).ljust(4, '0')}')" }
+      super(name, :uuid, **options)
+    else
+      super
+    end
+  end
+
+end

data/lib/typed_uuid/railtie.rb

@@ -0,0 +1,14 @@
+class TypedUUID::Railtie < Rails::Railtie
+
+  initializer :typed_uuid do |app|
+    ActiveRecord::Tasks::DatabaseTasks.migrations_paths << File.expand_path('../../../db/migrate', __FILE__)
+    
+    ActiveSupport.on_load(:active_record) do
+      ActiveRecord::Base.extend TypedUUID::ActiveRecord
+    end
+    
+    require 'active_record/connection_adapters/postgresql/schema_definitions'    
+    ActiveRecord::ConnectionAdapters::PostgreSQL::TableDefinition.include TypedUUID::PsqlColumnMethods
+  end
+
+end

data/lib/typed_uuid/version.rb

@@ -0,0 +1,3 @@
+module TypedUUID
+  VERSION = '1.0'
+end

data/lib/typed_uuid.rb

@@ -0,0 +1,6 @@
+module TypedUUID
+  autoload :ActiveRecord, 'typed_uuid/active_record'
+  autoload :PsqlColumnMethods, 'typed_uuid/psql_column_methods'
+end
+
+require 'typed_uuid/railtie' if defined? Rails

data/test/test_helper.rb

@@ -0,0 +1,194 @@
+require 'simplecov'
+SimpleCov.start do
+  add_filter %r{^/test/}
+  # add_group 'lib', 'sunstone/lib'
+  # add_group 'ext', 'sunstone/ext'
+end
+
+# To make testing/debugging easier, test within this source tree versus an
+# installed gem
+$LOAD_PATH << File.expand_path('../lib', __FILE__)
+
+require 'byebug'
+require "minitest/autorun"
+require 'minitest/unit'
+require 'minitest/reporters'
+require 'mocha/minitest'
+require 'active_support'
+require 'active_record'
+require 'rails'
+require 'typed_uuid'
+require 'typed_uuid/railtie'
+require File.expand_path('../../db/migrate/20191122234546_add_typed_uuid_function', __FILE__)
+
+module ActiveRecord::Tasks::DatabaseTasks
+  def migrations_paths
+    []
+  end
+end
+TypedUUID::Railtie.initializers.each(&:run)
+Minitest::Reporters.use! Minitest::Reporters::SpecReporter.new
+
+class ActiveSupport::TestCase
+  
+  # File 'lib/active_support/testing/declarative.rb'
+  def self.test(name, &block)
+    test_name = "test_#{name.gsub(/\s+/, '_')}".to_sym
+    defined = method_defined? test_name
+    raise "#{test_name} is already defined in #{self}" if defined
+    if block_given?
+      define_method(test_name, &block)
+    else
+      define_method(test_name) do
+        skip "No implementation provided for #{name}"
+      end
+    end
+  end
+  
+  def self.schema(&block)
+    self.class_variable_set(:@@schema, block)
+  end
+  
+  set_callback(:setup, :before) do
+    if !self.class.class_variable_defined?(:@@suite_setup_run)
+      configuration = {
+        adapter:  "postgresql",
+        database: "uuid-types-test",
+        encoding: "utf8"
+      }.stringify_keys
+  
+      db_tasks = ActiveRecord::Tasks::PostgreSQLDatabaseTasks.new(configuration)
+      db_tasks.purge
+    
+      ActiveRecord::Base.establish_connection(configuration)
+      ActiveRecord::Migration.suppress_messages do
+        AddTypedUuidFunction.migrate :up
+        
+        if self.class.class_variable_defined?(:@@schema)
+          ActiveRecord::Schema.define(&self.class.class_variable_get(:@@schema))
+          ActiveRecord::Migration.execute("SELECT c.relname FROM pg_class c WHERE c.relkind = 'S'").each_row do |row|
+            ActiveRecord::Migration.execute("ALTER SEQUENCE #{row[0]} RESTART WITH #{rand(50_000)}")
+          end
+        end
+      end
+    end
+    self.class.class_variable_set(:@@suite_setup_run, true)
+  end
+
+  # def debug
+  #   ActiveRecord::Base.logger = Logger.new(STDOUT)
+  #   $debugging = true
+  #   yield
+  # ensure
+  #   ActiveRecord::Base.logger = nil
+  #   $debugging = false
+  # end
+
+  def capture_sql
+    # ActiveRecord::Base.connection.materialize_transactions
+    SQLLogger.clear_log
+    yield
+    SQLLogger.log_all.dup
+  end
+
+  def assert_sql(*patterns_to_match)
+    if patterns_to_match.all? { |s| s.is_a?(String) } && patterns_to_match.size > 1
+      assert_equal(*patterns_to_match.take(2).map { |sql| sql.gsub(/( +|\n\s*|\s+)/, ' ').strip })
+    else
+      begin
+        ret_value = nil
+        capture_sql { ret_value = yield }
+        ret_value
+      ensure
+        patterns_to_match.map! {|p| p.is_a?(String) ? p.gsub(/( +|\n\s*|\s+)/, ' ').strip : p }
+        failed_patterns = []
+        patterns_to_match.each do |pattern|
+          failed_patterns << pattern unless SQLLogger.log_all.any?{ |sql| pattern === sql.gsub(/( +|\n\s*|\s+)/, ' ').strip }
+        end
+        assert failed_patterns.empty?, "Query pattern(s) #{failed_patterns.map(&:inspect).join(', ')} not found.#{SQLLogger.log.size == 0 ? '' : "\nQueries:\n#{SQLLogger.log.join("\n")}"}"
+      end
+    end
+  end
+
+  def assert_no_sql(*patterns_to_match)
+    if patterns_to_match.all? { |s| s.is_a?(String) }
+      assert_not_equal(*patterns_to_match.take(2).map { |sql| sql.gsub(/( +|\n\s*|\s+)/, ' ').strip })
+    else
+      begin
+        ret_value = nil
+        capture_sql { ret_value = yield }
+        ret_value
+      ensure
+        failed_patterns = []
+        patterns_to_match.each do |pattern|
+          failed_patterns << pattern unless SQLLogger.log_all.any?{ |sql| pattern === sql }
+        end
+        assert !failed_patterns.empty?, "Query pattern(s) #{failed_patterns.map(&:inspect).join(', ')} found.#{SQLLogger.log.size == 0 ? '' : "\nQueries:\n#{SQLLogger.log.join("\n")}"}"
+      end
+    end
+  end
+  
+  class SQLLogger
+    class << self
+      attr_accessor :ignored_sql, :log, :log_all
+      def clear_log; self.log = []; self.log_all = []; end
+    end
+
+    self.clear_log
+
+    self.ignored_sql = [/^PRAGMA/i, /^SELECT currval/i, /^SELECT CAST/i, /^SELECT @@IDENTITY/i, /^SELECT @@ROWCOUNT/i, /^SAVEPOINT/i, /^ROLLBACK TO SAVEPOINT/i, /^RELEASE SAVEPOINT/i, /^SHOW max_identifier_length/i, /^BEGIN/i, /^COMMIT/i]
+
+    # FIXME: this needs to be refactored so specific database can add their own
+    # ignored SQL, or better yet, use a different notification for the queries
+    # instead examining the SQL content.
+    oracle_ignored     = [/^select .*nextval/i, /^SAVEPOINT/, /^ROLLBACK TO/, /^\s*select .* from all_triggers/im, /^\s*select .* from all_constraints/im, /^\s*select .* from all_tab_cols/im]
+    mysql_ignored      = [/^SHOW FULL TABLES/i, /^SHOW FULL FIELDS/, /^SHOW CREATE TABLE /i, /^SHOW VARIABLES /, /^\s*SELECT (?:column_name|table_name)\b.*\bFROM information_schema\.(?:key_column_usage|tables)\b/im]
+    postgresql_ignored = [/^\s*select\b.*\bfrom\b.*pg_namespace\b/im, /^\s*select tablename\b.*from pg_tables\b/im, /^\s*select\b.*\battname\b.*\bfrom\b.*\bpg_attribute\b/im, /^SHOW search_path/i]
+    sqlite3_ignored =    [/^\s*SELECT name\b.*\bFROM sqlite_master/im, /^\s*SELECT sql\b.*\bFROM sqlite_master/im]
+
+    [oracle_ignored, mysql_ignored, postgresql_ignored, sqlite3_ignored].each do |db_ignored_sql|
+      ignored_sql.concat db_ignored_sql
+    end
+
+    attr_reader :ignore
+
+    def initialize(ignore = Regexp.union(self.class.ignored_sql))
+      @ignore = ignore
+    end
+
+    def call(name, start, finish, message_id, values)
+      sql = values[:sql]
+
+      # FIXME: this seems bad. we should probably have a better way to indicate
+      # the query was cached
+      return if 'CACHE' == values[:name]
+
+      self.class.log_all << sql
+      unless ignore =~ sql
+        # if $debugging
+        # puts caller.select { |l| l.starts_with?(File.expand_path('../../lib', __FILE__)) }
+        # puts "\n\n"
+        # end
+      end
+      self.class.log << sql unless ignore =~ sql
+    end
+  end
+  ActiveSupport::Notifications.subscribe('sql.active_record', SQLLogger.new)
+
+  # test/unit backwards compatibility methods
+  alias :assert_raise :assert_raises
+  alias :assert_not_empty :refute_empty
+  alias :assert_not_equal :refute_equal
+  alias :assert_not_in_delta :refute_in_delta
+  alias :assert_not_in_epsilon :refute_in_epsilon
+  alias :assert_not_includes :refute_includes
+  alias :assert_not_instance_of :refute_instance_of
+  alias :assert_not_kind_of :refute_kind_of
+  alias :assert_no_match :refute_match
+  alias :assert_not_nil :refute_nil
+  alias :assert_not_operator :refute_operator
+  alias :assert_not_predicate :refute_predicate
+  alias :assert_not_respond_to :refute_respond_to
+  alias :assert_not_same :refute_same
+  
+end

data/test/typed_uuid_test.rb

@@ -0,0 +1,63 @@
+require 'test_helper'
+
+class FilterTest < ActiveSupport::TestCase
+
+  schema do
+    ActiveRecord::Base.register_uuid_types({
+      listings: 0,
+      buildings: 65_535
+    })
+    
+    create_table :listings, id: :typed_uuid do |t|
+      t.string   "name", limit: 255
+    end
+    
+    create_table :buildings, id: :typed_uuid do |t|
+      t.string   "name", limit: 255
+    end
+  end
+  
+  class Listing < ActiveRecord::Base
+  end
+  
+  class Building < ActiveRecord::Base
+  end
+
+  test 'adding primary key as a typed_uuid in a migration' do
+    ActiveRecord::Base.register_uuid_types({
+      properties: 1
+    })
+
+    exprexted_sql = <<-SQL
+      CREATE TABLE "properties" ("id" uuid DEFAULT typed_uuid('\\x1000') NOT NULL PRIMARY KEY, "name" character varying(255))
+    SQL
+
+    assert_sql exprexted_sql do
+      ActiveRecord::Migration.suppress_messages do
+        ActiveRecord::Migration.create_table :properties, id: :typed_uuid do |t|
+          t.string   "name",                    limit: 255
+        end
+      end
+    end
+  end
+
+  test 'class_from uuid' do
+    listing = Listing.create
+    building = Building.create
+    
+    assert_equal FilterTest::Listing, ::ActiveRecord::Base.class_from_uuid(listing.id)
+    assert_equal FilterTest::Building, ::ActiveRecord::Base.class_from_uuid(building.id)
+  end
+  
+  test 'uuid_type from table_name' do
+    assert_equal 0, ::ActiveRecord::Base.uuid_type_from_table_name(:listings)
+    assert_equal 0, ::ActiveRecord::Base.uuid_type_from_table_name('listings')
+    assert_equal 65_535, ::ActiveRecord::Base.uuid_type_from_table_name(:buildings)
+  end
+  
+  test 'class from uuid_type' do
+    assert_equal FilterTest::Listing, ::ActiveRecord::Base.class_from_uuid_type(0)
+    assert_equal FilterTest::Building, ::ActiveRecord::Base.class_from_uuid_type(65_535)
+  end
+  
+end

data/typed_uuid.gemspec

@@ -0,0 +1,31 @@
+require File.expand_path("../lib/typed_uuid/version", __FILE__)
+
+Gem::Specification.new do |s|
+  s.name        = "typed_uuid"
+  s.version     = TypedUUID::VERSION
+  s.authors     = ["Jon Bracy"]
+  s.email       = ["jonbracy@gmail.com"]
+  s.homepage    = "https://github.com/malomalo/typed_uuid"
+  s.summary     = %q{Typed UUIDs for ActiveRecord}
+  s.description = %q{Typed UUIDs 2 bytes are reserved in the UUID for the class enum}
+
+  s.files         = `git ls-files`.split("\n")
+  s.test_files    = `git ls-files -- {test,spec,features}/*`.split("\n")
+  s.executables   = `git ls-files -- bin/*`.split("\n").map{ |f| File.basename(f) }
+  s.require_paths = ["lib"]
+
+  # Developoment 
+  s.add_development_dependency 'rake'
+  s.add_development_dependency 'bundler'
+  s.add_development_dependency 'minitest'
+  s.add_development_dependency 'minitest-reporters'
+  s.add_development_dependency 'simplecov'
+  s.add_development_dependency 'mocha'
+  s.add_development_dependency 'byebug'
+  s.add_development_dependency 'activesupport', '>= 6.0.0'
+  s.add_development_dependency 'rails', '>= 6.0.0'
+  
+  # Runtime
+  s.add_runtime_dependency 'pg'
+  s.add_runtime_dependency 'activerecord', '>= 6.0.0'
+end

metadata

@@ -0,0 +1,214 @@
+--- !ruby/object:Gem::Specification
+name: typed_uuid
+version: !ruby/object:Gem::Version
+  version: '1.0'
+platform: ruby
+authors:
+- Jon Bracy
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2019-12-23 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: 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: bundler
+  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: minitest
+  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: minitest-reporters
+  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: simplecov
+  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: mocha
+  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: byebug
+  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: activesupport
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 6.0.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 6.0.0
+- !ruby/object:Gem::Dependency
+  name: rails
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 6.0.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 6.0.0
+- !ruby/object:Gem::Dependency
+  name: pg
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: activerecord
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 6.0.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 6.0.0
+description: Typed UUIDs 2 bytes are reserved in the UUID for the class enum
+email:
+- jonbracy@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".tm_properties"
+- Gemfile
+- Gemfile.lock
+- LICENSE
+- README.md
+- Rakefile
+- db/migrate/20191222234546_add_typed_uuid_function.rb
+- lib/typed_uuid.rb
+- lib/typed_uuid/active_record.rb
+- lib/typed_uuid/psql_column_methods.rb
+- lib/typed_uuid/railtie.rb
+- lib/typed_uuid/version.rb
+- test/test_helper.rb
+- test/typed_uuid_test.rb
+- typed_uuid.gemspec
+homepage: https://github.com/malomalo/typed_uuid
+licenses: []
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.0.3
+signing_key: 
+specification_version: 4
+summary: Typed UUIDs for ActiveRecord
+test_files:
+- test/test_helper.rb
+- test/typed_uuid_test.rb