openapi3_parser 0.6.1 → 0.7.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: ca568bd4f56414a9a7467ba929750fe26ebe2ff6
-  data.tar.gz: 3e0a2532c02e114140e3ea53458e637308b1ab53
+  metadata.gz: e4d2e3dac62b0199c892ea6d0e9ed34dcea67c9d
+  data.tar.gz: 93839047c652d0342d0a6a6700863c4a143e3c21
 SHA512:
-  metadata.gz: 916678f780b8d71fd83c09a64fc6725e678dd8356a137d4b7295c7c4ca185d824c4803bae74c46de755faa5c52736ddcbada93fc0c88ef12d8b2e0e583edc56a
-  data.tar.gz: effde9d9458daf6d68bc5c9d79d137c32d583246f620f039b4606f1cf678d6f10bea2553a23b0930b2b73ecb0a665a66c9f5ac227e15956629095746363d634e
+  metadata.gz: 06c8d624f8a4a3e95f8838f60682a7a2861e333cfcb4c43a5f9fc4961406c1aeb5ad91da57e1664fa9a9d62eb7deaade81314ec924dec8e09b6eda1b00fb0d2b
+  data.tar.gz: 1304885f64188113d219df891a3584259cff0a628c696ad74902fd5667da994e9f2116ab880436f4e3c5a31a21605bb3f0c21a1202499780b6a861bb482713ad

data/CHANGELOG.md

@@ -1,3 +1,16 @@
+# 0.7.0
+
+- Add `#values` method to `Node::Object` and `Node#Map` to have a method that
+  pairs with `#keys`
+- Add `Node::Schema#requires?` method to simplify checking whether a property
+  is required by a particular schema.
+- Add `#==` methods to Node objects. This allows checking whether two nodes
+  are from the same source location even if they're referenced in different
+  places.
+- Add `Node::Schema#name` method that looks up the name of a Schema based
+  on it's contextual position in a document. Allows accessing the `Pet` value
+  from `#/components/schemas/Pet`.
+
 # 0.6.1
 
 - Fix bug where Node::Object and Node::Map iterated arrays rather than hashes

data/README.md

@@ -118,7 +118,7 @@ You can install this gem into your bundler application by adding this line to
 your Gemfile:
 
 ```
-gem "openapi3_parser", "~> 0.6.0"
+gem "openapi3_parser", "~> 0.7.0"
 ```
 
 and then running `$ bundle install`

data/lib/openapi3_parser/document.rb

@@ -60,7 +60,7 @@ module Openapi3Parser
     # @!method external_docs
     #   The value of the external_docs field on the OpenAPI document
     #   @see Node::Openapi#external_docs
-    #   @return [Node::ExternalDocumentation]
+    #   @return [Node::ExternalDocumentation, nil]
     # @!method extension
     #   Look up an extension field provided for the root object of the document
     #   @see Node::Object#extension

data/lib/openapi3_parser/node/array.rb

@@ -35,6 +35,14 @@ module Openapi3Parser
         Placeholder.each(node_data, &block)
       end
 
+      # @param [Any]  other
+      #
+      # @return [Boolean]
+      def ==(other)
+        other.instance_of?(self.class) &&
+          node_context.same_data_and_source?(other.node_context)
+      end
+
       # Used to access a node relative to this node
       # @param  [Source::Pointer, ::Array, ::String] pointer_like
       # @return anything

data/lib/openapi3_parser/node/context.rb

@@ -65,10 +65,19 @@ module Openapi3Parser
         @source_location = source_location
       end
 
+      # @param  [Context] other
       # @return [Boolean]
       def ==(other)
+        document_location == other.document_location &&
+          same_data_and_source?(other)
+      end
+
+      # Check that contexts are the same without concern for document location
+      #
+      # @param  [Context] other
+      # @return [Boolean]
+      def same_data_and_source?(other)
         input == other.input &&
-          document_location == other.document_location &&
           source_location == other.source_location
       end
 

data/lib/openapi3_parser/node/map.rb

@@ -48,6 +48,14 @@ module Openapi3Parser
         self["x-#{value}"]
       end
 
+      # @param [Any]  other
+      #
+      # @return [Boolean]
+      def ==(other)
+        other.instance_of?(self.class) &&
+          node_context.same_data_and_source?(other.node_context)
+      end
+
       # Iterates through the data of this node, used by Enumerable
       #
       # @return [Object]
@@ -55,6 +63,14 @@ module Openapi3Parser
         Placeholder.each(node_data, &block)
       end
 
+      # Provide an array of values for this object, a partner to the #keys
+      # method
+      #
+      # @return [Array]
+      def values
+        map(&:last)
+      end
+
       # Used to access a node relative to this node
       # @param  [Source::Pointer, ::Array, ::String] pointer_like
       # @return anything

data/lib/openapi3_parser/node/object.rb

@@ -48,6 +48,14 @@ module Openapi3Parser
         self["x-#{value}"]
       end
 
+      # @param [Any]  other
+      #
+      # @return [Boolean]
+      def ==(other)
+        other.instance_of?(self.class) &&
+          node_context.same_data_and_source?(other.node_context)
+      end
+
       # Iterates through the data of this node, used by Enumerable
       #
       # @return [Object]
@@ -55,6 +63,14 @@ module Openapi3Parser
         Placeholder.each(node_data, &block)
       end
 
+      # Provide an array of values for this object, a partner to the #keys
+      # method
+      #
+      # @return [Array]
+      def values
+        map(&:last)
+      end
+
       # Used to render fields that can be in markdown syntax into HTML
       # @param  [String, nil] value
       # @return [String, nil]

data/lib/openapi3_parser/node/schema.rb

@@ -7,6 +7,37 @@ module Openapi3Parser
     # @see https://github.com/OAI/OpenAPI-Specification/blob/master/versions/3.0.0.md#schemaObject
     # rubocop:disable 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"]

data/lib/openapi3_parser/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module Openapi3Parser
-  VERSION = "0.6.1"
+  VERSION = "0.7.0"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: openapi3_parser
 version: !ruby/object:Gem::Version
-  version: 0.6.1
+  version: 0.7.0
 platform: ruby
 authors:
 - Kevin Dew
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2019-10-09 00:00:00.000000000 Z
+date: 2019-10-11 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: commonmarker