rsmp_schema 0.4.4 → 0.5

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 32d15bd696be18d414974b0c0a03f1e4a99af8c08e32e1a35cc3fe7f435de6a5
-  data.tar.gz: 9ff9aa8acd817779eb03a4c6a4d041c49254e3e004afcbcd15c53866a82e4d20
+  metadata.gz: b0fe667b2e56247b88fa296646f5722440c9e8e6fa39b1df0a100ac9e41428b0
+  data.tar.gz: e15a00378c0e0d111f5fb2e7a9c4a36b6ade8b5ff81ac228dd6d47ef29dca223
 SHA512:
-  metadata.gz: 3db348308f9ba82724cdd44446747fc03b1bca8deb7179c15de9ae45cf132027aeb8157400b493b8b6e60f6da802cb0ad85bbc44788c685f7c5da4a5d7950fe8
-  data.tar.gz: 50e280d38a9ce66fdcb0aaecfede0541868333e29c6de07c84ff2dc2abbeda270766089d54d9d547f326567e6676b30f5a3b1b26678d905271959c6cdab52dae
+  metadata.gz: ebae7d8552ff121ed8c6e7f33b7c71d16aba8a344daf9d74d9cceddb701400f6117f8a49e97b996a190bce7adc115132e1d940114f95bd8f71446c6ca9300eee
+  data.tar.gz: f3a2b02f947c1da1bb3081898e16d0c5669bfbb3f4a97c220f0eeb1db435186cd61c911504af584b5c2bdb62ec89ed8645d00c42cf59458f6dfdef34d1b4f82f

data/.github/workflows/rspec.yaml

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

data/.tool-versions

@@ -0,0 +1 @@
+ruby 3.2.2

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    rsmp_schema (0.4.4)
+    rsmp_schema (0.5)
       json_schemer (~> 0.2.21)
       thor (~> 1.2.1)
 
@@ -52,4 +52,4 @@ DEPENDENCIES
   rspec-expectations (~> 3.11.0)
 
 BUNDLED WITH
-   2.3.19
+   2.4.20

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

@@ -136,20 +136,40 @@ module RSMP
 
         # convert yaml alarm/status/command item to corresponding jsons schema
         def self.build_item item, property_key: 'v'
-          json = { "allOf" => [ { "description" => item['description'] } ] }
-          if item['arguments']
-            json["allOf"] << {
-              "if"=> { "required" => ["q"], "properties" => { "q"=> { "const" => "undefined" }}},
-              "then" => { "s" => nil }
+          unless item['arguments']
+            json = {
+              "description" => item['description'],
             }
-            json["allOf"].first["properties"] = { "n" => { "enum" => item['arguments'].keys.sort } }
-            item['arguments'].each_pair do |key,argument|
-              json["allOf"] << {
-                "if" => { "required" => ["n"], "properties" => { "n" => { "const" => key }}},
-                "then" => { "properties" => { property_key => build_value(argument) } }
-              }
-            end
+            return json
           end
+
+          json = {
+            "description" => item['description'],
+            "allOf" => [
+              {
+               "properties" => { "n" => { "enum" => item['arguments'].keys.sort }},
+              },
+              {
+                "if" =>
+                {
+                  "required" => ["q"],
+                  "properties" => { "q"=> { "const" => "undefined" }},
+                },
+                  "then" => {
+                  "s" => { "type" => "null" }
+                },
+                "else" => {
+                  "allOf" => item['arguments'].map do |key,argument|
+                    {
+                      "if" => { "required" => ["n"], "properties" => { "n" => { "const" => key }}},
+                      "then" => { "properties" => { property_key => build_value(argument) }}
+                    }
+                  end
+                }
+              }
+            ]
+          }
+
           json
         end
 

data/lib/rsmp_schema/schema.rb

@@ -30,9 +30,12 @@ module RSMP::Schema
     @@schemas[type] = {}
     Dir.glob("#{type_path}/*").select {|f| File.directory? f}.each do |schema_path|
       version = File.basename(schema_path)
-      @@schemas[type][version] = JSONSchemer.schema(
-        Pathname.new(File.join(schema_path,'rsmp.json'))
-      )
+      file_path = File.join(schema_path,'rsmp.json')
+      if File.exist? file_path
+        @@schemas[type][version] = JSONSchemer.schema(
+          Pathname.new(File.join(schema_path,'rsmp.json'))
+        )
+      end
     end
   end
 

data/lib/rsmp_schema/version.rb

@@ -1,5 +1,5 @@
 module RSMP
   module Schema
-    VERSION = "0.4.4"
+    VERSION = "0.5"
   end
 end

data/schemas/core/3.1.2/status_response.json

@@ -13,7 +13,7 @@
         "type" : "object",
         "properties": {
           "sCI" : { "$ref": "definitions.json#/status_code" },
-          "n" : { "description" : "Unique reference of the value", "type" : "string" },
+          "n" : { "description" : "Value name", "type" : "string" },
           "s" : { "description" : "Value", "type" : "string" },
           "q" : {
             "description" : "Quality",

data/schemas/core/3.1.3/status_response.json

@@ -11,37 +11,35 @@
       "minItems": 1,
       "items" : {
         "type" : "object",
-        "oneOf" : [
+        "allOf" : [
           {
+            "required" : [ "sCI", "n", "s", "q" ],
+            "additionalProperties" : false,
             "properties": {
               "sCI" : { "$ref": "../3.1.2/definitions.json#/status_code" },
-              "n" : { "description" : "Unique reference of the value", "type" : "string" },
-              "s" : { "description" : "Value", "type" : "string" },
-              "q" : { 
-                "description" : "Value",
-                "type" : "string",
-                "enum" : [ "recent", "old", "unknown" ]
-              }
-            },
-            "additionalProperties" : false
+              "n" : { "description" : "Value name", "type" : "string" },
+              "q" : { "description" : "Quality", "type" : "string" },
+              "s" : { "description" : "Value" }
+            }
           },
           {
-            "properties": {
-              "sCI" : { "$ref": "../3.1.2/definitions.json#/status_code" },
-              "n" : { "description" : "Unique reference of the value", "type" : "string" },
-              "s" : { "description" : "Null when q=undefined", "type" : "null" },
-              "q" : { 
-                "description" : "Quality",
-                "type" : "string",
-                "const" : "undefined"       // 'undefined' was added
-              }
+            "if" : {
+              "required" : [ "q" ],
+              "properties": { "q" : { "const": "undefined" }}
+            },
+            "then" : {
+              "properties": { "s" : { "type": "null" }}
             },
-            "additionalProperties" : false
+            "else" : {
+              "properties": {
+                "s" : { "type" : ["string"] },
+                "q" : { "enum" : [ "recent", "old", "unknown" ] }
+              }
+            }
           }
-        ],
-        "required" : [ "sCI", "n", "s", "q" ]
+        ]
       }
     }
   },
   "required" : [ "mId", "cId", "sTs", "sS" ]
-}
+}

data/schemas/core/3.2/status_response.json

@@ -11,37 +11,35 @@
       "minItems": 1,
       "items" : {
         "type" : "object",
-        "oneOf" : [
+        "allOf" : [
           {
+            "required" : [ "sCI", "n", "s", "q" ],
+            "additionalProperties" : false,
             "properties": {
               "sCI" : { "$ref": "../3.1.2/definitions.json#/status_code" },
               "n" : { "description" : "Unique reference of the value", "type" : "string" },
-              "s" : { "description" : "Value", "type" : ["string"," array"] },      // 3.2 allows array
-              "q" : { 
-                "description" : "Value",
-                "type" : "string",
-                "enum" : [ "recent", "old", "unknown" ]
-              }
-            },
-            "additionalProperties" : false
+              "q" : { "description" : "Quality", "type" : "string" },
+              "s" : { "description" : "Value" }
+            }
           },
           {
-            "properties": {
-              "sCI" : { "$ref": "../3.1.2/definitions.json#/status_code" },
-              "n" : { "description" : "Unique reference of the value", "type" : "string" },
-              "s" : { "description" : "Null when q=undefined", "type" : "null" },
-              "q" : { 
-                "description" : "Quality",
-                "type" : "string",
-                "const" : "undefined"
-              }
+            "if" : {
+              "required" : [ "q" ],
+              "properties": { "q" : { "const": "undefined" }}
             },
-            "additionalProperties" : false
+            "then" : {
+              "properties": { "s" : { "type": "null" }}
+            },
+            "else" : {
+              "properties": {
+                "s" : { "type" : [ "string", "array" ] },
+                "q" : { "enum" : [ "recent", "old", "unknown" ] }
+              }
+            }
           }
-        ],
-        "required" : [ "sCI", "n", "s", "q" ]
+        ]
       }
     }
   },
   "required" : [ "mId", "cId", "sTs", "sS" ]
-}
+}

data/schemas/core/3.2.1/core.json

@@ -0,0 +1,39 @@
+{
+  "$schema" : "http://json-schema.org/draft-07/schema#",
+  "name" : "core",
+  "description" : "Core",
+  "version" : "3.2.1",
+  "type" :  "object",
+  "allOf" : [
+    {
+      "properties" : {
+        "mType" : {
+          "description" : "Supported RSMP versions",
+          "type" : "string",
+          "const" : "rSMsg"
+        },
+        "type" : {
+          "description" : "Type of RMSP message",
+          "type" : "string",
+          "enum" : [
+            "MessageAck",
+            "MessageNotAck",
+            "Version",
+            "AggregatedStatus",
+            "AggregatedStatusRequest",
+            "Watchdog",
+            "Alarm",
+            "CommandRequest",
+            "CommandResponse",
+            "StatusRequest",
+            "StatusResponse",
+            "StatusSubscribe",
+            "StatusUnsubscribe",
+            "StatusUpdate"
+          ]
+        }
+      },
+      "required" : [ "mType", "type" ]
+    }
+  ]
+}

data/schemas/core/3.2.1/rsmp.json

@@ -0,0 +1,133 @@
+{
+  "allOf": [
+    {
+      "$ref": "../3.2/core.json"
+    },
+    {
+      "if": {
+        "required" : ["type"],
+        "properties": { "type": { "const": "MessageAck" } }
+      },
+      "then": {
+        "$ref": "../3.1.2/message_ack.json"
+      }
+    },
+    {
+      "if": {
+        "required" : ["type"],
+        "properties": { "type": { "const": "MessageNotAck" } }
+      },
+      "then": {
+        "$ref": "../3.1.2/message_not_ack.json"
+      }
+    },
+    {
+      "if": {
+        "required" : ["type"],
+        "properties": { "type": { "const": "Version" } }
+      },
+      "then": {
+        "$ref": "../3.1.2/version.json"
+      }
+    },
+    {
+      "if": {
+        "required" : ["type"],
+        "properties": { "type": { "const": "AggregatedStatus" } }
+      },
+      "then": {
+        "$ref": "../3.1.2/aggregated_status.json"
+      }
+    },
+    {
+      "if": {
+        "required" : ["type"],
+        "properties": { "type": { "const": "AggregatedStatusRequest" } }
+      },
+      "then": {
+        "$ref": "../3.1.5/aggregated_status_request.json"
+      }
+    },
+    {
+      "if": {
+        "required" : ["type"],
+        "properties": { "type": { "const": "Watchdog" } }
+      },
+      "then": {
+        "$ref": "../3.1.2/watchdog.json"
+      }
+    },
+    {
+      "if": {
+        "required" : ["type"],
+        "properties": { "type": { "const": "Alarm" } }
+      },
+      "then": {
+        "$ref": "../3.2/alarm.json"
+      }
+    },
+    {
+      "if": {
+        "required" : ["type"],
+        "properties": { "type": { "const": "CommandRequest" } }
+      },
+      "then": {
+        "$ref": "../3.1.2/command_request.json"
+      }
+    },
+    {
+      "if": {
+        "required" : ["type"],
+        "properties": { "type": { "const": "CommandResponse" } }
+      },
+      "then": {
+        "$ref": "../3.1.2/command_response.json"
+      }
+    },
+    {
+      "if": {
+        "required" : ["type"],
+        "properties": { "type": { "const": "StatusRequest" } }
+      },
+      "then": {
+        "$ref": "../3.1.2/status_request.json"
+      }
+    },
+    {
+      "if": {
+        "required" : ["type"],
+        "properties": { "type": { "const": "StatusResponse" } }
+      },
+      "then": {
+        "$ref": "../3.2/status_response.json"
+      }
+    },
+    {
+      "if": {
+         "required" : ["type"],
+       "properties": { "type": { "const": "StatusSubscribe" } }
+      },
+      "then": {
+        "$ref": "../3.1.5/status_subscribe.json"
+      }
+    },
+    {
+      "if": {
+        "required" : ["type"],
+        "properties": { "type": { "const": "StatusUnsubscribe" } }
+      },
+      "then": {
+        "$ref": "../3.1.2/status_unsubscribe.json"
+      }
+    },
+    {
+      "if": {
+        "required" : ["type"],
+        "properties": { "type": { "const": "StatusUpdate" } }
+      },
+      "then": {
+        "$ref": "../3.2/status_update.json"
+      }
+    }
+  ]
+}

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

@@ -1,7 +1,3 @@
 {
-  "allOf" : [
-    {
-      "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."
-    }
-  ]
+  "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,7 +1,3 @@
 {
-  "allOf" : [
-    {
-      "description" : "Less serious hardware error.\nIs a \"minor fault\" defined according to 3.11 in EN12675."
-    }
-  ]
+  "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,7 +1,3 @@
 {
-  "allOf" : [
-    {
-      "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."
-    }
-  ]
+  "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,7 +1,3 @@
 {
-  "allOf" : [
-    {
-      "description" : "Less serious configuration error.\nIs a \"minor fault\" defined according to 3.11 in EN12675."
-    }
-  ]
+  "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,7 +1,3 @@
 {
-  "allOf" : [
-    {
-      "description" : "Communication error between traffic light controllers / synchronisation error.\nIs a \"minor fault\" defined according to 3.11 in EN12675."
-    }
-  ]
+  "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,7 +1,3 @@
 {
-  "allOf" : [
-    {
-      "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."
-    }
-  ]
+  "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,7 +1,3 @@
 {
-  "allOf" : [
-    {
-      "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."
-    }
-  ]
+  "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,7 +1,7 @@
 {
+  "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.",
   "allOf" : [
     {
-      "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" : [
@@ -22,33 +22,39 @@
         }
       },
       "then" : {
-        "s" : null
-      }
-    },
-    {
-      "if" : {
-        "required" : [
-          "n"
-        ],
-        "properties" : {
-          "n" : {
-            "const" : "timeplan"
-          }
+        "s" : {
+          "type" : "null"
         }
       },
-      "then" : {
-        "properties" : {
-          "v" : {
-            "allOf" : [
-              {
-                "description" : "Current time plan"
-              },
-              {
-                "$ref" : "../../../core/3.1.2/definitions.json#/integer"
+      "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"
+                    }
+                  ]
+                }
               }
-            ]
+            }
           }
-        }
+        ]
       }
     }
   ]

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

@@ -1,7 +1,3 @@
 {
-  "allOf" : [
-    {
-      "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."
-    }
-  ]
+  "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,7 +1,3 @@
 {
-  "allOf" : [
-    {
-      "description" : "Pushbutton error.\nUsed for push buttons."
-    }
-  ]
+  "description" : "Pushbutton error.\nUsed for push buttons."
 }

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

@@ -1,7 +1,7 @@
 {
+  "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.",
   "allOf" : [
     {
-      "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" : [
@@ -22,32 +22,38 @@
         }
       },
       "then" : {
-        "s" : null
-      }
-    },
-    {
-      "if" : {
-        "required" : [
-          "n"
-        ],
-        "properties" : {
-          "n" : {
-            "const" : "color"
-          }
+        "s" : {
+          "type" : "null"
         }
       },
-      "then" : {
-        "properties" : {
-          "v" : {
-            "description" : "Color of lamp",
-            "type" : "string",
-            "enum" : [
-              "green",
-              "red",
-              "yellow"
-            ]
+      "else" : {
+        "allOf" : [
+          {
+            "if" : {
+              "required" : [
+                "n"
+              ],
+              "properties" : {
+                "n" : {
+                  "const" : "color"
+                }
+              }
+            },
+            "then" : {
+              "properties" : {
+                "v" : {
+                  "description" : "Color of lamp",
+                  "type" : "string",
+                  "enum" : [
+                    "green",
+                    "red",
+                    "yellow"
+                  ]
+                }
+              }
+            }
           }
-        }
+        ]
       }
     }
   ]