openapi-sourcetools 0.9.1 → 0.10.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 66fdcf15ec85b0fd84ac01e72665ced41cf0026cecf4bc36f62d316ff4089c87
-  data.tar.gz: 7b73b94b00c1d0ec2eeddcbd92055515dce3bdc2d33d1f3a4e82294c509b90e2
+  metadata.gz: b692fd4b41d1d925fc0a51d94faabe7ee1f5ec8ff26c7ee393e37cafd9b9dffe
+  data.tar.gz: 19df615a73ec7f006fffd49f1474fb188dbe0f616c49739f0b28c692f7035ec5
 SHA512:
-  metadata.gz: ecd07946cb028d9219aa00bc77507ec3e594b981b5fbb503c9142f2d7cd4f2248dabdfe706ef3a47f46a20377a81118d2125c3c94f8ad780ae58f07a346f0b0a
-  data.tar.gz: 21d343fdc926592defb63d521ad5245452036b39016e4cd97f4b3dcbc3319f5d03b592bca2a3006c01a5aee2295a6d2475f9029d2002d8dde689600d6cbb963c
+  metadata.gz: d52cdb9cbdea83bbb3ff510c0b73f61d47eb13049b74e452f90eb597d5a3f697dd414b8f4ca6dd7215d8ea9ac3fd397864c8589365e2a295aa575f2cb3d18c7e
+  data.tar.gz: 26b623377edc1c7cbf58721d1bc3a6a649d2bd79098c5b30502f7810678a09f27c6f401452f96020f4ddc8ff2a5546fce40c2904b63ad968421e7563730182ee

data/bin/openapi-addheaders

@@ -1,7 +1,7 @@
 #!/usr/bin/env ruby
 # 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.
 
 require_relative '../lib/openapi/sourcetools/apiobjects'
@@ -70,4 +70,4 @@ replaces the original with reference.
   Common.dump_result(output_name, doc, 3)
 end
 
-exit(main) if defined?($unit_test).nil?
+exit(main) if File.basename(__FILE__) == File.basename($PROGRAM_NAME)

data/bin/openapi-addparameters

@@ -1,7 +1,7 @@
 #!/usr/bin/env ruby
 # 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.
 
 require_relative '../lib/openapi/sourcetools/apiobjects'
@@ -87,7 +87,8 @@ replaces the original with reference.
 
 Optionally adds parameters to all operations objects by copying parameters
 from path item and replacing ones referred to in operations object. The
-path item parameters are left in place. Even empty arrays are added.
+path item parameters are left in place. Even empty arrays are added. This
+feature is intended to simplify code generation.
 
 #{components.help}
 )
@@ -109,4 +110,4 @@ path item parameters are left in place. Even empty arrays are added.
   Common.dump_result(output_name, doc, 3)
 end
 
-exit(main) unless defined?($unit_test)
+exit(main) if File.basename(__FILE__) == File.basename($PROGRAM_NAME)

data/bin/openapi-addresponses

@@ -1,7 +1,7 @@
 #!/usr/bin/env ruby
 # 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.
 
 require_relative '../lib/openapi/sourcetools/apiobjects'
@@ -68,4 +68,4 @@ replaces the original with reference.
   Common.dump_result(output_name, doc, 3)
 end
 
-exit(main) if defined?($unit_test).nil?
+exit(main) if File.basename(__FILE__) == File.basename($PROGRAM_NAME)

data/bin/openapi-addschemas

@@ -1,7 +1,7 @@
 #!/usr/bin/env ruby
 # 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.
 
 require_relative '../lib/openapi/sourcetools/apiobjects'
@@ -128,4 +128,4 @@ Loads API document in OpenAPI format and adds a schema for each inline type.
   Common.dump_result(output_name, doc, 3)
 end
 
-exit(main) if defined?($unit_test).nil?
+exit(main) if File.basename(__FILE__) == File.basename($PROGRAM_NAME)

data/bin/openapi-addsecurityschemes

@@ -1,7 +1,7 @@
 #!/usr/bin/env ruby
 # frozen_string_literal: true
 
-# Copyright © 2025 Ismo Kärkkäinen
+# Copyright © 2025-2026 Ismo Kärkkäinen
 # Licensed under Universal Permissive License. See LICENSE.txt.
 
 require_relative '../lib/openapi/sourcetools/apiobjects'
@@ -105,4 +105,4 @@ replaces the original with reference.
   Common.dump_result(output_name, doc, 3)
 end
 
-exit(main) unless defined?($unit_test)
+exit(main) if File.basename(__FILE__) == File.basename($PROGRAM_NAME)

data/bin/openapi-checkschemas

@@ -1,7 +1,7 @@
 #!/usr/bin/env ruby
 # 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.
 
 require_relative '../lib/openapi/sourcetools/apiobjects'
@@ -214,4 +214,4 @@ input, as inlined types in requests, for example, are ignored.
   Common.dump_result(output_name, YAML.dump(report, line_width: 80), 3)
 end
 
-exit(main) if defined?($unit_test).nil?
+exit(main) if File.basename(__FILE__) == File.basename($PROGRAM_NAME)

data/bin/openapi-frequencies

@@ -1,7 +1,7 @@
 #!/usr/bin/env ruby
 # frozen_string_literal: true
 
-# Copyright © 2021-2025 Ismo Kärkkäinen
+# Copyright © 2021-2026 Ismo Kärkkäinen
 # Licensed under Universal Permissive License. See LICENSE.txt.
 
 require_relative '../lib/openapi/sourcetools/apiobjects'
@@ -73,4 +73,4 @@ into each path object matching count as "x-openapi-sourcetools-freq".
   Common.dump_result(output_name, doc, 3)
 end
 
-exit(main) unless defined?($unit_test)
+exit(main) if File.basename(__FILE__) == File.basename($PROGRAM_NAME)

data/bin/openapi-generate

@@ -1,7 +1,7 @@
 #!/usr/bin/env ruby
 # frozen_string_literal: true
 
-# Copyright © 2021-2025 Ismo Kärkkäinen
+# Copyright © 2021-2026 Ismo Kärkkäinen
 # Licensed under Universal Permissive License. See LICENSE.txt.
 
 require_relative '../lib/openapi/sourcetools/common'
@@ -58,4 +58,4 @@ After all generators have loaded succesfully, tasks are run.
   gen.run
 end
 
-exit(main) unless defined?($unit_test)
+exit(main) if File.basename(__FILE__) == File.basename($PROGRAM_NAME)

data/bin/openapi-merge

@@ -1,14 +1,14 @@
 #!/usr/bin/env ruby
 # frozen_string_literal: true
 
-# Copyright © 2021-2025 Ismo Kärkkäinen
+# Copyright © 2021-2026 Ismo Kärkkäinen
 # Licensed under Universal Permissive License. See LICENSE.txt.
 
 require_relative '../lib/openapi/sourcetools/common'
 require 'optparse'
-require 'set'
 include OpenAPISourceTools
 
+
 def raise_se(message)
   raise StandardError, message
 end
@@ -26,23 +26,38 @@ def too_deep(path, max_depths)
   max_depths.fetch(path.first) <= path.size
 end
 
-def add_undefined(merged, incoming, filename, path, max_depths)
+def add_missing(existing, incoming, field)
+  incoming.each do |t|
+    tv = t[field]
+    next if tv.nil?
+    existing.push(t) if existing.index { |e| e.key?(field) && e[field] == tv }.nil?
+  end
+end
+
+def add_undefined(merged, incoming, filename, path, max_depths, firsts, lasts)
   incoming.each_pair do |key, value|
     unless merged.key? key
       merged[key] = value
       next
     end
+    next if firsts.member?(key) # When key appears the second or more times.
+    if lasts.member?(key) # If last is kept, always copy value.
+      merged[key] = value
+      next
+    end
     m = merged[key]
     raise_se("Path #{path_combo(path, false)} merged type #{m.class} differs from type #{value.class} in #{filename}") unless m.instance_of?(value.class)
     raise_se("Re-definition of #{key} #{path_combo(path)} in #{filename}") if too_deep(path, max_depths)
     if m.is_a? Hash # paths or similar
       path.push key
-      add_undefined(m, value, filename, path, max_depths)
+      add_undefined(m, value, filename, path, max_depths, firsts, lasts)
       path.pop
     elsif m.is_a? Array
-      value.each do |v|
-        next if m.include? v
-        m.push v
+      case key
+      when 'tags' then add_missing(m, value, 'name')
+      when 'servers' then add_missing(m, value, 'url')
+      else
+        value.each { |v| m.push(v) unless m.include?(v) }
       end
     else
       raise_se "Re-definition of #{key} #{path_combo(path)} in #{filename}"
@@ -65,10 +80,10 @@ def gather_refs(doc, found)
 end
 
 def has_refd_anchor(item, refs)
-  return !((item.index { |v| has_refd_anchor(v, refs) }).nil?) if item.is_a?(Array)
+  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?)
+  return true if refs.member?("##{item.fetch('$anchor', '')}")
+  !item.values.index { |v| has_refd_anchor(v, refs) }.nil?
 end
 
 def prune(merged)
@@ -83,7 +98,7 @@ def prune(merged)
     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)
+      refs.add("#/components/schemas/#{name}") if has_refd_anchor(schema, refs)
     end
     used = {}
     all = merged.fetch('components', {})
@@ -111,6 +126,8 @@ end
 def main
   output_file = nil
   keep = false
+  firsts = Set.new
+  lasts = Set.new
 
   parser = OptionParser.new do |opts|
     opts.summary_indent = '  '
@@ -127,6 +144,12 @@ def main
     opts.on('-p', '--prune', 'Prune all unreferenced objects under components (default).') do
       keep = false
     end
+    opts.on('-f', '--first KEY', 'Keep only the first occurrence of top-level KEY.') do |key|
+      firsts.add(key)
+    end
+    opts.on('-l', '--last KEY', 'Keep only the last occurrence of top-level KEY.') do |key|
+      lasts.add(key)
+    end
     opts.on('-h', '--help', 'Print this help and exit.') do
       $stdout.puts %(#{opts}
 
@@ -138,20 +161,27 @@ allowed only to append to the merged document, not re-define anything in it.
   end
   parser.order!
 
-  max_depths = Hash.new(0)
-  max_depths['openapi'] = 1
-  max_depths['info'] = 1
-  max_depths['servers'] = 1
-  max_depths['paths'] = 2 # Allows get, post, etc. from different files.
-  max_depths['webhooks'] = 2
-  max_depths['components'] = 2
-  max_depths['security'] = 1
-  max_depths['tags'] = 1
+  overlap = firsts & lasts
+  unless overlap.empty?
+    return Common.aargh("Key can only be in first or last, not both: #{overlap.to_a.sort!.join(' ')}", 1)
+  end
+
+  max_depths = Hash.new(0).merge!({
+    'openapi' => 1,
+    'info' => 1,
+    'servers' => 1,
+    'paths' => 2, # Allows get, post, etc. from different files.
+    'webhooks' => 2,
+    'components' => 2,
+    'security' => 1,
+    'tags' => 1
+  })
+
   merged = {}
   ARGV.each do |filename|
     s = Common.load_source(filename)
     return 2 if s.nil?
-    add_undefined(merged, s, filename, [], max_depths)
+    add_undefined(merged, s, filename, [], max_depths, firsts, lasts)
   rescue StandardError => e
     return Common.aargh(e.to_s, 4)
   end
@@ -161,4 +191,4 @@ allowed only to append to the merged document, not re-define anything in it.
   Common.dump_result(output_file, merged, 3)
 end
 
-exit(main) if defined?($unit_test).nil?
+exit(main) if File.basename(__FILE__) == File.basename($PROGRAM_NAME)

data/bin/openapi-modifypaths

@@ -1,7 +1,7 @@
 #!/usr/bin/env ruby
 # 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.
 
 require_relative '../lib/openapi/sourcetools/common'
@@ -121,4 +121,4 @@ STR and PREFIX are expected to be parts of a path surrounded by /.
   Common.dump_result(output_name, doc, 3)
 end
 
-exit(main) if defined?($unit_test).nil?
+exit(main) if File.basename(__FILE__) == File.basename($PROGRAM_NAME)

data/bin/openapi-patterntests

@@ -1,7 +1,7 @@
 #!/usr/bin/env ruby
 # frozen_string_literal: true
 
-# Copyright © 2025 Ismo Kärkkäinen
+# Copyright © 2025-2026 Ismo Kärkkäinen
 # Licensed under Universal Permissive License. See LICENSE.txt.
 
 require_relative '../lib/openapi/sourcetools/common'
@@ -163,4 +163,4 @@ strings for testing generated code.
   Common.dump_result(output_name, ex, 3)
 end
 
-exit(main) if defined?($unit_test).nil?
+exit(main) if File.basename(__FILE__) == File.basename($PROGRAM_NAME)

data/bin/openapi-processpaths

@@ -1,7 +1,7 @@
 #!/usr/bin/env ruby
 # frozen_string_literal: true
 
-# Copyright © 2021-2025 Ismo Kärkkäinen
+# Copyright © 2021-2026 Ismo Kärkkäinen
 # Licensed under Universal Permissive License. See LICENSE.txt.
 
 require_relative '../lib/openapi/sourcetools/apiobjects'
@@ -70,4 +70,4 @@ key. Checks for paths that may be ambiguous.
   Common.dump_result(output_name, doc, 3)
 end
 
-exit(main) unless defined?($unit_test)
+exit(main) if File.basename(__FILE__) == File.basename($PROGRAM_NAME)

data/lib/openapi/sourcetools/apiobjects.rb

@@ -251,5 +251,83 @@ module OpenAPISourceTools
         @servers <=> other.servers
       end
     end
+
+    # Simple holder if security scheme objects.
+    class SecurityScheme
+      include Comparable
+
+      attr_reader :name, :scheme
+
+      def initialize(name, scheme)
+        @name = name
+        @scheme = scheme
+      end
+
+      def <=>(other)
+        @name <=> other.name
+      end
+    end
+
+    # Simple holder that determines where parameters are placed.
+    class SecurityRequirementObject
+      include Comparable
+
+      attr_reader :reqs, :extras
+
+      def initialize(reqs, schemes)
+        @reqs = reqs
+        @extras = {}
+        @reqs.each do |name, scopes|
+          scheme = schemes[name].scheme
+          case scheme['type']
+          when 'apiKey'
+            if scheme['in'] == 'header'
+              h = @extras[:headers] || {}
+              h[scheme['name']] = scopes
+              @extras[:headers] = h
+            elsif scheme['in'] == 'query'
+              q = @extras[:query] || {}
+              q[scheme['name']] = scopes
+              @extras[:query] = q
+            end
+          when 'http', 'oauth2', 'openIdConnect'
+            h = @extras[:headers] || {}
+            h['authorization'] = scopes
+            @extras[:headers] = h
+          else
+            raise "Unknown security type: #{scheme['type']} for #{name}"
+          end
+        end
+      end
+
+      def <=>(other)
+        d = @reqs.size <=> other.reqs.size
+        return d unless d.zero?
+        d = @reqs.keys.sort! <=> other.reqs.keys.sort!
+        return d unless d.zero?
+        @reqs.keys.sort!.each do |name|
+          d = @reqs[name].sort <=> other.reqs[name].sort
+          return d unless d.zero?
+        end
+        0
+      end
+    end
+
+    # Available possibilities.
+    class SecurityAlternatives
+      include Comparable
+
+      attr_reader :sros, :schemes
+      attr_accessor :set_id
+
+      def initialize(sros, schemes)
+        @sros = sros
+        @schemes = schemes
+      end
+
+      def <=>(other)
+        @sros.sort <=> other.sros.sort
+      end
+    end
   end
 end

data/lib/openapi/sourcetools/generate.rb

@@ -4,6 +4,7 @@
 # Copyright © 2024-2025 Ismo Kärkkäinen
 # Licensed under Universal Permissive License. See LICENSE.txt.
 
+require 'fileutils'
 require_relative 'common'
 require_relative 'loaders'
 require_relative 'gen'

data/lib/openapi/sourcetools/output.rb

@@ -1,21 +1,30 @@
 # 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.
 
+require 'json'
+require 'yaml'
+
 
 module OpenAPISourceTools
   # Output configuration settings for easy storage.
   # You can have it in configuration and pass hash to initialize.
   class OutputConfiguration
     attr_reader :indent_character, :indent_step
-    attr_reader :tab, :tab_replaces_count
+    attr_reader :tab, :tab_replaces_count, :prettified_json
 
     def initialize(cfg = {})
       @indent_character = cfg['indent_character'] || ' '
       @indent_step = cfg['indent_step'] || 4
       @tab = cfg['tab'] || "\t"
       @tab_replaces_count = cfg['tab_replaces_count'] || 0
+      @prettified_json = {
+        array_nl: "\n",
+        object_nl: "\n",
+        indent: '  ',
+        space: ' '
+      }.merge(cfg['prettified_json'] || {})
     end
   end
 
@@ -81,5 +90,17 @@ module OpenAPISourceTools
       @last_indent = indent
       indented.join(separator)
     end
+
+    def yaml(something)
+      YAML.dump(something)
+    end
+
+    def json(something)
+      JSON.generate(something)
+    end
+
+    def pretty_json(something)
+      JSON.generate(something, @config.prettified_json)
+    end
   end
 end

data/lib/openapi/sourcetools/version.rb

@@ -1,11 +1,11 @@
 # frozen_string_literal: true
 
-# Copyright © 2025 Ismo Kärkkäinen
+# Copyright © 2025-2026 Ismo Kärkkäinen
 # Licensed under Universal Permissive License. See LICENSE.txt.
 
 module OpenAPISourceTools
   NAME = 'openapi-sourcetools'
-  VERSION = '0.9.1'
+  VERSION = '0.10.1'
 
   def self.info(separator = ': ')
     "#{NAME}#{separator}#{VERSION}"

metadata

@@ -1,14 +1,13 @@
 --- !ruby/object:Gem::Specification
 name: openapi-sourcetools
 version: !ruby/object:Gem::Version
-  version: 0.9.1
+  version: 0.10.1
 platform: ruby
 authors:
 - Ismo Kärkkäinen
-autorequire:
 bindir: bin
 cert_chain: []
-date: 2025-04-18 00:00:00.000000000 Z
+date: 1980-01-02 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: deep_merge
@@ -82,7 +81,6 @@ licenses:
 - UPL-1.0
 metadata:
   rubygems_mfa_required: 'true'
-post_install_message:
 rdoc_options: []
 require_paths:
 - lib
@@ -97,8 +95,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.4.19
-signing_key:
+rubygems_version: 3.6.9
 specification_version: 4
 summary: Tools for creating source code from API specification.
 test_files: []