openapi-sourcetools 0.4.2 → 0.5.0

data/lib/common.rb

@@ -1,25 +1,33 @@
 # frozen_string_literal: true
 
-def aargh(message, exit_code = nil)
+# Copyright © 2021-2024 Ismo Kärkkäinen
+# Licensed under Universal Permissive License. See LICENSE.txt.
+
+require 'pathname'
+
+
+def aargh(message, return_value = nil)
+  message = message.map(&:to_s).join("\n") if message.is_a? Array
   $stderr.puts message
-  exit exit_code unless exit_code.nil?
+  return_value
 end
 
-def env(var, value = nil)
-  k = var.to_s.upcase
-  ENV[k] = { false => '0', true => '1' }.fetch(value, value) unless value.nil?
-  v = ENV.fetch(k, nil)
-  case v
-  when '0' then false
-  when '1' then true
-  else
-    v
+def bury(doc, path, value)
+  (path.size - 1).times do |k|
+    p = path[k]
+    doc[p] = {} unless doc.key?(p)
+    doc = doc[p]
   end
+  doc[path.last] = value
 end
 
-def default_env(var, value)
-  v = env(var)
-  env(var, value) if v.nil?
+module Output
+  attr_reader :count
+
+  def put(message)
+    aargh(message)
+    count += 1
+  end
 end
 
 def split_path(p, spec = false)
@@ -37,32 +45,50 @@ def split_path(p, spec = false)
   parts
 end
 
+def load_source(input)
+  YAML.safe_load(input.nil? ? $stdin : File.read(input))
+rescue Errno::ENOENT
+  aargh "Could not load #{input || 'stdin'}"
+rescue StandardError => e
+  aargh "#{e}\nFailed to read #{input || 'stdin'}"
+end
+
+def dump_result(output, doc, error_return)
+  if output.nil?
+    $stdout.puts doc
+  else
+    fp = Pathname.new output
+    fp.open('w') do |f|
+      f.puts doc
+    end
+  end
+  0
+rescue StandardError => e
+  aargh([ e, "Failed to write output: #{output || 'stdout'}" ], error_return)
+end
+
 ServerPath = Struct.new(:parts) do
-  def <=>(p) # Variables are after fixed strings.
-    pp = p.is_a?(Array) ? p : p.parts
+  # Variables are after fixed strings.
+  def <=>(other)
+    pp = other.is_a?(Array) ? other : other.parts
     parts.each_index do |k|
       return 1 if pp.size <= k # Longer comes after shorter.
       pk = parts[k]
       ppk = pp[k]
       if pk.is_a? String
-        if ppk.is_a? String
-          c = pk <=> ppk
-        else
-          return -1
-        end
+        return -1 unless ppk.is_a? String
+        c = pk <=> ppk
       else
-        if ppk.is_a? String
-          return 1
-        else
-          c = pk.fetch('var', '') <=> ppk.fetch('var', '')
-        end
+        return 1 if ppk.is_a? String
+        c = pk.fetch('var', '') <=> ppk.fetch('var', '')
       end
       return c unless c.zero?
     end
     (parts.size < pp.size) ? -1 : 0
   end
 
-  def compare(p, range = nil) # Not fit for sorting. Variable equals anything.
+  # Not fit for sorting. Variable equals anything.
+  def compare(p, range = nil)
     pp = p.is_a?(Array) ? p : p.parts
     if range.nil?
       range = 0...parts.size

metadata

@@ -1,21 +1,26 @@
 --- !ruby/object:Gem::Specification
 name: openapi-sourcetools
 version: !ruby/object:Gem::Version
-  version: 0.4.2
+  version: 0.5.0
 platform: ruby
 authors:
 - Ismo Kärkkäinen
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2021-10-15 00:00:00.000000000 Z
+date: 2024-05-17 00:00:00.000000000 Z
 dependencies: []
 description: |2
 
-  Tools for generating source code from API specification in OpenAPI format.
+  Tools for handling API specification in OpenAPI format. Replacement of
+  duplicate definitions with references. Other checks. Does not validate
+  the document against specification.
 email: ismokarkkainen@icloud.com
 executables:
-- openapi-generatecode
+- openapi-addheaders
+- openapi-addresponses
+- openapi-addschemas
+- openapi-checkschemas
 - openapi-frequencies
 - openapi-merge
 - openapi-processpaths
@@ -23,15 +28,20 @@ extensions: []
 extra_rdoc_files: []
 files:
 - LICENSE.txt
+- bin/openapi-addheaders
+- bin/openapi-addresponses
+- bin/openapi-addschemas
+- bin/openapi-checkschemas
 - bin/openapi-frequencies
-- bin/openapi-generatecode
 - bin/openapi-merge
 - bin/openapi-processpaths
+- lib/apiobjects.rb
 - lib/common.rb
 homepage: https://xn--ismo-krkkinen-gfbd.fi/openapi-sourcetools/index.html
 licenses:
 - UPL-1.0
-metadata: {}
+metadata:
+  rubygems_mfa_required: 'true'
 post_install_message:
 rdoc_options: []
 require_paths:
@@ -40,14 +50,14 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: '0'
+      version: 3.0.0
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.1.2
+rubygems_version: 3.2.33
 signing_key:
 specification_version: 4
 summary: Tools for creating source code from API specification.

data/bin/openapi-generatecode

@@ -1,128 +0,0 @@
-#!/usr/bin/env ruby
-# frozen_string_literal: true
-
-# Copyright © 2021 Ismo Kärkkäinen
-# Licensed under Universal Permissive License. See LICENSE.txt.
-
-require_relative '../lib/common.rb'
-require 'optparse'
-require 'yaml'
-require 'erb'
-
-
-default_env(:out, '')
-default_env(:in, '')
-default_env(:template, '')
-
-ENV['POSIXLY_CORRECT'] = '1'
-parser = OptionParser.new do |opts|
-  opts.summary_indent = '  '
-  opts.summary_width = 26
-  opts.banner = 'Usage: openapi-generatecode [options] [additions...]'
-  opts.separator ''
-  opts.separator 'Options (equivalent environment variable and value in parentheses):'
-  opts.on('-i', '--input FILE', 'Read processed API 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('-t', '--template FILE', 'Read template from FILE (TEMPLATE=FILE).') do |f|
-    env(:template, f)
-  end
-  opts.on('-h', '--help', 'Print this help and exit.') do
-    $stdout.puts %(#{opts}
-
-Loads ERB template and optional additions to a context along with the processed
-API document and produces the template result.
-)
-    exit 0
-  end
-end
-parser.parse!
-
-aargh('Template file name must be given.', 1) if env(:template).empty?
-
-def load_content(name)
-  name.empty? ? $stdin.read : File.read(name)
-rescue Errno::ENOENT
-  aargh("Could not load #{name || 'stdin'}", 2)
-rescue StandardError => e
-  aargh("#{e}\nFailed to read #{name || 'stdin'}", 2)
-end
-
-class Generator
-  attr_accessor :addition, :order, :full_name_order, :template, :document
-
-  def initialize(document_content, template_content)
-    @addition = Hash.new
-    @order = []
-    @full_name_order = []
-    @document = document_content
-    @template = template_content
-  end
-
-  def get_binding
-    binding
-  end
-
-  def add(name, content, strip_suffix)
-    @full_name_order.push({ filename: name, contents: content })
-    name = File.basename(name)
-    @order.push name
-    if strip_suffix
-      idx = name.rindex('.')
-      name = name.slice(0, idx) unless idx.nil?
-    end
-    @addition[name] = content
-  end
-end
-t = load_content(env(:template))
-d = load_content(env(:in))
-begin
-  $generator = Generator.new(YAML.safe_load(d), t)
-rescue StandardError => e
-  aargh('Failed to parse API document.', 3)
-end
-
-ARGV.each do |name|
-  aargh('Addition file name is empty.', 1) if name.empty?
-  if name.end_with? '.rb'
-    begin
-      require File.absolute_path(name)
-    rescue SyntaxError => e
-      aargh("Syntax error in addition #{name}: #{e.to_s}", 4)
-    rescue StandardError => e
-      aargh("Failed to require addition #{name}: #{e.to_s}", 5)
-    end
-  else
-    c = load_content(name)
-    begin
-      d = YAML.safe_load(c)
-    rescue StandardError
-      d = c
-    end
-    $generator.add(name, d, name.upcase.end_with?('.YAML') || name.upcase.end_with?('.JSON'))
-  end
-end
-
-begin
-  out = ERB.new($generator.template).result($generator.get_binding)
-rescue SyntaxError => e
-  aargh("Template syntax error: #{e.to_s}", 6)
-rescue StandardError => e
-  aargh("Template error: #{e.to_s}", 7)
-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)
-  end
-end
-output.write(out)
-output.close