rsmp_schema 0.8.9 → 0.9.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: e3d517e40ea10e09d966c92de4c6b80f4ca7fef46d455ad0cb1ae729d487801c
-  data.tar.gz: 17885aac6cd969bce5a059210658dee89fea7313641d28b45b1b05b526725283
+  metadata.gz: 86686f176a4c15c90f569c0d60dbeafb56a27c2fe0d06f379791f2314bf1884f
+  data.tar.gz: 5e33a0a3e94483f5fe496168b3de4c704e8ea566f32f217cce4db15829b654c6
 SHA512:
-  metadata.gz: e1d6261fc9b66f618996b82aedffec5499928686d737d4fcec33430c67486b82120a8d4d35612b18fa421b3f38f91462f3641d08bb7b4eba38f0f693e434ce97
-  data.tar.gz: b44020651b67f07b26a9a1907ca81b346a48d0be1f384cf8d60c870e3aa08ba472dd886390ef06c2434f24310e434ed327d74526a90b9a55d67c08a0d775f2ac
+  metadata.gz: 0d579d39429c9b4025794282e3fa45958f05849971b80745c089ca0fb8f79fe35909a1d800e1a6b92ff9aa4976c862e548197cb574b484ff0db5d9d1ed3b4b36
+  data.tar.gz: cb0d7767006fd9aac1ad8d6092df01a33bc089a46eef9d05be21433a0de437034de18cb63a9960bec94c11319735ac7beaf1b16b1841b5ad1c0f71cfa77629b7

data/.github/copilot-instructions.md

@@ -5,38 +5,28 @@ RSMP Schema is a Ruby gem that provides JSON Schema validation for RSMP (Road Si
 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.
 
 ## Environment Setup
-Copilot Agent runs in a minimal Docker container, NOT the devcontainer specified in .devcontainer.
 
-Ruby will be available, but bundler and gems must be installed.
-The Ruby version migh not match what's specified in .tool-versions, but it should still be possible to work in the repo
+Bootstrap, build, and test the repository using mise:
 
-## Installing bundler
-The bundler gem itself is usually included in modern Ruby distributions, but it's NOT included in the copilot agent container, so always install with:
-
-```sh
-gem install bundler --install-dir ~/.local/share/gem
-```
+```bash
+# Install mise (if not already installed), follow instructions at https://mise.jdx.dev/
+curl https://mise.run | sh
 
-Add gem executables to the PATH so they can be found:
-```sh
-export PATH="$HOME/.local/share/gem/bin:$PATH"
-```
+# Install the Ruby version specified in .tool-versions
+mise install
 
-## Installing Gems
-Always use the bundler `path` config to install gems in the user’s local directory:
-```sh
-bundle config set --local path ~/.local/share/gem
+# Install all dependencies.
+# The bundler gem is included by default in the Ruby installation and does not have to be installed first.
 bundle install
 ```
 
-## Using Gem Executables
-Always use 'bundle exec' to run executable from gems.
-
 ## Running Tests
+
 The test suite includes comprehensive RSpec tests covering:
 - Core RSMP message validation
 - Traffic Light Controller SXL validation
 
+
 Run the complete test suite:
 ```bash
 # Test command takes approximately 2 seconds
@@ -46,6 +36,7 @@ bundle exec rspec
 All tests should pass on a clean repository.
 
 ## CLI Tool Usage
+
 The gem provides a CLI tool for converting YAML SXL files to JSON Schema:
 
 ```bash
@@ -60,6 +51,7 @@ bundle exec exe/rsmp_schema convert -i schemas/tlc/1.2.1/sxl.yaml -o tmp/sxl_1.2
 ```
 
 ## Schema Regeneration
+
 Regenerate all TLC JSON schemas from their YAML sources:
 
 ```bash
@@ -85,6 +77,7 @@ bundle exec ruby examples/validate.rb
 Expected output: `ok` (indicates successful validation)
 
 ## Repository Structure
+
 Key directories and files:
 - `lib/rsmp_schema/` - Main gem code
 - `lib/rsmp_schema/cli.rb` - CLI tool implementation  
@@ -114,6 +107,7 @@ Key directories and files:
 - Helper: `spec/schemer_helper.rb`
 
 ## CI Pipeline Validation
+
 The repository uses GitHub Actions with the following requirements:
 - Runs on Ubuntu, macOS, and Windows
 - Tests with different Ruby versions
@@ -126,6 +120,7 @@ Before committing changes, ensure:
 - Ruby syntax is valid for modified files
 
 ## Validation Scenarios
+
 After making changes, always test these scenarios:
 
 1. **Schema regeneration**: Run `bundle exec rake regenerate` and verify no unexpected changes.
@@ -161,12 +156,15 @@ git status
 ```
 
 
+
 ## Dependencies and Versions
+
 See `rsmp_schema.gemspec` for current runtime and development dependencies.
 
 Requires the Ruby version specified in .tool-versions.
 
 ## Common Issues and Solutions
+
 **Ruby version or environment issues**:
 - Use mise for automatic Ruby management: `mise install`
 
@@ -186,6 +184,7 @@ Requires the Ruby version specified in .tool-versions.
 - Check Ruby version compatibility (see .tool-versions)
 
 ## Timing Expectations
+
 - **NEVER CANCEL**: Bundle install takes 10-15 seconds normally - wait for completion
 - **NEVER CANCEL**: Test suite takes 2 seconds - use 30+ second timeout  
 - **NEVER CANCEL**: Schema regeneration takes 0.75 seconds - very fast but allow buffer

data/.gitignore

@@ -5,3 +5,4 @@
 /tmp/
 /.DS_Store
 /.rspec_status
+/vendor/bundle/

data/.tool-versions

@@ -1 +1 @@
-ruby 3.3.2
+ruby 3.4

data/Gemfile.lock

@@ -1,23 +1,23 @@
 PATH
   remote: .
   specs:
-    rsmp_schema (0.8.9)
-      json_schemer (~> 2.4.0)
-      thor (~> 1.4.0)
+    rsmp_schema (0.9.0)
+      json_schemer (~> 2.3.0)
+      thor (~> 1.3.1)
 
 GEM
   remote: https://rubygems.org/
   specs:
-    bigdecimal (3.2.2)
+    bigdecimal (3.2.3)
     diff-lcs (1.6.2)
     hana (1.3.7)
-    json_schemer (2.4.0)
+    json_schemer (2.3.0)
       bigdecimal
       hana (~> 1.3)
       regexp_parser (~> 2.0)
       simpleidn (~> 0.2)
-    rake (13.3.0)
-    regexp_parser (2.11.2)
+    rake (13.2.1)
+    regexp_parser (2.11.3)
     rspec (3.13.1)
       rspec-core (~> 3.13.0)
       rspec-expectations (~> 3.13.0)
@@ -30,18 +30,18 @@ GEM
     rspec-mocks (3.13.5)
       diff-lcs (>= 1.2.0, < 2.0)
       rspec-support (~> 3.13.0)
-    rspec-support (3.13.5)
+    rspec-support (3.13.6)
     simpleidn (0.2.3)
-    thor (1.4.0)
+    thor (1.3.2)
 
 PLATFORMS
   ruby
 
 DEPENDENCIES
-  rake (~> 13.3.0)
+  rake (~> 13.2.1)
   rsmp_schema!
   rspec (~> 3.13.0)
   rspec-expectations (~> 3.13.0)
 
 BUNDLED WITH
-   2.5.11
+   2.7.2

data/lib/rsmp_schema/convert/export/json_schema.rb

@@ -61,7 +61,7 @@ module RSMP
             "items" => {
               "type" => "object",
               "required" => required,
-              "additionalProperties": false
+              "unevaluatedProperties" => false  # Modern alternative to additionalProperties
             }
           })
           out["items"]["properties"] = {}
@@ -71,16 +71,10 @@ module RSMP
           out
         end
 
-        # with draft-07 and older, using a $ref mean all other properties are ignored.
-        # to avoid this we need to use an allOf.
-        # this is changed from draft-08, but unfortunately, there is still no Ruby validator for that
+        # JSON Schema 2020-12 allows combining $ref with other properties directly
         def self.wrap_refs out
-          if out.keys.include? '$ref'
-            ref = out.delete '$ref'
-            { "allOf" => [out,{"$ref"=>ref}]}
-          else
-            out
-          end
+          # No wrapping needed with modern JSON Schema
+          out
         end
 
         # convert a yaml item with list: true to json schema
@@ -138,37 +132,53 @@ module RSMP
         def self.build_item item, property_key: 'v'
           unless item['arguments']
             json = {
+              "$schema" => "https://json-schema.org/draft/2020-12/schema",
               "description" => item['description'],
             }
             return json
           end
 
-          json = {
-            "description" => item['description'],
-            "allOf" => [
-              {
-               "properties" => { "n" => { "enum" => item['arguments'].keys.sort }},
-              },
+          arguments = item['arguments']
+
+          # For statuses (property_key == 's'), generate a single top-level gate:
+          # if q is undefined/unknown -> no constraints; else -> per-n branches.
+          if property_key == 's'
+            branches = arguments.map do |key, argument|
               {
-                "if" =>
-                {
-                  "required" => ["q"],
-                  "properties" => { "q"=> { "enum" => ["undefined","unknown"] }},
-                },
-                "then" => {},
-                "else" => {
-                  "allOf" => item['arguments'].map do |key,argument|
-                    {
-                      "if" => { "required" => ["n"], "properties" => { "n" => { "const" => key }}},
-                      "then" => { "properties" => { property_key => build_value(argument) }}
-                    }
-                  end
-                }
+                "if" => { "properties" => { "n" => { "const" => key } } },
+                "then" => { "properties" => { property_key => build_value(argument) } }
               }
-            ]
-          }
+            end
+
+            return {
+              "$schema" => "https://json-schema.org/draft/2020-12/schema",
+              "description" => item['description'],
+              "properties" => {
+                "n" => { "enum" => arguments.keys.sort }
+              },
+              # reference shared guard (relative from statuses folder to tlc/defs)
+              "if" => { "$ref" => "../../defs/guards.json#/$defs/q_unknown_or_undefined" },
+              "then" => {},
+              "else" => { "allOf" => branches }
+            }
+          end
+
+          # Default behavior (alarms/commands): keep simple per-n if/then rules without q gating
+          rules = arguments.map do |key, argument|
+            {
+              "if" => { "properties" => { "n" => { "const" => key } } },
+              "then" => { "properties" => { property_key => build_value(argument) } }
+            }
+          end
 
-          json
+          {
+            "$schema" => "https://json-schema.org/draft/2020-12/schema",
+            "description" => item['description'],
+            "properties" => {
+              "n" => { "enum" => arguments.keys.sort }
+            },
+            "allOf" => rules
+          }
         end
 
         # convert alarms to json schema
@@ -180,6 +190,7 @@ module RSMP
             }
           end
           json = {
+            "$schema" => "https://json-schema.org/draft/2020-12/schema",
             "properties" => {
               "aCId" => { "enum" => items.keys.sort },
               "rvs" => { "items" => { "allOf" => list } }
@@ -197,6 +208,19 @@ module RSMP
 
         # convert statuses to json schema
         def self.output_statuses out, items
+          # ensure shared guard is written (relative to version folder)
+          out['../defs/guards.json'] ||= output_json({
+            "$schema" => "https://json-schema.org/draft/2020-12/schema",
+            "$defs" => {
+              "q_unknown_or_undefined" => {
+                "allOf" => [
+                  { "required" => ["q"] },
+                  { "properties" => { "q" => { "enum" => ["undefined", "unknown"] } } }
+                ]
+              }
+            }
+          })
+
           list = [ { "properties" => { "sCI" => { "enum"=> items.keys.sort }}} ]
           items.keys.sort.each do |key|
             list << {
@@ -204,7 +228,10 @@ module RSMP
               "then" => { "$ref" => "#{key}.json" }
             }
           end
-          json = { "properties" => { "sS" => { "items" => { "allOf" => list }}}}
+          json = { 
+            "$schema" => "https://json-schema.org/draft/2020-12/schema",
+            "properties" => { "sS" => { "items" => { "allOf" => list }}}
+          }
           out['statuses/statuses.json'] = output_json json
           items.each_pair { |key,item| output_status out, key, item }
         end
@@ -224,13 +251,22 @@ module RSMP
               "then" => { "$ref" => "#{key}.json" }
             }
           end
-          json = { "items" => { "allOf" => list }}
+          json = { 
+            "$schema" => "https://json-schema.org/draft/2020-12/schema",
+            "items" => { "allOf" => list }
+          }
           out['commands/commands.json'] = output_json json
 
-          json = { "properties" => { "arg" => { "$ref" => "commands.json" }}}
+          json = { 
+            "$schema" => "https://json-schema.org/draft/2020-12/schema",
+            "properties" => { "arg" => { "$ref" => "commands.json" }}
+          }
           out['commands/command_requests.json'] = output_json json
 
-          json = { "properties" => { "rvs" => { "$ref" => "commands.json" }}}
+          json = { 
+            "$schema" => "https://json-schema.org/draft/2020-12/schema",
+            "properties" => { "rvs" => { "$ref" => "commands.json" }}
+          }
           out['commands/command_responses.json'] = output_json json
 
           items.each_pair { |key,item| output_command out, key, item }
@@ -239,13 +275,17 @@ module RSMP
         # convert a command to json schema
         def self.output_command out, key, item
           json = build_item item
-          json["allOf"].first["properties"]['cO'] = { "const" => item['command'] }
+          # Always add the command operation (cO) constraint at the top-level properties
+          json["properties"] ||= {}
+          json["properties"]["cO"] = { "const" => item['command'] }
+          
           out["commands/#{key}.json"] = output_json json
         end
 
         # output the json schema root
         def self.output_root out, meta
           json = {
+            "$schema" => "https://json-schema.org/draft/2020-12/schema",
             "name"=> meta['name'],
             "description"=> meta['description'],
             "version"=> meta['version'],

data/lib/rsmp_schema/version.rb

@@ -1,5 +1,5 @@
 module RSMP
   module Schema
-    VERSION = "0.8.9"
+    VERSION = "0.9.0"
   end
 end

data/lib/rsmp_schema.rb

@@ -1,5 +1,10 @@
 require 'yaml'
 require 'json_schemer'
+
+# Define module hierarchy first
+module RSMP
+end
+
 require 'rsmp_schema/error'
 require 'rsmp_schema/schema'
 require 'rsmp_schema/convert/import/yaml'

data/rsmp_schema.gemspec

@@ -30,10 +30,10 @@ Gem::Specification.new do |spec|
   spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
   spec.require_paths = ["lib"]
 
-  spec.add_dependency "json_schemer", "~> 2.4.0"
-  spec.add_dependency "thor", "~> 1.4.0"
+  spec.add_dependency "json_schemer", "~> 2.3.0"
+  spec.add_dependency "thor", "~> 1.3.1"
 
-  spec.add_development_dependency "rake", "~> 13.3.0"
+  spec.add_development_dependency "rake", "~> 13.2.1"
   spec.add_development_dependency "rspec", "~> 3.13.0"
   spec.add_development_dependency "rspec-expectations", "~> 3.13.0"
 end

data/schemas/core/3.3.0/aggregated_status.json

@@ -0,0 +1,90 @@
+{
+  "title" :  "Aggregated Status",
+  "description" :  "Aggregated status message (bits 2 and 8 are unused and must be false in 3.3.0)",
+  "properties" : {
+    "mId" : { "$ref": "../3.1.2/definitions.json#/message_id" },
+    "aSTS" : { "$ref": "../3.1.2/definitions.json#/timestamp" },
+    "fP" : {
+      "description" : "Functional position",
+      "type" : ["string","null"]
+    },
+    "fS" : {
+      "description" : "Functional state",
+      "type" : ["string","null"]
+    },
+    "se" : {
+      "description" : "Aggregated status bits (2 and 8 unused -> always false)",
+      "type" : "array",
+      "minItems": 8,
+      "maxItems": 8,
+      "items": { "type": "boolean" },
+      "enum": [
+        [false,false,false,false,false,false,false,false],
+        [false,false,false,false,false,false,true,false],
+        [false,false,false,false,false,true,false,false],
+        [false,false,false,false,false,true,true,false],
+        [false,false,false,false,true,false,false,false],
+        [false,false,false,false,true,false,true,false],
+        [false,false,false,false,true,true,false,false],
+        [false,false,false,false,true,true,true,false],
+        [false,false,false,true,false,false,false,false],
+        [false,false,false,true,false,false,true,false],
+        [false,false,false,true,false,true,false,false],
+        [false,false,false,true,false,true,true,false],
+        [false,false,false,true,true,false,false,false],
+        [false,false,false,true,true,false,true,false],
+        [false,false,false,true,true,true,false,false],
+        [false,false,false,true,true,true,true,false],
+        [false,false,true,false,false,false,false,false],
+        [false,false,true,false,false,false,true,false],
+        [false,false,true,false,false,true,false,false],
+        [false,false,true,false,false,true,true,false],
+        [false,false,true,false,true,false,false,false],
+        [false,false,true,false,true,false,true,false],
+        [false,false,true,false,true,true,false,false],
+        [false,false,true,false,true,true,true,false],
+        [false,false,true,true,false,false,false,false],
+        [false,false,true,true,false,false,true,false],
+        [false,false,true,true,false,true,false,false],
+        [false,false,true,true,false,true,true,false],
+        [false,false,true,true,true,false,false,false],
+        [false,false,true,true,true,false,true,false],
+        [false,false,true,true,true,true,false,false],
+        [false,false,true,true,true,true,true,false],
+        [true,false,false,false,false,false,false,false],
+        [true,false,false,false,false,false,true,false],
+        [true,false,false,false,false,true,false,false],
+        [true,false,false,false,false,true,true,false],
+        [true,false,false,false,true,false,false,false],
+        [true,false,false,false,true,false,true,false],
+        [true,false,false,false,true,true,false,false],
+        [true,false,false,false,true,true,true,false],
+        [true,false,false,true,false,false,false,false],
+        [true,false,false,true,false,false,true,false],
+        [true,false,false,true,false,true,false,false],
+        [true,false,false,true,false,true,true,false],
+        [true,false,false,true,true,false,false,false],
+        [true,false,false,true,true,false,true,false],
+        [true,false,false,true,true,true,false,false],
+        [true,false,false,true,true,true,true,false],
+        [true,false,true,false,false,false,false,false],
+        [true,false,true,false,false,false,true,false],
+        [true,false,true,false,false,true,false,false],
+        [true,false,true,false,false,true,true,false],
+        [true,false,true,false,true,false,false,false],
+        [true,false,true,false,true,false,true,false],
+        [true,false,true,false,true,true,false,false],
+        [true,false,true,false,true,true,true,false],
+        [true,false,true,true,false,false,false,false],
+        [true,false,true,true,false,false,true,false],
+        [true,false,true,true,false,true,false,false],
+        [true,false,true,true,false,true,true,false],
+        [true,false,true,true,true,false,false,false],
+        [true,false,true,true,true,false,true,false],
+        [true,false,true,true,true,true,false,false],
+        [true,false,true,true,true,true,true,false]
+      ]
+    }
+  },
+  "required" : [ "mId", "aSTS", "fP", "fS", "se" ]
+}

data/schemas/core/3.3.0/aggregated_status_request.json

@@ -0,0 +1,9 @@
+{
+  "title" :  "Aggregated Status Request",
+  "description" :  "Aggregated status request message",
+  "properties" : {
+    "mId" : { "$ref": "../3.1.2/definitions.json#/message_id" },
+    "cId" : { "$ref": "definitions.json#/component_id" }
+  },
+  "required" : [ "mId", "cId" ]
+}

data/schemas/core/3.3.0/alarm.json

@@ -0,0 +1,75 @@
+{
+  "title" :  "Alarm",
+  "description" :  "Alarm messsage",
+  "properties" : {
+    "mId" : { "$ref": "../3.1.2/definitions.json#/message_id" },
+    "cId" : { "$ref": "definitions.json#/component_id" },
+    "aCId" : { "$ref": "../3.1.2/definitions.json#/alarm_code" },
+    "xACId" : { "description" : "External alarm code id", "type" : "string" },
+    "aSp" : {
+      "description" : "Alarm specialization",
+      "type" : "string",
+      "enum" : [ "Issue", "Acknowledge", "Suspend", "Resume", "Request",
+                 "issue", "acknowledge", "request" ]
+    }
+  },
+  "required" : [ "aSp"],
+  "allOf" : [
+    {
+      "if": {
+        "required" : [ "aSp" ],
+        "properties" : {
+          "aSp" : { "enum" : [ "Issue",
+                               "issue"] }
+        }
+      },
+      "then": { "$ref": "../3.1.2/alarm_issue.json" }
+    },
+    {
+      "if": {
+        "allOf" : [
+          {
+            "required" : [ "aSp" ],
+            "properties" : {
+              "aSp" : { "enum" : [ "Suspend", "Resume"] }
+            }
+          },
+          {
+            "not": { "required" : [ "sS" ] }
+          }
+        ]
+      },
+      "then": { "$ref": "../3.1.2/alarm_suspend_resume.json" }
+    },
+    {
+      "if": {
+        "required" : [ "aSp", "sS" ],
+        "properties" : {
+          "aSp" : { "enum" : [ "Suspend", "Resume"] },
+          "sS" : { "enum" : [ "suspended", "notSuspended",
+                              "Suspended", "NotSuspended" ] }
+        }
+      },
+      "then": { "$ref": "../3.1.2/alarm_suspended_resumed.json" }
+    },
+    {
+      "if": {
+        "required" : [ "aSp" ],
+        "properties" : {
+          "aSp" : { "enum" : [ "Acknowledge"] }
+        }
+      },
+      "then": { "$ref": "../3.1.2/alarm_acknowledge.json" }
+    },
+    {
+      "if": {
+        "required" : [ "aSp" ],
+        "properties" : {
+          "aSp" : { "enum" : [ "Request",
+                               "request"] }
+        }
+      },
+      "then": { "$ref": "alarm_request.json" }
+    }
+   ]
+}

data/schemas/core/3.3.0/alarm_request.json

@@ -0,0 +1,3 @@
+{
+  "required" : [ "mId", "cId", "aCId", "xACId", "aSp" ]
+}

data/schemas/core/3.3.0/command_request.json

@@ -0,0 +1,26 @@
+{
+  "title" :  "CommandRequest",
+  "description" :  "Command request",
+  "properties" : {
+    "mId" : { "$ref": "../3.1.2/definitions.json#/message_id" },
+    "cId" : { "$ref": "definitions.json#/component_id" },
+    "arg" : {
+      "description" : "Command arguments",
+      "type" : "array",
+  "minItems": 1,
+  "maxItems": 1,
+      "items" : {
+        "type" : "object",
+        "properties": {
+          "cCI" : { "$ref": "../3.1.2/definitions.json#/command_code" },
+          "n" : { "description" : "Unique reference of the value", "type" : "string" },
+          "cO" : { "description" : "Command", "type" : "string" },
+          "v" : { "description" : "Value" }
+        },
+        "required" : [ "cCI", "n", "cO", "v" ],
+        "additionalProperties": false
+      }
+    }
+  },
+  "required" : [ "mId", "cId", "arg"]
+}

data/schemas/core/3.3.0/command_response.json

@@ -0,0 +1,35 @@
+{
+  "title" :  "CommandResponse",
+  "description" :  "Command response",
+  "properties" : {
+    "mId" : { "$ref": "../3.1.2/definitions.json#/message_id" },
+    "cId" : { "$ref": "definitions.json#/component_id" },
+    "cTS" : { "$ref": "../3.1.2/definitions.json#/timestamp" },
+    "rvs" : {
+      "description" : "Command arguments",
+      "type" : "array",
+  "maxItems": 1,
+      "items" : {
+        "type" : "object",
+        "properties": {
+          "cCI" : { "$ref": "../3.1.2/definitions.json#/command_code" },
+          "n" : {
+            "description" : "Unique reference of the value",
+            "type" : "string"
+          },
+          "v" : {
+            "description" : "Value"
+          },
+          "age" : {
+            "description" : "Age of the value",
+            "type" : "string",
+            "enum" : [ "recent", "old", "undefined", "unknown" ]
+          }
+        },
+        "required" : [ "cCI", "n", "v", "age" ],
+        "additionalProperties": false
+      }
+    }
+  },
+  "required" : [ "mId", "cId", "cTS", "rvs" ]
+}