rsmp_schema 0.1.1 → 0.2.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: aeef79729314dc2a8440a0697560f02608622a0c46ffaa635d6ec18b7afc3a43
-  data.tar.gz: 04c0d1bbc1039a924ca63e70bb29bafceb0dbbc5d8a95e54d9a39686f7d34847
+  metadata.gz: 8c5718eb96e00289525b0997cc296fcc93b029966d40c80a544d7b075d4c870b
+  data.tar.gz: c64cabf0d6cf081bd1434401eb9794691ac126dcf2fe64316ddbfe3fbef31f5e
 SHA512:
-  metadata.gz: d8905cc3b11e5fc4aa9721e07a4b4f0de852f872af7e7dc364e9fa63e09720870bbc1e2cd3cb5efd816d35c641e128e829a2ed2b7de079084f7d3aff96b13688
-  data.tar.gz: efea6b4d539ba3bd686900beb2595cf72b17c890208193204fab0fe040faa671eb49ec67ba0973bc1f7077a8a1be392d6d4f4c281a57c78e633fa2eebd26653d
+  metadata.gz: 454414a51cf1e8ffa4f978a997ca702726058d82a0e1e0e6645fc74122e945d42584b38926a97a464ecbb591ec3afaf23e85a4639f704815abf431895c3e2f52
+  data.tar.gz: a48f7a8aa43283cd5448376c7f26f7c060d10fda7caf7e95f1b0f6e54c81432af867a9cbfa25ff6cb7608d1868e04fa1c9b6b5677e7550358e11073b18539634

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    rsmp_schema (0.1.1)
+    rsmp_schema (0.2.2)
       json_schemer (~> 0.2.21)
       thor (~> 1.2.1)
 

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

@@ -21,67 +21,61 @@ module RSMP
           JSON.generate(item,@@json_options)
         end
 
+        # convert a yaml item to json schema
         def self.build_value item
           out = {}
+          out['description'] = item['description'] if item['description']
 
-          if item['description']
-            out["description"] = item['description']
+          if item['type'] =~/_list$/
+            handle_string_list item, out
+          else
+            handle_types item, out
+            handle_enum item, out
+            handle_pattern item, out
           end
+          wrap_refs out
+        end
 
-          if item['list']
-            case item['type']
-            when "boolean"
-              out["$ref"] = "../../../core/3.1.1/definitions.json#/boolean_list"
-            when "integer", "ordinal", "unit", "scale", "long"
-              out["$ref"] = "../../../core/3.1.1/definitions.json#/integer_list"
-            when "string"
-              out["$ref"] = "../../../core/3.1.1/definitions.json#/string_list"
-            else
-              raise "Error: List of #{item['type']} is not supported: #{item.inspect}"
-            end
-
-            if item["values"]
-              value_list = item["values"].keys.join('|')
-              out['pattern'] = /(?-mix:^(#{value_list})(?:,(#{value_list}))*$)/
-            end
-
-            if item["pattern"]
-              puts "Warning: Pattern not support for lists: #{item.inspect}"
-            end
+        # convert an item which is not a string-list, to json schema
+        def self.handle_types item, out
+          case item['type']
+          when "string", "base64"
+            out["type"] = "string"
+          when "boolean"
+            out["$ref"] = "../../../core/3.1.1/definitions.json#/boolean"
+          when "timestamp"
+            out["$ref"] = "../../../core/3.1.1/definitions.json#/timestamp"
+          when "integer", "ordinal", "unit", "scale", "long"
+            out["$ref"] = "../../../core/3.1.1/definitions.json#/integer"
+          when 'array'   # a json array
+            build_json_array item['items'], out
           else
-            case item['type']
-            when "string", "base64"
-              out["type"] = "string"
-            when "boolean"
-              out["$ref"] = "../../../core/3.1.1/definitions.json#/boolean"
-            when "timestamp"
-              out["$ref"] = "../../../core/3.1.1/definitions.json#/timestamp"
-            when "integer", "ordinal", "unit", "scale", "long"
-              out["$ref"] = "../../../core/3.1.1/definitions.json#/integer"
-            else
-              out["type"] = "string"
-            end
-
-            if item["values"]
-              case item["values"]
-              when Hash
-                out["enum"] = item["values"].keys.sort
-              when Array
-                out["enum"] = item["values"].sort
-              else
-                raise "Error: Values must be specified as either a Hash or an Array"
-              end
-
-            end
+            out["type"] = "string"
+          end
+        end
 
-            if item["pattern"]
-              out["pattern"] = item["pattern"]
-            end
+        # convert an yaml item with type: array to json schema
+        def self.build_json_array item, out
+          required = item.select { |k,v| v['optional'] != true }.keys.sort
+          out.merge!({
+            "type" => "array",
+            "items" => {
+              "type" => "object",
+              "required" => required,
+              "additionalProperties": false
+            }
+          })
+          out["items"]["properties"] = {}
+          item.each_pair do |key,v|
+            out["items"]["properties"][key] = build_value(v)
           end
+          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
+        # 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
+        def self.wrap_refs out
           if out.keys.include? '$ref'
             ref = out.delete '$ref'
             { "allOf" => [out,{"$ref"=>ref}]}
@@ -90,6 +84,47 @@ module RSMP
           end
         end
 
+        # convert a yaml item with list: true to json schema
+        def self.handle_string_list item, out
+          case item['type']
+          when "boolean_list"
+            out["$ref"] = "../../../core/3.1.1/definitions.json#/boolean_list"
+          when "integer_list"
+            out["$ref"] = "../../../core/3.1.1/definitions.json#/integer_list"
+          when "string_list"
+            out["$ref"] = "../../../core/3.1.1/definitions.json#/string_list"
+          else
+            raise "Error: List of #{item['type']} is not supported: #{item.inspect}"
+          end
+
+          if item["values"]
+            value_list = item["values"].keys.join('|')
+            out['pattern'] = /(?-mix:^(#{value_list})(?:,(#{value_list}))*$)/
+          end
+
+          puts "Warning: Pattern not support for lists: #{item.inspect}" if item["pattern"]
+        end
+
+        # convert yaml values to jsons schema enum
+        def self.handle_enum item, out
+          if item["values"]
+            case item["values"]
+            when Hash
+              out["enum"] = item["values"].keys.sort
+            when Array
+              out["enum"] = item["values"].sort
+            else
+              raise "Error: Values must be specified as either a Hash or an Array"
+            end
+          end
+        end
+
+        # convert yaml pattern to jsons schema
+        def self.handle_pattern item, out
+          out["pattern"] = item["pattern"] if item["pattern"]
+        end
+
+        # 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']
@@ -104,6 +139,7 @@ module RSMP
           json
         end
 
+        # convert alarms to json schema
         def self.output_alarms out, items
           list = items.keys.sort.map do |key|
             {
@@ -121,11 +157,13 @@ module RSMP
           items.each_pair { |key,item| output_alarm out, key, item }
         end
 
+        # convert an alarm to json schema
         def self.output_alarm out, key, item
           json = build_item item
           out["alarms/#{key}.json"] = output_json json
         end
 
+        # convert statuses to json schema
         def self.output_statuses out, items
           list = [ { "properties" => { "sCI" => { "enum"=> items.keys.sort }}} ]
           items.keys.sort.each do |key|
@@ -139,11 +177,13 @@ module RSMP
           items.each_pair { |key,item| output_status out, key, item }
         end
 
+        # convert a status to json schema
         def self.output_status out, key, item
           json = build_item item, property_key:'s'
           out["statuses/#{key}.json"] = output_json json
         end
 
+        # convert commands to json schema
         def self.output_commands out, items
           list = [ { "properties" => { "cCI" => { "enum"=> items.keys.sort }}} ]
           items.keys.sort.each do |key|
@@ -164,12 +204,14 @@ module RSMP
           items.each_pair { |key,item| output_command out, key, item }
         end
 
+        # 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'] }
           out["commands/#{key}.json"] = output_json json
         end
 
+        # output the json schema root
         def self.output_root out, meta
           json = {
             "name"=> meta['name'],
@@ -197,6 +239,7 @@ module RSMP
           out["sxl.json"] = output_json json
         end
 
+        # generate the json schema from a string containing yaml
         def self.generate sxl
           out = {}
           output_root out, sxl[:meta]
@@ -206,6 +249,7 @@ module RSMP
           out
         end
 
+        # convert yaml to json schema and write files to a folder
         def self.write sxl, folder
           out = generate sxl
           out.each_pair do |relative_path,str|
@@ -215,9 +259,7 @@ module RSMP
             file.puts str
           end
         end
-
       end
-
     end
   end
 end

data/lib/rsmp_schema/schema.rb

@@ -6,32 +6,66 @@ end
 module RSMP::Schema
   @@schemas = nil
 
-  def self.schemas
-    return @@schemas if @@schemas
+  def self.setup
+    @@schemas = {}
     schemas_path = File.expand_path( File.join(__dir__,'..','..','schemas') )
-    @@schemas = {
-      core: {
-        '3.1.1' => JSONSchemer.schema( Pathname.new(File.join(schemas_path, 'core','3.1.1','rsmp.json')) ),
-        '3.1.2' => JSONSchemer.schema( Pathname.new(File.join(schemas_path, 'core','3.1.2','rsmp.json')) ),
-        '3.1.3' => JSONSchemer.schema( Pathname.new(File.join(schemas_path, 'core','3.1.3','rsmp.json')) ),
-        '3.1.4' => JSONSchemer.schema( Pathname.new(File.join(schemas_path, 'core','3.1.4','rsmp.json')) ),
-        '3.1.5' => JSONSchemer.schema( Pathname.new(File.join(schemas_path, 'core','3.1.5','rsmp.json')) ),
-        '3.2'   => JSONSchemer.schema( Pathname.new(File.join(schemas_path, 'core','3.2',  'rsmp.json')) )
-      },
-      # note that tlc 1.0.11 and 1.0.12 does not exist (unreleased drafts)
-      tlc: {
-        '1.0.7'  => JSONSchemer.schema( Pathname.new(File.join(schemas_path, 'tlc','1.0.7' ,'sxl.json')) ),
-        '1.0.8'  => JSONSchemer.schema( Pathname.new(File.join(schemas_path, 'tlc','1.0.8' ,'sxl.json')) ),
-        '1.0.9'  => JSONSchemer.schema( Pathname.new(File.join(schemas_path, 'tlc','1.0.9' ,'sxl.json')) ),
-        '1.0.10' => JSONSchemer.schema( Pathname.new(File.join(schemas_path, 'tlc','1.0.10','sxl.json')) ),
-        '1.0.13' => JSONSchemer.schema( Pathname.new(File.join(schemas_path, 'tlc','1.0.13','sxl.json')) ),
-        '1.0.14' => JSONSchemer.schema( Pathname.new(File.join(schemas_path, 'tlc','1.0.14','sxl.json')) ),
-        '1.0.15' => JSONSchemer.schema( Pathname.new(File.join(schemas_path, 'tlc','1.0.15','sxl.json')) ),
-        '1.1'    => JSONSchemer.schema( Pathname.new(File.join(schemas_path, 'tlc','1.1',   'sxl.json')) )
-      }
-    }
+    Dir.glob("#{schemas_path}/*").select {|f| File.directory? f}.each do |type_path|
+      type = File.basename(type_path).to_sym
+      @@schemas[type] = {}
+      Dir.glob("#{type_path}/*").select {|f| File.directory? f}.each do |schema_path|
+        version = File.basename(schema_path)
+        if type == :core
+          file = 'rsmp.json'
+        else
+          file = 'sxl.json'
+        end
+        @@schemas[type][version] = JSONSchemer.schema(
+          Pathname.new(File.join(schema_path,file))
+        )
+      end
+    end
+  end
+
+  # get all schemas, oganized by type and version
+  def self.schemas
+    raise RuntimeError.new("No schemas available, perhaps Schema.setup was never called?") unless @@schemas
+    @@schemas
+  end
+
+  # get array of core schema versions
+  def self.core_versions
+    versions :core
+  end
+
+  # get earliest core schema version
+  def self.earliest_core_version
+    earliest_version :core
   end
 
+  # get latesty core schema version
+  def self.latest_core_version
+    latest_version :core
+  end
+
+  # get array of  schema versions for a particular schema type
+  def self.versions type
+    schemas = find_schemas!(type).keys
+    sort_versions(schemas)
+  end
+
+  # get earliest schema version for a particular schema type
+  def self.earliest_version type
+    schemas = find_schemas!(type).keys
+    sort_versions(schemas).first
+  end
+
+  # get latest schema version for a particular schema type
+  def self.latest_version type
+    schemas = find_schemas!(type).keys
+    sort_versions(schemas).last
+  end
+
+  # validate an rsmp messages using a schema object
   def self.validate_using_schema message, schema
     raise ArgumentError.new("message missing") unless message
     raise ArgumentError.new("schema missing") unless schema
@@ -44,17 +78,28 @@ module RSMP::Schema
     end
   end
 
+  # sort version strings
+  def self.sort_versions versions
+    versions.sort_by { |k| Gem::Version.new(k) }
+  end
+
+  # find schemas versions for particular schema type
+  # return nil if type not found
   def self.find_schemas type
     raise ArgumentError.new("type missing") unless type
-    schemas[type.to_sym]
+    schemas = @@schemas[type.to_sym]
   end
 
+  # find schemas versions for particular schema type
+  # raise error if not found
   def self.find_schemas! type
     schemas = find_schemas type
     raise UnknownSchemaTypeError.new("Unknown schema type #{type}") unless schemas
     schemas
   end
 
+  # find schema for a particular schema and version
+  # return nil if not found
   def self.find_schema type, version, options={}
     raise ArgumentError.new("version missing") unless version
     version = sanitize_version version if options[:lenient]
@@ -65,11 +110,18 @@ module RSMP::Schema
     nil
   end
 
+  # get major.minor.patch part of a version string, where patch is optional
+  # ignore trailing characters, e.g.
+  #   3.1.3.32A => 3.1.3
+  #   3.1A3r3 >= 3.1
+  # return nil if string doesn't match
   def self.sanitize_version version
     matched = /^\d+\.\d+(\.\d+)?/.match version
     matched.to_s if matched
   end
 
+  # find schema for a particular schema and version
+  # raise error if not found
   def self.find_schema! type, version, options={}
     schema = find_schema type, version, options
     raise ArgumentError.new("version missing") unless version
@@ -82,10 +134,14 @@ module RSMP::Schema
     raise UnknownSchemaVersionError.new("Unknown schema version #{type} #{version}")
   end
 
+  # true if a particular schema type and version found
   def self.has_schema? type, version, options={}
     find_schema(type,version, options) != nil
   end
 
+  # validate using a particular schema and version
+  # raises error if schema is not found
+  # return nil if validation succeds, otherwise returns an array of errors
   def self.validate message, schemas, options={}
     raise ArgumentError.new("message missing") unless message
     raise ArgumentError.new("schemas missing") unless schemas

data/lib/rsmp_schema/version.rb

@@ -1,5 +1,5 @@
 module RSMP
   module Schema
-    VERSION = "0.1.1"
+    VERSION = "0.2.2"
   end
 end

data/lib/rsmp_schema.rb

@@ -5,3 +5,5 @@ require 'rsmp_schema/schema'
 require 'rsmp_schema/convert/import/yaml'
 require 'rsmp_schema/convert/export/json_schema'
 require 'rsmp_schema/version'
+
+RSMP::Schema.setup

data/schemas/tlc/1.0.10/sxl.yaml

@@ -177,15 +177,13 @@ objects:
           During maintenance work the controller might be using dark mode (no output to the signal heads).
         arguments:
           intersection:
-            list: true
-            type: integer
+            type: integer_list
             description: |-
               0: Not applicable (only one intersection exists or applicable for all intersection of the traffic light controller)
               Other value: Intersection number
             range: "[0-255]"
           status:
-            list: true
-            type: boolean
+            type: boolean_list
             description: |-
               False: Traffic Light Controller in dark mode
               True: Traffic Light Controller not in dark mode
@@ -196,15 +194,13 @@ objects:
           Signal timings is controlled manually by service personnel using the operating panel of the controller.
         arguments:
           intersection:
-            list: true
-            type: integer
+            type: integer_list
             description: |-
               0: Not applicable (only one intersection exists or applicable for all intersection of the traffic light controller)
               Other value: Intersection number
             range: "[0-255]"
           status:
-            list: true
-            type: boolean
+            type: boolean_list
             description: |-
               False: Manual control inactive
               True: Manual control active
@@ -215,15 +211,13 @@ objects:
           Usually only used in case normal detectors can't be used, e.g. during maintenance work.
         arguments:
           intersection:
-            list: true
-            type: integer
+            type: integer_list
             description: |-
               0: Not applicable (only one intersection exists or applicable for all intersection of the traffic light controller)
               Other value: Intersection number
             range: "[0-255]"
           status:
-            list: true
-            type: boolean
+            type: boolean_list
             description: |-
               False: Fixed time control inactive
               True: Fixed time control active
@@ -234,15 +228,13 @@ objects:
           Used to determine if the controller is operating independently or operating with other controllers (coordination).
         arguments:
           intersection:
-            list: true
-            type: integer
+            type: integer_list
             description: |-
               0: Not applicable (only one intersection exists or applicable for all intersection of the traffic light controller)
               Other value: Intersection number
             range: "[0-255]"
           status:
-            list: true
-            type: boolean
+            type: boolean_list
             description: |-
               False: Isolated control disabled
               True: Isolated control enabled (Vehicle actuated control or Fixed time control)
@@ -253,15 +245,13 @@ objects:
           Yellow flash may be used during a serious fault (depending on configuration) or maintenance work. It can also be manually set using M0001.
         arguments:
           intersection:
-            list: true
-            type: integer
+            type: integer_list
             description: |-
               0: Not applicable (only one intersection exists or applicable for all intersection of the traffic light controller)
               Other value: Intersection number
             range: "[0-255]"
           status:
-            list: true
-            type: boolean
+            type: boolean_list
             description: |-
               False: Yellow flash disabled
               True: Yellow flash enabled
@@ -272,15 +262,13 @@ objects:
           All red can be manually set using the controllers operating panel during maintenance work.
         arguments:
           intersection:
-            list: true
-            type: integer
+            type: integer_list
             description: |-
               0: Not applicable (only one intersection exists or applicable for all intersection of the traffic light controller)
               Other value: Intersection number
             range: "[0-255]"
           status:
-            list: true
-            type: boolean
+            type: boolean_list
             description: |-
               False: All red disabled
               True: All red enabled
@@ -291,15 +279,13 @@ objects:
           The "police key" is a external control switch present in some controllers that manually switches the controller to either dark mode or yellow flash.
         arguments:
           intersection:
-            list: true
-            type: integer
+            type: integer_list
             description: |-
               0: Not applicable (only one intersection exists or applicable for all intersection of the traffic light controller)
               Other value: Intersection number
             range: "[0-255]"
           status:
-            list: true
-            type: integer
+            type: integer_list
             values:
               0: disabled
               1: dark mode
@@ -367,15 +353,13 @@ objects:
           Can be used for the management system to check the current control mode (startup, normal, standby, failure, test).
         arguments:
           intersection:
-            list: true
-            type: integer
+            type: integer_list
             description: |-
               0: Not applicable (only one intersection exists or applicable for all intersection of the traffic light controller)
               Other value: Intersection number
             range: "[0-255]"
           controlmode:
-            list: true
-            type: string
+            type: string_list
             values:
               startup: Startup mode
               control: Normal control
@@ -469,29 +453,25 @@ objects:
           Requires security code 2.
         arguments:
           status:
-            list: true
+            type: string_list
             description: Set operating mode
-            type: string
             values:
               NormalControl: Normal Control
               YellowFlash: Enables yellow flash
               Dark: Enables dark mode
           securityCode:
-            list: true
+            type: string_list
             description: Security code 2
-            type: string
           timeout:
-            list: true
+            type: integer_list
             description: |-
               Time in minutes until controller automatically reverts to previous functional position.
               0=no automatic return
-            type: integer
             min: 0
             max: 1440
           intersection:
-            list: true
+            type: integer_list
             description: Intersection number
-            type: integer
             min: 0
             max: 255
         command: setValue