rsmp_schema 0.1.0 → 0.2.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 07e5fccae77303733072ab27976c1cb1991ea9cd1add360dbac63e8da97baf8b
-  data.tar.gz: 364e6d5569d3fa262a96de68b80bec855d4fd3bb06c754ee47c5bcc3ea9300c4
+  metadata.gz: d77598d55d8ad5356f08539dae9c80c2f0887240f3d7cc45fe8f81a39e22467f
+  data.tar.gz: 376dde9dc8d380588293178dba3b968ac8a558c52832804e0aea5c0d065627f1
 SHA512:
-  metadata.gz: d9a41e3ef2a8f1ce2ed30b701867b118fdaad9fc7f2bced0ca3637a65f242bb69735715e1d41d5bf7ea20690c2280cad7bdbd3b33ce2d0e137f218517967f3d8
-  data.tar.gz: 9885c98876461dab7abc379206ee2617ffb6747fe96a91dec3c382d9111029b3a98ad9a389a6b2ea311db1d4d98e66ead63bf8baf5a7b020c3f520878bad4d54
+  metadata.gz: f49e353daeca137c0a542dfad6f49f6c927786fbef5f3b8242bf9dd29f091e398ef10ba206ebf71a64c8d64f258400c0b3b24c87b4e62cc39aaa6dd3d76bbbaa
+  data.tar.gz: 7c0565ff56406fbfc56f6b711e1b26a42d9bf1a50b708ed659b53628963f42b37922814ed2e0f517c302dd205ffbf888d22bd11f93be9a875f88ab84d6241dbc

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    rsmp_schema (0.1.0)
+    rsmp_schema (0.2.1)
       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.0"
+    VERSION = "0.2.1"
   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