prettier 0.14.0 → 0.15.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: b8e2166de3bdb098137b5445e9db41d9c6eb1f1677fe8edfd9bbb7fb25704091
-  data.tar.gz: 8284b60434648ad65daae6a2d24677ec197cde21b986e69e88adcbc0560592bf
+  metadata.gz: 4601f1c4bcd732027d5e7077aeece6ce80485b33f6d6122149903a3b768bae01
+  data.tar.gz: 7b8934c54be0b0125b25325d45a82d801314c9a4f6074033f9e719db8e873ffc
 SHA512:
-  metadata.gz: 9d94d15c6f8c4b295596bfd821884937954ebc854cc6d2c292a8ea77a8ba23d99bf3c80cda43bcd8c5fb60b72e334b7f90ae18729b884c8c2a7eab6b44bda0d3
-  data.tar.gz: 563ab1b61b66e0ade505742063c9c949c16087942d68853eb07ec9ee4b4d56ec69219355ab80a230028efa44af1c9012a30c1556743f19025ffe625c8f2affbd
+  metadata.gz: 5b9adb4c97a45dd1323cd36af7e8fbd6b542a5bb15f9c5c5824155ee09ea2c6cd2d4b0e27eedcfb4c3d79b1045fa7454cfba3ead575262a1740352a74f47798d
+  data.tar.gz: 3e6bd216100a983f702ca001c1f2578609361fe11e7e7a3ffa70da6b8a0db988d23afd3d7ba5328dfea8f0b1fe5d124bd9767f498708c931aef27e6f05994c40

data/CHANGELOG.md

@@ -6,6 +6,88 @@ The format is based on [Keep a Changelog](http://keepachangelog.com/en/1.0.0/) a
 
 ## [Unreleased]
 
+## [0.15.0] - 2019-08-06
+
+### Changed
+
+- If xstring literals (command line calls surrounded by backticks) break, then we indent and place the command on a new line. Previously, this was resulting in new lines getting added each time the code was formatted. Now this happens correctly. (Thanks to @dudeofawesome for the report.)
+- When a `while` or `until` loop modifies a `begin...end` statement, it must remain in the modifier form or else it changes sematic meaning. For example,
+
+<!-- prettier-ignore -->
+```ruby
+begin
+  foo
+end while bar
+```
+
+cannot be transformed into:
+
+<!-- prettier-ignore -->
+```ruby
+while bar
+  foo
+end
+```
+
+because that would never execute `foo` if `bar` is falsy, whereas in the initial example it would have. (Thanks to @krachtstefan for the report.)
+
+- When transforming a block into the `Symbol#to_proc` syntax from within a list of arguments inside of an `aref` node (i.e., `foo[:bar].each`), we can't put the block syntax inside the brackets. (Thanks to @jviney for the report.)
+- Values for the `return` keyword that broke the line were previously just printed as they were, which breaks if you have a block expression like an `if` or `while`. For example,
+
+<!-- prettier-ignore -->
+```ruby
+return foo ? bar : baz
+```
+
+if the line was set to very short would be printed as:
+
+<!-- prettier-ignore -->
+```ruby
+return if foo
+  bar
+else
+  baz
+end
+```
+
+which wouldn't work. Instead, they now get printed with parentheses around the value, as in:
+
+<!-- prettier-ignore -->
+```ruby
+return(
+  if foo
+    bar
+  else
+    baz
+  end
+)
+```
+
+(Thanks to @jakeprime for the report.)
+
+- When switching from a double-quoted string to a single-quoted string that contained escaped double quotes, the backslashes would stay in the string. As in:
+
+<!-- prettier-ignore -->
+```ruby
+"Foo \"Bar\" Baz"
+```
+
+would get formatted as:
+
+<!-- prettier-ignore -->
+```ruby
+'Foo \"Bar\" Baz'
+```
+
+but now gets formatted as:
+
+<!-- prettier-ignore -->
+```ruby
+'Foo "Bar" Baz'
+```
+
+(Thanks to @jakeprime for the report.)
+
 ## [0.14.0] - 2019-07-17
 
 ### Added
@@ -463,7 +545,8 @@ would previously result in `array[]`, but now prints properly. (Thanks to @xipgr
 
 - Initial release 🎉
 
-[unreleased]: https://github.com/prettier/plugin-ruby/compare/v0.14.0...HEAD
+[unreleased]: https://github.com/prettier/plugin-ruby/compare/v0.15.0...HEAD
+[0.15.0]: https://github.com/prettier/plugin-ruby/compare/v0.14.0...v0.15.0
 [0.14.0]: https://github.com/prettier/plugin-ruby/compare/v0.13.0...v0.14.0
 [0.13.0]: https://github.com/prettier/plugin-ruby/compare/v0.12.3...v0.13.0
 [0.12.3]: https://github.com/prettier/plugin-ruby/compare/v0.12.2...v0.12.3

data/README.md

@@ -159,7 +159,8 @@ The package is available as open source under the terms of the [MIT License](htt
 Thanks goes to these wonderful people ([emoji key](https://allcontributors.org/docs/en/emoji-key)):
 
 <!-- ALL-CONTRIBUTORS-LIST:START - Do not remove or modify this section -->
-<!-- prettier-ignore -->
+<!-- prettier-ignore-start -->
+<!-- markdownlint-disable -->
 <table>
   <tr>
     <td align="center"><a href="https://kevindeisz.com"><img src="https://avatars2.githubusercontent.com/u/5093358?v=4" width="100px;" alt="Kevin Deisz"/><br /><sub><b>Kevin Deisz</b></sub></a><br /><a href="https://github.com/prettier/plugin-ruby/commits?author=kddeisz" title="Code">💻</a> <a href="https://github.com/prettier/plugin-ruby/commits?author=kddeisz" title="Documentation">📖</a> <a href="https://github.com/prettier/plugin-ruby/commits?author=kddeisz" title="Tests">⚠️</a> <a href="https://github.com/prettier/plugin-ruby/issues?q=author%3Akddeisz" title="Bug reports">🐛</a></td>
@@ -184,9 +185,18 @@ Thanks goes to these wonderful people ([emoji key](https://allcontributors.org/d
     <td align="center"><a href="https://www.andywaite.com"><img src="https://avatars1.githubusercontent.com/u/13400?v=4" width="100px;" alt="Andy Waite"/><br /><sub><b>Andy Waite</b></sub></a><br /><a href="https://github.com/prettier/plugin-ruby/commits?author=andyw8" title="Documentation">📖</a></td>
     <td align="center"><a href="https://github.com/jviney"><img src="https://avatars3.githubusercontent.com/u/7051?v=4" width="100px;" alt="Jonathan Viney"/><br /><sub><b>Jonathan Viney</b></sub></a><br /><a href="https://github.com/prettier/plugin-ruby/issues?q=author%3Ajviney" title="Bug reports">🐛</a></td>
     <td align="center"><a href="https://github.com/acrewdson"><img src="https://avatars0.githubusercontent.com/u/10353074?v=4" width="100px;" alt="acrewdson"/><br /><sub><b>acrewdson</b></sub></a><br /><a href="https://github.com/prettier/plugin-ruby/issues?q=author%3Aacrewdson" title="Bug reports">🐛</a></td>
+    <td align="center"><a href="https://orleans.io"><img src="https://avatars0.githubusercontent.com/u/1683595?v=4" width="100px;" alt="Louis Orleans"/><br /><sub><b>Louis Orleans</b></sub></a><br /><a href="https://github.com/prettier/plugin-ruby/issues?q=author%3Adudeofawesome" title="Bug reports">🐛</a></td>
+    <td align="center"><a href="https://github.com/cvoege"><img src="https://avatars2.githubusercontent.com/u/6777709?v=4" width="100px;" alt="Colton Voege"/><br /><sub><b>Colton Voege</b></sub></a><br /><a href="https://github.com/prettier/plugin-ruby/issues?q=author%3Acvoege" title="Bug reports">🐛</a></td>
+    <td align="center"><a href="https://stefankracht.de"><img src="https://avatars1.githubusercontent.com/u/529711?v=4" width="100px;" alt="Stefan Kracht"/><br /><sub><b>Stefan Kracht</b></sub></a><br /><a href="https://github.com/prettier/plugin-ruby/issues?q=author%3Akrachtstefan" title="Bug reports">🐛</a></td>
+  </tr>
+  <tr>
+    <td align="center"><a href="https://github.com/jakeprime"><img src="https://avatars1.githubusercontent.com/u/1019036?v=4" width="100px;" alt="jakeprime"/><br /><sub><b>jakeprime</b></sub></a><br /><a href="https://github.com/prettier/plugin-ruby/issues?q=author%3Ajakeprime" title="Bug reports">🐛</a></td>
   </tr>
 </table>
 
+<!-- markdownlint-enable -->
+<!-- prettier-ignore-end -->
+
 <!-- ALL-CONTRIBUTORS-LIST:END -->
 
 This project follows the [all-contributors](https://github.com/all-contributors/all-contributors) specification. Contributions of any kind welcome!

data/package.json

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

data/src/nodes/args.js

@@ -51,17 +51,30 @@ module.exports = {
     const args = path.map(print, "body");
     let blockNode = null;
 
+    // Look up the chain to see if these arguments are contained within a
+    // method_add_block node, and if they are that that node has a block
+    // associated with it. If it does, we're going to attempt to transform it
+    // into the to_proc shorthand and add it to the list of arguments.
     [1, 2, 3].find(parent => {
       const parentNode = path.getParentNode(parent);
       blockNode =
         parentNode &&
         parentNode.type === "method_add_block" &&
         parentNode.body[1];
+
       return blockNode;
     });
 
     const proc = blockNode && toProc(blockNode);
-    if (proc) {
+
+    // If we have a successful to_proc transformation, but we're part of an aref
+    // node, that means it's something to the effect of
+    //
+    //     foo[:bar].each(&:to_s)
+    //
+    // In this case we need to just return regular arguments, otherwise we would
+    // end up putting &:to_s inside the brackets accidentally.
+    if (proc && path.getParentNode(1).type !== "aref") {
       args.push(proc);
     }
 

data/src/nodes/calls.js

@@ -53,9 +53,11 @@ module.exports = {
         ])
       );
     }
+
     if (proc) {
       return path.call(print, "body", 0);
     }
+
     return concat(path.map(print, "body"));
   },
   vcall: first

data/src/nodes/flow.js

@@ -1,4 +1,11 @@
-const { concat, join } = require("../prettier");
+const {
+  concat,
+  group,
+  ifBreak,
+  indent,
+  join,
+  softline
+} = require("../prettier");
 const { literal } = require("../utils");
 
 module.exports = {
@@ -42,15 +49,23 @@ module.exports = {
       return "return";
     }
 
+    let value = join(", ", path.call(print, "body", 0));
+
+    // If the body of the return contains parens, then just skip directly to the
+    // content of the parens so that we can skip printing parens if we don't
+    // want them.
     if (args.body[0] && args.body[0].type === "paren") {
-      // Ignoring the parens node and just going straight to the content
-      return concat([
-        "return ",
-        path.call(print, "body", 0, "body", 0, "body", 0, "body", 0)
-      ]);
+      value = path.call(print, "body", 0, "body", 0, "body", 0, "body", 0);
     }
 
-    return concat(["return ", join(", ", path.call(print, "body", 0))]);
+    return group(
+      concat([
+        "return",
+        ifBreak("(", " "),
+        indent(concat([softline, value])),
+        concat([softline, ifBreak(")", "")])
+      ])
+    );
   },
   return0: literal("return"),
   yield: (path, opts, print) => {

data/src/nodes/loops.js

@@ -1,5 +1,4 @@
 const {
-  breakParent,
   concat,
   group,
   hardline,
@@ -8,23 +7,45 @@ const {
   softline
 } = require("../prettier");
 
-const printLoop = keyword => (path, { inlineLoops }, print) =>
-  group(
-    ifBreak(
-      concat([
-        concat([`${keyword} `, path.call(print, "body", 0)]),
-        indent(concat([softline, path.call(print, "body", 1)])),
-        concat([softline, "end"])
-      ]),
-      concat([
-        inlineLoops ? "" : breakParent,
-        path.call(print, "body", 1),
-        ` ${keyword} `,
-        path.call(print, "body", 0)
-      ])
-    )
-  );
+const printLoop = (keyword, modifier) => (path, { inlineLoops }, print) => {
+  const inlineLoop = concat([
+    path.call(print, "body", 1),
+    ` ${keyword} `,
+    path.call(print, "body", 0)
+  ]);
+
+  // If we're in the modifier form and we're modifying a `begin`, then this is a
+  // special case where we need to explicitly use the modifier form because
+  // otherwise the semantic meaning changes. This looks like:
+  //
+  //     begin
+  //       foo
+  //     end while bar
+  //
+  // The above is effectively a `do...while` loop (which we don't have in ruby).
+  if (modifier && path.getValue().body[1].type === "begin") {
+    return inlineLoop;
+  }
+
+  const blockLoop = concat([
+    concat([`${keyword} `, path.call(print, "body", 0)]),
+    indent(concat([softline, path.call(print, "body", 1)])),
+    concat([softline, "end"])
+  ]);
+
+  if (!inlineLoops) {
+    return blockLoop;
+  }
+
+  return group(ifBreak(blockLoop, inlineLoop));
+};
 
+// Technically this is incorrect. A `for` loop actually introduces and modifies
+// a local variable that then remains in the outer scope. Additionally, if the
+// `each` method was somehow missing from the enumerable (it's possible...),
+// then this transformation would fail. However - I've never actually seen a
+// `for` loop used in production. If someone actually calls me on it, I'll fix
+// this, but for now I'm leaving it.
 const printFor = (path, opts, print) =>
   group(
     concat([
@@ -38,9 +59,9 @@ const printFor = (path, opts, print) =>
   );
 
 module.exports = {
-  while: printLoop("while"),
-  while_mod: printLoop("while"),
-  until: printLoop("until"),
-  until_mod: printLoop("until"),
+  while: printLoop("while", false),
+  while_mod: printLoop("while", true),
+  until: printLoop("until", false),
+  until_mod: printLoop("until", true),
   for: printFor
 };

data/src/nodes/strings.js

@@ -40,7 +40,7 @@ const getStringQuote = (string, preferSingleQuotes) => {
 const quotePattern = new RegExp("\\\\([\\s\\S])|(['\"])", "g");
 
 const makeString = (content, enclosingQuote) => {
-  const otherQuote = enclosingQuote === '"' ? "'" : enclosingQuote;
+  const otherQuote = enclosingQuote === '"' ? "'" : '"';
 
   // Escape and unescape single and double quotes as needed to be able to
   // enclose `content` with `enclosingQuote`.
@@ -139,12 +139,24 @@ module.exports = {
   word_add: concatBody,
   word_new: empty,
   xstring: makeList,
-  xstring_literal: (path, opts, print) =>
-    group(
+  xstring_literal: (path, opts, print) => {
+    const parts = path.call(print, "body", 0);
+
+    if (typeof parts[0] === "string") {
+      parts[0] = parts[0].replace(/^\s+/, "");
+    }
+
+    const lastIndex = parts.length - 1;
+    if (typeof parts[lastIndex] === "string") {
+      parts[lastIndex] = parts[lastIndex].replace(/\s+$/, "");
+    }
+
+    return group(
       concat([
         "`",
-        indent(concat([softline, join(softline, path.call(print, "body", 0))])),
+        indent(concat([softline, join(softline, parts)])),
         concat([softline, "`"])
       ])
-    )
+    );
+  }
 };

data/src/ripper.rb

@@ -2,8 +2,12 @@
 
 REQUIRED_VERSION = Gem::Version.new('2.5')
 if Gem::Version.new(RUBY_VERSION) < REQUIRED_VERSION
-  raise "Ruby version #{RUBY_VERSION} not supported. " \
-          "Please upgrade to #{REQUIRED_VERSION} or above."
+  warn(
+    "Ruby version #{RUBY_VERSION} not supported. " \
+      "Please upgrade to #{REQUIRED_VERSION} or above."
+  )
+
+  exit 1
 end
 
 require 'json' unless defined?(JSON)
@@ -757,8 +761,13 @@ if $0 == __FILE__
   builder = RipperJS.new($stdin.read)
   response = builder.parse
 
-  if !response && builder.error?
-    STDERR.puts 'Invalid ruby'
+  if !response || builder.error?
+    warn(
+      '@prettier/plugin-ruby encountered an error when attempting to parse ' \
+        'the ruby source. This usually means there was a syntax error in the ' \
+        'file in question. You can verify by running `ruby -i [path/to/file]`.'
+    )
+
     exit 1
   end
 

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: prettier
 version: !ruby/object:Gem::Version
-  version: 0.14.0
+  version: 0.15.0
 platform: ruby
 authors:
 - Kevin Deisz
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2019-07-17 00:00:00.000000000 Z
+date: 2019-08-06 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler