clean code

Author: Riccardo Di Benedetto

config/karma.conf.js

@@ -19,8 +19,8 @@ module.exports = function (config) {
     // preprocess matching files before serving them to the browser
     // available preprocessors: https://npmjs.org/browse/keyword/karma-preprocessor
     preprocessors: {
-      './src/core.js': [ 'webpack', 'sourcemap' ], // Same as entrypoint specified in webpack.config.js
-      './tests/unit/**/*.spec.js': [ 'webpack', 'sourcemap']
+      './src/core.js': ['webpack', 'sourcemap'], // Same as entrypoint specified in webpack.config.js
+      './tests/unit/**/*.spec.js': ['webpack', 'sourcemap']
     },
 
     // list of files / patterns to exclude
@@ -63,7 +63,7 @@ module.exports = function (config) {
 
     // start these browsers
     // available browser launchers: https://npmjs.org/browse/keyword/karma-launcher
-    browsers: ['ChromeHeadless'],
+    browsers: ['ChromeHeadless', 'Chrome'],
 
     customLaunchers: {
       Chrome_with_debugging: {

package.json

@@ -3,7 +3,7 @@
   "title": "JSONEditor",
   "description": "JSON Schema based editor",
   "version": "2.2.1",
-  "main": "dist/nonmin/jsoneditor.js",
+  "main": "dist/jsoneditor.js",
   "author": {
     "name": "Jeremy Dorn",
     "email": "jeremy@jeremydorn.com",
@@ -26,7 +26,7 @@
     "prepare": "npm run build",
     "clean": "npm run clean.css.js",
     "clean.css.js": "find ./src -name *.css.js -type f -delete",
-    "build": "npm run build.nonmin",
+    "build": "npm run build.prod && npm run build.nonmin",
     "build.prod": "webpack --config config/webpack.prod.js --progress --profile --bail",
     "build.nonmin": "webpack --config config/webpack.nonmin.js --progress --profile --bail",
     "build.dev": "webpack --config config/webpack.dev.js --progress --profile --bail",
@@ -45,8 +45,7 @@
     "cp:fulltest": "codeceptjs run --steps",
     "cp:fulltestmocha": "codeceptjs run --steps --reporter mochawesome",
     "eslint.fix": "eslint -c ./.eslintrc src/**/*.js --fix",
-    "eslint": "eslint -c ./.eslintrc src/**/*.js",
-    "my-test": "jasmine ./tests/unit/core.spec.js"
+    "eslint": "eslint -c ./.eslintrc src/**/*.js"
   },
   "license": "MIT",
   "engines": {

src/core.js

@@ -26,9 +26,8 @@ export class JSONEditor {
     const themeName = this.options.theme || JSONEditor.defaults.theme
     const themeClass = JSONEditor.defaults.themes[themeName]
 
-    this.MAX_RECURSIONS = this.options.maxRecurions
+    this.MAX_RECURSIONS = this.options.maxRecursions
 
-    console.log('Current options ', this.options)
     /* Load editors and selected theme style rules */
     if (!themeClass) throw new Error(`Unknown theme ${themeName}`)
     this.element.setAttribute('data-theme', themeName)
@@ -73,9 +72,11 @@ export class JSONEditor {
         required: true,
         container: this.root_container
       })
+
       this.root.preBuild()
       this.root.build()
       this.root.postBuild()
+
       /* Starting data */
       if (hasOwnProperty(this.options, 'startval')) this.root.setValue(this.options.startval)
 
@@ -214,10 +215,10 @@ export class JSONEditor {
     return JSONEditor.defaults.editors[classname]
   }
 
-  createEditor (editorClass, options, recursion = 0, onRecursionStopCallback) {
+  createEditor (editorClass, options, recursion = 0) {
     options = extend({}, editorClass.options || {}, options)
     // eslint-disable-next-line new-cap
-    return new editorClass(options, JSONEditor.defaults, recursion, onRecursionStopCallback)
+    return new editorClass(options, JSONEditor.defaults, recursion)
   }
 
   onChange () {

src/defaults.js

@@ -285,7 +285,7 @@ const options = {
   upload,
   prompt_before_delete: true,
   useDefault: true,
-  maxRecurions: 99999
+  maxRecursions: 99999
 }
 
 /* This assignment was previously in index.js but makes more sense here */

src/editors/object.js

@@ -2,13 +2,10 @@ import { AbstractEditor } from '../editor.js'
 import { extend, trigger, hasOwnProperty } from '../utilities.js'
 
 export class ObjectEditor extends AbstractEditor {
-  constructor (a, b, recursion, stopRecursionCallback = () => {}) {
-    super(a, b)
-    this._recursion = recursion
-    this._stopRecursionCallback = stopRecursionCallback
+  constructor (options, defaults, recursions) {
+    super(options, defaults)
+    this.currentRecursions = recursions
     this.collapsed = null
-    this.collapseOnStopRecursion = this.collapseOnStopRecursion.bind(this)
-    console.log('jsoneditor MAX_RECURSIONS', this.jsoneditor.MAX_RECURSIONS)
   }
 
   getDefault () {
@@ -385,7 +382,6 @@ export class ObjectEditor extends AbstractEditor {
 
     /* If the object should be rendered as a table row */
     if (this.options.table_row) {
-      console.log('OPTION TABLE ROW ', this._recursion)
       Object.entries(this.schema.properties).forEach(([key, schema]) => {
         const editor = this.jsoneditor.getEditorClass(schema)
         this.editors[key] = this.jsoneditor.createEditor(editor, {
@@ -395,7 +391,7 @@ export class ObjectEditor extends AbstractEditor {
           parent: this,
           compact: true,
           required: true
-        }, this._recursion + 1, this.collapseOnStopRecursion)
+        }, this.currentRecursions + 1)
         this.editors[key].preBuild()
 
         const width = this.editors[key].options.hidden ? 0 : (this.editors[key].options.grid_columns || this.editors[key].getNumColumns())
@@ -522,7 +518,6 @@ export class ObjectEditor extends AbstractEditor {
   }
 
   build () {
-    console.log('>>>>>>>>>>>>>>>>> LINKED CORRECTLY ')
     const isCategoriesFormat = (this.format === 'categories')
     this.rows = []
     this.active_tab = null
@@ -720,15 +715,8 @@ export class ObjectEditor extends AbstractEditor {
       }
 
       /* Show/Hide button */
-      console.log('BUILD ', this._recursion, this.collapsed)
-      if (this.collapsed === true) {
-        this.editor_holder.style.display = 'none'
-        this.collapse_control = this.getButton('', 'expand', this.translate('button_expand'))
-      } else {
-        this.collapsed = false
-        this.collapse_control = this.getButton('', 'collapse', this.translate('button_collapse'))
-      }
-
+      this.collapsed = false
+      this.collapse_control = this.getButton('', 'collapse', this.translate('button_collapse'))
       this.collapse_control.style.margin = '0 10px 0 0'
       this.collapse_control.classList.add('json-editor-btntype-toggle')
       this.title.insertBefore(this.collapse_control, this.title.childNodes[0])
@@ -985,13 +973,11 @@ export class ObjectEditor extends AbstractEditor {
       this.editors[name].register()
       /* New property */
     } else {
-      console.log('NAME ', !this.canHaveAdditionalProperties(), name)
       if (!this.canHaveAdditionalProperties() && (!this.schema.properties || !this.schema.properties[name])) {
         return
       }
 
       const schema = this.getPropertySchema(name)
-      console.log('SCHEMA ', schema)
       if (typeof schema.propertyOrder !== 'number') {
         /* if the propertyOrder undefined, then set a smart default value. */
         schema.propertyOrder = Object.keys(this.editors).length + 1000
@@ -1002,10 +988,10 @@ export class ObjectEditor extends AbstractEditor {
 
       this.editors[name] = this.jsoneditor.createEditor(editor, {
         jsoneditor: this.jsoneditor,
-        schema: this._recursion >= this.jsoneditor.MAX_RECURSIONS ? { type: schema.type || null } : schema,
+        schema: this.currentRecursions >= this.jsoneditor.MAX_RECURSIONS ? { type: schema.type || null } : schema,
         path: `${this.path}.${name}`,
         parent: this
-      }, this._recursion + 1, this.collapseOnStopRecursion)
+      }, this.currentRecursions + 1)
       this.editors[name].preBuild()
 
       if (!prebuildOnly) {
@@ -1019,11 +1005,6 @@ export class ObjectEditor extends AbstractEditor {
       }
 
       this.cached_editors[name] = this.editors[name]
-
-      if (this._recursion >= this.jsoneditor.MAX_RECURSIONS) {
-        console.info('Stop recursion')
-        this._stopRecursionCallback()
-      }
     }
 
     /* If we're only prebuilding the editors, don't refresh values */
@@ -1033,13 +1014,6 @@ export class ObjectEditor extends AbstractEditor {
     }
   }
 
-  collapseOnStopRecursion () {
-    this.collapsed = true
-    if (this._recursion !== 0) {
-      this._stopRecursionCallback()
-    }
-  }
-
   onOutsideModalClick (e) {
     if (this.addproperty_holder && !this.addproperty_holder.contains(e.target) && this.adding_property) {
       e.preventDefault()

src/editors/select.js

@@ -6,7 +6,6 @@ export class SelectEditor extends AbstractEditor {
     const correctValue = initial && value === null && this.value === undefined ? 'undefined' : value
     /* Sanitize value before setting it */
     let sanitized = this.typecast(correctValue || '')
-    console.log('SETVALUE ', 'CURRENT ', this.value, 'SET ', value, 'INITIAL ', initial, 'SANITIZED', sanitized)
 
     if (!this.enum_values.includes(sanitized)) sanitized = this.enum_values[0]
 
@@ -54,9 +53,7 @@ export class SelectEditor extends AbstractEditor {
     if (!this.dependenciesFulfilled) {
       return undefined
     }
-    const value = this.typecast(this.value)
-    console.log('GET VALUE ', value, this.value)
-    return value
+    return this.typecast(this.value)
   }
 
   preBuild () {
@@ -174,7 +171,6 @@ export class SelectEditor extends AbstractEditor {
     this.setInputAttributes([])
 
     this.input.addEventListener('change', (e) => {
-      console.log('SELECT CHANGE ')
       e.preventDefault()
       e.stopPropagation()
       this.onInputChange()
@@ -183,9 +179,8 @@ export class SelectEditor extends AbstractEditor {
     this.control = this.theme.getFormControl(this.label, this.input, this.description, this.infoButton)
     this.container.appendChild(this.control)
 
-    console.log('ENUM VALUES ', this.enum_values)
     this.value = this.enum_values[0]
-    console.log('SET ', this.value)
+
     /* Any special formatting that needs to happen after the input is added to the dom */
     window.requestAnimationFrame(() => {
       if (this.input.parentNode) this.afterInputReady()

tests/unit/core.spec.js

@@ -94,30 +94,4 @@ describe('JSONEditor', function () {
     editor = new JSONEditor(element, { schema: schema })
     expect(editor).toBeTruthy()
   })
-
-  it('please do not crash', () => {
-    editor = new JSONEditor(element, { schema: recursionTest })
-    expect(editor).toBeTruthy()
-  })
 })
-
-const recursionTest = {
-  'definitions': {
-    'JsonArray': {
-      'type': 'object',
-      'properties': {
-        'asJsonArray': {
-          '$ref': '#/definitions/JsonArray'
-        }
-      },
-      'title': 'JsonArray'
-    }
-  },
-  'type': 'object',
-  'properties': {
-    'asJsonArray': {
-      '$ref': '#/definitions/JsonArray'
-    }
-  },
-  'title': 'JsonArray'
-}

tests/unit/editors/object.spec.js

@@ -1,5 +1,4 @@
 import { JSONEditor } from '../../../src/core'
-import {ObjectEditor} from '../../../src/editors/object.js'
 
 const fixture = [
   {
@@ -78,30 +77,30 @@ describe('Object Editor', () => {
     })
   })
 
-  it('please object do not crash', () => {
+  it('with option maxRecursions 0, should create an editor (schema with recursion on object properties)', () => {
     editor = new JSONEditor(element, {
-      schema: recursionTest
+      schema: {
+        definitions: {
+          JsonArray: {
+            type: 'object',
+            properties: {
+              asJsonArray: {
+                $ref: '#/definitions/JsonArray'
+              }
+            },
+            title: 'JsonArray'
+          }
+        },
+        type: 'object',
+        properties: {
+          asJsonArray: {
+            $ref: '#/definitions/JsonArray'
+          }
+        },
+        title: 'JsonArray'
+      },
+      maxRecursions: 0
     })
     expect(editor).toBeTruthy()
   })
 })
-const recursionTest = {
-  'definitions': {
-    'JsonArray': {
-      'type': 'object',
-      'properties': {
-        'asJsonArray': {
-          '$ref': '#/definitions/JsonArray'
-        }
-      },
-      'title': 'JsonArray'
-    }
-  },
-  'type': 'object',
-  'properties': {
-    'asJsonArray': {
-      '$ref': '#/definitions/JsonArray'
-    }
-  },
-  'title': 'JsonArray'
-}