openapi3_parser 0.2.0 → 0.3.0

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

@@ -0,0 +1,44 @@
+# frozen_string_literal: true
+
+require "openapi3_parser/node_factory"
+require "openapi3_parser/validators/reference"
+
+module Openapi3Parser
+  module NodeFactory
+    module Fields
+      class Reference
+        include NodeFactory
+        input_type ::String
+
+        def initialize(context, factory)
+          super(context)
+          @factory = factory
+          @given_reference = context.input
+          @reference_resolver = create_reference_resolver
+        end
+
+        private
+
+        attr_reader :given_reference, :factory, :reference_resolver
+
+        def validate(_, _)
+          return reference_validator.errors unless reference_validator.valid?
+          reference_resolver&.errors
+        end
+
+        def build_node(_)
+          reference_resolver&.node
+        end
+
+        def reference_validator
+          @reference_validator ||= Validators::Reference.new(given_reference)
+        end
+
+        def create_reference_resolver
+          return unless given_reference
+          context.register_reference(given_reference, factory)
+        end
+      end
+    end
+  end
+end

data/lib/openapi3_parser/node_factory/map.rb

@@ -1,6 +1,7 @@
 # frozen_string_literal: true
 
 require "openapi3_parser/node_factory"
+require "openapi3_parser/validation/error_collection"
 
 module Openapi3Parser
   module NodeFactory
@@ -23,11 +24,10 @@ module Openapi3Parser
         build_map(data, context)
       end
 
-      def validate_input(error_collection)
-        super(error_collection)
-        processed_input.each_value do |value|
-          next unless value.respond_to?(:errors)
-          error_collection.merge(value.errors)
+      def validate_input
+        processed_input.each_value.inject(super) do |memo, value|
+          errors = value.respond_to?(:errors) ? value.errors : []
+          Validation::ErrorCollection.combine(memo, errors)
         end
       end
 

data/lib/openapi3_parser/node_factory/object.rb

@@ -1,9 +1,11 @@
 # frozen_string_literal: true
 
+require "openapi3_parser/context"
 require "openapi3_parser/node_factory"
 require "openapi3_parser/node_factory/field_config"
 require "openapi3_parser/node_factory/object/node_builder"
 require "openapi3_parser/node_factory/object/validator"
+require "openapi3_parser/validation/error_collection"
 
 module Openapi3Parser
   module NodeFactory
@@ -54,15 +56,14 @@ module Openapi3Parser
       def process_input(input)
         field_configs.each_with_object(input.dup) do |(field, config), memo|
           next unless config.factory?
-          next_context = context.next_namespace(field)
+          next_context = Context.next_field(context, field)
           memo[field] = config.initialize_factory(next_context, self)
         end
       end
 
-      def validate_input(error_collection)
-        super(error_collection)
-        validator = Validator.new(context.input, self)
-        error_collection.tap { |ec| ec.append(*validator.errors) }
+      def validate_input
+        validator = Validator.new(processed_input, self)
+        Validation::ErrorCollection.combine(super, validator.errors)
       end
 
       def build_node(input)

data/lib/openapi3_parser/node_factory/object/node_builder.rb

@@ -1,7 +1,8 @@
 # frozen_string_literal: true
 
-require "openapi3_parser/node_factory/object/validator"
+require "openapi3_parser/context"
 require "openapi3_parser/error"
+require "openapi3_parser/node_factory/object/validator"
 
 module Openapi3Parser
   module NodeFactory
@@ -32,16 +33,16 @@ module Openapi3Parser
         def check_required_fields
           fields = Validator.missing_required_fields(input, factory)
           return if fields.empty?
-          raise Openapi3Parser::Error,
+          raise Openapi3Parser::Error::MissingFields,
                 "Missing required fields for "\
-                  "#{context.stringify_namespace}: #{fields.join(', ')}"
+                  "#{context.location_summary}: #{fields.join(', ')}"
         end
 
         def check_unexpected_fields
           fields = Validator.unexpected_fields(input, factory)
           return if fields.empty?
-          raise Openapi3Parser::Error,
-                "Unexpected fields for #{context.stringify_namespace}: "\
+          raise Openapi3Parser::Error::UnexpectedFields,
+                "Unexpected fields for #{context.location_summary}: "\
                   "#{fields.join(', ')}"
         end
 
@@ -53,23 +54,23 @@ module Openapi3Parser
         end
 
         def check_type_error(name, field_config)
-          field_context = context.next_namespace(name)
+          field_context = Context.next_field(context, name)
           input = context.input.nil? ? nil : context.input[name]
           error = field_config.input_type_error(input, factory)
 
           return unless error
-          raise Openapi3Parser::Error,
+          raise Openapi3Parser::Error::InvalidType,
                 "Invalid type for "\
-                  "#{field_context.stringify_namespace}: #{error}"
+                  "#{field_context.location_summary}: #{error}"
         end
 
         def check_validation_errors(name, field_config)
-          field_context = context.next_namespace(name)
+          field_context = Context.next_field(context, name)
           errors = field_config.validation_errors(field_context.input, factory)
 
           return unless errors.any?
-          raise Openapi3Parser::Error,
-                "Invalid field for #{field_context.stringify_namespace}: "\
+          raise Openapi3Parser::Error::InvalidData,
+                "Invalid field for #{field_context.location_summary}: "\
                 "#{errors.join(', ')}"
         end
 

data/lib/openapi3_parser/node_factory/object/validator.rb

@@ -1,5 +1,6 @@
 # frozen_string_literal: true
 
+require "openapi3_parser/context"
 require "openapi3_parser/node_factory"
 require "openapi3_parser/validation/error"
 
@@ -10,7 +11,9 @@ module Openapi3Parser
         def self.missing_required_fields(input, factory)
           configs = factory.field_configs
           configs.each_with_object([]) do |(name, field_config), memo|
-            memo << name if field_config.required?(factory) && input[name].nil?
+            f = input[name]
+            is_nil = f.respond_to?(:nil_input?) ? f.nil_input? : f.nil?
+            memo << name if field_config.required?(factory) && is_nil
           end
         end
 
@@ -44,12 +47,17 @@ module Openapi3Parser
           factory.context
         end
 
+        def raw_input
+          context.input
+        end
+
         def missing_required_fields_error
           fields = self.class.missing_required_fields(input, factory)
           return unless fields.any?
           Validation::Error.new(
-            context.namespace,
-            "Missing required fields: #{fields.join(', ')}"
+            "Missing required fields: #{fields.join(', ')}",
+            context,
+            factory.class
           )
         end
 
@@ -57,42 +65,45 @@ module Openapi3Parser
           fields = self.class.unexpected_fields(input, factory)
           return unless fields.any?
           Validation::Error.new(
-            context.namespace,
-            "Unexpected fields: #{fields.join(', ')}"
+            "Unexpected fields: #{fields.join(', ')}",
+            context,
+            factory.class
           )
         end
 
         def invalid_field_errors
           factory.field_configs.inject([]) do |memo, (name, field_config)|
-            memo + field_errors(name, field_config)
+            memo + Array(field_errors(name, field_config))
           end
         end
 
         def field_errors(name, field_config)
           field = input[name]
-          return [] if field.nil?
+          return if field.nil?
           return field.errors.to_a if field.respond_to?(:errors)
           type_error = build_type_error(name, field_config)
-          return [type_error] if type_error
+          return type_error if type_error
           build_validation_errors(name, field_config)
         end
 
         def build_type_error(name, field_config)
-          type_error = field_config.input_type_error(input[name], factory)
+          type_error = field_config.input_type_error(raw_input[name], factory)
           return unless type_error
           Validation::Error.new(
-            context.next_namespace(name),
-            "Invalid type: #{type_error}"
+            "Invalid type: #{type_error}",
+            Context.next_field(context, name),
+            factory.class
           )
         end
 
         def build_validation_errors(name, field_config)
           field_config.validation_errors(
-            input[name], factory
+            raw_input[name], factory
           ).map do |error|
             Validation::Error.new(
-              context.next_namespace(name),
-              "Invalid field: #{error}"
+              "Invalid field: #{error}",
+              Context.next_field(context, name),
+              factory.class
             )
           end
         end

data/lib/openapi3_parser/nodes/components.rb

@@ -8,49 +8,47 @@ module Openapi3Parser
     class Components
       include Node::Object
 
-      # @return [Map] a map of String: {Schema}[../Schema.html] objects
+      # @return [Map<String, Schema>]
       def schemas
         node_data["schemas"]
       end
 
-      # @return [Map] a map of String: {Response}[./Response.html] objects
+      # @return [Map<String, Response>]
       def responses
         node_data["responses"]
       end
 
-      # @return [Map] a map of String: {Parameter}[./Parameter.html] objects
+      # @return [Map<String, Parameter>]
       def parameters
         node_data["parameters"]
       end
 
-      # @return [Map] a map of String: {Example}[../Example.html] objects
+      # @return [Map<String, Example>]
       def examples
         node_data["examples"]
       end
 
-      # @return [Map] a map of String: {RequestBody}[./RequestBody.html]
-      #         objects
+      # @return [Map<String, RequestBody>]
       def request_bodies
         node_data["requestBodies"]
       end
 
-      # @return [Map] a map of String: {Header}[./Header.html] objects
+      # @return [Map<String, Header>]
       def headers
         node_data["headers"]
       end
 
-      # @return [Map] a map of String: {SecurityScheme}[./SecurityScheme.html]
-      #         objects
+      # @return [Map<String, SecurityScheme>]
       def security_schemes
         node_data["securitySchemes"]
       end
 
-      # @return [Map] a map of String: {Link}[./Link.html] objects
+      # @return [Map<String, Link>]
       def links
         node_data["links"]
       end
 
-      # @return [Map] a map of String: {Callback}[./Callback.html] objects
+      # @return [Map<String, Callback>]
       def callbacks
         node_data["callbacks"]
       end

data/lib/openapi3_parser/nodes/discriminator.rb

@@ -13,7 +13,7 @@ module Openapi3Parser
         node_data["propertyName"]
       end
 
-      # @return [Map] a map of String: String objects
+      # @return [Map<String, String>]
       def mapping
         node_data["mapping"]
       end

data/lib/openapi3_parser/nodes/encoding.rb

@@ -13,7 +13,7 @@ module Openapi3Parser
         node_data["contentType"]
       end
 
-      # @return [Map] a map of String: {Header}[./Header.html] objects
+      # @return [Map<String, Header>]
       def headers
         node_data["headers"]
       end

data/lib/openapi3_parser/nodes/link.rb

@@ -18,7 +18,7 @@ module Openapi3Parser
         node_data["operationId"]
       end
 
-      # @return [Map] a map of String: {Parameter}[./Parameter.html] objects
+      # @return [Map<String, Parameter>]
       def parameters
         node_data["parameters"]
       end

data/lib/openapi3_parser/nodes/media_type.rb

@@ -18,12 +18,12 @@ module Openapi3Parser
         node_data["example"]
       end
 
-      # @return [Map] a map of String: {Example}[./Example.html] objects
+      # @return [Map<String, Example>]
       def examples
         node_data["examples"]
       end
 
-      # @return [Map] a map of String: {Encoding}[./Encoding.html] objects
+      # @return [Map<String, Encoding>]
       def encoding
         node_data["encoding"]
       end

data/lib/openapi3_parser/nodes/oauth_flow.rb

@@ -23,7 +23,7 @@ module Openapi3Parser
         node_data["refreshUrl"]
       end
 
-      # @return [Map] a map of String: String objects
+      # @return [Map<String, String>]
       def scopes
         node_data["scopes"]
       end

data/lib/openapi3_parser/nodes/openapi.rb

@@ -20,7 +20,7 @@ module Openapi3Parser
         node_data["info"]
       end
 
-      # @return [Nodes::Array] A collection of {Server}[./Server.html] objects
+      # @return [Nodes::Array<Server>]
       def servers
         node_data["servers"]
       end
@@ -35,13 +35,12 @@ module Openapi3Parser
         node_data["components"]
       end
 
-      # @return [Nodes::Array] a collection of
-      #         {SecurityRequirement}[./SecurityRequirement.html] objects
+      # @return [Nodes::Array<SecurityRequirement>]
       def security
         node_data["security"]
       end
 
-      # @return [Nodes::Array] A collection of {Tag}[./Tag.html] objects
+      # @return [Nodes::Array<Tag>]
       def tags
         node_data["tags"]
       end

data/lib/openapi3_parser/nodes/operation.rb

@@ -8,7 +8,7 @@ module Openapi3Parser
     class Operation
       include Node::Object
 
-      # @return [Nodes::Array] a collection of String objects
+      # @return [Nodes::Array<String>]
       def tags
         node_data["tags"]
       end
@@ -33,8 +33,7 @@ module Openapi3Parser
         node_data["operationId"]
       end
 
-      # @return [Nodes::Array] a collection of {Parameter}[./Parameter.html]
-      #         objects
+      # @return [Nodes::Array<Parameter>]
       def parameters
         node_data["parameters"]
       end
@@ -49,8 +48,7 @@ module Openapi3Parser
         node_data["responses"]
       end
 
-      # @return [Map] a collection of String: {Callback}[./Callback.html]
-      #         objects
+      # @return [Map<String, Callback>]
       def callbacks
         node_data["callbacks"]
       end
@@ -60,13 +58,12 @@ module Openapi3Parser
         node_data["deprecated"]
       end
 
-      # @return [Nodes::Array] a collection of
-      #         {SecurityRequirement}[./SecurityRequirement.html] objects
+      # @return [Nodes::Array<SecurityRequirement>]
       def security
         node_data["security"]
       end
 
-      # @return [Nodes::Array] a collection of {Server}[./Server.html] objects
+      # @return [Nodes::Array<Server>]
       def servers
         node_data["servers"]
       end

data/lib/openapi3_parser/nodes/parameter/parameter_like.rb

@@ -52,12 +52,12 @@ module Openapi3Parser
           node_data["example"]
         end
 
-        # @return [Map] a map of String: {Example}[../Example.html] objects
+        # @return [Map<String, Example>]
         def examples
           node_data["examples"]
         end
 
-        # @return [Map] a map of String: {MediaType}[../MediaType.html] objects
+        # @return [Map<String, MediaType>]
         def content
           node_data["content"]
         end