Add a from_payload method (#37)

Author: hopsoft

lib/universalid/extensions/global_id/global_id_model.rb

@@ -14,14 +14,12 @@ def self.find(value)
     def initialize(universal_id)
       @uid = case universal_id
       when URI::UID then universal_id
-      when String
-        case universal_id
-        when /\A#{URI::UID::SCHEME}/o then URI::UID.parse(universal_id)
-        else URI::UID.parse(URI::UID.build_string(universal_id, self))
-        end
+      when String then URI::UID.match?(universal_id) ?
+        URI::UID.parse(universal_id) :
+        URI::UID.from_payload(universal_id)
       end
 
-      @id = @uid&.payload
+      @id = uid&.payload
     end
   end
 

lib/uri/uid.rb

@@ -9,6 +9,7 @@ class UID < ::URI::Generic
       VERSION = UniversalID::VERSION
       SCHEME = "uid"
       HOST = "universalid"
+      PATTERN = /\A#{SCHEME}:\/\/#{HOST}\/[-_0-9A-Z]+#[-_0-9A-Z]+\z/io
 
       class << self
         def encoder
@@ -29,6 +30,11 @@ def parse(value)
           new(*::URI.split(value))
         end
 
+        def match?(uri)
+          return true if uri.is_a?(self)
+          uri.to_s.match? PATTERN
+        end
+
         def build_string(payload, object = nil)
           "#{SCHEME}://#{HOST}/#{payload}##{fingerprint(object)}"
         end
@@ -38,6 +44,17 @@ def build(object, options = {}, &block)
           parse "#{SCHEME}://#{HOST}#{path}##{fingerprint(object)}"
         end
 
+        def from_payload(payload, object = nil)
+          parse(build_string(payload, object)).tap do |uid|
+            # NOTE: fingerprint mismatch can happen when building from a UID payload
+            #       ensure the fingerprint is correct
+            if uid&.valid? && URI::UID.fingerprint(uid.decode) != uid.fingerprint
+              remove_instance_variable :@decoded_fingerprint if instance_variable_defined?(:@decoded_fingerprint)
+              uid.instance_variable_set :@fragment, URI::UID.build(uid.decode).fingerprint
+            end
+          end
+        end
+
         def encode(object, options = {})
           return yield(object, options) if block_given?
           encoder.encode object, options
@@ -99,7 +116,7 @@ def payload
       end
 
       def fingerprint(decode: false)
-        return decode_fingerprint if decode
+        return @decoded_fingerprint ||= decode_fingerprint if decode
         fragment
       end
 
@@ -114,11 +131,14 @@ def invalid?
         !valid?
       end
 
-      def decode
+      def decode(force: false)
         return nil unless valid?
-        return yield(decode_payload, *decode_fingerprint) if block_given?
 
-        decode_payload
+        remove_instance_variable :@decoded if force && instance_variable_defined?(:@decoded)
+        return @decoded if defined?(@decoded)
+
+        @decoded ||= yield(decode_payload, *decode_fingerprint) if block_given?
+        @decoded ||= decode_payload
       end
 
       def deconstruct_keys(_keys)

test/test_extension.rb

@@ -121,7 +121,7 @@ def assert_record(expected, actual)
   end
 
   def self.scalars
-    {
+    @scalars ||= {
       bigdecimal: BigDecimal("123.45"),
       complex: Complex(1, 2),
       date: Date.today,

test/universalid/extensions/global_id/global_id_model_test.rb

@@ -0,0 +1,30 @@
+# frozen_string_literal: true
+
+class UniversalID::Packer::GlobalIDModelTest < Minitest::Test
+  def test_new_from_uid
+    uid = URI::UID.build(scalars)
+    model = UniversalID::Extensions::GlobalIDModel.new(uid)
+
+    assert_instance_of UniversalID::Extensions::GlobalIDModel, model
+    assert_equal uid, model.uid
+    assert_equal scalars, model.uid.decode
+  end
+
+  def test_new_from_uid_payload
+    uid = URI::UID.build(scalars)
+    model = UniversalID::Extensions::GlobalIDModel.new(uid.payload)
+
+    assert_instance_of UniversalID::Extensions::GlobalIDModel, model
+    assert_equal uid, model.uid
+    assert_equal scalars, model.uid.decode
+  end
+
+  def test_new_from_uri
+    uri = URI::UID.build(scalars).to_s
+    model = UniversalID::Extensions::GlobalIDModel.new(uri)
+
+    assert_instance_of UniversalID::Extensions::GlobalIDModel, model
+    assert_equal uri, model.uid.to_s
+    assert_equal scalars, model.uid.decode
+  end
+end

test/uri/uid/ruby_composites_test.rb

@@ -0,0 +1,10 @@
+# frozen_string_literal: true
+
+class URI::UIDTest < Minitest::Test
+  def test_from_payload
+    expected = scalars
+    payload = URI::UID.build(expected).payload
+    actual = URI::UID.from_payload(payload).decode
+    assert_equal expected, actual
+  end
+end