kwalify_to_json_schema 0.2.1 → 0.6.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 2e3e11103f87d4445e81beb29fe9b36d3dc17c0e03b399d2d088d9b1fa8504d8
-  data.tar.gz: c2e09d2aa94ceb1a5588f9e175b402ee11a3260d6b1441471eec1f304e7b29d6
+  metadata.gz: 2bbbe823e0df66f54b21956a628b2a08dad03190f4d2884ee05abe1c6362fba8
+  data.tar.gz: ef883dfea6e9cebcee6c0bd95d7470db46d428734dac428cd52f65230af7666a
 SHA512:
-  metadata.gz: '09fd74c1ade4d0e9389d46ec6d93d40d9ce797a34bc951eaf0354c3dfe2f2464c2a2849e65b4dc0ebaa682648816eb16b0b79c91ba56f4815d0ac309473e28d8'
-  data.tar.gz: e78af6fbb9e4c2cd3e17e4168abd3615b5e798ffb318a737b5978a8613af4548a7ac4a36bae783e228b2d9314e0f4815ce6172ccb6a1b3789f8bdde491c89abb
+  metadata.gz: 237ff9995ed857260b71851e3499640af68deafcbb65c8103d6e7227ce1a0c774b06d8b3d4cab7ed1f0f54bf74e4122e6dcfe543515db2dc70a2dc971e10e8a0
+  data.tar.gz: d30502c9942dd6039c074b3c227b3829fa8624dca103541572487659eda84386ba91f7583742183dbe1f1d8ca6e79f74b8aadfc461e65a1aac07ac576742b0e2

data/lib/kwalify_to_json_schema.rb

@@ -6,6 +6,8 @@ require_relative "kwalify_to_json_schema/kwalify_to_json_schema"
 require_relative "kwalify_to_json_schema/serialization"
 require_relative "kwalify_to_json_schema/options"
 require_relative "kwalify_to_json_schema/limitations"
+require_relative "kwalify_to_json_schema/issue"
+require_relative "kwalify_to_json_schema/issues"
 require_relative "kwalify_to_json_schema/converter"
 require_relative "kwalify_to_json_schema/custom_processing"
 require_relative "kwalify_to_json_schema/cli"

data/lib/kwalify_to_json_schema/cli.rb

@@ -29,6 +29,9 @@ module KwalifyToJsonSchema
     option(*Options.cli_option(Options::TITLE))
     option(*Options.cli_option(Options::DESCRIPTION))
     option(*Options.cli_option(Options::ISSUES_TO_DESCRIPTION))
+    option(*Options.cli_option(Options::ISSUES_TO_STDERR))
+    option(*Options.cli_option(Options::SCHEMA_VERSION))
+    option(*Options.cli_option(Options::VERBOSE))
     option Options::CUSTOM_PROCESSING,
            :type => :string,
            :desc => <<~DESC
@@ -58,6 +61,8 @@ module KwalifyToJsonSchema
            :default => false,
            :desc => "Process files recursively",
            :long_desc => ""
+    option(*Options.cli_option(Options::SCHEMA_VERSION))
+    option(*Options.cli_option(Options::VERBOSE))
     option Options::CUSTOM_PROCESSING,
            :type => :string,
            :desc => <<~DESC
@@ -67,11 +72,9 @@ module KwalifyToJsonSchema
            DESC
 
     def convert_dir(kwalify_schema_dir, result_dir)
-      opts = {
-        Options::ISSUES_TO_DESCRIPTION => options[:issues_to_description],
-        Options::CUSTOM_PROCESSING => custom_processing(options),
-      }
-
+      opts = options.dup
+      opts[Options::CUSTOM_PROCESSING] = custom_processing(options)
+      
       path = [kwalify_schema_dir, options["recursive"] ? "**" : nil, "*.yaml"].compact
       Dir.glob(File.join(*path)).each { |kwalify_schema_file|
         result_file = File.join(result_dir, File.basename(kwalify_schema_file, File.extname(kwalify_schema_file))) + ".#{options["format"]}"

data/lib/kwalify_to_json_schema/converter.rb

@@ -11,7 +11,7 @@ module KwalifyToJsonSchema
   #
   # File.write("json_schema.json", JSON.pretty_generate(json_schema))
   class Converter
-    SCHEMA = "http://json-schema.org/draft-07/schema#"
+    SCHEMA = "http://json-schema.org/%s/schema#"
 
     # The options given used to initialized the converter
     attr_reader :options
@@ -24,12 +24,16 @@ module KwalifyToJsonSchema
     # | :id                   | string | nil          | The JSON schema identifier                                                               |
     # | :title                | string | nil          | The JSON schema title                                                                    |
     # | :description          | string | nil          | The JSON schema description. If not given the Kwalify description will be used if present|
-    # | :issues_to_description| boolean| false        | To append the issuses to the JSON schema description                                     |
+    # | :issues_to_description| boolean| false        | To append the issues to the JSON schema description                                      |
+    # | :issues_to_stderr     | boolean| false        | To write the issues to standard error output                                             |
     # | :custom_processing    | object | nil          | To customize the conversion                                                              |
+    # | :schema_version       | string | "draft-04"   | JSON schema version. Changing this value only change the value of $schema field          |
+    # | :verbose              | boolean| false        | To be verbose when converting                                                            |
     # --
-    def initialize(options_hash = {})
-      @options = Options.new(options_hash)
-      @issues = []
+    # @param options {Options} or {Hash}
+    def initialize(options = {})
+      @options = Options.new(options)
+      @issues = Issues.new
     end
 
     # Execute the conversion process
@@ -43,11 +47,12 @@ module KwalifyToJsonSchema
       if issues.any? && options.issues_to_description?
         description = json_schema["description"] ||= ""
         description << "Issues when converting from Kwalify:\n"
-        description << issues.map { |issue| "* #{issue}" }.join("\n")
+        description << issues.descriptions_uniq.map { |description| "* #{description}" }.join("\n")
       end
 
       # Override description if given in option
       json_schema["description"] = options.description if options.description
+      STDERR.puts issues if options.issues_to_stderr?
 
       postprocess(json_schema)
     end
@@ -56,20 +61,22 @@ module KwalifyToJsonSchema
 
     def root
       {
-        "$schema" => SCHEMA,
-        "$id" => options.id,
+        "$schema" => SCHEMA % options.schema_version,
+        "id" => options.id,
         "title" => options.title,
       }.reject { |k, v| v.nil? }
     end
 
     # @param target Json schema target
     # @param kelem Kwalify element
-    def process(target, kelem)
+    def process(target, kelem, path = [])
 
       # Add description if available
       target["description"] = kelem["desc"] if kelem["desc"]
+      ktype = kelem["type"]
+      path += [ktype] if ktype
 
-      case ktype = kelem["type"]
+      case ktype
       when "map"
         target["type"] = "object"
         target["additionalProperties"] = false
@@ -78,8 +85,18 @@ module KwalifyToJsonSchema
         if mapping.is_a? Hash
           properties = target["properties"] = {}
           mapping.each_pair { |name, e|
-            process(properties[name] = {}, e)
-            required << name if e["required"] == true
+            # Handle partial support of mapping default value
+            # Only default rule is supported (see http://www.kuwata-lab.com/kwalify/ruby/users-guide.02.html#tips-default)
+            if name == "="
+              if e.is_a?(Hash)
+                process(target["additionalProperties"] = {}, e, path)
+              else
+                new_issue path, Limitations::ONLY_DEFAULT_RULE_SUPPORTED_FOR_DEFAULT_MAPPING
+              end
+            else
+              process(properties[name] = {}, e, path + [name])
+              required << name if e["required"] == true
+            end
           }
           target["required"] = required unless required.empty?
         end
@@ -87,7 +104,13 @@ module KwalifyToJsonSchema
         target["type"] = "array"
         sequence = kelem["sequence"]
         if sequence.is_a? Array
-          process(target["items"] = {}, sequence.first)
+          rule = sequence.first
+          if rule["unique"]
+            target["uniqueItems"] = true
+            rule = rule.dup
+            rule.delete("unique")
+          end
+          process(target["items"] = {}, rule)
         end
       when "str"
         target["type"] = "string"
@@ -105,13 +128,13 @@ module KwalifyToJsonSchema
         target["type"] = "boolean"
       when "date"
         # TODO
-        new_issue Limitations::DATE_TYPE_NOT_IMPLEMENTED
+        new_issue path, Limitations::DATE_TYPE_NOT_IMPLEMENTED
       when "time"
         # TODO
-        new_issue Limitations::TIME_TYPE_NOT_IMPLEMENTED
+        new_issue path, Limitations::TIME_TYPE_NOT_IMPLEMENTED
       when "timestamp"
         # TODO
-        new_issue Limitations::TIMESTAMP_TYPE_NOT_IMPLEMENTED
+        new_issue path, Limitations::TIMESTAMP_TYPE_NOT_IMPLEMENTED
       when "scalar"
         # Use one of
         target["oneOf"] = [
@@ -123,7 +146,7 @@ module KwalifyToJsonSchema
       when "any"
         # Don't put type
       else
-        new_issue("Unknown Kwalify type #{ktype}")
+        new_issue(path, "Unknown Kwalify type #{ktype}")
       end
 
       target["enum"] = kelem["enum"] if kelem["enum"]
@@ -154,7 +177,7 @@ module KwalifyToJsonSchema
         end
       end
 
-      new_issue Limitations::UNIQUE_NOT_SUPPORTED if kelem["unique"]
+      new_issue path, Limitations::UNIQUE_NOT_SUPPORTED_WITHIN_MAPPING if kelem["unique"]
 
       target
     end
@@ -171,8 +194,8 @@ module KwalifyToJsonSchema
       ep.postprocess(json_schema)
     end
 
-    def new_issue(description)
-      @issues << description
+    def new_issue(path, description)
+      @issues << Issue.new(path, description)
     end
   end
 end

data/lib/kwalify_to_json_schema/issue.rb

@@ -0,0 +1,16 @@
+module KwalifyToJsonSchema
+  # Used to represent issues encoutered while converting
+  class Issue
+    attr_reader :path
+    attr_reader :description
+
+    def initialize(path, description)
+      @path = path
+      @description = description
+    end
+
+    def to_s
+      "Issue #{path.join "/"}: #{description}"
+    end
+  end
+end

data/lib/kwalify_to_json_schema/issues.rb

@@ -0,0 +1,10 @@
+module KwalifyToJsonSchema
+  # Used to hold issues encoutered while converting
+  class Issues < Array
+
+    # Get an array with only one instance of each description
+    def descriptions_uniq
+      map(&:description).uniq
+    end
+  end
+end

data/lib/kwalify_to_json_schema/kwalify_to_json_schema.rb

@@ -10,12 +10,18 @@ module KwalifyToJsonSchema
   # | :id                   | string | nil          | The JSON schema identifier                                                               |
   # | :title                | string | nil          | The JSON schema title                                                                    |
   # | :description          | string | nil          | The JSON schema description. If not given the Kwalify description will be used if present|
-  # | :issues_to_description| boolean| false        | To append the issuses to the JSON schema description                                     |
+  # | :issues_to_description| boolean| false        | To append the issues to the JSON schema description                                      |
+  # | :issues_to_stderr     | boolean| false        | To write the issues to standard error output                                             |
   # | :custom_processing    | object | nil          | To customize the conversion                                                              |
+  # | :schema_version       | string | "draft-04"   | JSON schema version. Changing this value only change the value of $schema field          |
+  # | :verbose              | boolean| false        | To be verbose when converting                                                            |
   # --
   # @param source Path to Kwalify YAML schema
   # @param dest Path to resulting JSON schema
   def self.convert_file(source, dest, options = {})
+    options = Options.new(options)
+    puts "Converting file://#{File.expand_path source } to file://#{File.expand_path dest}" if options.verbose?
+
     # Get a converter
     converter = Converter.new(options)
     # Convert
@@ -33,14 +39,18 @@ module KwalifyToJsonSchema
   # | :id                   | string | nil          | The JSON schema identifier                                                               |
   # | :title                | string | nil          | The JSON schema title                                                                    |
   # | :description          | string | nil          | The JSON schema description. If not given the Kwalify description will be used if present|
-  # | :issues_to_description| boolean| false        | To append the issuses to the JSON schema description                                     |
+  # | :issues_to_description| boolean| false        | To append the issues to the JSON schema description                                      |
+  # | :issues_to_stderr     | boolean| false        | To write the issues to standard error output                                             |
   # | :custom_processing    | object | nil          | To customize the conversion                                                              |
+  # | :schema_version       | string | "draft-04"   | JSON schema version. Changing this value only change the value of $schema field          |
+  # | :verbose              | boolean| false        | To be verbose when converting                                                            |
   # --
   # @param kwalify_schema Kwalify schema as YAML or JSON
   # @param source_format format of the source schema
   # @param dest_format format of the destination schema
   # @param options
   def self.convert_string(kwalify_schema, source_format = "yaml", dest_format = "json", options = {})
+    options = Options.new(options)
     # Get a converter
     converter = Converter.new(options)
     # Convert

data/lib/kwalify_to_json_schema/limitations.rb

@@ -4,6 +4,7 @@ module KwalifyToJsonSchema
     DATE_TYPE_NOT_IMPLEMENTED = "Kwalify 'date' type is not supported and is ignored"
     TIME_TYPE_NOT_IMPLEMENTED = "Kwalify 'time' type is not supported and is ignored"
     TIMESTAMP_TYPE_NOT_IMPLEMENTED = "Kwalify 'timestamp' type is not supported and is ignored"
-    UNIQUE_NOT_SUPPORTED = "Kwalify 'unique' is not supported by JSON Schema and is ignored"
+    UNIQUE_NOT_SUPPORTED_WITHIN_MAPPING = "Kwalify 'unique' within a mapping is not supported by JSON Schema and is ignored"
+    ONLY_DEFAULT_RULE_SUPPORTED_FOR_DEFAULT_MAPPING = "Kwalify mapping default value is not supported by JSON Schema and is ignored. Only default rule is supported"
   end
 end

data/lib/kwalify_to_json_schema/options.rb

@@ -7,22 +7,32 @@ module KwalifyToJsonSchema
     # | :id                   | string | nil          | The JSON schema identifier                                                               |
     # | :title                | string | nil          | The JSON schema title                                                                    |
     # | :description          | string | nil          | The JSON schema description. If not given the Kwalify description will be used if present|
-    # | :issues_to_description| boolean| false        | To append the issuses to the JSON schema description                                     |
+    # | :issues_to_description| boolean| false        | To append the issues to the JSON schema description                                      |
+    # | :issues_to_stderr     | boolean| false        | To write the issues to standard error output                                             |
     # | :custom_processing    | object | nil          | To customize the conversion                                                              |
+    # | :schema_version       | string | "draft-04"   | JSON schema version. Changing this value only change the value of $schema field          |
+    # | :verbose              | boolean| false        | To be verbose when converting                                                            |
     # --
     DECLARATION = %q(
     ID                    # The JSON schema identifier [string] (nil)
     TITLE                 # The JSON schema title [string] (nil)
     DESCRIPTION           # The JSON schema description. If not given the Kwalify description will be used if present [string] (nil)
-    ISSUES_TO_DESCRIPTION # To append the issuses to the JSON schema description [boolean] (false)
+    ISSUES_TO_DESCRIPTION # To append the issues to the JSON schema description [boolean] (false)
+    ISSUES_TO_STDERR      # To write the issues to standard error output [boolean] (false)
     CUSTOM_PROCESSING     # To customize the conversion [object] (nil)
+    SCHEMA_VERSION        # JSON schema version. Changing this value only change the value of $schema field[string] ("draft-04")
+    VERBOSE               # To be verbose when converting [boolean] (false)
     )
 
     # The options as Hash
     attr_reader :options_hash
 
-    def initialize(options_hash)
-      @options_hash = options_hash
+    def initialize(options)
+      @options_hash = options.is_a?(Options) ? options.options_hash : options
+    end
+
+    def to_s
+      YAML.dump("Options" => options_hash)
     end
 
     # Parse options declaration text and give an array of Hash

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: kwalify_to_json_schema
 version: !ruby/object:Gem::Version
-  version: 0.2.1
+  version: 0.6.0
 platform: ruby
 authors:
 - Sylvain Gamot
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2020-06-10 00:00:00.000000000 Z
+date: 2021-04-15 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: thor
@@ -80,7 +80,7 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: 12.3.0
-description: Allows to convert Kwalify schemas to JSON schemas Draft 7
+description: Allows to convert Kwalify schemas to JSON schemas
 email: ''
 executables:
 - kwalify_to_json_schema
@@ -92,6 +92,8 @@ files:
 - lib/kwalify_to_json_schema/cli.rb
 - lib/kwalify_to_json_schema/converter.rb
 - lib/kwalify_to_json_schema/custom_processing.rb
+- lib/kwalify_to_json_schema/issue.rb
+- lib/kwalify_to_json_schema/issues.rb
 - lib/kwalify_to_json_schema/kwalify_to_json_schema.rb
 - lib/kwalify_to_json_schema/limitations.rb
 - lib/kwalify_to_json_schema/options.rb