sourced-message 0.5.0 → 0.5.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: b8202b720a3a57bf15a429a136797186c2bc8bd2721a7539e2f08495e7078923
-  data.tar.gz: 6532b0db8f33fb6aa9ba4d585d5b0424fd089be4917e994f4a1abd341db132b4
+  metadata.gz: 5f851a99f35af7389e8aeaa9a62e174c9c76fe83c7123ccf245160672250534b
+  data.tar.gz: af633b34af3853e032e2b4735394dec70b03bcce4e19b1dacd54f80cf76382f3
 SHA512:
-  metadata.gz: ba7bafee643414f03b642074c521257fb731f663dc653d6ddedb3c6ca2d26304e727d7c719fac830d196aee3e1086aed22d126759c4671a3242fcc6c89fff5a8
-  data.tar.gz: 5f979cf196b3d6e0bc3b37ddc5b85f0a9284b1d8fad4a15a877ca835b18a747e49d9c1e5a5a0ad0b4acaaffe8b7bbb02411ee34f888445a30f6f3835c6eb267b
+  metadata.gz: 46637a045f56cd99c1ead9dba880d6d846a58106d7d8200c35606fc21d484f92514f310cad4fc1f3ea20298c9e356a875069a4c076c9a40c73a7cc7ebdc1be85
+  data.tar.gz: 83972e23b181caa04596cb6235a5fe0aec375bf6795967a12157c1b104c1b5e380c37a246afff29ce57c3fa909847ade958567b0b90ff1af2831c7c922353846

data/CHANGELOG.md

@@ -1,5 +1,14 @@
 ## [Unreleased]
 
+- `Message::Registry` raises `DuplicateTypeError` when two classes with different names
+  claim one type string, instead of silently replacing the registered class. Registering
+  a type again is still allowed when the names are equal (a code reloader redefining a
+  constant) or either class is anonymous (throwaway classes in specs; a constant in an
+  anonymous module counts as anonymous until the module is named). `.define`
+  registers a class before it's assigned to its constant, so the comparison waits until
+  the new class has a name: the next registration of the type, its lookup (`[]`,
+  `Message.from`, codec `decode`) or `#all` (codec `compile!`) raises.
+
 ## [0.5.0]
 
 - `Message#tags`: an envelope attribute (`Types::Tags`, Symbol keys and String values,

data/lib/sourced/message.rb

@@ -22,7 +22,7 @@ module Sourced
   # +Sourced::Message.registry[type]+ resolves a type registered under any
   # subclass. Resolve from this root to see the whole tree.
   class Message < Plumb::Types::Data
-    VERSION = '0.5.0'
+    VERSION = '0.5.1'
 
     EMPTY_ARRAY = [].freeze
 
@@ -54,6 +54,8 @@ module Sourced
     TagConflictError = Class.new(ArgumentError)
     # Raised by {#at} when a message would be scheduled in the past.
     PastMessageDateError = Class.new(ArgumentError)
+    # Raised by {Registry} when two classes with different names claim one type string.
+    DuplicateTypeError = Class.new(ArgumentError)
     LaxTime = Types::Time | Types::String.build(::Time, :parse).policy(:rescue, ::ArgumentError)
 
     attribute :id, Types::AutoUUID
@@ -68,11 +70,19 @@ module Sourced
     attribute :payload, Types::Static[nil]
 
     # Lookup table mapping type strings to message subclasses.
+    #
+    # Registering a type again replaces its class: a code reloader redefines a
+    # constant, and specs define throwaway anonymous messages reusing type
+    # strings. Two classes with different permanent names claiming one type are
+    # a bug, and raise {DuplicateTypeError}. {.define} registers a class before
+    # it's assigned to its constant, so the replaced class is kept until its
+    # successor has a name, and compared on the next registration or lookup.
     class Registry
       # @param message_class [Class] the root message class for this registry
       def initialize(message_class)
         @message_class = message_class
         @lookup = {}
+        @replaced = {}
       end
 
       # @return [Array<String>] registered type strings
@@ -85,7 +95,14 @@ module Sourced
       #
       # @param key [String] message type string
       # @param klass [Class] message subclass
+      # @raise [DuplicateTypeError] if a class with a different name holds the type
       def []=(key, klass)
+        check!(key)
+        previous = @lookup[key]
+        if previous && named(previous) && !previous.equal?(klass)
+          duplicate!(key, previous, klass) if named(klass) && named(klass) != named(previous)
+          @replaced[key] = previous unless named(klass)
+        end
         @lookup[key] = klass
       end
 
@@ -94,7 +111,9 @@ module Sourced
       #
       # @param key [String] message type string
       # @return [Class, nil]
+      # @raise [DuplicateTypeError] if a class with a different name holds the type
       def [](key)
+        check!(key) unless @replaced.empty?
         klass = lookup[key]
         return klass if klass
 
@@ -109,9 +128,11 @@ module Sourced
       #
       # @return [Enumerator<Class>] if no block given
       # @yield [Class] each registered message class
+      # @raise [DuplicateTypeError] if a class with a different name holds a type
       def all(&block)
         return enum_for(:all) unless block
 
+        @replaced.keys.each { |key| check!(key) }
         lookup.each_value(&block)
         subclasses.each { |c| c.registry.all(&block) }
       end
@@ -119,6 +140,29 @@ module Sourced
       private
 
       attr_reader :lookup, :message_class
+
+      # Compare the class a type replaced with the one holding it, once the latter has a name.
+      def check!(key)
+        replaced = @replaced[key]
+        return unless replaced
+
+        current = @lookup[key]
+        return unless named(current)
+
+        @replaced.delete(key)
+        duplicate!(key, replaced, current) unless named(current) == named(replaced)
+      end
+
+      # A class's permanent name. A constant set in an anonymous module has a
+      # temporary one (+"#<Class:0x...>::Foo"+) until the module is named.
+      def named(klass)
+        name = klass.name
+        name unless name.nil? || name.start_with?('#<')
+      end
+
+      def duplicate!(key, registered, klass)
+        raise DuplicateTypeError, "message type #{key.inspect} is claimed by both #{registered.name} and #{klass.name}"
+      end
     end
 
     # @return [Registry] the message type registry for this class

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: sourced-message
 version: !ruby/object:Gem::Version
-  version: 0.5.0
+  version: 0.5.1
 platform: ruby
 authors:
 - Ismael Celis