All files / dist/helpers classes.js

88.46% Statements 115/130
83.5% Branches 86/103
100% Functions 9/9
94.78% Lines 109/115
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232    1x     1x 1x 1x   1x   1x   1x   1x   1x   1x   1x   1x   1x   1x   1x   2x   2x                 27x       27x   27x 27x 27x 27x 27x   27x 27x   27x 27x       27x 54x 4x       27x 53x 53x 53x 31x 31x 3x   28x 28x 28x 28x 5x     23x 10x 10x 10x 3x     20x     22x 22x   9x 13x 3x   10x 10x 6x   4x             4x                     27x 27x   27x 27x 27x   27x   27x 2x         2x 2x     27x 3x 1x   6x       27x 6x 6x             27x             27x           27x 25x 14x 14x       32x         32x 32x 32x             32x 32x 32x 32x 32x 32x 32x 32x 1x   32x                   335x   335x   335x   191x 191x 191x   12x 12x 12x   12x 12x 12x   12x  
'use strict';
 
Object.defineProperty(exports, "__esModule", {
  value: true
});
exports.convertClassToUI5Extend = convertClassToUI5Extend;
exports.getClassInfo = getClassInfo;
exports.isSAPUIDefineCallExpression = isSAPUIDefineCallExpression;
 
require('source-map-support/register');
 
var _babelTypes = require('babel-types');
 
var t = _interopRequireWildcard(_babelTypes);
 
var _templates = require('./templates');
 
var th = _interopRequireWildcard(_templates);
 
var _path = require('path');
 
var _path2 = _interopRequireDefault(_path);
 
var _objectAssignDefined = require('object-assign-defined');
 
var _objectAssignDefined2 = _interopRequireDefault(_objectAssignDefined);
 
var _jsdoc = require('./jsdoc');
 
var _decorators = require('./decorators');
 
function _interopRequireDefault(obj) { return obj && obj.__esModule ? obj : { default: obj }; }
 
function _interopRequireWildcard(obj) { Eif (obj && obj.__esModule) { return obj; } else { var newObj = {}; if (obj != null) { for (var key in obj) { if (Object.prototype.hasOwnProperty.call(obj, key)) newObj[key] = obj[key]; } } newObj.default = obj; return newObj; } }
 
/**
 * Converts an ES6 class to a UI5 extend.
 * Any static methods or properties will be moved outside the class body.
 * The path will be updated with the new AST.
 */
function convertClassToUI5Extend(node, classInfo, extraStaticProps) {
  // eslint-disable-line no-unused-vars
  Iif (!(t.isClassDeclaration(node) || t.isClassExpression(node))) {
    return node;
  }
 
  const staticMembers = [];
 
  const classNameIdentifier = node.id;
  const className = classNameIdentifier.name;
  const superClass = node.superClass; // Identifier
  const superClassName = node.superClass.name;
  const isController = className.includes('Controller') || !!classInfo.controller;
 
  const extendProps = [];
  const boundProps = [];
 
  const CONSTRUCTOR = 'constructor';
  const propsByName = {};
  let constructor;
  let constructorComments;
 
  for (const propName of ['metadata', 'renderer']) {
    if (extraStaticProps[propName]) {
      extendProps.push(t.objectProperty(t.identifier(propName), extraStaticProps[propName]));
    }
  }
 
  for (const member of node.body.body) {
    const memberName = member.key.name;
    const memberExpression = member.static && t.memberExpression(classNameIdentifier, member.key);
    if (t.isClassMethod(member)) {
      const func = t.functionExpression(member.key, member.params, member.body, member.generator, member.async);
      if (member.static) {
        staticMembers.push(t.expressionStatement(t.assignmentExpression('=', memberExpression, func)));
      } else {
        propsByName[memberName] = func;
        func.generator = member.generator;
        func.async = member.async;
        if (member.kind === 'get' || member.kind === 'set') {
          extendProps.push(t.objectMethod(member.kind, member.key, member.params, member.body, member.computed));
        } else {
          // method
          if (memberName === CONSTRUCTOR) {
            constructorComments = member.leadingComments;
            constructor = func;
            if (isController) {
              continue; // don't push to props yet
            }
          }
          extendProps.push(t.objectProperty(member.key, func));
        }
      }
    } else Eif (t.isClassProperty(member)) {
      if (memberName === 'metadata' || memberName === 'renderer') {
        // Special handling for TypeScript limitation where metadata and renderer must be properties.
        extendProps.unshift(t.objectProperty(member.key, member.value));
      } else if (member.static) {
        staticMembers.push(t.expressionStatement(t.assignmentExpression('=', memberExpression, member.value)));
      } else {
        propsByName[memberName] = member.value;
        if (t.isArrowFunctionExpression(member.value)) {
          boundProps.push(member);
        } else {
          Iif (memberName === 'constructor') {
            constructorComments = member.leadingComments;
            constructor = member.value;
            if (isController) {
              continue; // don't push to props yet
            }
          }
          extendProps.push(t.objectProperty(member.key, member.value));
        }
      }
    }
  }
 
  // Arrow function properties need to get moved to the constructor so that
  // they're bound properly to the class instance, to align with the spec.
  // For controllers, use onInit rather than constructor, since controller constructors don't work.
  // Also move the constructor's statements to the onInit.
 
  const bindToMethodName = isController ? 'onInit' : 'constructor';
  const bindToId = t.identifier(bindToMethodName);
  // console.log("isController::", className, isController, bindToMethodName, bindToId);
  let bindMethod = isController ? propsByName[bindToMethodName] : constructor; // avoid getting a prop named constructor as it may return {}'s
  const constructorJsdoc = (0, _jsdoc.getTags)(constructorComments);
  const keepConstructor = classInfo.keepConstructor || constructorJsdoc.keep;
 
  const needsBindingMethod = boundProps.length || isController && constructor && !keepConstructor;
 
  if (needsBindingMethod && !bindMethod) {
    const fn = th.buildInheritingFunction({
      NAME: bindToId,
      SUPER: t.identifier(superClassName)
    });
    // Need to convert FunctionDeclaration to FunctionExpression
    bindMethod = t.functionExpression(fn.id, fn.params, fn.body, fn.generator, fn.async);
    extendProps.unshift(t.objectProperty(bindToId, bindMethod));
  }
 
  if (isController && constructor) {
    if (keepConstructor) {
      extendProps.unshift(t.objectProperty(t.identifier(CONSTRUCTOR), constructor));
    } else {
      bindMethod.body.body.unshift(...constructor.body.body.filter(node => !(t.isCallExpression(node.expression) && node.expression.callee.type === 'Super')));
    }
  }
 
  if (boundProps.length) {
    bindMethod.body.body.push(...boundProps.map(prop => {
      return th.buildThisAssignment({
        NAME: prop.key,
        VALUE: prop.value
      });
    }));
  }
 
  const extendAssign = th.buildExtendAssign({
    NAME: classNameIdentifier,
    SUPERNAME: superClass,
    FQN: t.stringLiteral(getFullyQualifiedName(classInfo)),
    OBJECT: t.objectExpression(extendProps)
  });
 
  return [extendAssign, ...staticMembers];
}
// import template from 'babel-template'
 
 
function getFullyQualifiedName(classInfo) {
  if (classInfo.alias) return classInfo.alias;
  if (classInfo.name) return classInfo.name;
  const separator = classInfo.namespace ? '.' : '';
  return `${ classInfo.namespace }${ separator }${ classInfo.localName }`;
}
 
function getClassInfo(path, node, parent, pluginOpts) {
  const defaults = {
    localName: node.id.name,
    superClassName: node.superClass && node.superClass.name,
    namespace: getFileBaseNamespace(path, pluginOpts) || ''
  };
  const decoratorInfo = (0, _decorators.getDecoratorClassInfo)(node);
  const jsDocInfo = (0, _jsdoc.getJsDocClassInfo)(node, parent);
  return (0, _objectAssignDefined2.default)(defaults, decoratorInfo, jsDocInfo);
}
 
/**
 * Reads the namespace from the file path, but not the name
 */
function getFileBaseNamespace(path, pluginOpts) {
  const opts = path.hub.file.opts;
  const filename = _path2.default.resolve(opts.filename);
  const sourceRoot = opts.sourceRoot || process.cwd();
  Eif (filename.startsWith(sourceRoot)) {
    const filenameRelative = _path2.default.relative(sourceRoot, filename);
    const { dir } = _path2.default.parse(filenameRelative);
    const namespaceParts = dir.split(_path2.default.sep);
    if (pluginOpts.namespacePrefix) {
      namespaceParts.unshift(pluginOpts.namespacePrefix);
    }
    return namespaceParts.join('.');
  } else {
    return undefined;
  }
}
 
/**
 * Checks if the CallExpression is sap.ui.define(...) call
 */
function isSAPUIDefineCallExpression(node) {
  let name = null;
 
  const callee = node.callee;
 
  if (!t.isMemberExpression(callee)) return false;
 
  node = callee;
  name = node.name || node.property && node.property.name; // property won't be there for an anonymous function
  if (name !== 'define') return false;
 
  node = node.object;
  name = node.name || node.property.name;
  Iif (name !== 'ui') return false;
 
  node = node.object;
  name = node.name || node.property.name;
  Iif (name !== 'sap') return false;
 
  return true;
}