rsmp 0.7.5 → 0.8.3

data/lib/rsmp/collect/listener.rb

@@ -5,22 +5,19 @@ module RSMP
   class Listener
     include Inspect
 
-    def initialize proxy, options={}
-      @proxy = proxy
+    def initialize notifier, options={}
+      @notifier = notifier
     end
 
-    def notify message
+    def change_notifier notifier
+      @notifier.remove_listener self if @notifier
+      @notifier = notifier
     end
 
-    def notify_error error, options={}
+    def notify message
     end
 
-    def listen &block
-      @proxy.add_listener self
-      yield
-    ensure
-      @proxy.remove_listener self
+    def notify_error error, options={}
     end
-
   end
 end

data/lib/rsmp/collect/message_matchers.rb

@@ -1,64 +0,0 @@
-module RSMP
-  # Class for waiting for specific command responses
-  class CommandResponseMatcher < Matcher
-    def initialize proxy, want, options={}
-      super proxy, want, options.merge(
-        type: ['CommandResponse','MessageNotAck'],
-        title:'command response'
-      )
-    end
-
-    def build_query want
-      CommandQuery.new want
-    end
-
-    # Get items, in our case the return values
-    def get_items message
-      message.attributes['rvs']
-    end
-  end
-
-  # Base class for waiting for status updates or responses
-  class StatusUpdateOrResponseMatcher < Matcher
-    def initialize proxy, want, options={}
-      super proxy, want, options.merge
-    end
-
-    def build_query want
-      StatusQuery.new want
-    end
-
-    # Get items, in our case status values
-    def get_items message
-      message.attributes['sS']
-    end
-  end
-
-  # Class for waiting for specific status responses
-  class StatusResponseMatcher < StatusUpdateOrResponseMatcher
-    def initialize proxy, want, options={}
-      super proxy, want, options.merge(
-        type: ['StatusResponse','MessageNotAck'],
-        title: 'status response'
-      )
-    end
-  end
-
-  # Class for waiting for specific status responses
-  class StatusUpdateMatcher < StatusUpdateOrResponseMatcher
-    def initialize proxy, want, options={}
-      super proxy, want, options.merge(
-        type: ['StatusUpdate','MessageNotAck'],
-        title:'status update'
-      )
-    end
-  end
-
-  # Class for waiting for an aggregated status response
-  class AggregatedStatusMatcher < Collector
-    def initialize proxy, options={}
-      required = { type: ['AggregatedStatus','MessageNotAck'], title: 'aggregated status' }
-      super proxy, options.merge(required)
-    end
-  end
-end

data/lib/rsmp/collect/query.rb

@@ -1,5 +1,5 @@
 module RSMP
-    
+
   # Class that matches a single status or command item
   class Query
     attr_reader :want, :got, :message
@@ -8,26 +8,36 @@ module RSMP
       @want = want
       @got = nil
       @message = nil
-      @done = false
     end
 
     # Are we done, i.e. did the last checked item match?
     def done?
-      @done
+      @got != nil
     end
 
     # Check an item and set @done to true if it matches
     # Store the item and corresponding message if there's a positive or negative match
-    def check_match item, message
+    def perform_match item, message, block
       matched = match? item
       if matched != nil
-        @message = message
-        @got = item
-        @done = matched
+        if block
+          status = block.call(nil,item)
+          matched = status if status == true || status == false
+        end
       end
       matched
     end
 
+    def keep message, item
+      @message = message
+      @got = item
+    end
+
+    def forget
+      @message = nil
+      @got = nil
+    end
+
     def match? item
     end
   end

data/lib/rsmp/collect/{matcher.rb → state_collector.rb}

@@ -31,15 +31,14 @@ module RSMP
   #   {"cCI"=>"M0104", "cO"=>"setDate", "n"=>"month", "v"=>/\d+/} =>
   #     { <StatusResponse message>, {"cCI"=>"M0104", "cO"=>"setDate", "n"=>"month", "v"=>"9"} }
   # }
-
-  class Matcher < Collector
+  class StateCollector < Collector
     attr_reader :queries
 
     # Initialize with a list of wanted statuses
     def initialize proxy, want, options={}
+      raise ArgumentError.new("num option cannot be used") if options[:num]
       super proxy, options.merge( ingoing: true, outgoing: false)
       @queries = want.map { |item| build_query item }
-      @want = want
     end
 
     # Build a query object.
@@ -60,14 +59,9 @@ module RSMP
       @queries.map { |query| query.got }.compact
     end
 
-    # get the first message. Useful when you only collect one mesage
-    def message
-      @queries.first.message
-    end
-
     # Get messages from results
     def messages
-      @queries.map { |query| query.message }.uniq
+      @queries.map { |query| query.message }.uniq.compact
     end
 
     # Return progress as completes queries vs. total number of queries
@@ -77,14 +71,14 @@ module RSMP
       { need: need, reached: reached }
     end
 
-    # Are there queries left to match?
+    # Are there queries left to type_match?
     def done?
       @queries.all? { |query| query.done? }
     end
 
     # Get a simplified hash of queries, with values set to either true or false,
     # indicating which queries have been matched.
-    def status
+    def query_status
       @queries.map { |query| [query.want, query.done?] }.to_h
     end
 
@@ -95,19 +89,34 @@ module RSMP
 
     # Check if a messages matches our criteria.
     # Match each query against each item in the message
-    def check_match message
-      return unless match?(message)
+    def perform_match message
+      return false if super(message) == false
+      return unless collecting?
       @queries.each do |query|       # look through queries
         get_items(message).each do |item|  # look through items in message
-          matched = query.check_match(item,message)
+          matched = query.perform_match(item,message,@block)
+          return unless collecting?
           if matched != nil
             type = {true=>'match',false=>'mismatch'}[matched]
-            @proxy.log "#{@title.capitalize} #{message.m_id_short} collect #{type} #{query.want}, item #{item}", level: :debug
-            break
+            @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
+              query.forget
+            end
           end
         end
       end
-      @proxy.log "#{@title.capitalize} collect reached #{summary}", level: :debug
+      complete if done?
+      @notifier.log "#{@title.capitalize} collect reached #{summary}", level: :debug
+    end
+
+    # don't collect anything. Query will collect them instead
+    def keep message
+    end
+
+    def describe
+      @queries.map {|q| q.want.to_s }
     end
   end
 end

data/lib/rsmp/collect/status_collector.rb

@@ -0,0 +1,20 @@
+module RSMP
+  # Base class for waiting for status updates or responses
+  class StatusCollector < StateCollector
+    def initialize proxy, want, options={}
+      super proxy, want, options.merge(title: 'status response', type:['MessageNotAck'])
+
+      @options[:type] << 'StatusUpdate' unless options[:updates] == false
+      @options[:type] << 'StatusResponse' unless options[:reponses] == false
+    end
+
+    def build_query want
+      RSMP::StatusQuery.new want
+    end
+
+    # Get items, in our case status values
+    def get_items message
+      message.attributes['sS'] || []
+    end
+  end
+end

data/lib/rsmp/collect/{message_queries.rb → status_query.rb}

@@ -1,20 +1,5 @@
 module RSMP
-  # Match a specific command responses
-  class CommandQuery < Query
-    # Match a return value item against a query
-    def match? item
-      return nil if @want['cCI'] && @want['cCI'] != item['cCI']
-      return nil if @want['n'] && @want['n'] != item['n']
-      if @want['v'].is_a? Regexp
-        return false if @want['v'] && item['v'] !~ @want['v']
-      else
-        return false if @want['v'] && item['v'] != @want['v']
-      end
-      true
-    end
-  end
-
-  # Match a specific status response or update 
+  # Match a specific status response or update
   class StatusQuery < Query
     # Match a status value against a query
     def match? item

data/lib/rsmp/error.rb

@@ -41,7 +41,7 @@ module RSMP
 	class TimeoutError < Error
 	end
 
-	class DisonnectError < Error
+	class DisconnectError < Error
 	end
 
 	class ConnectionError < Error

data/lib/rsmp/node.rb

@@ -6,7 +6,7 @@ module RSMP
     include Wait
     include Inspect
 
-    attr_reader :archive, :logger, :task, :deferred, :error_queue, :clock
+    attr_reader :archive, :logger, :task, :deferred, :error_queue, :clock, :collector
 
     def initialize options
       initialize_logging options
@@ -15,6 +15,7 @@ module RSMP
       @clock = Clock.new
       @error_queue = Async::Queue.new
       @ignore_errors = []
+      @collect = options[:collect]
     end
 
     def ignore_errors classes, &block

data/lib/rsmp/proxy.rb

@@ -15,9 +15,8 @@ module RSMP
 
     def initialize options
       initialize_logging options
-      setup options
       initialize_distributor
-      prepare_collection @settings['collect']
+      setup options
       clear
     end
 
@@ -37,6 +36,10 @@ module RSMP
       @sxl = nil
       @site_settings = nil  # can't pick until we know the site id
       @state = :stopped
+      if options[:collect]
+        @collector = RSMP::Collector.new self, options[:collect]
+        @collector.start
+      end
     end
 
     def inspect
@@ -49,19 +52,6 @@ module RSMP
       node.clock
     end
 
-    def prepare_collection num
-      if num
-        @collector = RSMP::Collector.new self, num: num, ingoing: true, outgoing: true
-        add_listener @collector
-      end
-    end
-
-    def collect task, options, &block
-      collector = RSMP::Collector.new self, options
-      collector.collect task, &block
-      collector
-    end
-
     def run
       start
       @reader.wait if @reader
@@ -86,7 +76,7 @@ module RSMP
       return if @state == :stopped
       set_state :stopping
       stop_tasks
-      notify_error DisonnectError.new("Connection was closed")
+      notify_error DisconnectError.new("Connection was closed")
     ensure
       close_socket
       clear
@@ -583,25 +573,27 @@ module RSMP
     end
 
     def wait_for_acknowledgement parent_task, options={}, m_id
-      collect(parent_task,options.merge({
-        type: ['MessageAck','MessageNotAck'],
-        num: 1
-      })) do |message|
+      collector = Collector.new self, options.merge(task: parent_task, type: ['MessageAck','MessageNotAck'])
+      collector.collect do |message|
         if message.is_a?(MessageNotAck)
           if message.attribute('oMId') == m_id
-            # set result to an exception, but don't raise it.
-            # this will be returned by the 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, and caught by rspec.
-            # rspec will then show the error and record the test as failed
             m_id_short = RSMP::Message.shorten_m_id m_id, 8
-            result = RSMP::MessageRejected.new "Aggregated status request #{m_id_short} was rejected with '#{message.attribute('rea')}'"
-            next true   # done, no more messages wanted
+            raise RSMP::MessageRejected.new "Aggregated status request #{m_id_short} was rejected with '#{message.attribute('rea')}'"
           end
         elsif message.is_a?(MessageAck)
-          next true if message.attribute('oMId') == m_id
+          collector.complete if message.attribute('oMId') == m_id
         end
-        false
+      end
+    end
+
+    def send_and_optionally_collect message, options, &block
+      if options[:collect]
+        task = @task.async { |task| yield task }
+        send_message message, validate: options[:validate]
+        { sent: message, collector: task.wait }
+      else
+        send_message message, validate: options[:validate]
+        return { sent: message }
       end
     end
   end

data/lib/rsmp/site.rb

@@ -95,7 +95,8 @@ module RSMP
         ip: supervisor_settings['ip'],
         port: supervisor_settings['port'],
         logger: @logger,
-        archive: @archive
+        archive: @archive,
+        collect: @collect
       })
       @proxies << proxy
       @proxies_condition.signal

data/lib/rsmp/site_proxy.rb

@@ -101,15 +101,13 @@ module RSMP
           "cId" => component,
           "mId" => m_id
       })
-      if options[:collect]
-        task = @task.async do |task|
-          collect_aggregated_status task, options[:collect].merge(m_id: m_id)
-        end
-        send_message message, validate: options[:validate]
-        return message, task.wait
-      else
-        send_message message, validate: options[:validate]
-        message
+      send_and_optionally_collect message, options do |task|
+        collector = AggregatedStatusCollector.new(
+          self,
+          options[:collect].merge(task:@task,m_id: m_id, num:1)
+        )
+        collector.collect
+        collector
       end
     end
 
@@ -181,8 +179,14 @@ module RSMP
           "sS" => request_list,
           "mId" => m_id
       })
-      send_while_collecting message, options do |task|
-        collect_status_responses task, status_list, options[:collect].merge(m_id: m_id)
+      send_and_optionally_collect message, options do |task|
+        collector = StatusCollector.new(
+          self,
+          status_list,
+          options[:collect].merge(task:@task,m_id: m_id)
+          )
+        collector.collect
+        collector
       end
     end
 
@@ -193,13 +197,6 @@ module RSMP
       acknowledge message
     end
 
-    def send_while_collecting message, options, &block
-      task = @task.async { |task| yield task } if options[:collect]
-      send_message message, validate: options[:validate]
-      return message, task.wait if task
-      message
-    end
-
     def subscribe_to_status component_id, status_list, options={}
       validate_ready 'subscribe to status'
       m_id = options[:m_id] || RSMP::Message.make_m_id
@@ -218,8 +215,14 @@ module RSMP
           "sS" => subscribe_list,
           'mId' => m_id
       })
-      send_while_collecting message, options do |task|
-         collect_status_updates task, status_list, options[:collect].merge(m_id: m_id)
+      send_and_optionally_collect message, options do |task|
+        collector = StatusCollector.new(
+          self,
+          status_list,
+          options[:collect].merge(task:@task,m_id: m_id)
+        )
+        collector.collect
+        collector
       end
     end
 
@@ -264,8 +267,14 @@ module RSMP
           "arg" => command_list,
           "mId" => m_id
       })
-      send_while_collecting message, options do |task|
-        collect_command_responses task, command_list, options[:collect].merge(m_id: m_id)
+      send_and_optionally_collect message, options do |task|
+        collector = CommandResponseCollector.new(
+          self,
+          command_list,
+          options[:collect].merge(task:@task,m_id: m_id)
+          )
+        collector.collect
+        collector
       end
     end
 
@@ -342,29 +351,13 @@ module RSMP
       distribute_error e, options
     end
 
-    def collect_alarms parent_task, options={}
-      collect(parent_task,options.merge(type: "Alarm")) do |alarm|
+    def collect_alarms options={}
+      collect(@task,options.merge(type: "Alarm")) do |alarm|
         next if options[:aCId] && options[:aCId] != alarm.attribute("aCId")
         next if options[:aSp] && options[:aSp] != alarm.attribute("aSp")
         next if options[:aS] && options[:aS] != alarm.attribute("aS")
-        true
+        :keep
       end
     end
-
-    def collect_status_updates task, status_list, options
-      StatusUpdateMatcher.new(self, status_list, options).collect task
-    end
-
-    def collect_status_responses task, status_list, options
-      StatusResponseMatcher.new(self, status_list, options).collect task
-    end
-
-    def collect_command_responses task, command_list, options
-      CommandResponseMatcher.new(self, command_list, options).collect task
-    end
-
-    def collect_aggregated_status task, options
-      AggregatedStatusMatcher.new(self, options).collect task
-    end
   end
 end

data/lib/rsmp/supervisor.rb

@@ -7,7 +7,6 @@ module RSMP
     attr_reader :rsmp_versions, :site_id, :supervisor_settings, :proxies, :logger
 
     def initialize options={}
-
       handle_supervisor_settings( options[:supervisor_settings] || {} )
       super options
       @proxies = []
@@ -161,7 +160,7 @@ module RSMP
         ip: info[:ip],
         port: info[:port],
         task: @task,
-        settings: {'collect'=>@supervisor_settings['collect']},
+        collect: @collect,
         socket: socket,
         stream: stream,
         protocol: protocol,

data/lib/rsmp/supervisor_proxy.rb

@@ -138,16 +138,8 @@ module RSMP
         "mId" => m_id,
       })
 
-      if options[:collect]
-        result = nil
-        task = @task.async do |task|
-          wait_for_acknowledgement task, options[:collect], m_id
-        end
-        send_message message, validate: options[:validate]
-        return message, task.wait
-      else
-        send_message message, validate: options[:validate]
-        message
+      send_and_optionally_collect message, options do |task|
+        wait_for_acknowledgement task, options[:collect], m_id
       end
     end
 
@@ -282,7 +274,7 @@ module RSMP
     end
 
     def fetch_last_sent_status component, code, name
-      @last_status_sent.dig component, code, name
+      @last_status_sent.dig component, code, name if @last_status_sent
     end
 
     def store_last_sent_status message

data/lib/rsmp/tlc/signal_group.rb

@@ -16,7 +16,7 @@ module RSMP
         return default unless plan.states
         states = plan.states[c_id]
         return default unless states
-        state =states[pos]
+        state = states[pos]
         return default unless state =~ /[a-hA-G0-9N-P]/  # valid signal group states
         state
       end

data/lib/rsmp/version.rb

@@ -1,3 +1,3 @@
 module RSMP
-  VERSION = "0.7.5"
+  VERSION = "0.8.3"
 end

data/lib/rsmp.rb

@@ -20,10 +20,14 @@ require 'rsmp/components'
 require 'rsmp/collect/notifier'
 require 'rsmp/collect/listener'
 require 'rsmp/collect/collector'
+require 'rsmp/collect/state_collector'
+require 'rsmp/collect/filter'
 require 'rsmp/collect/query'
-require 'rsmp/collect/matcher'
-require 'rsmp/collect/message_queries'
-require 'rsmp/collect/message_matchers'
+require 'rsmp/collect/status_query'
+require 'rsmp/collect/command_query'
+require 'rsmp/collect/status_collector'
+require 'rsmp/collect/command_response_collector'
+require 'rsmp/collect/aggregated_status_collector'
 require 'rsmp/component'
 require 'rsmp/site'
 require 'rsmp/proxy'

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: rsmp
 version: !ruby/object:Gem::Version
-  version: 0.7.5
+  version: 0.8.3
 platform: ruby
 authors:
 - Emil Tin
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2022-01-04 00:00:00.000000000 Z
+date: 2022-01-11 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: async
@@ -201,18 +201,24 @@ files:
 - config/supervisor.yaml
 - config/tlc.yaml
 - documentation/classes_and_modules.md
+- documentation/collecting_message.md
 - documentation/message_distribution.md
 - exe/rsmp
 - lib/rsmp.rb
 - lib/rsmp/archive.rb
 - lib/rsmp/cli.rb
+- lib/rsmp/collect/aggregated_status_collector.rb
 - lib/rsmp/collect/collector.rb
+- lib/rsmp/collect/command_query.rb
+- lib/rsmp/collect/command_response_collector.rb
+- lib/rsmp/collect/filter.rb
 - lib/rsmp/collect/listener.rb
-- lib/rsmp/collect/matcher.rb
 - lib/rsmp/collect/message_matchers.rb
-- lib/rsmp/collect/message_queries.rb
 - lib/rsmp/collect/notifier.rb
 - lib/rsmp/collect/query.rb
+- lib/rsmp/collect/state_collector.rb
+- lib/rsmp/collect/status_collector.rb
+- lib/rsmp/collect/status_query.rb
 - lib/rsmp/component.rb
 - lib/rsmp/components.rb
 - lib/rsmp/convert/export/json_schema.rb