openapi-sourcetools 0.12.0 → 0.12.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 830a477c8647ad883e5a6619767f19cfae7c2d9b9baa100b0e10bdd911ef0fc1
-  data.tar.gz: 9e4a89d44c344c0099f826bf08c459b2eaa448e4d8b76b982e7ee8b7146199b2
+  metadata.gz: 44a305843fc718a7b958b3afbaf42f6f215f5a23e23c5485799222b7030a1757
+  data.tar.gz: 68d37c654b903c17d8aa64d96fdcecbca2c3e7c56b2b5629e2e80f243d3993e1
 SHA512:
-  metadata.gz: eef01e1c3095d747213533d8ceeb4d0ba4107970b6541632b92b9ffaa0a0202d583ec6934f2af4af3dbf0dff4d0344e053bbf9201d8128cd474406fe11a8b308
-  data.tar.gz: 92fcbc4c9128e213ee4d67d7eebe69c5de9f5ef2576a0efdeae33b2f512a786d586e0eebe903fc932b43f59475ecbd780d925263adbd9f5039b113292db8ae97
+  metadata.gz: 274b22fbac33a899c3a2102772d2b3e6bd44aab656b67e74a1e65fbd07edcab86bc7fcde94e41184a51e3435ec7cbc5d826c407bbbbed322ff0e2eeec1168156
+  data.tar.gz: a41c84712831166ef6ab0b2233a9c491ea1d87b73d6f1d67bab2ef821a937d2216e99a471ed9210427cb7b8c9824160c257cc6ef856a971d4804812a9b9a5a5a

data/bin/openapi-addmediatypes

@@ -0,0 +1,59 @@
+#!/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
+  path = %w[components mediaTypes]
+  components = OpenAPISourceTools::ApiObjects::Components.new(path, 'MediaType')
+  replacer = OpenAPISourceTools::ApiObjects::ValueSubValueReplacer.new('content', components)
+
+  parser = OptionParser.new do |opts|
+    opts.summary_indent = '  '
+    opts.summary_width = 26
+    opts.banner = 'Usage: openapi-addmediatypes [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
+    components.add_options(opts)
+    opts.on('-h', '--help', 'Print this help and exit.') do
+      $stdout.puts %(#{opts}
+
+Loads API document in OpenAPI format and moves media types under components
+and replaces the original with reference.
+
+#{components.help}
+)
+      exit 0
+    end
+  end
+  parser.order!
+
+  doc = OpenAPISourceTools::Common.load_source(input_name)
+  return 2 if doc.nil?
+
+  components.items = doc.dig(*path) || {}
+  replacer.replace(doc.dig('components', 'headers') || {})
+  replacer.replace(doc.dig('components', 'responses') || {})
+  replacer.replace(doc.dig('components', 'parameters') || {})
+  replacer.replace(doc.fetch('paths', {}))
+  OpenAPISourceTools::Common.bury(doc, path, components.items) unless components.items.empty?
+
+  OpenAPISourceTools::Common.dump_result(output_name, doc, 3)
+end
+
+exit(main) if File.basename(__FILE__) == File.basename($PROGRAM_NAME)

data/bin/openapi-addrequestbodies

@@ -0,0 +1,57 @@
+#!/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
+  path = %w[components requestBodies]
+  components = OpenAPISourceTools::ApiObjects::Components.new(path, 'RequestBody')
+  replacer = OpenAPISourceTools::ApiObjects::ValueReplacer.new('requestBody', components)
+
+  parser = OptionParser.new do |opts|
+    opts.summary_indent = '  '
+    opts.summary_width = 26
+    opts.banner = 'Usage: openapi-addrequestbodies [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
+    components.add_options(opts)
+    opts.on('-h', '--help', 'Print this help and exit.') do
+      $stdout.puts %(#{opts}
+
+Loads API document in OpenAPI format and moves request body under components
+and replaces the original with reference.
+
+#{components.help}
+)
+      exit 0
+    end
+  end
+  parser.order!
+
+  doc = OpenAPISourceTools::Common.load_source(input_name)
+  return 2 if doc.nil?
+
+  components.items = doc.dig(*path) || {}
+  replacer.replace(doc.dig('components', 'pathItems') || {})
+  replacer.replace(doc.fetch('paths', {}))
+  OpenAPISourceTools::Common.bury(doc, path, components.items) unless components.items.empty?
+
+  OpenAPISourceTools::Common.dump_result(output_name, doc, 3)
+end
+
+exit(main) if File.basename(__FILE__) == File.basename($PROGRAM_NAME)

data/bin/openapi-addschemas

@@ -56,7 +56,7 @@ def replace_inlines(obj, components, top_level_name = nil)
   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|
+    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

data/bin/openapi-generate-checkconfig

@@ -0,0 +1,73 @@
+#!/usr/bin/env ruby
+# frozen_string_literal: true
+
+# Copyright © 2024-2026 Ismo Kärkkäinen
+# Licensed under Universal Permissive License. See LICENSE.txt.
+
+require_relative '../lib/openapi/sourcetools/common'
+require_relative '../lib/openapi/sourcetools/config'
+require_relative '../lib/openapi/sourcetools/gen'
+require 'optparse'
+include OpenAPISourceTools
+
+
+def main
+  prefix = nil
+  keys = nil
+  read = false
+
+  parser = OptionParser.new do |opts|
+    opts.summary_indent = '  '
+    opts.summary_width = 26
+    opts.banner = 'Usage: openapi-generate-checkconfig [options]'
+    opts.separator ''
+    opts.separator 'Options:'
+    opts.on('-c', '--config NAME', 'Use config prefix NAME. (config:NAME)') do |c|
+      prefix = c
+    end
+    opts.on('-s', '--separator STRING', 'Use separator STRING. (separator:STRING)') do |s|
+      Gen.separator = s unless s.empty?
+    end
+    opts.on('-r', '--[no-]read', "Show if file is read by read_contents, default #{Common.yesno(read)}.") do |b|
+      read = b
+    end
+    opts.on('-k', '--keys KEYS', 'Show all values of KEYS.') do |ks|
+      keys = ks.split('/').reject(&:empty?) unless ks.empty?
+      keys = nil if !keys.nil? && keys.empty?
+    end
+    opts.on('-h', '--help', 'Print this help and exit.') do
+      $stdout.puts %(#{opts}
+Displays configurations files that are found using specific prefix and an
+optional separator character or string.
+
+If KEYS, separated by "/", is given, the value of that key path is displayed.
+That and read check require the configuration files to be YAML/JSON.
+)
+      exit 0
+    end
+  end
+  parser.order!
+
+  return Common.aargh('Config must be given.', 1) if prefix.nil?
+  cfgs = ConfigLoader.find_files(name_prefix: prefix)
+  ConfigLoader.read_contents(cfgs) if read || !keys.nil?
+  root_dir, _p = ConfigLoader.prepare_prefix(prefix, Gen.wd)
+  drop = root_dir.size + 1
+  cfgs.each do |cfg|
+    ks = cfg.keys.join('/')
+    info = "#{cfg.root}: #{ks.empty? ? '(root)' : ks}, #{cfg.path[drop..]}"
+    ki = nil
+    unless keys.nil? || cfg.content.nil?
+      v = cfg.content.dig(*keys)
+      ki = v.to_s unless v.nil?
+    end
+    ri = read ? !cfg.content.nil? : nil
+    next if (read || !keys.nil?) && ki.nil? && ri.nil?
+    puts info
+    puts "  #{ki}" unless ki.nil?
+    puts "  File is #{ri ? '' : 'not '}read." unless ri.nil?
+  end
+  0
+end
+
+exit(main) if File.basename(__FILE__) == File.basename($PROGRAM_NAME)

data/bin/openapi-order

@@ -213,6 +213,7 @@ def default_order_data(order_key, regexp_prefix)
       - parameters
       - '*'
       - additionalOperations
+      - re:^x-openapi-sourcetools.*$
       '*':
         #{order_key}: &OperationObject
         - '$ref'

data/lib/openapi/sourcetools/apiobjects.rb

@@ -240,17 +240,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/task.rb

@@ -7,8 +7,8 @@ require_relative 'common'
 require 'erb'
 
 
+# Gem namespace.
 module OpenAPISourceTools
-
   # Required interface for tasks, with default implementation for some methods.
   module TaskInterface
     def generate(context_binding)

data/lib/openapi/sourcetools/version.rb

@@ -3,9 +3,10 @@
 # Copyright © 2025-2026 Ismo Kärkkäinen
 # Licensed under Universal Permissive License. See LICENSE.txt.
 
+# Gem namespace.
 module OpenAPISourceTools
   NAME = 'openapi-sourcetools'
-  VERSION = '0.12.0'
+  VERSION = '0.12.1'
 
   def self.info(separator = ': ')
     "#{NAME}#{separator}#{VERSION}"

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: openapi-sourcetools
 version: !ruby/object:Gem::Version
-  version: 0.12.0
+  version: 0.12.1
 platform: ruby
 authors:
 - Ismo Kärkkäinen
@@ -37,7 +37,9 @@ description: |-
 email: ismokarkkainen@icloud.com
 executables:
 - openapi-addheaders
+- openapi-addmediatypes
 - openapi-addparameters
+- openapi-addrequestbodies
 - openapi-addresponses
 - openapi-addschemas
 - openapi-addsecurityschemes
@@ -45,6 +47,7 @@ executables:
 - openapi-clearrefs
 - openapi-frequencies
 - openapi-generate
+- openapi-generate-checkconfig
 - openapi-merge
 - openapi-modifypaths
 - openapi-order
@@ -55,7 +58,9 @@ extra_rdoc_files: []
 files:
 - LICENSE.txt
 - bin/openapi-addheaders
+- bin/openapi-addmediatypes
 - bin/openapi-addparameters
+- bin/openapi-addrequestbodies
 - bin/openapi-addresponses
 - bin/openapi-addschemas
 - bin/openapi-addsecurityschemes
@@ -63,6 +68,7 @@ files:
 - bin/openapi-clearrefs
 - bin/openapi-frequencies
 - bin/openapi-generate
+- bin/openapi-generate-checkconfig
 - bin/openapi-merge
 - bin/openapi-modifypaths
 - bin/openapi-order
@@ -100,7 +106,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.6.9
+rubygems_version: 4.0.21
 specification_version: 4
 summary: Tools for creating source code from API specification.
 test_files: []