openapi-sourcetools 0.6.0 → 0.7.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 9320a1d6d4202c453fb7065f00bc534206b1c780560ae443cd30293f27827595
-  data.tar.gz: af45eabe9a8f392c705398957cf276acb39923655207ffda12ee8d93e1c072a0
+  metadata.gz: 211083083a2a3c53321234416ffff41bd1d00320a5ebbdab3ccdcd49576653b3
+  data.tar.gz: 34535443138a6308869974d62e79321d9ec9dbb3f46434c19d571075044751e1
 SHA512:
-  metadata.gz: 1f81cae3adb06d42d3bf5361615a0a21ca42346d08b1f8b83462116668d2ad61ec05ac707e723d910bbe55eb29699129ba13570b44504581e92597242ab3d810
-  data.tar.gz: 656959f866321cd68814fed2ef1c9121fe1db36674cb7fbd49f9f2a652e5f43a29d6b1d491a2197278577084d1328e01f99fd1eff8fca1c7ef7d6299ed512b17
+  metadata.gz: 3c4a5361e25a1cf7903b6038a32f4a94cf42579c0c4fefb21f885fae996c219a02eef322fd91d694dfe0ff668314685b990d3128ca7e6a98c3f30660639494d0
+  data.tar.gz: a563ba480140037e0ef91dbdc89fb62a2175954897726717976760879a74bf8284d673d3a259ce338b7b7493c84fd6c1f5cf4246b90ee42ae1959d3b31c7b21f

data/bin/openapi-addheaders

@@ -67,7 +67,7 @@ replaces the original with reference.
   replace_headers(doc.fetch('paths', {}), components)
   bury(doc, path, components.items) unless components.items.empty?
 
-  dump_result(output_name, YAML.dump(doc, line_width: 1_000_000), 3)
+  dump_result(output_name, doc, 3)
 end
 
 exit(main) if (defined? $unit_test).nil?

data/bin/openapi-addparameters

@@ -66,7 +66,7 @@ replaces the original with reference.
   replace_parameters(doc.fetch('paths', {}), components)
   bury(doc, path, components.items) unless components.items.empty?
 
-  dump_result(output_name, YAML.dump(doc, line_width: 1_000_000), 3)
+  dump_result(output_name, doc, 3)
 end
 
 exit(main) if defined?($unit_test).nil?

data/bin/openapi-addresponses

@@ -66,7 +66,7 @@ replaces the original with reference.
   replace_responses(doc.fetch('paths', {}), components)
   bury(doc, path, components.items) unless components.items.empty?
 
-  dump_result(output_name, YAML.dump(doc, line_width: 1_000_000), 3)
+  dump_result(output_name, doc, 3)
 end
 
 exit(main) if (defined? $unit_test).nil?

data/bin/openapi-addschemas

@@ -98,7 +98,7 @@ Loads API document in OpenAPI format and adds a schema for each inline type.
   return 4 unless replace_inlines(doc, components)
   bury(doc, path, components.items) unless components.items.empty?
 
-  dump_result(output_name, YAML.dump(doc, line_width: 1_000_000), 3)
+  dump_result(output_name, doc, 3)
 end
 
 exit(main) if (defined? $unit_test).nil?

data/bin/openapi-generate

@@ -16,7 +16,6 @@ def main
   input_name = nil
   output_dir = nil
 
-  ENV['POSIXLY_CORRECT'] = '1'
   parser = OptionParser.new do |opts|
     opts.summary_indent = '  '
     opts.summary_width = 26
@@ -32,7 +31,7 @@ def main
     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:
+or additional document loaders accept the following:
 #{Loaders.document.strip}
 
 During load each generator can add and modify tasks via Gen module:
@@ -43,7 +42,7 @@ After all generators have loaded succesfully, tasks are run.
       exit 0
     end
   end
-  parser.parse!
+  parser.order!
 
   return aargh('Generator names must be given.', 1) if ARGV.empty?
 

data/bin/openapi-modifypaths

@@ -0,0 +1,123 @@
+#!/usr/bin/env ruby
+# frozen_string_literal: true
+
+# Copyright © 2024 Ismo Kärkkäinen
+# Licensed under Universal Permissive License. See LICENSE.txt.
+
+require_relative '../lib/common'
+require 'optparse'
+require 'yaml'
+
+def path2pieces(s)
+  s.split('/').reject { |p| p.empty? }
+end
+
+def pieces2path(p)
+  "/#{p.join('/')}"
+end
+
+def add(s, path)
+  s.empty? ? path : (s + path)
+end
+
+def remove_complete_prefix(prefix, path)
+  return nil if prefix.empty? || path.size < prefix.size
+  prefix.size.times do |idx|
+    return nil unless prefix[idx] == path[idx]
+  end
+  path[prefix.size...path.size]
+end
+
+def remove(s, path)
+  remove_complete_prefix(s, path) || path
+end
+
+def replace(o, s, path)
+  p = remove_complete_prefix(o, path)
+  p.nil? ? path : (s + p)
+end
+
+def add_op(s)
+  s = path2pieces(s)
+  Proc.new { |path| add(s, path) }
+end
+
+def remove_op(s)
+  s = path2pieces(s)
+  Proc.new { |path| remove(s, path) }
+end
+
+def replace_op(orig, s)
+  o = path2pieces(orig)
+  s = path2pieces(s)
+  Proc.new { |path| replace(o, s, path) }
+end
+
+def perform_operations(paths, operations)
+  out = {}
+  paths.each do |path, value|
+    operations.each do |op|
+      path = pieces2path(op.call(path2pieces(path)))
+    end
+    out[path] = value
+  end
+  out
+end
+
+def main
+  input_name = nil
+  output_name = nil
+  operations = []
+  orig = nil
+
+  parser = OptionParser.new do |opts|
+    opts.summary_indent = '  '
+    opts.summary_width = 26
+    opts.banner = 'Usage: openapi-modifypaths [options]'
+    opts.separator ''
+    opts.separator 'Options:'
+    opts.on('-i', '--input FILE', 'Read API spec from FILE, not stdin.') do |f|
+      exit(aargh("Expected string to replace PREFIX.", 1)) unless orig.nil?
+      input_name = f
+    end
+    opts.on('-o', '--output FILE', 'Output to FILE, not stdout.') do |f|
+      exit(aargh("Expected string to replace PREFIX.", 1)) unless orig.nil?
+      output_name = f
+    end
+    opts.on('-a', '--add STR', 'Add prefix STR to all paths.') do |s|
+      exit(aargh("Expected string to replace PREFIX.", 1)) unless orig.nil?
+      operations.push(add_op(s))
+    end
+    opts.on('-d', '--delete PREFIX', 'Delete PREFIX when present.') do |s|
+      exit(aargh("Expected string to replace PREFIX.", 1)) unless orig.nil?
+      operations.push(remove_op(s))
+    end
+    opts.on('-r', '--replace PREFIX STR', 'Replace PREFIX with STR when present.') do |s|
+      exit(aargh('Empty string to replace.', 1)) if s.empty?
+      orig = s
+    end
+    opts.on('-h', '--help', 'Print this help and exit.') do
+      $stdout.puts %(#{opts}
+
+Loads API document in OpenAPI format and changes paths according to options.
+STR and PREFIX are expected to be parts of a path surrounded by /.
+)
+      exit 0
+    end
+  end
+  parser.order! do |s|
+    exit(aargh("String without option: #{s}", 1)) if orig.nil?
+    operations.push(replace_op(orig, s))
+    orig = nil
+  end
+
+  doc = load_source(input_name)
+  return 2 if doc.nil?
+
+  p = perform_operations(doc.fetch('paths', {}), operations)
+  doc['paths'] = p unless p.empty?
+
+  dump_result(output_name, doc, 3)
+end
+
+main if defined?($unit_test).nil?

data/lib/common.rb

@@ -54,6 +54,7 @@ rescue StandardError => e
 end
 
 def dump_result(output, doc, error_return)
+  doc = YAML.dump(doc, line_width: 1_000_000) unless doc.is_a?(String)
   if output.nil?
     $stdout.puts doc
   else

data/lib/docs.rb

@@ -0,0 +1,33 @@
+# frozen_string_literal: true
+
+# Copyright © 2024 Ismo Kärkkäinen
+# Licensed under Universal Permissive License. See LICENSE.txt.
+
+require_relative 'common'
+
+
+class Docs
+  attr_reader :docs
+
+  def initialize
+    @docs = {}
+  end
+
+  def method_missing(method_name, *args)
+    name = method_name.to_s
+    if name.end_with?('=')
+      name = name[0...(name.size - 1)]
+      super unless @docs.key?(name)
+      @docs[name] = args.first
+      return args.first
+    end
+    super unless @docs.key?(name)
+    @docs[name]
+  end
+
+  def add(name, content)
+    return false if docs.key?(name)
+    @docs[name] = content
+    true
+  end
+end

data/lib/gen.rb

@@ -5,56 +5,73 @@
 
 require_relative 'task'
 require_relative 'helper'
+require_relative 'docs'
+require_relative 'output'
 
 
 module Gen
-  def self.mod_attr_reader(symbol, docstr = nil)
-    attr_reader(symbol)
-    module_function(symbol)
+  def self.add_doc(symbol, docstr)
     return if docstr.nil?
-    @docsrc = [] unless Gen.instance_variable_defined?('@docsrc')
+    @docsrc = [] unless instance_variable_defined?('@docsrc')
     @docsrc.push("- #{symbol.to_s} : #{docstr}")
   end
 
-  def self.mod_attr_accessor(symbol, docstr = nil)
+  def self.read_attr(symbol, default)
+    return if symbol.nil?
+    attr_reader(symbol)
+    module_function(symbol)
+    instance_variable_set("@#{symbol.to_s}", default)
+  end
+
+  def self.mod_attr2_reader(symbol, symbol2, docstr = nil, default = nil)
+    read_attr(symbol, default)
+    read_attr(symbol2, default)
+    add_doc(symbol, docstr)
+  end
+
+  def self.mod_attr_reader(symbol, docstr = nil, default = nil)
+    mod_attr2_reader(symbol, nil, docstr, default)
+  end
+
+  def self.rw_attr(symbol, default)
     attr_accessor(symbol)
     module_function(symbol)
     s = symbol.to_s
     module_function((s + '=').to_sym)
-    return if docstr.nil?
-    @docsrc = [] unless Gen.instance_variable_defined?('@docsrc')
-    @docsrc.push("- #{s} : #{docstr}")
+    instance_variable_set("@#{s}", default)
+  end
+
+  def self.mod_attr2_accessor(symbol, symbol2, docstr = nil, default = nil)
+    rw_attr(symbol, default)
+    rw_attr(symbol2, default) unless symbol2.nil?
+    add_doc(symbol, docstr)
+  end
+
+  def self.mod_attr_accessor(symbol, docstr = nil, default = nil)
+    mod_attr2_accessor(symbol, nil, docstr, default)
   end
 
   mod_attr_reader :doc, 'OpenAPI document.'
   mod_attr_reader :outdir, 'Output directory name.'
+  mod_attr_reader :d, 'Other documents object.', Docs.new
   mod_attr_accessor :in_name, 'OpenAPI document name, nil if stdin.'
   mod_attr_accessor :in_basename, 'OpenAPI document basename, nil if stdin.'
-  mod_attr_accessor :tasks, 'Tasks array.'
-  mod_attr_accessor :g, 'Hash for storing values visible to all tasks.'
+  mod_attr_accessor :tasks, 'Tasks array.', []
+  mod_attr_accessor :g, 'Hash for storing values visible to all tasks.', {}
   mod_attr_accessor :a, 'Intended for instance with defined attributes.'
   mod_attr_accessor :h, 'Instance of class with helper methods.'
-  mod_attr_accessor :t, 'Current task instance.'
+  mod_attr2_accessor :task, :t, 'Current task instance.'
   mod_attr_accessor :task_index, 'Current task index.'
-  mod_attr_accessor :loaders, 'Array of generator loader methods.'
+  mod_attr_accessor :loaders, 'Array of generator loader methods.', []
+  mod_attr2_accessor :output, :o, 'Output-related methods.', Output.new
 
   def self.setup(document_content, input_name, output_directory)
     @doc = document_content
     @outdir = output_directory
-    if input_name.nil?
-      @in_name = nil
-      @in_basename = nil
-    else
+    unless input_name.nil?
       @in_name = File.basename(input_name)
       @in_basename = File.basename(input_name, '.*')
     end
-    @tasks = []
-    @g = {}
-    @a = nil
-    @h = nil
-    @t = nil
-    @task_index = nil
-    @loaders = []
     add_task(task: HelperTask.new)
   end
 

data/lib/generate.rb

@@ -8,6 +8,7 @@ require_relative 'common'
 require_relative 'loaders'
 require_relative 'gen'
 
+
 def executable_bits_on(mode)
   mode = mode.to_s(8).split('')
   mode.size.times do |k|

data/lib/helper.rb

@@ -10,7 +10,7 @@ class Helper
   attr_reader :doc, :parents
   attr_accessor :parent_parameters
 
-  # Stores the nearesh Hash for each Hash.
+  # Stores the nearest Hash for each Hash.
   def store_parents(obj, parent = nil)
     if obj.is_a?(Hash)
       @parents[obj.object_id] = parent
@@ -26,8 +26,6 @@ class Helper
 
   def initialize(doc)
     @doc = doc
-    # For each hash in doc, set parent?
-    # Build an object_id to parent object mapping and use parent method?
     @parents = {}
     store_parents(@doc)
   end

data/lib/loaders.rb

@@ -3,6 +3,9 @@
 # Copyright © 2024 Ismo Kärkkäinen
 # Licensed under Universal Permissive License. See LICENSE.txt.
 
+
+# Original loader functions. These are accessible via Gen.loaders. New loaders
+# should be added there.
 module Loaders
 
   GEM_PREFIX = 'gem:'
@@ -37,14 +40,56 @@ module Loaders
     true
   end
 
+  YAML_PREFIX = 'yaml:'
+  YAML_EXTS = [ '.yaml', '.yml' ]
+
+  def self.yaml_loader(name)
+    d = name.downcase
+    if d.start_with?(YAML_PREFIX)
+      name = name.slice(YAML_PREFIX.size...name.size)
+    else
+      return false if (YAML_EXTS.index { |s| d.end_with?(s) }).nil?
+    end
+    n, sep, f = name.partition(':')
+    raise StandardError, "No name given." if n.empty?
+    raise StandardError, "No filename given." if f.empty?
+    doc = YAML.safe_load(File.read(f))
+    raise StandardError, "#{name} #{n} exists already." unless Gen.d.add(n, doc)
+    true
+  rescue Errno::ENOENT
+    raise StandardError, "Not found: #{f}\n#{e.to_s}"
+  rescue Exception => e
+    raise StandardError, "Failed to read as YAML: #{f}\n#{e.to_s}"
+  end
+
+  BIN_PREFIX = 'bin:'
+
+  def self.bin_loader(name)
+    return false unless name.downcase.start_with?(BIN_PREFIX)
+    n, sep, f = name.slice(BIN_PREFIX.size...name.size).partition(':')
+    raise StandardError, "No name given." if n.empty?
+    raise StandardError, "No filename given." if f.empty?
+    doc = IO.binread(f)
+    raise StandardError, "#{name} #{n} exists already." unless Gen.d.add(n, doc)
+    true
+  rescue Errno::ENOENT
+    raise StandardError, "Not found: #{f}\n#{e.to_s}"
+  rescue Exception => e
+    raise StandardError, "Failed to read #{f}\n#{e.to_s}"
+  end
+
   def self.loaders
-    [ method(:gem_loader), method(:ruby_loader) ]
+    pre = @preloaders
+    [ method(:gem_loader), method(:ruby_loader), method(:yaml_loader), method(:bin_loader) ]
   end
 
   def self.document
     %(
 - #{Loaders::GEM_PREFIX}gem_name : requires the gem.
 - 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.
+- #{Loaders::BIN_PREFIX}name:filename : Loads binary file into Gen.d.name.
 )
   end
 

data/lib/output.rb

@@ -0,0 +1,58 @@
+# frozen_string_literal: true
+
+# Copyright © 2024 Ismo Kärkkäinen
+# Licensed under Universal Permissive License. See LICENSE.txt.
+
+require_relative 'task'
+
+
+class Output
+  # For indentation.
+  attr_accessor :indent_character, :indent_step
+  attr_accessor :tab, :tab_replaces_count
+  attr_accessor :last_indent
+
+  def initialize
+    @indent_character = ' '
+    @indent_step = 4
+    @tab = "\t"
+    @tab_replaces_count = 0
+    @last_indent = 0
+  end
+
+  def join(blocks, separator = "\n")
+    indented = []
+    blocks.flatten!
+    indent = 0
+    blocks.each do |block|
+      if block.nil?
+        indent = 0
+      elsif block.is_a?(Integer)
+        indent += block
+      elsif block.is_a?(TrueClass)
+        indent += @indent_step
+      elsif block.is_a?(FalseClass)
+        indent -= @indent_step
+      else
+        block = block.to_s unless block.is_a?(String)
+        if indent.zero?
+          indented.push(block)
+          next
+        end
+        if 0 < @tab_replaces_count
+          tabs = @tab * (indent / @tab_replaces_count)
+          chars = @indent_character * (indent % @tab_replaces_count)
+        else
+          tabs = ''
+          chars = @indent_character * indent
+        end
+        lines = block.lines(chomp: true)
+        lines.each do |line|
+          indented.push("#{tabs}#{chars}#{line}")
+        end
+      end
+    end
+    @last_indent = indent
+    indented.join(separator)
+  end
+end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: openapi-sourcetools
 version: !ruby/object:Gem::Version
-  version: 0.6.0
+  version: 0.7.0
 platform: ruby
 authors:
 - Ismo Kärkkäinen
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2024-07-17 00:00:00.000000000 Z
+date: 2024-08-07 00:00:00.000000000 Z
 dependencies: []
 description: |2
 
@@ -25,6 +25,7 @@ executables:
 - openapi-frequencies
 - openapi-generate
 - openapi-merge
+- openapi-modifypaths
 - openapi-processpaths
 extensions: []
 extra_rdoc_files: []
@@ -38,13 +39,16 @@ files:
 - bin/openapi-frequencies
 - bin/openapi-generate
 - bin/openapi-merge
+- bin/openapi-modifypaths
 - bin/openapi-processpaths
 - lib/apiobjects.rb
 - lib/common.rb
+- lib/docs.rb
 - lib/gen.rb
 - lib/generate.rb
 - lib/helper.rb
 - lib/loaders.rb
+- lib/output.rb
 - lib/task.rb
 homepage: https://xn--ismo-krkkinen-gfbd.fi/openapi-sourcetools/index.html
 licenses: