evt-messaging 2.5.8.1 → 2.7.0.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: ccafb945cdd024a0fa0d3b90b2bb197973f0a6111f778657e2c8dcc7514e944f
-  data.tar.gz: 64be2ec439b541414bd50e9d0ad2490cb6069d9e617bd12d8f44b5dad8231f64
+  metadata.gz: 9c8945f49315d73d29f7c3a3fa6d88bfca5c8eeb2dcd8fd5e34f2b5020881ef4
+  data.tar.gz: 77bfd0a23528e8624e74ca29a0a590892ce29d64571a9e75aeca7ed5247def60
 SHA512:
-  metadata.gz: 13a6e341c068157a89e0e3336afd19c3518149bc766bcfca8b73fc72d74a97948854838b5e35d9ba9adb127e660ef679ada4f1b4d928d7bb08307f816f3cfbac
-  data.tar.gz: c017e5d29247eb7601db7828574f03348429e38f51cd69c7c65dbf394723b9f5ca592d68589bcb1782055c6fa9562d6be5602fa91bf6834e0de8296b705c16d3
+  metadata.gz: dbf96b8c14e18786fec12e942b075276b31ded1b1d1c1b7a9e062564d7923f8dbc4e5e1884d7bb935bed784a57f58c2c8bed7e752265643c12f9b462e685d095
+  data.tar.gz: 8b5ca6436050e0938f58bf081a8369f6fadb5181aed72875b0a0b3c3fa2decc8042336fcb396a175e77f016a56bdd3e70bc2f767f4e518b2274cb197c6e9621d

data/lib/messaging/controls/handler.rb

@@ -60,63 +60,6 @@ module Messaging
           end
         end
       end
-
-      module SessionArgument
-        class Example
-          include Messaging::Handle
-
-          attr_accessor :session
-
-          def configure(session: nil)
-            self.session = session
-          end
-        end
-
-        module Anomaly
-          module Required
-            class Example
-              include Messaging::Handle
-
-              def configure(session:)
-              end
-            end
-          end
-
-          module Positional
-            class Example
-              include Messaging::Handle
-
-              def configure(session)
-              end
-            end
-
-            module Optional
-              class Example
-                include Messaging::Handle
-
-                def configure(session=nil)
-                end
-              end
-            end
-          end
-        end
-      end
-
-      module Settings
-        Error = Class.new(RuntimeError)
-
-        class Example
-          include Messaging::Handle
-
-          setting :some_setting
-
-          attr_accessor :some_other_setting
-
-          def handle(message_data)
-            raise Settings::Error if some_setting.nil?
-          end
-        end
-      end
     end
   end
 end

data/lib/messaging/controls/local_properties.rb

@@ -0,0 +1,39 @@
+module Messaging
+  module Controls
+    module LocalProperties
+      def self.example
+        {
+          SomeLocalProperty.name => SomeLocalProperty.value
+        }
+      end
+
+      module SomeLocalProperty
+        def self.name
+          :some_local_property
+        end
+
+        def self.value
+          'some local property value'
+        end
+      end
+
+      module Random
+        def self.example
+          {
+            SomeLocalProperty.name => SomeLocalProperty.value
+          }
+        end
+
+        module SomeLocalProperty
+          def self.name
+            :some_local_property
+          end
+
+          def self.value
+            SecureRandom.hex
+          end
+        end
+      end
+    end
+  end
+end

data/lib/messaging/controls/metadata.rb

@@ -4,9 +4,8 @@ module Messaging
       def self.example
         data = self.data
 
-        ## Remove this once Metadata can be built
-        ## from Raw data (Scott, Fri Feb 5 20201)
-        data[:properties] = Properties.example
+        data[:properties] = properties
+        data[:local_properties] = local_properties
 
         Messaging::Message::Metadata.build(data)
       end
@@ -63,6 +62,14 @@ module Messaging
         Time::Raw.example
       end
 
+      def self.properties
+        Properties.example
+      end
+
+      def self.local_properties
+        LocalProperties.example
+      end
+
       def self.data
         {
           stream_name: stream_name,
@@ -77,7 +84,8 @@ module Messaging
 
           reply_stream_name: reply_stream_name,
 
-          properties: Properties.data,
+          properties: Properties.example,
+          local_properties: LocalProperties.example,
 
           time: time,
 
@@ -110,6 +118,11 @@ module Messaging
 
       module Random
         def self.example
+          data = self.data
+
+          data[:properties] = properties
+          data[:local_properties] = local_properties
+
           Messaging::Message::Metadata.build(data)
         end
 
@@ -161,10 +174,19 @@ module Messaging
           (::Time.now + Controls::Random::Number.example).utc
         end
 
+        def self.properties
+          Properties::Random.example
+        end
+
+        def self.local_properties
+          LocalProperties::Random.example
+        end
+
         def self.data
           {
             stream_name: stream_name,
             position: position,
+            global_position: global_position,
 
             causation_message_stream_name: causation_message_stream_name,
             causation_message_position: causation_message_position,
@@ -174,7 +196,9 @@ module Messaging
 
             reply_stream_name: reply_stream_name,
 
-            global_position: global_position,
+            properties: Properties::Random.example,
+            local_properties: LocalProperties::Random.example,
+
             time: time,
 
             schema_version: schema_version

data/lib/messaging/controls/properties.rb

@@ -2,33 +2,14 @@ module Messaging
   module Controls
     module Properties
       def self.example
-        [
-          SomeProperty.example,
-          SomeLocalProperty.example
-        ]
-      end
-
-      def self.data
-        [
-          SomeProperty.data,
-          SomeLocalProperty.data
-        ]
+        {
+          SomeProperty.name => SomeProperty.value
+        }
       end
 
       module SomeProperty
-        def self.example
-          Messaging::Message::Metadata::Property.new(name, value)
-        end
-
-        def self.data
-          {
-            name: name,
-            value: value
-          }
-        end
-
         def self.name
-          'some_property'
+          :some_property
         end
 
         def self.value
@@ -36,25 +17,21 @@ module Messaging
         end
       end
 
-      module SomeLocalProperty
+      module Random
         def self.example
-          Messaging::Message::Metadata::Property.new(name, value, true)
-        end
-
-        def self.data
           {
-            name: name,
-            value: value,
-            local: true
+            SomeProperty.name => SomeProperty.value
           }
         end
 
-        def self.name
-          'some_local_property'
-        end
+        module SomeProperty
+          def self.name
+            :some_property
+          end
 
-        def self.value
-          'some local property value'
+          def self.value
+            SecureRandom.hex
+          end
         end
       end
     end

data/lib/messaging/controls.rb

@@ -8,6 +8,7 @@ require 'messaging/controls/time'
 require 'messaging/controls/id'
 require 'messaging/controls/stream_name'
 require 'messaging/controls/properties'
+require 'messaging/controls/local_properties'
 require 'messaging/controls/metadata'
 require 'messaging/controls/message_data'
 require 'messaging/controls/message'

data/lib/messaging/handle.rb

@@ -6,7 +6,6 @@ module Messaging
       cls.class_exec do
         include Dependency
         include Virtual
-        include Settings::Setting
 
         def handler_logger
           @handler_logger ||= Log.get(self)
@@ -26,37 +25,49 @@ module Messaging
     end
 
     module Build
+      Error = Class.new(RuntimeError)
+
       def build(strict: nil, session: nil, settings: nil)
         instance = new
         instance.strict = strict
 
-        if not settings.nil?
-          settings.set(instance)
+        arguments = {}
+
+        if Build.send_session?(session, instance)
+          arguments[:session] = session
         end
 
-        if Build.configure_session?(instance)
-          instance.configure(session: session)
-        else
-          instance.configure
+        if Build.send_settings?(settings, instance)
+          arguments[:settings] = settings
         end
 
+        instance.configure(**arguments)
+
         instance
       end
 
-      def self.configure_session?(instance)
+      def self.send_session?(session, instance)
+        configure?(instance, :session) && !session.nil?
+      end
+
+      def self.send_settings?(settings, instance)
+        configure?(instance, :settings) && !settings.nil?
+      end
+
+      def self.configure?(instance, parameter_name)
         configure_method = instance.method(:configure)
 
         parameter_type, _ = configure_method.parameters.find do |type, name|
-          name == :session
+          name == parameter_name
         end
 
         return false if parameter_type.nil?
 
-        return true if parameter_type == :key
+        return true if [:key, :keyreq].include?(parameter_type)
 
-        error_message = "Optional session parameter of configure is not a keyword argument (Type: #{parameter_type.inspect})"
+        error_message = "Incorrect definition of handler's configure method. The #{parameter_name} parameter must be a keyword argument (Handler: #{instance.class}, Parameter Type: #{parameter_type.inspect})"
         handler_logger.error(tag: :handle) { error_message }
-        raise ArgumentError, error_message
+        raise Error, error_message
       end
 
       def self.handler_logger
@@ -75,20 +86,20 @@ module Messaging
       extend self
 
       def handler(message_or_message_data)
-        name = handler_name(message_or_message_data)
+        handler_method_name = handler_method_name(message_or_message_data)
 
-        if method_defined?(name)
-          return name
+        if method_defined?(handler_method_name)
+          return handler_method_name
         else
           return nil
         end
       end
 
       def handles?(message_or_message_data)
-        method_defined? handler_name(message_or_message_data)
+        method_defined? handler_method_name(message_or_message_data)
       end
 
-      def handler_name(message_or_message_data)
+      def handler_method_name(message_or_message_data)
         name = nil
 
         if message_or_message_data.is_a? MessageStore::MessageData::Read
@@ -99,7 +110,7 @@ module Messaging
           name = message_or_message_data.message_name
         end
 
-        "handle_#{name}"
+        "handle_#{name}".to_sym
       end
     end
 
@@ -111,13 +122,16 @@ module Messaging
       end
 
       def handle_macro(message_class, &blk)
-        define_handler_method(message_class, &blk)
+        handler_method_name = define_handler_method(message_class, &blk)
+
         message_registry.register(message_class)
+
+        handler_method_name
       end
       alias :handle :handle_macro
 
       def define_handler_method(message_class, &blk)
-        handler_method_name = handler_name(message_class)
+        handler_method_name = handler_method_name(message_class)
 
         if blk.nil?
           error_msg = "Handler for #{message_class.name} is not correctly defined. It must have a block."

data/lib/messaging/message/copy.rb

@@ -32,13 +32,12 @@ module Messaging
         end
 
         if metadata
-          metadata_include = source.metadata.class.attribute_names - [:properties]
+          metadata_include = source.metadata.class.attribute_names - [:properties, :local_properties]
 
           SetAttributes.(receiver.metadata, source.metadata, include: metadata_include)
 
-          source.metadata.properties.each do |property|
-            receiver.metadata.properties << property.dup
-          end
+          receiver.metadata.properties = source.metadata.properties.dup
+          receiver.metadata.local_properties = source.metadata.local_properties.dup
         end
 
         receiver

data/lib/messaging/message/metadata.rb

@@ -33,7 +33,8 @@ module Messaging
 
       attribute :reply_stream_name, String
 
-      attribute :properties, Array, default: -> { Array.new }
+      attribute :properties, Hash, default: -> { Hash.new }
+      attribute :local_properties, Hash, default: -> { Hash.new }
 
       attribute :time, Time
 
@@ -60,12 +61,8 @@ module Messaging
 
         self.reply_stream_name = preceding_metadata.reply_stream_name
 
-        preceding_metadata.properties.each do |property|
-          if property.local?
-            next
-          end
-
-          properties << property.dup
+        preceding_metadata.properties.each do |name, value|
+          properties[name] = value
         end
       end
 
@@ -136,49 +133,64 @@ module Messaging
       end
       alias :correlates? :correlated?
 
-      def set_property(name, value, local: nil)
-        if not name.is_a?(String)
-          raise Error, "Property name must be a string: #{name.inspect}"
+      def set_property(name, value)
+        if not name.is_a?(Symbol)
+          raise Error, "Property name must be a symbol: #{name.inspect}"
         end
 
-        local ||= false
+        properties[name] = value
 
-        delete_property(name)
+        value
+      end
+
+      def get_property(name)
+        if not name.is_a?(Symbol)
+          raise Error, "Property name must be a symbol: #{name.inspect}"
+        end
 
-        property = Property.new(name, value, local)
+        properties[name]
+      end
 
-        properties << property
+      def delete_property(name)
+        if not name.is_a?(Symbol)
+          raise Error, "Property name must be a symbol: #{name.inspect}"
+        end
 
-        property
+        properties.delete(name)
       end
 
-      def set_local_property(name, value)
-        set_property(name, value, local: true)
+      def clear_properties
+        properties.clear
       end
 
-      def get_property(name)
-        if not name.is_a?(String)
-          raise Error, "Property name must be a string: #{name.inspect}"
+      def set_local_property(name, value)
+        if not name.is_a?(Symbol)
+          raise Error, "Local property name must be a symbol: #{name.inspect}"
         end
 
-        property = properties.find { |property| property.name == name }
-        property&.value
+        local_properties[name] = value
+
+        value
       end
 
-      def delete_property(name)
-        if not name.is_a?(String)
-          raise Error, "Property name must be a string: #{name.inspect}"
+      def get_local_property(name)
+        if not name.is_a?(Symbol)
+          raise Error, "Local property name must be a symbol: #{name.inspect}"
         end
 
-        i = properties.index { |property| property.name == name }
+        local_properties[name]
+      end
 
-        return nil if i.nil?
+      def delete_local_property(name)
+        if not name.is_a?(Symbol)
+          raise Error, "Local property name must be a symbol: #{name.inspect}"
+        end
 
-        properties.delete_at(i).value
+        local_properties.delete(name)
       end
 
-      def clear_properties
-        properties.clear
+      def clear_local_properties
+        local_properties.clear
       end
 
       def self.source_attribute_names

data/lib/messaging/message/transform.rb

@@ -26,12 +26,12 @@ module Messaging
 
           metadata = message.metadata.to_h
 
-          properties = metadata[:properties]
-
-          if properties.empty?
+          if metadata[:properties].empty?
             metadata.delete(:properties)
-          else
-            metadata[:properties] = Properties.write(properties)
+          end
+
+          if metadata[:local_properties].empty?
+            metadata.delete(:local_properties)
           end
 
           metadata.delete_if { |k, v| v.nil? }
@@ -41,28 +41,13 @@ module Messaging
           message_data
         end
 
-        module Properties
-          def self.write(properties)
-            properties.map do |property|
-              property_hash = property.to_h
-
-              if not property_hash[:local]
-                property_hash.delete(:local)
-              end
-
-              property_hash
-            end
-          end
-        end
-
         def self.read(message_data)
           data = message_data.to_h
 
-## TODO change to positive "if"
-          unless data[:metadata].nil?
-            data[:metadata] = data[:metadata].clone
-          else
+          if data[:metadata].nil?
             data[:metadata] = {}
+          else
+            data[:metadata] = data[:metadata].clone
           end
 
           metadata = data[:metadata]
@@ -73,15 +58,8 @@ module Messaging
           metadata[:global_position] = data[:global_position]
           metadata[:time] = data[:time]
 
-          if metadata[:properties].nil?
-            metadata[:properties] = []
-          end
-
-          properties = metadata[:properties].map do |property_data|
-            Metadata::Property.new(*property_data.values_at(*Metadata::Property.members))
-          end
-
-          metadata[:properties] = properties
+          metadata[:properties] ||= {}
+          metadata[:local_properties] ||= {}
 
           data
         end

data/lib/messaging.rb

@@ -7,7 +7,6 @@ require 'messaging/stream_name'
 
 require 'messaging/message'
 require 'messaging/message/metadata'
-require 'messaging/message/metadata/property'
 require 'messaging/message/copy'
 require 'messaging/message/follow'
 require 'messaging/message/sequence_accessor'

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: evt-messaging
 version: !ruby/object:Gem::Version
-  version: 2.5.8.1
+  version: 2.7.0.1
 platform: ruby
 authors:
 - The Eventide Project
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2021-02-09 00:00:00.000000000 Z
+date: 2022-09-12 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: evt-message_store
@@ -64,6 +64,7 @@ files:
 - lib/messaging/controls/batch.rb
 - lib/messaging/controls/handler.rb
 - lib/messaging/controls/id.rb
+- lib/messaging/controls/local_properties.rb
 - lib/messaging/controls/message.rb
 - lib/messaging/controls/message_data.rb
 - lib/messaging/controls/metadata.rb
@@ -82,7 +83,6 @@ files:
 - lib/messaging/message/follow.rb
 - lib/messaging/message/import.rb
 - lib/messaging/message/metadata.rb
-- lib/messaging/message/metadata/property.rb
 - lib/messaging/message/sequence_accessor.rb
 - lib/messaging/message/transform.rb
 - lib/messaging/message_registry.rb
@@ -108,7 +108,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.1.2
+rubygems_version: 3.3.3
 signing_key:
 specification_version: 4
 summary: Common primitives for platform-specific messaging implementations for Eventide

data/lib/messaging/message/metadata/property.rb

@@ -1,22 +0,0 @@
-module Messaging
-  module Message
-    class Metadata
-      Property = Struct.new(
-        :name,
-        :value,
-        :local
-      ) do
-        def local?
-          local == true
-        end
-
-        def ==(other)
-          equal =
-            name == other.name &&
-            value == other.value &&
-            !!local == !!other.local
-        end
-      end
-    end
-  end
-end