rsmp 0.48.2 → 0.48.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: b7679302307b859b55883853c8c6e68e0312ce424a669a8f8a6518cf12e87332
-  data.tar.gz: 4751ec87842c6c2e5eea8df0c7de2d5225357260ac2738ea2eb9effdd119f1ca
+  metadata.gz: 9a1022065ed55946e06f4b312bafbc205eeb9c4ab26aab7cd251e682127f1c57
+  data.tar.gz: ee0364563ca3b85e39fda32fc6f2e769be26406aab01919c09da5f28da07d02f
 SHA512:
-  metadata.gz: ae23356f9e9b4d1daff2bb8fda1a085a49a3ae832cf204ded0f17c20c7e722a0d9f9d9708ce8734de3d5e2aeebcb7d55e8b97a56523985904246c0036f85929d
-  data.tar.gz: fa43ab65b703f93a4abbe07cab0ad08c144b931a2df4b5580a9a8841d2a748989557fa2fa65e658e1f9a67942cd737ad70018d8922342294cc717394ac2093b0
+  metadata.gz: 2bc65697e462f74a43b3412d7248b36e69cb11c265dc0a66b486528d4f9f86f8a72461c21affc29f9ee7915e1934ca8764ae20c7f8108bec8f0c956d977a2634
+  data.tar.gz: 0d886469084cc50a0b03343b9ad098d4a89a8f7e8ed20e9d91d96a194c180d693826c8b035555ec282621a84baa64fb59b6bbf37889e68aa426d3eec0792be8a

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    rsmp (0.48.2)
+    rsmp (0.48.3)
       async (~> 2.39)
       colorize (~> 1.1)
       io-endpoint (~> 0.17)

data/Rakefile

@@ -1,4 +1,10 @@
 require 'bundler/gem_tasks'
+require 'fileutils'
+require 'open3'
+require 'yaml'
+
+require_relative 'lib/rsmp/convert/import/yaml'
+require_relative 'lib/rsmp/convert/export/json_schema'
 
 task :test do
   sh 'bundle exec sus'
@@ -7,6 +13,19 @@ end
 CORE_VERSIONS = %w[3.1.2 3.1.3 3.1.4 3.1.5 3.2.0 3.2.1 3.2.2 3.3.0].freeze
 TLC_VERSIONS  = %w[1.0.7 1.0.8 1.0.9 1.0.10 1.0.13 1.0.14 1.0.15 1.1.0 1.2.0 1.2.1 1.3.0].freeze
 
+def git_show!(repo_path, ref)
+  output, status = Open3.capture2e('git', '-C', repo_path, 'show', ref)
+  raise "Could not read #{ref} from #{repo_path}:\n#{output}" unless status.success?
+
+  output
+end
+
+def require_minimum_core_version!(source_path)
+  yaml = YAML.load_file(source_path)
+  minimum_core_version = yaml.dig('meta', 'minimum_core_version')
+  raise "Missing meta.minimum_core_version in #{source_path}" if minimum_core_version.nil? || minimum_core_version.to_s.empty?
+end
+
 # Update vendored schemas from source repos.
 # Usage: rake schemas:update[/path/to/rsmp_core,/path/to/rsmp_sxl_traffic_lights]
 # Defaults to sibling directories ../rsmp_core and ../rsmp_sxl_traffic_lights.
@@ -32,10 +51,14 @@ namespace :schemas do
     puts "Updating TLC schemas from #{tlc_path}:"
     TLC_VERSIONS.each do |ver|
       target = "schemas/tlc/#{ver}"
+      source = File.join(target, 'source', 'sxl.yaml')
       puts "  #{ver}"
       FileUtils.rm_rf(target)
-      FileUtils.mkdir_p(target)
-      sh "git -C #{tlc_path} archive refs/heads/#{ver} -- schema/ | tar x --strip-components=1 -C #{target}"
+      FileUtils.mkdir_p(File.dirname(source))
+      File.write(source, git_show!(tlc_path, "refs/heads/#{ver}:schema/sxl.yaml"))
+      require_minimum_core_version!(source)
+      sxl = RSMP::Convert::Import::YAML.read(source)
+      RSMP::Convert::Export::JSONSchema.write(sxl, target)
     end
   end
 end

data/lib/rsmp/convert/export/json_schema/index.rb

@@ -6,56 +6,77 @@ module RSMP
         def self.output_sxl_index(out, sxl)
           out['sxl_index.json'] = output_json({
                                                 'meta' => sxl[:meta],
-                                                'statuses' => index_items(sxl[:statuses]),
-                                                'commands' => index_items(sxl[:commands]),
-                                                'alarms' => index_items(sxl[:alarms])
+                                                'statuses' => index_items(sxl[:statuses], legacy_types: legacy_types?(sxl)),
+                                                'commands' => index_items(sxl[:commands], legacy_types: legacy_types?(sxl)),
+                                                'alarms' => index_items(sxl[:alarms], legacy_types: legacy_types?(sxl))
                                               })
         end
 
-        def self.index_items(items)
+        def self.legacy_types?(sxl)
+          Gem::Version.new(minimum_core_version(sxl).to_s) < Gem::Version.new('3.3.0')
+        end
+
+        def self.index_items(items, legacy_types:)
           items.keys.sort.to_h do |key|
-            [key, index_item(items[key])]
+            [key, index_item(items[key], legacy_types: legacy_types)]
           end
         end
 
-        def self.index_item(item)
+        def self.index_item(item, legacy_types:)
           arguments = item['arguments'] || {}
           entry = {}
-          required = typed_arguments(arguments.reject { |_name, argument| argument['optional'] == true })
-          optional = typed_arguments(arguments.select { |_name, argument| argument['optional'] == true })
+          required = typed_arguments(arguments.reject { |_name, argument| argument['optional'] == true },
+                                     legacy_types: legacy_types)
+          optional = typed_arguments(arguments.select { |_name, argument| argument['optional'] == true },
+                                     legacy_types: legacy_types)
           entry['required'] = required unless required.empty?
           entry['optional'] = optional unless optional.empty?
           entry
         end
 
-        def self.typed_arguments(arguments)
+        def self.typed_arguments(arguments, legacy_types:)
           arguments.keys.sort.to_h do |name|
-            [name, argument_type_descriptor(arguments[name])]
+            [name, argument_type_descriptor(arguments[name], legacy_types: legacy_types)]
           end
         end
 
-        def self.argument_type_descriptor(argument)
+        def self.argument_type_descriptor(argument, legacy_types:)
           type = argument['type']
           case type
           when 'array'
-            argument_array_descriptor(argument)
+            argument_array_descriptor(argument, legacy_types: legacy_types)
           when 'object'
-            argument_object_descriptor(argument)
+            argument_object_descriptor(argument, legacy_types: legacy_types)
+          else
+            legacy_types ? legacy_index_type(type) : type
+          end
+        end
+
+        def self.legacy_index_type(type)
+          case type
+          when 'boolean'
+            'boolean_as_string'
+          when 'integer'
+            'integer_as_string'
+          when 'long'
+            'long_as_string'
+          when 'number'
+            'number_as_string'
           else
             type
           end
         end
 
-        def self.argument_array_descriptor(argument)
+        def self.argument_array_descriptor(argument, legacy_types:)
           descriptor = { 'type' => argument['type'] }
-          descriptor['items'] = typed_arguments(argument['items']) if argument['items'].is_a?(Hash)
+          descriptor['items'] = typed_arguments(argument['items'], legacy_types: legacy_types) if argument['items'].is_a?(Hash)
           descriptor
         end
 
-        def self.argument_object_descriptor(argument)
+        def self.argument_object_descriptor(argument, legacy_types:)
           descriptor = { 'type' => argument['type'] }
           properties = argument['properties'] || argument['items']
-          descriptor['properties'] = typed_arguments(properties) if properties.is_a?(Hash)
+          descriptor['properties'] = typed_arguments(properties, legacy_types: legacy_types) if properties.is_a?(Hash)
           descriptor
         end
       end

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

@@ -43,6 +43,7 @@ module RSMP
 
         # generate the json schema from a string containing yaml
         def self.generate(sxl)
+          sxl = normalize_legacy_types(sxl) if legacy_types?(sxl)
           out = {}
           output_root out, sxl[:meta]
           output_alarms out, sxl[:alarms]
@@ -52,6 +53,34 @@ module RSMP
           out
         end
 
+        def self.normalize_legacy_types(value)
+          case value
+          when Hash
+            value.each_with_object({}) do |(key, child), memo|
+              memo[key] = key == 'type' ? legacy_type(child) : normalize_legacy_types(child)
+            end
+          when Array
+            value.map { |child| normalize_legacy_types(child) }
+          else
+            value
+          end
+        end
+
+        def self.legacy_type(type)
+          case type
+          when 'boolean'
+            'boolean_as_string'
+          when 'integer'
+            'integer_as_string'
+          when 'long'
+            'long_as_string'
+          when 'number'
+            'number_as_string'
+          else
+            type
+          end
+        end
+
         # convert yaml to json schema and write files to a folder
         def self.write(sxl, folder)
           out = generate sxl

data/lib/rsmp/version.rb

@@ -1,3 +1,3 @@
 module RSMP
-  VERSION = '0.48.2'.freeze
+  VERSION = '0.48.3'.freeze
 end

data/schemas/tlc/1.0.10/commands/M0001.json

@@ -54,7 +54,7 @@
           "properties" : {
             "v" : {
               "description" : "Security code 2",
-              "type" : "string"
+              "$ref" : "../defs/definitions.json#/string_list"
             }
           }
         }
@@ -71,7 +71,7 @@
           "properties" : {
             "v" : {
               "description" : "Time in minutes until controller automatically reverts to previous functional position.\n0=no automatic return",
-              "$ref" : "../defs/definitions.json#/integer"
+              "$ref" : "../defs/definitions.json#/integer_list"
             }
           }
         }
@@ -87,8 +87,8 @@
         "then" : {
           "properties" : {
             "v" : {
-              "description" : "Intersection number.\nCommand only applies to specified intersection. Other intersections remains in their respective operating mode(s).\n0: All intersections",
-              "$ref" : "../defs/definitions.json#/integer"
+              "description" : "Intersection number",
+              "$ref" : "../defs/definitions.json#/integer_list"
             }
           }
         }