openapi3_parser 0.7.0 → 0.8.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: e4d2e3dac62b0199c892ea6d0e9ed34dcea67c9d
-  data.tar.gz: 93839047c652d0342d0a6a6700863c4a143e3c21
+  metadata.gz: 305a84267a984ae06f488b48ed4d9f385fddfccb
+  data.tar.gz: 51e8ed34fcc0b665658a4ff08d3ac51c2755f9bd
 SHA512:
-  metadata.gz: 06c8d624f8a4a3e95f8838f60682a7a2861e333cfcb4c43a5f9fc4961406c1aeb5ad91da57e1664fa9a9d62eb7deaade81314ec924dec8e09b6eda1b00fb0d2b
-  data.tar.gz: 1304885f64188113d219df891a3584259cff0a628c696ad74902fd5667da994e9f2116ab880436f4e3c5a31a21605bb3f0c21a1202499780b6a861bb482713ad
+  metadata.gz: c77b4149bba7eac8bb043b3c276325a4dc7de5605481e60a63fba01b0476c9f9fcc799ced7eda3bbbdc28cff955a64b578e48633d7f0ba7b0f3cbb659320ce58
+  data.tar.gz: 3dbe3f4d0235e8308cbf28aa4ce79e725bd6071b28f0e087e222d8f6a91cb618e8ea91c46bde703f393baf5c09e5bb3f7ed23741b3ae07275b6aed7f9a60b655

data/.gitignore

@@ -2,3 +2,4 @@
 /pkg
 /.yardoc
 /doc
+/coverage

data/.rubocop.yml

@@ -4,12 +4,10 @@ Metrics/MethodLength:
   Max: 30
 Metrics/AbcSize:
   Max: 30
-Documentation:
+Style/Documentation:
   Enabled: false
 Metrics/BlockLength:
   Exclude:
     - 'spec/**/*.rb'
-Naming/UncommunicativeMethodParamName:
-  Enabled: false
-Naming/UncommunicativeBlockParamName:
+Style/BracesAroundHashParameters:
   Enabled: false

data/.travis.yml

@@ -1,11 +1,22 @@
 language: ruby
 sudo: false
+env:
+  global:
+    CC_TEST_REPORTER_ID=8bc2d8e54331569aeb442094c21cb64a58d6efa0670f65ff00d9ae887f63c0b4
+    CC_RUBY_VERSION=ruby-2.4.6
 rvm:
   - 2.4.6
   - 2.5.5
   - 2.6.4
+  - 2.7.0
   - ruby-head
 matrix:
   allow_failures:
     - rvm: ruby-head
   fast_finish: true
+before_script:
+  - curl -L https://codeclimate.com/downloads/test-reporter/test-reporter-latest-linux-amd64 > ./cc-test-reporter
+  - chmod +x ./cc-test-reporter
+  - if [ $(rvm current) = $CC_RUBY_VERSION ]; then ./cc-test-reporter before-build; fi
+after_script:
+    - if [ $(rvm current) = $CC_RUBY_VERSION ]; then ./cc-test-reporter after-build --exit-code $TRAVIS_TEST_RESULT; fi

data/CHANGELOG.md

@@ -1,3 +1,16 @@
+# 0.8.0
+
+- Resolve deprecation warnings for Ruby 2.7
+- Resolve deprecation warnings for Psych
+- Operation and Path Item objects use servers that have cascaded from parent
+  objects if they do not have their own servers defined.
+- Add `#relative_node` and `#parent_node` methods to `Node::Context`.
+- Default to a server of "/" when given an empty or null servers input for
+  OpenAPI node.
+- Set referenced data as input and source location for a PathItem with only
+  a $ref value.
+- Fix data being lost in PathItem reference merges.
+
 # 0.7.0
 
 - Add `#values` method to `Node::Object` and `Node#Map` to have a method that

data/README.md

@@ -33,10 +33,13 @@ being:
 - Documentation for the API to navigate the OpenAPI nodes is available on
   [rubydoc.info][docs].
 
+I've wrote a blog post reflecting on the decisions involved in building this
+parser in [How to write an OpenAPI 3 parser][blog].
 
 [openapi-3]: https://github.com/OAI/OpenAPI-Specification
 [openapi-3-spec]: https://github.com/OAI/OpenAPI-Specification/blob/master/versions/3.0.2.md#specification
 [docs]: http://www.rubydoc.info/github/kevindew/openapi3_parser/Openapi3Parser/Node/Openapi
+[blog]: https://kevindew.me/post/188611423231/how-to-write-an-openapi-3-parser
 
 ## Usage
 
@@ -118,7 +121,7 @@ You can install this gem into your bundler application by adding this line to
 your Gemfile:
 
 ```
-gem "openapi3_parser", "~> 0.7.0"
+gem "openapi3_parser", "~> 0.8.0"
 ```
 
 and then running `$ bundle install`

data/TODO.md

@@ -32,7 +32,7 @@ These are the steps defined to reach 1.0. Assistance is very welcome.
 - [x] Ensure Array and Map nodes return empty ones by default rather than nil
 - [ ] Make JSON pointer public access to be consistent accepting string, array
       or (potentially) a pointer class
-- [ ] Support creating a default Server object on servers property of OpenAPI
+- [x] Support creating a default Server object on servers property of OpenAPI
       Node
 - [ ] Support relative URLs being able to be relative the first server object
       see: https://github.com/OAI/OpenAPI-Specification/blob/master/versions/3.0.1.md#relative-references-in-urls

data/lib/openapi3_parser.rb

@@ -1,8 +1,7 @@
 # frozen_string_literal: true
 
-Dir.glob(File.join(__dir__, "openapi3_parser", "**", "*.rb")).each do |file|
-  require file
-end
+files = Dir.glob(File.join(__dir__, "openapi3_parser", "**", "*.rb")).sort
+files.each { |file| require file }
 
 module Openapi3Parser
   # For a variety of inputs this will construct an OpenAPI document. For a

data/lib/openapi3_parser/array_sentence.rb

@@ -5,6 +5,7 @@ module Openapi3Parser
     refine ::Array do
       def sentence_join
         return join if count < 2
+
         self[0..-2].join(", ") + " and " + self[-1]
       end
     end

data/lib/openapi3_parser/document.rb

@@ -138,7 +138,7 @@ module Openapi3Parser
       look_up_pointer(pointer, relative_to, factory.resolved_input)
     end
 
-    # Look up a node at a particular location in the OpenAPI docuemnt
+    # Look up a node at a particular location in the OpenAPI document
     #
     # Examples:
     #
@@ -174,6 +174,7 @@ module Openapi3Parser
 
     def build
       return if build_in_progress || built
+
       @build_in_progress = true
       context = NodeFactory::Context.root(root_source.data, root_source)
       @factory = NodeFactory::Openapi.new(context)

data/lib/openapi3_parser/node/array.rb

@@ -14,7 +14,7 @@ module Openapi3Parser
       extend Forwardable
       include Enumerable
 
-      def_delegators :node_data, :empty?
+      def_delegators :node_data, :empty?, :length, :size
       attr_reader :node_data, :node_context
 
       # @param [::Array] data     data used to populate this node

data/lib/openapi3_parser/node/context.rb

@@ -133,6 +133,29 @@ module Openapi3Parser
       def node
         document.node_at(document_location.pointer)
       end
+
+      # Look up a node at a particular location in the OpenAPI docuemnt based
+      # on the relative position in the document of this context
+      #
+      # Examples:
+      #
+      # context.relative_node("#schemas")
+      # context.relative_node(%w[..])
+      #
+      # @param [Source::Pointer, String, Array] pointer
+      # @return anything
+      def relative_node(pointer)
+        document.node_at(pointer, document_location.pointer)
+      end
+
+      # Return the node that is the parent node for the node at this context
+      #
+      # @return [Node::Object, Node::Map, Node::Array, nil]
+      def parent_node
+        return if document_location.root?
+
+        relative_node("#..")
+      end
     end
   end
 end

data/lib/openapi3_parser/node/map.rb

@@ -8,7 +8,7 @@ module Openapi3Parser
       extend Forwardable
       include Enumerable
 
-      def_delegators :node_data, :keys, :empty?
+      def_delegators :node_data, :keys, :empty?, :length, :size
       attr_reader :node_data, :node_context
 
       def initialize(data, context)

data/lib/openapi3_parser/node/object.rb

@@ -76,6 +76,7 @@ module Openapi3Parser
       # @return [String, nil]
       def render_markdown(value)
         return if value.nil?
+
         Markdown.to_html(value)
       end
 

data/lib/openapi3_parser/node/operation.rb

@@ -70,6 +70,14 @@ module Openapi3Parser
       def servers
         self["servers"]
       end
+
+      # Whether this object uses it's own defined servers instead of falling
+      # back to the path items' ones.
+      #
+      # @return [Boolean]
+      def alternative_servers?
+        servers != node_context.parent_node.servers
+      end
     end
   end
 end

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,7 +17,7 @@ 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)
@@ -27,6 +31,9 @@ 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
@@ -41,10 +48,6 @@ module Openapi3Parser
                     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,7 +5,7 @@ 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.
@@ -177,6 +177,7 @@ module Openapi3Parser
       def additional_properties_schema
         properties = self["additionalProperties"]
         return if [true, false].include?(properties)
+
         properties
       end
 
@@ -240,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,