gaffer-generator 1.2.7 → 2.0.0

package/src/utils.js

@@ -1,179 +0,0 @@
-require('colors');
-const _ = require('./lodash');
-const get = _.get;
-const fs = require('fs');
-const path = require('path');
-const argv = require('yargs').argv;
-const fetch = require('node-fetch');
-
-/*
- Public API.
- */
-exports.contentsDiffer = contentsDiffer;
-exports.safeRead = safeRead;
-exports.safeWrite = safeWrite;
-exports.log = log;
-exports.logChange = logChange;
-exports.logRemoval = logRemoval;
-exports.logError = logError;
-exports.parameterizeString = parameterizeString;
-exports.lowerCaseFirst = lowerCaseFirst;
-exports.fetch = fetch;
-exports.normalizePath = normalizePath;
-
-/*
- Implementation.
- */
-
-/**
- * Looks at two strings to see if they contain the same content, ignoring line endings.
- * @param a
- * @param b
- * @returns {boolean}
- */
-function contentsDiffer(a, b) {
-  // Are a and b both empty?
-  if (!a && !b) {
-    return false;
-  }
-  // Is only one of them empty?
-  if (!a || !b) {
-    return true;
-  }
-  // Otherwise, compare them while ignoring line endings to see if they're equivalent.
-  return normalizeLineEndings(a) !== normalizeLineEndings(b);
-}
-
-/**
- * Attempts to read in the provided file, returning the string contents if it exists, or null.
- * @param file
- * @returns {string}
- */
-function safeRead(file) {
-  let url = normalizePath(typeof file === 'string'
-    ? file
-    : path.join(file.dirname, file.basename));
-  return fs.existsSync(url)
-    ? fs.readFileSync(url, 'UTF-8')
-    : null;
-}
-
-/**
- * Writes the contents to the file, making sure the parent directories of the file exist.
- * @param file
- * @param contents
- */
-function safeWrite(file, contents) {
-  const url = normalizePath(typeof file === 'string'
-    ? file
-    : path.join(file.dirname, file.basename));
-  const dirs = url.split(path.sep).slice(0, -1);
-  // Note: we start at 1 to avoid trying to create the root directory.
-  for (let i = 1; i < dirs.length; i++) {
-    let collectivePath = dirs.slice(0, i + 1).join(path.sep);
-    if (!fs.existsSync(collectivePath)) {
-      fs.mkdirSync(collectivePath);
-    }
-  }
-  fs.writeFileSync(url, contents, 'UTF-8');
-}
-
-/**
- * If the file doesn't exist, logs a message saying it is being created. Otherwise, it's being updated.
- * @param file
- */
-function logChange(file) {
-  let url = normalizePath(typeof file === 'string'
-    ? file
-    : path.join(file.dirname, file.basename));
-  log((`${fs.existsSync(url) ? 'updating' : 'creating'}: `).cyan + url.magenta);
-}
-
-/**
- * Logs a message saying the file is being removed.
- * @param url
- */
-function logRemoval(url) {
-  log((`removing: `).red + url.magenta);
-}
-
-/**
- * Logs an error.
- * @param text
- * @param [err]
- */
-function logError(text, err) {
-  log(text, err, true);
-}
-
-/**
- * Logs a message to the console with a nice prefix.
- * @param text The text to write.
- * @param [error] The optional error to log
- * @param writeAsError If we should use console.error or console.log.
- */
-function log(text, error = null, writeAsError = false) {
-  if (argv.silent) {
-    return;
-  }
-  let prefix = `[${new Date().toTimeString().split(' ')[0]}] `.gray;
-  if (writeAsError) {
-    if (error) {
-      console.error(prefix + text, error);
-    }
-    else {
-      console.error(prefix + text);
-    }
-  }
-  else {
-    console.log(prefix + text);
-  }
-}
-
-/**
- * Given a string with _parameters_ within it, substitute them with the real values from the given context.
- * @param str
- * @param context
- * @returns {string}
- */
-function parameterizeString(str, context) {
-  return str.replace(
-    /_[a-z]*\.?[a-z]+_/ig,
-    match => {
-      const variableName = match.slice(1, -1);
-      return get(context, variableName)
-        || get(context, variableName.toLowerCase())
-        || get(context, variableName.toUpperCase())
-        || match;
-    });
-}
-
-/**
- * Lowers the first letter of the provided string, leaving the rest of it alone.
- * @param val
- * @returns {string}
- */
-function lowerCaseFirst(val) {
-  if (!val || !val.toLowerCase) {
-    return val;
-  }
-  return val[0].toLowerCase() + val.substr(1);
-}
-
-/**
- * Normalizes a path across platforms. (Root / paths are assumed to be on C:\ on windows).
- * @param ref
- * @returns {string}
- */
-function normalizePath(ref) {
-  return ref && ref.startsWith('/') ? path.resolve(ref) : path.normalize(ref);
-}
-
-/**
- * Normalizes line endings for comparison purposes.
- * @param contents
- * @returns {string}
- */
-function normalizeLineEndings(contents) {
-  return contents.replace(/\r\n?/g, '\n');
-}

package/src/utils.test.js

@@ -1,146 +0,0 @@
-const spyLog = jest.spyOn(console, 'log');
-const spyError = jest.spyOn(console, 'error');
-
-jest.mock('fs');
-const utils = require('./utils');
-const fs = require('fs');
-
-const _n = utils.normalizePath;
-
-describe('contentsDiffer', () => {
-  test('handles one or more empty contents', () => {
-    expect(utils.contentsDiffer('', '')).toBe(false);
-    expect(utils.contentsDiffer('a', '')).toBe(true);
-    expect(utils.contentsDiffer('', 'b')).toBe(true);
-  });
-  test('handles normal cases', () => {
-    expect(utils.contentsDiffer('a', 'a')).toBe(false);
-    expect(utils.contentsDiffer('a', 'b')).toBe(true);
-    expect(utils.contentsDiffer('a', 'A')).toBe(true);
-  });
-  test('handles line endings', () => {
-    expect(utils.contentsDiffer('a\na', 'a\na')).toBe(false);
-    expect(utils.contentsDiffer('a\r\na', 'a\na')).toBe(false);
-    expect(utils.contentsDiffer('a\r\na', 'a\r\na')).toBe(false);
-    expect(utils.contentsDiffer('a\na', 'a\r\na')).toBe(false);
-  });
-});
-
-describe('safeRead', () => {
-  test('returns null when file does not exist', () => {
-    fs.__setResponse('existsSync', false);
-    expect(utils.safeRead(_n('/foo/bar.js'))).toBe(null);
-  });
-  test('returns contents when file does exist', () => {
-    fs.__setResponse('existsSync', true);
-    fs.__setResponse('readFileSync', 'baz');
-    expect(utils.safeRead(_n('/foo/bar.js'))).toBe('baz');
-  });
-  test('allows string argument', () => {
-    fs.__setResponse('existsSync', false);
-    expect(utils.safeRead(_n('/foo/bar.js'))).toBe(null);
-    expect(fs.__spy.existsSync).toHaveBeenCalledWith(_n('/foo/bar.js'));
-  });
-  test('allows file argument', () => {
-    fs.__setResponse('existsSync', false);
-    expect(utils.safeRead({ dirname: _n('/foo'), basename: 'bar.js' })).toBe(null);
-    expect(fs.__spy.existsSync).toHaveBeenCalledWith(_n('/foo/bar.js'));
-  });
-});
-
-describe('safeWrite', () => {
-  test('creates directories recursively', () => {
-    fs.__setResponse('existsSync', false);
-    utils.safeWrite(_n('/foo/bar/baz.js'), 'qux');
-    expect(fs.__spy.existsSync).toHaveBeenCalledWith(_n('/foo'));
-    expect(fs.__spy.mkdirSync).toHaveBeenCalledWith(_n('/foo'));
-    expect(fs.__spy.existsSync).toHaveBeenCalledWith(_n('/foo/bar'));
-    expect(fs.__spy.mkdirSync).toHaveBeenCalledWith(_n('/foo/bar'));
-    expect(fs.__spy.writeFileSync).toHaveBeenCalledWith(_n('/foo/bar/baz.js'), 'qux', 'UTF-8');
-  });
-  test('only creates directories when they do not exist', () => {
-    fs.__setResponse('existsSync', true);
-    utils.safeWrite(_n('/foo/bar/baz.js'), 'qux');
-    expect(fs.__spy.existsSync).toHaveBeenCalledWith(_n('/foo'));
-    expect(fs.__spy.mkdirSync).not.toHaveBeenCalledWith(_n('/foo'));
-    expect(fs.__spy.existsSync).toHaveBeenCalledWith(_n('/foo/bar'));
-    expect(fs.__spy.mkdirSync).not.toHaveBeenCalledWith(_n('/foo/bar'));
-    expect(fs.__spy.writeFileSync).toHaveBeenCalledWith(_n('/foo/bar/baz.js'), 'qux', 'UTF-8');
-  });
-  test('allows string argument', () => {
-    fs.__setResponse('existsSync', false);
-    utils.safeWrite(_n('/foo/bar.js'), 'baz');
-    expect(fs.__spy.existsSync).toHaveBeenCalledWith(_n('/foo'));
-    expect(fs.__spy.mkdirSync).toHaveBeenCalledWith(_n('/foo'));
-    expect(fs.__spy.writeFileSync).toHaveBeenCalledWith(_n('/foo/bar.js'), 'baz', 'UTF-8');
-  });
-  test('allows file argument', () => {
-    fs.__setResponse('existsSync', false);
-    utils.safeWrite({ dirname: _n('/foo'), basename: 'bar.js' }, 'baz');
-    expect(fs.__spy.existsSync).toHaveBeenCalledWith(_n('/foo'));
-    expect(fs.__spy.mkdirSync).toHaveBeenCalledWith(_n('/foo'));
-    expect(fs.__spy.writeFileSync).toHaveBeenCalledWith(_n('/foo/bar.js'), 'baz', 'UTF-8');
-  });
-});
-
-describe('logChange', () => {
-  test('calls console.log', () => {
-    expect(spyError).not.toHaveBeenCalled();
-    expect(spyLog).not.toHaveBeenCalled();
-    utils.logChange('foo');
-    expect(spyError).not.toHaveBeenCalled();
-    expect(spyLog).toHaveBeenCalled();
-  });
-});
-
-describe('logRemoval', () => {
-  test('calls console.log', () => {
-    expect(spyError).not.toHaveBeenCalled();
-    expect(spyLog).not.toHaveBeenCalled();
-    utils.logRemoval('foo');
-    expect(spyError).not.toHaveBeenCalled();
-    expect(spyLog).toHaveBeenCalled();
-  });
-});
-
-describe('logError', () => {
-  test('calls console.error', () => {
-    expect(spyError).not.toHaveBeenCalled();
-    expect(spyLog).not.toHaveBeenCalled();
-    utils.logError('foo');
-    expect(spyError).toHaveBeenCalled();
-    expect(spyLog).not.toHaveBeenCalled();
-  });
-});
-
-describe('parameterizeString', () => {
-  test('translates', () => {
-    expect(utils.parameterizeString('foo', {})).toBe('foo');
-    expect(utils.parameterizeString('_foo_', {})).toBe('_foo_');
-    expect(utils.parameterizeString('_foo_', { foo: 'bar' })).toBe('bar');
-    expect(utils.parameterizeString('_foo.bar_', { foo: { bar: 'baz' } })).toBe('baz');
-    expect(utils.parameterizeString('_foo_', { foo: 2 })).toBe('2');
-  });
-});
-
-describe('lowerCaseFirst', () => {
-  test('lowers first letter', () => {
-    expect(utils.lowerCaseFirst('Foo')).toBe('foo');
-    expect(utils.lowerCaseFirst('FOO')).toBe('fOO');
-  });
-  test('leaves strings with lower-first alone', () => {
-    expect(utils.lowerCaseFirst('')).toBe('');
-    expect(utils.lowerCaseFirst('foo')).toBe('foo');
-    expect(utils.lowerCaseFirst('fOO')).toBe('fOO');
-    expect(utils.lowerCaseFirst('foO')).toBe('foO');
-  });
-  test('ignores numbers at the start', () => {
-    expect(utils.lowerCaseFirst('0oO')).toBe('0oO');
-  });
-  test('passes through non-strings', () => {
-    expect(utils.lowerCaseFirst(false)).toBe(false);
-    expect(utils.lowerCaseFirst(undefined)).toBe(undefined);
-    expect(utils.lowerCaseFirst(null)).toBe(null);
-    expect(utils.lowerCaseFirst(1)).toBe(1);
-  });
-});