reynard 0.9.0 → 0.10.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 52cb53bbff626e0dce10485bf5cc023639b024024a237e34a73d09ae632ef9db
-  data.tar.gz: 1b66f322e4f7bfe5d0a5bd63096f218994bd55ed747a2fb2e1fa72c4af57ef30
+  metadata.gz: 9d2a2059bfff7777ad1d0b122d83afff99bc6af883a35f8970091fa3197fd541
+  data.tar.gz: 05d9297e7d4d86e43f733f5c385ac2ea93a16b681d4f51e09bea9e20e97a00bc
 SHA512:
-  metadata.gz: 15a3077ed0ee0c2331cab0182adae4b3970d83a4113f82d2d8aa4e528edd93678dd10a7e346d54e8d3e659dd5ad3509415f9de714a61a013e1937c3781eb686d
-  data.tar.gz: 80f49722dbde52f83aa9260aea1f71ccc6b97c7871f0818a71b4d42b4a79683cc404a0fa0ad8714f0d4fa4d3def54d2e140be1b35abe215699098da25c9b7b00
+  metadata.gz: 8b0ccb3d8e187780cdca33e65588b4da8d835910f247f618e5b67114e58cda744745826ff9e8c223742be55c003ea6df904b18a6fee9bc7e2b7b466c9739f751
+  data.tar.gz: dd5bf8691ae5c72ea7462e313992671ad82125fb0de3228d09d6a26fa367734cd14498de7bc02dda73684b255774b40e5991464c606609bc16517528f75b4219

data/lib/reynard/context.rb

@@ -15,7 +15,7 @@ class Reynard
     end
 
     def base_url(base_url)
-      copy(base_url: base_url)
+      copy(base_url:)
     end
 
     def operation(operation_name)
@@ -44,7 +44,7 @@ class Reynard
     end
 
     def logger(logger)
-      copy(logger: logger)
+      copy(logger:)
     end
 
     def execute
@@ -74,7 +74,7 @@ class Reynard
         specification: @specification,
         inflector: @inflector,
         request_context: @request_context,
-        http_response: http_response
+        http_response:
       )
     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/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

data/lib/reynard/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 class Reynard
-  VERSION = '0.9.0'
+  VERSION = '0.10.0'
 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,14 @@
 --- !ruby/object:Gem::Specification
 name: reynard
 version: !ruby/object:Gem::Version
-  version: 0.9.0
+  version: 0.10.0
 platform: ruby
 authors:
 - Manfred Stienstra
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2024-02-28 00:00:00.000000000 Z
+date: 2024-08-07 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: multi_json
@@ -78,9 +78,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
@@ -96,14 +99,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
+rubygems_version: 3.5.16
 signing_key:
 specification_version: 4
 summary: Minimal OpenAPI client.