rsmp 0.10.0 → 0.11.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 966835905e623249647c1c09a2571ffe81e42a4d28b7f61630f11dbd886f5e60
-  data.tar.gz: 134c264fdbeddd2a2dd72613ccb96d9476f732ecff086ae274bb0bc25a381e5c
+  metadata.gz: 1e0f394a4f97656f2ace6156c775c7af4f35ae4023c6bd5c9ad2fd55eca06e3a
+  data.tar.gz: b5e75bf4cb30280fa51e08ee8c42507a7239dc6f7bff57fd0c6f679ca44652b8
 SHA512:
-  metadata.gz: '04027059289848f757e10b46b5cc9ba15ade51460cdaaa80d442945dd79a3300f676a593a6cc3ec29c945f9340664855cca3304188cbef99f89531820731004f'
-  data.tar.gz: a04881e95b77482897ccd746047847e3036953515d02539fb2988b1a743135ebf0d6c66d1f15c39c46d7d3bfd8c5df67568bddf58ac26df3fee5fca5f00d3dd4
+  metadata.gz: 9b8a16e7119b579f81a49d444ae3b2ee0393659eb0dbd84a5f24d4d498b31cf51e0ea355990af5618081c779e41d8c7d33aecb2778f6af2d242de1ee48569050
+  data.tar.gz: 71118e681ee613fecfb5133ec2532813abaa9026d42dd7c58ad5363acbc040cc67d14b899b6a0ab2a6907166967f5125c2d5584ed01d57a3bcaec0a9e1068337

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    rsmp (0.10.0)
+    rsmp (0.11.2)
       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,54 @@ module RSMP
       end
       true
     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]} #{@options[:type]}s"
+      else
+        @options[:type]
+      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,24 @@ 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
+      want = @queries.map {|query| "#{query.want}" }
+      "#{super} with #{want.join(', ')}"
+    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? }
+
+      got = @queries.select {|query| query.done? == true }.map {|query| "#{query.got}" }
+      need = @queries.select {|query| query.done? == false }.map {|query| "#{query.want}" }
+      str = "Matched #{num_matched} of #{num_queries}".colorize(:red)
+      str << ", got #{got.join(', ')}" if got.any?
+      str << ", need #{need.join(', ')}" if need.any?
+      str
+    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.0"
+  VERSION = "0.11.2"
 end

metadata

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