openapi3_parser 0.5.2 → 0.6.0

data/lib/openapi3_parser/validators/duplicate_parameters.rb

@@ -15,10 +15,14 @@ module Openapi3Parser
       private
 
       def duplicate_names_by_in(resolved_input)
-        resolved_input.reject { |item| item["name"].nil? || item["in"].nil? }
-                      .group_by { |item| [item["name"], item["in"]] }
-                      .delete_if { |_, group| group.size < 2 }
-                      .keys
+        potential_items = resolved_input.reject do |item|
+          next true unless item.respond_to?(:keys)
+          item["name"].nil? || item["in"].nil?
+        end
+
+        potential_items.group_by { |item| [item["name"], item["in"]] }
+                       .delete_if { |_, group| group.size < 2 }
+                       .keys
       end
 
       def message(dupes)

data/lib/openapi3_parser/validators/reference.rb

@@ -20,11 +20,11 @@ module Openapi3Parser
       attr_reader :given_reference
 
       def build_errors
-        return "expected a string" unless given_reference.is_a?(String)
+        return "Expected a string" unless given_reference.is_a?(String)
         begin
           uri = URI.parse(given_reference)
         rescue URI::Error
-          return "could not parse as a URI"
+          return "Could not parse as a URI"
         end
         check_fragment(uri) || []
       end
@@ -33,7 +33,7 @@ module Openapi3Parser
         return if uri.fragment.nil? || uri.fragment.empty?
         first_char = uri.fragment[0]
 
-        "invalid JSON pointer, expected a root slash" if first_char != "/"
+        "Invalid JSON pointer, expected a root slash" if first_char != "/"
       end
     end
   end

data/lib/openapi3_parser/version.rb

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

data/openapi3_parser.gemspec

@@ -24,7 +24,7 @@ Gem::Specification.new do |spec|
     f.match(%r{^spec/})
   end
 
-  spec.required_ruby_version = ">= 2.3.0"
+  spec.required_ruby_version = ">= 2.4.0"
 
   spec.add_dependency "commonmarker", "~> 0.17"
 

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: openapi3_parser
 version: !ruby/object:Gem::Version
-  version: 0.5.2
+  version: 0.6.0
 platform: ruby
 authors:
 - Kevin Dew
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2018-08-29 00:00:00.000000000 Z
+date: 2019-10-07 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: commonmarker
@@ -131,17 +131,15 @@ files:
 - lib/openapi3_parser.rb
 - lib/openapi3_parser/array_sentence.rb
 - lib/openapi3_parser/cautious_dig.rb
-- lib/openapi3_parser/context.rb
-- lib/openapi3_parser/context/location.rb
-- lib/openapi3_parser/context/pointer.rb
 - lib/openapi3_parser/document.rb
-- lib/openapi3_parser/document/reference_register.rb
+- lib/openapi3_parser/document/reference_registry.rb
 - lib/openapi3_parser/error.rb
 - lib/openapi3_parser/markdown.rb
 - lib/openapi3_parser/node/array.rb
 - lib/openapi3_parser/node/callback.rb
 - lib/openapi3_parser/node/components.rb
 - lib/openapi3_parser/node/contact.rb
+- lib/openapi3_parser/node/context.rb
 - lib/openapi3_parser/node/discriminator.rb
 - lib/openapi3_parser/node/encoding.rb
 - lib/openapi3_parser/node/example.rb
@@ -161,6 +159,7 @@ files:
 - lib/openapi3_parser/node/parameter_like.rb
 - lib/openapi3_parser/node/path_item.rb
 - lib/openapi3_parser/node/paths.rb
+- lib/openapi3_parser/node/placeholder.rb
 - lib/openapi3_parser/node/request_body.rb
 - lib/openapi3_parser/node/response.rb
 - lib/openapi3_parser/node/responses.rb
@@ -176,6 +175,7 @@ files:
 - lib/openapi3_parser/node_factory/callback.rb
 - lib/openapi3_parser/node_factory/components.rb
 - lib/openapi3_parser/node_factory/contact.rb
+- lib/openapi3_parser/node_factory/context.rb
 - lib/openapi3_parser/node_factory/discriminator.rb
 - lib/openapi3_parser/node_factory/encoding.rb
 - lib/openapi3_parser/node_factory/example.rb
@@ -202,7 +202,6 @@ files:
 - lib/openapi3_parser/node_factory/parameter_like.rb
 - lib/openapi3_parser/node_factory/path_item.rb
 - lib/openapi3_parser/node_factory/paths.rb
-- lib/openapi3_parser/node_factory/recursive_pointer.rb
 - lib/openapi3_parser/node_factory/reference.rb
 - lib/openapi3_parser/node_factory/request_body.rb
 - lib/openapi3_parser/node_factory/response.rb
@@ -216,8 +215,10 @@ files:
 - lib/openapi3_parser/node_factory/type_checker.rb
 - lib/openapi3_parser/node_factory/xml.rb
 - lib/openapi3_parser/source.rb
+- lib/openapi3_parser/source/location.rb
+- lib/openapi3_parser/source/pointer.rb
 - lib/openapi3_parser/source/reference.rb
-- lib/openapi3_parser/source/reference_resolver.rb
+- lib/openapi3_parser/source/resolved_reference.rb
 - lib/openapi3_parser/source_input.rb
 - lib/openapi3_parser/source_input/file.rb
 - lib/openapi3_parser/source_input/raw.rb
@@ -252,7 +253,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: 2.3.0
+      version: 2.4.0
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
@@ -260,7 +261,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.5.1
+rubygems_version: 2.6.14.4
 signing_key: 
 specification_version: 4
 summary: An OpenAPI V3 parser for Ruby

data/lib/openapi3_parser/context.rb

@@ -1,162 +0,0 @@
-# frozen_string_literal: true
-
-module Openapi3Parser
-  # Context is a construct used in both the node factories and the nodes
-  # themselves. It is used to represent the data, and the source of it, that
-  # a node is associated with. It also acts as a bridge between a node/node
-  # factory and associated document.
-  #
-  # @attr_reader                            input
-  # @attr_reader  [Context::Location]       document_location
-  # @attr_reader  [Context::Location, nil]  source_location
-  # @attr_reader  [Context, nil]            referenced_by
-  class Context
-    # Create a context for the root of a document
-    # @return [Context]
-    def self.root(input, source)
-      location = Location.new(source, [])
-      new(input, document_location: location)
-    end
-
-    # Create a context for a field within the current contexts data
-    # eg for a context of:
-    #   root = Context.root({ "test" => {} }, source)
-    # we can get the context of "test" with:
-    #   test = Context.next_field(root, "test")
-    #
-    # @param  [Context] parent_context
-    # @param  [String]  field
-    # @return [Context]
-    def self.next_field(parent_context, field)
-      pc = parent_context
-      input = pc.input.respond_to?(:[]) ? pc.input[field] : nil
-      new(input,
-          document_location: Location.next_field(pc.document_location, field),
-          source_location: Location.next_field(pc.source_location, field),
-          referenced_by: pc.referenced_by)
-    end
-
-    # Convert a context into one that knows that is a reference
-    #
-    # @param  [Context] current_context
-    # @return [Context]
-    def self.as_reference(current_context)
-      new(current_context.input,
-          document_location: current_context.document_location,
-          source_location: current_context.source_location,
-          referenced_by: current_context.referenced_by,
-          is_reference: true)
-    end
-
-    # Creates the context for a field that is referenced by a context.
-    # In this scenario the context of the document is the same but we are in
-    # a different part of the source file, or even a different source file
-    #
-    # @param  [Context] referencer_context
-    # @param            input
-    # @param  [Source]  source
-    # @param  [::Array] pointer_segments
-    # @return [Context]
-    def self.reference_field(referencer_context,
-                             input:,
-                             source:,
-                             pointer_segments:)
-      new(input,
-          document_location: referencer_context.document_location,
-          source_location: Location.new(source, pointer_segments),
-          referenced_by: referencer_context)
-    end
-
-    attr_reader :input, :document_location, :source_location, :referenced_by
-
-    # @param                            input
-    # @param  [Context::Location]       document_location
-    # @param  [Context::Location, nil]  source_location
-    # @param  [Context, nil]            referenced_by
-    # @param  [Boolean]                 is_reference
-    def initialize(input,
-                   document_location:,
-                   source_location: nil,
-                   referenced_by: nil,
-                   is_reference: false)
-      @input = input
-      @document_location = document_location
-      @source_location = source_location || document_location
-      @referenced_by = referenced_by
-      @is_reference = is_reference
-    end
-
-    # @return [Boolean]
-    def ==(other)
-      input == other.input &&
-        document_location == other.document_location &&
-        source_location == other.source_location &&
-        referenced_by == other.referenced_by
-    end
-
-    # @return [Document]
-    def document
-      document_location.source.document
-    end
-
-    # @return [Source]
-    def source
-      source_location.source
-    end
-
-    # @return [Source::ReferenceResolver]
-    def register_reference(reference, factory)
-      source.register_reference(reference, factory, self)
-    end
-
-    # @deprecated
-    def namespace
-      document_location.pointer.segments
-    end
-
-    # @return [Boolean]
-    def reference?
-      @is_reference
-    end
-
-    def inspect
-      %{#{self.class.name}(document_location: #{document_location}, } +
-        %{source_location: #{source_location}), referenced_by: } +
-        %{#{referenced_by})}
-    end
-
-    def location_summary
-      summary = document_location.to_s
-      summary += " (#{source_location})" if document_location != source_location
-      summary
-    end
-
-    def to_s
-      location_summary
-    end
-
-    def resolved_input
-      # The resolved input for a reference is at the segment before the
-      # reference
-      pointer = if reference?
-                  document_location.pointer.segments[0...-1]
-                else
-                  document_location.pointer
-                end
-
-      document.resolved_input_at(pointer)
-    end
-
-    def node
-      # The created node for a reference is at the segment before the
-      # reference
-      pointer = if reference?
-                  document_location.pointer.segments[0...-1]
-                else
-                  document_location.pointer
-                end
-
-      document.node_at(pointer)
-    end
-  end
-end

data/lib/openapi3_parser/document/reference_register.rb

@@ -1,48 +0,0 @@
-# frozen_string_literal: true
-
-module Openapi3Parser
-  class Document
-    class ReferenceRegister
-      attr_reader :sources, :factories
-
-      def initialize
-        @sources = []
-        @factories = []
-      end
-
-      def register(factory)
-        error = "Can't register references when the register is frozen"
-        raise Error::ImmutableObject, error if frozen?
-        context = factory.context
-        add_source(context.source_location.source)
-        add_factory(factory)
-      end
-
-      def freeze
-        sources.freeze
-        factories.freeze
-        super
-      end
-
-      private
-
-      def add_source(source)
-        return if sources.include?(source)
-        sources << source
-      end
-
-      def add_factory(factory)
-        return if factory_registered?(factory)
-        factories << factory
-      end
-
-      def factory_registered?(factory)
-        source_location = factory.context.source_location
-        factories.any? do |f|
-          same_location = f.context.source_location == source_location
-          same_location && f.class == factory.class
-        end
-      end
-    end
-  end
-end

data/lib/openapi3_parser/node_factory/recursive_pointer.rb

@@ -1,17 +0,0 @@
-# frozen_string_literal: true
-
-module Openapi3Parser
-  module NodeFactory
-    class RecursivePointer
-      attr_reader :reference_context
-
-      def initialize(reference_context)
-        @reference_context = reference_context
-      end
-
-      def node
-        reference_context.node
-      end
-    end
-  end
-end

data/lib/openapi3_parser/source/reference_resolver.rb

@@ -1,82 +0,0 @@
-# frozen_string_literal: true
-
-module Openapi3Parser
-  class Source
-    class ReferenceResolver
-      def initialize(reference, factory, context)
-        @reference = reference
-        @factory = factory
-        @context = context
-      end
-
-      def reference_factory
-        @reference_factory ||= begin
-                                 next_context = Context.reference_field(
-                                   context,
-                                   input: source.data_at_pointer(json_pointer),
-                                   source: source,
-                                   pointer_segments: json_pointer
-                                 )
-                                 build_factory(next_context)
-                               end
-      end
-
-      def resolved_input
-        reference_factory.resolved_input
-      end
-
-      def valid?
-        errors.empty?
-      end
-
-      def errors
-        @errors ||= Array(build_errors)
-      end
-
-      def node
-        reference_factory.node
-      end
-
-      def in_root_source?
-        source == context.document.root_source
-      end
-
-      private
-
-      attr_reader :reference, :factory, :context
-
-      def source
-        @source ||= context.source.resolve_source(reference)
-      end
-
-      def build_errors
-        return source_unavailabe_error unless source.available?
-        return pointer_missing_error unless source.has_pointer?(json_pointer)
-        resolution_error unless reference_factory.valid?
-      end
-
-      def source_unavailabe_error
-        # @todo include a location
-        "Source is unavailable"
-      end
-
-      def pointer_missing_error
-        # @todo include a location and a pointer
-        "Source does not have pointer"
-      end
-
-      def resolution_error
-        # @todo include exepected object
-        "Reference does not resolve to a valid object"
-      end
-
-      def json_pointer
-        reference.json_pointer
-      end
-
-      def build_factory(context)
-        factory.is_a?(Class) ? factory.new(context) : factory.call(context)
-      end
-    end
-  end
-end