reynard 0.9.0 → 0.10.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 52cb53bbff626e0dce10485bf5cc023639b024024a237e34a73d09ae632ef9db
-  data.tar.gz: 1b66f322e4f7bfe5d0a5bd63096f218994bd55ed747a2fb2e1fa72c4af57ef30
+  metadata.gz: c3c34bb5538fc723eb3089aed2fcc9297caecd7c12802081fb1c0ffd5b930885
+  data.tar.gz: fd266bc7821ef67989261e66923605b3ea0b249f19c028ada40815928c070b7b
 SHA512:
-  metadata.gz: 15a3077ed0ee0c2331cab0182adae4b3970d83a4113f82d2d8aa4e528edd93678dd10a7e346d54e8d3e659dd5ad3509415f9de714a61a013e1937c3781eb686d
-  data.tar.gz: 80f49722dbde52f83aa9260aea1f71ccc6b97c7871f0818a71b4d42b4a79683cc404a0fa0ad8714f0d4fa4d3def54d2e140be1b35abe215699098da25c9b7b00
+  metadata.gz: edd450cc95fc83f6f16c8e8a77d7600f98d8524fe75a1abc78b383cd6442458acf3351e7ea0513cb539a00870bea79729a57120a4c0b556e54c937dcc0275e63
+  data.tar.gz: b00d56c46b6c29f5ccf01a83a6fc8f62e53a44953787441bb13af36a7025a0712f75ad537507f917644acff2f134edf71502461cb930e0bbe1c5a4a1b0ff9f6f

data/lib/reynard/context.rb

@@ -1,7 +1,5 @@
 # frozen_string_literal: true
 
-require 'ostruct'
-
 class Reynard
   # Exposes a public interface to build a request context.
   class Context
@@ -15,7 +13,7 @@ class Reynard
     end
 
     def base_url(base_url)
-      copy(base_url: base_url)
+      copy(base_url:)
     end
 
     def operation(operation_name)
@@ -44,7 +42,7 @@ class Reynard
     end
 
     def logger(logger)
-      copy(logger: logger)
+      copy(logger:)
     end
 
     def execute
@@ -74,7 +72,7 @@ class Reynard
         specification: @specification,
         inflector: @inflector,
         request_context: @request_context,
-        http_response: http_response
+        http_response:
       )
     end
   end

data/lib/reynard/external.rb

@@ -3,9 +3,16 @@
 require 'rack'
 
 class Reynard
-  # Loads external references.
+  # Loads data for external references from disk.
   class External
-    def initialize(path:, ref:)
+    # Build a new external reference loader.
+    #
+    # @param basepath [String] base path of the OpenAPI specification, we never load any files
+    #        higher in the directory tree
+    # @param path [String] base path of the current file, used to resolve relative paths
+    # @param ref [String] the $ref value we actually resolve
+    def initialize(basepath:, path:, ref:)
+      @basepath = basepath
       @path = path
       @relative_path, @anchor = ref.split('#', 2)
       @filename = File.expand_path(@relative_path, @path)
@@ -14,7 +21,10 @@ class Reynard
     def path
       return [] unless @anchor
 
-      @anchor.split('/')[1..]
+      # Remove explicit absolute (ie. /) and explicitly relative (ie. ./) instructions from the
+      # path expression because we're starting at the root of an external file. We currently don't
+      # support the // syntax.
+      @anchor.to_s.gsub(%r{\A\.?/}, '').split('/')
     end
 
     def data
@@ -30,7 +40,7 @@ class Reynard
     private
 
     def filename
-      return @filename if @filename.start_with?(@path)
+      return @filename if @filename.start_with?(@basepath)
 
       raise 'You are only allowed to reference files relative to the specification file.'
     end

data/lib/reynard/grouped_parameters.rb

@@ -3,14 +3,21 @@
 class Reynard
   # Groups parameters based on the parameters specification.
   class GroupedParameters
-    def initialize(specification, params)
-      @specification = pivot(specification)
+    def initialize(specification:, node:, params:)
+      @specification = specification
+      @node = node
       @params = params
     end
 
+    def constraints
+      return @constraints if defined?(@constraints)
+
+      @constraints = actualize(*@node, 'parameters') || actualize(*@node[..-2], 'parameters') || {}
+    end
+
     def to_h
       @params.each_with_object({}) do |(name, value), grouped|
-        group_name = @specification.dig(name, 'in') || 'query'
+        group_name = constraints.dig(name, 'in') || 'query'
         grouped[group_name] ||= {}
         grouped[group_name].merge!({ name => value })
       end
@@ -18,12 +25,16 @@ class Reynard
 
     private
 
-    def pivot(specification)
-      return {} unless specification
+    def actualize(*node)
+      parameters = @specification.dig(*node)
+      return unless parameters
 
-      specification.each_with_object({}) do |attribute, pivot|
-        pivot[attribute['name']] = attribute
+      pivot = {}
+      parameters.each.with_index do |attributes, index|
+        attributes = @specification.dig(*node, index) if attributes.key?('$ref')
+        pivot[attributes['name']] = attributes
       end
+      pivot
     end
   end
 end

data/lib/reynard/http/response.rb

@@ -73,7 +73,7 @@ class Reynard
         ObjectBuilder.new(
           schema: @specification.schema(media_type.node),
           inflector: @inflector,
-          parsed_body: parsed_body
+          parsed_body:
         ).call
       end
 

data/lib/reynard/model.rb

@@ -76,7 +76,7 @@ class Reynard
       property = schema.property_schema(name)
       return value unless property
 
-      ::Reynard::ObjectBuilder.new(schema: property, inflector: inflector, parsed_body: value).call
+      ::Reynard::ObjectBuilder.new(schema: property, inflector:, parsed_body: value).call
     end
 
     def self.inflector

data/lib/reynard/object_builder.rb

@@ -1,7 +1,5 @@
 # frozen_string_literal: true
 
-require 'ostruct'
-
 class Reynard
   # Defines dynamic classes based on schema and instantiates them for a response.
   class ObjectBuilder

data/lib/reynard/schema/model_naming.rb

@@ -0,0 +1,127 @@
+# frozen_string_literal: true
+
+class Reynard
+  class Schema
+    # Rummages through the specification to find a suitable model name for a response object.
+    class ModelNaming
+      def initialize(specification:, node:)
+        @specification = specification
+        @node = node
+      end
+
+      def model_name
+        model_name = determine_model_name
+        if class_type == :array
+          "#{model_name}Collection"
+        else
+          model_name
+        end
+      end
+
+      def self.title_model_name(model_name)
+        return unless model_name
+
+        model_name
+          .gsub(/[^[:alpha:]]/, ' ')
+          .gsub(/\s{2,}/, ' ')
+          .gsub(/(\s+)([[:alpha:]])/) { Regexp.last_match(2).upcase }
+          .strip
+      end
+
+      # Extracts a model name from a ref when there is a usable value.
+      #
+      #   ref_model_name("#/components/schemas/Library") => "Library"
+      def self.ref_model_name(ref)
+        return unless ref
+
+        normalize_ref_model_name(ref.split('/')&.last)
+      end
+
+      def self.normalize_ref_model_name(model_name)
+        # 1. Unescape encoded characters to create an UTF-8 string
+        # 2. Remove extensions for regularly used external schema files
+        # 3. Replace all non-alphabetic characters with a space (not allowed in Ruby constant)
+        # 4. Camelcase
+        Rack::Utils.unescape_path(model_name)
+                   .gsub(/(.yml|.yaml|.json)\Z/, '')
+                   .gsub(/[^[:alpha:]]/, ' ')
+                   .gsub(/(\s+)([[:alpha:]])/) { Regexp.last_match(2).upcase }
+                   .gsub(/\A(.)/) { Regexp.last_match(1).upcase }
+      end
+
+      def self.singularize(name)
+        case name
+        when /ies$/
+          "#{name[0..-4]}y"
+        else
+          name.chomp('s')
+        end
+      end
+
+      private
+
+      def class_type
+        @specification.dig(*@node).key?('items') ? :array : :object
+      end
+
+      def determine_model_name
+        title_model_name || ref_model_name || node_model_name
+      end
+
+      # Returns a model name when it was explicitly set using the title property in the specification.
+      def title_model_name
+        title = @specification.dig(*@node, 'title')
+        return unless title
+
+        self.class.title_model_name(title)
+      end
+
+      # Returns a model name based on the schema's $ref value, usually this contains a usable
+      # identifier at the end like /books.yml or /Books.
+      def ref_model_name
+        parent = @specification.dig(*@node[..-2])
+        ref = parent.dig('schema', '$ref') || parent.dig('items', '$ref')
+        return unless ref
+
+        self.class.ref_model_name(ref)
+      end
+
+      # Returns a model name based on the node path to schema in the specification.
+      def node_model_name
+        self.class.title_model_name(node_path_name.capitalize.gsub(/[_-]/, ' '))
+      end
+
+      def node_path_name
+        if node_anyonymous?
+          request_path_model_name
+        elsif @node.last == 'items'
+          # Use the property name as the model name for its items, for example in the case of
+          # schema > properties > birds > items => bird.
+          self.class.singularize(@node.at(-2))
+        else
+          # Usually this means we are dealing with a property's name a not a model, for example in
+          # the case of schema > properties > color => color.
+          @node.last
+        end
+      end
+
+      # Returns true when the node path doesn't have identifyable segments other than the request
+      # path for the resource.
+      #
+      # For example, when the last part of the path looks like this:
+      #   get > responses > 200 > content > application|json > schema
+      def node_anyonymous?
+        @node.last == 'schema' || @node.last(2) == %w[schema items]
+      end
+
+      # Finds the first segment starting from the end of the request path that is not a parameter
+      # and transforms that to make a model name.
+      #
+      # For example:
+      #   /books/{id} => "book"
+      def request_path_model_name
+        self.class.singularize(@node[1].split('/').reverse.find { |part| !part.start_with?('{') })
+      end
+    end
+  end
+end

data/lib/reynard/schema.rb

@@ -3,6 +3,8 @@
 class Reynard
   # Holds a references to a schema definition in the specification.
   class Schema
+    autoload :ModelNaming, 'reynard/schema/model_naming'
+
     attr_reader :node, :namespace
 
     def initialize(specification:, node:, namespace: nil)
@@ -18,9 +20,7 @@ class Reynard
     end
 
     def model_name
-      return @model_name if defined?(@model_name)
-
-      @model_name = find_model_name
+      @model_name || model_naming.model_name
     end
 
     # Returns the schema for items when the current schema is an array.
@@ -46,65 +46,10 @@ class Reynard
       )
     end
 
-    def self.title_model_name(model_name)
-      return unless model_name
-
-      model_name
-        .gsub(/[^[:alpha:]]/, ' ')
-        .gsub(/\s{2,}/, ' ')
-        .gsub(/(\s+)([[:alpha:]])/) { Regexp.last_match(2).upcase }
-        .strip
-    end
-
-    # Extracts a model name from a ref when there is a usable value.
-    #
-    #   ref_model_name("#/components/schemas/Library") => "Library"
-    def self.ref_model_name(ref)
-      return unless ref
-
-      normalize_ref_model_name(ref.split('/')&.last)
-    end
-
-    def self.normalize_ref_model_name(model_name)
-      # 1. Unescape encoded characters to create an UTF-8 string
-      # 2. Remove extensions for regularly used external schema files
-      # 3. Replace all non-alphabetic characters with a space (not allowed in Ruby constant)
-      # 4. Camelcase
-      Rack::Utils.unescape_path(model_name)
-                 .gsub(/(.yml|.yaml|.json)\Z/, '')
-                 .gsub(/[^[:alpha:]]/, ' ')
-                 .gsub(/(\s+)([[:alpha:]])/) { Regexp.last_match(2).upcase }
-                 .gsub(/\A(.)/) { Regexp.last_match(1).upcase }
-    end
-
     private
 
-    # Returns a model name based on the schema's title or $ref.
-    def find_model_name
-      title_model_name || ref_model_name || node_model_name
-    end
-
-    def title_model_name
-      title = @specification.dig(*node, 'title')
-      return unless title
-
-      self.class.title_model_name(title)
-    end
-
-    def ref_model_name
-      parent = @specification.dig(*node[..-2])
-      ref = parent.dig('schema', '$ref') || parent.dig('items', '$ref')
-      return unless ref
-
-      self.class.ref_model_name(ref)
-    end
-
-    def node_model_name
-      self.class.title_model_name(node_property_name.capitalize.gsub(/[_-]/, ' '))
-    end
-
-    def node_property_name
-      node.last == 'items' ? node.at(-2).chomp('s') : node.last
+    def model_naming
+      ModelNaming.new(specification: @specification, node: @node)
     end
   end
 end

data/lib/reynard/specification/finder.rb

@@ -0,0 +1,31 @@
+# frozen_string_literal: true
+
+class Reynard
+  class Specification
+    # Finds nodes in a specification that match a query.
+    class Finder
+      def initialize(specification:, query:)
+        @specification = specification
+        @query = query
+      end
+
+      def find_each(&)
+        find_into([], &)
+      end
+
+      private
+
+      def find_into(path, &block)
+        data = @specification.dig(*path)
+
+        yield path if data.respond_to?(:key?) && data.key?('type') && (@query.type == data['type'])
+
+        return unless data.respond_to?(:each_key)
+
+        data.each_key do |key|
+          find_into([*path, key], &block)
+        end
+      end
+    end
+  end
+end

data/lib/reynard/specification/query.rb

@@ -0,0 +1,14 @@
+# frozen_string_literal: true
+
+class Reynard
+  class Specification
+    # Describes a query for a node in a specification.
+    class Query
+      attr_reader :type
+
+      def initialize(type: nil)
+        @type = type
+      end
+    end
+  end
+end

data/lib/reynard/specification.rb

@@ -5,6 +5,9 @@ require 'rack'
 class Reynard
   # Wraps the YAML representation of an OpenAPI specification.
   class Specification
+    autoload :Finder, 'reynard/specification/finder'
+    autoload :Query, 'reynard/specification/query'
+
     VERBS = %w[get put post delete options head patch trace].freeze
 
     def initialize(filename:)
@@ -17,6 +20,15 @@ class Reynard
       dig_into(@data, @data, path.dup, File.dirname(@filename))
     end
 
+    # Yields all nodes in the specification matching the specified type.
+    #
+    #   specification.find_each(type: 'object') {}
+    #
+    # Please don't use this in a hot paths in production, primarily meant for testing and tooling.
+    def find_each(type:, &block)
+      Finder.new(specification: self, query: Query.new(type:)).find_each(&block)
+    end
+
     def servers
       dig('servers').map { |attributes| Server.new(attributes) }
     end
@@ -35,13 +47,9 @@ class Reynard
       return {} unless params
 
       GroupedParameters.new(
-        [
-          # Parameters can be shared between methods on a path or be specific to an operation. The
-          # parameters on the operation level override those at the path level.
-          dig(*operation_node, 'parameters'),
-          dig(*operation_node[..-2], 'parameters')
-        ].compact.flatten,
-        params
+        specification: self,
+        node: operation_node,
+        params:
       ).to_h
     end
 
@@ -52,7 +60,8 @@ class Reynard
     end
 
     def operation(operation_name)
-      dig('paths').each do |path, operations|
+      dig('paths').each_key do |path|
+        operations = dig('paths', path)
         operations.slice(*VERBS).each do |verb, operation|
           return Operation.new(node: ['paths', path, verb]) if operation_name == operation['operationId']
         end
@@ -101,7 +110,6 @@ class Reynard
     end
 
     # rubocop:disable Metrics/AbcSize
-    # rubocop:disable Metrics/CyclomaticComplexity
     # rubocop:disable Metrics/MethodLength
     def dig_into(data, cursor, path, filesystem_path)
       while path.length.positive?
@@ -117,8 +125,8 @@ class Reynard
           path = Rack::Utils.unescape_path(cursor['$ref'][2..]).split('/') + path
           cursor = data
         # References another file, with an optional anchor to an element in the data.
-        when %r{\A\./}
-          external = External.new(path: filesystem_path, ref: cursor['$ref'])
+        else
+          external = External.new(basepath:, path: filesystem_path, ref: cursor['$ref'])
           filesystem_path = external.filesystem_path
           path = external.path + path
           cursor = external.data
@@ -127,7 +135,10 @@ class Reynard
       cursor
     end
     # rubocop:enable Metrics/AbcSize
-    # rubocop:enable Metrics/CyclomaticComplexity
     # rubocop:enable Metrics/MethodLength
+
+    def basepath
+      File.dirname(File.expand_path(@filename))
+    end
   end
 end

data/lib/reynard/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 class Reynard
-  VERSION = '0.9.0'
+  VERSION = '0.10.1'
 end

data/lib/reynard.rb

@@ -34,7 +34,7 @@ class Reynard
   autoload :VERSION, 'reynard/version'
 
   def initialize(filename:)
-    @specification = Specification.new(filename: filename)
+    @specification = Specification.new(filename:)
     @inflector = Inflector.new
   end
 

metadata

@@ -1,14 +1,13 @@
 --- !ruby/object:Gem::Specification
 name: reynard
 version: !ruby/object:Gem::Version
-  version: 0.9.0
+  version: 0.10.1
 platform: ruby
 authors:
 - Manfred Stienstra
-autorequire:
 bindir: bin
 cert_chain: []
-date: 2024-02-28 00:00:00.000000000 Z
+date: 1980-01-02 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: multi_json
@@ -78,9 +77,12 @@ files:
 - lib/reynard/operation.rb
 - lib/reynard/request_context.rb
 - lib/reynard/schema.rb
+- lib/reynard/schema/model_naming.rb
 - lib/reynard/serialized_body.rb
 - lib/reynard/server.rb
 - lib/reynard/specification.rb
+- lib/reynard/specification/finder.rb
+- lib/reynard/specification/query.rb
 - lib/reynard/template.rb
 - lib/reynard/version.rb
 homepage: https://github.com/Manfred/reynard
@@ -88,7 +90,6 @@ licenses:
 - MIT
 metadata:
   rubygems_mfa_required: 'true'
-post_install_message:
 rdoc_options: []
 require_paths:
 - lib
@@ -96,15 +97,14 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">"
     - !ruby/object:Gem::Version
-      version: '3.0'
+      version: '3.1'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.5.6
-signing_key:
+rubygems_version: 3.6.7
 specification_version: 4
 summary: Minimal OpenAPI client.
 test_files: []