prettier 0.21.0 → 0.22.0

data/src/nodes/class.js

@@ -0,0 +1,74 @@
+const {
+  concat,
+  group,
+  hardline,
+  ifBreak,
+  indent,
+  line
+} = require("../prettier");
+
+function printClass(path, opts, print) {
+  const [_constant, superclass, bodystmt] = path.getValue().body;
+  const stmts = bodystmt.body[0];
+
+  const parts = ["class ", path.call(print, "body", 0)];
+  if (superclass) {
+    parts.push(" < ", path.call(print, "body", 1));
+  }
+
+  // If the body is empty and does not contain any comments, we can just
+  // replace the body with a semi-colon.
+  if (
+    stmts.body.length === 1 &&
+    stmts.body[0].type === "void_stmt" &&
+    !stmts.body[0].comments
+  ) {
+    return group(concat([concat(parts), ifBreak(line, "; "), "end"]));
+  }
+
+  return group(
+    concat([
+      concat(parts),
+      indent(concat([hardline, path.call(print, "body", 2)])),
+      concat([hardline, "end"])
+    ])
+  );
+}
+
+function printModule(path, opts, print) {
+  const declaration = group(concat(["module ", path.call(print, "body", 0)]));
+
+  // If the body is empty, we can replace with a ;
+  const stmts = path.getValue().body[1].body[0];
+  if (
+    stmts.body.length === 1 &&
+    stmts.body[0].type === "void_stmt" &&
+    !stmts.body[0].comments
+  ) {
+    return group(concat([declaration, ifBreak(line, "; "), "end"]));
+  }
+
+  return group(
+    concat([
+      declaration,
+      indent(concat([hardline, path.call(print, "body", 1)])),
+      concat([hardline, "end"])
+    ])
+  );
+}
+
+function printSClass(path, opts, print) {
+  return group(
+    concat([
+      concat(["class << ", path.call(print, "body", 0)]),
+      indent(concat([hardline, path.call(print, "body", 1)])),
+      concat([hardline, "end"])
+    ])
+  );
+}
+
+module.exports = {
+  class: printClass,
+  module: printModule,
+  sclass: printSClass
+};

data/src/nodes/commands.js

@@ -1,5 +1,14 @@
-const { align, concat, group, ifBreak, join, line } = require("../prettier");
-const { docLength, makeArgs, makeCall } = require("../utils");
+const {
+  align,
+  concat,
+  group,
+  ifBreak,
+  indent,
+  join,
+  line,
+  softline
+} = require("../prettier");
+const { docLength, makeCall } = require("../utils");
 
 const hasDef = (node) =>
   node.body[1].type === "args_add_block" &&
@@ -23,32 +32,39 @@ const hasDef = (node) =>
 const skipArgsAlign = (path) =>
   ["to", "not_to"].includes(path.getValue().body[2].body);
 
+// If there is a ternary argument to a command and it's going to get broken
+// into multiple lines, then we're going to have to use parentheses around the
+// command in order to make sure operator precedence doesn't get messed up.
+const hasTernaryArg = (path) =>
+  path.getValue().body[1].body[0].body.some((node) => node.type === "ifop");
+
 module.exports = {
   command: (path, opts, print) => {
     const command = path.call(print, "body", 0);
-    const { args, heredocs } = makeArgs(path, opts, print, 1);
+    const joinedArgs = join(concat([",", line]), path.call(print, "body", 1));
 
-    if (heredocs.length > 1) {
-      return concat([command, " ", join(", ", args)].concat(heredocs));
-    }
+    const hasTernary = hasTernaryArg(path);
+    let breakArgs;
 
-    const joinedArgs = join(concat([",", line]), args);
-    const breakArgs = hasDef(path.getValue())
-      ? joinedArgs
-      : align(command.length + 1, joinedArgs);
+    if (hasTernary) {
+      breakArgs = indent(concat([softline, joinedArgs]));
+    } else if (hasDef(path.getValue())) {
+      breakArgs = joinedArgs;
+    } else {
+      breakArgs = align(command.length + 1, joinedArgs);
+    }
 
-    const commandDoc = group(
+    return group(
       ifBreak(
-        concat([command, " ", breakArgs]),
+        concat([
+          command,
+          hasTernary ? "(" : " ",
+          breakArgs,
+          hasTernary ? concat([softline, ")"]) : ""
+        ]),
         concat([command, " ", joinedArgs])
       )
     );
-
-    if (heredocs.length === 1) {
-      return group(concat([commandDoc].concat(heredocs)));
-    }
-
-    return commandDoc;
   },
   command_call: (path, opts, print) => {
     const parts = [
@@ -62,25 +78,14 @@ module.exports = {
     }
 
     parts.push(" ");
-    const { args, heredocs } = makeArgs(path, opts, print, 3);
-
-    if (heredocs.length > 1) {
-      return concat(parts.concat([join(", ", args)]).concat(heredocs));
-    }
 
-    const joinedArgs = join(concat([",", line]), args);
+    const joinedArgs = join(concat([",", line]), path.call(print, "body", 3));
     const breakArgs = skipArgsAlign(path)
       ? joinedArgs
       : align(docLength(concat(parts)), joinedArgs);
 
-    const commandDoc = group(
+    return group(
       ifBreak(concat(parts.concat(breakArgs)), concat(parts.concat(joinedArgs)))
     );
-
-    if (heredocs.length === 1) {
-      return group(concat([commandDoc].concat(heredocs)));
-    }
-
-    return commandDoc;
   }
 };

data/src/nodes/conditionals.js

@@ -9,7 +9,7 @@ const {
   softline
 } = require("../prettier");
 
-const { containsAssignment } = require("../utils");
+const { containsAssignment, isEmptyStmts } = require("../utils");
 const inlineEnsureParens = require("../utils/inlineEnsureParens");
 
 const printWithAddition = (keyword, path, print, { breaking = false } = {}) =>
@@ -80,36 +80,50 @@ const printTernary = (path, _opts, print) => {
 // Prints an `if_mod` or `unless_mod` node. Because it was previously in the
 // modifier form, we're guaranteed to not have an additional node, so we can
 // just work with the predicate and the body.
-const printSingle = (keyword) => (path, { inlineConditionals }, print) => {
-  const multiline = concat([
-    `${keyword} `,
-    align(keyword.length + 1, path.call(print, "body", 0)),
-    indent(concat([softline, path.call(print, "body", 1)])),
-    concat([softline, "end"])
-  ]);
+function printSingle(keyword, modifier = false) {
+  return function printSingleWithKeyword(path, { inlineConditionals }, print) {
+    const [_predicateNode, statementsNode] = path.getValue().body;
+    const predicateDoc = path.call(print, "body", 0);
+    const statementsDoc = path.call(print, "body", 1);
 
-  const [_predicate, stmts] = path.getValue().body;
-  const hasComments =
-    stmts.type === "stmts" &&
-    stmts.body.some((stmt) => stmt.type === "@comment");
+    const multilineParts = [
+      `${keyword} `,
+      align(keyword.length + 1, predicateDoc),
+      indent(concat([softline, statementsDoc])),
+      softline,
+      "end"
+    ];
 
-  if (!inlineConditionals || hasComments) {
-    return multiline;
-  }
+    // If we do not allow modifier form conditionals or there are comments
+    // inside of the body of the conditional, then we must print in the
+    // multiline form.
+    if (!inlineConditionals || (!modifier && statementsNode.body[0].comments)) {
+      return concat([concat(multilineParts), breakParent]);
+    }
 
-  const inline = concat(
-    inlineEnsureParens(path, [
-      path.call(print, "body", 1),
-      ` ${keyword} `,
-      path.call(print, "body", 0)
-    ])
-  );
+    const inline = concat(
+      inlineEnsureParens(path, [
+        path.call(print, "body", 1),
+        ` ${keyword} `,
+        path.call(print, "body", 0)
+      ])
+    );
 
-  return group(ifBreak(multiline, inline));
-};
+    // An expression with a conditional modifier (expression if true), the
+    // conditional body is parsed before the predicate expression, meaning that
+    // if the parser encountered a variable declaration, it would initialize
+    // that variable first before evaluating the predicate expression. That
+    // parse order means the difference between a NameError or not. #591
+    // https://docs.ruby-lang.org/en/2.0.0/syntax/control_expressions_rdoc.html#label-Modifier+if+and+unless
+    if (modifier && containsAssignment(statementsNode)) {
+      return inline;
+    }
+
+    return group(ifBreak(concat(multilineParts), inline));
+  };
+}
 
 const noTernary = [
-  "@comment",
   "alias",
   "assign",
   "break",
@@ -205,7 +219,7 @@ const printConditional = (keyword) => (path, { inlineConditionals }, print) => {
 
   // If the body of the conditional is empty, then we explicitly have to use the
   // block form.
-  if (statements.type === "stmts" && statements.body[0].type === "void_stmt") {
+  if (isEmptyStmts(statements) && !statements.body[0].comments) {
     return concat([
       `${keyword} `,
       align(keyword.length + 1, path.call(print, "body", 0)),
@@ -260,7 +274,7 @@ module.exports = {
   },
   if: printConditional("if"),
   ifop: printTernary,
-  if_mod: printSingle("if"),
+  if_mod: printSingle("if", true),
   unless: printConditional("unless"),
-  unless_mod: printSingle("unless")
+  unless_mod: printSingle("unless", true)
 };

data/src/nodes/constants.js

@@ -1,25 +1,43 @@
 const { concat, group, indent, join, softline } = require("../prettier");
-const { first, makeCall, prefix } = require("../utils");
+const { makeCall } = require("../utils");
+
+function printConstPath(path, opts, print) {
+  return join("::", path.map(print, "body"));
+}
+
+function printConstRef(path, opts, print) {
+  return path.call(print, "body", 0);
+}
+
+function printDefined(path, opts, print) {
+  return group(
+    concat([
+      "defined?(",
+      indent(concat([softline, path.call(print, "body", 0)])),
+      concat([softline, ")"])
+    ])
+  );
+}
+
+function printField(path, opts, print) {
+  return group(
+    concat([
+      path.call(print, "body", 0),
+      concat([makeCall(path, opts, print), path.call(print, "body", 2)])
+    ])
+  );
+}
+
+function printTopConst(path, opts, print) {
+  return concat(["::", path.call(print, "body", 0)]);
+}
 
 module.exports = {
-  const_path_field: (path, opts, print) => join("::", path.map(print, "body")),
-  const_path_ref: (path, opts, print) => join("::", path.map(print, "body")),
-  const_ref: first,
-  defined: (path, opts, print) =>
-    group(
-      concat([
-        "defined?(",
-        indent(concat([softline, path.call(print, "body", 0)])),
-        concat([softline, ")"])
-      ])
-    ),
-  field: (path, opts, print) =>
-    group(
-      concat([
-        path.call(print, "body", 0),
-        concat([makeCall(path, opts, print), path.call(print, "body", 2)])
-      ])
-    ),
-  top_const_field: prefix("::"),
-  top_const_ref: prefix("::")
+  const_path_field: printConstPath,
+  const_path_ref: printConstPath,
+  const_ref: printConstRef,
+  defined: printDefined,
+  field: printField,
+  top_const_field: printTopConst,
+  top_const_ref: printTopConst
 };

data/src/nodes/flow.js

@@ -1,5 +1,15 @@
 const { concat, join } = require("../prettier");
-const { literal, nodeDive } = require("../utils");
+const { literal } = require("../utils");
+
+const nodeDive = (node, steps) => {
+  let current = node;
+
+  steps.forEach((step) => {
+    current = current[step];
+  });
+
+  return current;
+};
 
 const unskippableParens = [
   "if_mod",

data/src/nodes/hashes.js

@@ -1,14 +1,13 @@
 const {
   concat,
   group,
+  hardline,
   ifBreak,
   indent,
   join,
-  line,
-  literalline
+  line
 } = require("../prettier");
-
-const { nodeDive, prefix, skipAssignIndent } = require("../utils");
+const { prefix, skipAssignIndent } = require("../utils");
 
 // When attempting to convert a hash rocket into a hash label, you need to take
 // care because only certain patterns are allowed. Ruby source says that they
@@ -20,14 +19,14 @@ const { nodeDive, prefix, skipAssignIndent } = require("../utils");
 //
 // This function represents that check, as it determines if it can convert the
 // symbol node into a hash label.
-const isValidHashLabel = (symbolLiteral) => {
-  const label = symbolLiteral.body[0].body[0].body;
+function isValidHashLabel(symbolLiteral) {
+  const label = symbolLiteral.body[0].body;
   return label.match(/^[_A-Za-z]/) && !label.endsWith("=");
-};
+}
 
-const makeLabel = (path, { preferHashLabels }, print, steps) => {
-  const labelNode = nodeDive(path.getValue(), steps);
-  const labelDoc = path.call.apply(path, [print].concat(steps));
+function printHashKey(path, { preferHashLabels }, print) {
+  const labelNode = path.getValue().body[0];
+  const labelDoc = path.call(print, "body", 0);
 
   switch (labelNode.type) {
     case "@label":
@@ -37,12 +36,7 @@ const makeLabel = (path, { preferHashLabels }, print, steps) => {
       return `:${labelDoc.slice(0, labelDoc.length - 1)} =>`;
     case "symbol_literal": {
       if (preferHashLabels && isValidHashLabel(labelNode)) {
-        const symbolSteps = steps.concat("body", 0, "body", 0);
-
-        return concat([
-          path.call.apply(path, [print].concat(symbolSteps)),
-          ":"
-        ]);
+        return concat([path.call(print, "body", 0, "body", 0), ":"]);
       }
       return concat([labelDoc, " =>"]);
     }
@@ -54,94 +48,73 @@ const makeLabel = (path, { preferHashLabels }, print, steps) => {
     default:
       return concat([labelDoc, " =>"]);
   }
-};
+}
+
+function printAssocNew(path, opts, print) {
+  const valueDoc = path.call(print, "body", 1);
+  const parts = [printHashKey(path, opts, print)];
+
+  if (skipAssignIndent(path.getValue().body[1])) {
+    parts.push(" ", valueDoc);
+  } else {
+    parts.push(indent(concat([line, valueDoc])));
+  }
+
+  return group(concat(parts));
+}
+
+function printEmptyHashWithComments(path, opts) {
+  const hashNode = path.getValue();
+
+  const printComment = (commentPath, index) => {
+    hashNode.comments[index].printed = true;
+    return opts.printer.printComment(commentPath);
+  };
+
+  return concat([
+    "{",
+    indent(
+      concat([hardline, join(hardline, path.map(printComment, "comments"))])
+    ),
+    line,
+    "}"
+  ]);
+}
 
-function printHash(path, { addTrailingCommas }, print) {
+function printHash(path, opts, print) {
   const hashNode = path.getValue();
 
   // Hashes normally have a single assoclist_from_args child node. If it's
   // missing, then it means we're dealing with an empty hash, so we can just
   // exit here and print.
   if (hashNode.body[0] === null) {
-    return "{}";
-  }
-
-  // Here we get a reference to the printed assoclist_from_args child node,
-  // which handles printing all of the key-value pairs of the hash. We're
-  // wrapping it in an array in case we need to append a trailing comma.
-  const assocDocs = [path.call(print, "body", 0)];
-
-  // Here we get a reference to the last key-value pair's value node, in order
-  // to check if we're dealing with a heredoc. If we are, then the trailing
-  // comma printing is handled from within the assoclist_from_args node
-  // printing, because the trailing comma has to go after the heredoc
-  // declaration.
-  const assocNodes = hashNode.body[0].body[0];
-  const lastAssocValueNode = assocNodes[assocNodes.length - 1].body[1];
-
-  // If we're adding a trailing comma and the last key-value pair's value node
-  // is not a heredoc node, then we can safely append the extra comma if the
-  // hash ends up getting printed on multiple lines.
-  if (addTrailingCommas && lastAssocValueNode.type !== "heredoc") {
-    assocDocs.push(ifBreak(",", ""));
+    return hashNode.comments ? printEmptyHashWithComments(path, opts) : "{}";
   }
 
   return group(
     concat([
       "{",
-      indent(concat([line, concat(assocDocs)])),
-      concat([line, "}"])
+      indent(
+        concat([
+          line,
+          path.call(print, "body", 0),
+          opts.addTrailingCommas ? ifBreak(",", "") : ""
+        ])
+      ),
+      line,
+      "}"
     ])
   );
 }
 
-module.exports = {
-  assoc_new: (path, opts, print) => {
-    const valueDoc = path.call(print, "body", 1);
-    const parts = [makeLabel(path, opts, print, ["body", 0])];
-
-    if (skipAssignIndent(path.getValue().body[1])) {
-      parts.push(" ", valueDoc);
-    } else {
-      parts.push(indent(concat([line, valueDoc])));
-    }
+function printHashContents(path, opts, print) {
+  return group(join(concat([",", line]), path.map(print, "body")));
+}
 
-    return group(concat(parts));
-  },
+module.exports = {
+  assoc_new: printAssocNew,
   assoc_splat: prefix("**"),
-  assoclist_from_args: (path, opts, print) => {
-    const { addTrailingCommas } = opts;
-
-    const assocNodes = path.getValue().body[0];
-    const assocDocs = [];
-
-    assocNodes.forEach((assocNode, index) => {
-      const isInner = index !== assocNodes.length - 1;
-      const valueNode = assocNode.body[1];
-
-      if (valueNode && valueNode.type === "heredoc") {
-        assocDocs.push(
-          makeLabel(path, opts, print, ["body", 0, index, "body", 0]),
-          " ",
-          valueNode.beging,
-          isInner || addTrailingCommas ? "," : "",
-          literalline,
-          concat(path.map(print, "body", 0, index, "body", 1, "body")),
-          valueNode.ending,
-          isInner ? line : ""
-        );
-      } else {
-        assocDocs.push(path.call(print, "body", 0, index));
-
-        if (isInner) {
-          assocDocs.push(concat([",", line]));
-        }
-      }
-    });
-
-    return group(concat(assocDocs));
-  },
-  bare_assoc_hash: (path, opts, print) =>
-    group(join(concat([",", line]), path.map(print, "body", 0))),
+  assoclist_from_args: printHashContents,
+  bare_assoc_hash: printHashContents,
   hash: printHash
 };