refactor

Author: Riccardo Di Benedetto

README.md

@@ -276,6 +276,16 @@ Here are all the available options:
     <td>Preserve value at Move Up or Down.(No value is selected automatically upon deletion.)</td>
     <td><code>true</code></td>
   </tr>
+  <tr>
+    <td>max_depth</td>
+    <td>Max depth of an object that have to be rendered. The missing of this option could cause "maximum call stack size exceeded" in case of recursive object properties</td>
+    <td><code>infinite</code></td>
+  </tr>
+  <tr>
+    <td>use_default_values</td>
+    <td>True if have to be used default values based on the "type" of the property</td>
+    <td><code>true</code></td>
+  </tr>
   </tbody>
 </table>
 

config/karma.conf.js

@@ -13,7 +13,7 @@ module.exports = function (config) {
 
     // list of files / patterns to load in the browser
     files: [
-      { pattern: './tests/unit/**/*.spec.js', watched: false }
+      { pattern: './tests/unit/core.spec.js', watched: false }
     ],
 
     // preprocess matching files before serving them to the browser

package.json

@@ -3,7 +3,7 @@
   "title": "JSONEditor",
   "description": "JSON Schema based editor",
   "version": "2.2.1",
-  "main": "dist/jsoneditor.js",
+  "main": "dist/nonmin/jsoneditor.js",
   "author": {
     "name": "Jeremy Dorn",
     "email": "jeremy@jeremydorn.com",

src/core.js

@@ -26,8 +26,6 @@ export class JSONEditor {
     const themeName = this.options.theme || JSONEditor.defaults.theme
     const themeClass = JSONEditor.defaults.themes[themeName]
 
-    this.MAX_RECURSIONS = this.options.maxRecursions
-
     /* Load editors and selected theme style rules */
     if (!themeClass) throw new Error(`Unknown theme ${themeName}`)
     this.element.setAttribute('data-theme', themeName)
@@ -208,17 +206,15 @@ export class JSONEditor {
       classname = resolver(schema)
       return classname && JSONEditor.defaults.editors[classname]
     })
-
     if (!classname) throw new Error(`Unknown editor for schema ${JSON.stringify(schema)}`)
     if (!JSONEditor.defaults.editors[classname]) throw new Error(`Unknown editor ${classname}`)
-
     return JSONEditor.defaults.editors[classname]
   }
 
-  createEditor (editorClass, options, recursion = 0) {
+  createEditor (editorClass, options, depthCounter = 0) {
     options = extend({}, editorClass.options || {}, options)
     // eslint-disable-next-line new-cap
-    return new editorClass(options, JSONEditor.defaults, recursion)
+    return new editorClass(options, JSONEditor.defaults, depthCounter)
   }
 
   onChange () {

src/defaults.js

@@ -284,8 +284,7 @@ function translate (key, variables) {
 const options = {
   upload,
   prompt_before_delete: true,
-  useDefault: true,
-  maxRecursions: 99999
+  use_default_values: true
 }
 
 /* This assignment was previously in index.js but makes more sense here */

src/editor.js

@@ -519,15 +519,15 @@ export class AbstractEditor {
     this.parent = null
   }
 
+  isDefaultRequired () {
+    return this.isRequired() || !!this.jsoneditor.options.use_default_values
+  }
+
   getDefault () {
     if (typeof this.schema.default !== 'undefined') {
       return this.schema.default
     }
 
-    if (!this.jsoneditor.options.useDefault) {
-      return null
-    }
-
     if (typeof this.schema.enum !== 'undefined') {
       return this.schema.enum[0]
     }
@@ -538,9 +538,9 @@ export class AbstractEditor {
     if (type && Array.isArray(type)) type = type[0]
 
     if (typeof type === 'string') {
-      if (type === 'number') return 0.0
-      if (type === 'boolean') return false
-      if (type === 'integer') return 0
+      if (type === 'number') return this.isDefaultRequired() ? 0.0 : undefined
+      if (type === 'boolean') return this.isDefaultRequired() ? false : undefined
+      if (type === 'integer') return this.isDefaultRequired() ? 0 : undefined
       if (type === 'string') return ''
       if (type === 'object') return {}
       if (type === 'array') return []

src/editors/multiple.js

@@ -208,7 +208,6 @@ export class MultipleEditor extends AbstractEditor {
           schema.required = this.schema.required.concat(type.required)
         }
       }
-
       this.validators[i] = new Validator(this.jsoneditor, schema, validatorOptions, this.defaults)
     })
 

src/editors/object.js

@@ -2,10 +2,9 @@ import { AbstractEditor } from '../editor.js'
 import { extend, trigger, hasOwnProperty } from '../utilities.js'
 
 export class ObjectEditor extends AbstractEditor {
-  constructor (options, defaults, recursions) {
+  constructor (options, defaults, depth) {
     super(options, defaults)
-    this.currentRecursions = recursions
-    this.collapsed = null
+    this.currentDepth = depth
   }
 
   getDefault () {
@@ -391,7 +390,7 @@ export class ObjectEditor extends AbstractEditor {
           parent: this,
           compact: true,
           required: true
-        }, this.currentRecursions + 1)
+        }, this.currentDepth + 1)
         this.editors[key].preBuild()
 
         const width = this.editors[key].options.hidden ? 0 : (this.editors[key].options.grid_columns || this.editors[key].getNumColumns())
@@ -962,6 +961,23 @@ export class ObjectEditor extends AbstractEditor {
     }
   }
 
+  getSchemaOnMaxDepth (schema) {
+    return Object.keys(schema).reduce((acc, key) => {
+      switch (key) {
+        case '$ref':
+          return acc
+        case 'properties':
+        case 'items':
+          return {}
+        default:
+          return {
+            ...acc,
+            [key]: schema[key]
+          }
+      }
+    }, {})
+  }
+
   addObjectProperty (name, prebuildOnly) {
     /* Property is already added */
     if (this.editors[name]) return
@@ -986,12 +1002,14 @@ export class ObjectEditor extends AbstractEditor {
       /* Add the property */
       const editor = this.jsoneditor.getEditorClass(schema)
 
+      const { max_depth: maxDepth } = this.jsoneditor.options
+
       this.editors[name] = this.jsoneditor.createEditor(editor, {
         jsoneditor: this.jsoneditor,
-        schema: this.currentRecursions >= this.jsoneditor.MAX_RECURSIONS ? { type: schema.type || null } : schema,
+        schema: maxDepth !== undefined && this.currentDepth >= maxDepth ? this.getSchemaOnMaxDepth(schema) : schema,
         path: `${this.path}.${name}`,
         parent: this
-      }, this.currentRecursions + 1)
+      }, this.currentDepth + 1)
       this.editors[name].preBuild()
 
       if (!prebuildOnly) {

src/editors/select.js

@@ -3,11 +3,17 @@ import { extend } from '../utilities.js'
 
 export class SelectEditor extends AbstractEditor {
   setValue (value, initial) {
-    const correctValue = initial && value === null && this.value === undefined ? 'undefined' : value
     /* Sanitize value before setting it */
-    let sanitized = this.typecast(correctValue || '')
+    let sanitized = this.typecast(value)
 
-    if (!this.enum_values.includes(sanitized)) sanitized = this.enum_values[0]
+    const haveToUseDefaultValue = !!this.jsoneditor.options.use_default_values || typeof this.schema.default !== 'undefined'
+
+    if (
+      !this.enum_values.includes(sanitized) ||
+      (initial && !this.isRequired() && !haveToUseDefaultValue)
+    ) {
+      sanitized = this.enum_values[0]
+    }
 
     if (this.value === sanitized) return
 
@@ -46,6 +52,7 @@ export class SelectEditor extends AbstractEditor {
     if (this.schema.type === 'boolean') return value === 'undefined' || value === undefined ? undefined : !!value
     else if (this.schema.type === 'number') return 1 * value || 0
     else if (this.schema.type === 'integer') return Math.floor(value * 1 || 0)
+    else if (this.schema.enum && value === undefined) return undefined
     return `${value}`
   }
 

tests/fixtures/some_types.json

@@ -0,0 +1,32 @@
+{
+    "type": "object",
+    "properties": {
+      "boolean": {
+        "type": "boolean",
+        "description": "This description should only appear once"
+      },
+      "enum": {
+          "type": "string",
+          "enum": ["foo", "bar"]
+      },
+      "integer": {
+          "type": "integer"
+      },
+      "number": {
+          "type": "number"
+      },
+      "string": {
+          "type": "string"
+      },
+      "object": {
+          "type": "object",
+          "properties": {}
+      },
+      "array": {
+          "type": "array",
+          "items": {
+              "type": "string"
+          }
+      }
+  }
+}