snap-shot-core/src/utils.js

'use strict'

const la = require('lazy-ass')
const is = require('check-more-types')
const Result = require('folktale/result')
const jsesc = require('jsesc')

// TODO: we should also consider the file spec name + test name id:5
// Gleb Bahmutov
// gleb.bahmutov@gmail.com
// https://github.com/bahmutov/snap-shot-core/issues/90
// not just spec name (which is test name here)
function snapshotIndex (options) {
  const counters = options.counters
  const file = options.file
  const specName = options.specName

  la(is.object(counters), 'expected counters', counters)
  la(is.unemptyString(specName), 'expected specName', specName)
  la(is.unemptyString(file), 'missing filename', file)

  if (!(specName in counters)) {
    counters[specName] = 1
  } else {
    counters[specName] += 1
  }
  return counters[specName]
}

// make sure values in the object are "safe" to be serialized
// and compared from loaded value
function strip (o) {
  if (is.fn(o)) {
    return o
  }
  return JSON.parse(JSON.stringify(o))
}

function compare (options) {
  const expected = options.expected
  const value = options.value

  const e = JSON.stringify(expected)
  const v = JSON.stringify(value)
  if (e === v) {
    return Result.Ok()
  }
  return Result.Error(`${e} !== ${v}`)
}

const sameTypes = (a, b) => typeof expected === typeof value

const compareTypes = options => {
  const expected = options.expected
  const value = options.value
  return sameTypes(expected, value) ? Result.Ok() : Result.Error('no message')
}

/**
 * Serializes and escapes a string value before saving.
 * @param {string} name for the snapshot
 * @param {string} value text to be escaped for saving
 */
function exportText (name, value) {
  la(is.unemptyString(name), 'expected snapshot name, got:', name)
  la(is.string(value), 'expected string value', value)

  // jsesc replace "\n" with "\\n"
  // https://github.com/mathiasbynens/jsesc/issues/20
  const serialized = value
    .split('\n')
    .map(line => {
      return jsesc(line, {
        quotes: 'backtick',
        minimal: true
      })
    })
    .join('\n')
  const withNewLines = '\n' + serialized + '\n'
  return `exports['${name}'] = \`${withNewLines}\`\n`
}

/**
 * Escapes properties of an object to be safe for saving
 */
function exportObject (name, value) {
  const serialized = jsesc(value, {
    json: true,
    compact: false,
    indent: '  ',
    minimal: true
  })
  return `exports['${name}'] = ${serialized}\n`
}

const isSurroundedByNewLines = s =>
  is.string(s) && s.length > 1 && s[0] === '\n' && s[s.length - 1] === '\n'

// when we save string snapshots we add extra new lines to
// avoid long first lines
// when loading snapshots we should remove these new lines
// from string properties
function removeExtraNewLines (snapshots) {
  Object.keys(snapshots).forEach(key => {
    const value = snapshots[key]
    if (isSurroundedByNewLines(value)) {
      snapshots[key] = value.substr(1, value.length - 2)
    }
  })
  return snapshots
}

const DEFAULT_EXTENSION = '.snapshot.js'

module.exports = {
  snapshotIndex,
  strip,
  compare,
  sameTypes,
  compareTypes,
  exportText,
  exportObject,
  removeExtraNewLines,
  DEFAULT_EXTENSION
}