Merge pull request #4 from JaredCE/make-a-factory

Make a factory

Author: JaredCE

README.md

@@ -77,8 +77,7 @@ To run:
 
 ```
 const jsonSchema = require('simple.json.schema')
-const Convertor = require('index')
+const ConvertorFactory = require('index')
 
-const complexConvertor = new Convertor(complexOneOfSchema)
-const components = complexConvertor.convert()
+const convertedSchema = ConvertorFactory.convert(jsonSchema)
 ```

index.js

@@ -0,0 +1,4 @@
+'use strict'
+const Factory = require('./src/Factory')
+
+module.exports = Factory

package-lock.json

@@ -1,6 +1,6 @@
 {
   "name": "json-schema-for-openapi",
-  "version": "0.0.1",
+  "version": "0.1.0",
   "description": "Converts a regular JSON Schema to a compatible OpenAPI 3 Schema Object, extracting out $ref schemas to their own schema object",
   "keywords": ["json", "json-schema", "openAPI", "openAPI-v3"],
   "main": "index.js",

package.json

@@ -0,0 +1,14 @@
+'use strict'
+
+const Convertor = require('./Convertor')
+
+class SchemaFactory {
+    constructor() {}
+
+    static convert(schema) {
+        const convertedSchema = new Convertor(schema)
+        return convertedSchema.convert()
+    }
+}
+
+module.exports = SchemaFactory

src/Factory.js

@@ -0,0 +1,32 @@
+'use strict'
+
+const expect = require('chai').expect
+
+const Factory = require('../../src/Factory')
+
+const simpleSchema = require('../schemas/simple-one')
+const complexAllOfSchema = require('../schemas/complex-allOf')
+
+describe('Factory', () => {
+    beforeEach(function() {
+        delete require.cache[require.resolve('../schemas/simple-one')];
+        delete require.cache[require.resolve('../schemas/complex-allOf')];
+    });
+
+    describe('convert', () => {
+        it('should produce a converted schema as a factory', function() {
+            let expected = Factory.convert(simpleSchema)
+            expect(expected).to.be.an('object')
+            expect(expected).to.have.property('schemas')
+            expect(expected.schemas).to.have.property('main')
+            expect(expected.schemas.main).to.not.have.property('$schema')
+
+            expected = Factory.convert(complexAllOfSchema)
+            expect(expected).to.be.an('object')
+            expect(expected).to.have.property('schemas')
+            expect(expected.schemas).to.have.property('main')
+            expect(expected.schemas.main).to.not.have.property('$schema')
+            expect(expected.schemas).to.have.property('message')
+        });
+    });
+});

test/src/Factory.spec.js

@@ -0,0 +1,32 @@
+'use strict'
+
+const expect = require('chai').expect
+
+const Factory = require('../../index')
+
+const simpleSchema = require('../schemas/simple-one')
+const complexAllOfSchema = require('../schemas/complex-allOf')
+
+describe('index', () => {
+    beforeEach(function() {
+        delete require.cache[require.resolve('../schemas/simple-one')];
+        delete require.cache[require.resolve('../schemas/complex-allOf')];
+    });
+
+    describe('convert', () => {
+        it('should produce a converted schema', function() {
+            let expected = Factory.convert(simpleSchema)
+            expect(expected).to.be.an('object')
+            expect(expected).to.have.property('schemas')
+            expect(expected.schemas).to.have.property('main')
+            expect(expected.schemas.main).to.not.have.property('$schema')
+
+            expected = Factory.convert(complexAllOfSchema)
+            expect(expected).to.be.an('object')
+            expect(expected).to.have.property('schemas')
+            expect(expected.schemas).to.have.property('main')
+            expect(expected.schemas.main).to.not.have.property('$schema')
+            expect(expected.schemas).to.have.property('message')
+        });
+    });
+});