rsmp 0.41.0 → 0.42.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: bc1577fbdedac8b027f104cbee87a5d3d60ac5f4166d8f5815a83a191e3ec34a
-  data.tar.gz: b8762a3e125833dc3d7c1f18214b9aca919064d673c892e738087c32ba449b78
+  metadata.gz: 42d22cc3891135d1349e9c0c41aeaa16338f7ec77aaa6055de5da51899454332
+  data.tar.gz: '09df465e7c6bd906003b451a61f403f8ea472cf3b92c01b9b136d620b019d391'
 SHA512:
-  metadata.gz: 9da569e3ca8f7d81ba5f8a1a73e55bbe4680dbac9d21b8f532ed56494f81bcfdfd085556dbb3c297b2ffcb890588f76bd10a04488083ae310f183d1c575e3064
-  data.tar.gz: d2384361479e970a1d33d92a128f73a58d509a9b92a3b6007698a76758a16061804c6e949769d672881c28a5d960ee1eeb132e9a01d428344e4e3cb9b241576e
+  metadata.gz: f4440c010e54e8a655f8424e2cc4c3a169fd1dcc992f838c8fc06894eebcccb12b5d0417b263b0de32fbffb66ebdccfb5b60940a3bd5122a9aa369921cd97e29
+  data.tar.gz: ae5f358894fe2ac1eded4d05be8e225959da65ba79251af378fb658f995569fd51b5f4dfe62bcbd9f0dabd560d07f42df56afe6ec6214fb44ea0f8cdaa9a3cfd

data/.github/workflows/{rspec.yaml → sus.yaml}

@@ -1,10 +1,10 @@
 # This workflow runs RSpec tests
 
-name: RSpec
+name: sus
 on: [push]
 jobs:
   test:
-    timeout-minutes: 10
+    timeout-minutes: 3
     strategy:
       fail-fast: false
       matrix:
@@ -14,7 +14,7 @@ jobs:
     - uses: actions/checkout@v4
     - uses: ruby/setup-ruby@v1
       with:
-        ruby-version: 3.4
+        ruby-version: 4.0
         bundler-cache: true
-    - run: bundle exec rspec -f d
+    - run: bundle exec sus
 

data/.rubocop.yml

@@ -1,8 +1,5 @@
-plugins:
-  - rubocop-rspec
-  - rubocop-rake
-
 AllCops:
+  SuggestExtensions: false
   NewCops: enable
   TargetRubyVersion: 3.4
   Exclude:
@@ -16,7 +13,7 @@ AllCops:
 Layout/LineLength:
   Max: 120
   Exclude:
-    - 'spec/**/*'
+    - 'test/**/*'
 
 # Allow some reasonable flexibility for domain-specific code
 Metrics/MethodLength:
@@ -43,10 +40,15 @@ Metrics/ParameterLists:
 # Allow some blocks to be longer for complex configurations and tests
 Metrics/BlockLength:
   Exclude:
-    - 'spec/**/*'
+    - 'test/**/*'
+    - 'test/**/*'
     - 'features/**/*'
     - '*.gemspec'
 
+Style/NumericPredicate:
+  Exclude:
+    - 'test/**/*.rb'
+
 # From Ruby 3.4, frozen string literals are the default anyways
 Style/FrozenStringLiteralComment:
   Enabled: false
@@ -54,16 +56,10 @@ Style/FrozenStringLiteralComment:
 # Allow mix-in usage at top level in test files
 Style/MixinUsage:
   Exclude:
-    - 'spec/**/*'
+    - 'test/**/*'
     - 'features/**/*'
 
 # Allow constant definition in blocks for test helpers
 Lint/ConstantDefinitionInBlock:
   Exclude:
-    - 'spec/**/*'
-
-RSpec/MultipleExpectations:
-  Max: 20
-
-RSpec/ExampleLength:
-  Max: 50
+    - 'test/**/*'

data/Gemfile

@@ -9,10 +9,9 @@ group :development do
   gem 'bundler', '~> 4.0'
   gem 'cucumber', '~> 9.2'
   gem 'rake', '~> 13.2'
-  gem 'rspec', '~> 3.13'
-  gem 'rspec-expectations', '~> 3.13'
-  gem 'rubocop', '~> 1.65'
+  gem 'rubocop'
   gem 'rubocop-rake', require: false
-  gem 'rubocop-rspec', require: false
+  gem 'sus'
+  gem 'sus-fixtures-async'
   gem 'timecop', '~> 0.9'
 end

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    rsmp (0.41.0)
+    rsmp (0.42.1)
       async (~> 2.32)
       colorize (~> 1.1)
       io-endpoint (~> 0.15)
@@ -20,13 +20,13 @@ GEM
       rspec-expectations (>= 3.4, < 5.0)
       thor (~> 1.0)
     ast (2.4.3)
-    async (2.38.1)
+    async (2.39.0)
       console (~> 1.29)
       fiber-annotation
       io-event (~> 1.11)
       metrics (~> 0.12)
       traces (~> 0.18)
-    bigdecimal (4.0.1)
+    bigdecimal (4.1.1)
     builder (3.3.0)
     colorize (1.1.0)
     console (1.34.3)
@@ -60,18 +60,17 @@ GEM
     cucumber-messages (22.0.0)
     cucumber-tag-expressions (6.1.2)
     diff-lcs (1.6.2)
-    ffi (1.17.3)
-    ffi (1.17.3-arm64-darwin)
-    ffi (1.17.3-x64-mingw-ucrt)
-    ffi (1.17.3-x86_64-darwin)
-    ffi (1.17.3-x86_64-linux-gnu)
+    ffi (1.17.4-arm64-darwin)
+    ffi (1.17.4-x64-mingw-ucrt)
+    ffi (1.17.4-x86_64-darwin)
+    ffi (1.17.4-x86_64-linux-gnu)
     fiber-annotation (0.2.0)
     fiber-local (1.1.0)
       fiber-storage
     fiber-storage (1.0.1)
     hana (1.3.7)
     io-endpoint (0.17.2)
-    io-event (1.14.5)
+    io-event (1.15.1)
     io-stream (0.11.1)
     json (2.19.3)
     json_schemer (2.5.0)
@@ -87,62 +86,59 @@ GEM
     mini_mime (1.1.5)
     multi_test (1.1.0)
     ostruct (0.6.3)
-    parallel (1.27.0)
-    parser (3.3.10.0)
+    parallel (2.0.1)
+    parser (3.3.11.1)
       ast (~> 2.4.1)
       racc
-    prism (1.8.0)
+    prism (1.9.0)
     racc (1.8.1)
     rainbow (3.1.1)
-    rake (13.3.1)
-    regexp_parser (2.11.3)
+    rake (13.4.2)
+    regexp_parser (2.12.0)
     rsmp_schema (0.10.1)
       json_schemer (~> 2.5)
       thor (~> 1.5)
-    rspec (3.13.2)
-      rspec-core (~> 3.13.0)
-      rspec-expectations (~> 3.13.0)
-      rspec-mocks (~> 3.13.0)
-    rspec-core (3.13.6)
-      rspec-support (~> 3.13.0)
     rspec-expectations (3.13.5)
       diff-lcs (>= 1.2.0, < 2.0)
       rspec-support (~> 3.13.0)
-    rspec-mocks (3.13.7)
-      diff-lcs (>= 1.2.0, < 2.0)
-      rspec-support (~> 3.13.0)
-    rspec-support (3.13.6)
-    rubocop (1.82.1)
+    rspec-support (3.13.7)
+    rubocop (1.86.1)
       json (~> 2.3)
       language_server-protocol (~> 3.17.0.2)
       lint_roller (~> 1.1.0)
-      parallel (~> 1.10)
+      parallel (>= 1.10)
       parser (>= 3.3.0.2)
       rainbow (>= 2.2.2, < 4.0)
       regexp_parser (>= 2.9.3, < 3.0)
-      rubocop-ast (>= 1.48.0, < 2.0)
+      rubocop-ast (>= 1.49.0, < 2.0)
       ruby-progressbar (~> 1.7)
       unicode-display_width (>= 2.4.0, < 4.0)
-    rubocop-ast (1.49.0)
+    rubocop-ast (1.49.1)
       parser (>= 3.3.7.2)
       prism (~> 1.7)
     rubocop-rake (0.7.1)
       lint_roller (~> 1.1)
       rubocop (>= 1.72.1)
-    rubocop-rspec (3.9.0)
-      lint_roller (~> 1.1)
-      rubocop (~> 1.81)
     ruby-progressbar (1.13.0)
     simpleidn (0.2.3)
-    sys-uname (1.4.1)
+    sus (0.36.0)
+    sus-fixtures-async (0.2.0)
+      async
+      sus (~> 0.10)
+    sys-uname (1.5.1)
+      ffi (~> 1.1)
+      memoist3 (~> 1.0.0)
+    sys-uname (1.5.1-universal-mingw32)
       ffi (~> 1.1)
       memoist3 (~> 1.0.0)
+      win32ole
     thor (1.5.0)
-    timecop (0.9.10)
+    timecop (0.9.11)
     traces (0.18.2)
     unicode-display_width (3.2.0)
       unicode-emoji (~> 4.1)
     unicode-emoji (4.2.0)
+    win32ole (1.9.3)
 
 PLATFORMS
   arm64-darwin-23
@@ -157,11 +153,10 @@ DEPENDENCIES
   cucumber (~> 9.2)
   rake (~> 13.2)
   rsmp!
-  rspec (~> 3.13)
-  rspec-expectations (~> 3.13)
-  rubocop (~> 1.65)
+  rubocop
   rubocop-rake
-  rubocop-rspec
+  sus
+  sus-fixtures-async
   timecop (~> 0.9)
 
 BUNDLED WITH

data/Rakefile

@@ -1,6 +1,7 @@
 require 'bundler/gem_tasks'
-require 'rspec/core/rake_task'
 
-RSpec::Core::RakeTask.new(:spec)
+task :test do
+  sh 'bundle exec sus'
+end
 
-task default: :spec
+task default: :test

data/config/sus.rb

@@ -0,0 +1,14 @@
+require 'rsmp'
+require 'sus/fixtures/async'
+require_relative '../test/support/async_helper'
+
+def test_paths
+  Dir.glob('test/**/*.rb', base: @root).reject { |p| p.start_with?('test/support/') }
+end
+
+def make_registry
+  registry = Sus::Registry.new(root: @root)
+  registry.base.include(Sus::Fixtures::Async::ReactorContext)
+  registry.base.include(AsyncHelper)
+  registry
+end

data/documentation/collecting_message.md

@@ -145,67 +145,82 @@ result = matcher.collect(options) do |message,item|
 end
 ```
 
-## Subscribing to status updates
-The method `subscribe_to_status` can be used to subscribe to one of more status messages.
+## Sending commands
+The method `send_command` sends a CommandRequest to the site and returns the sent message. `component:` defaults to `main.c_id`.
 
-### Without collection
-The simple form sends an RSMP status subscription message to the site and then returns immediatly. To collect incoming status messages, you need to manually use e.g. a Collector.
+```ruby
+message = send_command(
+  [{'cCI' => 'M0001', 'n' => 'status', 'v' => 'NormalControl'}],
+  component: 'AA+BBCCC=DDDEE001'
+)
+```
 
-A hash is returned, with `:sent` containing the send subscription messages.
+To send and wait for the CommandResponse, use `send_command_and_collect`. It returns a collector; call `.ok!` to raise on NotAck or timeout.
 
 ```ruby
-options = {
-	list: [{'sCI'=>'S0001','n'=>'signalgroupstatus'}],
-}
-result = subscribe_to_status(options)
-result.keys => # [:sent]
+collector = send_command_and_collect(
+  [{'cCI' => 'M0001', 'n' => 'status', 'v' => 'NormalControl'}],
+  within: 5,
+  component: 'AA+BBCCC=DDDEE001'
+)
+collector.ok!
 ```
 
-Note: If you want to use this simple form and manually collect responses, it's best to start collection in an asyncronous task _before_ you subscribe, to make sure you don't miss early responses:
+## Requesting status
+The method `request_status` sends a StatusRequest to the site and returns `{ sent: message }`. `component:` defaults to `main.c_id`.
 
 ```ruby
-task = async do
-	MessageCollector.new(options).collect(num: 5, timeout:10)  # start listening for status messages
-end
-result = subscribe_to_status(options) # subscribe
-task.wait  # wait for collection task to complete (or time out)
+result = request_status(
+  [{'sCI' => 'S0001', 'n' => 'signalgroupstatus'}],
+  component: 'AA+BBCCC=DDDEE001'
+)
+result[:sent]  # => the StatusRequest message
 ```
 
-### With collection
-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:
+To send and wait for the StatusResponse, use `request_status_and_collect`. It returns a collector; call `.ok!` to raise on NotAck or timeout.
 
 ```ruby
-options = {
-	list: [{'sCI'=>'S0001','n'=>'signalgroupstatus'}],
-	collect: {timeout: 5}
-}
-result = subscribe_to_status(options)
-result.keys => # [:sent, :collector]
-result[:collector].messages # => list of collected messages
+collector = request_status_and_collect(
+  [{'sCI' => 'S0001', 'n' => 'signalgroupstatus'}],
+  within: 5,
+  component: 'AA+BBCCC=DDDEE001'
+)
+collector.ok!
 ```
 
-You can pass you own collector which will give you more control of how to collect the incoming status messages:
+## Subscribing to status updates
+The method `subscribe_to_status` sends a StatusSubscribe message to the site and returns `{ sent: message }`. `component:` defaults to `main.c_id`.
+
+### Without collection
 
 ```ruby
-collector = Collector.new(options)
-options = {collect: collector}
-result = subscribe_to_status(options)
-result.keys => # [:sent, :collector]
-result[:collector].messages # => list of collected messages
+result = subscribe_to_status(
+  [{'sCI' => 'S0001', 'n' => 'signalgroupstatus', 'uRt' => '1'}],
+  component: 'AA+BBCCC=DDDEE001'
+)
+result[:sent]  # => the StatusSubscribe message
 ```
 
-### Processing responses
-If you pass a block, the block will be used to construct a collector. The block will be called for each matching  status item received.
-Collection will continue until the block returns :cancel, or it times out.
+If you want to manually collect incoming status updates after subscribing, start a collector before subscribing so you don't miss early responses:
 
 ```ruby
-options = {
-	list: [{'sCI'=>'S0001','n'=>'signalgroupstatus'}]
-}
-result = subscribe_to_status(options) do |message|
-	# do something with message
-	:keep # or not
+task = async do
+  MessageCollector.new(options).collect(num: 5, timeout: 10)
 end
-result.keys => # [:sent, :collector]
+subscribe_to_status(status_list)
+task.wait
+```
+
+### With collection
+
+Use `subscribe_to_status_and_collect` to subscribe and collect status updates matching the criteria. It returns a collector; call `.ok!` to raise on NotAck or timeout.
+
+```ruby
+collector = subscribe_to_status_and_collect(
+  [{'sCI' => 'S0001', 'n' => 'signalgroupstatus', 'uRt' => '1'}],
+  within: 5,
+  component: 'AA+BBCCC=DDDEE001'
+)
+collector.ok!
 ```
 

data/lib/rsmp/cli.rb

@@ -86,7 +86,8 @@ module RSMP
 
     def apply_basic_site_options(settings)
       settings['site_id'] = options[:id] if options[:id]
-      settings['core_version'] = options[:core] if options[:core]
+      settings['core_version'] = options[:core] || ENV['CORE_VERSION'] if options[:core] || ENV['CORE_VERSION']
+      settings['sxl_version'] = ENV['SXL_VERSION'] if ENV['SXL_VERSION']
     end
 
     def parse_supervisors(settings)

data/lib/rsmp/collect/collector.rb

@@ -8,7 +8,7 @@ module RSMP
     include Reporting
     include Logging
 
-    attr_reader :condition, :messages, :status, :error, :task, :m_id
+    attr_reader :condition, :messages, :status, :error, :task, :m_id, :initiator
 
     def initialize(distributor, options = {})
       initialize_receiver distributor, filter: options[:filter]
@@ -20,7 +20,8 @@ module RSMP
       }.deep_merge options
       @timeout = options[:timeout]
       @num = options[:num]
-      @m_id = options[:m_id]
+      @initiator = options[:initiator]
+      @m_id = options[:m_id] || @initiator&.attributes&.dig('mId')
       @condition = Async::Notification.new
       make_title options[:title]
 

data/lib/rsmp/command_list.rb

@@ -0,0 +1,42 @@
+module RSMP
+  # Represents an RSMP command list and converts between the two common formats:
+  #
+  # Compact form (used in validators and helpers):
+  #   RSMP::CommandList.new(:M0001, :setValue, securityCode: '1111', status: 'NormalControl')
+  #
+  # Raw wire Array (used in RSMP messages):
+  #   [
+  #     { 'cCI' => 'M0001', 'cO' => 'setValue', 'n' => 'securityCode', 'v' => '1111' },
+  #     { 'cCI' => 'M0001', 'cO' => 'setValue', 'n' => 'status',       'v' => 'NormalControl' }
+  #   ]
+  class CommandList
+    include Enumerable
+
+    def initialize(command_code_id, command_name, values)
+      @list = values.compact.map do |n, v|
+        {
+          'cCI' => command_code_id.to_s,
+          'cO' => command_name.to_s,
+          'n' => n.to_s,
+          'v' => v.to_s
+        }
+      end
+    end
+
+    def each(&)
+      @list.each(&)
+    end
+
+    def to_a
+      @list
+    end
+
+    def to_h
+      @list.each_with_object({}) do |item, hash|
+        code = item['cCI']
+        command = item['cO']
+        ((hash[code] ||= {})[command] ||= {})[item['n']] = item['v']
+      end
+    end
+  end
+end

data/lib/rsmp/node/site/site.rb

@@ -93,9 +93,9 @@ module RSMP
       end
     end
 
-    def aggregated_status_changed(component, options = {})
+    def aggregated_status_changed(component, _options = {})
       @proxies.each do |proxy|
-        proxy.send_aggregated_status component, options if proxy.ready?
+        proxy.send_aggregated_status component if proxy.ready?
       end
     end
 

data/lib/rsmp/proxy/modules/send.rb

@@ -47,23 +47,15 @@ module RSMP
           end
         end
 
-        def send_and_optionally_collect(message, options)
-          collect_options = options[:collect] || options[:collect!]
-          if collect_options
-            task = @task.async do |task|
-              task.annotate 'send_and_optionally_collect'
-              collector = yield collect_options     # call block to create collector
-              collector.collect
-              collector.ok! if options[:collect!]   # raise any errors if the bang version was specified
-              collector
-            end
-
-            send_message message, validate: options[:validate]
-            { sent: message, collector: task.wait }
-          else
-            send_message message, validate: options[:validate]
-            { sent: message }
+        def send_message_and_collect(message, collector, validate: true)
+          task = @task.async do |t|
+            t.annotate 'send_message_and_collect'
+            collector.collect
+            collector
           end
+          send_message message, validate: validate
+          collector = task.wait
+          { sent: message, collector: collector }
         end
 
         def apply_nts_message_attributes(message)

data/lib/rsmp/proxy/site/modules/aggregated_status.rb

@@ -3,20 +3,31 @@ module RSMP
     module Modules
       # Handles aggregated status requests and responses
       module AggregatedStatus
-        def request_aggregated_status(component, options = {})
+        # Build and send an AggregatedStatusRequest. Returns { sent: message }.
+        def request_aggregated_status(component, m_id: nil, validate: true)
           validate_ready 'request aggregated status'
-          m_id = options[:m_id] || RSMP::Message.make_m_id
+          m_id ||= RSMP::Message.make_m_id
           message = RSMP::AggregatedStatusRequest.new({
                                                         'cId' => component,
                                                         'mId' => m_id
                                                       })
           apply_nts_message_attributes message
-          send_and_optionally_collect message, options do |collect_options|
-            AggregatedStatusCollector.new(
-              self,
-              collect_options.merge(task: @task, m_id: m_id, num: 1)
-            )
-          end
+          send_message message, validate: validate
+          { sent: message }
+        end
+
+        # Build, send an AggregatedStatusRequest and collect the response. Returns the collector.
+        # Call .ok! on the result to raise on NotAck or timeout.
+        def request_aggregated_status_and_collect(component, within:, m_id: nil, validate: true)
+          validate_ready 'request aggregated status'
+          m_id ||= RSMP::Message.make_m_id
+          message = RSMP::AggregatedStatusRequest.new({
+                                                        'cId' => component,
+                                                        'mId' => m_id
+                                                      })
+          apply_nts_message_attributes message
+          collector = AggregatedStatusCollector.new(self, timeout: within, m_id: m_id, num: 1)
+          send_message_and_collect(message, collector, validate: validate)[:collector]
         end
 
         def validate_aggregated_status(message, status_elements)

data/lib/rsmp/proxy/site/modules/commands.rb

@@ -3,22 +3,35 @@ module RSMP
     module Modules
       # Handles command requests and responses
       module Commands
-        def send_command(component, command_list, options = {})
+        # Build and send a CommandRequest. Returns the CommandRequest message.
+        def send_command(command_list, component: nil, validate: true)
           validate_ready 'send command'
-          m_id = options[:m_id] || RSMP::Message.make_m_id
+          component ||= main.c_id
+          m_id = RSMP::Message.make_m_id
           message = RSMP::CommandRequest.new({
                                                'cId' => component,
                                                'arg' => command_list,
                                                'mId' => m_id
                                              })
           apply_nts_message_attributes message
-          send_and_optionally_collect message, options do |collect_options|
-            CommandResponseCollector.new(
-              self,
-              command_list,
-              collect_options.merge(task: @task, m_id: m_id)
-            )
-          end
+          send_message message, validate: validate
+          message
+        end
+
+        # Build, send a CommandRequest and collect the CommandResponse. Returns the collector.
+        # Raises on NotAck or timeout if ok! is called on the result.
+        def send_command_and_collect(command_list, within:, component: nil, validate: true)
+          validate_ready 'send command'
+          component ||= main.c_id
+          m_id = RSMP::Message.make_m_id
+          message = RSMP::CommandRequest.new({
+                                               'cId' => component,
+                                               'arg' => command_list,
+                                               'mId' => m_id
+                                             })
+          apply_nts_message_attributes message
+          collector = CommandResponseCollector.new(self, command_list, timeout: within, initiator: message)
+          send_message_and_collect(message, collector, validate: validate)[:collector]
         end
 
         def process_command_response(message)