feat(OpenApi3.1): add fixed and mixed fields generic visitors

Closes #91
swagger-api · Sep 8, 2020 · 666ba12 · 666ba12
1 parent 21dcbcc
commit 666ba12
Show file tree

Hide file tree

Showing 19 changed files with 134 additions and 74 deletions.
diff --git a/apidom/packages/apidom-parser-adapter-openapi3-1-json/src/parser/specification.ts b/apidom/packages/apidom-parser-adapter-openapi3-1-json/src/parser/specification.ts
@@ -216,7 +216,9 @@ const specification = {
         },
         Responses: {
           $visitor: ResponsesVisitor,
-          fields: {},
+          fields: {
+            default: ExternalDocumentationDescriptionVisitor,
+          },
         },
         Callback: {
           $visitor: CallbackVisitor,

diff --git a/...rser-adapter-openapi3-1-json/src/parser/visitors/generics/FixedFieldsJsonObjectVisitor.ts b/...rser-adapter-openapi3-1-json/src/parser/visitors/generics/FixedFieldsJsonObjectVisitor.ts
@@ -1,12 +1,13 @@
 import stampit from 'stampit';
+import { noop } from 'ramda-adjunct';
 
 import SpecificationVisitor from '../SpecificationVisitor';
 import { isOpenApiExtension } from '../../predicates';
 import { visit, BREAK } from '..';
 
 const FixedFieldsJsonObjectVisitor = stampit(SpecificationVisitor, {
   props: {
-    specPath: [],
+    specPath: noop,
     ignoredFields: [],
     canSupportSpecificationExtensions: true,
   },
@@ -24,14 +25,15 @@ const FixedFieldsJsonObjectVisitor = stampit(SpecificationVisitor, {
   },
   methods: {
     object(objectNode) {
-      const fields = this.retrieveFields(this.specPath);
+      const specPath = this.specPath(objectNode);
+      const fields = this.retrieveFields(specPath);
 
       objectNode.properties.forEach((propertyNode: any) => {
         const keyName = propertyNode.key.value;
 
         if (fields.includes(keyName) && !this.ignoredFields.includes(keyName)) {
           const visitor = this.retrieveVisitorInstance([
-            ...this.specPath,
+            ...specPath,
             'fields',
             propertyNode.key.value,
           ]);

diff --git a/...pidom-parser-adapter-openapi3-1-json/src/parser/visitors/generics/MapJsonObjectVisitor.ts b/...pidom-parser-adapter-openapi3-1-json/src/parser/visitors/generics/MapJsonObjectVisitor.ts
@@ -1,61 +1,11 @@
 import stampit from 'stampit';
-import { noop } from 'ramda-adjunct';
+import { isNonEmptyString } from 'ramda-adjunct';
 
-import SpecificationVisitor from '../SpecificationVisitor';
-import { isOpenApiExtension } from '../../predicates';
-import { visit, BREAK } from '..';
+import PatternedFieldsJsonObjectVisitor from './PatternedFieldsJsonObjectVisitor';
 
-const MapJsonObjectVisitor = stampit(SpecificationVisitor, {
+const MapJsonObjectVisitor = stampit(PatternedFieldsJsonObjectVisitor, {
   props: {
-    specPath: noop,
-    ignoredFields: [],
-    canSupportSpecificationExtensions: false,
-  },
-  init({
-    // @ts-ignore
-    specPath = this.specPath,
-    // @ts-ignore
-    ignoredFields = this.ignoredFields,
-    // @ts-ignore
-    canSupportSpecificationExtensions = this.canSupportSpecificationExtensions,
-  } = {}) {
-    this.specPath = specPath;
-    this.ignoredFields = ignoredFields;
-    this.canSupportSpecificationExtensions = canSupportSpecificationExtensions;
-  },
-  methods: {
-    object(objectNode) {
-      objectNode.properties.forEach((propertyNode: any) => {
-        const keyName = propertyNode.key.value;
-
-        if (!this.ignoredFields.includes(keyName)) {
-          const specPath = this.specPath(propertyNode.value);
-          const visitor = this.retrieveVisitorInstance(specPath);
-          const keyElement = new this.namespace.elements.String(keyName);
-          const { MemberElement } = this.namespace.elements.Element.prototype;
-
-          visit(propertyNode, visitor);
-
-          const memberElement = this.maybeAddSourceMap(
-            propertyNode,
-            new MemberElement(
-              this.maybeAddSourceMap(propertyNode.key, keyElement),
-              visitor.element,
-            ),
-          );
-
-          this.element.content.push(memberElement);
-        } else if (this.canSupportSpecificationExtensions && isOpenApiExtension({}, propertyNode)) {
-          const visitor = this.retrieveVisitorInstance(['document', 'extension']);
-          visit(propertyNode, visitor);
-          this.element.content.push(visitor.element);
-        }
-      });
-
-      this.maybeAddSourceMap(objectNode, this.element);
-
-      return BREAK;
-    },
+    fieldPatternPredicate: isNonEmptyString,
   },
 });
 

diff --git a/...rser-adapter-openapi3-1-json/src/parser/visitors/generics/MixedFieldsJsonObjectVisitor.ts b/...rser-adapter-openapi3-1-json/src/parser/visitors/generics/MixedFieldsJsonObjectVisitor.ts
@@ -0,0 +1,24 @@
+import stampit from 'stampit';
+
+import { BREAK } from '..';
+import FixedFieldsJsonObjectVisitor from './FixedFieldsJsonObjectVisitor';
+import PatternedFieldsJsonObjectVisitor from './PatternedFieldsJsonObjectVisitor';
+
+const MixedFieldsJsonObjectVisitor = stampit(
+  FixedFieldsJsonObjectVisitor,
+  PatternedFieldsJsonObjectVisitor,
+  {
+    methods: {
+      object(objectNode) {
+        // @ts-ignore
+        FixedFieldsJsonObjectVisitor.compose.methods.object.call(this, objectNode);
+        // @ts-ignore
+        PatternedFieldsJsonObjectVisitor.compose.methods.object.call(this, objectNode);
+
+        return BREAK;
+      },
+    },
+  },
+);
+
+export default MixedFieldsJsonObjectVisitor;
diff --git a/...-adapter-openapi3-1-json/src/parser/visitors/generics/PatternedFieldsJsonObjectVisitor.ts b/...-adapter-openapi3-1-json/src/parser/visitors/generics/PatternedFieldsJsonObjectVisitor.ts
@@ -0,0 +1,64 @@
+import stampit from 'stampit';
+import { F as stubFalse } from 'ramda';
+import { noop } from 'ramda-adjunct';
+
+import SpecificationVisitor from '../SpecificationVisitor';
+import { isOpenApiExtension } from '../../predicates';
+import { visit, BREAK } from '..';
+
+const PatternedFieldsJsonObjectVisitor = stampit(SpecificationVisitor, {
+  props: {
+    fieldPatternPredicate: stubFalse,
+    specPath: noop,
+    ignoredFields: [],
+    canSupportSpecificationExtensions: false,
+  },
+  init({
+    // @ts-ignore
+    specPath = this.specPath,
+    // @ts-ignore
+    ignoredFields = this.ignoredFields,
+    // @ts-ignore
+    canSupportSpecificationExtensions = this.canSupportSpecificationExtensions,
+  } = {}) {
+    this.specPath = specPath;
+    this.ignoredFields = ignoredFields;
+    this.canSupportSpecificationExtensions = canSupportSpecificationExtensions;
+  },
+  methods: {
+    object(objectNode) {
+      objectNode.properties.forEach((propertyNode: any) => {
+        const keyName = propertyNode.key.value;
+
+        if (this.canSupportSpecificationExtensions && isOpenApiExtension({}, propertyNode)) {
+          const visitor = this.retrieveVisitorInstance(['document', 'extension']);
+          visit(propertyNode, visitor);
+          this.element.content.push(visitor.element);
+        } else if (!this.ignoredFields.includes(keyName) && this.fieldPatternPredicate(keyName)) {
+          const specPath = this.specPath(propertyNode.value);
+          const visitor = this.retrieveVisitorInstance(specPath);
+          const keyElement = new this.namespace.elements.String(keyName);
+          const { MemberElement } = this.namespace.elements.Element.prototype;
+
+          visit(propertyNode, visitor);
+
+          const memberElement = this.maybeAddSourceMap(
+            propertyNode,
+            new MemberElement(
+              this.maybeAddSourceMap(propertyNode.key, keyElement),
+              visitor.element,
+            ),
+          );
+
+          this.element.content.push(memberElement);
+        }
+      });
+
+      this.maybeAddSourceMap(objectNode, this.element);
+
+      return BREAK;
+    },
+  },
+});
+
+export default PatternedFieldsJsonObjectVisitor;
diff --git a/.../apidom-parser-adapter-openapi3-1-json/src/parser/visitors/open-api-3-1/callback/index.ts b/.../apidom-parser-adapter-openapi3-1-json/src/parser/visitors/open-api-3-1/callback/index.ts
@@ -1,10 +1,11 @@
 import stampit from 'stampit';
+import { always } from 'ramda';
 
 import FixedFieldsJsonObjectVisitor from '../../generics/FixedFieldsJsonObjectVisitor';
 
 const CallbackVisitor = stampit(FixedFieldsJsonObjectVisitor, {
   props: {
-    specPath: ['document', 'objects', 'Callback'],
+    specPath: always(['document', 'objects', 'Callback']),
   },
   init() {
     this.element = new this.namespace.elements.Callback();

diff --git a/...pidom-parser-adapter-openapi3-1-json/src/parser/visitors/open-api-3-1/components/index.ts b/...pidom-parser-adapter-openapi3-1-json/src/parser/visitors/open-api-3-1/components/index.ts
@@ -1,9 +1,11 @@
 import stampit from 'stampit';
+import { always } from 'ramda';
+
 import FixedFieldsJsonObjectVisitor from '../../generics/FixedFieldsJsonObjectVisitor';
 
 const ComponentsVisitor = stampit(FixedFieldsJsonObjectVisitor, {
   props: {
-    specPath: ['document', 'objects', 'Components'],
+    specPath: always(['document', 'objects', 'Components']),
   },
   init() {
     this.element = new this.namespace.elements.Components();

diff --git a/...s/apidom-parser-adapter-openapi3-1-json/src/parser/visitors/open-api-3-1/contact/index.ts b/...s/apidom-parser-adapter-openapi3-1-json/src/parser/visitors/open-api-3-1/contact/index.ts
@@ -1,10 +1,11 @@
 import stampit from 'stampit';
+import { always } from 'ramda';
 
 import FixedFieldsJsonObjectVisitor from '../../generics/FixedFieldsJsonObjectVisitor';
 
 const ContactVisitor = stampit(FixedFieldsJsonObjectVisitor, {
   props: {
-    specPath: ['document', 'objects', 'Contact'],
+    specPath: always(['document', 'objects', 'Contact']),
   },
   init() {
     this.element = new this.namespace.elements.License();

diff --git a/...-adapter-openapi3-1-json/src/parser/visitors/open-api-3-1/external-documentation/index.ts b/...-adapter-openapi3-1-json/src/parser/visitors/open-api-3-1/external-documentation/index.ts
@@ -1,10 +1,11 @@
 import stampit from 'stampit';
+import { always } from 'ramda';
 
 import FixedFieldsJsonObjectVisitor from '../../generics/FixedFieldsJsonObjectVisitor';
 
 const ExternalDocumentationVisitor = stampit(FixedFieldsJsonObjectVisitor, {
   props: {
-    specPath: ['document', 'objects', 'ExternalDocumentation'],
+    specPath: always(['document', 'objects', 'ExternalDocumentation']),
   },
   init() {
     this.element = new this.namespace.elements.ExternalDocumentation();

diff --git a/.../packages/apidom-parser-adapter-openapi3-1-json/src/parser/visitors/open-api-3-1/index.ts b/.../packages/apidom-parser-adapter-openapi3-1-json/src/parser/visitors/open-api-3-1/index.ts
@@ -1,9 +1,11 @@
 import stampit from 'stampit';
+import { always } from 'ramda';
+
 import FixedFieldsJsonObjectVisitor from '../generics/FixedFieldsJsonObjectVisitor';
 
 const OpenApi3_1Visitor = stampit(FixedFieldsJsonObjectVisitor, {
   props: {
-    specPath: ['document', 'objects', 'OpenApi'],
+    specPath: always(['document', 'objects', 'OpenApi']),
   },
   init() {
     this.element = new this.namespace.elements.OpenApi3_1();

diff --git a/...ages/apidom-parser-adapter-openapi3-1-json/src/parser/visitors/open-api-3-1/info/index.ts b/...ages/apidom-parser-adapter-openapi3-1-json/src/parser/visitors/open-api-3-1/info/index.ts
@@ -1,10 +1,11 @@
 import stampit from 'stampit';
+import { always } from 'ramda';
 
 import FixedFieldsJsonObjectVisitor from '../../generics/FixedFieldsJsonObjectVisitor';
 
 const InfoVisitor = stampit(FixedFieldsJsonObjectVisitor, {
   props: {
-    specPath: ['document', 'objects', 'Info'],
+    specPath: always(['document', 'objects', 'Info']),
   },
   init() {
     this.element = new this.namespace.elements.Info();

diff --git a/...s/apidom-parser-adapter-openapi3-1-json/src/parser/visitors/open-api-3-1/license/index.ts b/...s/apidom-parser-adapter-openapi3-1-json/src/parser/visitors/open-api-3-1/license/index.ts
@@ -1,10 +1,11 @@
 import stampit from 'stampit';
+import { always } from 'ramda';
 
 import FixedFieldsJsonObjectVisitor from '../../generics/FixedFieldsJsonObjectVisitor';
 
 const LicenseVisitor = stampit(FixedFieldsJsonObjectVisitor, {
   props: {
-    specPath: ['document', 'objects', 'License'],
+    specPath: always(['document', 'objects', 'License']),
   },
   init() {
     this.element = new this.namespace.elements.License();

diff --git a/...apidom-parser-adapter-openapi3-1-json/src/parser/visitors/open-api-3-1/operation/index.ts b/...apidom-parser-adapter-openapi3-1-json/src/parser/visitors/open-api-3-1/operation/index.ts
@@ -1,10 +1,11 @@
 import stampit from 'stampit';
+import { always } from 'ramda';
 
 import FixedFieldsJsonObjectVisitor from '../../generics/FixedFieldsJsonObjectVisitor';
 
 const OperationVisitor = stampit(FixedFieldsJsonObjectVisitor, {
   props: {
-    specPath: ['document', 'objects', 'Operation'],
+    specPath: always(['document', 'objects', 'Operation']),
   },
   init() {
     this.element = new this.namespace.elements.Operation();

diff --git a/...apidom-parser-adapter-openapi3-1-json/src/parser/visitors/open-api-3-1/path-item/index.ts b/...apidom-parser-adapter-openapi3-1-json/src/parser/visitors/open-api-3-1/path-item/index.ts
@@ -1,12 +1,13 @@
 import stampit from 'stampit';
 import { StringElement } from 'minim';
+import { always } from 'ramda';
 import { isOperationElement, OperationElement } from 'apidom-ns-openapi3-1';
 
 import FixedFieldsJsonObjectVisitor from '../../generics/FixedFieldsJsonObjectVisitor';
 
 const PathItemVisitor = stampit(FixedFieldsJsonObjectVisitor, {
   props: {
-    specPath: ['document', 'objects', 'PathItem'],
+    specPath: always(['document', 'objects', 'PathItem']),
   },
   init() {
     this.element = new this.namespace.elements.PathItem();

diff --git a/...apidom-parser-adapter-openapi3-1-json/src/parser/visitors/open-api-3-1/reference/index.ts b/...apidom-parser-adapter-openapi3-1-json/src/parser/visitors/open-api-3-1/reference/index.ts
@@ -1,10 +1,11 @@
 import stampit from 'stampit';
+import { always } from 'ramda';
 
 import FixedFieldsJsonObjectVisitor from '../../generics/FixedFieldsJsonObjectVisitor';
 
 const ReferenceVisitor = stampit(FixedFieldsJsonObjectVisitor, {
   props: {
-    specPath: ['document', 'objects', 'Reference'],
+    specPath: always(['document', 'objects', 'Reference']),
   },
   init() {
     this.element = new this.namespace.elements.Reference();

diff --git a/...dom-parser-adapter-openapi3-1-json/src/parser/visitors/open-api-3-1/request-body/index.ts b/...dom-parser-adapter-openapi3-1-json/src/parser/visitors/open-api-3-1/request-body/index.ts
@@ -1,10 +1,11 @@
 import stampit from 'stampit';
+import { always } from 'ramda';
 
 import FixedFieldsJsonObjectVisitor from '../../generics/FixedFieldsJsonObjectVisitor';
 
 const RequestBodyVisitor = stampit(FixedFieldsJsonObjectVisitor, {
   props: {
-    specPath: ['document', 'objects', 'RequestBody'],
+    specPath: always(['document', 'objects', 'RequestBody']),
   },
   init() {
     this.element = new this.namespace.elements.RequestBody();

diff --git a/...apidom-parser-adapter-openapi3-1-json/src/parser/visitors/open-api-3-1/responses/index.ts b/...apidom-parser-adapter-openapi3-1-json/src/parser/visitors/open-api-3-1/responses/index.ts
@@ -1,10 +1,13 @@
 import stampit from 'stampit';
+import { always, test } from 'ramda';
 
-import FixedFieldsJsonObjectVisitor from '../../generics/FixedFieldsJsonObjectVisitor';
+import MixedFieldsJsonObjectVisitor from '../../generics/MixedFieldsJsonObjectVisitor';
 
-const ResponsesVisitor = stampit(FixedFieldsJsonObjectVisitor, {
+const ResponsesVisitor = stampit(MixedFieldsJsonObjectVisitor, {
   props: {
-    specPath: ['document', 'objects', 'Responses'],
+    specPath: always(['document', 'objects', 'Responses']),
+    fieldPatternPredicate: test(/^\d{3}$/),
+    canSupportSpecificationExtensions: true,
   },
   init() {
     this.element = new this.namespace.elements.Responses();

diff --git a/...-parser-adapter-openapi3-1-json/src/parser/visitors/open-api-3-1/server-variable/index.ts b/...-parser-adapter-openapi3-1-json/src/parser/visitors/open-api-3-1/server-variable/index.ts
@@ -1,10 +1,11 @@
 import stampit from 'stampit';
+import { always } from 'ramda';
 
 import FixedFieldsJsonObjectVisitor from '../../generics/FixedFieldsJsonObjectVisitor';
 
 const ServerVariableVisitor = stampit(FixedFieldsJsonObjectVisitor, {
   props: {
-    specPath: ['document', 'objects', 'ServerVariable'],
+    specPath: always(['document', 'objects', 'ServerVariable']),
     canSupportSpecificationExtensions: true,
   },
   init() {

diff --git a/...es/apidom-parser-adapter-openapi3-1-json/src/parser/visitors/open-api-3-1/server/index.ts b/...es/apidom-parser-adapter-openapi3-1-json/src/parser/visitors/open-api-3-1/server/index.ts
@@ -1,10 +1,11 @@
 import stampit from 'stampit';
+import { always } from 'ramda';
 
 import FixedFieldsJsonObjectVisitor from '../../generics/FixedFieldsJsonObjectVisitor';
 
 const ServerVisitor = stampit(FixedFieldsJsonObjectVisitor, {
   props: {
-    specPath: ['document', 'objects', 'Server'],
+    specPath: always(['document', 'objects', 'Server']),
   },
   init() {
     this.element = new this.namespace.elements.Server();