openapi_contracts 0.3.0 → 0.4.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: b457539132f36e2ce4da92d0b34721465ed731b5ce33323bedebbebcfe5ad8fa
-  data.tar.gz: 378f005f60327e8835908621f3991ffd8954434c5343ad91918026b0d2ce0444
+  metadata.gz: c495a3bb1abc5e8a6da67fc5ed5dc7a9ba98a42ebd84d5f80bc7665cb5badded
+  data.tar.gz: bcfc21e9c2b09c02f32a6e9eec7644a7790b94ac7c92a25c4aa54a55a46d307b
 SHA512:
-  metadata.gz: f556c79bb2c60a9489b9a48f31ac1acbff8fbbd0bf0279e2b8e5208c270fece99631d2cc8ee4e3d0579a2a82d8f3a4eeb566d609f79149f1d3622908460a2d8b
-  data.tar.gz: 2961f9afd81b0954fd8e37d0c7fe290e35d87c176d28772d9c272e5d3629440b1e4da5c7223beb1f73e564fd8bc277f3bb05b1061af4138ffb02c5dc677d005a
+  metadata.gz: d82aab412b36a2669556e69b0cdbec4f793076b4757050ad1b6b943856446f66e01d2b17f0d296e521fc04d39ebbfd83e481d1341de1c18290044d4baed0fd0c
+  data.tar.gz: 6fd2334e58fc53fd75b41c1ba9df2dd2a4da2925920c9ffcf2562df3f01b03e66e5801f88fbb691d5b73225ba9817bc1e42d89846f2b15ecaffa5a0e126e6b17

data/README.md

@@ -16,7 +16,7 @@ First parse your api documentation:
 
 ```ruby
 # This must point to the folder where the "openapi.yaml" file is
-$doc = OpenapiContracts::Doc.parse(Rails.root.join('spec', 'fixtures', 'openapi', 'api-docs', 'openapi'))
+$doc = OpenapiContracts::Doc.parse(Rails.root.join('spec/fixtures/openapi/api-docs/openapi'))
 ```
 
 Ideally you do this once in a RSpec `before(:suite)` hook.

data/lib/openapi_contracts/doc/parser.rb

@@ -12,14 +12,15 @@ module OpenapiContracts
       abs_path = @dir.join(path)
       data = parse_file(abs_path, translate: false)
       data.deep_merge! merge_components
-      join_partials(abs_path.dirname, data)
+      data = join_partials(abs_path.dirname, data)
+      nullable_to_type!(data)
     end
 
     private
 
     def parse_file(path, translate: true)
       schema = YAML.safe_load(File.read(path))
-      translate ? translate_paths(schema, Pathname(path).parent) : schema
+      translate ? translate_paths!(schema, Pathname(path).parent) : schema
     end
 
     def join_partials(cwd, data)
@@ -34,10 +35,23 @@ module OpenapiContracts
       end
     end
 
+    def nullable_to_type!(object)
+      case object
+      when Hash
+        if object['type'] && object['nullable']
+          object['type'] = [object['type'], 'null']
+          object.delete 'nullable'
+        else
+          object.each_value { |o| nullable_to_type! o }
+        end
+      when Array
+        object.each { |o| nullable_to_type! o }
+      end
+    end
+
     def merge_components
       data = {}
       Dir[File.expand_path('components/**/*.yaml', @dir)].each do |file|
-        # pn = Pathname(file).relative_path_from(@dir)
         pointer = json_pointer(Pathname(file)).split('/')
         i = 0
         pointer.reduce(data) do |h, p|
@@ -53,14 +67,17 @@ module OpenapiContracts
       data
     end
 
-    def translate_paths(data, cwd)
-      data.each_with_object({}) do |(key, val), m|
-        if val.is_a?(Hash)
-          m[key] = translate_paths(val, cwd)
-        elsif key == '$ref' && val !~ %r{^#/}
-          m[key] = json_pointer(cwd.join(val), '#/')
-        else
-          m[key] = val
+    def translate_paths!(data, cwd)
+      case data
+      when Array
+        data.each { |v| translate_paths!(v, cwd) }
+      when Hash
+        data.each_pair do |k, v|
+          if k == '$ref' && v !~ %r{^#/}
+            v.replace json_pointer(cwd.join(v), '#/')
+          else
+            translate_paths!(v, cwd)
+          end
         end
       end
     end

data/lib/openapi_contracts/doc/response.rb

@@ -1,7 +1,7 @@
 module OpenapiContracts
   class Doc::Response
     def initialize(schema)
-      @schema = schema
+      @schema = schema.follow_refs
     end
 
     def headers

data/lib/openapi_contracts/doc/schema.rb

@@ -7,6 +7,14 @@ module OpenapiContracts
       @path = path.freeze
     end
 
+    def follow_refs
+      if (ref = dig('$ref'))
+        at_path(ref.split('/')[1..])
+      else
+        self
+      end
+    end
+
     def fragment
       path.map { |p| p.gsub('/', '~1') }.join('/').then { |s| "#/#{s}" }
     end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: openapi_contracts
 version: !ruby/object:Gem::Version
-  version: 0.3.0
+  version: 0.4.2
 platform: ruby
 authors:
 - mkon
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2022-05-25 00:00:00.000000000 Z
+date: 2022-06-27 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activesupport
@@ -78,28 +78,28 @@ dependencies:
     requirements:
     - - '='
       - !ruby/object:Gem::Version
-        version: 1.29.0
+        version: 1.30.1
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - '='
       - !ruby/object:Gem::Version
-        version: 1.29.0
+        version: 1.30.1
 - !ruby/object:Gem::Dependency
   name: rubocop-rspec
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - '='
       - !ruby/object:Gem::Version
-        version: 2.10.0
+        version: 2.11.1
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - '='
       - !ruby/object:Gem::Version
-        version: 2.10.0
+        version: 2.11.1
 - !ruby/object:Gem::Dependency
   name: simplecov
   requirement: !ruby/object:Gem::Requirement
@@ -146,7 +146,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
       version: '2.7'
   - - "<"
     - !ruby/object:Gem::Version
-      version: '3.2'
+      version: '3.3'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="