openapi-sourcetools 0.12.0 → 0.13

data/bin/openapi-schema-ls

@@ -0,0 +1,100 @@
+#!/usr/bin/env ruby
+# frozen_string_literal: true
+
+# Copyright © 2026 Ismo Kärkkäinen
+# Licensed under Universal Permissive License. See LICENSE.txt.
+
+require_relative '../lib/openapi/sourcetools/common'
+require_relative '../lib/openapi/sourcetools/schemaio'
+require 'optparse'
+require 'yaml'
+require 'json'
+include OpenAPISourceTools
+
+
+# Functions related to saving the document path dump.
+
+def to_json(doc)
+  JSON.dump(doc)
+end
+
+def to_pretty_json(doc)
+  JSON.pretty_generate(doc)
+end
+
+def to_yaml(doc)
+  YAML.dump(doc)
+end
+
+def main
+  input_file = nil
+  output_file = nil
+  doc_paths = :openapi
+  output_default = nil
+  format = 'pretty_json'
+  formats = {
+    'yaml' => method(:to_yaml),
+    'json' => method(:to_json),
+    'pretty_json' => method(:to_pretty_json)
+  }
+
+  parser = OptionParser.new do |opts|
+    opts.summary_indent = '  '
+    opts.summary_width = 22
+    opts.banner = 'Usage: openapi-schema-ls [options]'
+    opts.separator ''
+    opts.separator 'Options:'
+    opts.on('-i', '--input FILE', 'Read input from FILE, not stdin.') do |f|
+      input_file = f
+    end
+    opts.on('-o', '--output FILE', 'Write result to FILE, not stdout.') do |f|
+      output_file = f
+    end
+    opts.on('--inputpaths DATA', 'Input path data.') do |data|
+      doc_paths = data
+    end
+    opts.on('--dump DATA', 'Dump internal path data to output and exit.') do |data|
+      output_default = data
+    end
+    opts.on('-f', '--format FORMAT', "DATA output format: #{formats.keys.sort!.join(', ')}.") do |fmt|
+      format = fmt
+    end
+    opts.on('-h', '--help', 'Print this help and exit.') do
+      $stdout.puts <<EOF
+#{opts}
+Lists named schemas in the input document.
+
+The document paths DATA is either a file name, internal data name, or a
+JSON-encoded object with necessary keys. Same data also applies to both
+openapi-schema-in and openapi-schema-out. Internal data names are:
+#{SchemaIO::BUILTINS.keys.sort!.join(', ')}
+
+DATA defaults to OpenAPI format.
+EOF
+      return 0
+    end
+  end
+  parser.order!
+
+  return Common.aargh("Unknown format: #{format}", 1) unless formats.key?(format)
+
+  unless output_default.nil?
+    doc = SchemaIO.get(output_default)
+    return Commpon.aargh("Not internal data format: #{output_default}", 1) if doc.nil?
+    out = (format == 'yaml') ? doc : formats[format].call(YAML.safe_load(doc))
+    return Common.dump_result(output_file, out, 3)
+  end
+
+  dp = SchemaIO.key_data(doc_paths)
+  return Common.aargh("Not file or internal format name or format as JSON object: #{doc_paths}", 2) if dp.nil?
+
+  doc = Common.load_source(input_file)
+  return 2 if doc.nil?
+
+  src = SchemaIO::SchemaAccess.new(dp, doc)
+  out = src.list_schema_names.join("\n")
+
+  Common.dump_result(output_file, out, 3)
+end
+
+exit(main) if File.basename(__FILE__) == File.basename($PROGRAM_NAME)

data/bin/openapi-schema-out

@@ -0,0 +1,144 @@
+#!/usr/bin/env ruby
+# frozen_string_literal: true
+
+# Copyright © 2026 Ismo Kärkkäinen
+# Licensed under Universal Permissive License. See LICENSE.txt.
+
+require_relative '../lib/openapi/sourcetools/common'
+require_relative '../lib/openapi/sourcetools/schemaio'
+require 'optparse'
+require 'yaml'
+require 'json'
+include OpenAPISourceTools
+
+
+# Functions related to saving the output.
+
+def to_json(doc, _line_width)
+  JSON.dump(doc)
+end
+
+def to_pretty_json(doc, _line_width)
+  JSON.pretty_generate(doc)
+end
+
+def to_yaml(doc, line_width)
+  YAML.dump(doc, line_width: line_width)
+end
+
+def main
+  input_file = nil
+  output_file = nil
+  name = nil
+  refs = true
+  format = 'pretty_json'
+  formats = {
+    'yaml' => method(:to_yaml),
+    'json' => method(:to_json),
+    'pretty_json' => method(:to_pretty_json)
+  }
+  line_width = 80
+  doc_paths = :openapi
+  schema_paths = :jsonschema
+  additions = {}
+
+  parser = OptionParser.new do |opts|
+    opts.summary_indent = '  '
+    opts.summary_width = 27
+    opts.banner = 'Usage: openapi-schema-out [options]'
+    opts.separator ''
+    opts.separator 'Options:'
+    opts.on('-i', '--input FILE', 'Read input from FILE, not stdin.') do |f|
+      input_file = f
+    end
+    opts.on('-o', '--output FILE', 'Write result to FILE, not stdout.') do |f|
+      output_file = f
+    end
+    opts.on('-n', '--name NAME', 'Use schema NAME.') do |n|
+      name = n
+    end
+    opts.on('--[no-]refs', "Include referred schemas (default #{Common.yesno(refs)}).") do |r|
+      refs = r
+    end
+    opts.on('-f', '--format FORMAT', "Schema output format: #{formats.keys.sort!.join(', ')}.") do |fmt|
+      format = fmt
+    end
+    opts.on('-w', '--width WIDTH', "Set YAML line width, default: #{line_width}") do |w|
+      line_width = w.to_i
+    end
+    opts.on('--inputpaths DATA', 'Input path data.') do |data|
+      doc_paths = data
+    end
+    opts.on('--schemapaths DATA', 'Schema path data.') do |data|
+      schema_paths = data
+    end
+    opts.on('-a', '--add KEY:[json:]VALUE', 'Add KEY with (JSON) VALUE to output schema.') do |kv|
+      k, v = kv.split(':', 2)
+      return Common.aargh("Invalid key-value pair: #{kv}", 1) if k.nil? || v.nil?
+      return Common.aargh("Empty key: #{kv}", 1) if k.empty?
+      v = JSON.parse(v[5..]) if v.downcase.start_with?('json:')
+      additions[k] = v
+    rescue JSON::ParserError
+      return Common.aargh("Invalid JSON in argument value: #{kv}", 1)
+    end
+    opts.on('-h', '--help', 'Print this help and exit.') do
+      $stdout.puts <<EOF
+#{opts}
+Takes schema with name from input and places it into output.
+
+The document and schema paths DATA is either a file name, internal data name,
+or a JSON-encoded object with necessary keys. Internal data names are:
+#{SchemaIO::BUILTINS.keys.sort!.join(', ')}
+
+Depending on input, schema NAME is used to find and store the schema in the
+location indicated by DATA for output.
+
+DATA values default to input being OpenAPI format and output is JSON schema
+with schema at root and referenced schemas, if output, under "$defs" key.
+
+Adding KEY:VALUE pairs can be used to add keys to the output schema with
+string values. Using KEY:json:VALUE will parse VALUE as JSON and use that.
+The format indicator is case-insensitive. Value can be empty but key cannot
+be empty. Pass value starting with "json:" as 'key:json:"json:the_rest"'.
+Usable for adding "$schema" and "$id" keys to the output schema.
+EOF
+      return 0
+    end
+  end
+  parser.order!
+
+  return Common.aargh('Schema name must be given.', 1) if name.nil?
+
+  return Common.aargh("Unknown format: #{format}", 1) unless formats.key?(format)
+
+  dp = SchemaIO.key_data(doc_paths)
+  return Common.aargh("Not file or internal format name or format as JSON object: #{doc_paths}", 2) if dp.nil?
+  sp = SchemaIO.key_data(schema_paths)
+  return Common.aargh("Not file or internal format name or format as JSON object: #{schema_paths}", 2) if sp.nil?
+
+  return Common.aargh(%(Name "#{name}" has document path separator "#{dp.separator}"), 1) if name.include?(dp.separator)
+  return Common.aargh(%(Name "#{name}" has schema path separator "#{sp.separator}"), 1) if name.include?(sp.separator)
+
+  doc = Common.load_source(input_file)
+  return 2 if doc.nil?
+  return Common.aargh('Document is not an object.', 2) unless doc.is_a?(Hash)
+
+  src = SchemaIO::SchemaAccess.new(dp, doc)
+  tgt = SchemaIO::SchemaAccess.new(sp, {})
+
+  desired = src.find_named_schema(name)
+  return Common.aargh("Schema not found: #{name}", 1) if desired.nil?
+  desired.merge!(additions) unless additions.empty?
+  tgt.put_named_schema(name, desired)
+
+  if refs
+    refd = src.find_referenced_schemas(name, desired)
+    refd.each { |n, s| tgt.put_referenced_schema(n, s) }
+  end
+  SchemaIO.alter_refs(tgt.document, src, tgt) # After referenced schemas have been found.
+
+  out = formats[format].call(tgt.document, line_width)
+  Common.dump_result(output_file, out, 3)
+end
+
+exit(main) if File.basename(__FILE__) == File.basename($PROGRAM_NAME)

data/lib/openapi/sourcetools/apiobjects.rb

@@ -1,12 +1,23 @@
 # frozen_string_literal: true
 
-# Copyright © 2024-2025 Ismo Kärkkäinen
+# Copyright © 2024-2026 Ismo Kärkkäinen
 # Licensed under Universal Permissive License. See LICENSE.txt.
 
 module OpenAPISourceTools
+  # Various schema-related constants.
+  module Schemas
+    ARRAY_VALUED = %w[allOf anyOf oneOf prefixItems].freeze
+    OTHER_VALUED = %w[items additionalProperties unevaluatedItems unevaluatedProperties if then else not].freeze
+    KEY2SCHEMA = %w[properties patternProperties dependentSchemas].freeze
+    HANDLED = [].concat(ARRAY_VALUED, OTHER_VALUED, KEY2SCHEMA).freeze
+    IGNORED = %w[example examples].freeze
+  end
+
   # Various classes for handling objects in the API specification.
   # Used in various programs.
   module ApiObjects
+    LOGIC_KEYS = Set.new(%w[allOf anyOf oneOf not if then else dependentSchemas]).freeze
+    DOCUMENT_KEYS = %w[example examples title summary description deprecated readOnly writeOnly].freeze
 
     def self.same(a, b, ignored_keys = Set.new(%w[summary description]))
       return a == b unless a.is_a?(Hash) && b.is_a?(Hash)
@@ -89,7 +100,7 @@ module OpenAPISourceTools
               next if value.key?('$ref')
               @components.to_reference_object(value)
             end
-          else
+          elsif !Schemas::IGNORED.include?(key)
             replace(value)
           end
         end
@@ -114,6 +125,7 @@ module OpenAPISourceTools
         obj.each do |key, value|
           if key == @key && value.is_a?(Hash)
             value.keys.sort!.each do |sub_key|
+              next if Schemas::IGNORED.include?(sub_key)
               sub_value = value[sub_key]
               next unless sub_value.is_a?(Hash)
               next if sub_value.key?('$ref')
@@ -173,7 +185,7 @@ module OpenAPISourceTools
         @items.each do |k, v|
           return ref_string(k) if ApiObjects.same(obj, v, @ignored_keys)
         end
-        # One of the numbers will not match existing keys. More number than keys.
+        # One of the numbers will not match existing keys. More numbers than keys.
         (@items.size + 1).times do |n|
           # 'x' is to simplify find and replace (Schema1x vs Schema1 and Schema10)
           cand = "#{@prefix}#{n}x"
@@ -240,17 +252,11 @@ module OpenAPISourceTools
           pk = @parts[k]
           ppk = pp[k]
           if pk.key?('fixed')
-            if ppk.key?('fixed')
-              c = pk['fixed'] <=> ppk['fixed']
-            else
-              return -1
-            end
+            return -1 unless ppk.key?('fixed')
+            c = pk['fixed'] <=> ppk['fixed']
           else
-            if ppk.key?('fixed')
-              return 1
-            else
-              c = pk.fetch('parameter', '') <=> ppk.fetch('parameter', '')
-            end
+            return 1 if ppk.key?('fixed')
+            c = pk.fetch('parameter', '') <=> ppk.fetch('parameter', '')
           end
           return c unless c.zero?
         end

data/lib/openapi/sourcetools/common.rb

@@ -10,7 +10,7 @@ module OpenAPISourceTools
   # Common methods used in programs and elsewhere gathered into one place.
   module Common
     def self.aargh(message, return_value = nil)
-      message = message.map(&:to_s).join("\n") if message.is_a? Array
+      message = message.join("\n") if message.is_a? Array
       $stderr.puts message
       return_value
     end

data/lib/openapi/sourcetools/config.rb

@@ -8,11 +8,11 @@ require_relative 'gen'
 require 'find'
 require 'yaml'
 
+# Gem namespace.
 module OpenAPISourceTools
   # Configuration file find and load convenience functions.
   # See the first 3 methods. The rest are intended to be internal helpers.
   module ConfigLoader
-
     # A function to find all files with a given prefix.
     # Prefix is taken from Gen.config if nil.
     # Returns an array of ConfigFileInfo objects.
@@ -43,9 +43,10 @@ module OpenAPISourceTools
 
     # Maps an array of ConfigFileInfo objects to an array of their contents.
     def self.contents_array(config_file_infos)
-      config_file_infos.map(&:content).reject(&:nil?)
+      config_file_infos.map(&:content).compact
     end
 
+    # The result with data about the config file.
     class ConfigFileInfo
       include Comparable
 

data/lib/openapi/sourcetools/generate.rb

@@ -10,6 +10,7 @@ require_relative 'loaders'
 require_relative 'gen'
 
 
+# Gem namespace.
 module OpenAPISourceTools
   def self.executable_bits_on(mode)
     mode = mode.to_s(8).chars

data/lib/openapi/sourcetools/loaders.rb

@@ -82,7 +82,7 @@ module OpenAPISourceTools
       d = name.downcase
       if d.start_with?(YAML_PREFIX)
         name = name.slice(YAML_PREFIX.size...name.size)
-      elsif (YAML_EXTS.index { |s| d.end_with?(s) }).nil?
+      elsif YAML_EXTS.index { |s| d.end_with?(s) }.nil?
         return false
       end
       n, _sep, f = name.partition(':')
@@ -140,9 +140,9 @@ module OpenAPISourceTools
         method(:req_loader),
         method(:eval_loader),
         method(:ruby_loader),
+        method(:config_loader),
         method(:yaml_loader),
         method(:bin_loader),
-        method(:config_loader),
         method(:separator_loader)
       ]
     end
@@ -153,7 +153,7 @@ module OpenAPISourceTools
 - #{Loaders::EVAL_PREFIX}code : runs code to add gem tasks again.
 - ruby_file#{Loaders::RUBY_EXT} : changes to Ruby file directory and requires the file.
 - #{Loaders::YAML_PREFIX}name:filename : Loads YAML file into Gen.d.name.
-- name:filename.{#{(Loaders::YAML_EXTS.map { |s| s[1...s.size] }).join('|')}} : Loads YAML file into Gen.d.name.
+- name:filename.{#{Loaders::YAML_EXTS.map { |s| s[1...s.size] }.join('|')}} : Loads YAML file into Gen.d.name.
 - #{Loaders::BIN_PREFIX}name:filename : Loads binary file into Gen.d.name.
 - #{Loaders::CONFIG_PREFIX}name : Sets Gen.config for next gem/Ruby file configuration loading.
 - #{Loaders::SEPARATOR_PREFIX}string : Sets Gen.separator to string.

data/lib/openapi/sourcetools/order.rb

@@ -10,7 +10,7 @@ module OpenAPISourceTools
     # Used as replacement for '*'.
     ANY = Regexp.new('^.*$')
 
-    def self.array_item_compare(a, b)
+    def self.array_item_compare(a, b, patterns)
       a[:values].size.times do |k|
         av = a[:values][k]
         bv = b[:values][k]
@@ -18,8 +18,14 @@ module OpenAPISourceTools
           return 1 unless bv.nil?
         else
           return -1 if bv.nil?
-          r = av <=> bv
-          return r unless r.nil? || r.zero?
+          if (av.is_a?(TrueClass) || av.is_a?(FalseClass)) && (bv.is_a?(TrueClass) || bv.is_a?(FalseClass))
+            r = (av ? 1 : 0) <=> (bv ? 1 : 0)
+          else
+            r = av <=> bv
+          end
+          next if r.nil? || r.zero?
+          r = -r unless patterns[k].ascending
+          return r
         end
       end
       0
@@ -129,18 +135,23 @@ module OpenAPISourceTools
         # Hence items.size, and the more multiple, the earlier.
         d = @items.size <=> other.items.size
         return d unless d.zero?
-        -@items.count(:multi) <=> -other.items.count(:multi)
+        d = -@items.count(:multi) <=> -other.items.count(:multi)
+        return d unless d.zero?
+        # Questionable if I should compare to the object_id or equality.
+        # Now if you use same regular expression, they are the same.
+        -@items.count(ANY) <=> -other.items.count(ANY)
       end
     end
 
     # Book-keeping class for pattern and its location.
     class KeyPattern
-      attr_reader :pattern, :index, :priority
+      attr_reader :pattern, :index, :priority, :ascending
 
-      def initialize(pattern, index, priority)
+      def initialize(pattern, index, priority, sort_operator)
         @pattern = pattern
         @index = index
         @priority = priority
+        @ascending = sort_operator == '<'
       end
 
       def match?(string)
@@ -160,22 +171,34 @@ module OpenAPISourceTools
         false
       end
 
+      def self.ordervalue(item)
+        return [ item, '<' ] if item.is_a?(String)
+        return nil unless item.is_a?(Hash)
+        return nil unless item.size == 1
+        key = item.keys.first
+        return nil unless key.is_a?(String)
+        return nil unless ['<', '>'].include?(item[key])
+        [ key, item[key] ]
+      end
+
       attr_reader :patterns
 
       def initialize(keys, regexp_prefix)
         @patterns = []
         has_asterisk = false
-        keys.each_with_index do |string, idx|
+        keys.each_with_index do |ov, idx|
+          string = ov.first
+          sort_operator = ov.last
           if string.start_with?(regexp_prefix)
-            @patterns.push(KeyPattern.new(Regexp.new(string[regexp_prefix.size..]), idx, idx))
+            @patterns.push(KeyPattern.new(Regexp.new(string[regexp_prefix.size..]), idx, idx, sort_operator))
           elsif string == '*'
-            @patterns.push(KeyPattern.new(Regexp.new('^.*$'), idx, keys.size)) unless has_asterisk # First used.
+            @patterns.push(KeyPattern.new(Regexp.new('^.*$'), idx, keys.size, sort_operator)) unless has_asterisk # First used.
             has_asterisk = true
           else
-            @patterns.push(KeyPattern.new(Regexp.new("^#{Regexp.escape(string)}$"), idx, idx))
+            @patterns.push(KeyPattern.new(Regexp.new("^#{Regexp.escape(string)}$"), idx, idx, sort_operator))
           end
         end
-        @patterns.push(KeyPattern.new(Regexp.new('^.*$'), @patterns.size, keys.size + 1)) unless has_asterisk
+        @patterns.push(KeyPattern.new(Regexp.new('^.*$'), @patterns.size, keys.size + 1, '<')) unless has_asterisk
       end
 
       def apply_array(array)
@@ -207,13 +230,13 @@ module OpenAPISourceTools
           end
           values.push(amended)
         end
-        values.sort! { |a, b| OpenAPISourceTools::Ordering.array_item_compare(a, b) }
+        values.sort! { |a, b| OpenAPISourceTools::Ordering.array_item_compare(a, b, @patterns) }
         values.each_with_index { |amended, i| array[i] = amended[:item] }
         true
       end
 
-      def apply_hash(hash)
-        return true if hash.size < 2
+      def apply_hash(unordered_hash)
+        return true if unordered_hash.size < 2
         groups = @patterns.map do |kp|
           {
             kp: kp,
@@ -221,7 +244,7 @@ module OpenAPISourceTools
           }
         end
         s2orig = {}
-        hash.each_key do |key|
+        unordered_hash.each_key do |key|
           skey = key.is_a?(String) ? key : key.to_s
           s2orig[skey] = key
           best_priority = groups.size + 1
@@ -238,10 +261,11 @@ module OpenAPISourceTools
         ordered = {}
         groups.each do |group|
           group[:keys].sort!
-          group[:keys].each { |k| ordered[s2orig[k]] = hash[s2orig[k]] }
+          group[:keys].reverse! unless group[:kp].ascending
+          group[:keys].each { |k| ordered[s2orig[k]] = unordered_hash[s2orig[k]] }
         end
-        hash.clear
-        hash.merge!(ordered)
+        unordered_hash.clear
+        unordered_hash.merge!(ordered)
         true
       end