kwalify_to_json_schema 0.1.3 → 0.5.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 18d110d9d28e8bd0a1231dd65df8f8f52063c8bf01e96069a74d577c717ec886
-  data.tar.gz: 1fd58dd04f1e30d48540f7b55a7f10d75aafd186e75e6ce0b9b6f932ec1f5b6d
+  metadata.gz: e93f6522625fde6b85d8f46a719a0a4ed2cec61ca281511094e32f1f8b8b8941
+  data.tar.gz: 47e10842e281ac6fb393e7c97dfa17ef574cfcc262507cc6e649eeec1d5e39a5
 SHA512:
-  metadata.gz: a5989d6935db5941cb5950e4d8db007fbe1a54bbca5b89e48b27f4e67f3b0747a52d0f95b67ca3c11bb57dcbf07d62a047fff57ef75e7342ffbf5c4652a0d3e2
-  data.tar.gz: 2acbfa4dd347768e076c02629de054b4c9ddfc5adbbb931ad0fdad9354e105f039e24658ffb1781204a55f1b1032412bc497535a00b323ec3f053bed96d3ec0b
+  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

@@ -25,11 +25,14 @@ module KwalifyToJsonSchema
 
     desc "convert KWALIFY_SCHEMA_FILE, RESULT_FILE",
          "Convert a Kwalify schema file to a JSON schema file. The result file extension will decide the format: .json or .yaml"
-    option :issues_to_description,
-           :type => :boolean,
-           :default => false,
-           :desc => "Will append any conversion issue to the schema description"
-    option :custom_processing,
+    option(*Options.cli_option(Options::ID))
+    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
              Allows to provide a pre/post processing file on handled schemas.
@@ -38,10 +41,8 @@ module KwalifyToJsonSchema
            DESC
 
     def convert(kwalify_schema_file, result_file)
-      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)
       KwalifyToJsonSchema.convert_file(kwalify_schema_file, result_file, opts)
     end
 
@@ -49,10 +50,7 @@ module KwalifyToJsonSchema
 
     desc "convert_dir KWALIFY_SCHEMA_DIR, RESULT_DIR",
          "Convert all the Kwalify schema from a directory to a JSON schema"
-    option :issues_to_description,
-           :type => :boolean,
-           :default => false,
-           :desc => "Will append any conversion issue to the schema description"
+    option(*Options.cli_option(:issues_to_description))
     option :format,
            :type => :string,
            :enum => ["json", "yaml"],
@@ -63,7 +61,9 @@ module KwalifyToJsonSchema
            :default => false,
            :desc => "Process files recursively",
            :long_desc => ""
-    option :custom_processing,
+    option(*Options.cli_option(Options::SCHEMA_VERSION))
+    option(*Options.cli_option(Options::VERBOSE))
+    option Options::CUSTOM_PROCESSING,
            :type => :string,
            :desc => <<~DESC
              Allows to provide a pre/post processing file on handled schemas.
@@ -72,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"]}"
@@ -98,7 +96,7 @@ module KwalifyToJsonSchema
         begin
           processing_class = Object.const_get :CustomProcessing
           custom_processing = processing_class.new
-        rescue NameError => e
+        rescue NameError
           raise "The 'CustomProcessing' module must be defined in #{pf}"
         end
       end

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
@@ -19,17 +19,21 @@ module KwalifyToJsonSchema
     attr_reader :issues
 
     # Converter options:
-    # | Name                  | Type   | Default value| Description                                         |
-    # |-----------------------|--------|--------------|-----------------------------------------------------|
-    # | :id                   | String | nil          | The JSON schema identifier                          |
-    # | :title                | String | nil          | The JSON schema title                               |
-    # | :description          | String | nil          | The JSON schema description                         |
-    # | :issues_to_description| Boolean| false        | To append the issuses to the JSON schema description|
-    # | :custom_processing    | Object | nil          | To customize the conversion                         |
+    # | Name                  | Type   | Default value| Description                                                                              |
+    # |-----------------------|--------|--------------|------------------------------------------------------------------------------------------|
+    # | :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_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
@@ -43,9 +47,13 @@ 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
 
@@ -53,21 +61,22 @@ module KwalifyToJsonSchema
 
     def root
       {
-        "$schema" => SCHEMA,
-        "$id" => options.id,
+        "$schema" => SCHEMA % options.schema_version,
+        "id" => options.id,
         "title" => options.title,
-        "description" => options.description,
       }.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
@@ -76,7 +85,12 @@ module KwalifyToJsonSchema
         if mapping.is_a? Hash
           properties = target["properties"] = {}
           mapping.each_pair { |name, e|
-            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?
@@ -103,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"] = [
@@ -152,7 +166,7 @@ module KwalifyToJsonSchema
         end
       end
 
-      new_issue UNIQUE_NOT_SUPPORTED if kelem["unique"]
+      new_issue path, Limitations::UNIQUE_NOT_SUPPORTED if kelem["unique"]
 
       target
     end
@@ -169,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

@@ -5,17 +5,23 @@ module KwalifyToJsonSchema
   # The file extension is used to select the format: .json or .yaml.
   # Other extension will fallback to JSON.
   # Converter options:
-  # | Name                  | Type   | Default value| Description                                         |
-  # |-----------------------|--------|--------------|-----------------------------------------------------|
-  # | :id                   | String | nil          | The JSON schema identifier                          |
-  # | :title                | String | nil          | The JSON schema title                               |
-  # | :description          | String | nil          | The JSON schema description                         |
-  # | :issues_to_description| Boolean| false        | To append the issuses to the JSON schema description|
-  # | :custom_processing    | Object | nil          | To customize the conversion                         |
+  # | Name                  | Type   | Default value| Description                                                                              |
+  # |-----------------------|--------|--------------|------------------------------------------------------------------------------------------|
+  # | :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_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
@@ -28,19 +34,23 @@ module KwalifyToJsonSchema
   # The source and destination strings can be JSON or YAML.
   # Other extension will fallback to JSON.
   # Converter options:
-  # | Name                  | Type   | Default value| Description                                         |
-  # |-----------------------|--------|--------------|-----------------------------------------------------|
-  # | :id                   | String | nil          | The JSON schema identifier                          |
-  # | :title                | String | nil          | The JSON schema title                               |
-  # | :description          | String | nil          | The JSON schema description                         |
-  # | :issues_to_description| Boolean| false        | To append the issuses to the JSON schema description|
-  # | :custom_processing    | Object | nil          | To customize the conversion                         |
+  # | Name                  | Type   | Default value| Description                                                                              |
+  # |-----------------------|--------|--------------|------------------------------------------------------------------------------------------|
+  # | :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_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

@@ -2,27 +2,37 @@ module KwalifyToJsonSchema
   # The possible options for the conversion and the associated accessors
   class Options
     # Converter options:
-    # | Name                  | Type   | Default value| Description                                         |
-    # |-----------------------|--------|--------------|-----------------------------------------------------|
-    # | :id                   | String | nil          | The JSON schema identifier                          |
-    # | :title                | String | nil          | The JSON schema title                               |
-    # | :description          | String | nil          | The JSON schema description                         |
-    # | :issues_to_description| Boolean| false        | To append the issuses to the JSON schema description|
-    # | :custom_processing    | Object | nil          | To customize the conversion                         |
+    # | Name                  | Type   | Default value| Description                                                                              |
+    # |-----------------------|--------|--------------|------------------------------------------------------------------------------------------|
+    # | :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_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 [String] (nil)
-    ISSUES_TO_DESCRIPTION # To append the issuses to the JSON schema description [Boolean] (false)
-    CUSTOM_PROCESSING     # To customize the conversion [Object] (nil)
+    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
@@ -40,13 +50,13 @@ module KwalifyToJsonSchema
         default_value = eval(default_value)
 
         # Create read accessor
-        attr_reader_name = "#{name}#{type == "Boolean" ? "?" : ""}"
+        attr_reader_name = "#{name}#{type == "boolean" ? "?" : ""}"
 
         # Array entry as Hash for the option
         {
           const_name: const_name,
           const_name_full: "#{Options.name}::#{const_name}",
-          name: name,
+          name: name.to_sym,
           description: description,
           type: type,
           default_value: default_value,
@@ -55,6 +65,11 @@ module KwalifyToJsonSchema
       }.compact
     end
 
+    # Same as :parse but give a Hash with the name as key
+    def self.parse_hash
+      parse.map { |e| [e[:name], e] }.to_h
+    end
+
     # Setup the constants and methods for the options
     # Example: ID will lead to get ID constant and :id method
     def self.setup
@@ -69,6 +84,12 @@ module KwalifyToJsonSchema
       }
     end
 
+    # Get description for option name
+    def self.cli_option(name)
+      o = parse_hash[name]
+      [o[:name], :type => o[:type].to_sym, :default => o[:default_value], :desc => o[:description]]
+    end
+
     setup
   end
 end

data/lib/kwalify_to_json_schema/serialization.rb

@@ -25,7 +25,7 @@ module KwalifyToJsonSchema
 
     # @return a Hash giving serialization/deserialization module and methods for a format (json/yaml)
     def self.serialization_for_format(format)
-      serializer = { "json" => Json, "yaml" => Yaml }[format] || Json
+      { "json" => Json, "yaml" => Yaml }[format] || Json
     end
 
     class Language

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: kwalify_to_json_schema
 version: !ruby/object:Gem::Version
-  version: 0.1.3
+  version: 0.5.0
 platform: ruby
 authors:
 - Sylvain Gamot
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2020-06-10 00:00:00.000000000 Z
+date: 2020-06-16 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