fix(all): fix json import (#675)

z3dev · web-flow · commit 05caf60efc3f · 2020-09-14T07:22:52.000-04:00
* fix(io) created a list of deserializers for export

* fix(io) created a list of deserializers for export

* fix(cli) corrected generateOutputData to use the list of deserializers

* fix(core): changed registerAllExtensions to use the list of deserializers from io module

* fix(core): changed transformSource to use the list of serializers from io module

* tests(core): corrected require statements in webRequire test suite
diff --git a/packages/cli/src/generateOutputData.js b/packages/cli/src/generateOutputData.js
@@ -1,7 +1,7 @@
 const fs = require('fs')
 const { isAbsolute, resolve } = require('path')
 
-const { solidsAsBlob } = require('@jscad/io')
+const { deserializers, solidsAsBlob } = require('@jscad/io')
 
 const rebuildSolids = require('@jscad/core/code-evaluation/rebuildGeometryCli')
 const { registerAllExtensions } = require('@jscad/core/io/registerExtensions')
@@ -34,23 +34,14 @@ const generateOutputData = (source, params, options) => {
   return new Promise((resolve, reject) => {
     // FIXME this table should come from core
     const conversionTable = {
-      amf: data => require('@jscad/io').amfDeSerializer.deserialize(data.options, data.source),
-      obj: data => require('@jscad/io').objDeSerializer.deserialize(data.options, data.source),
-      stl: data => require('@jscad/io').stlDeSerializer.deserialize(data.options, data.source),
-      svg: data => require('@jscad/io').svgDeSerializer.deserialize(data.options, data.source),
-      dxf: data => require('@jscad/io').dxfDeSerializer.deserialize(data.options, data.source),
-      json: data => require('@jscad/io').jsonDeSerializer.deserialize(data.options, data.source),
+      amf: data => deserializers.amf(data.options, data.source),
+      obj: data => deserializers.obj(data.options, data.source),
+      stl: data => deserializers.stl(data.options, data.source),
+      svg: data => deserializers.svg(data.options, data.source),
+      dxf: data => deserializers.dxf(data.options, data.source),
+      json: data => deserializers.json(data.options, data.source),
       jscad: data => data.source,
       js: data => data.source,
-      /*
-      scad: data => {
-        const source = !data.source.match(/^\/\/!OpenSCAD/i) ? '//!OpenSCAD\n' + data.source : data.source
-        const parsed = require('@jscad/openscad-openjscad-translator').parse(source)
-        return `//producer: OpenJSCAD ${version}
-      // source: ${outputFile}
-      ${parsed}`
-      },
-*/
       undefined: data => reject(new Error(`unsuported input format ${inputFormat}`))
     }
 
diff --git a/packages/core/code-loading/transformSources.js b/packages/core/code-loading/transformSources.js
@@ -1,10 +1,13 @@
+const { deserializers } = require('@jscad/io')
+
 const isCommonJsModule = require('./isCommonJsModule')
 const modulifySource = require('./modulifySource')
 
 const passThroughTransform = (options, entry) => entry
 
 /* function to turn old style jscad code with implicit imports
 into code with explicit exports/imports */
+// FIXME wouldn't a javascript error be better then 'hacking' the users code?
 const modulifyTransform = (options, entry) => {
   const { apiMainPath } = options
   const isFileCommonJs = isCommonJsModule(entry.source)
@@ -23,62 +26,34 @@ const createJscadEntry = (entry, source) => {
   return Object.assign({}, entry, { ext, name, fullPath, source })
 }
 
-const transformAmfToJscad = (options, entry) => {
-  // console.log('***** transformAmfToJscad',options,entry)
-  const deserialize = require('@jscad/io').amfDeSerializer.deserialize
-  const source = deserialize(options, entry.source)
-  return createJscadEntry(entry, source)
-}
-
-const transformDxfToJscad = (options, entry) => {
-  // console.log('***** transformDxfToJscad',options,entry)
-  const deserialize = require('@jscad/io').dxfDeSerializer.deserialize
-  const source = deserialize(options, entry.source)
-  return createJscadEntry(entry, source)
-}
-
-const transformObjToJscad = (options, entry) => {
-  // console.log('***** transformObjToJscad',options,entry)
-  const deserialize = require('@jscad/io').objDeSerializer.deserialize
-  const source = deserialize(options, entry.source)
-  return createJscadEntry(entry, source)
-}
-
-const transformStlToJscad = (options, entry) => {
-  // console.log('***** transformStlToJscad',options,entry)
-  const deserialize = require('@jscad/io').stlDeSerializer.deserialize
-  const source = deserialize(options, entry.source)
-  return createJscadEntry(entry, source)
-}
-
-const transformSvgToJscad = (options, entry) => {
-  // console.log('***** transformSvgToJscad',options,entry)
-  const deserialize = require('@jscad/io').svgDeSerializer.deserialize
-  const source = deserialize(options, entry.source)
-  return createJscadEntry(entry, source)
-}
-
+/*
+ * Transform the given files and folders if necessary.
+ * Transforms are only applied to single files as current deserializers create source with a main() function. Only one.
+ * Transforms are NOT applied to projects.
+ */
 const transformSources = (options, filesAndFolders) => {
   // console.log('***** transformSources', options, filesAndFolders)
-  // FIXME this table should come from IO
-  const transformsPerFormat = {
+
+  if (filesAndFolders && filesAndFolders.length > 1) return filesAndFolders // skip projects
+
+  const codeTransforms = {
     js: [modulifyTransform],
-    jscad: [modulifyTransform],
-    // formats that require translation
-    amf: [transformAmfToJscad, modulifyTransform],
-    dxf: [transformDxfToJscad, modulifyTransform],
-    obj: [transformObjToJscad, modulifyTransform],
-    stl: [transformStlToJscad, modulifyTransform],
-    svg: [transformSvgToJscad, modulifyTransform]
+    jscad: [modulifyTransform]
   }
 
   const updateEntry = (entry) => {
-    if (entry.source) {
-      const transformOptions = Object.assign({}, options, { filename: entry.name })
-      const transforms = transformsPerFormat[entry.ext] ? transformsPerFormat[entry.ext] : [passThroughTransform]
-      const transformedEntry = transforms.reduce((entry, transform) => transform(transformOptions, entry), entry)
-
-      return transformedEntry
+    if (entry.source && entry.ext) {
+      const transformOptions = Object.assign({}, options, { filename: entry.name, output: 'script' })
+      if (entry.ext in deserializers) {
+        const deserializer = deserializers[entry.ext]
+        const source = deserializer(transformOptions, entry.source)
+        return createJscadEntry(entry, source)
+      }
+      if (entry.ext in codeTransforms) {
+        const transforms = codeTransforms[entry.ext]
+        const transformedEntry = transforms.reduce((entry, transform) => transform(transformOptions, entry), entry)
+        return transformedEntry
+      }
     }
     return entry
   }
diff --git a/packages/core/code-loading/webRequire.test.js b/packages/core/code-loading/webRequire.test.js
@@ -106,10 +106,11 @@ test('webRequire: should allow using require.extensions like the native node req
 
 test('webRequire: should allow using require.extensions like the native node require (parser)', (t) => {
   const registerStlExtension = (fs, _require) => {
-    const deserializer = require('@jscad/io').stlDeSerializer
+    const { deserializers } = require('@jscad/io')
+    const deserializer = deserializers.stl
     _require.extensions['.stl'] = (module, filename) => {
       const content = fs.readFileSync(filename, 'utf8')
-      const parsed = deserializer.deserialize({ filename, output: 'geometry' }, content)
+      const parsed = deserializer({ filename, output: 'geometry' }, content)
       module.exports = parsed
     }
   }
diff --git a/packages/core/io/registerExtensions.js b/packages/core/io/registerExtensions.js
@@ -1,3 +1,5 @@
+const { deserializers } = require('@jscad/io')
+
 // FIXME: the unregistering does not work, look into it
 const registerJscadExtension = (fs, _require) => {
   const stripBom = require('strip-bom')
@@ -10,95 +12,37 @@ const unRegisterJscadExtension = (fs, _require) => {
   delete _require.extensions['.jscad']
 }
 
-const registerStlExtension = (fs, _require) => {
-  const deserializer = require('@jscad/io').stlDeSerializer
-  _require.extensions['.stl'] = (module, filename) => {
-    const content = fs.readFileSync(filename, 'utf8')
-    const parsed = deserializer.deserialize({ filename, output: 'geometry' }, content)
-    module.exports = parsed
-  }
-}
-const unRegisterStlExtension = (fs, _require) => {
-  delete _require.extensions['.stl']
-}
-
-const registerAmfExtension = (fs, _require) => {
-  const deserializer = require('@jscad/io').amfDeSerializer
-  _require.extensions['.amf'] = (module, filename) => {
+const registerDeserializer = (extension, fs, _require) => {
+  const deserializer = deserializers[extension]
+  const fileExtension = '.' + extension
+  _require.extensions[fileExtension] = (module, filename) => {
     const content = fs.readFileSync(filename, 'utf8')
-    const parsed = deserializer.deserialize({ filename, output: 'geometry' }, content)
+    const parsed = deserializer({ filename, output: 'geometry' }, content)
     module.exports = parsed
   }
 }
-const unRegisterAmfExtension = (fs, _require) => {
-  delete _require.extensions['.amf']
-}
-
-const registerDxfExtension = (fs, _require) => {
-  const deserializer = require('@jscad/io').dxfDeSerializer
-  _require.extensions['.dxf'] = (module, filename) => {
-    const content = fs.readFileSync(filename, 'utf8')
-    const parsed = deserializer.deserialize({ filename, output: 'geometry' }, content)
-    module.exports = parsed
-  }
-}
-const unRegisterDxfExtension = (fs, _require) => {
-  delete _require.extensions['.dxf']
-}
-
-const registerObjExtension = (fs, _require) => {
-  const deserializer = require('@jscad/io').objDeSerializer
-  _require.extensions['.obj'] = (module, filename) => {
-    const content = fs.readFileSync(filename, 'utf8')
-    const parsed = deserializer.deserialize({ filename, output: 'geometry' }, content)
-    module.exports = parsed
-  }
-}
-const unRegisterObjExtension = (fs, _require) => {
-  delete _require.extensions['.obj']
-}
-
-const registerSvgExtension = (fs, _require) => {
-  const deserializer = require('@jscad/io').svgDeSerializer
-  _require.extensions['.svg'] = (module, filename) => {
-    const content = fs.readFileSync(filename, 'utf8')
-    const parsed = deserializer.deserialize({ filename, output: 'geometry' }, content)
-    module.exports = parsed
-  }
-}
-const unRegisterSvgExtension = (fs, _require) => {
-  delete _require.extensions['.svg']
+const unregisterDeserializer = (extension, fs, _require) => {
+  const fileExtension = '.' + extension
+  delete _require.extensions[fileExtension]
 }
 
 const registerAllExtensions = (fs, _require) => {
   registerJscadExtension(fs, _require)
 
-  registerAmfExtension(fs, _require)
-  registerDxfExtension(fs, _require)
-  registerObjExtension(fs, _require)
-  registerStlExtension(fs, _require)
-  registerSvgExtension(fs, _require)
+  for (const extension of Object.keys(deserializers)) {
+    registerDeserializer(extension, fs, _require)
+  }
 }
 
 const unRegisterAllExtensions = (fs, _require) => {
   unRegisterJscadExtension(fs, _require)
 
-  unRegisterAmfExtension(fs, _require)
-  unRegisterDxfExtension(fs, _require)
-  unRegisterObjExtension(fs, _require)
-  unRegisterStlExtension(fs, _require)
-  unRegisterSvgExtension(fs, _require)
+  for (const extension of Object.keys(deserializers)) {
+    unregisterDeserializer(extension, fs, _require)
+  }
 }
 
 module.exports = {
-  registerJscadExtension,
-
-  registerAmfExtension,
-  registerDxfExtension,
-  registerObjExtension,
-  registerStlExtension,
-  registerSvgExtension,
-
   registerAllExtensions,
   unRegisterAllExtensions
 }
diff --git a/packages/io/io/deserializers.js b/packages/io/io/deserializers.js
@@ -0,0 +1,17 @@
+const amfDeSerializer = require('@jscad/amf-deserializer')
+const dxfDeSerializer = require('@jscad/dxf-deserializer')
+const jsonDeSerializer = require('@jscad/json-deserializer')
+const objDeSerializer = require('@jscad/obj-deserializer')
+// const scadDeSerializer = require('@jscad/scad-deserializer') //FIXME: upgrade, fix before re-enabling
+const stlDeSerializer = require('@jscad/stl-deserializer')
+const svgDeSerializer = require('@jscad/svg-deserializer')
+
+const deserializers = {}
+deserializers[amfDeSerializer.extension] = amfDeSerializer.deserialize
+deserializers[dxfDeSerializer.extension] = dxfDeSerializer.deserialize
+deserializers[jsonDeSerializer.extension] = jsonDeSerializer.deserialize
+deserializers[objDeSerializer.extension] = objDeSerializer.deserialize
+deserializers[stlDeSerializer.extension] = stlDeSerializer.deserialize
+deserializers[svgDeSerializer.extension] = svgDeSerializer.deserialize
+
+module.exports = deserializers
diff --git a/packages/io/io/index.js b/packages/io/io/index.js
@@ -1,5 +1,4 @@
 const { makeBlob, convertToBlob } = require('@jscad/io-utils')
-const prepareOutput = require('./prepareOutput')
 
 const amfSerializer = require('@jscad/amf-serializer')
 const dxfSerializer = require('@jscad/dxf-serializer')
@@ -8,51 +7,21 @@ const stlSerializer = require('@jscad/stl-serializer')
 const svgSerializer = require('@jscad/svg-serializer')
 const x3dSerializer = require('@jscad/x3d-serializer')
 
-const amfDeSerializer = require('@jscad/amf-deserializer')
-const dxfDeSerializer = require('@jscad/dxf-deserializer')
-const jsonDeSerializer = require('@jscad/json-deserializer')
-const objDeSerializer = require('@jscad/obj-deserializer')
-// const scadDeSerializer = require('@jscad/scad-deserializer') //FIXME: upgrade, fix before re-enabling
-const stlDeSerializer = require('@jscad/stl-deserializer')
-const svgDeSerializer = require('@jscad/svg-deserializer')
+const prepareOutput = require('./prepareOutput')
+const deserializers = require('./deserializers')
 
 const solidsAsBlob = (solids, params) => convertToBlob(prepareOutput(solids, params))
 
 module.exports = {
   makeBlob,
+  solidsAsBlob,
+
   amfSerializer,
   dxfSerializer,
   jsonSerializer,
   stlSerializer,
   svgSerializer,
   x3dSerializer,
 
-  amfDeSerializer,
-  dxfDeSerializer,
-  jsonDeSerializer,
-  objDeSerializer,
-  // scadDeSerializer,  //FIXME: upgrade, fix before re-enabling
-  stlDeSerializer,
-  svgDeSerializer,
-
-  solidsAsBlob
+  deserializers
 }
-/* export {makeBlob} from './utils/Blob'
-
-import * as CAGToDxf from './serializers/CAGToDxf'
-import * as CAGToJson from './serializers/CAGToJson'
-import * as CAGToSvg from './serializers/CAGToSvg'
-import * as CSGToAMF from './serializers/CSGToAMF'
-import * as CSGToJson from './serializers/CSGToJson'
-import * as CSGToStla from './serializers/CSGToStla'
-import * as CSGToStlb from './serializers/CSGToStlb'
-import * as CSGToX3D from './serializers/CSGToX3D'
-
-export {CAGToDxf, CAGToJson, CAGToSvg, CSGToAMF, CSGToJson, CSGToStla, CSGToStlb, CSGToX3D}
-
-export {parseAMF} from './deserializers/parseAMF'
-export {parseGCode} from './deserializers/parseGCode'
-export {parseJSON} from './deserializers/parseJSON'
-export {parseOBJ} from './deserializers/parseOBJ'
-export {parseSTL} from './deserializers/parseSTL'
-export {parseSVG} from './deserializers/parseSVG' */

Original file line number	Diff line number	Diff line change
`@@ -106,10 +106,11 @@ test('webRequire: should allow using require.extensions like the native node req`
`106`	`106`
`107`	`107`	`test('webRequire: should allow using require.extensions like the native node require (parser)', (t) => {`
`108`	`108`	`const registerStlExtension = (fs, _require) => {`
`109`		`- const deserializer = require('@jscad/io').stlDeSerializer`
	`109`	`+ const { deserializers } = require('@jscad/io')`
	`110`	`+ const deserializer = deserializers.stl`
`110`	`111`	`_require.extensions['.stl'] = (module, filename) => {`
`111`	`112`	`const content = fs.readFileSync(filename, 'utf8')`
`112`		`- const parsed = deserializer.deserialize({ filename, output: 'geometry' }, content)`
	`113`	`+ const parsed = deserializer({ filename, output: 'geometry' }, content)`
`113`	`114`	`module.exports = parsed`
`114`	`115`	`}`
`115`	`116`	`}`