rsmp_schema 0.2.5 → 0.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: da6aa7917da1551ed490189b8b6d782c9ae6c6d4baf4b46adabcc21cc801cc19
-  data.tar.gz: a916a1d6fbc64fcdc050f1be7a4d6c2a603497c54e73baa58c7d775c8c39c803
+  metadata.gz: 575a89e29f57a294f101abea73f59c22c43d4156ad3b700f5c71bbda7dcbe79b
+  data.tar.gz: 2887c0c2f4ccb51ae60f41dfd499035d136317fd5086255c14f26a255d26b365
 SHA512:
-  metadata.gz: 675151863b4bbbffa9d6598e833dcda25d48cf0ce332c9ce05e035fe7f6567269e1b180032182335eeeaf2ae915fc78a75478116f21fcfa496809cffdbeeaf49
-  data.tar.gz: baf90db70f6950c2a7c20bec201d4b347fd478e5716f71fdef263db690edf8423df45ad0531fef3a26b8ade57eec0eacfb3ac1004dde88420f197a9740345285
+  metadata.gz: 02b3e8b39f2eb04775a6c723bb9b6cffd5e2ab66e987ee77b16c5cfb895a47cf201c1efc557f0a2b90b7e035b8483905f08624999643bcaf823c1614dbefbceb
+  data.tar.gz: 99df31b79fe0b7f74f60b441d47d43ad6e8a2ca756907ec0d5f9a61783e5bb3ce4016aa448a731c5825714ea6eae4e62a0fe5e8c9cd684c1ffcce8796c4cb14a

data/Gemfile.lock

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

data/README.md

@@ -13,14 +13,14 @@ The schema consists of a core schema shared by all equipment types, and an SXL s
 
 Both core and SXL schemas exist in different version, for validation agaist a particular version of the spec.
 
-For example, to validate against the SXL for Trafic Light Controllers (TLCs), version 1.0.15, use the file schemas/tcl/1.0.15/sxl.json.
+For example, to validate against the SXL for Trafic Light Controllers (TLCs), version 1.0.15, use the file schemas/tcl/1.0.15/rsmp.json.
 
 Depending on the message type, relevant JSON Schema elements will be included to validate the detailed parameters, arguments, etc.
 
 For example, validating a CommandRequest M0001 message will include these parts:
 
 ```
-sxl.json
+rsmp.json
   commands.json
     M0001.json
 ```
@@ -52,7 +52,7 @@ message = {
 }
 
 # try validating a message against our schema
-schema = Pathname.new('schemas/tlc/1.1/sxl.json')
+schema = Pathname.new('schemas/tlc/1.1/rsmp.json')
 schemer = JSONSchemer.schema(schema)
 puts schemer.valid? message     # => true
 ```

data/examples/validate.rb

@@ -19,7 +19,7 @@ message = {
 }
 
 # try validating a message against our schema
-schema = Pathname.new('schema/tlc/sxl.json')
+schema = Pathname.new('schema/tlc/1.1/rsmp.json')
 schemer = JSONSchemer.schema(schema)
 if schemer.valid? message
   puts 'ok'

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

@@ -242,7 +242,7 @@ module RSMP
               }
             ]
           }
-          out["sxl.json"] = output_json json
+          out["rsmp.json"] = output_json json
         end
 
         # generate the json schema from a string containing yaml

data/lib/rsmp_schema/schema.rb

@@ -11,21 +11,41 @@ module RSMP::Schema
     schemas_path = File.expand_path( File.join(__dir__,'..','..','schemas') )
     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
+      load_schema_type type, type_path
+    end
+  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
+  #   1.0.7
+  #     rsmp.json
+  #     other jon schema files...
+  #   1.0.8
+  #   ...
+  #
+  #  an error is raised if the schema type already exists, and force is not set to true
+  def self.load_schema_type type, type_path, force:false
+    raise RuntimeError.new("Schema type #{type} already loaded") if @@schemas[type] && force!=true
+    @@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'))
+      )
     end
   end
 
+  # remove a schema type
+  def self.remove_schema_type type
+    schemas.delete type
+  end
+
+  # get schemas types
+  def self.schema_types
+    schemas.keys
+  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

data/lib/rsmp_schema/version.rb

@@ -1,5 +1,5 @@
 module RSMP
   module Schema
-    VERSION = "0.2.5"
+    VERSION = "0.3.0"
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: rsmp_schema
 version: !ruby/object:Gem::Version
-  version: 0.2.5
+  version: 0.3.0
 platform: ruby
 authors:
 - Emil Tin
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2022-08-26 00:00:00.000000000 Z
+date: 2022-08-30 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: json_schemer
@@ -190,6 +190,7 @@ files:
 - schemas/tlc/1.0.10/commands/command_requests.json
 - schemas/tlc/1.0.10/commands/command_responses.json
 - schemas/tlc/1.0.10/commands/commands.json
+- schemas/tlc/1.0.10/rsmp.json
 - schemas/tlc/1.0.10/statuses/S0001.json
 - schemas/tlc/1.0.10/statuses/S0002.json
 - schemas/tlc/1.0.10/statuses/S0003.json
@@ -220,7 +221,6 @@ files:
 - schemas/tlc/1.0.10/statuses/S0203.json
 - schemas/tlc/1.0.10/statuses/S0204.json
 - schemas/tlc/1.0.10/statuses/statuses.json
-- schemas/tlc/1.0.10/sxl.json
 - schemas/tlc/1.0.10/sxl.yaml
 - schemas/tlc/1.0.13/alarms/A0001.json
 - schemas/tlc/1.0.13/alarms/A0002.json
@@ -260,6 +260,7 @@ files:
 - schemas/tlc/1.0.13/commands/command_requests.json
 - schemas/tlc/1.0.13/commands/command_responses.json
 - schemas/tlc/1.0.13/commands/commands.json
+- schemas/tlc/1.0.13/rsmp.json
 - schemas/tlc/1.0.13/statuses/S0001.json
 - schemas/tlc/1.0.13/statuses/S0002.json
 - schemas/tlc/1.0.13/statuses/S0003.json
@@ -298,7 +299,6 @@ files:
 - schemas/tlc/1.0.13/statuses/S0203.json
 - schemas/tlc/1.0.13/statuses/S0204.json
 - schemas/tlc/1.0.13/statuses/statuses.json
-- schemas/tlc/1.0.13/sxl.json
 - schemas/tlc/1.0.13/sxl.yaml
 - schemas/tlc/1.0.14/alarms/A0001.json
 - schemas/tlc/1.0.14/alarms/A0002.json
@@ -338,6 +338,7 @@ files:
 - schemas/tlc/1.0.14/commands/command_requests.json
 - schemas/tlc/1.0.14/commands/command_responses.json
 - schemas/tlc/1.0.14/commands/commands.json
+- schemas/tlc/1.0.14/rsmp.json
 - schemas/tlc/1.0.14/statuses/S0001.json
 - schemas/tlc/1.0.14/statuses/S0002.json
 - schemas/tlc/1.0.14/statuses/S0003.json
@@ -380,7 +381,6 @@ files:
 - schemas/tlc/1.0.14/statuses/S0207.json
 - schemas/tlc/1.0.14/statuses/S0208.json
 - schemas/tlc/1.0.14/statuses/statuses.json
-- schemas/tlc/1.0.14/sxl.json
 - schemas/tlc/1.0.14/sxl.yaml
 - schemas/tlc/1.0.15/alarms/A0001.json
 - schemas/tlc/1.0.15/alarms/A0002.json
@@ -423,6 +423,7 @@ files:
 - schemas/tlc/1.0.15/commands/command_requests.json
 - schemas/tlc/1.0.15/commands/command_responses.json
 - schemas/tlc/1.0.15/commands/commands.json
+- schemas/tlc/1.0.15/rsmp.json
 - schemas/tlc/1.0.15/statuses/S0001.json
 - schemas/tlc/1.0.15/statuses/S0002.json
 - schemas/tlc/1.0.15/statuses/S0003.json
@@ -469,7 +470,6 @@ files:
 - schemas/tlc/1.0.15/statuses/S0207.json
 - schemas/tlc/1.0.15/statuses/S0208.json
 - schemas/tlc/1.0.15/statuses/statuses.json
-- schemas/tlc/1.0.15/sxl.json
 - schemas/tlc/1.0.15/sxl.yaml
 - schemas/tlc/1.0.7/alarms/A0001.json
 - schemas/tlc/1.0.7/alarms/A0002.json
@@ -502,6 +502,7 @@ files:
 - schemas/tlc/1.0.7/commands/command_requests.json
 - schemas/tlc/1.0.7/commands/command_responses.json
 - schemas/tlc/1.0.7/commands/commands.json
+- schemas/tlc/1.0.7/rsmp.json
 - schemas/tlc/1.0.7/statuses/S0001.json
 - schemas/tlc/1.0.7/statuses/S0002.json
 - schemas/tlc/1.0.7/statuses/S0003.json
@@ -533,7 +534,6 @@ files:
 - schemas/tlc/1.0.7/statuses/S0203.json
 - schemas/tlc/1.0.7/statuses/S0204.json
 - schemas/tlc/1.0.7/statuses/statuses.json
-- schemas/tlc/1.0.7/sxl.json
 - schemas/tlc/1.0.7/sxl.yaml
 - schemas/tlc/1.0.8/alarms/A0001.json
 - schemas/tlc/1.0.8/alarms/A0002.json
@@ -568,6 +568,7 @@ files:
 - schemas/tlc/1.0.8/commands/command_requests.json
 - schemas/tlc/1.0.8/commands/command_responses.json
 - schemas/tlc/1.0.8/commands/commands.json
+- schemas/tlc/1.0.8/rsmp.json
 - schemas/tlc/1.0.8/statuses/S0001.json
 - schemas/tlc/1.0.8/statuses/S0002.json
 - schemas/tlc/1.0.8/statuses/S0003.json
@@ -599,7 +600,6 @@ files:
 - schemas/tlc/1.0.8/statuses/S0203.json
 - schemas/tlc/1.0.8/statuses/S0204.json
 - schemas/tlc/1.0.8/statuses/statuses.json
-- schemas/tlc/1.0.8/sxl.json
 - schemas/tlc/1.0.8/sxl.yaml
 - schemas/tlc/1.0.9/alarms/A0001.json
 - schemas/tlc/1.0.9/alarms/A0002.json
@@ -634,6 +634,7 @@ files:
 - schemas/tlc/1.0.9/commands/command_requests.json
 - schemas/tlc/1.0.9/commands/command_responses.json
 - schemas/tlc/1.0.9/commands/commands.json
+- schemas/tlc/1.0.9/rsmp.json
 - schemas/tlc/1.0.9/statuses/S0001.json
 - schemas/tlc/1.0.9/statuses/S0002.json
 - schemas/tlc/1.0.9/statuses/S0003.json
@@ -665,7 +666,6 @@ files:
 - schemas/tlc/1.0.9/statuses/S0203.json
 - schemas/tlc/1.0.9/statuses/S0204.json
 - schemas/tlc/1.0.9/statuses/statuses.json
-- schemas/tlc/1.0.9/sxl.json
 - schemas/tlc/1.0.9/sxl.yaml
 - schemas/tlc/1.1/alarms/A0001.json
 - schemas/tlc/1.1/alarms/A0002.json
@@ -712,6 +712,7 @@ files:
 - schemas/tlc/1.1/commands/command_requests.json
 - schemas/tlc/1.1/commands/command_responses.json
 - schemas/tlc/1.1/commands/commands.json
+- schemas/tlc/1.1/rsmp.json
 - schemas/tlc/1.1/statuses/S0001.json
 - schemas/tlc/1.1/statuses/S0002.json
 - schemas/tlc/1.1/statuses/S0003.json
@@ -761,7 +762,6 @@ files:
 - schemas/tlc/1.1/statuses/S0207.json
 - schemas/tlc/1.1/statuses/S0208.json
 - schemas/tlc/1.1/statuses/statuses.json
-- schemas/tlc/1.1/sxl.json
 - schemas/tlc/1.1/sxl.yaml
 homepage: https://github.com/rsmp-nordic/rsmp_schema
 licenses: