openapi3_parser 0.7.0 → 0.8.0

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
 
@@ -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

data/lib/openapi3_parser/node_factory/object_factory/dsl.rb

@@ -9,7 +9,7 @@ module Openapi3Parser
       module Dsl
         def field(name, **options)
           @field_configs ||= {}
-          @field_configs[name] = FieldConfig.new(options)
+          @field_configs[name] = FieldConfig.new(**options)
         end
 
         def field_configs

data/lib/openapi3_parser/node_factory/object_factory/field_config.rb

@@ -64,6 +64,7 @@ module Openapi3Parser
         def default(factory)
           return given_default.call if given_default.is_a?(Proc)
           return factory.send(given_default) if given_default.is_a?(Symbol)
+
           given_default
         end
 

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

@@ -31,6 +31,7 @@ module Openapi3Parser
 
         def node_data(parent_context)
           return build_node_data(parent_context) if empty_and_allowed_to_be?
+
           TypeChecker.raise_on_invalid_type(factory.context, type: ::Hash)
           validate(raise_on_invalid: true)
           build_node_data(parent_context)

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

@@ -81,6 +81,7 @@ module Openapi3Parser
             factory.data.each do |name, field|
               # references can reference themselves and become in a loop
               next if in_recursive_loop?(field)
+
               has_factory_errors = handle_factory_checks(name)
 
               next if has_factory_errors || !field.respond_to?(:errors)
@@ -108,10 +109,11 @@ module Openapi3Parser
           def check_field(name, field_config)
             return if factory.raw_input[name].nil?
 
-            field_validatable = Validation::Validatable.new(
-              factory,
-              context: Context.next_field(factory.context, name)
-            )
+            context = Context.next_field(factory.context,
+                                         name,
+                                         factory.raw_input[name])
+            field_validatable = Validation::Validatable.new(factory,
+                                                            context: context)
 
             valid_input_type = field_config.check_input_type(field_validatable,
                                                              building_node)

data/lib/openapi3_parser/node_factory/openapi.rb

@@ -32,6 +32,8 @@ module Openapi3Parser
 
       def servers_factory(context)
         NodeFactory::Array.new(context,
+                               default: [{ "url" => "/" }],
+                               use_default_on_empty: true,
                                value_factory: NodeFactory::Server)
       end
 

data/lib/openapi3_parser/node_factory/operation.rb

@@ -25,6 +25,10 @@ module Openapi3Parser
       private
 
       def build_object(data, context)
+        if data["servers"].node.empty?
+          data["servers"] = path_item_server_data(context)
+        end
+
         Node::Operation.new(data, context)
       end
 
@@ -72,6 +76,13 @@ module Openapi3Parser
         NodeFactory::Array.new(context,
                                value_factory: NodeFactory::Server)
       end
+
+      def path_item_server_data(node_context)
+        path_item_servers = node_context.parent_node.node_data["servers"]
+        Node::Placeholder.new(path_item_servers.node_factory,
+                              "servers",
+                              node_context)
+      end
     end
   end
 end

data/lib/openapi3_parser/node_factory/parameter.rb

@@ -47,11 +47,13 @@ module Openapi3Parser
 
       def default_style
         return "simple" if %w[path header].include?(context.input["in"])
+
         "form"
       end
 
       def validate_in(validatable)
         return if %w[header query cookie path].include?(validatable.input)
+
         validatable.add_error("in can only be header, query, cookie, or path")
       end
     end

data/lib/openapi3_parser/node_factory/parameter_like.rb

@@ -28,6 +28,7 @@ module Openapi3Parser
 
       def validate_content(validatable)
         return if validatable.input.size == 1
+
         validatable.add_error("Must only have one item")
       end
     end

data/lib/openapi3_parser/node_factory/path_item.rb

@@ -23,11 +23,22 @@ module Openapi3Parser
       private
 
       def build_object(data, node_context)
-        ref = data.delete("$ref").node
-        return Node::PathItem.new(data, node_context) unless ref
+        ref = data.delete("$ref")
+        context = if node_context.input.keys == %w[$ref]
+                    referenced_factory = ref.node_factory.referenced_factory
+                    Node::Context.resolved_reference(
+                      node_context,
+                      referenced_factory.context
+                    )
+                  else
+                    node_context
+                  end
 
-        context = data.empty? ? ref.node_context : node_context
-        data = merge_data(ref.node_data, data)
+        reference_data = ref.nil_input? ? {} : ref.node.node_data
+
+        data = merge_data(reference_data, data).tap do |d|
+          d["servers"] = root_server_data(context) if d["servers"].node.empty?
+        end
 
         Node::PathItem.new(data, context)
       end
@@ -57,7 +68,11 @@ module Openapi3Parser
 
       def merge_data(base, priority)
         base.merge(priority) do |_, old, new|
-          new.nil? ? old : new
+          if new.nil? || new.respond_to?(:nil_input?) && new.nil_input?
+            old
+          else
+            new
+          end
         end
       end
 
@@ -76,6 +91,13 @@ module Openapi3Parser
                                value_factory: factory,
                                validate: validate_parameters)
       end
+
+      def root_server_data(node_context)
+        root_servers = node_context.document.root.node_data["servers"]
+        Node::Placeholder.new(root_servers.node_factory,
+                              "servers",
+                              node_context)
+      end
     end
   end
 end

data/lib/openapi3_parser/node_factory/paths.rb

@@ -18,7 +18,7 @@ module Openapi3Parser
           /?
         )*
         \Z
-      }x
+      }x.freeze
 
       def initialize(context)
         factory = NodeFactory::OptionalReference.new(NodeFactory::PathItem)

data/lib/openapi3_parser/node_factory/response.rb

@@ -43,6 +43,7 @@ module Openapi3Parser
         validatable.input.each_key do |key|
           message = Validators::MediaType.call(key)
           next unless message
+
           validatable.add_error(message,
                                 Context.next_field(validatable.context, key))
         end

data/lib/openapi3_parser/node_factory/responses.rb

@@ -13,7 +13,7 @@ module Openapi3Parser
         [1-5]([0-9][0-9]|XX)
         )
         \Z
-      /x
+      /x.freeze
 
       def initialize(context)
         factory = NodeFactory::OptionalReference.new(NodeFactory::Response)

data/lib/openapi3_parser/node_factory/schema.rb

@@ -61,6 +61,7 @@ module Openapi3Parser
       def read_only_or_write_only(validatable)
         input = validatable.input
         return if [input["readOnly"], input["writeOnly"]].uniq != [true]
+
         validatable.add_error("readOnly and writeOnly cannot both be true")
       end
 
@@ -114,11 +115,13 @@ module Openapi3Parser
       def additional_properties_input_type(validatable)
         input = validatable.input
         return if [true, false].include?(input) || input.is_a?(Hash)
+
         validatable.add_error("Expected a Boolean or an Object")
       end
 
       def additional_properties_factory(context)
         return context.input if [true, false].include?(context.input)
+
         referenceable_schema(context)
       end
     end

data/lib/openapi3_parser/node_factory/server_variable.rb

@@ -19,6 +19,7 @@ module Openapi3Parser
           value_input_type: String,
           validate: lambda do |validatable|
             return if validatable.input.any?
+
             validatable.add_error("Expected atleast one value")
           end
         )

data/lib/openapi3_parser/node_factory/type_checker.rb

@@ -27,9 +27,11 @@ module Openapi3Parser
 
       def validate_type(validatable, context)
         return true unless type
+
         context ||= validatable.context
         valid_type?(context.input).tap do |valid|
           next if valid
+
           validatable.add_error("Invalid type. #{field_error_message}",
                                 context)
         end
@@ -37,9 +39,11 @@ module Openapi3Parser
 
       def validate_keys(validatable, context)
         return true unless type
+
         context ||= validatable.context
         valid_keys?(context.input).tap do |valid|
           next if valid
+
           validatable.add_error("Invalid keys. #{keys_error_message}",
                                 context)
         end
@@ -47,6 +51,7 @@ module Openapi3Parser
 
       def raise_on_invalid_type(context)
         return true if !type || valid_type?(context.input)
+
         raise Error::InvalidType,
               "Invalid type for #{context.location_summary}: "\
               "#{field_error_message}"
@@ -54,6 +59,7 @@ module Openapi3Parser
 
       def raise_on_invalid_keys(context)
         return true if !type || valid_keys?(context.input)
+
         raise Error::InvalidType,
               "Invalid keys for #{context.location_summary}: "\
               "#{keys_error_message}"

data/lib/openapi3_parser/source.rb

@@ -93,6 +93,7 @@ module Openapi3Parser
     # @return [Object]
     def data_at_pointer(json_pointer)
       return data if json_pointer.empty?
+
       data.dig(*json_pointer) if data.respond_to?(:dig)
     end
 
@@ -104,6 +105,7 @@ module Openapi3Parser
     # @return [String]
     def relative_to_root
       return "" if root?
+
       source_input.relative_to(document.root_source.source_input)
     end
 

data/lib/openapi3_parser/source/location.rb

@@ -1,15 +1,20 @@
 # frozen_string_literal: true
 
+require "forwardable"
+
 module Openapi3Parser
   class Source
     # Class used to represent a location within an OpenAPI document.
     # It contains a source, which is the source file/data used for the contents
     # and the pointer which indicates where in the object like file the data is
     class Location
+      extend Forwardable
+
       def self.next_field(location, field)
         new(location.source, location.pointer.segments + [field])
       end
 
+      def_delegators :pointer, :root?
       attr_reader :source, :pointer
 
       # @param [Openapi3Parser::Source] source
@@ -21,6 +26,7 @@ module Openapi3Parser
 
       def ==(other)
         return false unless other.instance_of?(self.class)
+
         source == other.source && pointer == other.pointer
       end
 

data/lib/openapi3_parser/source/pointer.rb

@@ -12,6 +12,7 @@ module Openapi3Parser
         absolute = fragment[0] == "/"
         segments = fragment.split("/").map do |part|
           next if part == ""
+
           unescaped = CGI.unescape(part.gsub("%20", "+"))
           unescaped.match?(/\A\d+\z/) ? unescaped.to_i : unescaped
         end
@@ -49,6 +50,10 @@ module Openapi3Parser
         %{#{self.class.name}(segments: #{segments}, fragment: "#{fragment}")}
       end
 
+      def root?
+        segments.empty?
+      end
+
       class MergePointers
         private_class_method :new
 

data/lib/openapi3_parser/source_input.rb

@@ -45,6 +45,7 @@ module Openapi3Parser
     def contents
       raise access_error if access_error
       raise parse_error if parse_error
+
       @contents
     end
 
@@ -61,6 +62,7 @@ module Openapi3Parser
 
     def initialize_contents
       return if access_error
+
       @contents = parse_contents
     rescue ::StandardError => e
       @parse_error = Error::UnparsableInput.new(e.message)