@ember-tooling/blueprint-model 0.0.0 → 0.0.2

package/LICENSE

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2013 Stefan Penner, Robert Jackson and ember-cli contributors
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

package/package.json

@@ -1,8 +1,18 @@
 {
   "name": "@ember-tooling/blueprint-model",
-  "version": "0.0.0",
-  "description": "",
-  "keywords": [],
-  "author": "",
-  "license": "MIT"
-}
+  "version": "0.0.2",
+  "repository": {
+    "type": "git",
+    "url": "https://github.com/ember-cli/ember-cli.git",
+    "directory": "packages/blueprint-model"
+  },
+  "dependencies": {
+    "chalk": "^4.1.2",
+    "diff": "^7.0.0",
+    "isbinaryfile": "^5.0.4",
+    "lodash": "^4.17.21",
+    "promise.hash.helper": "^1.0.8",
+    "quick-temp": "^0.1.8",
+    "silent-error": "^1.1.1"
+  }
+}

package/utilities/directory-for-package-name.js

@@ -0,0 +1,31 @@
+'use strict';
+
+const path = require('path');
+
+/**
+ * Derive a directory name from a package name.
+ * Takes scoped packages into account.
+ *
+ * @method directoryForPackageName
+ * @param {String} packageName
+ * @return {String} Derived directory name.
+ */
+module.exports = function directoryForPackageName(packageName) {
+  let isScoped = packageName[0] === '@' && packageName.includes('/');
+
+  if (isScoped) {
+    let slashIndex = packageName.indexOf('/');
+    let scopeName = packageName.substring(1, slashIndex);
+    let packageNameWithoutScope = packageName.substring(slashIndex + 1);
+    let pathParts = process.cwd().split(path.sep);
+    let parentDirectoryContainsScopeName = pathParts.includes(scopeName);
+
+    if (parentDirectoryContainsScopeName) {
+      return packageNameWithoutScope;
+    } else {
+      return `${scopeName}-${packageNameWithoutScope}`;
+    }
+  } else {
+    return packageName;
+  }
+};

package/utilities/edit-file-diff.js

@@ -0,0 +1,64 @@
+'use strict';
+
+const fs = require('fs');
+const util = require('util');
+const jsdiff = require('diff');
+const quickTemp = require('quick-temp');
+const path = require('path');
+const SilentError = require('silent-error');
+const openEditor = require('./open-editor');
+const hash = require('promise.hash.helper');
+
+const readFile = util.promisify(fs.readFile);
+const writeFile = util.promisify(fs.writeFile);
+
+class EditFileDiff {
+  constructor(options) {
+    this.info = options.info;
+
+    quickTemp.makeOrRemake(this, 'tmpDifferenceDir');
+  }
+
+  edit() {
+    return hash({
+      input: this.info.render(),
+      output: readFile(this.info.outputPath),
+    })
+      .then(this.invokeEditor.bind(this))
+      .then(this.applyPatch.bind(this))
+      .finally(this.cleanUp.bind(this));
+  }
+
+  cleanUp() {
+    quickTemp.remove(this, 'tmpDifferenceDir');
+  }
+
+  applyPatch(resultHash) {
+    return hash({
+      diffString: readFile(resultHash.diffPath),
+      currentString: readFile(resultHash.outputPath),
+    }).then((result) => {
+      let appliedDiff = jsdiff.applyPatch(result.currentString.toString(), result.diffString.toString());
+
+      if (!appliedDiff) {
+        let message = 'Patch was not cleanly applied.';
+        this.info.ui.writeLine(`${message} Please choose another action.`);
+        throw new SilentError(message);
+      }
+
+      return writeFile(resultHash.outputPath, appliedDiff);
+    });
+  }
+
+  invokeEditor(result) {
+    let info = this.info;
+    let diff = jsdiff.createPatch(info.outputPath, result.output.toString(), result.input);
+    let diffPath = path.join(this.tmpDifferenceDir, 'currentDiff.diff');
+
+    return writeFile(diffPath, diff)
+      .then(() => openEditor(diffPath))
+      .then(() => ({ outputPath: info.outputPath, diffPath }));
+  }
+}
+
+module.exports = EditFileDiff;

package/utilities/experiments.js

@@ -0,0 +1,54 @@
+'use strict';
+
+const chalk = require('chalk');
+const availableExperiments = Object.freeze(['EMBROIDER', 'CLASSIC']);
+
+const deprecatedExperiments = Object.freeze([]);
+const enabledExperiments = Object.freeze([]);
+const deprecatedExperimentsDeprecationsIssued = [];
+
+function isExperimentEnabled(experimentName) {
+  if (!availableExperiments.includes(experimentName)) {
+    return false;
+  }
+
+  if (process.env.EMBER_CLI_ENABLE_ALL_EXPERIMENTS && deprecatedExperiments.includes(experimentName)) {
+    return false;
+  }
+
+  if (process.env.EMBER_CLI_ENABLE_ALL_EXPERIMENTS) {
+    return true;
+  }
+
+  if (process.env.EMBER_CLI_CLASSIC && experimentName === 'EMBROIDER') {
+    return false;
+  }
+
+  let experimentEnvironmentVariable = `EMBER_CLI_${experimentName}`;
+  let experimentValue = process.env[experimentEnvironmentVariable];
+
+  if (deprecatedExperiments.includes(experimentName)) {
+    let deprecationPreviouslyIssued = deprecatedExperimentsDeprecationsIssued.includes(experimentName);
+    let isSpecifiedByUser = experimentValue !== undefined;
+
+    if (!deprecationPreviouslyIssued && isSpecifiedByUser) {
+      console.warn(
+        chalk.yellow(`The ${experimentName} experiment in ember-cli has been deprecated and will be removed.`)
+      );
+      deprecatedExperimentsDeprecationsIssued.push(experimentName);
+    }
+  }
+
+  if (enabledExperiments.includes(experimentName)) {
+    return experimentValue !== 'false';
+  } else {
+    return experimentValue !== undefined && experimentValue !== 'false';
+  }
+}
+
+module.exports = {
+  isExperimentEnabled,
+
+  // exported for testing purposes
+  _deprecatedExperimentsDeprecationsIssued: deprecatedExperimentsDeprecationsIssued,
+};

package/utilities/file-info.js

@@ -0,0 +1,170 @@
+'use strict';
+
+const fs = require('fs');
+const util = require('util');
+const chalk = require('chalk');
+const EditFileDiff = require('./edit-file-diff');
+const EOL = require('os').EOL;
+const rxEOL = new RegExp(EOL, 'g');
+const isBinaryFile = require('isbinaryfile').isBinaryFileSync;
+const hash = require('promise.hash.helper');
+const canEdit = require('./open-editor').canEdit;
+const processTemplate = require('./process-template');
+
+const readFile = util.promisify(fs.readFile);
+const lstat = util.promisify(fs.stat);
+
+function diffHighlight(line) {
+  if (line[0] === '+') {
+    return chalk.green(line);
+  } else if (line[0] === '-') {
+    return chalk.red(line);
+  } else if (/^@@/.test(line)) {
+    return chalk.cyan(line);
+  } else {
+    return line;
+  }
+}
+
+const NOOP = (_) => _;
+class FileInfo {
+  constructor(options) {
+    this.action = options.action;
+    this.outputBasePath = options.outputBasePath;
+    this.outputPath = options.outputPath;
+    this.displayPath = options.displayPath;
+    this.inputPath = options.inputPath;
+    this.templateVariables = options.templateVariables;
+    this.replacer = options.replacer || NOOP;
+    this.ui = options.ui;
+  }
+
+  confirmOverwrite(path) {
+    let promptOptions = {
+      type: 'expand',
+      name: 'answer',
+      default: false,
+      message: `${chalk.red('Overwrite')} ${path}?`,
+      choices: [
+        { key: 'y', name: 'Yes, overwrite', value: 'overwrite' },
+        { key: 'n', name: 'No, skip', value: 'skip' },
+      ],
+    };
+
+    let outputPathIsFile = false;
+    try {
+      outputPathIsFile = fs.statSync(this.outputPath).isFile();
+    } catch (err) {
+      /* ignore */
+    }
+
+    let canDiff = !isBinaryFile(this.inputPath) && (!outputPathIsFile || !isBinaryFile(this.outputPath));
+
+    if (canDiff) {
+      promptOptions.choices.push({ key: 'd', name: 'Diff', value: 'diff' });
+
+      if (canEdit()) {
+        promptOptions.choices.push({ key: 'e', name: 'Edit', value: 'edit' });
+      }
+    }
+
+    return this.ui.prompt(promptOptions).then((response) => response.answer);
+  }
+
+  displayDiff() {
+    let info = this,
+      jsdiff = require('diff');
+    return hash({
+      input: this.render(),
+      output: readFile(info.outputPath),
+    }).then((result) => {
+      let diff = jsdiff.createPatch(
+        info.outputPath,
+        result.output.toString().replace(rxEOL, '\n'),
+        result.input.replace(rxEOL, '\n')
+      );
+      let lines = diff.split('\n');
+
+      for (let i = 0; i < lines.length; i++) {
+        info.ui.write(diffHighlight(lines[i] + EOL));
+      }
+    });
+  }
+
+  async render() {
+    if (!this.rendered) {
+      let result = await this._render();
+      this.rendered = this.replacer(result, this);
+    }
+
+    return this.rendered;
+  }
+
+  _render() {
+    let path = this.inputPath;
+    let context = this.templateVariables;
+
+    return readFile(path).then((content) =>
+      lstat(path).then((fileStat) => {
+        if (isBinaryFile(content, fileStat.size)) {
+          return content;
+        } else {
+          try {
+            return processTemplate(content.toString(), context);
+          } catch (err) {
+            err.message += ` (Error in blueprint template: ${path})`;
+            throw err;
+          }
+        }
+      })
+    );
+  }
+
+  checkForConflict() {
+    return this.render().then((input) => {
+      input = input.toString().replace(rxEOL, '\n');
+
+      return readFile(this.outputPath)
+        .then((output) => {
+          output = output.toString().replace(rxEOL, '\n');
+
+          return input === output ? 'identical' : 'confirm';
+        })
+        .catch((e) => {
+          if (e.code === 'ENOENT') {
+            return 'none';
+          }
+
+          throw e;
+        });
+    });
+  }
+
+  confirmOverwriteTask() {
+    let info = this;
+
+    return function () {
+      function doConfirm() {
+        return info.confirmOverwrite(info.displayPath).then((action) => {
+          if (action === 'diff') {
+            return info.displayDiff().then(doConfirm);
+          } else if (action === 'edit') {
+            let editFileDiff = new EditFileDiff({ info });
+            return editFileDiff
+              .edit()
+              .then(() => (info.action = action))
+              .catch(() => doConfirm())
+              .then(() => info);
+          } else {
+            info.action = action;
+            return info;
+          }
+        });
+      }
+
+      return doConfirm();
+    };
+  }
+}
+
+module.exports = FileInfo;

package/utilities/open-editor.js

@@ -0,0 +1,44 @@
+'use strict';
+
+const spawn = require('child_process').spawn;
+
+function openEditor(file) {
+  if (!openEditor.canEdit()) {
+    throw new Error('EDITOR environment variable is not set');
+  }
+
+  if (!file) {
+    throw new Error('No `file` option provided');
+  }
+
+  let editorArgs = openEditor._env().EDITOR.split(' ');
+  let editor = editorArgs.shift();
+  const args = [file].concat(editorArgs);
+  let editProcess = openEditor._spawn(editor, args, { stdio: 'inherit' });
+
+  return new Promise((resolve, reject) => {
+    editProcess.on('close', (code) => {
+      if (code === 0) {
+        resolve();
+      } else {
+        reject(
+          new Error(`Spawn('${editor}', [${args.join(',')}]) exited with a non zero error status code: '${code}'`)
+        );
+      }
+    });
+  });
+}
+
+openEditor.canEdit = function () {
+  return openEditor._env().EDITOR !== undefined;
+};
+
+openEditor._env = function () {
+  return process.env;
+};
+
+openEditor._spawn = function () {
+  return spawn.apply(this, arguments);
+};
+
+module.exports = openEditor;

package/utilities/prepend-emoji.js

@@ -0,0 +1,12 @@
+'use strict';
+
+function supportEmoji() {
+  const hasEmojiTurnedOff = process.argv.indexOf('--no-emoji') > -1;
+  return process.stdout.isTTY && process.platform !== 'win32' && !hasEmojiTurnedOff;
+}
+
+const areEmojiSupported = supportEmoji();
+
+module.exports = function prependEmoji(emoji, msg) {
+  return areEmojiSupported ? `${emoji}  ${msg}` : msg;
+};

package/utilities/process-template.js

@@ -0,0 +1,10 @@
+'use strict';
+
+module.exports = function processTemplate(content, context) {
+  let options = {
+    evaluate: /<%([\s\S]+?)%>/g,
+    interpolate: /<%=([\s\S]+?)%>/g,
+    escape: /<%-([\s\S]+?)%>/g,
+  };
+  return require('lodash/template')(content, options)(context);
+};