openapi-arrangement 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 0d131667f320634f4b75da00e14571872d65b4d05d4094c894dab7c4f2d6aadd
+  data.tar.gz: c95734699bbc4530c9632d8231d1ba84110d77bcfaf2cc3476e03066c2942474
+SHA512:
+  metadata.gz: 62b1a16559f5e48cdadbcdd3a7630c1b1c4aaabb97acf7337462f8a2760aa28aa8463fec341dd4a65459f78ea7b292e5faa116402d8717fc6ed04425e26531ce
+  data.tar.gz: 04bddf3ba5882d5f5d2d483f10148b61e6331fd75c478ca0c6c729bb3aec83b97094f7d4e26aa0da984de652f4ac140d16c787a6122751f7d12026041bc66f0b

data/LICENSE.txt

@@ -0,0 +1,17 @@
+Copyright (c) 2024-2025 Ismo Kärkkäinen
+
+The Universal Permissive License (UPL), Version 1.0
+
+Subject to the condition set forth below, permission is hereby granted to any person obtaining a copy of this software, associated documentation and/or data (collectively the "Software"), free of charge and under any and all copyright rights in the Software, and any and all patent rights owned or freely licensable by each licensor hereunder covering either (i) the unmodified Software as contributed to or provided by such licensor, or (ii) the Larger Works (as defined below), to deal in both
+
+(a) the Software, and
+
+(b) any piece of software and/or hardware listed in the lrgrwrks.txt file if one is included with the Software (each a "Larger Work" to which the Software is contributed by such licensors),
+
+without restriction, including without limitation the rights to copy, create derivative works of, display, perform, and distribute the Software and make, use, sell, offer for sale, import, export, have made, and have sold the Software and the Larger Work(s), and to sublicense the foregoing rights on either these or other terms.
+
+This license is subject to the following condition:
+
+The above copyright notice and either this complete permission notice or at a minimum a reference to the UPL must be included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/lib/openapi/arrangement/schema.rb

@@ -0,0 +1,205 @@
+# frozen_string_literal: true
+
+# Copyright © 2024-2025 Ismo Kärkkäinen
+# Licensed under Universal Permissive License. See LICENSE.txt.
+
+module OpenAPIArrangement
+  # Schema ordering.
+  module Schema
+    # Convenience methods to simplify using Orderer.
+    # All return a sorted array of Schema::Info instances.
+
+    # Arranges schemas in alphabetical order.
+    def self.alphabetical(doc, path = nil)
+      cands = path_candidates(path)
+      schemas, path = get_schemas(doc, cands)
+      return nil if schemas.nil?
+      ord = Orderer.new(path, schemas)
+      ord.sort!('@name')
+    end
+
+    # Arranges schemas to minimize forward declarations.
+    def self.dependencies_first(doc, path = nil)
+      cands = path_candidates(path)
+      schemas, path = get_schemas(doc, cands)
+      return nil if schemas.nil?
+      ord = Orderer.new(path, schemas)
+      ord.sort!
+    end
+
+    def self.path_candidates(path = nil)
+      if path.nil?
+        return {
+          '#/components/schemas/' => %w[components schemas],
+          '#/$defs/' => %w[$defs] # Supposing someone wants to use JSON schema doc.
+        }
+      end
+      pieces = path.split('/')
+      pieces.reject!(&:empty?)
+      pieces.shift if '#' == pieces.first
+      { path => pieces }
+    end
+    private_class_method :path_candidates
+
+    def self.get_schemas(doc, cands)
+      cands.each do |path, pieces|
+        schemas = doc.dig(*pieces)
+        return [ schemas, path ] unless schemas.nil?
+      end
+      [ nil, nil ]
+    end
+    private_class_method :get_schemas
+
+    # Schema, reference to it, name, and what it refers to.
+    class Info
+      attr_reader :ref, :schema, :direct_refs, :name, :unseen_refs
+
+      def initialize(ref, name, schema)
+        @ref = ref
+        @name = name
+        @schema = schema
+        @direct_refs = {}
+        self.class.gather_refs(@direct_refs, schema)
+      end
+
+      # Sets references that require forward declaration to be used.
+      def mark_as_seen(seen)
+        @unseen_refs = Set.new(@direct_refs.keys) - seen
+      end
+
+      def to_s
+        v = @direct_refs.keys.sort.map { |k| "#{k}:#{@direct_refs[k] ? 'req' : 'opt'}" }
+        "#{@ref}: #{v.join(' ')}"
+      end
+
+      # Adds all refs found in the array to refs with given required state.
+      def self.gather_array_refs(refs, items, required)
+        items.each do |s|
+          r = s['$ref']
+          next if r.nil?
+          refs[r] = required || refs.fetch(r, false)
+        end
+      end
+
+      # For any key '$ref' adds to refs whether referred type is required.
+      # Requires that there are no in-lined schemas, openapi-addschemas has been run.
+      def self.gather_refs(refs, schema)
+        # This implies types mixed together according to examples. Needs mixed type.
+        # AND. Also, mixing may fail. Adds a new schema, do in openapi-oftypes.
+        items = schema['allOf']
+        return gather_array_refs(refs, items, true) unless items.nil?
+        # As long as one schema is fulfilled, it is ok. OR, first that fits.
+        items = schema['anyOf'] if items.nil?
+        # oneOf implies selection between different types. No multiple matches. XOR.
+        # Needs to ensure that later types do not match.
+        # Should check if there is enough difference to ensure single match.
+        # Use separate program run after addschemas to create allOf mixed schema
+        # and verify the others can be dealt with.
+        items = schema['oneOf'] if items.nil?
+        return gather_array_refs(refs, items, false) unless items.nil?
+        # Defaults below handle it if "type" is not "object".
+        reqs = schema.fetch('required', [])
+        schema.fetch('properties', {}).each do |name, spec|
+          r = spec['$ref']
+          next if r.nil?
+          refs[r] = reqs.include?(name) || refs.fetch(r, false)
+        end
+      end
+    end
+
+    # Orders schemas according to given orderer.
+    # There is only one actual ordering method now.
+    class Orderer
+      attr_accessor :schemas, :order, :orderer
+
+      def initialize(path, schema_specs)
+        @schemas = {}
+        schema_specs.each do |name, schema|
+          r = "#{path}#{name}"
+          @schemas[r] = Info.new(r, name, schema)
+        end
+      end
+
+      def sort!(orderer = 'greedy_required_first')
+        @orderer = orderer
+        case orderer
+        when 'greedy_required_first' then @order = greedy_required_first
+        when '<=>' then @order = @schemas.values.sort { |a, b| a <=> b }
+        else
+          @order = @schemas.values.sort do |a, b|
+            va = self.class.var_or_method_value(a, orderer)
+            vb = self.class.var_or_method_value(b, orderer)
+            va <=> vb
+          end
+        end
+        seen = Set.new
+        @order.each do |si|
+          si.mark_as_seen(seen)
+          seen.add(si.name)
+        end
+        @order
+      end
+
+      def count_comparison(optfwd, manfwd, optrem, manrem, si, best)
+        # Fewer mandatory forwards is good because it leaves more room for implementation.
+        return true if manfwd < best[1]
+        if manfwd == best[1]
+          return true if manrem < best[3]
+          if manrem == best[3]
+            return true if optfwd < best[0]
+            if optfwd == best[0]
+              return true if optrem < best[2]
+              if optrem == best[2]
+                best_req_si = best.last.direct_refs.fetch(si.ref, false)
+                si_req_best = si.direct_refs.fetch(best.last.ref, false)
+                return nil if best_req_si == si_req_best
+                return !si_req_best
+              end
+            end
+          end
+        end
+        false
+      end
+
+      def greedy_required_first
+        chosen = []
+        until chosen.size == @schemas.size
+          used = Set.new(chosen.map(&:ref))
+          available = @schemas.values.reject { |si| used.member?(si.ref) }
+          best = nil
+          available.each do |si|
+            # Optional forwards from chosen.
+            optfwd = chosen.count { |x| !x.direct_refs.fetch(si.ref, false) && x.direct_refs.key?(si.ref) }
+            # Mandatory forwards from chosen.
+            manfwd = chosen.count { |x| x.direct_refs.fetch(si.ref, false) && x.direct_refs.key?(si.ref) }
+            # Optional and mandatory references from si.
+            opts = Set.new(si.direct_refs.keys.reject { |n| si.direct_refs[n] })
+            mans = Set.new(si.direct_refs.keys.select { |n| si.direct_refs[n] })
+            # Optional forwards to be added for si.
+            optrem = (opts - used).size
+            # Mandatory forwards to be added for si.
+            manrem = (mans - used).size
+            better = false
+            if best.nil?
+              better = true
+            else
+              better = count_comparison(optfwd, manfwd, optrem, manrem, si, best)
+              # Order by name if equally good otherwise.
+              better = si.name < best.last.name if better.nil?
+            end
+            best = [ optfwd, manfwd, optrem, manrem, si ] if better
+          end
+          chosen.push(best.last)
+        end
+        chosen
+      end
+
+      def self.var_or_method_value(x, name)
+        n = name.start_with?('@') ? name : "@#{name}"
+        return x.instance_variable_get(n) if x.instance_variable_defined?(n)
+        return x.public_send(name) if x.respond_to?(name)
+        raise ArgumentError, "#{name} is not #{x.class} instance variable nor public method"
+      end
+    end
+  end
+end

data/lib/openapi/arrangement/version.rb

@@ -0,0 +1,14 @@
+# frozen_string_literal: true
+
+# Copyright © 2025 Ismo Kärkkäinen
+# Licensed under Universal Permissive License. See LICENSE.txt.
+
+# Name and version.
+module OpenAPIArrangement
+  NAME = 'openapi-arrangement'
+  VERSION = '0.1.0'
+
+  def self.info(separator = ': ')
+    "#{NAME}#{separator}#{VERSION}"
+  end
+end

data/lib/openapi/arrangement.rb

@@ -0,0 +1,7 @@
+# frozen_string_literal: true
+
+# Copyright © 2024-2025 Ismo Kärkkäinen
+# Licensed under Universal Permissive License. See LICENSE.txt.
+
+require_relative 'arrangement/schema'
+require_relative 'arrangement/version'

metadata

@@ -0,0 +1,55 @@
+--- !ruby/object:Gem::Specification
+name: openapi-arrangement
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Ismo Kärkkäinen
+autorequire:
+bindir: bin
+cert_chain: []
+date: 2025-01-21 00:00:00.000000000 Z
+dependencies: []
+description: |-
+  Code for arranging schemas in OpenAPI format specifications.
+
+  Intended to be used in gems that are invoked from openapi-generate tool from
+  openapi-sourcetools gem.
+
+  Provides functionality for ordering schemas:
+  - Based on mutual dependencies to minimize the need for forward declarations.
+  - Alphabetical order.
+email: ismokarkkainen@icloud.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- LICENSE.txt
+- lib/openapi/arrangement.rb
+- lib/openapi/arrangement/schema.rb
+- lib/openapi/arrangement/version.rb
+homepage: https://xn--ismo-krkkinen-gfbd.fi/openapi-arrangement/index.html
+licenses:
+- UPL-1.0
+metadata:
+  rubygems_mfa_required: 'true'
+post_install_message:
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 3.2.5
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.4.19
+signing_key:
+specification_version: 4
+summary: Schema arrangement code for OpenAPI specifications.
+test_files: []