syntax_tree 2.1.1 → 2.3.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: bd341a51ce36b230703bfbe86078641e7670058a3e41d0dbb125548c0821a65a
-  data.tar.gz: 9ebdca60f2956e24f83a58749266c89eb0eed88003a06699432956a0ecfa735a
+  metadata.gz: 5855cfed255d36a243d697083688e553ae02aa5373ec08af6bc730eea66ab995
+  data.tar.gz: 15da5f28c3cff6953eb1204abbd42ac22b2c5ea78546242f543034360b39fb62
 SHA512:
-  metadata.gz: b8292d8020afa5ece8afdbaa60e959902357e769f098c75894d2b85686a20f824cf510563b2cd31e86b3f8f781f74cf8aaafac76e0e156e26897999ccb72ae36
-  data.tar.gz: 968a355401a9bd1ca6a3e67d60e5587485de9ad3ad2a5f9e8cbe7add95622364e4c094a757035482c35377ab75cb14926af1f5ab8a0df0e5069ba69f7bed1851
+  metadata.gz: 49bd5ad54611d46c9379e98f53c0ae789949d5104b225af51a54e7d4780e274a9a9bbcff1322c5af641dadd4c5d8d633b94b1271436ef1767bd9eb869dcb6be5
+  data.tar.gz: 12cd7e5be2218aeaf9a0833dd95ce40be9d2ee248933962e3f24e854ab5335dd25b2a86b9f6ecb2c6a7e24759dcf316a9db0e8aca8841a5365e6c8030882ac76

data/CHANGELOG.md

@@ -6,6 +6,46 @@ The format is based on [Keep a Changelog](http://keepachangelog.com/en/1.0.0/) a
 
 ## [Unreleased]
 
+## [2.3.1] - 2022-04-22
+
+### Changed
+
+- `SyntaxTree::If` nodes inside of `SyntaxTree::Command` arguments should include a space before if they are flat.
+
+## [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
@@ -153,7 +193,9 @@ 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.1...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

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.1)
+    syntax_tree (2.3.1)
 
 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/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