kwalify_to_json_schema 0.4.0 → 0.5.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: '06494f442be72dab717741fd0515c09e57541add4d42fd0740fd6ec475d18e08'
-  data.tar.gz: 0e3969aae90bda694a8beae488ecabfce80ee15ec381eca3f050456a1b7d4d45
+  metadata.gz: e93f6522625fde6b85d8f46a719a0a4ed2cec61ca281511094e32f1f8b8b8941
+  data.tar.gz: 47e10842e281ac6fb393e7c97dfa17ef574cfcc262507cc6e649eeec1d5e39a5
 SHA512:
-  metadata.gz: b5f7763ebef99718db807a839965f2118be48abe005616147a2a3c038adeb37a82564448faf52e35e6d782ce0666fad36902ed1e3832be8f7c67a7150471dc09
-  data.tar.gz: 5f690c9b95207db9329056ecaf74896beca736c634bf67659e16220613fa6cd5368dcc8160bd2b739262acc78026d09aed406853c025d0789509c2f4a6a95d4d
+  metadata.gz: 46e85a186ef82f070f7d370f7ac33cc3c8ab68a866cb3fd342650b4d3d42c7dcce3d42072cfd9597e8accddbd979fa50421066842693fff6e735cb325773f0cd
+  data.tar.gz: '0799db65393f0084351df69fd34ceef0c3382d8a82ec3ef710c8b1ef041187bf9dd44201ac4ca25abace773ee07a0610048971d4f8b23b190db5fea8002ed87d'

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,7 +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
@@ -60,6 +62,7 @@ module KwalifyToJsonSchema
            :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
@@ -69,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

@@ -25,12 +25,15 @@ module KwalifyToJsonSchema
     # | :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_stderr     | boolean| false        | To write the issuses 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
@@ -44,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
@@ -65,12 +69,14 @@ module KwalifyToJsonSchema
 
     # @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
@@ -79,8 +85,12 @@ module KwalifyToJsonSchema
         if mapping.is_a? Hash
           properties = target["properties"] = {}
           mapping.each_pair { |name, e|
-            next if name == "=" # Ignore mapping default value
-            process(properties[name] = {}, e)
+            # Ignore mapping default value
+            if name == "="
+              new_issue path, Limitations::MAPPING_DEFAULT_VALUE_NOT_SUPPORTED
+              next
+            end
+            process(properties[name] = {}, e, path + [name])
             required << name if e["required"] == true
           }
           target["required"] = required unless required.empty?
@@ -107,13 +117,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"] = [
@@ -156,7 +166,7 @@ module KwalifyToJsonSchema
         end
       end
 
-      new_issue Limitations::UNIQUE_NOT_SUPPORTED if kelem["unique"]
+      new_issue path, Limitations::UNIQUE_NOT_SUPPORTED if kelem["unique"]
 
       target
     end
@@ -173,8 +183,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

@@ -11,12 +11,17 @@ module KwalifyToJsonSchema
   # | :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_stderr     | boolean| false        | To write the issuses 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
@@ -35,14 +40,17 @@ module KwalifyToJsonSchema
   # | :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_stderr     | boolean| false        | To write the issuses 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

@@ -5,5 +5,6 @@ module KwalifyToJsonSchema
     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"
+    MAPPING_DEFAULT_VALUE_NOT_SUPPORTED = "Kwalify mapping default value is not supported by JSON Schema and is ignored"
   end
 end

data/lib/kwalify_to_json_schema/options.rb

@@ -8,23 +8,31 @@ module KwalifyToJsonSchema
     # | :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_stderr     | boolean| false        | To write the issuses 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_STDERR      # To write the issuses 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.4.0
+  version: 0.5.0
 platform: ruby
 authors:
 - Sylvain Gamot
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2020-06-15 00:00:00.000000000 Z
+date: 2020-06-16 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: thor
@@ -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