rsmp 0.3.0 → 0.3.4

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 9a3b1b8a67bdc7a3c8887ea606d3539d934121d99597f1a77f697d8259daba97
-  data.tar.gz: 03f420b48a4eff2f3b6978eed5053a838a87da4f507eb2ddb2f0c15cb0e3e7b4
+  metadata.gz: f529bfbfcdd5fc6b0854c294e2412c5e7da10e2595a6a20ab0f6c65b7eb28964
+  data.tar.gz: c8fb86566e623a27ec78784e3d0299f16d082edc87ad9438f2335a0c33657b39
 SHA512:
-  metadata.gz: 9fef0b5ea4b2e5481d3be7992e76c7cddb1d20db49df06c86d9b90faa37b56d458fde9cba36e14ea085e96e67f61dbe67f1a82a49401d360cb48900c6138b27d
-  data.tar.gz: a14a735fccf39e8584e3d9ab43a1fdb727c279f395c138d9c7c50f7a8d491265c0aeb3aa67ee071642195bd7a15e0339de4785b5230bbed624965ef3619a231e
+  metadata.gz: 58c5d44cb5d8a1f87b77d91823eaa76adfd437df955412ba42950e359d1b08b47acec78034f42524b72d474a6c7870e2e22f418973d634fc938650b13f95fc47
+  data.tar.gz: 6006f41562af7ce3419c50895040fc0682026fa3c5b0db113875645fdd1de5286e25b73edc22f1d547a1daac50059532e7c4061cc5e3789d3a92c18c5e502aca

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    rsmp (0.3.0)
+    rsmp (0.3.3)
       async (~> 1.29.1)
       async-io (~> 1.32.1)
       colorize (~> 0.8.1)

data/lib/rsmp/collector.rb

@@ -13,6 +13,7 @@ module RSMP
       @condition = Async::Notification.new
       @title = options[:title] || [@options[:type]].flatten.join('/')
       @options[:timeout] ||= 1
+      @options[:num] ||= 1
       reset
     end
 
@@ -51,21 +52,21 @@ module RSMP
       raise RSMP::TimeoutError.new str
     end
 
+    # Get the collected messages.
+    # If one message was requested, return it as a plain object instead of array
     def result
-      return @messages.first if @options[:num] == 1      # if one message was requested, return it instead of array
-      @messages.first @options[:num]      # return array, but ensure we never return more than requested
+      return @messages.first if @options[:num] == 1     
+      @messages.first @options[:num] 
     end
 
+    # Clear all query results
     def reset
       @messages = []
       @error = nil
       @done = false
     end
 
-    # Check for MessageNotAck
-    # If the original request identified by @m_id is rejected, set the result to an exception,
-    # which will be returned by the async task and stored as the task result.
-    # When the parent task call wait() on the task, the exception will be raised in the parent task.
+    # Check if we receive a NotAck related to initiating request, identified by @m_id.
     def check_not_ack message
       return unless @options[:m_id]
       if message.is_a?(MessageNotAck)
@@ -81,6 +82,7 @@ module RSMP
     # Handle message. and return true when we're done collecting
     def notify message
       raise ArgumentError unless message
+      raise RuntimeError.new("can't process message when already done") if @done
       check_not_ack(message)
       return true if @done
       check_match message
@@ -98,24 +100,31 @@ module RSMP
       end
     end
 
+    # Have we collected the required number of messages?
     def done?
       @options[:num] && @messages.size >= @options[:num]
     end
 
+    # Called when we're done collecting. Remove ourself as a listener,
+    # se we don't receive message notifications anymore
     def complete
       @done = true
       @proxy.remove_listener self
       @condition.signal
     end
 
+    # Store a message in the result array
     def keep message
       @messages << message
     end
 
+    # Remove a message from the result array
     def forget message
       @messages.delete message
     end
 
+    # Check a message against our match criteria
+    # Return true if there's a match
     def match? message
       raise ArgumentError unless message
       return if message.direction == :in && @ingoing == false

data/lib/rsmp/components.rb

@@ -13,6 +13,7 @@ module RSMP
 
     def setup_components settings
       return unless settings
+      check_main_component settings
       settings.each_pair do |type,components_by_type|
         components_by_type.each_pair do |id,settings|
           @components[id] = build_component(id:id, type:type, settings:settings)
@@ -20,6 +21,15 @@ module RSMP
       end
     end
 
+    def check_main_component settings
+      unless settings['main'] && settings['main'].size >= 1
+        raise ConfigurationError.new("main component must be defined") 
+      end
+      if settings['main'].size > 1
+        raise ConfigurationError.new("only one main component can be defined, found #{settings['main'].keys.join(', ')}") 
+      end
+    end
+
     def add_component component
       @components[component.c_id] = component
     end

data/lib/rsmp/matcher.rb

@@ -35,6 +35,7 @@ module RSMP
   #
   #
   class Matcher < Collector
+    attr_reader :queries
 
     # Initialize with a list a wanted statuses
     def initialize proxy, want, options={}
@@ -55,16 +56,27 @@ module RSMP
       @queries.map { |query,result| result[:message] }.uniq
     end
 
-    # get items from results
+    # Get items from results
     def items
       @queries.map { |query,result| result[:item] }.uniq
     end
 
-    # Queries left to match?
+    # Are there queries left to match?
     def done?
       @queries.values.all? { |result| result != nil }
     end
 
+    # Get a simplified hash of queries, with values set to either true or false,
+    # indicating which queries have been matched.
+    def status
+      @queries.transform_values{ |v| v != nil }
+    end
+
+    # Get a simply array of bools, showing which queries ahve been matched.
+    def summary
+      @queries.values.map { |v| v != nil }
+    end
+
     # Mark a query as matched, by linking it to the matched item and message
     def keep query, message, item
       @queries[query] = { message:message, item:item }
@@ -75,11 +87,12 @@ module RSMP
       @queries[query] = nil
     end
 
-    # Check if a messages is wanted.
-    # Returns true when we found all that we want.
+    # Check if a messages matches our criteria.
+    # We iterate through each of the status items or return values in the message
+    # Breaks as soon as where done matching all queries
     def check_match message
       return unless match?(message)
-      @queries.keys.each do |query|        # look through queries
+      @queries.keys.each do |query|       # look through queries
         get_items(message).each do |item|  # look through status items in message
           break if check_item_match message, query, item
         end
@@ -104,15 +117,16 @@ module RSMP
     def initialize proxy, want, options={}
       super proxy, want, options.merge(
         type: ['CommandResponse','MessageNotAck'],
-        title:'command request'
+        title:'command response'
       )
     end
 
+    # Get items, in our case the return values
     def get_items message
       message.attributes['rvs']
     end
 
-    # Match an item against a query
+    # Match a return value item against a query
     def match_item? query, item
       return nil if query['cCI'] && query['cCI'] != item['cCI']
       return nil if query['n'] && query['n'] != item['n']
@@ -131,11 +145,12 @@ module RSMP
       super proxy, want, options.merge
     end
 
+    # Get items, in our case status values
     def get_items message
       message.attributes['sS']
     end
 
-    # Match an item against a query
+    # Match a status value against a query
     def match_item? query, item
       return nil if query['sCI'] && query['sCI'] != item['sCI']
       return nil if query['cO'] && query['cO'] != item['cO']
@@ -155,7 +170,7 @@ module RSMP
     def initialize proxy, want, options={}
       super proxy, want, options.merge(
         type: ['StatusResponse','MessageNotAck'],
-        title: 'status request'
+        title: 'status response'
       )
     end
   end
@@ -165,7 +180,7 @@ module RSMP
     def initialize proxy, want, options={}
       super proxy, want, options.merge(
         type: ['StatusUpdate','MessageNotAck'],
-        title:'status subscription'
+        title:'status update'
       )
     end
   end
@@ -173,11 +188,8 @@ module RSMP
   # Class for waiting for an aggregated status response
   class AggregatedStatusMatcher < Collector
     def initialize proxy, options={}
-      super proxy, options.merge(
-        num: 1,
-        type: ['AggregatedStatus','MessageNotAck'],
-        title: 'aggregated status request'
-      )
+      required = { type: ['AggregatedStatus','MessageNotAck'], title: 'aggregated status' }
+      super proxy, options.merge(required)
     end
   end
 end

data/lib/rsmp/proxy.rb

@@ -124,7 +124,11 @@ module RSMP
           message = process_packet json
           duration = Time.now - beginning
           ms = (duration*1000).round(4)
-          per_second = (1.0 / duration).round
+          if duration > 0
+            per_second = (1.0 / duration).round
+          else
+            per_second = Float::INFINITY
+          end
           if message
             type = message.type
             m_id = Logger.shorten_message_id(message.m_id)
@@ -203,7 +207,6 @@ module RSMP
     def watchdog_send_timer now
       return unless @watchdog_started  
       return if @site_settings['intervals']['watchdog'] == :never
-      
       if @latest_watchdog_send_at == nil
         send_watchdog now
       else
@@ -299,10 +302,18 @@ module RSMP
       end
     end
 
+    def should_validate_ingoing_message? message
+      return false unless @site_settings
+      skip = @site_settings.dig('skip_validation')
+      return false unless skip
+      klass = message.class.name.split('::').last
+      !skip.include?(klass)
+    end
+
     def process_packet json
       attributes = Message.parse_attributes json
       message = Message.build attributes, json
-      message.validate get_schemas
+      message.validate(get_schemas) if should_validate_ingoing_message?(message)
       notify message
       expect_version_message(message) unless @version_determined
       process_message message

data/lib/rsmp/site.rb

@@ -41,10 +41,16 @@ module RSMP
         },
         'send_after_connect' => true,
         'components' => {
-          'C1' => {}
+          'main' => {
+            'C1' => {}
+          }
         }
       }
-      
+      # only one main component can be defined, so replace the default if options define one
+      if options.dig(:site_settings,'components','main')
+        defaults['components']['main'] = options[:site_settings]['components']['main']
+      end
+
       @site_settings = defaults.deep_merge options[:site_settings]
       check_sxl_version
       setup_components @site_settings['components']

data/lib/rsmp/site_proxy.rb

@@ -11,7 +11,7 @@ module RSMP
       initialize_components
       @supervisor = options[:supervisor]
       @settings = @supervisor.supervisor_settings.clone
-      @site_id = nil
+      @site_id = options[:site_id]
     end
 
     def revive options
@@ -103,7 +103,7 @@ module RSMP
       })
       if options[:collect]
         task = @task.async do |task|
-          wait_for_aggregated_status task, options[:collect].merge(m_id: m_id)
+          collect_aggregated_status task, options[:collect].merge(m_id: m_id)
         end
         send_message message, validate: options[:validate]
         return message, task.wait
@@ -369,7 +369,7 @@ module RSMP
       CommandResponseMatcher.new(self, command_list, options).collect task
     end
 
-    def wait_for_aggregated_status task, options
+    def collect_aggregated_status task, options
       AggregatedStatusMatcher.new(self, options).collect task
     end
   end

data/lib/rsmp/supervisor.rb

@@ -175,7 +175,7 @@ module RSMP
         proxy.revive settings
       else
         check_max_sites
-        proxy = build_proxy settings
+        proxy = build_proxy settings.merge(site_id:id)    # keep the id learned by peeking above
         @proxies.push proxy
       end
       proxy.run     # will run until the site disconnects

data/lib/rsmp/version.rb

@@ -1,3 +1,3 @@
 module RSMP
-  VERSION = "0.3.0"
+  VERSION = "0.3.4"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: rsmp
 version: !ruby/object:Gem::Version
-  version: 0.3.0
+  version: 0.3.4
 platform: ruby
 authors:
 - Emil Tin
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2021-10-14 00:00:00.000000000 Z
+date: 2021-10-18 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: async
@@ -255,7 +255,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.2.26
+rubygems_version: 3.2.15
 signing_key:
 specification_version: 4
 summary: RoadSide Message Protocol (RSMP) library.