@prettier/plugin-ruby/src/utils.js

prettier plugin for the Ruby programming language

const {
  breakParent,
  concat,
  hardline,
  lineSuffix,
  literalline
} = require("./prettier");

const concatBody = (path, opts, print) => concat(path.map(print, "body"));

// If the node is a type of assignment or if the node is a paren and nested
// inside that paren is a node that is a type of assignment.
const containsAssignment = node =>
  ["assign", "massign"].includes(node.type) ||
  (node.type === "paren" && node.body[0].body.some(containsAssignment));

const docLength = doc => {
  if (doc.length) {
    return doc.length;
  }

  if (doc.parts) {
    return doc.parts.reduce((sum, child) => sum + docLength(child), 0);
  }

  if (doc.contents) {
    return docLength(doc.contents);
  }

  return 0;
};

const empty = () => "";

const first = (path, opts, print) => path.call(print, "body", 0);

const hasAncestor = (path, types) => {
  let parent = 0;
  let parentNode = path.getParentNode();

  while (parentNode) {
    if (types.includes(parentNode.type)) {
      return true;
    }

    parent += 1;
    parentNode = path.getParentNode(parent);
  }

  return false;
};

const literal = value => () => value;

const makeArgs = (path, opts, print, argsIndex) => {
  let argNodes = path.getValue().body[argsIndex];
  const argPattern = [print, "body", argsIndex, "body"];

  if (argNodes.type === "args_add_block") {
    [argNodes] = argNodes.body;
    argPattern.push(0, "body");
  }

  const args = path.call(print, "body", argsIndex);
  const heredocs = [];

  argNodes.body.forEach((argNode, index) => {
    let pattern;
    let heredoc;

    if (argNode.type === "heredoc") {
      pattern = [index, "body"];
      heredoc = argNode;
    } else if (
      argNode.type === "string_literal" &&
      argNode.body[0].type === "heredoc"
    ) {
      pattern = [index, "body", 0, "body"];
      [heredoc] = argNode.body;
    } else {
      return;
    }

    const content = path.map.apply(path, argPattern.slice().concat(pattern));
    heredocs.push(
      concat([literalline].concat(content).concat([heredoc.ending]))
    );
    args[index] = heredoc.beging;
  });

  return { args, heredocs };
};

const makeCall = (path, opts, print) => {
  const operation = path.getValue().body[1];

  if ([".", "&."].includes(operation)) {
    return operation;
  }

  return operation === "::" ? "." : path.call(print, "body", 1);
};

const makeList = (path, opts, print) => path.map(print, "body");

const prefix = value => (path, opts, print) =>
  concat([value, path.call(print, "body", 0)]);

const printComments = (printed, start, comments) => {
  let node = printed;

  comments.forEach(comment => {
    if (comment.start < start) {
      node = concat([
        comment.break ? breakParent : "",
        comment.body,
        hardline,
        node
      ]);
    } else {
      node = concat([
        node,
        comment.break ? breakParent : "",
        lineSuffix(` ${comment.body}`)
      ]);
    }
  });

  return node;
};

const skipAssignIndent = node =>
  ["array", "hash", "heredoc", "lambda", "regexp_literal"].includes(
    node.type
  ) ||
  (node.type === "call" && skipAssignIndent(node.body[0])) ||
  (node.type === "string_literal" && node.body[0].type === "heredoc");

const surround = (left, right) => (path, opts, print) =>
  concat([left, path.call(print, "body", 0), right]);

module.exports = {
  concatBody,
  containsAssignment,
  docLength,
  empty,
  first,
  hasAncestor,
  literal,
  makeArgs,
  makeCall,
  makeList,
  prefix,
  printComments,
  skipAssignIndent,
  surround
};