evt-messaging 2.5.6.0 → 2.7.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 4ed32a3950086fa459ebb29d4343df38845f3ce1d4a559205bb5fcd6d8c42c40
-  data.tar.gz: 6187c2a9da83c38d5f003259a1ecf59b96fcf88aaaa16ca3b5ec03723a6ff806
+  metadata.gz: d22a40f19386098d8d266f77e69a6c794324d30f018e96a4993eab0c5cfc20e1
+  data.tar.gz: 8d523d0b69b432eed9e06e8e24731a77f14809fd86df46aed900feb90b2d4e9c
 SHA512:
-  metadata.gz: 56c25adccd43baa313b05d76aa3b2e8f82977be4e898c0680ae38ba479e009d88a31caa4deb50adc59fc3ebce58dc74e46f87dee6a44f8bfd2facb3bedb0c94a
-  data.tar.gz: 6e375228008283d4bc40f7495658223ca789afabc6c99d86805bee419c6b42dbfd06850e3ddc771a30f7c5ff46289ae2485d3e14fa2c5076a4c5cd4057434344
+  metadata.gz: ea96206a951ad33ef9b7e7d52db38e9f9584adaa66d898cf77579608e16ebff7b597017d770bf143048809b964d3dd5d90da4bef7ab262516506ab0cfc53881c
+  data.tar.gz: 8655511a3ae29570de973f79b5cfd535be9f701fdd6c2a7625fb4e9f746315bcb377b35c560c18563e482af2f53096b2215dcca79956361c48e868f65d6e98c0

data/lib/messaging/controls.rb

@@ -7,9 +7,11 @@ require 'messaging/controls/random'
 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'
-require 'messaging/controls/metadata'
 require 'messaging/controls/batch'
 require 'messaging/controls/write'
 require 'messaging/controls/settings'

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

@@ -2,6 +2,11 @@ module Messaging
   module Controls
     module Metadata
       def self.example
+        data = self.data
+
+        data[:properties] = properties
+        data[:local_properties] = local_properties
+
         Messaging::Message::Metadata.build(data)
       end
 
@@ -49,22 +54,22 @@ module Messaging
         "#{causation_message_stream_name}/#{causation_message_position}"
       end
 
-      # def self.properties
-      #   {
-      #     some_property: 'some property value'
-      #   }
-      # end
-
       def self.properties
-        [
-          Messaging::Message::Metadata::Property.new(:some_property, 'some property value')
-        ]
+        Properties.example
       end
 
       def self.time
         Time::Raw.example
       end
 
+      def self.properties
+        Properties.example
+      end
+
+      def self.local_properties
+        LocalProperties.example
+      end
+
       def self.data
         {
           stream_name: stream_name,
@@ -79,7 +84,8 @@ module Messaging
 
           reply_stream_name: reply_stream_name,
 
-          properties: properties,
+          properties: Properties.example,
+          local_properties: LocalProperties.example,
 
           time: time,
 
@@ -112,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
 
@@ -163,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,
@@ -176,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

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

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
@@ -93,6 +104,8 @@ module Messaging
 
         if message_or_message_data.is_a? MessageStore::MessageData::Read
           name = Messaging::Message::Info.canonize_name(message_or_message_data.type)
+        elsif message_or_message_data.is_a? String
+          name = Messaging::Message::Info.canonize_name(message_or_message_data)
         else
           name = message_or_message_data.message_name
         end

data/lib/messaging/message/copy.rb

@@ -32,8 +32,12 @@ module Messaging
         end
 
         if metadata
-          metadata_include = source.metadata.class.attribute_names
+          metadata_include = source.metadata.class.attribute_names - [:properties, :local_properties]
+
           SetAttributes.(receiver.metadata, source.metadata, include: metadata_include)
+
+          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,16 +61,8 @@ module Messaging
 
         self.reply_stream_name = preceding_metadata.reply_stream_name
 
-        preceding_metadata.properties.each do |property|
-          if property.transient?
-            next
-          end
-
-          set_property(
-            property.name,
-            property.value,
-            transient: property.transient
-          )
+        preceding_metadata.properties.each do |name, value|
+          properties[name] = value
         end
       end
 
@@ -140,47 +133,64 @@ module Messaging
       end
       alias :correlates? :correlated?
 
-      Property = Struct.new(
-        :name,
-        :value,
-        :transient
-      ) do
-        def transient?
-          transient == true
+      def set_property(name, value)
+        if not name.is_a?(Symbol)
+          raise Error, "Property name must be a symbol: #{name.inspect}"
         end
-      end
 
-      def set_property(name, value, transient: nil)
-        transient ||= 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, transient)
+        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_transient_property(name, value, transient: nil)
-        set_property(name, value, transient: true)
+      def clear_properties
+        properties.clear
       end
 
-      def get_property(name)
-        property = properties.find { |property| property.name == name }
-        property&.value
+      def set_local_property(name, value)
+        if not name.is_a?(Symbol)
+          raise Error, "Local property name must be a symbol: #{name.inspect}"
+        end
+
+        local_properties[name] = value
+
+        value
       end
 
-      def delete_property(name)
-        i = properties.index { |property| property.name == name }
+      def get_local_property(name)
+        if not name.is_a?(Symbol)
+          raise Error, "Local property name must be a symbol: #{name.inspect}"
+        end
 
-        return nil if i.nil?
+        local_properties[name]
+      end
+
+      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,14 @@ module Messaging
 
           metadata = message.metadata.to_h
 
-          metadata[:properties].delete_if { |property| property.transient? }
-
           if metadata[:properties].empty?
             metadata.delete(:properties)
           end
 
+          if metadata[:local_properties].empty?
+            metadata.delete(:local_properties)
+          end
+
           metadata.delete_if { |k, v| v.nil? }
 
           message_data.metadata = metadata
@@ -42,10 +44,10 @@ module Messaging
         def self.read(message_data)
           data = message_data.to_h
 
-          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]
@@ -56,6 +58,9 @@ module Messaging
           metadata[:global_position] = data[:global_position]
           metadata[:time] = data[:time]
 
+          metadata[:properties] ||= {}
+          metadata[:local_properties] ||= {}
+
           data
         end
       end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: evt-messaging
 version: !ruby/object:Gem::Version
-  version: 2.5.6.0
+  version: 2.7.0.0
 platform: ruby
 authors:
 - The Eventide Project
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2021-01-04 00:00:00.000000000 Z
+date: 2021-04-29 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: evt-message_store
@@ -64,9 +64,11 @@ 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
+- lib/messaging/controls/properties.rb
 - lib/messaging/controls/random.rb
 - lib/messaging/controls/settings.rb
 - lib/messaging/controls/stream_name.rb