prettier 1.0.0.pre.rc1 → 1.2.0

data/src/nodes/arrays.js

@@ -1,7 +1,6 @@
 const {
   concat,
   group,
-  hardline,
   ifBreak,
   indent,
   join,
@@ -9,7 +8,7 @@ const {
   softline
 } = require("../prettier");
 
-const { getTrailingComma } = require("../utils");
+const { getTrailingComma, printEmptyCollection } = require("../utils");
 
 // Checks that every argument within this args node is a string_literal node
 // that has no spaces or interpolations. This means we're dealing with an array
@@ -18,32 +17,35 @@ const { getTrailingComma } = require("../utils");
 //     ['a', 'b', 'c']
 //
 function isStringArray(args) {
-  return args.body.every((arg) => {
-    // We want to verify that every node inside of this array is a string
-    // literal. We also want to make sure none of them have comments attached.
-    if (arg.type !== "string_literal" || arg.comments) {
-      return false;
-    }
-
-    // If the string has multiple parts (meaning plain string content but also
-    // interpolated content) then we know it's not a simple string.
-    if (arg.body.length !== 1) {
-      return false;
-    }
-
-    const part = arg.body[0];
-
-    // If the only part of this string is not @tstring_content then it's
-    // interpolated, so again we can return false.
-    if (part.type !== "@tstring_content") {
-      return false;
-    }
-
-    // Finally, verify that the string doesn't contain a space, an escape
-    // character, or brackets so that we know it can be put into a string
-    // literal array.
-    return !/[\s\\[\]]/.test(part.body);
-  });
+  return (
+    args.body.length > 1 &&
+    args.body.every((arg) => {
+      // We want to verify that every node inside of this array is a string
+      // literal. We also want to make sure none of them have comments attached.
+      if (arg.type !== "string_literal" || arg.comments) {
+        return false;
+      }
+
+      // If the string has multiple parts (meaning plain string content but also
+      // interpolated content) then we know it's not a simple string.
+      if (arg.body.length !== 1) {
+        return false;
+      }
+
+      const part = arg.body[0];
+
+      // If the only part of this string is not @tstring_content then it's
+      // interpolated, so again we can return false.
+      if (part.type !== "@tstring_content") {
+        return false;
+      }
+
+      // Finally, verify that the string doesn't contain a space, an escape
+      // character, or brackets so that we know it can be put into a string
+      // literal array.
+      return !/[\s\\[\]]/.test(part.body);
+    })
+  );
 }
 
 // Checks that every argument within this args node is a symbol_literal node (as
@@ -53,8 +55,9 @@ function isStringArray(args) {
 //     [:a, :b, :c]
 //
 function isSymbolArray(args) {
-  return args.body.every(
-    (arg) => arg.type === "symbol_literal" && !arg.comments
+  return (
+    args.body.length > 1 &&
+    args.body.every((arg) => arg.type === "symbol_literal" && !arg.comments)
   );
 }
 
@@ -89,24 +92,6 @@ function printSpecialArray(start) {
   };
 }
 
-function printEmptyArrayWithComments(path, opts) {
-  const arrayNode = path.getValue();
-
-  const printComment = (commentPath, index) => {
-    arrayNode.comments[index].printed = true;
-    return opts.printer.printComment(commentPath);
-  };
-
-  return concat([
-    "[",
-    indent(
-      concat([hardline, join(hardline, path.map(printComment, "comments"))])
-    ),
-    line,
-    "]"
-  ]);
-}
-
 // An array node is any literal array in Ruby. This includes all of the special
 // array literals as well as regular arrays. If it is a special array literal
 // then it will have one child that represents the special array, otherwise it
@@ -118,12 +103,12 @@ function printArray(path, opts, print) {
   // If there is no inner arguments node, then we're dealing with an empty
   // array, so we can go ahead and return.
   if (args === null) {
-    return array.comments ? printEmptyArrayWithComments(path, opts) : "[]";
+    return printEmptyCollection(path, opts, "[", "]");
   }
 
   // If we have an array that contains only simple string literals with no
   // spaces or interpolation, then we're going to print a %w array.
-  if (isStringArray(args)) {
+  if (opts.rubyArrayLiteral && isStringArray(args)) {
     const printString = (stringPath) => stringPath.call(print, "body", 0);
     const parts = path.map(printString, "body", 0, "body");
 
@@ -132,7 +117,7 @@ function printArray(path, opts, print) {
 
   // If we have an array that contains only simple symbol literals with no
   // interpolation, then we're going to print a %i array.
-  if (isSymbolArray(args)) {
+  if (opts.rubyArrayLiteral && isSymbolArray(args)) {
     const printSymbol = (symbolPath) => symbolPath.call(print, "body", 0);
     const parts = path.map(printSymbol, "body", 0, "body");
 

data/src/nodes/assign.js

@@ -1,5 +1,5 @@
 const { concat, group, indent, join, line } = require("../prettier");
-const { concatBody, first, skipAssignIndent } = require("../utils");
+const { first, skipAssignIndent } = require("../utils");
 
 function printAssign(path, opts, print) {
   const [_targetNode, valueNode] = path.getValue().body;
@@ -31,9 +31,17 @@ function printOpAssign(path, opts, print) {
   );
 }
 
+function printVarField(path, opts, print) {
+  if (path.getValue().body) {
+    return path.call(print, "body", 0);
+  }
+
+  return "*";
+}
+
 module.exports = {
   assign: printAssign,
   opassign: printOpAssign,
-  var_field: concatBody,
+  var_field: printVarField,
   var_ref: first
 };

data/src/nodes/calls.js

@@ -6,15 +6,15 @@ const {
   indent,
   softline
 } = require("../prettier");
-const { concatBody, first, makeCall, noIndent } = require("../utils");
+const { first, makeCall, noIndent } = require("../utils");
 
 const toProc = require("../toProc");
 
-const chained = ["call", "method_add_arg"];
+const chained = ["call", "method_add_arg", "method_add_block"];
 
 function printCall(path, opts, print) {
-  const callNode = path.getValue();
-  const [receiverNode, _operatorNode, messageNode] = callNode.body;
+  const node = path.getValue();
+  const [receiverNode, _operatorNode, messageNode] = node.body;
 
   const receiverDoc = path.call(print, "body", 0);
   const operatorDoc = makeCall(path, opts, print);
@@ -24,21 +24,13 @@ function printCall(path, opts, print) {
   // call syntax so if `call` is implicit, we don't print it out.
   const messageDoc = messageNode === "call" ? "" : path.call(print, "body", 2);
 
-  // For certain left sides of the call nodes, we want to attach directly to
-  // the } or end.
-  if (noIndent.includes(receiverNode.type)) {
-    return concat([receiverDoc, operatorDoc, messageDoc]);
-  }
-
   // The right side of the call node, as in everything including the operator
   // and beyond.
-  const rightSideDoc = indent(
-    concat([
-      receiverNode.comments ? hardline : softline,
-      operatorDoc,
-      messageDoc
-    ])
-  );
+  const rightSideDoc = concat([
+    receiverNode.comments ? hardline : softline,
+    operatorDoc,
+    messageDoc
+  ]);
 
   // Get a reference to the parent node so we can check if we're inside a chain
   const parentNode = path.getParentNode();
@@ -46,33 +38,56 @@ function printCall(path, opts, print) {
   // If our parent node is a chained node then we're not going to group the
   // right side of the expression, as we want to have a nice multi-line layout.
   if (chained.includes(parentNode.type)) {
-    parentNode.chain = (callNode.chain || 0) + 1;
-    parentNode.breakDoc = (callNode.breakDoc || [receiverDoc]).concat(
-      rightSideDoc
-    );
+    parentNode.chain = (node.chain || 0) + 1;
+    parentNode.callChain = (node.callChain || 0) + 1;
+    parentNode.breakDoc = (node.breakDoc || [receiverDoc]).concat(rightSideDoc);
   }
 
   // If we're at the top of a chain, then we're going to print out a nice
   // multi-line layout if this doesn't break into multiple lines.
-  if (!chained.includes(parentNode.type) && (callNode.chain || 0) >= 3) {
+  if (!chained.includes(parentNode.type) && (node.chain || 0) >= 3) {
     return ifBreak(
-      group(concat(callNode.breakDoc.concat(rightSideDoc))),
+      group(indent(concat(node.breakDoc.concat(rightSideDoc)))),
       concat([receiverDoc, group(rightSideDoc)])
     );
   }
 
-  return group(concat([receiverDoc, group(rightSideDoc)]));
+  // For certain left sides of the call nodes, we want to attach directly to
+  // the } or end.
+  if (noIndent.includes(receiverNode.type)) {
+    return concat([receiverDoc, operatorDoc, messageDoc]);
+  }
+
+  return group(concat([receiverDoc, group(indent(rightSideDoc))]));
 }
 
 function printMethodAddArg(path, opts, print) {
-  const methodAddArgNode = path.getValue();
-  const argNode = methodAddArgNode.body[1];
+  const node = path.getValue();
 
+  const [methodNode, argNode] = node.body;
   const [methodDoc, argsDoc] = path.map(print, "body");
 
   // You can end up here if you have a method with a ? ending, presumably
-  // because the parser knows that it cannot be a local variable.
+  // because the parser knows that it cannot be a local variable. You can also
+  // end up here if you are explicitly using an empty set of parentheses.
   if (argsDoc.length === 0) {
+    // If you're using an explicit set of parentheses on something that looks
+    // like a constant, then we need to match that in order to maintain valid
+    // Ruby. For example, you could do something like Foo(), on which we would
+    // need to keep the parentheses to make it look like a method call.
+    if (methodNode.type === "fcall" && methodNode.body[0].type === "@const") {
+      return concat([methodDoc, "()"]);
+    }
+
+    // If you're using an explicit set parentheses with the special call syntax,
+    // then we need to explicitly print out an extra set of parentheses. For
+    // example, if you call something like Foo.new.() (implicitly calling the
+    // #call method on a new instance of the Foo class), then we have to print
+    // out those parentheses, otherwise we'll end up with Foo.new.
+    if (methodNode.type === "call" && methodNode.body[2] === "call") {
+      return concat([methodDoc, "()"]);
+    }
+
     return methodDoc;
   }
 
@@ -88,20 +103,30 @@ function printMethodAddArg(path, opts, print) {
   // If our parent node is a chained node then we're not going to group the
   // right side of the expression, as we want to have a nice multi-line layout.
   if (chained.includes(parentNode.type)) {
-    parentNode.chain = (methodAddArgNode.chain || 0) + 1;
-    parentNode.breakDoc = (methodAddArgNode.breakDoc || [methodDoc]).concat(
-      argsDoc
-    );
+    parentNode.chain = (node.chain || 0) + 1;
+    parentNode.breakDoc = (node.breakDoc || [methodDoc]).concat(argsDoc);
   }
 
   // If we're at the top of a chain, then we're going to print out a nice
   // multi-line layout if this doesn't break into multiple lines.
-  if (
-    !chained.includes(parentNode.type) &&
-    (methodAddArgNode.chain || 0) >= 3
-  ) {
+  if (!chained.includes(parentNode.type) && (node.chain || 0) >= 3) {
+    // This is pretty specialized behavior. Basically if we're at the top of a
+    // chain but we've only had method calls without arguments and now we have
+    // arguments, then we're effectively trying to call a method with arguments
+    // that is nested under a bunch of stuff. So we group together to first part
+    // to make it so just the arguments break. This looks like, for example:
+    //
+    //     config.action_dispatch.rescue_responses.merge!(
+    //       'ActiveRecord::ConnectionTimeoutError' => :service_unavailable,
+    //       'ActiveRecord::QueryCanceled' => :service_unavailable
+    //     )
+    //
+    if (node.callChain === node.chain) {
+      return concat([group(indent(concat(node.breakDoc))), group(argsDoc)]);
+    }
+
     return ifBreak(
-      group(concat(methodAddArgNode.breakDoc.concat(argsDoc))),
+      group(indent(concat(node.breakDoc.concat(argsDoc)))),
       concat([methodDoc, argsDoc])
     );
   }
@@ -109,15 +134,47 @@ function printMethodAddArg(path, opts, print) {
   return concat([methodDoc, argsDoc]);
 }
 
-module.exports = {
-  call: printCall,
-  fcall: concatBody,
-  method_add_arg: printMethodAddArg,
-  method_add_block: (path, opts, print) => {
-    const [method, block] = path.getValue().body;
-    const proc = toProc(path, opts, block);
+// Sorbet type annotations look like the following:
+//
+//     {method_add_block
+//       [{method_add_arg
+//          [{fcall
+//             [{@ident "sig"}]},
+//           {args []}]},
+//        {brace_block [nil, {stmts}]}}]}
+//
+function isSorbetTypeAnnotation(node) {
+  const [callNode, blockNode] = node.body;
+
+  return (
+    callNode.type === "method_add_arg" &&
+    callNode.body[0].type === "fcall" &&
+    callNode.body[0].body[0].body === "sig" &&
+    callNode.body[1].type === "args" &&
+    callNode.body[1].body.length === 0 &&
+    blockNode.type === "brace_block"
+  );
+}
 
-    if (proc && method.type === "call") {
+function printMethodAddBlock(path, opts, print) {
+  const node = path.getValue();
+
+  const [callNode, blockNode] = node.body;
+  const [callDoc, blockDoc] = path.map(print, "body");
+
+  // Very special handling here for sorbet type annotations. They look like Ruby
+  // code, but they're not actually Ruby code, so we're not going to mess with
+  // them at all.
+  if (isSorbetTypeAnnotation(node)) {
+    return opts.originalText.slice(opts.locStart(node), opts.locEnd(node));
+  }
+
+  // Don't bother trying to do any kind of fancy toProc transform if the option
+  // is disabled.
+  if (opts.rubyToProc) {
+    const proc = toProc(path, blockNode);
+
+    if (proc && callNode.type === "call") {
       return group(
         concat([
           path.call(print, "body", 0),
@@ -131,8 +188,34 @@ module.exports = {
     if (proc) {
       return path.call(print, "body", 0);
     }
+  }
 
-    return concat(path.map(print, "body"));
-  },
+  // Get a reference to the parent node so we can check if we're inside a chain
+  const parentNode = path.getParentNode();
+
+  // If our parent node is a chained node then we're not going to group the
+  // right side of the expression, as we want to have a nice multi-line layout.
+  if (chained.includes(parentNode.type)) {
+    parentNode.chain = (node.chain || 0) + 1;
+    parentNode.breakDoc = (node.breakDoc || [callDoc]).concat(blockDoc);
+  }
+
+  // If we're at the top of a chain, then we're going to print out a nice
+  // multi-line layout if this doesn't break into multiple lines.
+  if (!chained.includes(parentNode.type) && (node.chain || 0) >= 3) {
+    return ifBreak(
+      group(indent(concat(node.breakDoc.concat(blockDoc)))),
+      concat([callDoc, blockDoc])
+    );
+  }
+
+  return concat([callDoc, blockDoc]);
+}
+
+module.exports = {
+  call: printCall,
+  fcall: first,
+  method_add_arg: printMethodAddArg,
+  method_add_block: printMethodAddBlock,
   vcall: first
 };

data/src/nodes/case.js

@@ -28,13 +28,17 @@ module.exports = {
     // The `fill` builder command expects an array of docs alternating with
     // line breaks. This is so it can loop through and determine where to break.
     const preds = fill(
-      path
-        .call(print, "body", 0)
-        .reduce(
-          (accum, pred, index) =>
-            index === 0 ? [pred] : accum.concat([",", line, pred]),
-          null
-        )
+      path.call(print, "body", 0).reduce((accum, pred, index) => {
+        if (index === 0) {
+          return [pred];
+        }
+
+        // Pull off the last element and make it concat with a comma so that
+        // we can maintain alternating lines and docs.
+        return accum
+          .slice(0, -1)
+          .concat([concat([accum[accum.length - 1], ","]), line, pred]);
+      }, null)
     );
 
     const stmts = path.call(print, "body", 1);

data/src/nodes/hashes.js

@@ -1,14 +1,11 @@
-const {
-  concat,
-  group,
-  hardline,
-  ifBreak,
-  indent,
-  join,
-  line
-} = require("../prettier");
+const { concat, group, ifBreak, indent, join, line } = require("../prettier");
 
-const { getTrailingComma, prefix, skipAssignIndent } = require("../utils");
+const {
+  getTrailingComma,
+  prefix,
+  printEmptyCollection,
+  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
@@ -25,35 +22,54 @@ function isValidHashLabel(symbolLiteral) {
   return label.match(/^[_A-Za-z]/) && !label.endsWith("=");
 }
 
-function printHashKey(path, { rubyHashLabel }, print) {
-  const labelNode = path.getValue().body[0];
-  const labelDoc = path.call(print, "body", 0);
+function canUseHashLabels(contentsNode) {
+  return contentsNode.body.every((assocNode) => {
+    if (assocNode.type === "assoc_splat") {
+      return true;
+    }
 
-  switch (labelNode.type) {
-    case "@label":
-      if (rubyHashLabel) {
-        return labelDoc;
-      }
-      return `:${labelDoc.slice(0, labelDoc.length - 1)} =>`;
-    case "symbol_literal": {
-      if (rubyHashLabel && isValidHashLabel(labelNode)) {
-        return concat([path.call(print, "body", 0, "body", 0), ":"]);
-      }
-      return concat([labelDoc, " =>"]);
+    switch (assocNode.body[0].type) {
+      case "@label":
+        return true;
+      case "symbol_literal":
+        return isValidHashLabel(assocNode.body[0]);
+      case "dyna_symbol":
+        return true;
+      default:
+        return false;
     }
+  });
+}
+
+function printHashKeyLabel(path, print) {
+  const node = path.getValue();
+
+  switch (node.type) {
+    case "@label":
+      return print(path);
+    case "symbol_literal":
+      return concat([path.call(print, "body", 0), ":"]);
     case "dyna_symbol":
-      if (rubyHashLabel) {
-        return concat(labelDoc.parts.slice(1).concat(":"));
-      }
-      return concat([labelDoc, " =>"]);
-    default:
-      return concat([labelDoc, " =>"]);
+      return concat(print(path).parts.slice(1).concat(":"));
+  }
+}
+
+function printHashKeyRocket(path, print) {
+  const node = path.getValue();
+  const doc = print(path);
+
+  if (node.type === "@label") {
+    return `:${doc.slice(0, doc.length - 1)} =>`;
   }
+
+  return concat([doc, " =>"]);
 }
 
 function printAssocNew(path, opts, print) {
+  const { keyPrinter } = path.getParentNode();
+
+  const parts = [path.call((keyPath) => keyPrinter(keyPath, print), "body", 0)];
   const valueDoc = path.call(print, "body", 1);
-  const parts = [printHashKey(path, opts, print)];
 
   if (skipAssignIndent(path.getValue().body[1])) {
     parts.push(" ", valueDoc);
@@ -64,22 +80,17 @@ function printAssocNew(path, opts, print) {
   return group(concat(parts));
 }
 
-function printEmptyHashWithComments(path, opts) {
-  const hashNode = path.getValue();
+function printHashContents(path, opts, print) {
+  const node = path.getValue();
+
+  // First determine which key printer we're going to use, so that the child
+  // nodes can reference it when they go to get printed.
+  node.keyPrinter =
+    opts.rubyHashLabel && canUseHashLabels(path.getValue())
+      ? printHashKeyLabel
+      : printHashKeyRocket;
 
-  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,
-    "}"
-  ]);
+  return join(concat([",", line]), path.map(print, "body"));
 }
 
 function printHash(path, opts, print) {
@@ -89,7 +100,7 @@ function printHash(path, opts, print) {
   // 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 hashNode.comments ? printEmptyHashWithComments(path, opts) : "{}";
+    return printEmptyCollection(path, opts, "{", "}");
   }
 
   return group(
@@ -108,10 +119,6 @@ function printHash(path, opts, print) {
   );
 }
 
-function printHashContents(path, opts, print) {
-  return group(join(concat([",", line]), path.map(print, "body")));
-}
-
 module.exports = {
   assoc_new: printAssocNew,
   assoc_splat: prefix("**"),