feat: Add utilities#assert [#95469256]

DOMRenderer previously had methods for asserting state.

Putting those methods on the prototype makes it impossible for the
minifier to do any kind of dead-code elimination.

This commit adds an assert utility function used in order to check
if a certain condition is met.

Checking for NODE_ENV and not including the passed in error message
in the thrown error should be trivial and only needs to be done once
in the more generic assert function.

Author: alexanderGugel

dom-renderers/DOMRenderer.js

@@ -29,6 +29,7 @@ var math = require('./Math');
 var PathUtils = require('../core/Path');
 var vendorPrefix = require('../utilities/vendorPrefix');
 var eventMap = require('./events/EventMap');
+var assert = require('../utilities/assert');
 
 var TRANSFORM = null;
 
@@ -89,7 +90,6 @@ function DOMRenderer (element, selector, compositor) {
     this._lastEv = null;
 }
 
-
 /**
  * Attaches an EventListener to the element associated with the passed in path.
  * Prevents the default browser action on all subsequent events if
@@ -106,7 +106,7 @@ function DOMRenderer (element, selector, compositor) {
  * @return {undefined} undefined
  */
 DOMRenderer.prototype.subscribe = function subscribe(type) {
-    this._assertTargetLoaded();
+    assert(this._target, 'No target loaded');
     this._listen(type);
     this._target.subscribe[type] = true;
 };
@@ -120,7 +120,8 @@ DOMRenderer.prototype.subscribe = function subscribe(type) {
  * @return {undefined}      undefined
  */
 DOMRenderer.prototype.unsubscribe = function unsubscribe(type) {
-    this._assertTargetLoaded();
+    assert(this._target, 'No target loaded');
+
     this._listen(type);
     this._target.subscribe[type] = false;
 };
@@ -135,7 +136,8 @@ DOMRenderer.prototype.unsubscribe = function unsubscribe(type) {
  * @return {undefined}      undefined
  */
 DOMRenderer.prototype.preventDefault = function preventDefault(type) {
-    this._assertTargetLoaded();
+    assert(this._target, 'No target loaded');
+
     this._listen(type);
     this._target.preventDefault[type] = true;
 };
@@ -152,7 +154,8 @@ DOMRenderer.prototype.preventDefault = function preventDefault(type) {
  * @return {undefined}      undefined
  */
 DOMRenderer.prototype.allowDefault = function allowDefault(type) {
-    this._assertTargetLoaded();
+    assert(this._target, 'No target loaded');
+
     this._listen(type);
     this._target.preventDefault[type] = false;
 };
@@ -173,7 +176,7 @@ DOMRenderer.prototype.allowDefault = function allowDefault(type) {
  * @return {undefined}      undefined
  */
 DOMRenderer.prototype._listen = function _listen(type) {
-    this._assertTargetLoaded();
+    assert(this._target, 'No target loaded');
 
     if (
         !this._target.listeners[type] && !this._root.listeners[type]
@@ -248,7 +251,6 @@ DOMRenderer.prototype._triggerEvent = function _triggerEvent(ev) {
     }
 };
 
-
 /**
  * getSizeOf gets the dom size of a particular DOM element.  This is
  * needed for render sizing in the scene graph.
@@ -320,55 +322,6 @@ DOMRenderer.prototype.draw = function draw(renderState) {
     }
 };
 
-
-/**
- * Internal helper function used for ensuring that a path is currently loaded.
- *
- * @method
- * @private
- *
- * @return {undefined} undefined
- */
-DOMRenderer.prototype._assertPathLoaded = function _asserPathLoaded() {
-    if (!this._path) throw new Error('path not loaded');
-};
-
-/**
- * Internal helper function used for ensuring that a parent is currently loaded.
- *
- * @method
- * @private
- *
- * @return {undefined} undefined
- */
-DOMRenderer.prototype._assertParentLoaded = function _assertParentLoaded() {
-    if (!this._parent) throw new Error('parent not loaded');
-};
-
-/**
- * Internal helper function used for ensuring that children are currently
- * loaded.
- *
- * @method
- * @private
- *
- * @return {undefined} undefined
- */
-DOMRenderer.prototype._assertChildrenLoaded = function _assertChildrenLoaded() {
-    if (!this._children) throw new Error('children not loaded');
-};
-
-/**
- * Internal helper function used for ensuring that a target is currently loaded.
- *
- * @method  _assertTargetLoaded
- *
- * @return {undefined} undefined
- */
-DOMRenderer.prototype._assertTargetLoaded = function _assertTargetLoaded() {
-    if (!this._target) throw new Error('No target loaded');
-};
-
 /**
  * Finds and sets the parent of the currently loaded element (path).
  *
@@ -378,7 +331,7 @@ DOMRenderer.prototype._assertTargetLoaded = function _assertTargetLoaded() {
  * @return {ElementCache} Parent element.
  */
 DOMRenderer.prototype.findParent = function findParent () {
-    this._assertPathLoaded();
+    assert(this._path, 'No path loaded');
 
     var path = this._path;
     var parent;
@@ -403,7 +356,6 @@ DOMRenderer.prototype.findTarget = function findTarget() {
     return this._target;
 };
 
-
 /**
  * Loads the passed in path.
  *
@@ -465,7 +417,7 @@ DOMRenderer.prototype.insertEl = function insertEl (tagName) {
 
         this.findParent();
 
-        this._assertParentLoaded();
+        assert(this._parent, 'No parent loaded');
 
         if (this._parent.void)
             throw new Error(
@@ -487,7 +439,6 @@ DOMRenderer.prototype.insertEl = function insertEl (tagName) {
     }
 };
 
-
 /**
  * Sets a property on the currently loaded target.
  *
@@ -499,16 +450,15 @@ DOMRenderer.prototype.insertEl = function insertEl (tagName) {
  * @return {undefined} undefined
  */
 DOMRenderer.prototype.setProperty = function setProperty (name, value) {
-    this._assertTargetLoaded();
+    assert(this._target, 'No target loaded');
     this._target.element.style[name] = value;
 };
 
-
 /**
  * Sets the size of the currently loaded target.
  * Removes any explicit sizing constraints when passed in `false`
  * ("true-sizing").
- * 
+ *
  * Invoking setSize is equivalent to a manual invocation of `setWidth` followed
  * by `setHeight`.
  *
@@ -520,27 +470,27 @@ DOMRenderer.prototype.setProperty = function setProperty (name, value) {
  * @return {undefined} undefined
  */
 DOMRenderer.prototype.setSize = function setSize (width, height) {
-    this._assertTargetLoaded();
+    assert(this._target, 'No target loaded');
 
     this.setWidth(width);
     this.setHeight(height);
 };
 
 /**
  * Sets the width of the currently loaded ElementCache.
- * 
+ *
  * @method
- *  
+ *
  * @param  {Number|false} width     The explicit width to be set on the
  *                                  ElementCache's target (and content) element.
  *                                  `false` removes any explicit sizing
  *                                  constraints from the underlying DOM
  *                                  Elements.
  *
  * @return {undefined} undefined
- */ 
+ */
 DOMRenderer.prototype.setWidth = function setWidth(width) {
-    this._assertTargetLoaded();
+    assert(this._target, 'No target loaded');
 
     var contentWrapper = this._target.content;
 
@@ -561,19 +511,19 @@ DOMRenderer.prototype.setWidth = function setWidth(width) {
 
 /**
  * Sets the height of the currently loaded ElementCache.
- * 
+ *
  * @method  setHeight
- *  
+ *
  * @param  {Number|false} height    The explicit height to be set on the
  *                                  ElementCache's target (and content) element.
  *                                  `false` removes any explicit sizing
  *                                  constraints from the underlying DOM
  *                                  Elements.
  *
  * @return {undefined} undefined
- */ 
+ */
 DOMRenderer.prototype.setHeight = function setHeight(height) {
-    this._assertTargetLoaded();
+    assert(this._target, 'No target loaded');
 
     var contentWrapper = this._target.content;
 
@@ -603,7 +553,7 @@ DOMRenderer.prototype.setHeight = function setHeight(height) {
  * @return {undefined} undefined
  */
 DOMRenderer.prototype.setAttribute = function setAttribute(name, value) {
-    this._assertTargetLoaded();
+    assert(this._target, 'No target loaded');
     this._target.element.setAttribute(name, value);
 };
 
@@ -617,7 +567,7 @@ DOMRenderer.prototype.setAttribute = function setAttribute(name, value) {
  * @return {undefined} undefined
  */
 DOMRenderer.prototype.setContent = function setContent(content) {
-    this._assertTargetLoaded();
+    assert(this._target, 'No target loaded');
 
     if (this._target.formElement) {
         this._target.element.value = content;
@@ -641,7 +591,6 @@ DOMRenderer.prototype.setContent = function setContent(content) {
     );
 };
 
-
 /**
  * Sets the passed in transform matrix (world space). Inverts the parent's world
  * transform.
@@ -653,11 +602,10 @@ DOMRenderer.prototype.setContent = function setContent(content) {
  * @return {undefined} undefined
  */
 DOMRenderer.prototype.setMatrix = function setMatrix (transform) {
-    this._assertTargetLoaded();
+    assert(this._target, 'No target loaded');
     this._target.element.style[TRANSFORM] = this._stringifyMatrix(transform);
 };
 
-
 /**
  * Adds a class to the classList associated with the currently loaded target.
  *
@@ -668,11 +616,10 @@ DOMRenderer.prototype.setMatrix = function setMatrix (transform) {
  * @return {undefined} undefined
  */
 DOMRenderer.prototype.addClass = function addClass(domClass) {
-    this._assertTargetLoaded();
+    assert(this._target, 'No target loaded');
     this._target.element.classList.add(domClass);
 };
 
-
 /**
  * Removes a class from the classList associated with the currently loaded
  * target.
@@ -684,11 +631,10 @@ DOMRenderer.prototype.addClass = function addClass(domClass) {
  * @return {undefined} undefined
  */
 DOMRenderer.prototype.removeClass = function removeClass(domClass) {
-    this._assertTargetLoaded();
+    assert(this._target, 'No target loaded');
     this._target.element.classList.remove(domClass);
 };
 
-
 /**
  * Stringifies the passed in matrix for setting the `transform` property.
  *
@@ -700,7 +646,7 @@ DOMRenderer.prototype.removeClass = function removeClass(domClass) {
  */
 DOMRenderer.prototype._stringifyMatrix = function _stringifyMatrix(m) {
     var r = 'matrix3d(';
-    
+
     r += (m[0] < 0.000001 && m[0] > -0.000001) ? '0,' : m[0] + ',';
     r += (m[1] < 0.000001 && m[1] > -0.000001) ? '0,' : m[1] + ',';
     r += (m[2] < 0.000001 && m[2] > -0.000001) ? '0,' : m[2] + ',';
@@ -716,7 +662,7 @@ DOMRenderer.prototype._stringifyMatrix = function _stringifyMatrix(m) {
     r += (m[12] < 0.000001 && m[12] > -0.000001) ? '0,' : m[12] + ',';
     r += (m[13] < 0.000001 && m[13] > -0.000001) ? '0,' : m[13] + ',';
     r += (m[14] < 0.000001 && m[14] > -0.000001) ? '0,' : m[14] + ',';
-    
+
     r += m[15] + ')';
     return r;
 };

package.json

@@ -46,13 +46,18 @@
     "tap-closer": "^1.0.0",
     "tape": "^4.0.0",
     "tap-spec": "^4.0.0",
+    "escodegen": "^1.6.1",
+    "esprima": "^2.2.0",
+    "replace-method": "0.0.0",
+    "through": "^2.3.7",
     "uglify-js": "^2.4.17"
   },
   "dependencies": {
     "glslify": "^2.0.0"
   },
   "browserify": {
     "transform": [
+      ["./scripts/optimize-assertions", { "stripErrors": false, "preCheck": true }],
       "glslify"
     ]
   }