rsmp 0.45.0 → 0.45.2

data/lib/rsmp/schema/core_sxl_resolution.rb

@@ -0,0 +1,69 @@
+module RSMP
+  # Provides JSON Schema validation for RSMP messages across core and SXL versions.
+  module Schema
+    def self.clear_core_sxl_schemas(type = nil, version = nil)
+      @core_sxl_schemas ||= {}
+      return @core_sxl_schemas.clear unless type
+
+      type = type.to_sym
+      @core_sxl_schemas.delete_if do |(cached_type, cached_version, _core_version), _schema|
+        cached_type == type && (!version || cached_version == version.to_s)
+      end
+    end
+
+    def self.schema_core_version(schemas)
+      schemas[:core] || schemas['core']
+    end
+
+    def self.validate_resolved_sxl(message, resolved, schemas, options)
+      type, version = resolved
+      schema = find_core_sxl_schema! type, version, schema_core_version(schemas), options
+      validate_using_schema(message, schema)
+    end
+
+    def self.find_core_sxl_schema!(type, version, core_version, options = {})
+      raise ArgumentError, 'core version missing' unless core_version
+
+      version = sanitize_version(version.to_s) if options[:lenient]
+      core_version = sanitize_version(core_version.to_s) if options[:lenient]
+      find_schema! type, version
+      find_schema! :core, core_version
+
+      key = [type.to_sym, version.to_s, core_version.to_s]
+      @core_sxl_schemas ||= {}
+      @core_sxl_schemas[key] ||= build_core_sxl_schema(type, version, core_version)
+    end
+
+    def self.build_core_sxl_schema(type, version, core_version)
+      schema_path = @schema_paths&.dig(type.to_sym, version.to_s)
+      raise UnknownSchemaVersionError, "Unknown schema version #{type} #{version}" unless schema_path
+
+      file_path = File.join(schema_path, 'rsmp.json')
+      JSONSchemer.schema(
+        Pathname.new(file_path),
+        ref_resolver: core_sxl_ref_resolver(core_version)
+      )
+    end
+
+    def self.core_sxl_ref_resolver(core_version)
+      proc do |uri|
+        if sxl_definitions_ref?(uri)
+          JSON.parse(File.read(core_definitions_path(core_version), encoding: 'UTF-8'))
+        else
+          JSONSchemer::FILE_URI_REF_RESOLVER.call(uri)
+        end
+      end
+    end
+
+    def self.sxl_definitions_ref?(uri)
+      uri.scheme == 'file' && uri.path.end_with?('/defs/definitions.json')
+    end
+
+    def self.core_definitions_path(core_version)
+      path = File.join(schema_root_path, 'core', core_version.to_s, 'definitions.json')
+      return path if File.exist?(path)
+
+      raise UnknownSchemaVersionError, "Missing core definitions for RSMP #{core_version}"
+    end
+  end
+end

data/lib/rsmp/schema/validation.rb

@@ -0,0 +1,57 @@
+module RSMP
+  # Provides JSON Schema validation for RSMP messages across core and SXL versions.
+  module Schema
+    def self.core_message_type?(message)
+      type = message['type']
+      %w[
+        MessageAck
+        MessageNotAck
+        Version
+        ComponentList
+        AggregatedStatus
+        AggregatedStatusRequest
+        Watchdog
+      ].include?(type)
+    end
+
+    def self.validate_core(message, schemas, options)
+      core_version = schemas[:core] || schemas['core']
+      raise ArgumentError, 'schemas must include core' unless core_version
+
+      schema = find_schema! :core, core_version, options
+      validate_using_schema(message, schema)
+    end
+
+    def self.validate_sxls(message, schemas, options)
+      sxl_schemas = schemas.reject { |type, _version| type.to_sym == :core }
+      return [] if sxl_schemas.empty? || core_message_type?(message)
+
+      resolved = resolve_sxl(message, schemas: schemas, **options)
+      return validate_resolved_sxl(message, resolved, schemas, options) if resolved
+
+      all_errors = []
+      sxl_schemas.each do |type, version|
+        schema = find_core_sxl_schema! type, version, schema_core_version(schemas), options
+        errors = validate_using_schema(message, schema)
+        return [] if errors.empty?
+
+        all_errors.concat errors
+      end
+      all_errors
+    end
+
+    # Core must pass. SXL-defined messages pass if at least one SXL schema passes.
+    def self.validate(message, schemas, options = {})
+      raise ArgumentError, 'message missing' unless message
+      raise ArgumentError, 'schemas missing' unless schemas
+      raise ArgumentError, 'schemas must be a Hash' unless schemas.is_a?(Hash)
+      raise ArgumentError, 'schemas cannot be empty' unless schemas.any?
+
+      errors = validate_core(message, schemas, options)
+      errors.concat validate_sxls(message, schemas, options) if errors.empty?
+      return nil if errors.empty?
+
+      errors
+    end
+  end
+end

data/lib/rsmp/schema.rb

@@ -1,6 +1,5 @@
 require 'json_schemer'
 require 'json'
-require 'yaml'
 
 # RSMP (Road Side Message Protocol) schema validation library.
 module RSMP
@@ -11,13 +10,19 @@ module RSMP
     def self.setup
       @schemas = {}
       @schema_paths = {}
-      schemas_path = File.expand_path(File.join(__dir__, '..', '..', 'schemas'))
+      @sxl_indexes = {}
+      @core_sxl_schemas = {}
+      schemas_path = schema_root_path
       Dir.glob("#{schemas_path}/*").select { |f| File.directory? f }.each do |type_path|
         type = File.basename(type_path).to_sym
         load_schema_type type, type_path
       end
     end
 
+    def self.schema_root_path
+      File.expand_path(File.join(__dir__, '..', '..', 'schemas'))
+    end
+
     # load an schema from a folder. schemas are organized by version, and contain
     # json schema files, with the entry point being rsmp.jspon, eg:
     # tlc
@@ -35,6 +40,8 @@ module RSMP
       @schemas[type] = {}
       @schema_paths ||= {}
       @schema_paths[type] = {}
+      clear_sxl_index(type)
+      clear_core_sxl_schemas(type)
       schema_version_paths(type_path).each { |schema_path| load_schema_version(type, schema_path) }
     end
 
@@ -53,6 +60,8 @@ module RSMP
 
       @schemas[type][version] = JSONSchemer.schema(Pathname.new(file_path))
       @schema_paths[type][version] = schema_path
+      clear_sxl_index(type, version)
+      clear_core_sxl_schemas(type, version)
     end
 
     # remove a schema type
@@ -60,6 +69,8 @@ module RSMP
       type = type.to_sym
       schemas.delete type
       @schema_paths&.delete type
+      clear_sxl_index(type)
+      clear_core_sxl_schemas(type)
     end
 
     # get schemas types
@@ -195,14 +206,7 @@ module RSMP
       version = sanitize_version version if options[:lenient]
       find_schema! type, version
 
-      path = @schema_paths&.dig(type.to_sym, version)
-      return {} unless path
-
-      yaml_path = File.join(path, 'sxl.yaml')
-      return YAML.load_file(yaml_path).fetch('meta', {}) if File.exist?(yaml_path)
-
-      json_path = File.join(path, 'rsmp.json')
-      File.exist?(json_path) ? JSON.parse(File.read(json_path)) : {}
+      sxl_index(type, version).fetch('meta', {})
     end
 
     def self.sxl_prefix(type, version, options = {})
@@ -211,82 +215,51 @@ module RSMP
 
     # return a catalogue of statuses for a particular schema type and version
     # returns a hash of { status_code_id_sym => [arg_name_sym, ...] }
-    # raises an error if the schema type/version is not found, or has no sxl.yaml
+    # raises an error if the schema type/version is not found, or has no status catalogue
     def self.status_catalogue(type, version)
       sxl_catalogue(type, version, :statuses).transform_keys(&:to_sym).transform_values do |status|
-        (status['arguments'] || {}).keys.map(&:to_sym)
+        status.fetch('arguments', []).map(&:to_sym)
       end
     end
 
     def self.sxl_catalogue(type, version, kind)
       find_schema! type, version
-      schema_path = @schema_paths&.dig(type.to_sym, version)
-      yaml_path = File.join(schema_path, 'sxl.yaml') if schema_path
-      raise "No sxl.yaml for #{type} #{version}" unless yaml_path && File.exist?(yaml_path)
-
-      sxl = RSMP::Convert::Import::YAML.read(yaml_path)
-      sxl.fetch(kind)
-    end
-
-    def self.core_message_type?(message)
-      type = message['type']
-      %w[
-        MessageAck
-        MessageNotAck
-        Version
-        ComponentList
-        AggregatedStatus
-        AggregatedStatusRequest
-        Watchdog
-      ].include?(type)
-    end
+      catalogue = sxl_index(type, version)[kind.to_s]
+      raise "No #{kind} catalogue for #{type} #{version}" unless catalogue
 
-    def self.validate_core(message, schemas, options)
-      core_version = schemas[:core] || schemas['core']
-      raise ArgumentError, 'schemas must include core' unless core_version
-
-      schema = find_schema! :core, core_version, options
-      validate_using_schema(message, schema)
+      catalogue
     end
 
-    def self.validate_sxls(message, schemas, options)
-      sxl_schemas = schemas.reject { |type, _version| type.to_sym == :core }
-      return [] if sxl_schemas.empty? || core_message_type?(message)
+    def self.clear_sxl_index(type = nil, version = nil)
+      @sxl_indexes ||= {}
+      return @sxl_indexes.clear unless type
 
-      resolved = resolve_sxl(message, schemas: schemas, **options)
-      if resolved
-        type, version = resolved
-        schema = find_schema! type, version, options
-        return validate_using_schema(message, schema)
+      type = type.to_sym
+      if version
+        @sxl_indexes.delete([type, version.to_s])
+      else
+        @sxl_indexes.delete_if { |key, _value| key.first == type }
       end
+    end
 
-      all_errors = []
-      sxl_schemas.each do |type, version|
-        schema = find_schema! type, version, options
-        errors = validate_using_schema(message, schema)
-        return [] if errors.empty?
-
-        all_errors.concat errors
-      end
-      all_errors
+    def self.sxl_index(type, version)
+      key = [type.to_sym, version.to_s]
+      @sxl_indexes ||= {}
+      @sxl_indexes[key] ||= load_sxl_index(type, version)
     end
 
-    # validate using core and optional SXL schemas.
-    # Core must pass. SXL-defined messages pass if at least one SXL schema passes.
-    # returns nil if validation succeeds, otherwise returns an array of errors.
-    def self.validate(message, schemas, options = {})
-      raise ArgumentError, 'message missing' unless message
-      raise ArgumentError, 'schemas missing' unless schemas
-      raise ArgumentError, 'schemas must be a Hash' unless schemas.is_a?(Hash)
-      raise ArgumentError, 'schemas cannot be empty' unless schemas.any?
+    def self.load_sxl_index(type, version)
+      schema_path = @schema_paths&.dig(type.to_sym, version.to_s)
+      raise UnknownSchemaVersionError, "Unknown schema version #{type} #{version}" unless schema_path
 
-      errors = validate_core(message, schemas, options)
-      errors.concat validate_sxls(message, schemas, options) if errors.empty?
-      return nil if errors.empty?
+      index_path = File.join(schema_path, 'sxl_index.json')
+      raise Error, "Missing SXL index #{index_path}" unless File.exist?(index_path)
 
-      errors
+      JSON.parse(File.read(index_path, encoding: 'UTF-8'))
     end
   end
 end
 
+require_relative 'schema/core_sxl_resolution'
 require_relative 'schema/message_resolution'
+require_relative 'schema/validation'

data/lib/rsmp/tlc/proxy/control.rb

@@ -4,7 +4,7 @@ module RSMP
       # Command methods for operational control of a remote TLC.
       # Covers functional position, emergency routes, I/O modes, signal group orders, and system settings.
       module Control
-        # M0001 — Set functional position (NormalControl, YellowFlash, Dark).
+        # M0001 - Set functional position (NormalControl, YellowFlash, Dark).
         def set_functional_position(status, within:, timeout_minutes: 0)
           validate_ready 'set functional position'
           raise 'TLC main component not found' unless main
@@ -17,7 +17,7 @@ module RSMP
           { collector: collector }
         end
 
-        # M0005 — Set or clear an emergency route.
+        # M0005 - Set or clear an emergency route.
         def set_emergency_route(route:, active:, within:)
           validate_ready 'set emergency route'
           raise 'TLC main component not found' unless main
@@ -45,7 +45,7 @@ module RSMP
           send_command_and_collect(command_list, within: within).ok!
         end
 
-        # M0007 — Enable or disable fixed-time control.
+        # M0007 - Enable or disable fixed-time control.
         def set_fixed_time(status, within:)
           validate_ready 'set fixed time'
           raise 'TLC main component not found' unless main
@@ -70,7 +70,7 @@ module RSMP
           wait_for_status "fixed time #{status}", confirm_status, timeout: within
         end
 
-        # M0003 — Set traffic situation (activate a specific situation number).
+        # M0003 - Set traffic situation (activate a specific situation number).
         def set_traffic_situation(situation, within:)
           validate_ready 'set traffic situation'
           raise 'TLC main component not found' unless main
@@ -99,7 +99,7 @@ module RSMP
           wait_for_status "traffic situation #{situation}", confirm_status, timeout: within
         end
 
-        # M0003 — Clear the active traffic situation.
+        # M0003 - Clear the active traffic situation.
         def unset_traffic_situation(within:)
           validate_ready 'unset traffic situation'
           raise 'TLC main component not found' unless main

data/lib/rsmp/tlc/proxy/detectors.rb

@@ -4,7 +4,7 @@ module RSMP
       # Command methods for operational control of a remote TLC.
       # Covers functional position, emergency routes, I/O modes, signal group orders, and system settings.
       module Detectors
-        # M0008 — Force detector logic to a given mode and status.
+        # M0008 - Force detector logic to a given mode and status.
         # component_id must refer to the detector logic component, not main.
         def force_detector_logic(component_id, status:, mode:, within:)
           validate_ready 'force detector logic'
@@ -30,7 +30,7 @@ module RSMP
           send_command_and_collect(command_list, component: component_id, within: within).ok!
         end
 
-        # M0021 — Set the trigger level for traffic counting.
+        # M0021 - Set the trigger level for traffic counting.
         def set_trigger_level(status, within:)
           validate_ready 'set trigger level'
           raise 'TLC main component not found' unless main

data/lib/rsmp/tlc/proxy/io.rb

@@ -4,7 +4,7 @@ module RSMP
       # Command methods for I/O control of a remote TLC.
       # Covers detector logic, input/output forcing and setting.
       module IO
-        # M0006 — Set a single input to a given status.
+        # M0006 - Set a single input to a given status.
         def set_input(input:, status:, within:)
           validate_ready 'set input'
           raise 'TLC main component not found' unless main
@@ -30,7 +30,7 @@ module RSMP
           send_command_and_collect(command_list, within: within).ok!
         end
 
-        # M0013 — Set all inputs via a bit-pattern string.
+        # M0013 - Set all inputs via a bit-pattern string.
         def set_inputs(status, within:)
           validate_ready 'set inputs'
           raise 'TLC main component not found' unless main
@@ -51,7 +51,7 @@ module RSMP
           send_command_and_collect(command_list, within: within).ok!
         end
 
-        # M0019 — Force an input to a given value.
+        # M0019 - Force an input to a given value.
         def force_input(input:, status:, value:, within:)
           validate_ready 'force input'
           raise 'TLC main component not found' unless main
@@ -62,7 +62,7 @@ module RSMP
           wait_for_status "force input #{input}", confirm_status, timeout: within
         end
 
-        # M0020 — Force an output to a given value.
+        # M0020 - Force an output to a given value.
         def force_output(output:, status:, value:, within:)
           validate_ready 'force output'
           raise 'TLC main component not found' unless main

data/lib/rsmp/tlc/proxy/plans.rb

@@ -4,7 +4,7 @@ module RSMP
       # Command methods for signal plans.
       # Covers time plans, week/day tables, bands, offsets, and cycle times.
       module Plans
-        # M0014 — Set dynamic bands for a signal plan.
+        # M0014 - Set dynamic bands for a signal plan.
         def set_dynamic_bands(plan:, status:, within:)
           validate_ready 'set dynamic bands'
           raise 'TLC main component not found' unless main
@@ -30,7 +30,7 @@ module RSMP
           send_command_and_collect(command_list, within: within).ok!
         end
 
-        # M0023 — Set timeout for dynamic bands.
+        # M0023 - Set timeout for dynamic bands.
         def set_dynamic_bands_timeout(status, within:)
           validate_ready 'set dynamic bands timeout'
           raise 'TLC main component not found' unless main
@@ -51,7 +51,7 @@ module RSMP
           send_command_and_collect(command_list, within: within).ok!
         end
 
-        # M0015 — Set offset for a signal plan.
+        # M0015 - Set offset for a signal plan.
         def set_offset(plan:, offset:, within:)
           validate_ready 'set offset'
           raise 'TLC main component not found' unless main
@@ -105,7 +105,7 @@ module RSMP
           wait_for_status("timeplan #{plan_nr}", confirm_status, timeout: within)
         end
 
-        # M0016 — Set week table (mapping week days to traffic situations).
+        # M0016 - Set week table (mapping week days to traffic situations).
         def set_week_table(status, within:)
           validate_ready 'set week table'
           raise 'TLC main component not found' unless main
@@ -126,7 +126,7 @@ module RSMP
           send_command_and_collect(command_list, within:).ok!
         end
 
-        # M0017 — Set day table (mapping time periods to signal plans).
+        # M0017 - Set day table (mapping time periods to signal plans).
         def set_day_table(status, within:)
           validate_ready 'set day table'
           raise 'TLC main component not found' unless main
@@ -147,7 +147,7 @@ module RSMP
           send_command_and_collect(command_list, within:).ok!
         end
 
-        # M0018 — Set cycle time for a signal plan.
+        # M0018 - Set cycle time for a signal plan.
         def set_cycle_time(plan:, cycle_time:, within:)
           validate_ready 'set cycle time'
           raise 'TLC main component not found' unless main
@@ -173,7 +173,7 @@ module RSMP
           send_command_and_collect(command_list, within:).ok!
         end
 
-        # M0010 — Order signal start for a signal group component.
+        # M0010 - Order signal start for a signal group component.
         def order_signal_start(component_id, within:)
           validate_ready 'order signal start'
 
@@ -193,7 +193,7 @@ module RSMP
           send_command_and_collect(command_list, component: component_id, within:).ok!
         end
 
-        # M0011 — Order signal stop for a signal group component.
+        # M0011 - Order signal stop for a signal group component.
         def order_signal_stop(component_id, within:)
           validate_ready 'order signal stop'
 

data/lib/rsmp/tlc/proxy/system.rb

@@ -4,7 +4,7 @@ module RSMP
       # Command methods for operational control of a remote TLC.
       # Covers functional position, emergency routes, I/O modes, signal group orders, and system settings.
       module System
-        # M0103 — Change security code for a given level.
+        # M0103 - Change security code for a given level.
         # Does not use security_code_for since the codes are passed explicitly.
         def set_security_code(level:, old_code:, new_code:, within:)
           validate_ready 'set security code'
@@ -29,7 +29,7 @@ module RSMP
           send_command_and_collect(command_list, within: within).ok!
         end
 
-        # M0104 — Set the clock on the remote TLC. clock must respond to year/month/day/hour/min/sec.
+        # M0104 - Set the clock on the remote TLC. clock must respond to year/month/day/hour/min/sec.
         def set_clock(clock, within:)
           validate_ready 'set clock'
           raise 'TLC main component not found' unless main

data/lib/rsmp/version.rb

@@ -1,3 +1,3 @@
 module RSMP
-  VERSION = '0.45.0'.freeze
+  VERSION = '0.45.2'.freeze
 end

data/schemas/tlc/1.0.10/rsmp.json

@@ -70,5 +70,6 @@
         "$ref" : "alarms/alarms.json"
       }
     }
-  ]
+  ],
+  "minimum_core_version" : "3.1.2"
 }

data/schemas/tlc/1.0.10/sxl.yaml

@@ -3,6 +3,7 @@ meta:
   name: tlc
   description: Traffic Light Controllers
   version: 1.0.10
+  minimum_core_version: 3.1.2
 objects:
   Traffic Light Controller:
     description: