prettier 0.17.0 → 0.19.1

data/src/parse.js

@@ -1,11 +1,31 @@
 const { spawnSync } = require("child_process");
 const path = require("path");
 
+// In order to properly parse ruby code, we need to tell the ruby process to
+// parse using UTF-8. Unfortunately, the way that you accomplish this looks
+// differently depending on your platform. This object below represents all of
+// the possible values of process.platform per:
+//   https://nodejs.org/api/process.html#process_process_platform
+const LANG = {
+  aix: "C.UTF-8",
+  darwin: "en_US.UTF-8",
+  freebsd: "C.UTF-8",
+  linux: "C.UTF-8",
+  openbsd: "C.UTF-8",
+  sunos: "C.UTF-8",
+  win32: ".UTF-8"
+}[process.platform];
+
 module.exports = (text, _parsers, _opts) => {
-  const child = spawnSync("ruby", [path.join(__dirname, "./ripper.rb")], {
-    input: text,
-    maxBuffer: 10 * 1024 * 1024 // 10MB
-  });
+  const child = spawnSync(
+    "ruby",
+    ["--disable-gems", path.join(__dirname, "./ripper.rb")],
+    {
+      env: { LANG },
+      input: text,
+      maxBuffer: 10 * 1024 * 1024 // 10MB
+    }
+  );
 
   const error = child.stderr.toString();
   if (error) {

data/src/prettier.js

@@ -3,7 +3,6 @@
 // directly, as it's been shipped with the gem.
 const source = process.env.RBPRETTIER ? "../node_modules/prettier" : "prettier";
 
-// eslint-disable-next-line import/no-dynamic-require
 const prettier = require(source);
 
 // Just combine all the things into one big object so that we can import

data/src/ripper.rb

@@ -1,10 +1,13 @@
 #!/usr/bin/env ruby
 
-REQUIRED_VERSION = Gem::Version.new('2.5')
-if Gem::Version.new(RUBY_VERSION) < REQUIRED_VERSION
+# We implement our own version checking here instead of using Gem::Version so
+# that we can use the --disable-gems flag.
+major, minor, * = RUBY_VERSION.split('.').map(&:to_i)
+
+if (major < 2) || ((major == 2) && (minor < 5))
   warn(
     "Ruby version #{RUBY_VERSION} not supported. " \
-      "Please upgrade to #{REQUIRED_VERSION} or above."
+      'Please upgrade to 2.5.0 or above.'
   )
 
   exit 1
@@ -166,6 +169,7 @@ class RipperJS < Ripper
         assoc_splat: [:@op, '**'],
         arg_paren: :@lparen,
         args_add_star: [:@op, '*'],
+        args_forward: [:@op, '...'],
         begin: [:@kw, 'begin'],
         blockarg: [:@op, '&'],
         brace_block: :@lbrace,
@@ -290,7 +294,8 @@ class RipperJS < Ripper
           super(*body).merge!(
             start: node[:start],
             char_start: node[:char_start],
-            char_end: char_pos
+            char_end: char_pos,
+            quote: node[:body]
           )
         end
       end
@@ -319,14 +324,28 @@ class RipperJS < Ripper
       # child node.
       %i[dyna_symbol symbol_literal].each do |event|
         define_method(:"on_#{event}") do |*body|
-          char_start =
+          options =
             if scanner_events.any? { |sevent| sevent[:type] == :@symbeg }
-              find_scanner_event(:@symbeg)[:char_start]
+              symbeg = find_scanner_event(:@symbeg)
+
+              {
+                char_start: symbeg[:char_start],
+                char_end: char_pos,
+                quote: symbeg[:body][1]
+              }
+            elsif scanner_events.any? { |sevent| sevent[:type] == :@label_end }
+              label_end = find_scanner_event(:@label_end)
+
+              {
+                char_start: char_start_for(body),
+                char_end: char_pos,
+                quote: label_end[:body][0]
+              }
             else
-              char_start_for(body)
+              { char_start: char_start_for(body), char_end: char_pos }
             end
 
-          super(*body).merge!(char_start: char_start, char_end: char_pos)
+          super(*body).merge!(options)
         end
       end
 
@@ -630,6 +649,8 @@ class RipperJS < Ripper
     end
   )
 
+  # This module contains miscellaneous fixes required to get the right
+  # structure.
   prepend(
     Module.new do
       private
@@ -660,18 +681,6 @@ class RipperJS < Ripper
         super(*body).tap { |node| node[:body][0][:body] << __end__ if __end__ }
       end
 
-      # Adds the used quote type onto string nodes. This is necessary because
-      # we're going to have to stick to whatever quote the user chose if there
-      # are escape sequences within the string. For example, if you have '\n'
-      # we can't switch to double quotes without changing what it means.
-      def on_tstring_end(quote)
-        last_sexp.merge!(quote: quote)
-      end
-
-      def on_label_end(quote)
-        last_sexp.merge!(quote: quote[0]) # quote is ": or ':
-      end
-
       # Normally access controls are reported as vcall nodes. This creates a
       # new node type to explicitly track those nodes instead, so that the
       # printer can add new lines as necessary.

data/src/ruby.js

@@ -4,10 +4,10 @@ const print = require("./print");
 const haml = require("./haml");
 
 const pragmaPattern = /#\s*@(prettier|format)/;
-const hasPragma = text => pragmaPattern.test(text);
+const hasPragma = (text) => pragmaPattern.test(text);
 
-const locStart = node => node.char_start;
-const locEnd = node => node.char_end;
+const locStart = (node) => node.char_start;
+const locEnd = (node) => node.char_end;
 
 /*
  * metadata mostly pulled from linguist and rubocop:
@@ -49,6 +49,7 @@ module.exports = {
       filenames: [
         ".irbrc",
         ".pryrc",
+        ".simplecov",
         "Appraisals",
         "Berksfile",
         "Brewfile",
@@ -78,7 +79,8 @@ module.exports = {
     {
       name: "HAML",
       parsers: ["haml"],
-      extensions: [".haml"]
+      extensions: [".haml"],
+      vscodeLanguageIds: ["haml"]
     }
   ],
   parsers: {
@@ -141,6 +143,13 @@ module.exports = {
       default: true,
       description:
         "When double quotes are not necessary for interpolation, prefers the use of single quotes for string literals."
+    },
+    toProcTransform: {
+      type: "boolean",
+      category: "Global",
+      default: true,
+      description:
+        "When possible, convert blocks to the more concise Symbol#to_proc syntax."
     }
   },
   defaultOptions: {

data/src/toProc.js

@@ -1,4 +1,4 @@
-const isCall = node => ["::", "."].includes(node) || node.type === "@period";
+const isCall = (node) => ["::", "."].includes(node) || node.type === "@period";
 
 // If you have a simple block that only calls a method on the single required
 // parameter that is passed to it, then you can replace that block with the
@@ -11,8 +11,8 @@ const isCall = node => ["::", "."].includes(node) || node.type === "@period";
 //     [1, 2, 3].map(&:to_s)
 //
 // This works with `do` blocks as well.
-const toProc = node => {
-  if (!node) {
+const toProc = (path, opts, node) => {
+  if (!node || !opts.toProcTransform) {
     return null;
   }
 
@@ -76,6 +76,33 @@ const toProc = node => {
     return null;
   }
 
+  // Ensure that we're not inside of a hash that is being passed to a key that
+  // corresponds to `:if` or `:unless` to avoid problems with callbacks with
+  // Rails. For more context, see:
+  // https://github.com/prettier/plugin-ruby/issues/449
+  let assocNode = null;
+
+  if (path.getValue().type === "method_add_block") {
+    assocNode = path.getParentNode();
+  } else if (path.getValue().type === "args") {
+    assocNode = path.getParentNode(2);
+  }
+
+  if (assocNode && assocNode.type === "assoc_new") {
+    const [key] = assocNode.body;
+
+    if (key.type === "@label" && ["if:", "unless:"].includes(key.body)) {
+      return null;
+    }
+
+    if (
+      key.type === "symbol_literal" &&
+      ["if", "unless"].includes(key.body[0].body[0].body)
+    ) {
+      return null;
+    }
+  }
+
   return `&:${method.body}`;
 };
 

data/src/utils.js

@@ -10,11 +10,11 @@ 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 =>
+const containsAssignment = (node) =>
   ["assign", "massign"].includes(node.type) ||
   (node.type === "paren" && node.body[0].body.some(containsAssignment));
 
-const docLength = doc => {
+const docLength = (doc) => {
   if (doc.length) {
     return doc.length;
   }
@@ -50,7 +50,7 @@ const hasAncestor = (path, types) => {
   return false;
 };
 
-const literal = value => () => value;
+const literal = (value) => () => value;
 
 const makeArgs = (path, opts, print, argsIndex) => {
   let argNodes = path.getValue().body[argsIndex];
@@ -103,13 +103,13 @@ const makeCall = (path, opts, print) => {
 
 const makeList = (path, opts, print) => path.map(print, "body");
 
-const prefix = value => (path, opts, print) =>
+const prefix = (value) => (path, opts, print) =>
   concat([value, path.call(print, "body", 0)]);
 
 const printComments = (printed, start, comments) => {
   let node = printed;
 
-  comments.forEach(comment => {
+  comments.forEach((comment) => {
     if (comment.start < start) {
       node = concat([
         comment.break ? breakParent : "",
@@ -129,7 +129,7 @@ const printComments = (printed, start, comments) => {
   return node;
 };
 
-const skipAssignIndent = node =>
+const skipAssignIndent = (node) =>
   ["array", "hash", "heredoc", "lambda", "regexp_literal"].includes(
     node.type
   ) ||

metadata

@@ -1,29 +1,29 @@
 --- !ruby/object:Gem::Specification
 name: prettier
 version: !ruby/object:Gem::Version
-  version: 0.17.0
+  version: 0.19.1
 platform: ruby
 authors:
 - Kevin Deisz
-autorequire: 
+autorequire:
 bindir: exe
 cert_chain: []
-date: 2019-12-12 00:00:00.000000000 Z
+date: 2020-08-21 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '2.0'
+        version: '0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '2.0'
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: minitest
   requirement: !ruby/object:Gem::Requirement
@@ -52,8 +52,8 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '13.0'
-description: 
-email: 
+description:
+email:
 executables:
 - rbprettier
 extensions: []
@@ -72,7 +72,6 @@ files:
 - node_modules/prettier/index.js
 - node_modules/prettier/third-party.js
 - package.json
-- src/escapePattern.js
 - src/haml.js
 - src/haml/embed.js
 - src/haml/nodes/comment.js
@@ -124,7 +123,7 @@ homepage: https://github.com/prettier/plugin-ruby#readme
 licenses:
 - MIT
 metadata: {}
-post_install_message: 
+post_install_message:
 rdoc_options: []
 require_paths:
 - lib
@@ -139,8 +138,8 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.0.6
-signing_key: 
+rubygems_version: 3.0.3
+signing_key:
 specification_version: 4
 summary: prettier plugin for the Ruby programming language
 test_files: []

data/src/escapePattern.js

@@ -1,45 +0,0 @@
-/**
- * String literal syntax documentation from Ruby source (2.7.0-dev)
- *
- * Double-quote strings allow escaped characters such as <tt>\n</tt> for
- * newline, <tt>\t</tt> for tab, etc.  The full list of supported escape
- * sequences are as follows:
- *
- *   \a             bell, ASCII 07h (BEL)
- *   \b             backspace, ASCII 08h (BS)
- *   \t             horizontal tab, ASCII 09h (TAB)
- *   \n             newline (line feed), ASCII 0Ah (LF)
- *   \v             vertical tab, ASCII 0Bh (VT)
- *   \f             form feed, ASCII 0Ch (FF)
- *   \r             carriage return, ASCII 0Dh (CR)
- *   \e             escape, ASCII 1Bh (ESC)
- *   \s             space, ASCII 20h (SPC)
- *   \\             backslash, \
- *   \nnn           octal bit pattern, where nnn is 1-3 octal digits ([0-7])
- *   \xnn           hexadecimal bit pattern, where nn is 1-2 hexadecimal digits ([0-9a-fA-F])
- *   \unnnn         Unicode character, where nnnn is exactly 4 hexadecimal digits ([0-9a-fA-F])
- *   \u{nnnn ...}   Unicode character(s), where each nnnn is 1-6 hexadecimal digits ([0-9a-fA-F])
- *   \cx or \C-x    control character, where x is an ASCII printable character
- *   \M-x           meta character, where x is an ASCII printable character
- *   \M-\C-x        meta control character, where x is an ASCII printable character
- *   \M-\cx         same as above
- *   \c\M-x         same as above
- *   \c? or \C-?    delete, ASCII 7Fh (DEL)
- *
- * In addition to disabling interpolation, single-quoted strings also disable all
- * escape sequences except for the single-quote (<tt>\'</tt>) and backslash
- * (<tt>\\\\</tt>).
- */
-const patterns = [
-  "[abtnvfres\\\\]", // simple
-  "[0-7]{1,3}", // octal bits
-  "x[0-9a-fA-F]{1,2}", // hex bit
-  "u[0-9a-fA-F]{4}", // unicode char
-  "u\\{[0-9a-fA-F ]+\\}", // unicode chars
-  "c[ -~]|C\\-[ -~]", // control
-  "M\\-[ -~]", // meta
-  "M\\-\\\\C\\-[ -~]|M\\-\\\\c[ -~]|c\\\\M\\-[ -~]", // meta control
-  "c\\?|C\\-\\?" // delete
-];
-
-module.exports = new RegExp(`\\\\(${patterns.join("|")})`);