openapi-sourcetools 0.4.3 → 0.6.0

data/bin/openapi-frequencies

@@ -1,105 +1,78 @@
 #!/usr/bin/env ruby
 # frozen_string_literal: true
 
-# Copyright © 2021 Ismo Kärkkäinen
+# Copyright © 2021-2024 Ismo Kärkkäinen
 # Licensed under Universal Permissive License. See LICENSE.txt.
 
-require_relative '../lib/common.rb'
+require_relative '../lib/common'
 require 'optparse'
 require 'yaml'
-require 'json'
 
+def main
+  input_name = nil
+  output_name = nil
+  paths_name = nil
 
-default_env(:in, '')
-default_env(:out, '')
-default_env(:format, 'YAML')
-default_env(:paths, '')
-
-parser = OptionParser.new do |opts|
-  opts.summary_indent = '  '
-  opts.summary_width = 24
-  opts.banner = 'Usage: openapi-frequencies [options]'
-  opts.separator ''
-  opts.separator 'Options (equivalent environment variable and value in parentheses):'
-  opts.on('-i', '--input FILE', 'Read source from FILE, not stdin (IN=FILE).') do |f|
-    env(:in, f)
-  end
-  opts.on('-o', '--output FILE', 'Output result to FILE, not stdout (OUT=FILE).') do |f|
-    env(:out, f)
-  end
-  opts.on('-p', '--paths FILE', 'Path log file name (PATHS=FILE).') do |f|
-    env(:paths, f)
-  end
-  opts.on('--yaml', 'Output format is YAML (default) (FORMAT=YAML).') do
-    env(:format, 'YAML')
-  end
-  opts.on('--json', 'Output format is JSON. (FORMAT=JSON)') do
-    env(:format, 'JSON')
-  end
-  opts.on('-h', '--help', 'Print this help and exit.') do
-    $stdout.puts %(#{opts}
+  parser = OptionParser.new do |opts|
+    opts.summary_indent = '  '
+    opts.summary_width = 24
+    opts.banner = 'Usage: openapi-frequencies [options]'
+    opts.separator ''
+    opts.separator 'Options:'
+    opts.on('-i', '--input FILE', 'Read source from FILE, not stdin.') do |f|
+      input_name = f
+    end
+    opts.on('-o', '--output FILE', 'Output result to FILE, not stdout.') do |f|
+      output_name = f
+    end
+    opts.on('-p', '--paths FILE', 'Path log file name.') do |f|
+      paths_name = f
+    end
+    opts.on('-h', '--help', 'Print this help and exit.') do
+      $stdout.puts %(#{opts}
 
-Matches given file with paths and adds frequency information.
+Matches given OpenAPI document file paths with paths from file and adds
+into each path object matching count as "freq".
 )
-    exit 0
+      exit 0
+    end
   end
-end
-parser.parse!
+  parser.parse!
 
-aargh("Format neither JSON nor YAML: #{env(:format)}", 1) unless %w[JSON YAML].include? env(:format)
-fn = env(:paths)
-aargh("Path log file name must be given.") if fn.empty?
+  return aargh('Path log file name must be given.', 1) if paths_name.nil?
 
-def read_source(filename)
-  YAML.safe_load(filename.empty? ? $stdin : File.read(filename))
-rescue Errno::ENOENT => e
-  aargh("Could not read #{filename.empty? ? 'stdin' : filename}", 2)
-rescue StandardError => e
-  aargh(e.to_s, 3)
-end
-doc = read_source(env(:in))
+  doc = load_source(input_name)
+  return 2 if doc.nil?
 
-begin
-  # Expect one path per line with nothing else. Query is allowed and ignored.
-  f = File.new(fn, 'rt')
-  f.each_line do |line|
-    p = ServerPath.new(split_path(line))
-    doc['paths'].each_value do |info|
-      next unless (p <=> info['parts']) == 0
-      info['freq'] = info.fetch('freq', 0) + 1
-      # Lookalikes are the others that can be matched, since path has no
-      # variables so any change in fixed parts (not a lookalike) will be a
-      # mismatch with path.
-      info['lookalike'].each do |path|
-        cand = doc['paths'][path]
-        next unless (p <=> cand['parts']) == 0
-        cand['freq'] = cand.fetch('freq', 0) + 1
+  begin
+    # Expect one path per line with nothing else. Query is allowed and ignored.
+    f = File.new(paths_name, 'rt')
+    f.each_line do |line|
+      p = ServerPath.new(split_path(line))
+      doc['paths'].each_value do |info|
+        next unless (p <=> info['parts']).zero?
+        info['freq'] = info.fetch('freq', 0) + 1
+        # Lookalikes are the others that can be matched, since path has no
+        # variables so any change in fixed parts (not a lookalike) will be a
+        # mismatch with path.
+        info['lookalike'].each do |path|
+          cand = doc['paths'][path]
+          next unless (p <=> cand['parts']).zero?
+          cand['freq'] = cand.fetch('freq', 0) + 1
+        end
+        break
       end
-      break
     end
+    f.close
+  rescue Errno::ENOENT
+    return aargh("Could not read path log file: #{paths_name}", 4)
+  rescue NoMethodError
+    return aargh('Is input file an output of openapi-processpaths?', 5)
+  rescue StandardError => e
+    return aargh(e.to_s, 6)
   end
-  f.close
-rescue Errno::ENOENT => e
-  aargh("Could not read path log file: #{fn}", 4)
-rescue NoMethodError
-  aargh('Is input file an output of openapi-processpaths?', 5)
-rescue StandardError => e
-  aargh(e.to_s, 6)
-end
 
-output = env(:out)
-if output.empty?
-  output = $stdout
-else
-  begin
-    output = File.open(output, 'w')
-  rescue StandardError
-    aargh("Failed to open for writing: #{output}", 7)
-  end
+  dump_result(output_name, YAML.dump(doc), 3)
 end
 
-case env(:format)
-when 'JSON' then output.puts JSON.generate(doc)
-when 'YAML' then output.puts YAML.dump(doc)
-end
-output.close
+exit(main) if (defined? $unit_test).nil?

data/bin/openapi-generate

@@ -0,0 +1,59 @@
+#!/usr/bin/env ruby
+# frozen_string_literal: true
+
+# Copyright © 2021-2024 Ismo Kärkkäinen
+# Licensed under Universal Permissive License. See LICENSE.txt.
+
+require_relative '../lib/common'
+require_relative '../lib/loaders'
+require_relative '../lib/gen'
+require_relative '../lib/generate'
+require 'optparse'
+require 'yaml'
+
+
+def main
+  input_name = nil
+  output_dir = nil
+
+  ENV['POSIXLY_CORRECT'] = '1'
+  parser = OptionParser.new do |opts|
+    opts.summary_indent = '  '
+    opts.summary_width = 26
+    opts.banner = 'Usage: openapi-generate [options] generator-names...'
+    opts.separator ''
+    opts.separator 'Options:'
+    opts.on('-i', '--input FILE', 'Read processed API from FILE, not stdin.') do |f|
+      input_name = f
+    end
+    opts.on('-o', '--outdir DIR', 'Output directory.') do |d|
+      output_dir = d
+    end
+    opts.on('-h', '--help', 'Print this help and exit.') do
+      $stdout.puts %(#{opts}
+Loads API document in OpenAPI format and generator names. Built-in generator
+loaders accept the following:
+#{Loaders.document.strip}
+
+During load each generator can add and modify tasks via Gen module:
+#{Gen.document.strip}
+
+After all generators have loaded succesfully, tasks are run.
+)
+      exit 0
+    end
+  end
+  parser.parse!
+
+  return aargh('Generator names must be given.', 1) if ARGV.empty?
+
+  a = load_source(input_name)
+  return 2 if a.nil?
+  return aargh("Not a directory: #{output_dir}", 3) unless File.directory?(output_dir)
+  gen = Generator.new(a, input_name, output_dir)
+  ec = gen.load(ARGV)
+  return ec unless ec.zero?
+  gen.run
+end
+
+exit(main) if defined?($unit_test).nil?

data/bin/openapi-merge

@@ -1,63 +1,14 @@
 #!/usr/bin/env ruby
 # frozen_string_literal: true
 
-# Copyright © 2021 Ismo Kärkkäinen
+# Copyright © 2021-2024 Ismo Kärkkäinen
 # Licensed under Universal Permissive License. See LICENSE.txt.
 
-require_relative '../lib/common.rb'
+require_relative '../lib/common'
 require 'optparse'
 require 'yaml'
-require 'json'
 require 'set'
 
-
-default_env(:out, '')
-default_env(:format, 'YAML')
-default_env(:prune, true);
-
-ENV['POSIXLY_CORRECT'] = '1'
-parser = OptionParser.new do |opts|
-  opts.summary_indent = '  '
-  opts.summary_width = 26
-  opts.banner = 'Usage: openapi-merge [options] sources...'
-  opts.separator ''
-  opts.separator 'Options (equivalent environment variable and value in parentheses):'
-  opts.on('-o', '--output FILE', 'Output result to FILE, not stdout (OUT=FILE).') do |f|
-    env(:out, f)
-  end
-  opts.on('-k', '--keep', 'Keep all unreferenced objects under components.') do
-    env(:prune, false)
-  end
-  opts.on('-p', '--prune', 'Prune all unreferenced objects under components (default).') do
-    env(:prune, true)
-  end
-  opts.on('--yaml', 'Output format is YAML (default).') do
-    env(:format, 'YAML')
-  end
-  opts.on('--json', 'Output format is JSON.') do
-    env(:format, 'JSON')
-  end
-  opts.on('-h', '--help', 'Print this help and exit.') do
-    $stdout.puts %(#{opts}
-
-Source files are combined to form one API specification document. Sources are
-allowed only to append to the merged document, not re-define anything in it.
-)
-    exit 0
-  end
-end
-parser.parse!
-
-aargh("Format neither JSON nor YAML: #{env(:format)}", 1) unless %w[JSON YAML].include? env(:format)
-
-def read_source(filename)
-  YAML.safe_load(File.read(filename))
-rescue Errno::ENOENT => e
-  aargh("Could not read #{filename}", 2)
-rescue StandardError => e
-  aargh(e.to_s, 3)
-end
-
 def raise_se(message)
   raise StandardError, message
 end
@@ -77,12 +28,12 @@ end
 
 def add_undefined(merged, incoming, filename, path, max_depths)
   incoming.each_pair do |key, value|
-    unless merged.has_key? key
+    unless merged.key? key
       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.class == value.class
+    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
@@ -97,22 +48,6 @@ def add_undefined(merged, incoming, filename, path, max_depths)
       raise_se "Re-definition of #{key} #{path_combo(path)} in #{filename}"
     end
   end
-rescue StandardError => e
-  aargh(e.to_s, 3)
-end
-
-max_depths = Hash.new(0)
-max_depths['openapi'] = 1
-max_depths['info'] = 1
-max_depths['servers'] = 1
-max_depths['paths'] = 2 # Allows get, post, options, etc. from different files.
-max_depths['webhooks'] = 2
-max_depths['components'] = 2
-max_depths['security'] = 1
-max_depths['tags'] = 1
-merged = {}
-ARGV.each do |filename|
-  add_undefined(merged, read_source(filename), filename, [], max_depths)
 end
 
 def gather_refs(doc, found)
@@ -129,7 +64,7 @@ def gather_refs(doc, found)
   end
 end
 
-if env(:prune)
+def prune(merged)
   prev_refs = Set.new
   loop do # May have references from deleted so repeat until nothing deleted.
     refs = Set.new
@@ -153,7 +88,7 @@ if env(:prune)
       sub = used
       p.each_index do |k|
         if k + 1 < p.size
-          sub[p[k]] = {} unless sub.has_key? p[k]
+          sub[p[k]] = {} unless sub.key? p[k]
           sub = sub[p[k]]
         else
           sub[p[k]] = item
@@ -166,19 +101,58 @@ if env(:prune)
   end
 end
 
-output = env(:out)
-if output.empty?
-  output = $stdout
-else
-  begin
-    output = File.open(output, 'w')
-  rescue StandardError
-    aargh("Failed to open for writing: #{output}", 1)
+def main
+  output_file = nil
+  keep = false
+
+  ENV['POSIXLY_CORRECT'] = '1'
+  parser = OptionParser.new do |opts|
+    opts.summary_indent = '  '
+    opts.summary_width = 26
+    opts.banner = 'Usage: openapi-merge [options] sources...'
+    opts.separator ''
+    opts.separator 'Options:'
+    opts.on('-o', '--output FILE', 'Output result to FILE, not stdout.') do |f|
+      output_file = f
+    end
+    opts.on('-k', '--keep', 'Keep all unreferenced objects under components.') do
+      keep = true
+    end
+    opts.on('-p', '--prune', 'Prune all unreferenced objects under components (default).') do
+      keep = false
+    end
+    opts.on('-h', '--help', 'Print this help and exit.') do
+      $stdout.puts %(#{opts}
+
+Source files are combined to form one API specification document. Sources are
+allowed only to append to the merged document, not re-define anything in it.
+)
+      exit 0
+    end
   end
-end
+  parser.parse!
+
+  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
+  merged = {}
+  ARGV.each do |filename|
+    s = load_source(filename)
+    return 2 if s.nil?
+    add_undefined(merged, s, filename, [], max_depths)
+  rescue StandardError => e
+    return aargh(e.to_s, 4)
+  end
+
+  prune(merged) unless keep
 
-case env(:format)
-when 'JSON' then output.puts JSON.generate(merged)
-when 'YAML' then output.puts YAML.dump(merged)
+  dump_result(output_file, YAML.dump(merged), 3)
 end
-output.close
+
+exit(main) if (defined? $unit_test).nil?

data/bin/openapi-processpaths

@@ -1,111 +1,84 @@
 #!/usr/bin/env ruby
 # frozen_string_literal: true
 
-# Copyright © 2021 Ismo Kärkkäinen
+# Copyright © 2021-2024 Ismo Kärkkäinen
 # Licensed under Universal Permissive License. See LICENSE.txt.
 
-require_relative '../lib/common.rb'
+require_relative '../lib/common'
 require 'optparse'
 require 'yaml'
-require 'json'
 
 
-default_env(:in, '')
-default_env(:out, '')
-default_env(:format, 'YAML')
-default_env(:error, true)
+def main
+  input_name = nil
+  output_name = nil
+  error = true
 
-parser = OptionParser.new do |opts|
-  opts.summary_indent = '  '
-  opts.summary_width = 24
-  opts.banner = 'Usage: openapi-processpaths [options]'
-  opts.separator ''
-  opts.separator 'Options (equivalent environment variable and value in parentheses):'
-  opts.on('-i', '--input FILE', 'Read source from FILE, not stdin (IN=FILE).') do |f|
-    env(:in, f)
-  end
-  opts.on('-o', '--output FILE', 'Output result to FILE, not stdout (OUT=FILE).') do |f|
-    env(:out, f)
-  end
-  opts.on('--warn', 'Only warn of paths with same fixed parts (ERROR=0).') do
-    env(:error, false)
-  end
-  opts.on('--yaml', 'Output format is YAML (default) (FORMAT=YAML).') do
-    env(:format, 'YAML')
-  end
-  opts.on('--json', 'Output format is JSON. (FORMAT=JSON)') do
-    env(:format, 'JSON')
-  end
-  opts.on('-h', '--help', 'Print this help and exit.') do
-    $stdout.puts %(#{opts}
+  parser = OptionParser.new do |opts|
+    opts.summary_indent = '  '
+    opts.summary_width = 24
+    opts.banner = 'Usage: openapi-processpaths [options]'
+    opts.separator ''
+    opts.separator 'Options:'
+    opts.on('-i', '--input FILE', 'Read source from FILE, not stdin.') do |f|
+      input_name = f
+    end
+    opts.on('-o', '--output FILE', 'Output result to FILE, not stdout.') do |f|
+      output_name = f
+    end
+    opts.on('--warn', 'Only warn of paths with same fixed parts.') do
+      error = false
+    end
+    opts.on('-h', '--help', 'Print this help and exit.') do
+      $stdout.puts %(#{opts}
 
 Processes API specification document path objects into form that is expected by
 later stage tools. Checks for paths that may be ambiguous.
 )
-    exit 0
+      exit 0
+    end
   end
-end
-parser.parse!
+  parser.parse!
 
-aargh("Format neither JSON nor YAML: #{env(:format)}", 1) unless %w[JSON YAML].include? env(:format)
-
-def read_source(filename)
-  YAML.safe_load(filename.empty? ? $stdin : File.read(filename))
-rescue Errno::ENOENT => e
-  aargh("Could not read #{filename.empty? ? 'stdin' : filename}", 2)
-rescue StandardError => e
-  aargh(e.to_s, 3)
-end
-doc = read_source(env(:in))
+  doc = load_source(input_name)
+  return 2 if doc.nil?
 
-processed = {}
-doc.fetch('paths', {}).each_pair do |path, value|
-  parts = split_path(path, true)
-  processed[path] = {
-    'parts' => parts,
-    'orig' => value,
-    'lookalike' => [],
-    path: ServerPath.new(parts)
-  }
-end
-
-# Find lookalike sets.
-lookalikes = false
-paths = processed.keys.sort
-paths.each_index do |k|
-  pk = paths[k]
-  a = processed[pk]
-  (0...k).each do |n|
-    pn = paths[n]
-    b = processed[pn]
-    next unless (a[:path].compare(b[:path])) == 0
-    a['lookalike'].push pn
-    b['lookalike'].push pk
-    $stderr.puts("Similar: #{pn} #{pk}")
-    lookalikes = true
+  processed = {}
+  doc.fetch('paths', {}).each_pair do |path, value|
+    parts = split_path(path, true)
+    processed[path] = {
+      'parts' => parts,
+      'orig' => value,
+      'lookalike' => [],
+      path: ServerPath.new(parts)
+    }
   end
-end
-aargh('Similar paths found.', 7) if lookalikes && env(:error)
 
-# Clean-up temporary fields.
-processed.each_value do |v|
-  v.keys.each { |k| v.delete(k) if k.is_a? Symbol }
-end
-doc['paths'] = processed
+  # Find lookalike sets.
+  lookalikes = false
+  paths = processed.keys.sort!
+  paths.size.times do |k|
+    pk = paths[k]
+    a = processed[pk]
+    k.times do |n|
+      pn = paths[n]
+      b = processed[pn]
+      next unless a[:path].compare(b[:path]).zero?
+      a['lookalike'].push pn
+      b['lookalike'].push pk
+      $stderr.puts("Similar: #{pn} #{pk}")
+      lookalikes = true
+    end
+  end
+  return aargh('Similar paths found.', 4) if lookalikes && error
 
-output = env(:out)
-if output.empty?
-  output = $stdout
-else
-  begin
-    output = File.open(output, 'w')
-  rescue StandardError
-    aargh("Failed to open for writing: #{output}", 6)
+  # Remove temporary fields.
+  processed.each_value do |v|
+    v.keys.each { |k| v.delete(k) if k.is_a? Symbol }
   end
-end
+  doc['paths'] = processed
 
-case env(:format)
-when 'JSON' then output.puts JSON.generate(doc)
-when 'YAML' then output.puts YAML.dump(doc)
+  dump_result(output_name, YAML.dump(doc), 3)
 end
-output.close
+
+exit(main) if (defined? $unit_test).nil?