refactor: apply feedback

apply feedback
loopbackio · Jan 11, 2020 · 5f394d5 · 5f394d5
1 parent 5f15308
commit 5f394d5
Show file tree

Hide file tree

Showing 6 changed files with 198 additions and 128 deletions.
diff --git a/...__tests__/unit/consolidate-schema.unit.ts → ...ncers/consolidate-schema.enhancer.unit.ts b/...__tests__/unit/consolidate-schema.unit.ts → ...ncers/consolidate-schema.enhancer.unit.ts
@@ -4,9 +4,11 @@
 // License text available at https://opensource.org/licenses/MIT
 
 import {expect} from '@loopback/testlab';
-import {ConsolidateSchemaObjects, OpenAPIObject} from '../..';
+import {ConsolidationEnhancer, OpenAPIObject} from '../../..';
 
-describe('ConsolidateSchemaObjects', () => {
+const consolidationEnhancer = new ConsolidationEnhancer();
+
+describe('consolidateSchemaObjects', () => {
   it('moves schema with title to component.schemas, replace with reference', () => {
     const inputSpec: OpenAPIObject = {
       openapi: '',
@@ -33,12 +35,12 @@ describe('ConsolidateSchemaObjects', () => {
       },
       paths: {
         schema: {
-          $ref: '#/components/schemas/LoopbackExample',
+          $ref: '#/components/schemas/loopback.example',
         },
       },
       components: {
         schemas: {
-          LoopbackExample: {
+          'loopback.example': {
             title: 'loopback.example',
             properties: {
               test: {
@@ -49,7 +51,7 @@ describe('ConsolidateSchemaObjects', () => {
         },
       },
     };
-    expect(ConsolidateSchemaObjects(inputSpec)).to.eql(expectedSpec);
+    expect(consolidationEnhancer.modifySpec(inputSpec)).to.eql(expectedSpec);
   });
 
   it('ignores schema without title property', () => {
@@ -69,7 +71,7 @@ describe('ConsolidateSchemaObjects', () => {
         },
       },
     };
-    expect(ConsolidateSchemaObjects(inputSpec)).to.eql(inputSpec);
+    expect(consolidationEnhancer.modifySpec(inputSpec)).to.eql(inputSpec);
   });
 
   it('Avoids naming collision', () => {
@@ -91,8 +93,8 @@ describe('ConsolidateSchemaObjects', () => {
       },
       components: {
         schemas: {
-          LoopbackExample: {
-            title: 'Different LoopbackExample exists',
+          'loopback.example': {
+            title: 'Different loopback.example exists',
             properties: {
               testDiff: {
                 type: 'string',
@@ -110,20 +112,20 @@ describe('ConsolidateSchemaObjects', () => {
       },
       paths: {
         schema: {
-          $ref: '#/components/schemas/LoopbackExample2',
+          $ref: '#/components/schemas/loopback.example1',
         },
       },
       components: {
         schemas: {
-          LoopbackExample: {
-            title: 'Different LoopbackExample exists',
+          'loopback.example': {
+            title: 'Different loopback.example exists',
             properties: {
               testDiff: {
                 type: 'string',
               },
             },
           },
-          LoopbackExample2: {
+          'loopback.example1': {
             title: 'loopback.example',
             properties: {
               test: {
@@ -134,7 +136,7 @@ describe('ConsolidateSchemaObjects', () => {
         },
       },
     };
-    expect(ConsolidateSchemaObjects(inputSpec)).to.eql(expectedSpec);
+    expect(consolidationEnhancer.modifySpec(inputSpec)).to.eql(expectedSpec);
   });
 
   it('If array items has no title, copy parent title if exists', () => {
@@ -147,7 +149,7 @@ describe('ConsolidateSchemaObjects', () => {
       paths: {
         schema: {
           myarray: {
-            title: 'my.array',
+            title: 'MyArray',
             type: 'array',
             items: {
               properties: {
@@ -169,18 +171,18 @@ describe('ConsolidateSchemaObjects', () => {
       paths: {
         schema: {
           myarray: {
-            title: 'my.array',
+            title: 'MyArray',
             type: 'array',
             items: {
-              $ref: '#/components/schemas/MyArray',
+              $ref: '#/components/schemas/MyArray.Items',
             },
           },
         },
       },
       components: {
         schemas: {
-          MyArray: {
-            title: 'my.array',
+          'MyArray.Items': {
+            title: 'MyArray.Items',
             properties: {
               test: {
                 type: 'string',
@@ -190,6 +192,6 @@ describe('ConsolidateSchemaObjects', () => {
         },
       },
     };
-    expect(ConsolidateSchemaObjects(inputSpec)).to.eql(expectedSpec);
+    expect(consolidationEnhancer.modifySpec(inputSpec)).to.eql(expectedSpec);
   });
 });
diff --git a/packages/openapi-v3/src/consolidate-schema.ts b/packages/openapi-v3/src/consolidate-schema.ts