prettier 1.5.0 → 1.5.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 24ce6592d56391ec133891b51f4b0fc3092b735ae547547c79a75f953a891d90
-  data.tar.gz: 9b60c471f9d6953ebbcd1f7bd7080d306a3e8fba19a147f2a65ba9fd52542a9a
+  metadata.gz: 97cf5963c684d5bf17079800c59b79fb15f787c89c1b1d7bd315c3851307737f
+  data.tar.gz: 721e04eaa93f654d873e2b972b718b3d1db41d7acca278b8eec743aa92daf755
 SHA512:
-  metadata.gz: d258d7f5838c43e5e2d17a6bc2c02645dc5f347b801e2d4cad9dab298040cf7fc65850562f6f1d36dd35719196f986d4b8fd9243e4da9ea0df3c88a8cec44d6e
-  data.tar.gz: de06627e53a1c7994868f6184dc6d5fbb88f05c19e5a7a3c242361e320afc31b2f4254a388452b38f1d15581dcc760fa7a345c90d13a42c745c4c37cbbda3369
+  metadata.gz: fe8997d3c57f9ed1d6cc23d198555c51d234dd856d0e3803879fb4a92809204fcb5d8b70e0a02421e902d9fd4d33e34e02e7e6ccd778caef203ce3aa7b6c6037
+  data.tar.gz: 91656de653ca7b90469dfbc3e6363259d3e9977693e649846d0bc4fd39e0585798f985334b1895790efbb9613f39ba35dce3193aecb59844d0f419d0da2c5bf0

data/CHANGELOG.md

@@ -6,6 +6,20 @@ The format is based on [Keep a Changelog](http://keepachangelog.com/en/1.0.0/) a
 
 ## [Unreleased]
 
+## [1.5.2] - 2021-02-03
+
+### Changed
+
+- kddeisz - Fix up `binary` node comparison operators so that it will handle either Symbol literals or the `@op` nodes which are incorrectly coming from JRuby (https://github.com/jruby/jruby/issues/6548).
+
+## [1.5.1] - 2021-01-27
+
+### Changed
+
+- [#799](https://github.com/prettier/plugin-ruby/issues/799) - jscheid, kddeisz - Multi-byte characters shouldn't give invalid source string bounds.
+- [#801](https://github.com/prettier/plugin-ruby/issues/801) - jscheid, kddeisz - When converting a conditional to the modifier form, make sure to add parentheses if there is a chained method call.
+- [#803](https://github.com/prettier/plugin-ruby/issues/803) - jscheid, kddeisz - Fix `formatWithCursor` support to match new parser format.
+
 ## [1.5.0] - 2021-01-21
 
 ### Added
@@ -191,7 +205,7 @@ end
 - kddeisz - Fix up a bug with constant aliases, e.g., `alias in IN`.
 - andyw8, kddeisz - Ensure `rescue` comments stay on the same line as their declaration.
 
-# [0.22.0] - 2020-12-08
+## [0.22.0] - 2020-12-08
 
 ### Changed
 
@@ -1063,7 +1077,10 @@ would previously result in `array[]`, but now prints properly.
 
 - Initial release 🎉
 
-[unreleased]: https://github.com/prettier/plugin-ruby/compare/v1.4.0...HEAD
+[unreleased]: https://github.com/prettier/plugin-ruby/compare/v1.5.2...HEAD
+[1.5.2]: https://github.com/prettier/plugin-ruby/compare/v1.5.1...v1.5.2
+[1.5.1]: https://github.com/prettier/plugin-ruby/compare/v1.5.0...v1.5.1
+[1.5.0]: https://github.com/prettier/plugin-ruby/compare/v1.4.0...v1.5.0
 [1.4.0]: https://github.com/prettier/plugin-ruby/compare/v1.3.0...v1.4.0
 [1.3.0]: https://github.com/prettier/plugin-ruby/compare/v1.2.5...v1.3.0
 [1.2.5]: https://github.com/prettier/plugin-ruby/compare/v1.2.4...v1.2.5

data/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@prettier/plugin-ruby",
-  "version": "1.5.0",
+  "version": "1.5.2",
   "description": "prettier plugin for the Ruby programming language",
   "main": "src/plugin.js",
   "scripts": {

data/src/parser/server.rb

@@ -1,6 +1,6 @@
 # frozen_string_literal: true
 
-require 'bundler/setup' if ENV['CI']
+require 'bundler/setup' if ENV['PLUGIN_RUBY_CI']
 require 'socket'
 require 'json'
 
@@ -14,7 +14,7 @@ $PROGRAM_NAME = 'prettier-ruby-parser'
 # Make sure we trap these signals to be sure we get the quit command coming from
 # the parent node process
 quit = false
-trap(:QUIT) { quit = true }
+trap(:QUIT) { quit = true } if RUBY_PLATFORM != 'java'
 trap(:INT) { quit = true }
 trap(:TERM) { quit = true }
 

data/src/ruby/embed.js

@@ -8,7 +8,7 @@ const {
   stripTrailingHardline
 } = require("../prettier");
 
-const { literalLineNoBreak } = require("../utils");
+const { literallineWithoutBreakParent } = require("../utils");
 
 const parsers = {
   css: "css",
@@ -30,7 +30,7 @@ function replaceNewlines(doc) {
       ? concat(
           currentDoc
             .split(/(\n)/g)
-            .map((v, i) => (i % 2 === 0 ? v : literalLineNoBreak))
+            .map((v, i) => (i % 2 === 0 ? v : literallineWithoutBreakParent))
         )
       : currentDoc
   );
@@ -106,7 +106,7 @@ function embed(path, print, textToDoc, _opts) {
 
   // Pass that content into the embedded parser. Get back the doc node.
   const formatted = concat([
-    literalLineNoBreak,
+    literallineWithoutBreakParent,
     replaceNewlines(stripTrailingHardline(textToDoc(content, { parser })))
   ]);
 
@@ -119,7 +119,7 @@ function embed(path, print, textToDoc, _opts) {
         group(
           concat([
             indent(markAsRoot(formatted)),
-            literalLineNoBreak,
+            literallineWithoutBreakParent,
             ending.trim()
           ])
         )
@@ -132,7 +132,9 @@ function embed(path, print, textToDoc, _opts) {
   return markAsRoot(
     concat([
       path.call(print, "beging"),
-      lineSuffix(group(concat([formatted, literalLineNoBreak, ending.trim()])))
+      lineSuffix(
+        group(concat([formatted, literallineWithoutBreakParent, ending.trim()]))
+      )
     ])
   );
 }

data/src/ruby/nodes/arrays.js

@@ -63,33 +63,30 @@ function isSymbolArray(args) {
 // 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 printSpecialArrayWord(path, opts, print) {
+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 printSpecialArrayParts(parts) {
+function printArrayLiteral(start, parts) {
   return group(
     concat([
-      parts[0],
+      start,
       "[",
-      indent(concat([softline, join(line, parts.slice(1))])),
+      indent(concat([softline, join(line, parts)])),
       concat([softline, "]"])
     ])
   );
 }
 
-// Generates a print function with an embedded special start character for the
-// specific type of array literal that we're dealing with. The print function
-// returns an array as it expects to eventually be handed off to
-// printSpecialArrayParts.
-function printSpecialArray(start) {
-  return function printSpecialArrayWithStart(path, opts, print) {
-    return [start].concat(path.map(print, "body"));
-  };
-}
+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
@@ -105,30 +102,40 @@ function printArray(path, opts, print) {
     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 (opts.rubyArrayLiteral && isStringArray(args)) {
-    const printString = (stringPath) => stringPath.call(print, "body", 0);
-    const parts = path.map(printString, "body", 0, "body");
+  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 printSpecialArrayParts(["%w"].concat(parts));
-  }
+      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 (opts.rubyArrayLiteral && isSymbolArray(args)) {
-    const printSymbol = (symbolPath) => symbolPath.call(print, "body", 0);
-    const parts = path.map(printSymbol, "body", 0, "body");
+    // 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 printSpecialArrayParts(["%i"].concat(parts));
+      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 printSpecialArrayParts function.
+  // send that over to the printArrayLiteral function.
   if (!["args", "args_add_star"].includes(args.type)) {
-    return printSpecialArrayParts(path.call(print, "body", 0));
+    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
@@ -151,9 +158,5 @@ function printArray(path, opts, print) {
 
 module.exports = {
   array: printArray,
-  qsymbols: printSpecialArray("%i"),
-  qwords: printSpecialArray("%w"),
-  symbols: printSpecialArray("%I"),
-  word: printSpecialArrayWord,
-  words: printSpecialArray("%W")
+  word: printArrayLiteralWord
 };

data/src/ruby/nodes/commands.js

@@ -73,7 +73,7 @@ function printCommand(path, opts, print) {
   } else if (hasDef(path.getValue())) {
     breakArgs = joinedArgs;
   } else {
-    breakArgs = align(command.length + 1, joinedArgs);
+    breakArgs = align(docLength(command) + 1, joinedArgs);
   }
 
   return group(

data/src/ruby/nodes/heredocs.js

@@ -1,5 +1,5 @@
 const { concat, group, lineSuffix, join } = require("../../prettier");
-const { literalLineNoBreak } = require("../../utils");
+const { literallineWithoutBreakParent } = require("../../utils");
 
 function printHeredoc(path, opts, print) {
   const { body, ending } = path.getValue();
@@ -11,7 +11,7 @@ function printHeredoc(path, opts, print) {
     }
 
     // In this case, the part of the string is just regular string content
-    return join(literalLineNoBreak, part.body.split("\n"));
+    return join(literallineWithoutBreakParent, part.body.split("\n"));
   });
 
   // We use a literalline break because matching indentation is required
@@ -23,7 +23,9 @@ function printHeredoc(path, opts, print) {
     concat([
       path.call(print, "beging"),
       lineSuffix(
-        group(concat([literalLineNoBreak].concat(parts).concat(ending)))
+        group(
+          concat([literallineWithoutBreakParent].concat(parts).concat(ending))
+        )
       )
     ])
   );

data/src/ruby/parser.rb

@@ -21,7 +21,40 @@ module Prettier
 end
 
 class Prettier::Parser < Ripper
-  attr_reader :source, :lines, :scanner_events, :line_counts
+  # Represents a line in the source. If this class is being used, it means that
+  # every character in the string is 1 byte in length, so we can just return the
+  # start of the line + the index.
+  class SingleByteString
+    def initialize(start)
+      @start = start
+    end
+
+    def [](byteindex)
+      @start + byteindex
+    end
+  end
+
+  # Represents a line in the source. If this class is being used, it means that
+  # there are characters in the string that are multi-byte, so we will build up
+  # an array of indices, such that array[byteindex] will be equal to the index
+  # of the character within the string.
+  class MultiByteString
+    def initialize(start, line)
+      @indices = []
+
+      line
+        .each_char
+        .with_index(start) do |char, index|
+          char.bytesize.times { @indices << index }
+        end
+    end
+
+    def [](byteindex)
+      @indices[byteindex]
+    end
+  end
+
+  attr_reader :source, :lines, :scanner_events
 
   # This is an attr_accessor so Stmts objects can grab comments out of this
   # array and attach them to themselves.
@@ -40,9 +73,23 @@ class Prettier::Parser < Ripper
     @heredocs = []
 
     @scanner_events = []
-    @line_counts = [0]
+    @line_counts = []
 
-    @source.lines.each { |line| @line_counts << @line_counts.last + line.size }
+    # Here we're going to build up a list of SingleByteString or MultiByteString
+    # objects. They're each going to represent a string in the source. They are
+    # used by the `char_pos` method to determine where we are in the source
+    # string.
+    last_index = 0
+
+    @source.lines.each do |line|
+      if line.size == line.bytesize
+        @line_counts << SingleByteString.new(last_index)
+      else
+        @line_counts << MultiByteString.new(last_index, line)
+      end
+
+      last_index += line.size
+    end
   end
 
   def self.parse(source)
@@ -60,7 +107,7 @@ class Prettier::Parser < Ripper
   # this line, then we add the number of columns into this line that we've gone
   # through.
   def char_pos
-    line_counts[lineno - 1] + column
+    @line_counts[lineno - 1][column]
   end
 
   # As we build up a list of scanner events, we'll periodically need to go
@@ -518,6 +565,12 @@ class Prettier::Parser < Ripper
   # binary is a parser event that represents a binary operation between two
   # values.
   def on_binary(left, oper, right)
+    # On most Ruby implementations, oper is a Symbol that represents that
+    # operation being performed. For instance in the example `1 < 2`, the `oper`
+    # object would be `:<`. However, on JRuby, it's an `@op` node, so here we're
+    # going to explicitly convert it into the same normalized form.
+    oper = scanner_events.delete(oper)[:body] unless oper.is_a?(Symbol)
+
     {
       type: :binary,
       body: [left, oper, right],

data/src/ruby/printer.js

@@ -38,7 +38,8 @@ const noComments = [
   "args_add_star",
   "mlhs",
   "mlhs_add_post",
-  "mlhs_add_star"
+  "mlhs_add_star",
+  "mlhs_paren"
 ];
 
 // Certain nodes are used more for organizational purposed than for actually
@@ -97,8 +98,12 @@ function getCommentChildNodes(node) {
 
       return parts;
     }
-    default:
-      return node.body;
+    default: {
+      if (Array.isArray(node.body)) {
+        return node.body.filter((child) => child && typeof child === "object");
+      }
+      return [];
+    }
   }
 }
 

data/src/utils.js

@@ -5,7 +5,7 @@ module.exports = {
   isEmptyStmts: require("./utils/isEmptyStmts"),
   hasAncestor: require("./utils/hasAncestor"),
   literal: require("./utils/literal"),
-  literalLineNoBreak: require("./utils/literalLineNoBreak"),
+  literallineWithoutBreakParent: require("./utils/literallineWithoutBreakParent"),
   makeCall: require("./utils/makeCall"),
   noIndent: require("./utils/noIndent"),
   printEmptyCollection: require("./utils/printEmptyCollection"),

data/src/utils/inlineEnsureParens.js

@@ -1,4 +1,11 @@
-const needsParens = ["args", "assign", "assoc_new", "massign", "opassign"];
+const needsParens = [
+  "args",
+  "assign",
+  "assoc_new",
+  "call",
+  "massign",
+  "opassign"
+];
 
 // If you have a modifier statement (for instance an inline if statement or an
 // inline while loop) there are times when you need to wrap the entire statement

data/src/utils/literallineWithoutBreakParent.js

@@ -0,0 +1,7 @@
+const literallineWithoutBreakParent = {
+  type: "line",
+  hard: true,
+  literal: true
+};
+
+module.exports = literallineWithoutBreakParent;

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: prettier
 version: !ruby/object:Gem::Version
-  version: 1.5.0
+  version: 1.5.2
 platform: ruby
 authors:
 - Kevin Deisz
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2021-01-22 00:00:00.000000000 Z
+date: 2021-02-03 00:00:00.000000000 Z
 dependencies: []
 description:
 email:
@@ -100,7 +100,7 @@ files:
 - src/utils/isEmptyBodyStmt.js
 - src/utils/isEmptyStmts.js
 - src/utils/literal.js
-- src/utils/literalLineNoBreak.js
+- src/utils/literallineWithoutBreakParent.js
 - src/utils/makeCall.js
 - src/utils/noIndent.js
 - src/utils/printEmptyCollection.js

data/src/utils/literalLineNoBreak.js

@@ -1,7 +0,0 @@
-const literalLineNoBreak = {
-  type: "line",
-  hard: true,
-  literal: true
-};
-
-module.exports = literalLineNoBreak;