rsmp 0.10.1 → 0.11.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 58dea443fbf263b26902f047bc4b9127add5b43eea514be23e8f1c1354b34686
-  data.tar.gz: be065deb840d556e81194ca9862616d48fb5be475167899c155295a1b2276a5d
+  metadata.gz: 429ca780c80b9fd2e2a320256f76a8d1ed37bc6f2ca2045cbebb40c537c6888a
+  data.tar.gz: 9cdb92a02f59e8ee2dd82a60e64e9b097dd6039ef2ca0e331bfe43a8e63a44e9
 SHA512:
-  metadata.gz: 594fc45b7d42a0ad33c23ac2789c0b090a72afa5fb5355a9543586272f5623f4ea58a37265bd79c74c3cb0efe3e07d731265ca01c56188eb62084f1694ee3e09
-  data.tar.gz: aac8c6bc88b8498139232e2c131626f7d9e1663aeea1c85fbce579b499d21a4bc40ebbcb064281b34009dd413d3a79a1a4191f2c771ae3fa5253180317fa8436
+  metadata.gz: 35e87d762b71abb1e108b5045c05d97d024b193d683882444851e34af6dc34facffff91b6017fca83309a6f46eeec301f22530d0fd907526f417ce9b3d3b7eef
+  data.tar.gz: fde8b4459dc7cb15a08d2fa2a19584f0a47303f4591c76b390957f7b018f5704205be125d567b7648865a011a239fa52a460a9663b7b03b1daf7f5b0648eb24f

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    rsmp (0.10.1)
+    rsmp (0.11.3)
       async (~> 1.29.1)
       async-io (~> 1.32.2)
       colorize (~> 0.8.1)

data/lib/rsmp/collect/alarm_collector.rb

@@ -9,12 +9,20 @@ module RSMP
       )
     end
 
+    # match alarm attributes
     def type_match? message
       return false if super(message) == false
 
       # match fixed attributes
       %w{aCId aSp ack aS sS cat pri}.each do |key|
-        return false if @query[key] && @query[key] != message.attribute(key)
+        want = @query[key]
+        got = message.attribute(key)
+        case want
+        when Regexp
+          return false if got !~ want
+        when String
+          return false if got != want
+        end
       end
 
       # match rvs items
@@ -31,5 +39,11 @@ module RSMP
       end
       true
     end
+
+    # return a string that describes what we're collecting
+    def describe_query
+      "#{describe_num_and_type} #{ {component: @options[:component]}.merge(@query).compact }"
+    end
+
   end
 end

data/lib/rsmp/collect/collector.rb

@@ -134,17 +134,18 @@ module RSMP
     # Start collection and return immediately
     # You can later use wait() to wait for completion
     def start &block
-      raise RuntimeError.new("Can't begin unless ready (currenty #{@status})") unless ready?
+      raise RuntimeError.new("Can't start collectimng unless ready (currently #{@status})") unless ready?
       @block = block
       raise ArgumentError.new("Num, timeout or block must be provided") unless @options[:num] || @options[:timeout] || @block
       reset
       @status = :collecting
+      log_start
       @notifier.add_listener self if @notifier
     end
 
     # Build a string describing how how progress reached before timeout
     def describe_progress
-      str = "#{@title.capitalize} collection "
+      str = "#{identifier}: #{@title.capitalize} collection "
       str << "in response to #{@options[:m_id]} " if @options[:m_id]
       str << "didn't complete within #{@options[:timeout]}s, "
       str << "reached #{@messages.size}/#{@options[:num]}"
@@ -167,7 +168,13 @@ module RSMP
     def notify message
       raise ArgumentError unless message
       raise RuntimeError.new("can't process message when status is :#{@status}, title: #{@title}, desc: #{describe}") unless ready? || collecting?
-      perform_match message
+      if perform_match message
+        if done?
+          complete
+        else
+          incomplete
+        end
+      end
       @status
     end
 
@@ -178,6 +185,7 @@ module RSMP
     def perform_match message
       return false if reject_not_ack(message)
       return false unless type_match?(message)
+      #@notifier.log "#{identifier}: Looking at #{message.type} #{message.m_id_short}", level: :collect
       if @block
         status = [@block.call(message)].flatten
         return unless collecting?
@@ -185,7 +193,6 @@ module RSMP
       else
         keep message
       end
-      complete if done?
     end
 
     # Have we collected the required number of messages?
@@ -198,6 +205,12 @@ module RSMP
     def complete
       @status = :ok
       do_stop
+      log_complete
+    end
+
+    # called when we received a message, but are not done yet
+    def incomplete
+      log_incomplete
     end
 
     # Remove ourself as a listener, so we don't receive message notifications anymore,
@@ -225,14 +238,14 @@ module RSMP
       return unless message
       klass = message.class.name.split('::').last
       return unless @options[:type] == nil || [@options[:type]].flatten.include?(klass)
-      @notifier.log "Collection cancelled due to schema error in #{klass} #{message.m_id_short}", level: :debug
+      @notifier.log "#{identifier}: cancelled due to schema error in #{klass} #{message.m_id_short}", level: :debug
       cancel error
     end
 
     # Cancel if we received e notificaiton about a disconnect
     def notify_disconnect error, options
       return unless @options.dig(:cancel,:disconnect)
-      @notifier.log "Collection cancelled due to a connection error: #{error.to_s}", level: :debug
+      @notifier.log "#{identifier}: cancelled due to a connection error: #{error.to_s}", level: :debug
       cancel error
     end
 
@@ -265,5 +278,59 @@ module RSMP
       end
       true
     end
+
+    # return a string describing the types of messages we're collecting
+    def describe_types
+      [@options[:type]].flatten.join('/')
+    end
+
+    # return a string that describes whe number of messages, and type of message we're collecting
+    def describe_num_and_type
+      if @options[:num] && @options[:num] > 1
+        "#{@options[:num]} #{describe_types}s"
+      else
+        describe_types
+      end
+    end
+
+    # return a string that describes the attributes that we're looking for
+    def describe_query
+      h = {component: @options[:component]}.compact
+      if h.empty?
+        describe_num_and_type
+      else
+        "#{describe_num_and_type} #{h}"
+      end
+    end
+
+    # return a string that describe how many many messages have been collected
+    def describe_progress
+      if @options[:num]
+        "#{@messages.size} of #{@options[:num]} message#{'s' if @messages.size!=1} collected"
+      else
+        "#{@messages.size} message#{'s' if @messages.size!=1} collected"
+      end        
+    end
+
+    # log when we start collecting
+    def log_start
+      @notifier.log "#{identifier}: Waiting for #{describe_query}".strip, level: :collect
+    end
+
+    # log current progress
+    def log_incomplete
+      @notifier.log "#{identifier}: #{describe_progress}", level: :collect
+    end
+
+    # log when we end collecting
+    def log_complete
+      @notifier.log "#{identifier}: Done", level: :collect
+    end
+
+    # get a short id in hex format, identifying ourself
+    def identifier
+      "Collect #{self.object_id.to_s(16)}"
+    end
+
   end
 end

data/lib/rsmp/collect/state_collector.rb

@@ -97,8 +97,8 @@ module RSMP
           matched = query.perform_match(item,message,@block)
           return unless collecting?
           if matched != nil
-            type = {true=>'match',false=>'mismatch'}[matched]
-            @notifier.log "#{@title.capitalize} #{message.m_id_short} collect #{type} #{query.want}, item #{item}", level: :debug
+            #type = {true=>'match',false=>'mismatch'}[matched]
+            #@notifier.log "#{@title.capitalize} #{message.m_id_short} collect #{type} #{query.want}, item #{item}", level: :debug
             if matched == true
               query.keep message, item
             elsif matched == false
@@ -107,8 +107,6 @@ module RSMP
           end
         end
       end
-      complete if done?
-      @notifier.log "#{@title.capitalize} collect reached #{summary}", level: :debug
     end
 
     # don't collect anything. Query will collect them instead
@@ -118,5 +116,98 @@ module RSMP
     def describe
       @queries.map {|q| q.want.to_s }
     end
+
+    # return a string that describes the attributes that we're looking for
+    def describe_query
+      "#{super} matching #{query_want_hash.to_s}"
+    end
+
+    # return a hash that describe the status of all queries
+    def progress_hash
+      h = {}
+      @queries.each do |query|
+        want = query.want
+        if want['cCI']
+          cCI = want['cCI']
+          h[cCI] ||= {}
+          cO = h['cO']
+          n = h['n']
+          v = h['v']
+          h[cCI][cO] ||= {}
+          h[cCI][cO][n] = v
+        elsif want['sCI']
+          sCI = want['sCI']
+          h[sCI] ||= {}
+          n = want['n']
+          s = want['s']
+          if query.got && query.got['s']
+            h[sCI][n] = { {s=>query.got['s']} => query.done? }
+          else
+            h[sCI][n] = {s=>:anything}
+          end
+        end
+      end
+      h
+    end
+
+    # return a string that describe how many many messages have been collected
+    def describe_progress
+      num_queries = @queries.size
+      num_matched =  @queries.count { |query| query.done? }
+      ".. Matched #{num_matched}/#{num_queries} with #{progress_hash.to_s}"
+    end
+
+    def query_want_hash
+      h = {}
+      @queries.each do |query|
+        item = query.want
+        if item['cCI']
+          cCI = item['cCI']
+          h[cCI] ||= {}
+          cO = item['cO']
+          h[cCI][cO] ||= {}
+          n = item['n']
+          v = item['v']
+          h[cCI][cO][n] = v || :any
+        elsif item['sCI']
+          sCI = item['sCI']
+          h[sCI] ||= {}
+          n = item['n']
+          s = item['s']
+          h[sCI][n] = s || :any
+        end
+      end
+      h
+    end
+
+    # return a hash that describe the end result
+    def query_got_hash
+      h = {}
+      @queries.each do |query|
+        want = query.want
+        got = query.got
+        if got['cCI']
+          cCI = want['cCI']
+          h[cCI] ||= {}
+          cO = want['cO']
+          h[cCI][cO] ||= {}
+          n = want['n']
+          v = got['v']
+          h[cCI][cO][n] = v
+        elsif want['sCI']
+          sCI = want['sCI']
+          h[sCI] ||= {}
+          n = want['n']
+          s = got['s']
+          h[sCI][n] = s
+        end
+      end
+      h
+    end
+
+    # log when we end collecting
+    def log_complete
+      @notifier.log "#{identifier}: Completed with #{query_got_hash.to_s}", level: :collect
+    end
   end
 end

data/lib/rsmp/logger.rb

@@ -135,12 +135,11 @@ module RSMP
         colors = {
           'info' => 'white',
           'log' => 'light_blue',
-          'test' => 'light_magenta',
           'statistics' => 'light_black',
-          'not_acknowledged' => 'cyan',
           'warning' => 'light_yellow',
           'error' => 'red',
-          'debug' => 'light_black'
+          'debug' => 'light_black',
+          'collect' => 'light_black'
         }
         colors.merge! @settings["color"] if @settings["color"].is_a?(Hash)
         if colors[level.to_s]

data/lib/rsmp/version.rb

@@ -1,3 +1,3 @@
 module RSMP
-  VERSION = "0.10.1"
+  VERSION = "0.11.3"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: rsmp
 version: !ruby/object:Gem::Version
-  version: 0.10.1
+  version: 0.11.3
 platform: ruby
 authors:
 - Emil Tin
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2022-03-11 00:00:00.000000000 Z
+date: 2022-03-22 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: async