rsmp 0.35.2 → 0.38.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: e5c0f93062b73555dd67edda6564054299c1df0240c4ce55f0b854abc7e94931
-  data.tar.gz: 2659660e29f1ba7b50533b3e89bb80c81ae69f81768cbc4012db6da6776ccebc
+  metadata.gz: 3f1f32aacd75ffad7d36662c3e7abd0b0a851b35b287f444dd63cdebc9db1c00
+  data.tar.gz: 32d9db803bc5ef274c1838cb961f677863745bb2e2eca105eb17b8ee4f39cea1
 SHA512:
-  metadata.gz: c48367c147156f5adb8cdabfd5fc81cde4cbb3e842f05c982307b6400f6fb33deb583cc57737faa2e7a1fe2a87f7e629dde7b335f063e126a403e45f49774c2f
-  data.tar.gz: 77c5e1343d7106bd9a60ff55e666d69cb4589655e7ad9bcbcf84cb95101e3b7c004bf373943f018d24b38d5cb6f6cccc97f7a0202fe2c8f5dc6ad7e687134c1b
+  metadata.gz: a655dab4868d9544a0242303da7d26254f3d953ecc5d789c78f7e4553e946b98eebab7f59fa4ee69c736123dfa198417885595db490724b6238fa051b1fb2a87
+  data.tar.gz: f24fe238a17439e6e0b91e75f816733da49f9e348dd22cc00f3c68938505ca68ba7ed32575a71e9dfc18330a10f2b92fe23ade7679bdb3f0878b37e894fd55aa

data/.devcontainer/devcontainer.json

@@ -0,0 +1,22 @@
+// For format details, see https://aka.ms/devcontainer.json. For config options, see the
+// README at: https://github.com/devcontainers/templates/tree/main/src/ruby
+{
+	"name": "Ruby",
+	// Or use a Dockerfile or Docker Compose file. More info: https://containers.dev/guide/dockerfile
+	"image": "mcr.microsoft.com/devcontainers/ruby:3.4",
+
+	// Features to add to the dev container. More info: https://containers.dev/features.
+	// "features": {},
+
+	// Use 'forwardPorts' to make a list of ports inside the container available locally.
+	// "forwardPorts": [],
+
+	// A command to run when creating the container and rerun when the workspace content was updated while creating the container
+	   "updateContentCommand": "bundle install"
+
+	// Configure tool-specific properties.
+	// "customizations": {},
+
+	// Uncomment to connect as root instead. More info: https://aka.ms/dev-containers-non-root.
+	// "remoteUser": "root"
+}

data/.github/copilot-instructions.md

@@ -0,0 +1,33 @@
+# rsmp gem
+This is a Ruby based repository contaning an implementation of RSMP (RoadSide Message Protocol), including:
+
+- Ruby classes that can be used to build tests or other RSMP tools.
+- Command-line tools for quickly running RSMP supervisors or sites and view messages exchanged.
+
+It relies on the gem `rsmp_schema` to validate RSMP message using JSON schema.
+
+Always reference these instructions first, and fall back to search or bash commands only when you encounter unexpected information that does not match the info here.
+
+## Development Flow
+- Ruby and required gems are already installed by the action .github/copilot-setup-steps.yml, do not install them again.
+- All gem executables must be run from the bundle environment using `bundle exec ...`
+- Before any commit, run `bundle exec rspec` to verify that all tests pass.
+
+## Repository Structure
+- `bin/`: Main service entry points and executables
+- `lib/`: Ruby source code
+- `spec/`: RSpec test files for validating Ruby code
+- `features/`: Cucumber test files for validating the CLI component
+- `config/`: Configuration files used when running the 'rsmp' command line
+- `documentation/`: Documentation
+
+## Guidelines
+- Follow Ruby best practices and idiomatic patterns.
+- Maintain existing code structure and organization.
+- Always use existing async patterns to handle concurrency, also in tests.
+- Code behaviour should adhere to the RSMP specifications defined at https://github.com/rsmp-nordic/rsmp_core.
+- Write and verify rspec tests for new functionality.
+- Document public APIs and complex logic. Suggest changes to the `documentation/` folder when appropriate.
+- Don't commit example scripts.
+- Prefer real classes over test doubles or mocks in tests and use async contexts to run sites and supervisors.
+- When reporting on progress, claims should be supported by tests or other data.

data/.github/workflows/copilot-setup-steps.yml

@@ -0,0 +1,35 @@
+name: "Copilot Setup Steps"
+
+# Automatically run the setup steps when they are changed to allow for easy validation, and
+# allow manual testing through the repository's "Actions" tab
+on:
+  workflow_dispatch:
+  push:
+    paths:
+      - .github/workflows/copilot-setup-steps.yml
+  pull_request:
+    paths:
+      - .github/workflows/copilot-setup-steps.yml
+
+jobs:
+  # The job MUST be called `copilot-setup-steps` or it will not be picked up by Copilot.
+  copilot-setup-steps:
+    runs-on: ubuntu-latest
+
+    # Set the permissions to the lowest permissions possible needed for your steps.
+    # Copilot will be given its own token for its operations.
+    permissions:
+      # If you want to clone the repository as part of your setup steps, for example to install dependencies, you'll need the `contents: read` permission. If you don't clone the repository in your setup steps, Copilot will do this for you automatically after the steps complete.
+      contents: read
+
+    # You can define any steps you want, and they will run before the agent starts.
+    # If you do not check out your code, Copilot will do this for you.
+    steps:
+      - name: Checkout code
+        uses: actions/checkout@v4
+
+      - uses: ruby/setup-ruby@v1
+        with:
+          ruby-version: 3.4
+          bundler-cache: true
+

data/.github/workflows/rspec.yaml

@@ -14,6 +14,7 @@ jobs:
     - uses: actions/checkout@v4
     - uses: ruby/setup-ruby@v1
       with:
-        ruby-version: 3.3
+        ruby-version: 3.4
         bundler-cache: true
     - run: bundle exec rspec -f d
+

data/.github/workflows/rubocop.yaml

@@ -0,0 +1,17 @@
+# This workflow runs RSpec tests
+
+name: Rubocop
+on: [push]
+jobs:
+  test:
+    timeout-minutes: 10
+    strategy:
+      fail-fast: false
+    runs-on: ubuntu-latest
+    steps:
+    - uses: actions/checkout@v4
+    - uses: ruby/setup-ruby@v1
+      with:
+        bundler-cache: true
+    - run: bundle exec rubocop
+

data/.gitignore

@@ -1,16 +1,16 @@
-ignore
-log
-.DS_Store
-.rspec_status
-
+/.DS_Store
+/.rspec_status
+/ignore/
+/log/
 /.bundle/
-/.yardoc
+/.yardoc/
 /_yardoc/
 /coverage/
 /doc/
 /pkg/
-/spec/reports/
 /tmp/
+/vendor/
+/spec/reports/
 /config/private/
 
 

data/.rubocop.yml

@@ -0,0 +1,80 @@
+AllCops:
+  NewCops: enable
+  TargetRubyVersion: 3.4
+  Exclude:
+    - 'vendor/**/*'
+    - 'bin/**/*'
+    - '.bundle/**/*'
+    - 'ignore/**/*'
+    - 'config/private/**/*'
+
+# Allow longer line lengths for tests with long JSON strings
+Layout/LineLength:
+  Max: 120
+  Exclude:
+    - 'spec/**/*'
+
+# Allow some reasonable flexibility for domain-specific code
+Metrics/MethodLength:
+  Max: 25
+
+Metrics/ClassLength:
+  Max: 200
+
+Metrics/ModuleLength:
+  Max: 200
+
+Metrics/AbcSize:
+  Max: 20
+
+Metrics/CyclomaticComplexity:
+  Max: 10
+
+Metrics/PerceivedComplexity:
+  Max: 10
+
+Metrics/ParameterLists:
+  Max: 5
+
+# Allow some blocks to be longer for complex configurations and tests
+Metrics/BlockLength:
+  Exclude:
+    - 'spec/**/*'
+    - 'features/**/*'
+    - '*.gemspec'
+
+# Keep some reasonable exceptions
+Style/Documentation:
+  Enabled: false
+
+Style/FrozenStringLiteralComment:
+  Enabled: false
+
+# Allow double negation for boolean coercion - common Ruby pattern
+Style/DoubleNegation:
+  Enabled: false
+
+# Allow mix-in usage at top level in test files
+Style/MixinUsage:
+  Exclude:
+    - 'spec/**/*'
+    - 'features/**/*'
+
+# Allow constant definition in blocks for test helpers
+Lint/ConstantDefinitionInBlock:
+  Exclude:
+    - 'spec/**/*'
+
+# Keep critical domain-specific logic intact
+Style/ReturnNilInPredicateMethodDefinition:
+  Enabled: false
+
+
+plugins:
+  - rubocop-rspec
+
+RSpec/MultipleExpectations:
+  Max: 20
+
+RSpec/ExampleLength:
+  Max: 50

data/Gemfile

@@ -1,5 +1,17 @@
-source "https://rubygems.org"
+source 'https://rubygems.org'
 
 # Specify your gem's dependencies in rsmp.gemspec
 
 gemspec
+
+group :development do
+  gem 'aruba', '~> 2.3'
+  gem 'bundler', '~> 2.6'
+  gem 'cucumber', '~> 9.2'
+  gem 'rake', '~> 13.2'
+  gem 'rspec', '~> 3.13'
+  gem 'rspec-expectations', '~> 3.13'
+  gem 'rubocop', '~> 1.65'
+  gem 'rubocop-rspec', require: false
+  gem 'timecop', '~> 0.9'
+end

data/Gemfile.lock

@@ -1,10 +1,11 @@
 PATH
   remote: .
   specs:
-    rsmp (0.35.2)
-      async (~> 2.21)
-      async-io (~> 1.43)
+    rsmp (0.38.0)
+      async (~> 2.32)
       colorize (~> 1.1)
+      io-endpoint (~> 0.15)
+      io-stream (~> 0.10)
       logger (~> 1.6)
       ostruct (~> 0.6)
       rsmp_schema (~> 0.8)
@@ -12,24 +13,23 @@ PATH
 GEM
   remote: https://rubygems.org/
   specs:
-    aruba (2.3.0)
+    aruba (2.3.1)
       bundler (>= 1.17, < 3.0)
       contracts (>= 0.16.0, < 0.18.0)
-      cucumber (>= 8.0, < 10.0)
+      cucumber (>= 8.0, < 11.0)
       rspec-expectations (~> 3.4)
       thor (~> 1.0)
-    async (2.23.0)
+    ast (2.4.3)
+    async (2.32.0)
       console (~> 1.29)
       fiber-annotation
-      io-event (~> 1.9)
+      io-event (~> 1.11)
       metrics (~> 0.12)
-      traces (~> 0.15)
-    async-io (1.43.2)
-      async
-    bigdecimal (3.1.9)
+      traces (~> 0.18)
+    bigdecimal (3.2.3)
     builder (3.3.0)
     colorize (1.1.0)
-    console (1.29.3)
+    console (1.34.0)
       fiber-annotation
       fiber-local (~> 1.1)
       json
@@ -55,57 +55,93 @@ GEM
       bigdecimal
     cucumber-gherkin (27.0.0)
       cucumber-messages (>= 19.1.4, < 23)
-    cucumber-html-formatter (21.9.0)
+    cucumber-html-formatter (21.14.0)
       cucumber-messages (> 19, < 28)
     cucumber-messages (22.0.0)
     cucumber-tag-expressions (6.1.2)
-    diff-lcs (1.6.0)
-    ffi (1.17.1)
+    diff-lcs (1.6.2)
+    ffi (1.17.2)
+    ffi (1.17.2-arm64-darwin)
     fiber-annotation (0.2.0)
     fiber-local (1.1.0)
       fiber-storage
-    fiber-storage (1.0.0)
+    fiber-storage (1.0.1)
     hana (1.3.7)
-    io-event (1.9.0)
-    json (2.10.1)
-    json_schemer (2.3.0)
+    io-endpoint (0.15.2)
+    io-event (1.14.0)
+    io-stream (0.10.0)
+    json (2.14.1)
+    json_schemer (2.4.0)
       bigdecimal
       hana (~> 1.3)
       regexp_parser (~> 2.0)
       simpleidn (~> 0.2)
-    logger (1.6.6)
-    metrics (0.12.1)
+    language_server-protocol (3.17.0.5)
+    lint_roller (1.1.0)
+    logger (1.7.0)
+    memoist3 (1.0.0)
+    metrics (0.15.0)
     mini_mime (1.1.5)
     multi_test (1.1.0)
-    ostruct (0.6.1)
-    rake (13.2.1)
-    regexp_parser (2.10.0)
-    rsmp_schema (0.8.7)
-      json_schemer (~> 2.3.0)
-      thor (~> 1.3.1)
-    rspec (3.13.0)
+    ostruct (0.6.3)
+    parallel (1.27.0)
+    parser (3.3.9.0)
+      ast (~> 2.4.1)
+      racc
+    prism (1.5.1)
+    racc (1.8.1)
+    rainbow (3.1.1)
+    rake (13.3.0)
+    regexp_parser (2.11.2)
+    rsmp_schema (0.8.9)
+      json_schemer (~> 2.4.0)
+      thor (~> 1.4.0)
+    rspec (3.13.1)
       rspec-core (~> 3.13.0)
       rspec-expectations (~> 3.13.0)
       rspec-mocks (~> 3.13.0)
-    rspec-core (3.13.3)
+    rspec-core (3.13.5)
       rspec-support (~> 3.13.0)
-    rspec-expectations (3.13.3)
+    rspec-expectations (3.13.5)
       diff-lcs (>= 1.2.0, < 2.0)
       rspec-support (~> 3.13.0)
-    rspec-mocks (3.13.2)
+    rspec-mocks (3.13.5)
       diff-lcs (>= 1.2.0, < 2.0)
       rspec-support (~> 3.13.0)
-    rspec-support (3.13.2)
+    rspec-support (3.13.5)
+    rubocop (1.81.0)
+      json (~> 2.3)
+      language_server-protocol (~> 3.17.0.2)
+      lint_roller (~> 1.1.0)
+      parallel (~> 1.10)
+      parser (>= 3.3.0.2)
+      rainbow (>= 2.2.2, < 4.0)
+      regexp_parser (>= 2.9.3, < 3.0)
+      rubocop-ast (>= 1.47.1, < 2.0)
+      ruby-progressbar (~> 1.7)
+      unicode-display_width (>= 2.4.0, < 4.0)
+    rubocop-ast (1.47.1)
+      parser (>= 3.3.7.2)
+      prism (~> 1.4)
+    rubocop-rspec (3.7.0)
+      lint_roller (~> 1.1)
+      rubocop (~> 1.72, >= 1.72.1)
+    ruby-progressbar (1.13.0)
     simpleidn (0.2.3)
-    sys-uname (1.3.1)
+    sys-uname (1.4.1)
       ffi (~> 1.1)
-    thor (1.3.2)
+      memoist3 (~> 1.0.0)
+    thor (1.4.0)
     timecop (0.9.10)
-    traces (0.15.2)
+    traces (0.18.2)
+    unicode-display_width (3.2.0)
+      unicode-emoji (~> 4.1)
+    unicode-emoji (4.1.0)
 
 PLATFORMS
   arm64-darwin-22
   arm64-darwin-23
+  arm64-darwin-24
   x64-mingw-ucrt
   x64-mingw32
   x86_64-darwin-19
@@ -122,6 +158,8 @@ DEPENDENCIES
   rsmp!
   rspec (~> 3.13)
   rspec-expectations (~> 3.13)
+  rubocop (~> 1.65)
+  rubocop-rspec
   timecop (~> 0.9)
 
 BUNDLED WITH

data/Rakefile

@@ -1,6 +1,6 @@
-require "bundler/gem_tasks"
-require "rspec/core/rake_task"
+require 'bundler/gem_tasks'
+require 'rspec/core/rake_task'
 
 RSpec::Core::RakeTask.new(:spec)
 
-task :default => :spec
+task default: :spec

data/bin/console

@@ -14,10 +14,8 @@ module IRB
   class MyInputMethod < StdioInputMethod
     def initialize
       super
-      @input = Async::IO::Protocol::Line.new(
-        Async::IO::Stream.new(
-          Async::IO::Generic.new($stdin)
-        )
+      @input = RSMP::Protocol.new(
+        IO::Stream::Buffered.new($stdin)
       )
     end
 

data/documentation/tasks.md

@@ -74,16 +74,16 @@ SiteProxy and SupervisorProxy both inherit from Proxy and have a reader task and
 ## Task Hierachy
 When you start an Async task, the parent will be the currently running task, unless you specify a different parent task.
 
-The Async task hierarchy is similar to the object hierachy, with the difference that proxies have reader and timer tasks. And Async::IO which is used to handle TPC connections concurently, will create some intermediate tasks:
+The Async task hierarchy is similar to the object hierachy, with the difference that proxies have reader and timer tasks. And IO::Endpoint which is used to handle TCP connections concurently, will create some intermediate tasks:
 
 ```
 Supervisor @task
-	accepting connections      # this task is created by Async::IO
-		incoming connection 1    # this task is created by Async::IO
+	accepting connections      # this task is created by IO::Endpoint
+		incoming connection 1    # this task is created by IO::Endpoint
 			SiteProxy @task
 				SiteProxy @reader
 				SiteProxy @timer
-		incoming connection 2    # this task is created by Async::IO
+		incoming connection 2    # this task is created by IO::Endpoint
 			SiteProxy @task
 				SiteProxy @reader
 				SiteProxy @timer