rsmp_schema 0.8.9 → 0.9.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: e3d517e40ea10e09d966c92de4c6b80f4ca7fef46d455ad0cb1ae729d487801c
-  data.tar.gz: 17885aac6cd969bce5a059210658dee89fea7313641d28b45b1b05b526725283
+  metadata.gz: 8fc20cc1d05617986e855941274ff5b84d631f563802dbfd9640d00bf02bc4a6
+  data.tar.gz: a341f9ad7a2d57311b4328d673af2cbbadd2db102c97995a1701af2b3036abd5
 SHA512:
-  metadata.gz: e1d6261fc9b66f618996b82aedffec5499928686d737d4fcec33430c67486b82120a8d4d35612b18fa421b3f38f91462f3641d08bb7b4eba38f0f693e434ce97
-  data.tar.gz: b44020651b67f07b26a9a1907ca81b346a48d0be1f384cf8d60c870e3aa08ba472dd886390ef06c2434f24310e434ed327d74526a90b9a55d67c08a0d775f2ac
+  metadata.gz: 4e22ab72a7fb96ce53dc2a950d3b1fa53144da6b7d25c684127640eec7a8f1d6e90bf24c79abc49113bbcdc1ca815b27d9c0aa3eedcfddd9fa26c410142dc21d
+  data.tar.gz: f5606e2da1e282ffef489d546587be20a26d28e3b7332478c638d66173809bb36d63f3287696341e2e8c9b05905e3cd62bbb42d66b820b8137f9c522818b66bd

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

@@ -0,0 +1,34 @@
+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

@@ -9,7 +9,7 @@ jobs:
       fail-fast: false
       matrix:
         os: [ubuntu-latest, macos-latest, windows-latest]
-        ruby: ['3.1', '3.2', '3.3']
+        ruby: ['3.2', '3.3', '3.4']
     runs-on: ${{ matrix.os }}
     steps:
     - uses: actions/checkout@v2

data/.tool-versions

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

data/Gemfile.lock

@@ -1,14 +1,14 @@
 PATH
   remote: .
   specs:
-    rsmp_schema (0.8.9)
+    rsmp_schema (0.9.1)
       json_schemer (~> 2.4.0)
       thor (~> 1.4.0)
 
 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)
@@ -17,7 +17,7 @@ GEM
       regexp_parser (~> 2.0)
       simpleidn (~> 0.2)
     rake (13.3.0)
-    regexp_parser (2.11.2)
+    regexp_parser (2.11.3)
     rspec (3.13.1)
       rspec-core (~> 3.13.0)
       rspec-expectations (~> 3.13.0)
@@ -30,7 +30,7 @@ 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)
 
@@ -44,4 +44,4 @@ DEPENDENCIES
   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.1"
   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/schemas/tlc/1.0.10/alarms/A0001.json

@@ -1,3 +1,4 @@
 {
+  "$schema" : "https://json-schema.org/draft/2020-12/schema",
   "description" : "Serious hardware error.\nIs a \"major fault\" defined according to 3.8 i EN12675 which causes the controller to switch to a \"failure mode\" according to 3.6 in EN12675."
 }

data/schemas/tlc/1.0.10/alarms/A0002.json

@@ -1,3 +1,4 @@
 {
+  "$schema" : "https://json-schema.org/draft/2020-12/schema",
   "description" : "Less serious hardware error.\nIs a \"minor fault\" defined according to 3.11 in EN12675."
 }

data/schemas/tlc/1.0.10/alarms/A0003.json

@@ -1,3 +1,4 @@
 {
+  "$schema" : "https://json-schema.org/draft/2020-12/schema",
   "description" : "Serious configuration error.\nIs a \"major fault\" defined according to 3.8 in EN12675 which causes the controller to switch to a \"failure mode\" according to 3.6 in EN12675."
 }

data/schemas/tlc/1.0.10/alarms/A0004.json

@@ -1,3 +1,4 @@
 {
+  "$schema" : "https://json-schema.org/draft/2020-12/schema",
   "description" : "Less serious configuration error.\nIs a \"minor fault\" defined according to 3.11 in EN12675."
 }

data/schemas/tlc/1.0.10/alarms/A0005.json

@@ -1,3 +1,4 @@
 {
+  "$schema" : "https://json-schema.org/draft/2020-12/schema",
   "description" : "Communication error between traffic light controllers / synchronisation error.\nIs a \"minor fault\" defined according to 3.11 in EN12675."
 }

data/schemas/tlc/1.0.10/alarms/A0006.json

@@ -1,3 +1,4 @@
 {
+  "$schema" : "https://json-schema.org/draft/2020-12/schema",
   "description" : "Safety error\nIs a \"major fault\" defined according to 3.8 in EN12675 which causes the controller to switch to a \"failure mode\" according to 3.6 in EN12675."
 }

data/schemas/tlc/1.0.10/alarms/A0007.json

@@ -1,3 +1,4 @@
 {
+  "$schema" : "https://json-schema.org/draft/2020-12/schema",
   "description" : "Communication error between one or multiple traffic light controllers and central control system.\nUsed for communication errors with the central system. Includes NTP connection loss if the TLC is configured to use NTP.\nIs a \"minor fault\" defined according to 3.11 in EN12675."
 }

data/schemas/tlc/1.0.10/alarms/A0008.json

@@ -1,60 +1,29 @@
 {
+  "$schema" : "https://json-schema.org/draft/2020-12/schema",
   "description" : "Dead lock error.\nUsed for dead lock errors.\nFor instance; a signal group has requested green but is unable to switch due to a conflicting signal group for an extended period of time. At some point the request times out and the controller goes failure mode. The cause for this error is due to configuration errors or external sources.\nIs a \"major fault\" defined according to 3.8 in EN12675 which causes the controller to switch to a \"failure mode\" according to 3.6 in EN12675.",
+  "properties" : {
+    "n" : {
+      "enum" : [
+        "timeplan"
+      ]
+    }
+  },
   "allOf" : [
-    {
-      "properties" : {
-        "n" : {
-          "enum" : [
-            "timeplan"
-          ]
-        }
-      }
-    },
     {
       "if" : {
-        "required" : [
-          "q"
-        ],
         "properties" : {
-          "q" : {
-            "enum" : [
-              "undefined",
-              "unknown"
-            ]
+          "n" : {
+            "const" : "timeplan"
           }
         }
       },
       "then" : {
-      },
-      "else" : {
-        "allOf" : [
-          {
-            "if" : {
-              "required" : [
-                "n"
-              ],
-              "properties" : {
-                "n" : {
-                  "const" : "timeplan"
-                }
-              }
-            },
-            "then" : {
-              "properties" : {
-                "v" : {
-                  "allOf" : [
-                    {
-                      "description" : "Current time plan"
-                    },
-                    {
-                      "$ref" : "../../../core/3.1.2/definitions.json#/integer"
-                    }
-                  ]
-                }
-              }
-            }
+        "properties" : {
+          "v" : {
+            "description" : "Current time plan",
+            "$ref" : "../../../core/3.1.2/definitions.json#/integer"
           }
-        ]
+        }
       }
     }
   ]

data/schemas/tlc/1.0.10/alarms/A0009.json

@@ -1,3 +1,4 @@
 {
+  "$schema" : "https://json-schema.org/draft/2020-12/schema",
   "description" : "Other error.\nUsed for other errors not covered by any other alarm type\nIs a \"minor fault\" defined according to 3.11 in EN12675."
 }

data/schemas/tlc/1.0.10/alarms/A0101.json

@@ -1,3 +1,4 @@
 {
+  "$schema" : "https://json-schema.org/draft/2020-12/schema",
   "description" : "Pushbutton error.\nUsed for push buttons."
 }

data/schemas/tlc/1.0.10/alarms/A0201.json

@@ -1,59 +1,34 @@
 {
+  "$schema" : "https://json-schema.org/draft/2020-12/schema",
   "description" : "Serious lamp error.\nUsed for lamp errors.\nIs a \"major fault\" defined according to 3.8 in EN12675 which causes the controller to switch to a \"failure mode\" according to 3.6 in EN12675.",
+  "properties" : {
+    "n" : {
+      "enum" : [
+        "color"
+      ]
+    }
+  },
   "allOf" : [
-    {
-      "properties" : {
-        "n" : {
-          "enum" : [
-            "color"
-          ]
-        }
-      }
-    },
     {
       "if" : {
-        "required" : [
-          "q"
-        ],
         "properties" : {
-          "q" : {
-            "enum" : [
-              "undefined",
-              "unknown"
-            ]
+          "n" : {
+            "const" : "color"
           }
         }
       },
       "then" : {
-      },
-      "else" : {
-        "allOf" : [
-          {
-            "if" : {
-              "required" : [
-                "n"
-              ],
-              "properties" : {
-                "n" : {
-                  "const" : "color"
-                }
-              }
-            },
-            "then" : {
-              "properties" : {
-                "v" : {
-                  "description" : "Color of lamp",
-                  "type" : "string",
-                  "enum" : [
-                    "green",
-                    "red",
-                    "yellow"
-                  ]
-                }
-              }
-            }
+        "properties" : {
+          "v" : {
+            "description" : "Color of lamp",
+            "type" : "string",
+            "enum" : [
+              "green",
+              "red",
+              "yellow"
+            ]
           }
-        ]
+        }
       }
     }
   ]

data/schemas/tlc/1.0.10/alarms/A0202.json

@@ -1,59 +1,34 @@
 {
+  "$schema" : "https://json-schema.org/draft/2020-12/schema",
   "description" : "Less serious lamp error.\nUsed for lamp errors.\nIs a \"minor fault\" defined according to 3.11 in EN12675.",
+  "properties" : {
+    "n" : {
+      "enum" : [
+        "color"
+      ]
+    }
+  },
   "allOf" : [
-    {
-      "properties" : {
-        "n" : {
-          "enum" : [
-            "color"
-          ]
-        }
-      }
-    },
     {
       "if" : {
-        "required" : [
-          "q"
-        ],
         "properties" : {
-          "q" : {
-            "enum" : [
-              "undefined",
-              "unknown"
-            ]
+          "n" : {
+            "const" : "color"
           }
         }
       },
       "then" : {
-      },
-      "else" : {
-        "allOf" : [
-          {
-            "if" : {
-              "required" : [
-                "n"
-              ],
-              "properties" : {
-                "n" : {
-                  "const" : "color"
-                }
-              }
-            },
-            "then" : {
-              "properties" : {
-                "v" : {
-                  "description" : "Color of lamp",
-                  "type" : "string",
-                  "enum" : [
-                    "green",
-                    "red",
-                    "yellow"
-                  ]
-                }
-              }
-            }
+        "properties" : {
+          "v" : {
+            "description" : "Color of lamp",
+            "type" : "string",
+            "enum" : [
+              "green",
+              "red",
+              "yellow"
+            ]
           }
-        ]
+        }
       }
     }
   ]