openapi-sourcetools 0.7.0 → 0.7.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 211083083a2a3c53321234416ffff41bd1d00320a5ebbdab3ccdcd49576653b3
-  data.tar.gz: 34535443138a6308869974d62e79321d9ec9dbb3f46434c19d571075044751e1
+  metadata.gz: 71267174b8f95f5a510b93590f8fcdb8daf2737df19db6d2d7ebf48410444cf8
+  data.tar.gz: cf682ab07dcc557c9f3a2b9785f46aded117c4b50d840a6e8dd0b31e80840a63
 SHA512:
-  metadata.gz: 3c4a5361e25a1cf7903b6038a32f4a94cf42579c0c4fefb21f885fae996c219a02eef322fd91d694dfe0ff668314685b990d3128ca7e6a98c3f30660639494d0
-  data.tar.gz: a563ba480140037e0ef91dbdc89fb62a2175954897726717976760879a74bf8284d673d3a259ce338b7b7493c84fd6c1f5cf4246b90ee42ae1959d3b31c7b21f
+  metadata.gz: efe4f67e9903c4b65e404fe349e668ff659e538ddff7bc7e28a59bd7f98167e16faabb4876d5b45e1142562ad6e6c4e22c7471e1f374c3debc4e204855a7e169
+  data.tar.gz: 3ab4a1cf50426d6405cb1281f4c159d43480ead4f11414f8642b6e0a5d7cb4eca4f3769fb43cff4c5f1884ef5a72d88fdcc9b9c09bbdeb80f4624b008cfba059

data/bin/openapi-addheaders

@@ -32,7 +32,6 @@ def main
   path = %w[components headers]
   components = Components.new(path, 'Header')
 
-  ENV['POSIXLY_CORRECT'] = '1'
   parser = OptionParser.new do |opts|
     opts.summary_indent = '  '
     opts.summary_width = 26
@@ -42,7 +41,7 @@ def main
     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|
+    opts.on('-o', '--output FILE', 'Output to FILE, not stdout.') do |f|
       output_name = f
     end
     components.add_options(opts)
@@ -57,7 +56,7 @@ replaces the original with reference.
       exit 0
     end
   end
-  parser.parse!
+  parser.order!
 
   doc = load_source(input_name)
   return 2 if doc.nil?
@@ -70,4 +69,4 @@ replaces the original with reference.
   dump_result(output_name, doc, 3)
 end
 
-exit(main) if (defined? $unit_test).nil?
+exit(main) if defined?($unit_test).nil?

data/bin/openapi-addparameters

@@ -32,7 +32,6 @@ def main
   path = %w[components parameters]
   components = Components.new(path, 'Parameter')
 
-  ENV['POSIXLY_CORRECT'] = '1'
   parser = OptionParser.new do |opts|
     opts.summary_indent = '  '
     opts.summary_width = 26
@@ -42,7 +41,7 @@ def main
     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|
+    opts.on('-o', '--output FILE', 'Output to FILE, not stdout.') do |f|
       output_name = f
     end
     components.add_options(opts)
@@ -57,7 +56,7 @@ replaces the original with reference.
       exit 0
     end
   end
-  parser.parse!
+  parser.order!
 
   doc = load_source(input_name)
   return 2 if doc.nil?

data/bin/openapi-addresponses

@@ -32,7 +32,6 @@ def main
   path = %w[components responses]
   components = Components.new(path, 'Response')
 
-  ENV['POSIXLY_CORRECT'] = '1'
   parser = OptionParser.new do |opts|
     opts.summary_indent = '  '
     opts.summary_width = 26
@@ -42,7 +41,7 @@ def main
     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|
+    opts.on('-o', '--output FILE', 'Output to FILE, not stdout.') do |f|
       output_name = f
     end
     components.add_options(opts)
@@ -57,7 +56,7 @@ replaces the original with reference.
       exit 0
     end
   end
-  parser.parse!
+  parser.order!
 
   doc = load_source(input_name)
   return 2 if doc.nil?
@@ -69,4 +68,4 @@ replaces the original with reference.
   dump_result(output_name, doc, 3)
 end
 
-exit(main) if (defined? $unit_test).nil?
+exit(main) if defined?($unit_test).nil?

data/bin/openapi-addschemas

@@ -17,7 +17,7 @@ def remove_subitem(obj, path)
   parent.delete(path.last) || {}
 end
 
-def replace_inlines(obj, components, top_level = false)
+def replace_inlines(obj, components, top_level_name = nil)
   if obj.is_a?(Array)
     obj.each do |o|
       return false unless replace_inlines(o, components)
@@ -25,8 +25,11 @@ def replace_inlines(obj, components, top_level = false)
     return true
   end
   return true unless obj.is_a?(Hash)
-  return true if obj.key?('$ref')
-  # Prior return would be the place to get rid of other keys if so desired.
+  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?
@@ -49,17 +52,34 @@ def replace_inlines(obj, components, top_level = false)
       return false unless replace_inlines(props[name], components)
     end
   end
-  obj.replace({ '$ref' => components.reference(obj) }) unless top_level
+  r = components.ref_string(top_level_name) || components.reference(obj)
+  components.store_anchor(obj, r)
+  obj.replace({ '$ref' => r }) if top_level_name.nil?
   true
 end
 
+def replace_anchor_refs(obj, components)
+  if obj.is_a?(Array)
+    obj.each do |o|
+      replace_anchor_refs(o, components)
+    end
+    return
+  end
+  return unless obj.is_a?(Hash)
+  r = obj['$ref']
+  obj['$ref'] = components.anchor_ref_replacement(r) unless r.nil?
+  obj.values.each do |value|
+    # Loops over $ref value but that is a string so nothing done to it.
+    replace_anchor_refs(value, components)
+  end
+end
+
 def main
   input_name = nil
   output_name = nil
   path = %w[components schemas]
   components = Components.new(path, 'Schema')
 
-  ENV['POSIXLY_CORRECT'] = '1'
   parser = OptionParser.new do |opts|
     opts.summary_indent = '  '
     opts.summary_width = 26
@@ -69,7 +89,7 @@ def main
     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|
+    opts.on('-o', '--output FILE', 'Output to FILE, not stdout.') do |f|
       output_name = f
     end
     components.add_options(opts)
@@ -83,7 +103,7 @@ Loads API document in OpenAPI format and adds a schema for each inline type.
       exit 0
     end
   end
-  parser.parse!
+  parser.order!
 
   doc = load_source(input_name)
   return 2 if doc.nil?
@@ -93,12 +113,15 @@ Loads API document in OpenAPI format and adds a schema for each inline type.
   components.items = remove_subitem(doc, path)
   # Get rid of inlined types within existing schemas first.
   components.items.keys.sort!.each do |k|
-    return 4 unless replace_inlines(components.items[k], components, true)
+    components.add_schema_name(k)
+    return 4 unless replace_inlines(components.items[k], components, k)
   end
   return 4 unless replace_inlines(doc, components)
+  components.alter_anchors
   bury(doc, path, components.items) unless components.items.empty?
+  replace_anchor_refs(doc, components)
 
   dump_result(output_name, doc, 3)
 end
 
-exit(main) if (defined? $unit_test).nil?
+exit(main) if defined?($unit_test).nil?

data/bin/openapi-checkschemas

@@ -142,7 +142,6 @@ def main
   count = true
   keep = false
 
-  ENV['POSIXLY_CORRECT'] = '1'
   parser = OptionParser.new do |opts|
     opts.summary_indent = '  '
     opts.summary_width = 26
@@ -152,22 +151,22 @@ def main
     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|
+    opts.on('-o', '--output FILE', 'Output to FILE, not stdout.') do |f|
       output_name = f
     end
-    opts.on('-e', '--[no-]equivalent', "Report equivalent schemas, default #{equivalent}") do |b|
+    opts.on('-e', '--[no-]equivalent', "Report equivalent schemas, default #{yesno(equivalent)}") do |b|
       equivalent = b
     end
-    opts.on('-t', '--[no-]typematch', "Report typematch schemas, default #{typematch}") do |b|
+    opts.on('-t', '--[no-]typematch', "Report typematch schemas, default #{yesno(typematch)}") do |b|
       typematch = b
     end
-    opts.on('-r', '--[no-]reference', "Report schema references, default #{references}") do |b|
+    opts.on('-r', '--[no-]reference', "Report schema references, default #{yesno(references)}") do |b|
       references = b
     end
-    opts.on('-c', '--[no-]count', "Report schema reference counts, default #{count}") do |b|
+    opts.on('-c', '--[no-]count', "Report schema reference counts, default #{yesno(count)}") do |b|
       count = b
     end
-    opts.on('-k', '--[no-]keep', "Keep all schema references/counts, default #{keep}") do |b|
+    opts.on('-k', '--[no-]keep', "Keep all schema references/counts, default #{yesno(keep)}") do |b|
       keep = b
     end
     components.add_options(opts)
@@ -182,17 +181,17 @@ names differ but types match.
 
 Search is performed only at top schema level. References to equivalent types
 are not considered equivalent when references themselves are not equivalent.
-Any allOf, anyOf, oneOf checks merely check the refernces. Hence two different
+Any allOf, anyOf, oneOf checks merely check the references. Hence two different
 allOf schemas may in practice result in equivalent types and that is not
 detected.
 
 Implicit expectation is the openapi-addschemas has been used to process the
-input, as inlined types in requests for example are ignored.
+input, as inlined types in requests, for example, are ignored.
 )
       exit 0
     end
   end
-  parser.parse!
+  parser.order!
 
   doc = load_source(input_name)
   return 2 if doc.nil?
@@ -214,4 +213,4 @@ input, as inlined types in requests for example are ignored.
   dump_result(output_name, YAML.dump(report, line_width: 80), 3)
 end
 
-exit(main) if (defined? $unit_test).nil?
+exit(main) if defined?($unit_test).nil?

data/bin/openapi-frequencies

@@ -37,7 +37,7 @@ into each path object matching count as "freq".
       exit 0
     end
   end
-  parser.parse!
+  parser.order!
 
   return aargh('Path log file name must be given.', 1) if paths_name.nil?
 
@@ -75,4 +75,4 @@ into each path object matching count as "freq".
   dump_result(output_name, YAML.dump(doc), 3)
 end
 
-exit(main) if (defined? $unit_test).nil?
+exit(main) if defined?($unit_test).nil?

data/bin/openapi-merge

@@ -52,7 +52,7 @@ end
 
 def gather_refs(doc, found)
   doc.each_pair do |key, value|
-    if key == '$ref' && value.is_a?(String) && value.start_with?('#/components/')
+    if key == '$ref' # Trust all refs to be valid.
       found.add(value)
     elsif value.is_a? Hash
       gather_refs(value, found)
@@ -64,6 +64,13 @@ def gather_refs(doc, found)
   end
 end
 
+def has_refd_anchor(item, refs)
+  return !((item.index { |v| has_refd_anchor(v, refs) }).nil?) if item.is_a?(Array)
+  return false unless item.is_a?(Hash)
+  return true if refs.member?('#' + item.fetch('$anchor', ''))
+  !((item.values.index { |v| has_refd_anchor(v, refs) }).nil?)
+end
+
 def prune(merged)
   prev_refs = Set.new
   loop do # May have references from deleted so repeat until nothing deleted.
@@ -74,16 +81,16 @@ def prune(merged)
         refs.add("#/components/securitySchemes/#{key}")
       end
     end
+    # Add schema ref for all schemas that have referenced anchor somewhere.
+    (merged.dig(*%w[components schemas]) || {}).each do |name, schema|
+      refs.add("#/components/Schemas/#{name}") if has_refd_anchor(schema, refs)
+    end
     used = {}
     all = merged.fetch('components', {})
     refs.each do |ref|
       p = ref.split('/')
       p.shift(2)
-      item = all
-      p.each do |key|
-        item = item.fetch(key, nil)
-        break if item.nil?
-      end
+      item = all.dig(*p)
       next if item.nil?
       sub = used
       p.each_index do |k|
@@ -105,7 +112,6 @@ def main
   output_file = nil
   keep = false
 
-  ENV['POSIXLY_CORRECT'] = '1'
   parser = OptionParser.new do |opts|
     opts.summary_indent = '  '
     opts.summary_width = 26
@@ -130,7 +136,7 @@ allowed only to append to the merged document, not re-define anything in it.
       exit 0
     end
   end
-  parser.parse!
+  parser.order!
 
   max_depths = Hash.new(0)
   max_depths['openapi'] = 1
@@ -155,4 +161,4 @@ allowed only to append to the merged document, not re-define anything in it.
   dump_result(output_file, YAML.dump(merged), 3)
 end
 
-exit(main) if (defined? $unit_test).nil?
+exit(main) if defined?($unit_test).nil?

data/bin/openapi-modifypaths

@@ -120,4 +120,4 @@ STR and PREFIX are expected to be parts of a path surrounded by /.
   dump_result(output_name, doc, 3)
 end
 
-main if defined?($unit_test).nil?
+exit(main) if defined?($unit_test).nil?

data/bin/openapi-processpaths

@@ -38,7 +38,7 @@ later stage tools. Checks for paths that may be ambiguous.
       exit 0
     end
   end
-  parser.parse!
+  parser.order!
 
   doc = load_source(input_name)
   return 2 if doc.nil?
@@ -81,4 +81,4 @@ later stage tools. Checks for paths that may be ambiguous.
   dump_result(output_name, YAML.dump(doc), 3)
 end
 
-exit(main) if (defined? $unit_test).nil?
+exit(main) if defined?($unit_test).nil?

data/lib/apiobjects.rb

@@ -33,15 +33,17 @@ def reference(obj, schemas, schema_path, ignored_keys = Set.new(%w[summary descr
 end
 
 class Components
-  attr_reader :path, :prefix
+  attr_reader :path, :prefix, :anchor2ref, :schema_names
   attr_accessor :items, :ignored_keys
 
-  def initialize(path, prefix, ignored_keys = %w[summary description examples example])
-    @items = {}
+  def initialize(path, prefix, ignored_keys = %w[summary description examples example $anchor])
     path = "#/#{path.join('/')}/" if path.is_a?(Array)
     path = "#{path}/" unless path.end_with?('/')
     @path = path
     @prefix = prefix
+    @anchor2ref = {}
+    @schema_names = Set.new
+    @items = {}
     @ignored_keys = Set.new(ignored_keys)
   end
 
@@ -58,7 +60,12 @@ class Components
     %(All fields are used in object equality comparisons except:\n#{@ignored_keys.to_a.sort!.join("\n")})
   end
 
+  def add_schema_name(name)
+    @schema_names.add(name)
+  end
+
   def ref_string(name)
+    return nil if name.nil?
     "#{@path}#{name}"
   end
 
@@ -73,42 +80,39 @@ class Components
       cand = "#{@prefix}#{n}x"
       next if @items.key?(cand)
       @items[cand] = obj.merge
+      @schema_names.add(cand)
       return ref_string(cand)
     end
   end
-end
-
-
-class PathOperation
-  attr_accessor :path, :operation, :info, :parameters
-  attr_accessor :servers, :security, :tags
-  attr_accessor :summary, :description
-end
 
-# One could have a convenience
-# method that determines how many bytes the value needs, and if it needs to be
-# signed.
-
-# When creating types for schemas or otherwise, the type name can be added
-# into the item and that way be used as an indicator that the type has been
-# declared or needs a declaration.
+  def store_anchor(obj, ref = nil)
+    anchor_name = obj['$anchor']
+    return if anchor_name.nil?
+    ref = obj['$ref'] if ref.nil?
+    raise Exception, 'ref is nil and no $ref or it is nil' if ref.nil?
+    @anchor2ref[anchor_name] = ref
+  end
 
-def make_path_operations(apidoc)
-  # Check openapi
-  # Store info as is for reference
-  # Store servers as is for default value for PathOperation
-  # Process components. Lazy manner, only when referenced.
-  # Store security as is for default value for PathOperation.
-  # Store tags as mapping from name to object for use with PathOperation.
-  # Process paths:
-  # Store parameters as is for default value for PathOperation.
-  # All other fields, check if it looks like OperationObject and create a
-  # PathOperation using it. For others, store as is for default value.
+  def alter_anchors
+    replacements = {}
+    @anchor2ref.each do |a, r|
+      next if @schema_names.member?(a)
+      replacements[a] = ref_string(a)
+      @schema_names.add(a)
+    end
+    replacements.each do |a, r|
+      @anchor2ref[a] = r
+    end
+  end
 
+  def anchor_ref_replacement(ref)
+    @anchor2ref[ref[1...ref.size]] || ref
+  end
 end
 
-
 class ServerPath
+  # Probably moves to a separate file once processpaths and frequencies receive
+  # some attention.
   include Comparable
 
   attr_accessor :parts
@@ -161,6 +165,8 @@ class ServerPath
   end
 end
 
+# The rest probably ends up in a gem that orders schemas and does nothing else.
+
 # Adds all refs found in the array to refs with given required state.
 def gather_array_refs(refs, items, required)
   items.each do |s|
@@ -298,36 +304,3 @@ class SchemaOrderer
     chosen
   end
 end
-
-class HeaderOrderer
-end
-
-class ResponseOrderer
-end
-
-class PathOrderer
-end
-
-class Tasker
-  attr_reader :doc
-  def initialize(doc)
-    @doc = doc
-  end
-end
-
-class SchemaTasker < Tasker
-# initialize with doc
-# Orderer set somehow.
-# Method ot create one task per schema.
-# Method to create one task for all schemas.
-end
-
-class HeaderTasker < Tasker
-# initialize with doc
-# Orderer set somehow.
-# Method ot create one task per schema.
-# Method to create one task for all schemas.
-end
-
-
-

data/lib/common.rb

@@ -12,6 +12,10 @@ def aargh(message, return_value = nil)
   return_value
 end
 
+def yesno(boolean)
+  boolean ? 'yes' : 'no'
+end
+
 def bury(doc, path, value)
   (path.size - 1).times do |k|
     p = path[k]

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: openapi-sourcetools
 version: !ruby/object:Gem::Version
-  version: 0.7.0
+  version: 0.7.1
 platform: ruby
 authors:
 - Ismo Kärkkäinen
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2024-08-07 00:00:00.000000000 Z
+date: 2024-08-28 00:00:00.000000000 Z
 dependencies: []
 description: |2