const { concat, group, ifBreak, indent, join, line, softline } = require("../../prettier"); 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 // that looks something like: // // ['a', 'b', 'c'] // function isStringArray(args) { 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 // opposed to a dyna_symbol) so it has no interpolation. This means we're // dealing with an array that looks something like: // // [:a, :b, :c] // function isSymbolArray(args) { return ( args.body.length > 1 && args.body.every((arg) => arg.type === "symbol_literal" && !arg.comments) ); } // Prints out a word that is a part of a special array literal that accepts // interpolation. The body is an array of either plain strings or interpolated // expressions. function printArrayLiteralWord(path, opts, print) { return concat(path.map(print, "body")); } // Prints out a special array literal. Accepts the parts of the array literal as // an argument, where the first element of the parts array is a string that // contains the special start. function printArrayLiteral(start, parts) { return group( concat([ start, "[", indent(concat([softline, join(line, parts)])), concat([softline, "]"]) ]) ); } const arrayLiteralStarts = { qsymbols: "%i", qwords: "%w", symbols: "%I", words: "%W" }; // 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 // will have one child that contains all of the elements of the array. function printArray(path, opts, print) { const array = path.getValue(); const args = array.body[0]; // 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 printEmptyCollection(path, opts, "[", "]"); } if (opts.rubyArrayLiteral) { // 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)) { const printString = (stringPath) => stringPath.call(print, "body", 0); const parts = path.map(printString, "body", 0, "body"); return printArrayLiteral("%w", parts); } // 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)) { const printSymbol = (symbolPath) => symbolPath.call(print, "body", 0); const parts = path.map(printSymbol, "body", 0, "body"); return printArrayLiteral("%i", parts); } } // If we don't have a regular args node at this point then we have a special // array literal. In that case we're going to print out the body (which will // return to us an array with the first one being the start of the array) and // send that over to the printArrayLiteral function. if (!["args", "args_add_star"].includes(args.type)) { return path.call( (arrayPath) => printArrayLiteral( arrayLiteralStarts[arrayPath.getValue().type], arrayPath.map(print, "body") ), "body", 0 ); } // Here we have a normal array of any type of object with no special literal // types or anything. return group( concat([ "[", indent( concat([ softline, join(concat([",", line]), path.call(print, "body", 0)), getTrailingComma(opts) ? ifBreak(",", "") : "" ]) ), softline, "]" ]) ); } module.exports = { array: printArray, word: printArrayLiteralWord };