rails_type_id 0.2.0 → 0.4.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: c0781fbf1b175f2edfe7b66fc82d03d09f08762d084cfc4e0681831d39d6f90b
-  data.tar.gz: 162be97b603d6b6480dcf27461bcf19541f43b30a5c65fcab5b1b46de1c04bd4
+  metadata.gz: baa657bbbdd396f057fdc5480b2b2dc873cfb07b411304bbfbd27e0b6c58d5e4
+  data.tar.gz: 5950890d9a9d3399be3076602c103b4f4a5d03c38aea144e57e145d615507de9
 SHA512:
-  metadata.gz: 7a2d68e71437f6c62f2c183aaf749a4fddfba9ea61c6708f66c433dfa708ebfd2218ea2bfc74d05b1349cf2f65bbe1cc55b6434688cb5a6d2cb4c7defe823b94
-  data.tar.gz: bbd6f63fd939e57f0dbb46280e249f1d2ed8a929aeb9f1541e49c732bd742b7f81f624a4bf6ed51ca399fe733064a2d58e1a8fbc4778796e1f89915fdeb4c59f
+  metadata.gz: 0161ab95f16f8ee6a66973cb7ba72ab0b6b64cc4d0ce929feb6984d7974adad1e33ed70f0e4f91431fd435627d2a565359958728d1e17bd9deaae758d8011bc5
+  data.tar.gz: 130a375af749c03edca9dc240aa287f627630c041fe573a33de7bc81f8efaf63b59dfdacef5a6a2586bd811af8da778569a7bde395790401fb9de4291d1cd327

data/README.md

@@ -59,7 +59,7 @@ class MigrateUserToUUID < ActiveRecord::Migration[8.0]
         add_column :sessions, :user_uuid, :text, null: true
 
         Users.find_each do |u|
-            u.update(uuid: SecureRandom.uuid_v7)
+            u.update(uuid: RailsTypeId::Concern::Helpers.generate_type_id("user"))
         end
         Session.find_each do |s|
             s.update(user_uuid: s.user.uuid)

data/lib/rails_type_id/concern.rb

@@ -13,8 +13,6 @@ module RailsTypeId
     extend ::ActiveSupport::Concern
     include ::ActiveModel::Validations::Callbacks
 
-    class InvalidTypeIdPrefix < StandardError; end
-
     # Checks validity of the ActiveRecord model instances
     class Validator < ActiveModel::Validator
       def validate(record)
@@ -31,7 +29,9 @@ module RailsTypeId
       end
 
       def type_id_prefix
-        @_type_id_prefix
+        @_type_id_prefix ||
+          # Handle inheritance by bubbling up if type_id_prefix defined on superclass
+          (superclass.type_id_prefix if superclass.respond_to?(:type_id_prefix))
       end
 
       def from_controller_id_param(type_id_str)
@@ -56,57 +56,7 @@ module RailsTypeId
       # @return [void]
       define_method :generate_type_id do
         Helpers.validate_type_id_prefix!(self.class.type_id_prefix)
-        self.id ||= TypeID.from_uuid(self.class.type_id_prefix, SecureRandom.uuid_v7).to_s
-      end
-    end
-
-    # Internal helper methods
-    class Helpers
-      extend T::Sig
-
-      class << self
-        def validate_type_id_prefix(prefix)
-          return "type_id_prefix cannot be nil" if prefix.nil?
-
-          return nil if prefix.match(/\A[a-z]{1,10}\z/)
-
-          "type_id_prefix must be lowercase alphabetic (a-z) with length >= 1, <= 10"
-        end
-
-        def validate_type_id_prefix!(prefix)
-          result = validate_type_id_prefix(prefix)
-          raise InvalidTypeIdPrefix, result if result.present?
-        end
-
-        def lookup_type_id(type_id)
-          klasses = lookup_model(type_id)
-          return if klasses.nil?
-
-          klasses.each do |klass|
-            result = klass.find_by(id: type_id)
-            return result unless result.nil?
-          end
-
-          nil
-        end
-
-        def lookup_model(type_id)
-          prefix = TypeID.from_string(type_id).prefix
-          return if prefix.nil?
-
-          prefix_map[prefix]
-        end
-
-        private
-
-        def prefix_map
-          Rails.application.eager_load!
-          # This has to be group_by and not index_by because we can have multiple
-          # models that use the same prefix (like Settings)
-          @prefix_map ||= ActiveRecord::Base.descendants
-                                            .select { |klass| klass.respond_to?(:type_id_prefix) }
-                                            .group_by(&:type_id_prefix)
-        end
+        self.id ||= Helpers.generate_type_id(self.class.type_id_prefix).to_s
       end
     end
   end

data/lib/rails_type_id/helpers.rb

@@ -0,0 +1,71 @@
+# typed: strict
+# frozen_string_literal: true
+
+require "sorbet-runtime"
+
+module RailsTypeId
+  class InvalidTypeIdPrefix < StandardError; end
+
+  # Helper methods for interacting with type IDs
+  class Helpers
+    class << self
+      extend T::Sig
+
+      sig { params(prefix: String).returns(TypeID) }
+      def generate_type_id(prefix)
+        TypeID.from_uuid(prefix, SecureRandom.uuid_v7)
+      end
+
+      sig { params(prefix: T.nilable(String)).returns(T.nilable(String)) }
+      def validate_type_id_prefix(prefix)
+        return "type_id_prefix cannot be nil" if prefix.nil?
+
+        return nil if prefix.match(/\A[a-z]{1,10}\z/)
+
+        "type_id_prefix must be lowercase alphabetic (a-z) with length >= 1, <= 10"
+      end
+
+      sig { params(prefix: T.nilable(String)).void }
+      def validate_type_id_prefix!(prefix)
+        result = validate_type_id_prefix(prefix)
+        raise InvalidTypeIdPrefix, result if result.present?
+      end
+
+      sig { params(type_id: String).returns(T.nilable(ActiveRecord::Base)) }
+      def lookup_type_id(type_id)
+        klasses = lookup_model(type_id)
+        return if klasses.nil?
+
+        klasses.each do |klass|
+          result = klass.find_by(id: type_id)
+          return result unless result.nil?
+        end
+
+        nil
+      end
+
+      sig { params(type_id: String).returns(T.nilable(T::Array[T.untyped])) }
+      def lookup_model(type_id)
+        prefix = TypeID.from_string(type_id).prefix
+        return if prefix.nil?
+
+        prefix_map[prefix]
+      end
+
+      private
+
+      sig { returns(T::Hash[String, T::Array[T.untyped]]) }
+      def prefix_map
+        Rails.application.eager_load!
+        # This has to be group_by and not index_by because we can have multiple
+        # models that use the same prefix (like Settings)
+        @prefix_map ||= T.let(
+          ActiveRecord::Base.descendants
+            .select { |klass| klass.respond_to?(:type_id_prefix) }
+            .group_by(&:type_id_prefix),
+          T.nilable(T::Hash[String, T::Array[T.untyped]])
+        )
+      end
+    end
+  end
+end

data/lib/rails_type_id/require.rb

@@ -2,5 +2,6 @@
 # frozen_string_literal: true
 
 require_relative "version"
+require_relative "helpers"
 require_relative "concern"
 require_relative "test_helper"

data/lib/rails_type_id/version.rb

@@ -2,5 +2,5 @@
 # frozen_string_literal: true
 
 module RailsTypeId
-  VERSION = "0.2.0"
+  VERSION = "0.4.0"
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: rails_type_id
 version: !ruby/object:Gem::Version
-  version: 0.2.0
+  version: 0.4.0
 platform: ruby
 authors:
 - Franklin Hu
@@ -66,6 +66,7 @@ files:
 - Rakefile
 - lib/rails_type_id.rb
 - lib/rails_type_id/concern.rb
+- lib/rails_type_id/helpers.rb
 - lib/rails_type_id/require.rb
 - lib/rails_type_id/test_helper.rb
 - lib/rails_type_id/version.rb