openapi-sourcetools 0.10.1 → 0.12.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: b692fd4b41d1d925fc0a51d94faabe7ee1f5ec8ff26c7ee393e37cafd9b9dffe
-  data.tar.gz: 19df615a73ec7f006fffd49f1474fb188dbe0f616c49739f0b28c692f7035ec5
+  metadata.gz: 830a477c8647ad883e5a6619767f19cfae7c2d9b9baa100b0e10bdd911ef0fc1
+  data.tar.gz: 9e4a89d44c344c0099f826bf08c459b2eaa448e4d8b76b982e7ee8b7146199b2
 SHA512:
-  metadata.gz: d52cdb9cbdea83bbb3ff510c0b73f61d47eb13049b74e452f90eb597d5a3f697dd414b8f4ca6dd7215d8ea9ac3fd397864c8589365e2a295aa575f2cb3d18c7e
-  data.tar.gz: 26b623377edc1c7cbf58721d1bc3a6a649d2bd79098c5b30502f7810678a09f27c6f401452f96020f4ddc8ff2a5546fce40c2904b63ad968421e7563730182ee
+  metadata.gz: eef01e1c3095d747213533d8ceeb4d0ba4107970b6541632b92b9ffaa0a0202d583ec6934f2af4af3dbf0dff4d0344e053bbf9201d8128cd474406fe11a8b308
+  data.tar.gz: 92fcbc4c9128e213ee4d67d7eebe69c5de9f5ef2576a0efdeae33b2f512a786d586e0eebe903fc932b43f59475ecbd780d925263adbd9f5039b113292db8ae97

data/LICENSE.txt

@@ -1,4 +1,4 @@
-Copyright (c) 2021-2024 Ismo Kärkkäinen
+Copyright (c) 2021-2026 Ismo Kärkkäinen
 
 The Universal Permissive License (UPL), Version 1.0
 

data/bin/openapi-addheaders

@@ -8,30 +8,14 @@ require_relative '../lib/openapi/sourcetools/apiobjects'
 require_relative '../lib/openapi/sourcetools/common'
 require 'optparse'
 require 'yaml'
-include OpenAPISourceTools
 
 
-def replace_headers(obj, components)
-  return unless obj.is_a?(Hash)
-  obj.each do |k, v|
-    if k == 'headers'
-      v.keys.sort!.each do |name|
-        r = v[name]
-        next unless r.is_a?(Hash) # Could complain.
-        next if r.key?('$ref')
-        v[name] = { '$ref' => components.reference(r) }
-      end
-    else
-      replace_headers(v, components)
-    end
-  end
-end
-
 def main
   input_name = nil
   output_name = nil
   path = %w[components headers]
-  components = ApiObjects::Components.new(path, 'Header')
+  components = OpenAPISourceTools::ApiObjects::Components.new(path, 'Header')
+  replacer = OpenAPISourceTools::ApiObjects::ValueSubValueReplacer.new('headers', components)
 
   parser = OptionParser.new do |opts|
     opts.summary_indent = '  '
@@ -59,15 +43,15 @@ replaces the original with reference.
   end
   parser.order!
 
-  doc = Common.load_source(input_name)
+  doc = OpenAPISourceTools::Common.load_source(input_name)
   return 2 if doc.nil?
 
   components.items = doc.dig(*path) || {}
-  replace_headers(doc.dig('components', 'responses') || {}, components)
-  replace_headers(doc.fetch('paths', {}), components)
-  Common.bury(doc, path, components.items) unless components.items.empty?
+  replacer.replace(doc.dig('components', 'responses') || {})
+  replacer.replace(doc.fetch('paths', {}))
+  OpenAPISourceTools::Common.bury(doc, path, components.items) unless components.items.empty?
 
-  Common.dump_result(output_name, doc, 3)
+  OpenAPISourceTools::Common.dump_result(output_name, doc, 3)
 end
 
 exit(main) if File.basename(__FILE__) == File.basename($PROGRAM_NAME)

data/bin/openapi-addparameters

@@ -7,12 +7,12 @@
 require_relative '../lib/openapi/sourcetools/apiobjects'
 require_relative '../lib/openapi/sourcetools/common'
 require 'optparse'
-include OpenAPISourceTools
+
 
 def replace_parameter(p, components)
   return p unless p.is_a?(Hash) # Could complain.
   return p if p.key?('$ref')
-  { '$ref' => components.reference(p) }
+  components.to_reference_object(p)
 end
 
 def replace_parameters(obj, components)
@@ -46,7 +46,7 @@ def add_operations_parameters(paths, referenced)
   # Below that are operations objects.
   paths.each_value do |item|
     top_nameloc2ref = nameloc2ref(item['parameters'] || [], referenced)
-    oos = ApiObjects.operation_objects(item)
+    oos = OpenAPISourceTools::ApiObjects.operation_objects(item)
     oos.each_value do |operation|
       nl2r = nameloc2ref(operation['parameters'] || [], referenced)
       params = top_nameloc2ref.merge(nl2r)
@@ -61,7 +61,7 @@ def main
   output_name = nil
   add2operations = false
   path = %w[components parameters]
-  components = ApiObjects::Components.new(path, 'Parameter')
+  components = OpenAPISourceTools::ApiObjects::Components.new(path, 'Parameter')
 
   parser = OptionParser.new do |opts|
     opts.summary_indent = '  '
@@ -97,17 +97,17 @@ feature is intended to simplify code generation.
   end
   parser.order!
 
-  doc = Common.load_source(input_name)
+  doc = OpenAPISourceTools::Common.load_source(input_name)
   return 2 if doc.nil?
 
   components.items = doc.dig(*path) || {}
   replace_parameters(doc.fetch('paths', {}), components)
-  Common.bury(doc, path, components.items) unless components.items.empty?
+  OpenAPISourceTools::Common.bury(doc, path, components.items) unless components.items.empty?
   # If nothing has parameters, this adds empty arrays.
   # Consistency might be desired for code generation templates.
   add_operations_parameters(doc.fetch('paths', {}), components.items) if add2operations
 
-  Common.dump_result(output_name, doc, 3)
+  OpenAPISourceTools::Common.dump_result(output_name, doc, 3)
 end
 
 exit(main) if File.basename(__FILE__) == File.basename($PROGRAM_NAME)

data/bin/openapi-addresponses

@@ -7,30 +7,14 @@
 require_relative '../lib/openapi/sourcetools/apiobjects'
 require_relative '../lib/openapi/sourcetools/common'
 require 'optparse'
-include OpenAPISourceTools
 
 
-def replace_responses(obj, components)
-  return unless obj.is_a?(Hash)
-  obj.each do |k, v|
-    if k == 'responses'
-      v.keys.sort!.each do |code|
-        r = v[code]
-        next unless r.is_a?(Hash) # Could complain.
-        next if r.key?('$ref')
-        v[code] = { '$ref' => components.reference(r) }
-      end
-    else
-      replace_responses(v, components)
-    end
-  end
-end
-
 def main
   input_name = nil
   output_name = nil
   path = %w[components responses]
-  components = ApiObjects::Components.new(path, 'Response')
+  components = OpenAPISourceTools::ApiObjects::Components.new(path, 'Response')
+  replacer = OpenAPISourceTools::ApiObjects::ValueSubValueReplacer.new('responses', components)
 
   parser = OptionParser.new do |opts|
     opts.summary_indent = '  '
@@ -58,14 +42,14 @@ replaces the original with reference.
   end
   parser.order!
 
-  doc = Common.load_source(input_name)
+  doc = OpenAPISourceTools::Common.load_source(input_name)
   return 2 if doc.nil?
 
   components.items = doc.dig(*path) || {}
-  replace_responses(doc.fetch('paths', {}), components)
-  Common.bury(doc, path, components.items) unless components.items.empty?
+  replacer.replace(doc.fetch('paths', {}))
+  OpenAPISourceTools::Common.bury(doc, path, components.items) unless components.items.empty?
 
-  Common.dump_result(output_name, doc, 3)
+  OpenAPISourceTools::Common.dump_result(output_name, doc, 3)
 end
 
 exit(main) if File.basename(__FILE__) == File.basename($PROGRAM_NAME)

data/bin/openapi-addschemas

@@ -7,7 +7,6 @@
 require_relative '../lib/openapi/sourcetools/apiobjects'
 require_relative '../lib/openapi/sourcetools/common'
 require 'optparse'
-include OpenAPISourceTools
 
 
 def remove_subitem(obj, path)
@@ -27,38 +26,45 @@ def replace_inlines(obj, components, top_level_name = nil)
   return true unless obj.is_a?(Hash)
   if obj.key?('$ref')
     components.store_anchor(obj)
-    # Here would be the place to get rid of other keys if so desired.
     return true
   end
   # Is inlined, process parts recursively.
-  items = obj['allOf']
-  items = obj['anyOf'] if items.nil?
-  items = obj['oneOf'] if items.nil?
-  # All above need special treatment in code generation templates.
-  return replace_inlines(items, components) unless items.nil?
-  t = obj['type']
-  if t.nil? # Some kind of intermediate-level object.
+  %w[allOf anyOf oneOf items prefixItems additionalProperties unevaluatedItems
+    unevaluatedProperties if then else not
+  ].each do |prop_name|
+    return false unless replace_inlines(obj[prop_name], components)
+  end
+  %w[properties patternProperties dependentSchemas].each do |prop_name|
+    props = obj[prop_name]
+    next if props.nil?
+    props.keys.sort!.each do |name|
+      return false unless replace_inlines(props[name], components)
+    end
+  end
+  looks_like_type = false
+  # required is omitted since it is in schema and in parameters.
+  %w[type items prefixItems properties patternProperties additionalProperties
+    unevaluatedItems unevaluatedProperties enum const minimum maximum multipleOf
+    exclusiveMinimum exclusiveMaximum maxLength minLength pattern maxItems minItems
+    uniqueItems maxContains minContains maxProperties minProperties propertyNames
+    dependentRequired format contentEncoding contentMediaType contentSchema
+  ].each do |kw|
+    if obj.key?(kw)
+      looks_like_type = true
+      break
+    end
+  end
+  unless looks_like_type
+    # Some kind of intermediate-level object.
     (obj.keys.sort! { |a, b| a.to_s <=> b.to_s }).each do |key|
       next if key == 'securitySchemes'
       return false unless replace_inlines(obj[key], components)
     end
     return true
   end
-  case t
-  when 'array'
-    return false unless replace_inlines(obj['items'], components)
-  when 'object'
-    %w[properties patternProperties].each do |prop_name|
-      props = obj.fetch(prop_name, {})
-      props.keys.sort!.each do |name|
-        return false unless replace_inlines(props[name], components)
-      end
-    end
-    return false unless replace_inlines(obj['additionalProperties'], components)
-  end
   r = components.ref_string(top_level_name) || components.reference(obj)
   components.store_anchor(obj, r)
-  obj.replace({ '$ref' => r }) if top_level_name.nil?
+  components.to_reference_object(obj, r) if top_level_name.nil?
   true
 end
 
@@ -82,7 +88,7 @@ def main
   input_name = nil
   output_name = nil
   path = %w[components schemas]
-  components = ApiObjects::Components.new(path, 'Schema')
+  components = OpenAPISourceTools::ApiObjects::Components.new(path, 'Schema')
 
   parser = OptionParser.new do |opts|
     opts.summary_indent = '  '
@@ -109,7 +115,7 @@ Loads API document in OpenAPI format and adds a schema for each inline type.
   end
   parser.order!
 
-  doc = Common.load_source(input_name)
+  doc = OpenAPISourceTools::Common.load_source(input_name)
   return 2 if doc.nil?
 
   # Find schema object and remove it temporarily to prevent being
@@ -122,10 +128,10 @@ Loads API document in OpenAPI format and adds a schema for each inline type.
   end
   return 4 unless replace_inlines(doc, components)
   components.alter_anchors
-  Common.bury(doc, path, components.items) unless components.items.empty?
+  OpenAPISourceTools::Common.bury(doc, path, components.items) unless components.items.empty?
   replace_anchor_refs(doc, components)
 
-  Common.dump_result(output_name, doc, 3)
+  OpenAPISourceTools::Common.dump_result(output_name, doc, 3)
 end
 
 exit(main) if File.basename(__FILE__) == File.basename($PROGRAM_NAME)

data/bin/openapi-clearrefs

@@ -0,0 +1,46 @@
+#!/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/apiobjects'
+require_relative '../lib/openapi/sourcetools/common'
+require 'optparse'
+require 'yaml'
+
+
+def main
+  input_name = nil
+  output_name = nil
+  retainer = OpenAPISourceTools::ApiObjects::ValueRetainer.new('$ref')
+
+  parser = OptionParser.new do |opts|
+    opts.summary_indent = '  '
+    opts.summary_width = 26
+    opts.banner = 'Usage: openapi-clearrefs [options]'
+    opts.separator ''
+    opts.separator 'Options:'
+    opts.on('-i', '--input FILE', 'Read API spec from FILE, not stdin.') do |f|
+      input_name = f
+    end
+    opts.on('-o', '--output FILE', 'Output to FILE, not stdout.') do |f|
+      output_name = f
+    end
+    opts.on('-h', '--help', 'Print this help and exit.') do
+      $stdout.puts %(#{opts}
+Loads API document in OpenAPI format and from objects with '$ref' key, deletes
+all other keys.
+)
+      exit 0
+    end
+  end
+  parser.order!
+
+  doc = OpenAPISourceTools::Common.load_source(input_name)
+  return 2 if doc.nil?
+  retainer.process(doc)
+  OpenAPISourceTools::Common.dump_result(output_name, doc, 3)
+end
+
+exit(main) if File.basename(__FILE__) == File.basename($PROGRAM_NAME)