rsmp_schema 0.2.0 → 0.2.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: badefc8cfd4f1df332cad770cd02b9394d19fe327860206cf59ed745b7f051cd
-  data.tar.gz: d04eebeede6747cd5b245ef66c83b1d0256c14bd7df21f6f2d94176bfd146536
+  metadata.gz: e82b6ea883b37ce64d134d66ba9980891dd9ecf8f1f7fc12df75df212b77d7a1
+  data.tar.gz: 242013a26a727cb7ec5281c3e3d60f68e2799999238503ad2701e209fb7112ec
 SHA512:
-  metadata.gz: 4ba94206d0fc23153dff5474dc4fea59112d24319a7bf1932ea5ada2bf1f77412b2231913cce74f11f69f9783fa319aff41b0a57cc08a35770ee401e7c01205f
-  data.tar.gz: afb8edf5054d2e430b174bb881b149eab1487891ef774239e3cbc9b87419b1afbbc2aa7a6504e35a512c7694480c762c08e42a77c72a84fa673e2d3c3ed9db63
+  metadata.gz: '046758412e06b7b8ddea3ecb050cd0d0d32d55f901f85b74a2cd1032def20417d7dacdeea9710234730ef2b03b6e29152f230be6ac6eda295154beeaa925b2a5'
+  data.tar.gz: f27d0648c9023b301caca1a5d311ef02577afe6c8adf54ca07c2ba3dc3b8f71b114dd451a7464e61a93be5d560b6b4a2e07b2c02df15392a60fa6a4d2c777b54

data/Gemfile.lock

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

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

@@ -108,13 +108,19 @@ module RSMP
         # convert yaml values to jsons schema enum
         def self.handle_enum item, out
           if item["values"]
-            case item["values"]
+            out["enum"] = case item["values"]
             when Hash
-              out["enum"] = item["values"].keys.sort
+              item["values"].keys.sort
             when Array
-              out["enum"] = item["values"].sort
+              item["values"].sort
             else
-              raise "Error: Values must be specified as either a Hash or an Array"
+              raise "Error: Values must be specified as either a Hash or an Array, got #{item["values"].class}"
+            end.map do |v|
+              if v.is_a?(Integer) || v.is_a?(Float)
+                v.to_s
+              else
+                v
+              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.2.0"
+    VERSION = "0.2.3"
   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.1/statuses/S0091.json

@@ -26,11 +26,10 @@
           "s" : {
             "allOf" : [
               {
-                "description" : "0: Nobody logged in \n1: Operator logged in at level 1 (read only) \n2: Operator logged in at level 2 (read/write)",
                 "enum" : [
-                  0,
-                  1,
-                  2
+                  "0",
+                  "1",
+                  "2"
                 ]
               },
               {

data/schemas/tlc/1.1/statuses/S0092.json

@@ -26,11 +26,10 @@
           "s" : {
             "allOf" : [
               {
-                "description" : "0: Nobody logged in \n1: Operator logged in at level 1 (read only) \n2: Operator logged in at level 2 (read/write)",
                 "enum" : [
-                  0,
-                  1,
-                  2
+                  "0",
+                  "1",
+                  "2"
                 ]
               },
               {

data/schemas/tlc/1.1/sxl.yaml

@@ -781,8 +781,7 @@ objects:
         arguments:
           user:
             type: integer
-            values: [0,1,2]
-            description: |-
+            values:
               0: Nobody logged in 
               1: Operator logged in at level 1 (read only) 
               2: Operator logged in at level 2 (read/write)
@@ -793,8 +792,7 @@ objects:
         arguments:
           user:
             type: integer
-            values: [0,1,2]
-            description: |-
+            values:
               0: Nobody logged in 
               1: Operator logged in at level 1 (read only) 
               2: Operator logged in at level 2 (read/write)

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: rsmp_schema
 version: !ruby/object:Gem::Version
-  version: 0.2.0
+  version: 0.2.3
 platform: ruby
 authors:
 - Emil Tin
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2022-08-24 00:00:00.000000000 Z
+date: 2022-08-25 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: json_schemer