openapi3_parser 0.6.1 → 0.9.0

data/lib/openapi3_parser/node/path_item.rb

@@ -66,6 +66,14 @@ module Openapi3Parser
         self["servers"]
       end
 
+      # Whether this object uses it's own defined servers instead of falling
+      # back to the root ones.
+      #
+      # @return [Boolean]
+      def alternative_servers?
+        servers != node_context.document.root.servers
+      end
+
       # @return [Node::Array<Parameter>]
       def parameters
         self["parameters"]

data/lib/openapi3_parser/node/placeholder.rb

@@ -1,8 +1,12 @@
 # frozen_string_literal: true
 
+require "forwardable"
+
 module Openapi3Parser
   module Node
     class Placeholder
+      extend Forwardable
+
       def self.resolve(potential_placeholder)
         if potential_placeholder.is_a?(Placeholder)
           potential_placeholder.node
@@ -13,12 +17,12 @@ module Openapi3Parser
 
       # Used to iterate through hashes or arrays that may contain
       # Placeholder objects where these are resolved to being nodes
-      # befor iteration
+      # before iteration
       def self.each(node_data, &block)
         resolved =
           if node_data.respond_to?(:keys)
-            node_data.each_with_object({}) do |(key, value), memo|
-              memo[key] = resolve(value)
+            node_data.transform_values do |value|
+              resolve(value)
             end
           else
             node_data.map { |item| resolve(item) }
@@ -27,6 +31,10 @@ module Openapi3Parser
         resolved.each(&block)
       end
 
+      attr_reader :node_factory, :field, :parent_context
+
+      def_delegators :node_factory, :nil_input?
+
       def initialize(node_factory, field, parent_context)
         @node_factory = node_factory
         @field = field
@@ -35,16 +43,12 @@ module Openapi3Parser
 
       def node
         @node ||= begin
-                    node_context = Context.next_field(parent_context,
-                                                      field,
-                                                      node_factory.context)
-                    node_factory.node(node_context)
-                  end
+          node_context = Context.next_field(parent_context,
+                                            field,
+                                            node_factory.context)
+          node_factory.node(node_context)
+        end
       end
-
-      private
-
-      attr_reader :node_factory, :field, :parent_context
     end
   end
 end

data/lib/openapi3_parser/node/schema.rb

@@ -5,8 +5,39 @@ require "openapi3_parser/node/object"
 module Openapi3Parser
   module Node
     # @see https://github.com/OAI/OpenAPI-Specification/blob/master/versions/3.0.0.md#schemaObject
-    # rubocop:disable ClassLength
+    # rubocop:disable Metrics/ClassLength
     class Schema < Node::Object
+      # This is used to provide a name for the schema based on it's position in
+      # an OpenAPI document.
+      #
+      # For example it's common to have an OpenAPI document structured like so:
+      # components:
+      #   schemas:
+      #     Product:
+      #       properties:
+      #         product_id:
+      #           type: string
+      #         description:
+      #           type: string
+      #
+      # and there is then implied meaning in the field name of Product, ie
+      # that schema now represents a product. This data is not easily or
+      # consistently made available as it is part of the path to the data
+      # rather than the data itself. Instead the field that would be more
+      # appropriate would be "title" within a schema.
+      #
+      # As this is a common pattern in OpenAPI docs this provides a method
+      # to look up this contextual name of the schema so it can be referenced
+      # when working with the document, it only considers a field to be
+      # name if it is within a group called schemas (as is the case
+      # in #/components/schemas)
+      #
+      # @return [String, nil]
+      def name
+        segments = node_context.source_location.pointer.segments
+        segments[-1] if segments[-2] == "schemas"
+      end
+
       # @return [String, nil]
       def title
         self["title"]
@@ -82,6 +113,21 @@ module Openapi3Parser
         self["required"]
       end
 
+      # Returns whether a property is a required field or not. Can accept the
+      # property name or a schema
+      #
+      # @param [String, Schema] property
+      # @return [Boolean]
+      def requires?(property)
+        if property.is_a?(Schema)
+          properties.to_h
+                    .select { |k, _| required.to_a.include?(k) }
+                    .any? { |_, schema| schema == property }
+        else
+          required.to_a.include?(property)
+        end
+      end
+
       # @return [Node::Array<Object>, nil]
       def enum
         self["enum"]
@@ -131,6 +177,7 @@ module Openapi3Parser
       def additional_properties_schema
         properties = self["additionalProperties"]
         return if [true, false].include?(properties)
+
         properties
       end
 
@@ -160,7 +207,7 @@ module Openapi3Parser
       end
 
       # @return [Discriminator, nil]
-      def disciminator
+      def discriminator
         self["discriminator"]
       end
 
@@ -194,6 +241,6 @@ module Openapi3Parser
         self["deprecated"]
       end
     end
-    # rubocop:enable ClassLength
+    # rubocop:enable Metrics/ClassLength
   end
 end

data/lib/openapi3_parser/node_factory.rb

@@ -2,6 +2,6 @@
 
 module Openapi3Parser
   module NodeFactory
-    EXTENSION_REGEX = /^x-(.*)/
+    EXTENSION_REGEX = /^x-(.*)/.freeze
   end
 end

data/lib/openapi3_parser/node_factory/array.rb

@@ -3,23 +3,27 @@
 module Openapi3Parser
   module NodeFactory
     class Array
-      attr_reader :context, :data, :default, :value_input_type,
-                  :value_factory, :validation
+      attr_reader :context, :data, :default, :use_default_on_empty,
+                  :value_input_type, :value_factory, :validation
 
+      # rubocop:disable Metrics/ParameterLists
       def initialize(
         context,
         default: [],
+        use_default_on_empty: false,
         value_input_type: nil,
         value_factory: nil,
         validate: nil
       )
         @context = context
         @default = default
+        @use_default_on_empty = use_default_on_empty
         @value_input_type = value_input_type
         @value_factory = value_factory
         @validation = validate
         @data = build_data(context.input)
       end
+      # rubocop:enable Metrics/ParameterLists
 
       def raw_input
         context.input
@@ -50,18 +54,25 @@ module Openapi3Parser
         %{#{self.class.name}(#{context.source_location.inspect})}
       end
 
+      def use_default?
+        return true if nil_input? || !raw_input.is_a?(::Array)
+        return false unless use_default_on_empty
+
+        raw_input.empty?
+      end
+
       private
 
       def build_data(raw_input)
-        use_default = nil_input? || !raw_input.is_a?(::Array)
-        return if use_default && default.nil?
-        process_data(use_default ? default : raw_input)
+        return if use_default? && default.nil?
+
+        process_data(use_default? ? default : raw_input)
       end
 
       def process_data(data)
         data.each_with_index.map do |value, i|
           if value_factory
-            initialize_value_factory(Context.next_field(context, i))
+            initialize_value_factory(Context.next_field(context, i, value))
           else
             value
           end
@@ -104,26 +115,24 @@ module Openapi3Parser
 
         def errors
           return validatable.collection if factory.nil_input?
+
           TypeChecker.validate_type(validatable, type: ::Array)
           return validatable.collection if validatable.errors.any?
+
           collate_errors
           validatable.collection
         end
 
         def data(parent_context)
-          return default_value if factory.nil_input?
+          if factory.use_default?
+            return factory.default.nil? ? nil : build_node_data(parent_context)
+          end
 
           TypeChecker.raise_on_invalid_type(factory.context, type: ::Array)
           check_values(raise_on_invalid: true)
           validate(raise_on_invalid: true)
 
-          factory.data.each_with_index.map do |value, i|
-            if value.respond_to?(:node)
-              Node::Placeholder.new(value, i, parent_context)
-            else
-              value
-            end
-          end
+          build_node_data(parent_context)
         end
 
         private_class_method :new
@@ -132,6 +141,14 @@ module Openapi3Parser
 
         attr_reader :factory, :validatable
 
+        def build_node_data(parent_context)
+          factory.data.each_with_index.map do |value, i|
+            next value unless value.respond_to?(:node)
+
+            Node::Placeholder.new(value, i, parent_context)
+          end
+        end
+
         def collate_errors
           check_values(raise_on_invalid: false)
           validate(raise_on_invalid: false)
@@ -141,21 +158,12 @@ module Openapi3Parser
           end
         end
 
-        def default_value
-          if factory.nil_input? && factory.default.nil?
-            nil
-          else
-            factory.data
-          end
-        end
-
         def check_values(raise_on_invalid: false)
           return unless factory.value_input_type
 
-          factory.context.input.each_index do |index|
-            check_field_type(
-              Context.next_field(factory.context, index), raise_on_invalid
-            )
+          factory.context.input.each_with_index do |value, index|
+            check_field_type(Context.next_field(factory.context, index, value),
+                             raise_on_invalid)
           end
         end
 

data/lib/openapi3_parser/node_factory/context.rb

@@ -12,6 +12,8 @@ module Openapi3Parser
     # @attr_reader  [Array<Source::Location>] refernce_locations
     #
     class Context
+      UNDEFINED = Class.new
+
       # Create a context for the root of a document
       #
       # @param  [Any]     input
@@ -29,10 +31,15 @@ module Openapi3Parser
       #
       # @param  [Context] parent_context
       # @param  [String]  field
+      # @param  [Any]     input
       # @return [Context]
-      def self.next_field(parent_context, field)
+      def self.next_field(parent_context, field, given_input = UNDEFINED)
         pc = parent_context
-        input = pc.input.respond_to?(:[]) ? pc.input[field] : nil
+        input = if given_input == UNDEFINED
+                  pc.input.respond_to?(:[]) ? pc.input[field] : nil
+                else
+                  given_input
+                end
         source_location = Source::Location.next_field(pc.source_location, field)
         new(input,
             source_location: source_location,

data/lib/openapi3_parser/node_factory/discriminator.rb

@@ -19,9 +19,11 @@ module Openapi3Parser
       def validate_mapping(validatable)
         input = validatable.input
         return if input.empty?
+
         string_keys = input.keys.map(&:class).uniq == [String]
         string_values = input.values.map(&:class).uniq == [String]
         return if string_keys && string_values
+
         validatable.add_error("Expected string keys and string values")
       end
     end

data/lib/openapi3_parser/node_factory/field.rb

@@ -70,8 +70,10 @@ module Openapi3Parser
 
         def errors
           return validatable.collection if factory.nil_input?
+
           TypeChecker.validate_type(validatable, type: factory.input_type)
           return validatable.collection if validatable.errors.any?
+
           validate(raise_on_invalid: false)
           validatable.collection
         end

data/lib/openapi3_parser/node_factory/fields/reference.rb

@@ -72,6 +72,7 @@ module Openapi3Parser
 
         def create_resolved_reference
           return unless reference_validator.valid?
+
           context.resolve_reference(reference,
                                     factory,
                                     recursive: context.self_referencing?)

data/lib/openapi3_parser/node_factory/map.rb

@@ -60,6 +60,7 @@ module Openapi3Parser
       def build_data(raw_input)
         use_default = nil_input? || !raw_input.is_a?(::Hash)
         return if use_default && default.nil?
+
         process_data(use_default ? default : raw_input)
       end
 
@@ -89,12 +90,12 @@ module Openapi3Parser
       def build_resolved_input
         return unless data
 
-        data.each_with_object({}) do |(key, value), memo|
-          memo[key] = if value.respond_to?(:resolved_input)
-                        value.resolved_input
-                      else
-                        value
-                      end
+        data.transform_values do |value|
+          if value.respond_to?(:resolved_input)
+            value.resolved_input
+          else
+            value
+          end
         end
       end
 
@@ -114,8 +115,10 @@ module Openapi3Parser
 
         def errors
           return validatable.collection if factory.nil_input?
+
           TypeChecker.validate_type(validatable, type: ::Hash)
           return validatable.collection if validatable.errors.any?
+
           collate_errors
           validatable.collection
         end
@@ -175,12 +178,11 @@ module Openapi3Parser
         def check_values(raise_on_invalid: false)
           return unless factory.value_input_type
 
-          factory.context.input.keys.each do |key|
+          factory.context.input.each do |key, value|
             next if factory.allow_extensions && key.to_s =~ EXTENSION_REGEX
 
-            check_field_type(
-              Context.next_field(factory.context, key), raise_on_invalid
-            )
+            check_field_type(Context.next_field(factory.context, key, value),
+                             raise_on_invalid)
           end
         end
 

data/lib/openapi3_parser/node_factory/media_type.rb

@@ -48,6 +48,7 @@ module Openapi3Parser
         def call(validatable)
           missing_keys = validatable.input.keys - properties
           return if missing_keys.empty?
+
           validatable.add_error(error_message(missing_keys))
         end
 

data/lib/openapi3_parser/node_factory/object.rb

@@ -78,6 +78,7 @@ module Openapi3Parser
       def build_data(raw_input)
         use_default = nil_input? || !raw_input.is_a?(::Hash)
         return if use_default && default.nil?
+
         process_data(use_default ? default : raw_input)
       end
 
@@ -85,7 +86,8 @@ module Openapi3Parser
         field_configs.each_with_object(raw_data.dup) do |(field, config), memo|
           memo[field] = nil unless memo[field]
           next unless config.factory?
-          next_context = Context.next_field(context, field)
+
+          next_context = Context.next_field(context, field, memo[field])
           memo[field] = config.initialize_factory(next_context, self)
         end
       end
@@ -95,6 +97,7 @@ module Openapi3Parser
 
         data.each_with_object({}) do |(key, value), memo|
           next if value.respond_to?(:nil_input?) && value.nil_input?
+
           memo[key] = if value.respond_to?(:resolved_input)
                         value.resolved_input
                       else