openapi-sourcetools 0.8.1 → 0.9.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 93117ebfa33920b762da40afe48264ead793574ad336628487d3cfb3b6019987
-  data.tar.gz: 67cb3400cd879b3625e58b72db11cfc860a87179d069ff341a6202391f8d61f5
+  metadata.gz: 44ff7d64b4781fdfbab07060f6faa294a8092e342530e6cde786e50ff8f69db1
+  data.tar.gz: 893e593407c4734e67c83bffe77a67bb55b2ecef3970620a416580fd33109437
 SHA512:
-  metadata.gz: af4681c719424375326d4149ede787f0d6a58d33ff28082d7c1f7b00db4b40186f6406bfe99707012aeae0ac03d4504fb14cd49b6e587f55d91c1f2cb353a3b3
-  data.tar.gz: f6c84c0a9e6b20040fefa9611c8abf211abc1fb65c6a3c3041ce1f96f3b3482fa1789eb2eb16460c5a1d892d56fd843164ae4d7dfb9c4cdb6e3a13f26977d323
+  metadata.gz: 741c12063a6d5df5d090f26b80c60a7810083537076573cb10f9ba5a3ca3afc8109ab6faa305707139c881a7efa1f478d7d0de562db67b44f93c0329ae8263e4
+  data.tar.gz: 9e1c2bc87442258d75517beb13f99c1e0b210b7074ee622db8057e1e4ebf17c253538ba52b893b0f148baa21188a306976a9783d778e92dd769caee6eb84aef6

data/bin/openapi-patterntests

@@ -0,0 +1,159 @@
+#!/usr/bin/env ruby
+# frozen_string_literal: true
+
+# Copyright © 2025 Ismo Kärkkäinen
+# Licensed under Universal Permissive License. See LICENSE.txt.
+
+require_relative '../lib/openapi/sourcetools/common'
+require 'optparse'
+include OpenAPISourceTools
+
+def key(item)
+  "#{item['pattern']}::#{item.fetch('minLength', 0)}::#{item.fetch('maxLength', 'inf')}"
+end
+
+def find_patterns(doc, pmm)
+  if doc.is_a?(Hash)
+    if doc.key?('pattern')
+      item = { 'pattern' => doc['pattern'] }
+      item['minLength'] = doc['minLength'] if doc.key?('minLength')
+      item['maxLength'] = doc['maxLength'] if doc.key?('maxLength')
+      pmm[key(doc)] = item
+      return
+    end
+    doc = doc.values
+  end
+  doc.each { |v| find_patterns(v, pmm) } if doc.is_a?(Array)
+end
+
+def pattern_list2hash(list)
+  pmms = {}
+  list.each { |item| pmms[key(item)] = item }
+  pmms
+end
+
+def add_strings(item)
+  passes = []
+  fails = []
+  min_len = item.fetch('minLength', 0)
+  fails.push('f' * (min_len - 1)) unless min_len.zero?
+  max_len = item['maxLength']
+  fails.push('f' * (max_len + 1)) unless max_len.nil?
+  # Fails within length limits require considering the pattern.
+  # All passes require considering the pattern.
+  item['pass'] = passes
+  item['fail'] = fails
+end
+
+def merge_arrays(current, past)
+  if current.is_a?(Array)
+    if past.is_a?(Array)
+      return current.concat(past)
+    end
+    current
+  elsif past.is_a?(Array)
+    past
+  else
+    false
+  end
+end
+
+def merge_existing(pmms, existing)
+  pmms.each do |k, v|
+    ex = existing[k]
+    next if ex.nil?
+    %w[pass fail].each do |arr|
+      m = merge_arrays(v[arr], ex[arr])
+      v[arr] = m.is_a?(Array) ? m.sort!.uniq : m
+    end
+    ex.each do |ek, ev|
+      v[ek] = ev unless v.key?(ek)
+    end
+  end
+end
+
+def add_removed(pmms, existing)
+  existing.each { |k, v| pmms[k] = v unless pmms.key?(k) }
+end
+
+def compare(a, b)
+  d = a['pattern'] <=> b['pattern']
+  return d unless d.zero?
+  d = a.fetch('minLength', 0) <=> b.fetch('minLength', 0)
+  return d unless d.zero?
+  a.fetch('maxLength', Float::INFINITY) <=> b.fetch('maxLength', Float::INFINITY)
+end
+
+def pattern_hash2list(pmms)
+  pmms.values.sort { |a, b| compare(a, b) }
+end
+
+def main
+  array_name = 'patterns'
+  input_name = nil
+  output_name = nil
+  source_tests = nil
+  keep = false
+  chain = []
+
+  parser = OptionParser.new do |opts|
+    opts.summary_indent = '  '
+    opts.summary_width = 20
+    opts.banner = 'Usage: openapi-patterntests [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
+    opts.on('-t', '--tests FILE', 'Read existing tests from FILE.') do |f|
+      source_tests = f
+    end
+    opts.on('-u', '--under STR', %(Top-level "#{array_name}" is under dot-separated keys.)) do |s|
+      chain = s.split('.').reject(&:empty?)
+    end
+    opts.on('-k', '--[no-]keep', "Keep missing test patterns, default = #{Common.yesno(keep)}.") do |b|
+      keep = b
+    end
+    opts.on('-h', '--help', 'Print this help and exit.') do
+      $stdout.puts %(#{opts}
+
+Loads API document in OpenAPI format, extracts string patterns, and outputs
+a YAML file that contains mapping from patterns to matching and not mathcing
+strings for testing generated code.
+)
+      exit 0
+    end
+  end
+  parser.order!
+
+  doc = Common.load_source(input_name)
+  return 2 if doc.nil?
+
+  if source_tests.nil?
+    ex = {}
+    pats = []
+  else
+    ex = Common.load_source(source_tests)
+    return 2 if ex.nil?
+    parent = chain.empty? ? ex : ex.dig(*chain)
+    return Common.aargh("Key chain #{chain.join('.')} not found in source tests.", 4) if parent.nil?
+    pats = parent[array_name] || []
+  end
+  chain.push(array_name)
+
+  existing = pattern_list2hash(pats)
+  pmms = {}
+  find_patterns(doc, pmms)
+  pmms.each_value { |item| add_strings(item) }
+  merge_existing(pmms, existing)
+  add_removed(pmms, existing) if keep
+  pats = pattern_hash2list(pmms)
+
+  Common.bury(ex, chain, pats)
+  Common.dump_result(output_name, ex, 3)
+end
+
+exit(main) if defined?($unit_test).nil?

data/lib/openapi/sourcetools/apiobjects.rb

@@ -187,5 +187,69 @@ module OpenAPISourceTools
       end
       out
     end
+
+    # Single server variable object.
+    class ServerVariableObject
+      include Comparable
+
+      attr_reader :name, :default, :enum
+
+      def initialize(name, variable_object)
+        @name = name
+        @default = variable_object['default']
+        @enum = (variable_object['enum'] || []).sort!
+      end
+
+      def <=>(other)
+        d = @name <=> other.name
+        return d unless d.zero?
+        d = @default <=> other.default
+        return d unless d.zero?
+        @enum <=> other.enum
+      end
+    end
+
+    # Single server object with variables.
+    class ServerObject
+      include Comparable
+
+      attr_reader :url, :variables
+
+      def initialize(server_object)
+        @url = server_object['url']
+        vs = server_object['variables'] || {}
+        @variables = vs.keys.sort!.map do |name|
+          obj = vs[name]
+          ServerVariableObject.new(name, obj)
+        end
+      end
+
+      def <=>(other)
+        d = @url <=> other.url
+        return d unless d.zero?
+        if @variables.nil? || other.variables.nil?
+          return -1 if @variables.nil?
+          return 1 if other.variables.nil?
+        end
+        @variables <=> other.variables
+      end
+    end
+
+    # Combines servers array with set identifier.
+    class ServerAlternatives
+      include Comparable
+
+      attr_reader :servers
+      attr_accessor :set_id
+
+      def initialize(server_objects)
+        @servers = server_objects.map { |so| ServerObject.new(so) }
+        @servers.sort!
+      end
+
+      def <=>(other)
+        @servers <=> other.servers
+      end
+    end
   end
 end

data/lib/openapi/sourcetools/helper.rb

@@ -76,6 +76,47 @@ module OpenAPISourceTools
       end
       uniqs.keys.sort!.map { |k| uniqs[k] }
     end
+
+    def response_codes(responses_object)
+      responses_object.keys.sort! do |a, b|
+        ad = a.downcase
+        bd = b.downcase
+        if ad == 'default'
+          1
+        elsif bd == 'default'
+          -1
+        else
+          ax = ad.end_with?('x')
+          bx = bd.end_with?('x')
+          if ax && bx || !ax && !bx
+            a <=> b # Both numbers or patterns.
+          else
+            ax ? 1 : -1
+          end
+        end
+      end
+    end
+
+    def response_code_condition(code, var: 'code', op_and: '&&', op_lte: '<=', op_eq: '==')
+      low = []
+      high = []
+      code.downcase.each_char do |c|
+        if c == 'x'
+          low.push('0')
+          high.push('9')
+        else
+          low.push(c)
+          high.push(c)
+        end
+      end
+      low = low.join
+      high = high.join
+      if low == high
+        "#{var} #{op_eq} #{low}"
+      else
+        "(#{low} #{op_lte} #{var}) #{op_and} (#{var} #{op_lte} #{high})"
+      end
+    end
   end
 
   # Task class to add an Helper instance to Gen.h, for convenience.

data/lib/openapi/sourcetools/output.rb

@@ -46,13 +46,15 @@ module OpenAPISourceTools
       indent = 0
       blocks.each do |block|
         if block.nil?
-          indent = 0
+          next
         elsif block.is_a?(Integer)
           indent += block
+          indent = 0 if indent.negative?
         elsif block.is_a?(TrueClass)
           indent += @config.indent_step
         elsif block.is_a?(FalseClass)
           indent -= @config.indent_step
+          indent = 0 if indent.negative?
         else
           block = block.to_s unless block.is_a?(String)
           if block.empty?

data/lib/openapi/sourcetools/version.rb

@@ -5,7 +5,7 @@
 
 module OpenAPISourceTools
   NAME = 'openapi-sourcetools'
-  VERSION = '0.8.1'
+  VERSION = '0.9.0'
 
   def self.info(separator = ': ')
     "#{NAME}#{separator}#{VERSION}"

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: openapi-sourcetools
 version: !ruby/object:Gem::Version
-  version: 0.8.1
+  version: 0.9.0
 platform: ruby
 authors:
 - Ismo Kärkkäinen
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2025-01-31 00:00:00.000000000 Z
+date: 2025-04-15 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: deep_merge
@@ -47,6 +47,7 @@ executables:
 - openapi-generate
 - openapi-merge
 - openapi-modifypaths
+- openapi-patterntests
 - openapi-processpaths
 extensions: []
 extra_rdoc_files: []
@@ -62,6 +63,7 @@ files:
 - bin/openapi-generate
 - bin/openapi-merge
 - bin/openapi-modifypaths
+- bin/openapi-patterntests
 - bin/openapi-processpaths
 - lib/openapi/sourcetools.rb
 - lib/openapi/sourcetools/apiobjects.rb