rsmp 0.8.2 → 0.8.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 49e4aee9252ad888e831e5ce0738eff5bba57fdd6f2ec2220d7e74936e0e8177
-  data.tar.gz: 5866b23cb324d0732de17f995abec6304f50673e9cfcaa7b440dea6858102cd8
+  metadata.gz: f54121873905da2e5ffa4914f4f454fc4b59c7283e482b6b89b4035d686b7779
+  data.tar.gz: 523d2e310ebec8f4df07592fcb501d91f604ba8ea1c4625482c7d8d011340a6f
 SHA512:
-  metadata.gz: 0ff9a48cde72b3fb3963c421a321c4bd08c0edfb9afcd7b4b919e2e92aa37624259a5124c81f4bd0189cc6a3596414edc75a305fb19b0c348fadc4e836bdf7cf
-  data.tar.gz: 490aa51f0a4a5b9a6a197c0f6bbe11b8ae16934e5eecd76a486b6e4e34786ebbb334d4ddabf7340c9f13d4946cad4e162db49205a3fbf04fa064938bf6029e0f
+  metadata.gz: 807d2283a18f4a9c4e45594d4ae85e75464cde3792eb941342a825e8765a00d21f7d541fac03191680e28eb7e4af4c6624cb6ce80486da191cf3bc2b3f2d6431
+  data.tar.gz: 6adc50becc91e2deab2c8099808a492a2440d072188227147742bd51ec1310f8a1075e3bed72f2989581ba11125b9beeda8134704d8a42e131ac1dac9a76eca1

data/Gemfile.lock

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

data/documentation/collecting_message.md

@@ -157,7 +157,7 @@ task.wait  # wait for collection task to complete (or time out)
 ```
 
 ### With collection
-If you provide `:collect` options, it will be used to construct a StatusUpdateCollector for collecting the relevant status messages. When collection completes the collector is returned in the `:collector` key:
+If you provide `:collect` options, it will be used to construct a StatusCollector for collecting the relevant status messages. When collection completes the collector is returned in the `:collector` key:
 
 ```ruby
 options = {

data/lib/rsmp/collect/collector.rb

@@ -6,8 +6,8 @@ module RSMP
   class Collector < Listener
     attr_reader :condition, :messages, :status, :error, :task
 
-    def initialize proxy, options={}
-      super proxy, options
+    def initialize notifier, options={}
+      super notifier, options
       @options = {
         cancel: {
           schema_error: true,
@@ -18,7 +18,15 @@ module RSMP
       @outgoing = options[:outgoing] == nil ? false : options[:outgoing]
       @condition = Async::Notification.new
       @title = options[:title] || [@options[:type]].flatten.join('/')
-      @task = options[:task]
+      if options[:task]
+        @task = options[:task]
+      else
+         # if notifier is a Proxy, or some other object that implements task(),
+         # then try to get the task that way
+        if notifier.respond_to? 'task'
+          @task = notifier.task
+        end
+      end
       reset
     end
 
@@ -192,8 +200,8 @@ module RSMP
       @condition.signal
     end
 
-    # The proxy experienced some error.
-    # Check if this should cause us to cancel.
+    # An error occured upstream.
+    # Check if we should cancel.
     def notify_error error, options={}
       case error
       when RSMP::SchemaError

data/lib/rsmp/collect/{status_update_or_response_collector.rb → status_collector.rb}

@@ -1,8 +1,11 @@
 module RSMP
   # Base class for waiting for status updates or responses
-  class StatusUpdateOrResponseCollector < StateCollector
+  class StatusCollector < StateCollector
     def initialize proxy, want, options={}
-      super proxy, want, options.merge(outgoing: false)
+      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

data/lib/rsmp/node.rb

@@ -15,7 +15,6 @@ module RSMP
       @clock = Clock.new
       @error_queue = Async::Queue.new
       @ignore_errors = []
-      options[:collector]
       @collect = options[:collect]
     end
 

data/lib/rsmp/proxy.rb

@@ -52,12 +52,6 @@ module RSMP
       node.clock
     end
 
-    def collect options, &block
-      collector = RSMP::Collector.new self, options.merge(task: @task)
-      collector.collect &block
-      collector
-    end
-
     def run
       start
       @reader.wait if @reader
@@ -579,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,8 +101,13 @@ module RSMP
           "cId" => component,
           "mId" => m_id
       })
-      send_and_collect_if_needed message, options do |task|
-        collect_aggregated_status task, options[:collect].merge(m_id: m_id, num:1)
+      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
 
@@ -174,8 +179,14 @@ module RSMP
           "sS" => request_list,
           "mId" => m_id
       })
-      send_and_collect_if_needed 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
 
@@ -186,17 +197,6 @@ module RSMP
       acknowledge message
     end
 
-    def send_and_collect_if_needed 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
-
     def subscribe_to_status component_id, status_list, options={}
       validate_ready 'subscribe to status'
       m_id = options[:m_id] || RSMP::Message.make_m_id
@@ -215,8 +215,14 @@ module RSMP
           "sS" => subscribe_list,
           'mId' => m_id
       })
-      send_and_collect_if_needed 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
 
@@ -261,8 +267,14 @@ module RSMP
           "arg" => command_list,
           "mId" => m_id
       })
-      send_and_collect_if_needed 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
 
@@ -339,37 +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
-      collector = StatusUpdateCollector.new(self, status_list, options.merge(task:task))
-      collector.collect
-      collector
-    end
-
-    def collect_status_responses task, status_list, options
-      collector = StatusResponseCollector.new(self, status_list, options.merge(task:task))
-      collector.collect
-      collector
-    end
-
-    def collect_command_responses task, command_list, options
-      collector = CommandResponseCollector.new(self, command_list, options.merge(task:task))
-      collector.collect
-      collector
-    end
-
-    def collect_aggregated_status task, options
-      collector = AggregatedStatusCollector.new(self, options.merge(task:task))
-      collector.collect
-      collector
-    end
   end
 end

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
 

data/lib/rsmp/version.rb

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

data/lib/rsmp.rb

@@ -25,9 +25,7 @@ require 'rsmp/collect/filter'
 require 'rsmp/collect/query'
 require 'rsmp/collect/status_query'
 require 'rsmp/collect/command_query'
-require 'rsmp/collect/status_update_or_response_collector'
-require 'rsmp/collect/status_response_collector'
-require 'rsmp/collect/status_update_collector'
+require 'rsmp/collect/status_collector'
 require 'rsmp/collect/command_response_collector'
 require 'rsmp/collect/aggregated_status_collector'
 require 'rsmp/component'

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: rsmp
 version: !ruby/object:Gem::Version
-  version: 0.8.2
+  version: 0.8.3
 platform: ruby
 authors:
 - Emil Tin
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2022-01-10 00:00:00.000000000 Z
+date: 2022-01-11 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: async
@@ -217,10 +217,8 @@ files:
 - 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/collect/status_response_collector.rb
-- lib/rsmp/collect/status_update_collector.rb
-- lib/rsmp/collect/status_update_or_response_collector.rb
 - lib/rsmp/component.rb
 - lib/rsmp/components.rb
 - lib/rsmp/convert/export/json_schema.rb

data/lib/rsmp/collect/status_response_collector.rb

@@ -1,11 +0,0 @@
-module RSMP
-  # Class for waiting for specific status responses
-  class StatusResponseCollector < StatusUpdateOrResponseCollector
-    def initialize proxy, want, options={}
-      super proxy, want, options.merge(
-        type: ['StatusResponse','MessageNotAck'],
-        title: 'status response'
-      )
-    end
-  end
-end

data/lib/rsmp/collect/status_update_collector.rb

@@ -1,11 +0,0 @@
-module RSMP
-  # Class for waiting for specific status responses
-  class StatusUpdateCollector < StatusUpdateOrResponseCollector
-    def initialize proxy, want, options={}
-      super proxy, want, options.merge(
-        type: ['StatusUpdate','MessageNotAck'],
-        title:'status update'
-      )
-    end
-  end
-end