syntax_tree 2.1.0 → 2.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 46b573afdda378e664e11b1f5acab2c89ce0fdd2c8b3d4c6400d74e133aaffc3
-  data.tar.gz: 6be0570ce471fe3f34c53730d7095d9b81be5b7e3e2e84ac5724ba95d7ac7362
+  metadata.gz: 5db5f5652e0786475f56ea361b693340998d3f1505d57e2300182d2cc811bcf3
+  data.tar.gz: 3ee5db660541f5355e80fe7d63c4995e30c5089b45286ab1e7ac29ccc62c8bab
 SHA512:
-  metadata.gz: 36236536a1dda5e6e2907b82c383b74f207f5e2b64f282490cf26161d62d748d1cdf51b68c393cd60f1777d2c5434c294ad2e243f2575faae34c42ac44155f76
-  data.tar.gz: 5c2e0ee682e5847287cee5a6ca4357c51e4172bacf7aa98b780e427fb7d0912b6bd829bbf6236baa294a919be9be5730d8c7e74b27a0ca630a29a91c37540324
+  metadata.gz: 9be4902085676d0c4c76eaa29c5b00878916409f2b63a519376ab1a9521cf6204c7aa0a540e61cfa607079ebe17ef42c960c63ab752da300fbdf653be279e4e8
+  data.tar.gz: b2923a9ed6e61e3e14b353b200e49ffe39556081a25fb409cf3af4bd8de4e14aa6229c44c20bb76e67b0efbf63b463cdb0a307ff43975ca5a08a362e6af8aac6

data/CHANGELOG.md

@@ -6,6 +6,50 @@ The format is based on [Keep a Changelog](http://keepachangelog.com/en/1.0.0/) a
 
 ## [Unreleased]
 
+## [2.3.0] - 2022-04-22
+
+### Added
+
+- [#52](https://github.com/ruby-syntax-tree/syntax_tree/pull/52) - `SyntaxTree::Formatter.format` for formatting an already parsed node.
+- [#56](https://github.com/ruby-syntax-tree/syntax_tree/pull/56) - `if` and `unless` can now be transformed into ternaries if they're simple enough.
+- [#56](https://github.com/ruby-syntax-tree/syntax_tree/pull/56) - Nicely format call chains by one indentation.
+- [#56](https://github.com/ruby-syntax-tree/syntax_tree/pull/56) - Handle trailing operators in call chains when they are necessary because of comments.
+- [#56](https://github.com/ruby-syntax-tree/syntax_tree/pull/56) - Add some specialized formatting for Sorbet `sig` blocks to make them appear nicer.
+
+### Changed
+
+- [#53](https://github.com/ruby-syntax-tree/syntax_tree/pull/53) - Optional keyword arguments on method declarations have a value of `nil` now instead of `false`. This makes it easier to use the visitor.
+- [#54](https://github.com/ruby-syntax-tree/syntax_tree/pull/54) - Flow control operators can now skip parentheses for simple, individual arguments. e.g., `break(1)` becomes `break 1`.
+- [#54](https://github.com/ruby-syntax-tree/syntax_tree/pull/54) - Don't allow modifier conditionals to modify ternaries.
+- [#55](https://github.com/ruby-syntax-tree/syntax_tree/pull/55) - Skip parentheses and brackets on arrays for flow control operators. e.g., `break([1, 2, 3])` becomes `break 1, 2, 3`.
+- [#56](https://github.com/ruby-syntax-tree/syntax_tree/pull/56) - Don't add parentheses to method calls if you don't need them.
+- [#56](https://github.com/ruby-syntax-tree/syntax_tree/pull/56) - Format comments on empty parameter sets. e.g., `def foo # bar` should keeps its comment.
+- [#56](https://github.com/ruby-syntax-tree/syntax_tree/pull/56) - `%s[]` symbols on assignments should not indent to the next line.
+- [#56](https://github.com/ruby-syntax-tree/syntax_tree/pull/56) - Empty hash and array literals with comments inside of them should be formatted correctly.
+
+## [2.2.0] - 2022-04-19
+
+### Added
+
+- [#51](https://github.com/ruby-syntax-tree/syntax_tree/pull/51) - `SyntaxTree::Location` nodes now have pattern matching.
+- [#51](https://github.com/ruby-syntax-tree/syntax_tree/pull/51) - `SyntaxTree::Heredoc` now have a `dedent` field that indicates the number of spaces to strip from the beginning of the string content.
+
+### Changed
+
+- [#51](https://github.com/ruby-syntax-tree/syntax_tree/pull/51) - `SyntaxTree::HshPtn` will now add a `then` if you use a bare `**` and `SyntaxTree::AryPtn` will do the same for a bare `*` on the end.
+- [#51](https://github.com/ruby-syntax-tree/syntax_tree/pull/51) - `SyntaxTree::MLHSParen` now has a comma field in case a trailing comma has been added to a parenthesis destructuring, as in `((foo,))`.
+- [#51](https://github.com/ruby-syntax-tree/syntax_tree/pull/51) - `SyntaxTree::FndPtn` has much improved parsing now.
+
+## [2.1.1] - 2022-04-16
+
+### Changed
+
+- [#45](https://github.com/ruby-syntax-tree/syntax_tree/issues/45) - Fix parsing expressions like `foo.instance_exec(&T.must(block))`, where there are two `args_add_block` calls with a single `&`. Previously it was associating the `&` with the wrong block.
+- [#47](https://github.com/ruby-syntax-tree/syntax_tree/pull/47) - Handle expressions like `not()`.
+- [#48](https://github.com/ruby-syntax-tree/syntax_tree/pull/48) - Handle special call syntax with `::` operator.
+- [#49](https://github.com/ruby-syntax-tree/syntax_tree/pull/49) - Handle expressions like `case foo; in {}; end`.
+- [#50](https://github.com/ruby-syntax-tree/syntax_tree/pull/50) - Parsing expressions like `case foo; in **nil; end`.
+
 ## [2.1.0] - 2022-04-12
 
 ### Added
@@ -143,7 +187,10 @@ The format is based on [Keep a Changelog](http://keepachangelog.com/en/1.0.0/) a
 
 - 🎉 Initial release! 🎉
 
-[unreleased]: https://github.com/ruby-syntax-tree/syntax_tree/compare/v2.1.0...HEAD
+[unreleased]: https://github.com/ruby-syntax-tree/syntax_tree/compare/v2.3.0...HEAD
+[2.3.0]: https://github.com/ruby-syntax-tree/syntax_tree/compare/v2.2.0...v2.3.0
+[2.2.0]: https://github.com/ruby-syntax-tree/syntax_tree/compare/v2.1.1...v2.2.0
+[2.1.1]: https://github.com/ruby-syntax-tree/syntax_tree/compare/v2.1.0...v2.1.1
 [2.1.0]: https://github.com/ruby-syntax-tree/syntax_tree/compare/v2.0.1...v2.1.0
 [2.0.1]: https://github.com/ruby-syntax-tree/syntax_tree/compare/v2.0.0...v2.0.1
 [2.0.0]: https://github.com/ruby-syntax-tree/syntax_tree/compare/v1.2.0...v2.0.0

data/Gemfile

@@ -3,8 +3,3 @@
 source "https://rubygems.org"
 
 gemspec
-
-gem "benchmark-ips"
-gem "parser"
-gem "ruby_parser"
-gem "stackprof"

data/Gemfile.lock

@@ -1,28 +1,20 @@
 PATH
   remote: .
   specs:
-    syntax_tree (2.1.0)
+    syntax_tree (2.3.0)
 
 GEM
   remote: https://rubygems.org/
   specs:
-    ast (2.4.2)
-    benchmark-ips (2.10.0)
     docile (1.4.0)
     minitest (5.15.0)
-    parser (3.1.2.0)
-      ast (~> 2.4.1)
     rake (13.0.6)
-    ruby_parser (3.19.1)
-      sexp_processor (~> 4.16)
-    sexp_processor (4.16.0)
     simplecov (0.21.2)
       docile (~> 1.1)
       simplecov-html (~> 0.11)
       simplecov_json_formatter (~> 0.1)
     simplecov-html (0.12.3)
-    simplecov_json_formatter (0.1.3)
-    stackprof (0.2.19)
+    simplecov_json_formatter (0.1.4)
 
 PLATFORMS
   arm64-darwin-21
@@ -32,15 +24,11 @@ PLATFORMS
   x86_64-linux
 
 DEPENDENCIES
-  benchmark-ips
   bundler
   minitest
-  parser
   rake
-  ruby_parser
   simplecov
-  stackprof
   syntax_tree!
 
 BUNDLED WITH
-   2.2.31
+   2.3.6

data/README.md

@@ -33,6 +33,7 @@ It is built with only standard library dependencies. It additionally ships with
   - [textDocument/formatting](#textdocumentformatting)
   - [textDocument/inlayHints](#textdocumentinlayhints)
   - [syntaxTree/visualizing](#syntaxtreevisualizing)
+- [Plugins](#plugins)
 - [Contributing](#contributing)
 - [License](#license)
 
@@ -307,6 +308,26 @@ Implicity, the `2 * 3` is going to be executed first because the `*` operator ha
 
 The language server additionally includes this custom request to return a textual representation of the syntax tree underlying the source code of a file. Language server clients can use this to (for example) open an additional tab with this information displayed.
 
+## Plugins
+
+You can register additional languages that can flow through the same CLI with Syntax Tree's plugin system. To register a new language, call:
+
+```ruby
+SyntaxTree.register_handler(".mylang", MyLanguage)
+```
+
+In this case, whenever the CLI encounters a filepath that ends with the given extension, it will invoke methods on `MyLanguage` instead of `SyntaxTree` itself. To make sure your object conforms to each of the necessary APIs, it should implement:
+
+* `MyLanguage.read(filepath)` - usually this is just an alias to `File.read(filepath)`, but if you need anything else that hook is here.
+* `MyLanguage.parse(source)` - this should return the syntax tree corresponding to the given source. Those objects should implement the `pretty_print` interface.
+* `MyLanguage.format(source)` - this should return the formatted version of the given source.
+
+Below are listed all of the "official" plugins hosted under the same GitHub organization, which can be used as references for how to implement other plugins.
+
+* [SyntaxTree::Haml](https://github.com/ruby-syntax-tree/syntax_tree-haml) for the [Haml template language](https://haml.info/).
+* [SyntaxTree::JSON](https://github.com/ruby-syntax-tree/syntax_tree-json) for JSON.
+* [SyntaxTree::RBS](https://github.com/ruby-syntax-tree/syntax_tree-rbs) for the [RBS type language](https://github.com/ruby/rbs).
+
 ## Contributing
 
 Bug reports and pull requests are welcome on GitHub at https://github.com/ruby-syntax-tree/syntax_tree.

data/bin/bench

@@ -1,12 +1,17 @@
 #!/usr/bin/env ruby
 # frozen_string_literal: true
 
-require "bundler/setup"
-require "benchmark/ips"
+require "bundler/inline"
 
-require_relative "../lib/syntax_tree"
-require "ruby_parser"
-require "parser/current"
+gemfile do
+  source "https://rubygems.org"
+  gem "benchmark-ips"
+  gem "parser", require: "parser/current"
+  gem "ruby_parser"
+end
+
+$:.unshift(File.expand_path("../lib", __dir__))
+require "syntax_tree"
 
 def compare(filepath)
   prefix = "#{File.expand_path("..", __dir__)}/"
@@ -30,7 +35,7 @@ filepaths = ARGV
 if filepaths.empty?
   filepaths = [
     File.expand_path("bench", __dir__),
-    File.expand_path("../lib/syntax_tree.rb", __dir__)
+    File.expand_path("../lib/syntax_tree/node.rb", __dir__)
   ]
 end
 

data/bin/profile

@@ -1,19 +1,28 @@
 #!/usr/bin/env ruby
 # frozen_string_literal: true
 
-require "bundler/setup"
-require "stackprof"
+require "bundler/inline"
 
-filepath = File.expand_path("../lib/syntax_tree", __dir__)
-require_relative filepath
+gemfile do
+  source "https://rubygems.org"
+  gem "stackprof"
+end
+
+$:.unshift(File.expand_path("../lib", __dir__))
+require "syntax_tree"
 
 GC.disable
 
 StackProf.run(mode: :cpu, out: "tmp/profile.dump", raw: true) do
-  SyntaxTree.format(File.read("#{filepath}.rb"))
+  filepath = File.expand_path("../lib/syntax_tree/node.rb", __dir__)
+  SyntaxTree.format(File.read(filepath))
 end
 
 GC.enable
 
-`bundle exec stackprof --d3-flamegraph tmp/profile.dump > tmp/flamegraph.html`
-puts "open tmp/flamegraph.html"
+File.open("tmp/flamegraph.html", "w") do |file|
+  report = Marshal.load(IO.binread("tmp/profile.dump"))
+  StackProf::Report.new(report).print_d3_flamegraph(file)
+end
+
+`open tmp/flamegraph.html`

data/lib/syntax_tree/formatter.rb

@@ -17,6 +17,13 @@ module SyntaxTree
       @quote = "\""
     end
 
+    def self.format(source, node)
+      formatter = new(source, [])
+      node.format(formatter)
+      formatter.flush
+      formatter.output.join
+    end
+
     def format(node, stackable: true)
       stack << node if stackable
       doc = nil
@@ -43,7 +50,7 @@ module SyntaxTree
         # Print all comments that were found after the node.
         trailing.each do |comment|
           line_suffix(priority: COMMENT_PRIORITY) do
-            text(" ")
+            comment.inline? ? text(" ") : breakable
             comment.format(self)
             break_parent
           end