openapi3_parser 0.5.2 → 0.6.0

data/lib/openapi3_parser/node/context.rb

@@ -0,0 +1,129 @@
+# frozen_string_literal: true
+
+module Openapi3Parser
+  module Node
+    # This class is used to specify the data and source information for a
+    # Node, for every node there is a different context to represent it's
+    # place within the document.
+    #
+    # @attr_reader  [Any]               input             The raw data that was
+    #                                                     used to build the
+    #                                                     node
+    # @attr_reader  [Source::Location]  document_location The location in the
+    #                                                     root source of this
+    #                                                     node
+    # @attr_reader  [Source::Location]  source_location   The location in a
+    #                                                     source file of this
+    class Context
+      # Create a context for the root of a document
+      #
+      # @param  [NodeFactory::Context]  factory_context
+      # @return [Node::Context]
+      def self.root(factory_context)
+        location = Source::Location.new(factory_context.source, [])
+        new(factory_context.input,
+            document_location: location,
+            source_location: factory_context.source_location)
+      end
+
+      # Create a context for the child of a previous context
+      #
+      # @param  [Node::Context]         parent_context
+      # @param  [String]                field
+      # @param  [NodeFactory::Context]  factory_context
+      # @return [Node::Context]
+      def self.next_field(parent_context, field, factory_context)
+        document_location = Source::Location.next_field(
+          parent_context.document_location,
+          field
+        )
+
+        new(factory_context.input,
+            document_location: document_location,
+            source_location: factory_context.source_location)
+      end
+
+      # Create a context for a the a field that is the result of a reference
+      #
+      # @param  [Node::Context]         current_context
+      # @param  [NodeFactory::Context]  reference_factory_context
+      # @return [Node::Context]
+      def self.resolved_reference(current_context, reference_factory_context)
+        new(reference_factory_context.input,
+            document_location: current_context.document_location,
+            source_location: reference_factory_context.source_location)
+      end
+
+      attr_reader :input, :document_location, :source_location
+
+      # @param                           input
+      # @param  [Source::Location]       document_location
+      # @param  [Source::Location]       source_location
+      def initialize(input, document_location:, source_location:)
+        @input = input
+        @document_location = document_location
+        @source_location = source_location
+      end
+
+      # @return [Boolean]
+      def ==(other)
+        input == other.input &&
+          document_location == other.document_location &&
+          source_location == other.source_location
+      end
+
+      # The OpenAPI document associated with this context
+      #
+      # @return [Document]
+      def document
+        document_location.source.document
+      end
+
+      # The source file used to provide the data for this node
+      #
+      # @return [Source]
+      def source
+        source_location.source
+      end
+
+      # @return [String]
+      def inspect
+        %{#{self.class.name}(document_location: #{document_location}, } +
+          %{source_location: #{source_location})}
+      end
+
+      # A string representing the location of the node
+      #
+      # @return [String]
+      def location_summary
+        summary = document_location.to_s
+
+        if document_location != source_location
+          summary += " (#{source_location})"
+        end
+
+        summary
+      end
+
+      # (see #location_summary)
+      def to_s
+        location_summary
+      end
+
+      # Used to return the data at this document location with all references
+      # resolved and optional fields populated with defaults
+      #
+      # @return [Any]
+      def resolved_input
+        document.resolved_input_at(document_location.pointer)
+      end
+
+      # Return the node for this context
+      #
+      # @return [Node::Object, Node::Map, Node::Array]
+      def node
+        document.node_at(document_location.pointer)
+      end
+    end
+  end
+end

data/lib/openapi3_parser/node/discriminator.rb

@@ -8,12 +8,12 @@ module Openapi3Parser
     class Discriminator < Node::Object
       # @return [String]
       def property_name
-        node_data["propertyName"]
+        self["propertyName"]
       end
 
       # @return [Map<String, String>]
       def mapping
-        node_data["mapping"]
+        self["mapping"]
       end
     end
   end

data/lib/openapi3_parser/node/encoding.rb

@@ -8,27 +8,27 @@ module Openapi3Parser
     class Encoding < Node::Object
       # @return [String, nil]
       def content_type
-        node_data["contentType"]
+        self["contentType"]
       end
 
       # @return [Map<String, Header>]
       def headers
-        node_data["headers"]
+        self["headers"]
       end
 
       # @return [String, nil]
       def style
-        node_data["style"]
+        self["style"]
       end
 
       # @return [Boolean]
       def explode?
-        node_data["explode"]
+        self["explode"]
       end
 
       # @return [Boolean]
       def allow_reserved?
-        node_data["allowReserved"]
+        self["allowReserved"]
       end
     end
   end

data/lib/openapi3_parser/node/example.rb

@@ -8,12 +8,12 @@ module Openapi3Parser
     class Example < Node::Object
       # @return [String, nil]
       def summary
-        node_data["summary"]
+        self["summary"]
       end
 
       # @return [String, nil]
       def description
-        node_data["description"]
+        self["description"]
       end
 
       # @return [String, nil]
@@ -23,12 +23,12 @@ module Openapi3Parser
 
       # @return [Object]
       def value
-        node_data["value"]
+        self["value"]
       end
 
       # @return [String, nil]
       def external_value
-        node_data["externalValue"]
+        self["externalValue"]
       end
     end
   end

data/lib/openapi3_parser/node/external_documentation.rb

@@ -8,7 +8,7 @@ module Openapi3Parser
     class ExternalDocumentation < Node::Object
       # @return [String, nil]
       def description
-        node_data["description"]
+        self["description"]
       end
 
       # @return [String, nil]
@@ -18,7 +18,7 @@ module Openapi3Parser
 
       # @return [String]
       def url
-        node_data["url"]
+        self["url"]
       end
     end
   end

data/lib/openapi3_parser/node/info.rb

@@ -8,12 +8,12 @@ module Openapi3Parser
     class Info < Node::Object
       # @return [String]
       def title
-        node_data["title"]
+        self["title"]
       end
 
       # @return [String, nil]
       def description
-        node_data["description"]
+        self["description"]
       end
 
       # @return [String, nil]
@@ -23,22 +23,22 @@ module Openapi3Parser
 
       # @return [String, nil]
       def terms_of_service
-        node_data["termsOfService"]
+        self["termsOfService"]
       end
 
       # @return [Contact, nil]
       def contact
-        node_data["contact"]
+        self["contact"]
       end
 
       # @return [License, nil]
       def license
-        node_data["license"]
+        self["license"]
       end
 
       # @return [String]
       def version
-        node_data["version"]
+        self["version"]
       end
     end
   end

data/lib/openapi3_parser/node/license.rb

@@ -8,12 +8,12 @@ module Openapi3Parser
     class License < Node::Object
       # @return [String]
       def name
-        node_data["name"]
+        self["name"]
       end
 
       # @return [String, nil]
       def url
-        node_data["url"]
+        self["url"]
       end
     end
   end

data/lib/openapi3_parser/node/link.rb

@@ -8,27 +8,27 @@ module Openapi3Parser
     class Link < Node::Object
       # @return [String, nil]
       def operation_ref
-        node_data["operationRef"]
+        self["operationRef"]
       end
 
       # @return [String, nil]
       def operation_id
-        node_data["operationId"]
+        self["operationId"]
       end
 
       # @return [Map<String, Parameter>]
       def parameters
-        node_data["parameters"]
+        self["parameters"]
       end
 
       # @return [Any]
       def request_body
-        node_data["requestBody"]
+        self["requestBody"]
       end
 
       # @return [String, nil]
       def description
-        node_data["description"]
+        self["description"]
       end
 
       # @return [String, nil]
@@ -38,7 +38,7 @@ module Openapi3Parser
 
       # @return [Server, nil]
       def server
-        node_data["server"]
+        self["server"]
       end
     end
   end

data/lib/openapi3_parser/node/map.rb

@@ -8,7 +8,7 @@ module Openapi3Parser
       extend Forwardable
       include Enumerable
 
-      def_delegators :node_data, :each, :keys, :empty?
+      def_delegators :node_data, :keys, :empty?
       attr_reader :node_data, :node_context
 
       def initialize(data, context)
@@ -32,7 +32,7 @@ module Openapi3Parser
       #
       # @return anything
       def [](value)
-        node_data[value.to_s]
+        Placeholder.resolve(node_data[value.to_s])
       end
 
       # Look up an extension provided for this map, doesn't need a prefix of
@@ -45,11 +45,15 @@ module Openapi3Parser
       #
       # @return [Hash, Array, Numeric, String, true, false, nil]
       def extension(value)
-        node_data["x-#{value}"]
+        self["x-#{value}"]
+      end
+
+      def each
+        node_data.each_key { |key| yield(self[key]) }
       end
 
       # Used to access a node relative to this node
-      # @param  [Context::Pointer, ::Array, ::String] pointer_like
+      # @param  [Source::Pointer, ::Array, ::String] pointer_like
       # @return anything
       def node_at(pointer_like)
         current_pointer = node_context.document_location.pointer

data/lib/openapi3_parser/node/media_type.rb

@@ -8,22 +8,22 @@ module Openapi3Parser
     class MediaType < Node::Object
       # @return [Schema, nil]
       def schema
-        node_data["schema"]
+        self["schema"]
       end
 
       # @return [Any]
       def example
-        node_data["example"]
+        self["example"]
       end
 
-      # @return [Map<String, Example>]
+      # @return [Map<String, Example>, nil]
       def examples
-        node_data["examples"]
+        self["examples"]
       end
 
       # @return [Map<String, Encoding>]
       def encoding
-        node_data["encoding"]
+        self["encoding"]
       end
     end
   end

data/lib/openapi3_parser/node/oauth_flow.rb

@@ -8,22 +8,22 @@ module Openapi3Parser
     class OauthFlow < Node::Object
       # @return [String, nil]
       def authorization_url
-        node_data["authorizationUrl"]
+        self["authorizationUrl"]
       end
 
       # @return [String, nil]
       def token_url
-        node_data["tokenUrl"]
+        self["tokenUrl"]
       end
 
       # @return [String, nil]
       def refresh_url
-        node_data["refreshUrl"]
+        self["refreshUrl"]
       end
 
       # @return [Map<String, String>]
       def scopes
-        node_data["scopes"]
+        self["scopes"]
       end
     end
   end

data/lib/openapi3_parser/node/oauth_flows.rb

@@ -8,22 +8,22 @@ module Openapi3Parser
     class OauthFlows < Node::Object
       # @return [OauthFlow, nil]
       def implicit
-        node_data["implicit"]
+        self["implicit"]
       end
 
       # @return [OauthFlow, nil]
       def password
-        node_data["password"]
+        self["password"]
       end
 
       # @return [OauthFlow, nil]
       def client_credentials
-        node_data["clientCredentials"]
+        self["clientCredentials"]
       end
 
       # @return [OauthFlow, nil]
       def authorization_code
-        node_data["authorizationCode"]
+        self["authorizationCode"]
       end
     end
   end

data/lib/openapi3_parser/node/object.rb

@@ -8,7 +8,7 @@ module Openapi3Parser
       extend Forwardable
       include Enumerable
 
-      def_delegators :node_data, :each, :keys, :empty?
+      def_delegators :node_data, :keys, :empty?
       attr_reader :node_data, :node_context
 
       def initialize(data, context)
@@ -32,7 +32,7 @@ module Openapi3Parser
       #
       # @return anything
       def [](value)
-        node_data[value.to_s]
+        Placeholder.resolve(node_data[value.to_s])
       end
 
       # Look up an extension provided for this object, doesn't need a prefix of
@@ -45,7 +45,11 @@ module Openapi3Parser
       #
       # @return [Hash, Array, Numeric, String, true, false, nil]
       def extension(value)
-        node_data["x-#{value}"]
+        self["x-#{value}"]
+      end
+
+      def each
+        node_data.each_key { |key| yield(self[key]) }
       end
 
       # Used to render fields that can be in markdown syntax into HTML
@@ -64,7 +68,7 @@ module Openapi3Parser
       # @example Jumping way down the tree
       #   obj.node_at("#properties/Field/type")
       #
-      # @param  [Context::Pointer, ::Array, ::String] pointer_like
+      # @param  [Source::Pointer, ::Array, ::String] pointer_like
       # @return anything
       def node_at(pointer_like)
         current_pointer = node_context.document_location.pointer