Enable setting Model.global_id_column

This allows overriding the column used to define GIDs

Author: tylerwillingham

lib/global_id/global_id.rb

@@ -11,6 +11,7 @@ class << self
     def create(model, options = {})
       if app = options.fetch(:app) { GlobalID.app }
         params = options.except(:app, :verifier, :for)
+        params[:global_id_column] ||= model.global_id_column
         new URI::GID.create(app, model, params), options
       else
         raise ArgumentError, 'An app is required to create a GlobalID. ' \

lib/global_id/identification.rb

@@ -26,6 +26,19 @@ class GlobalID
   #   GlobalID::Locator.locate person_gid
   #   # => #<Person:0x007fae94bf6298 @id="1">
   module Identification
+    def self.included(base)
+      base.extend(ClassMethods)
+    end
+
+    module ClassMethods
+      def global_id_column(column_name = nil)
+        @global_id_column ||= column_name
+      end
+    end
+
+    def global_id_column
+      self.class.global_id_column || self.class.try(:primary_key) || :id
+    end
 
     # Returns the Global ID of the model.
     #

lib/global_id/uri/gid.rb

@@ -72,8 +72,11 @@ def parse(uri)
       #
       #   URI::GID.create('bcx', Person.find(5), database: 'superhumans')
       def create(app, model, params = nil)
-        model_id_method = if params.is_a?(Hash) && (model_id_key = params.delete(:model_id_key))
-                            model_id_key
+        global_id_column = params&.delete(:global_id_column)
+        model_id_method = if model.id.is_a?(Array)
+                            :id
+                          else
+                            global_id_column
                           end || :id
 
         build app: app, model_name: model.class.name, model_id: model.send(model_id_method), params: params

test/cases/global_id_test.rb

@@ -45,6 +45,8 @@ class GlobalIDCreationTest < ActiveSupport::TestCase
     @person_namespaced_gid = GlobalID.create(Person::Child.new(4))
     @person_model_gid = GlobalID.create(PersonModel.new(id: 1))
     @cpk_model_gid = GlobalID.create(CompositePrimaryKeyModel.new(id: ["tenant-key-value", "id-value"]))
+    @ckm_model = ConfigurableKeyModel.new(id: "id-value", external_id: "external-id-value")
+    @ckm_model_gid = GlobalID.create(@ckm_model)
   end
 
   test 'find' do
@@ -53,13 +55,15 @@ class GlobalIDCreationTest < ActiveSupport::TestCase
     assert_equal Person::Child.find(@person_namespaced_gid.model_id), @person_namespaced_gid.find
     assert_equal PersonModel.find(@person_model_gid.model_id), @person_model_gid.find
     assert_equal CompositePrimaryKeyModel.find(@cpk_model_gid.model_id), @cpk_model_gid.find
+    assert_equal ConfigurableKeyModel.find(@ckm_model_gid.model_id), @ckm_model_gid.find
   end
 
   test 'find with class' do
     assert_equal Person.find(@person_gid.model_id), @person_gid.find(only: Person)
     assert_equal Person.find(@person_uuid_gid.model_id), @person_uuid_gid.find(only: Person)
     assert_equal PersonModel.find(@person_model_gid.model_id), @person_model_gid.find(only: PersonModel)
     assert_equal CompositePrimaryKeyModel.find(@cpk_model_gid.model_id), @cpk_model_gid.find(only: CompositePrimaryKeyModel)
+    assert_equal ConfigurableKeyModel.find(@ckm_model_gid.model_id), @ckm_model_gid.find(only: ConfigurableKeyModel)
   end
 
   test 'find with class no match' do
@@ -68,6 +72,7 @@ class GlobalIDCreationTest < ActiveSupport::TestCase
     assert_nil @person_namespaced_gid.find(only: String)
     assert_nil @person_model_gid.find(only: Float)
     assert_nil @cpk_model_gid.find(only: Hash)
+    assert_nil @ckm_model_gid.find(only: Hash)
   end
 
   test 'find with subclass' do
@@ -140,6 +145,7 @@ class GlobalIDCreationTest < ActiveSupport::TestCase
     assert_equal 'gid://bcx/Person::Child/4', @person_namespaced_gid.to_s
     assert_equal 'gid://bcx/PersonModel/1', @person_model_gid.to_s
     assert_equal 'gid://bcx/CompositePrimaryKeyModel/tenant-key-value/id-value', @cpk_model_gid.to_s
+    assert_equal 'gid://bcx/ConfigurableKeyModel/external-id-value', @ckm_model_gid.to_s
   end
 
   test 'as param' do
@@ -166,6 +172,7 @@ class GlobalIDCreationTest < ActiveSupport::TestCase
     assert_equal URI('gid://bcx/Person::Child/4'), @person_namespaced_gid.uri
     assert_equal URI('gid://bcx/PersonModel/1'), @person_model_gid.uri
     assert_equal URI('gid://bcx/CompositePrimaryKeyModel/tenant-key-value/id-value'), @cpk_model_gid.uri
+    assert_equal URI('gid://bcx/ConfigurableKeyModel/external-id-value'), @ckm_model_gid.uri
   end
 
   test 'as JSON' do
@@ -183,6 +190,9 @@ class GlobalIDCreationTest < ActiveSupport::TestCase
 
     assert_equal 'gid://bcx/CompositePrimaryKeyModel/tenant-key-value/id-value', @cpk_model_gid.as_json
     assert_equal '"gid://bcx/CompositePrimaryKeyModel/tenant-key-value/id-value"', @cpk_model_gid.to_json
+
+    assert_equal 'gid://bcx/ConfigurableKeyModel/external-id-value', @ckm_model_gid.as_json
+    assert_equal '"gid://bcx/ConfigurableKeyModel/external-id-value"', @ckm_model_gid.to_json
   end
 
   test 'model id' do
@@ -191,6 +201,7 @@ class GlobalIDCreationTest < ActiveSupport::TestCase
     assert_equal '4', @person_namespaced_gid.model_id
     assert_equal '1', @person_model_gid.model_id
     assert_equal ['tenant-key-value', 'id-value'], @cpk_model_gid.model_id
+    assert_equal 'external-id-value', @ckm_model_gid.model_id
   end
 
   test 'model name' do
@@ -199,6 +210,7 @@ class GlobalIDCreationTest < ActiveSupport::TestCase
     assert_equal 'Person::Child', @person_namespaced_gid.model_name
     assert_equal 'PersonModel', @person_model_gid.model_name
     assert_equal 'CompositePrimaryKeyModel', @cpk_model_gid.model_name
+    assert_equal 'ConfigurableKeyModel', @ckm_model_gid.model_name
   end
 
   test 'model class' do
@@ -207,6 +219,7 @@ class GlobalIDCreationTest < ActiveSupport::TestCase
     assert_equal Person::Child, @person_namespaced_gid.model_class
     assert_equal PersonModel, @person_model_gid.model_class
     assert_equal CompositePrimaryKeyModel, @cpk_model_gid.model_class
+    assert_equal ConfigurableKeyModel, @ckm_model_gid.model_class
     assert_raise ArgumentError do
       GlobalID.find 'gid://bcx/SignedGlobalID/5'
     end

test/cases/uri_gid_test.rb

@@ -46,7 +46,7 @@ class URI::GIDTest <  ActiveSupport::TestCase
 
   test 'create from a configurable key model' do
     model = ConfigurableKeyModel.new(id: 'id-value', external_id: 'external-id-123')
-    assert_equal @ckm_gid_string, URI::GID.create('bcx', model, model_id_key: :external_id).to_s
+    assert_equal @ckm_gid_string, URI::GID.create('bcx', model, global_id_column: :external_id).to_s
   end
 
   test 'build' do

test/models/configurable_key_model.rb

@@ -6,7 +6,19 @@ class ConfigurableKeyModel
 
   attr_accessor :id, :external_id
 
-  def self.primary_key
-    :id
+  global_id_column :external_id
+
+  class << self
+    def primary_key
+      :id
+    end
+
+    def find(external_id)
+      new external_id: external_id, id: "id-value"
+    end
+  end
+
+  def ==(other)
+    external_id == other.try(:external_id)
   end
 end

test/models/person.rb

@@ -41,6 +41,10 @@ class PersonUuid < Person
   def self.primary_key
     :uuid
   end
+
+  def uuid
+    id
+  end
 end
 
 class Person::Scoped < Person