syntax_tree 2.8.0 → 3.0.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: ad3c35843b6e3148499ac001d05a9c5d613d69debff5fdc411dff89a9adc5ca4
-  data.tar.gz: 570ae99edf8b17b5d205142872621b0551632d29ac4671ee14fed8415cf9cfe4
+  metadata.gz: 499aba04c732c3101f3e3ebb7d487a19842781a0a97b67fad047c2cf9bbe2bcb
+  data.tar.gz: dc9e28898951ae74f3a053b261b8d1e752567917bbb8eb34a4aa22af6b49b716
 SHA512:
-  metadata.gz: 7ec0e9d8f5f4f828ba0d451d49bd7fa9f5576570f7427c91973503e795fe068e21a61dac4f1880be12dbd551855eb0b8d27f359a9a682b964f3183aaf687e1da
-  data.tar.gz: b8ae5c0132ebc445d060b1d5cef477253c724ea2c7a22a536d4ea78b3fb2d905c560e1f044f8843b92f79e0dbc1a434cda2a38e76b2732b426719150785a59af
+  metadata.gz: 3a8cdd3933efaaa8898cfa25bebd3e52d3b6632081319d8ddded59dacb996ebd11232d1060e408eb93bdb4211aa4d2775bfce970ba868264f7846dcb63873e5e
+  data.tar.gz: 673c601ce6a25cc4875b2041710b4a85f5114a24deb1cb5e3bf69a464e072f72f24f2e13cb3aa89d95076a5d7643beb6469ccd669018e75d9ac998aeb0a10ddf

data/CHANGELOG.md

@@ -6,6 +6,28 @@ The format is based on [Keep a Changelog](http://keepachangelog.com/en/1.0.0/) a
 
 ## [Unreleased]
 
+## [3.0.1] - 2022-07-15
+
+### Changed
+
+- [#112](https://github.com/ruby-syntax-tree/syntax_tree/pull/112) - Fix parallel CLI execution by not short-circuiting with the `||` operator.
+
+## [3.0.0] - 2022-07-04
+
+### Changed
+
+- [#102](https://github.com/ruby-syntax-tree/syntax_tree/issues/102) - Handle requests to the language server for files that do not yet exist on disk.
+
+### Removed
+
+- [#108](https://github.com/ruby-syntax-tree/syntax_tree/pull/108) - Remove old inlay hints code.
+
+## [2.9.0] - 2022-07-04
+
+### Added
+
+- [#106](https://github.com/ruby-syntax-tree/syntax_tree/pull/106) - Add inlay hint support to match the LSP specification.
+
 ## [2.8.0] - 2022-06-21
 
 ### Added
@@ -272,7 +294,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.8.0...HEAD
+[unreleased]: https://github.com/ruby-syntax-tree/syntax_tree/compare/v3.0.1...HEAD
+[3.0.1]: https://github.com/ruby-syntax-tree/syntax_tree/compare/v3.0.0...v3.0.1
+[3.0.0]: https://github.com/ruby-syntax-tree/syntax_tree/compare/v2.9.0...v3.0.0
+[2.9.0]: https://github.com/ruby-syntax-tree/syntax_tree/compare/v2.8.0...v2.9.0
 [2.8.0]: https://github.com/ruby-syntax-tree/syntax_tree/compare/v2.7.1...v2.8.0
 [2.7.1]: https://github.com/ruby-syntax-tree/syntax_tree/compare/v2.7.0...v2.7.1
 [2.7.0]: https://github.com/ruby-syntax-tree/syntax_tree/compare/v2.6.0...v2.7.0

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    syntax_tree (2.8.0)
+    syntax_tree (3.0.1)
       prettier_print
 
 GEM
@@ -9,7 +9,8 @@ GEM
   specs:
     ast (2.4.2)
     docile (1.4.0)
-    minitest (5.16.0)
+    json (2.6.2)
+    minitest (5.16.2)
     parallel (1.22.1)
     parser (3.1.2.0)
       ast (~> 2.4.1)
@@ -18,7 +19,8 @@ GEM
     rake (13.0.6)
     regexp_parser (2.5.0)
     rexml (3.2.5)
-    rubocop (1.30.1)
+    rubocop (1.31.2)
+      json (~> 2.3)
       parallel (~> 1.10)
       parser (>= 3.1.0.0)
       rainbow (>= 2.2.2, < 4.0)
@@ -36,7 +38,7 @@ GEM
       simplecov_json_formatter (~> 0.1)
     simplecov-html (0.12.3)
     simplecov_json_formatter (0.1.4)
-    unicode-display_width (2.1.0)
+    unicode-display_width (2.2.0)
 
 PLATFORMS
   arm64-darwin-21

data/README.md

@@ -35,7 +35,7 @@ It is built with only standard library dependencies. It additionally ships with
   - [BasicVisitor](#basicvisitor)
 - [Language server](#language-server)
   - [textDocument/formatting](#textdocumentformatting)
-  - [textDocument/inlayHints](#textdocumentinlayhints)
+  - [textDocument/inlayHint](#textdocumentinlayhint)
   - [syntaxTree/visualizing](#syntaxtreevisualizing)
 - [Plugins](#plugins)
   - [Configuration](#configuration)
@@ -402,7 +402,7 @@ By default, the language server is relatively minimal, mostly meant to provide a
 
 As mentioned above, the language server responds to formatting requests with the formatted document. It typically responds on the order of tens of milliseconds, so it should be fast enough for any IDE.
 
-### textDocument/inlayHints
+### textDocument/inlayHint
 
 The language server also responds to the relatively new inlay hints request. This request allows the language server to define additional information that should exist in the source code as helpful hints to the developer. In our case we use it to display things like implicit parentheses. For example, if you had the following code:
 
@@ -410,7 +410,7 @@ The language server also responds to the relatively new inlay hints request. Thi
 1 + 2 * 3
 ```
 
-Implicity, the `2 * 3` is going to be executed first because the `*` operator has higher precedence than the `+` operator. However, to ease mental overhead, our language server includes small parentheses to make this explicit, as in:
+Implicity, the `2 * 3` is going to be executed first because the `*` operator has higher precedence than the `+` operator. To ease mental overhead, our language server includes small parentheses to make this explicit, as in:
 
 ```ruby
 1 + ₍2 * 3₎

data/lib/syntax_tree/cli.rb

@@ -315,23 +315,7 @@ module SyntaxTree
 
         # At the end, we're going to return whether or not this worker ever
         # encountered an error.
-        errored =
-          with_workers(queue) do |item|
-            action.run(item)
-            false
-          rescue Parser::ParseError => error
-            warn("Error: #{error.message}")
-            highlight_error(error, item.source)
-            true
-          rescue Check::UnformattedError, Debug::NonIdempotentFormatError
-            true
-          rescue StandardError => error
-            warn(error.message)
-            warn(error.backtrace)
-            true
-          end
-
-        if errored
+        if process_queue(queue, action)
           action.failure
           1
         else
@@ -342,13 +326,11 @@ module SyntaxTree
 
       private
 
-      def with_workers(queue)
-        # If the queue is just 1 item, then we're not going to bother going
-        # through the whole ceremony of parallelizing the work.
-        return yield queue.shift if queue.size == 1
-
+      # Processes each item in the queue with the given action. Returns whether
+      # or not any errors were encountered.
+      def process_queue(queue, action)
         workers =
-          Etc.nprocessors.times.map do
+          [Etc.nprocessors, queue.size].min.times.map do
             Thread.new do
               # Propagate errors in the worker threads up to the parent thread.
               Thread.current.abort_on_exception = true
@@ -360,7 +342,25 @@ module SyntaxTree
 
               # While there is still work left to do, shift off the queue and
               # process the item.
-              (errored ||= yield queue.shift) until queue.empty?
+              until queue.empty?
+                item = queue.shift
+                errored |=
+                  begin
+                    action.run(item)
+                    false
+                  rescue Parser::ParseError => error
+                    warn("Error: #{error.message}")
+                    highlight_error(error, item.source)
+                    true
+                  rescue Check::UnformattedError,
+                         Debug::NonIdempotentFormatError
+                    true
+                  rescue StandardError => error
+                    warn(error.message)
+                    warn(error.backtrace)
+                    true
+                  end
+              end
 
               # At the end, we're going to return whether or not this worker
               # ever encountered an error.
@@ -368,7 +368,7 @@ module SyntaxTree
             end
           end
 
-        workers.inject(false) { |accum, thread| accum || thread.value }
+        workers.map(&:value).inject(:|)
       end
 
       # Highlights a snippet from a source and parse error.

data/lib/syntax_tree/formatter.rb

@@ -68,7 +68,9 @@ module SyntaxTree
         # going to just print out the node as it was seen in the source.
         doc =
           if leading.last&.ignore?
-            text(source[node.location.start_char...node.location.end_char])
+            range = source[node.location.start_char...node.location.end_char]
+            separator = -> { breakable(indent: false, force: true) }
+            seplist(range.split(/\r?\n/, -1), separator) { |line| text(line) }
           else
             node.format(self)
           end

data/lib/syntax_tree/language_server/inlay_hints.rb

@@ -2,20 +2,37 @@
 
 module SyntaxTree
   class LanguageServer
-    # This class provides inlay hints for the language server. It is loosely
-    # designed around the LSP spec, but existed before the spec was finalized so
-    # is a little different for now.
-    #
-    # For more information, see the spec here:
+    # This class provides inlay hints for the language server. For more
+    # information, see the spec here:
     # https://github.com/microsoft/language-server-protocol/issues/956.
-    #
     class InlayHints < Visitor
-      attr_reader :stack, :before, :after
+      # This represents a hint that is going to be displayed in the editor.
+      class Hint
+        attr_reader :line, :character, :label
+
+        def initialize(line:, character:, label:)
+          @line = line
+          @character = character
+          @label = label
+        end
+
+        # This is the shape that the LSP expects.
+        def to_json(*opts)
+          {
+            position: {
+              line: line,
+              character: character
+            },
+            label: label
+          }.to_json(*opts)
+        end
+      end
+
+      attr_reader :stack, :hints
 
       def initialize
         @stack = []
-        @before = Hash.new { |hash, key| hash[key] = +"" }
-        @after = Hash.new { |hash, key| hash[key] = +"" }
+        @hints = []
       end
 
       def visit(node)
@@ -97,7 +114,11 @@ module SyntaxTree
       #
       def visit_rescue(node)
         if node.exception.nil?
-          after[node.location.start_char + "rescue".length] << " StandardError"
+          hints << Hint.new(
+            line: node.location.start_line - 1,
+            character: node.location.start_column + "rescue".length,
+            label: " StandardError"
+          )
         end
 
         super
@@ -120,17 +141,20 @@ module SyntaxTree
         super
       end
 
-      def self.find(program)
-        visitor = new
-        visitor.visit(program)
-        visitor
-      end
-
       private
 
       def parentheses(location)
-        before[location.start_char] << "₍"
-        after[location.end_char] << "₎"
+        hints << Hint.new(
+          line: location.start_line - 1,
+          character: location.start_column,
+          label: "₍"
+        )
+
+        hints << Hint.new(
+          line: location.end_line - 1,
+          character: location.end_column,
+          label: "₎"
+        )
       end
     end
   end

data/lib/syntax_tree/language_server.rb

@@ -20,71 +20,60 @@ module SyntaxTree
       @output = output.binmode
     end
 
+    # rubocop:disable Layout/LineLength
     def run
       store =
         Hash.new do |hash, uri|
-          hash[uri] = File.binread(CGI.unescape(URI.parse(uri).path))
+          filepath = CGI.unescape(URI.parse(uri).path)
+          File.exist?(filepath) ? (hash[uri] = File.read(filepath)) : nil
         end
 
       while (headers = input.gets("\r\n\r\n"))
         source = input.read(headers[/Content-Length: (\d+)/i, 1].to_i)
         request = JSON.parse(source, symbolize_names: true)
 
+        # stree-ignore
         case request
         in { method: "initialize", id: }
           store.clear
           write(id: id, result: { capabilities: capabilities })
-        in method: "initialized"
+        in { method: "initialized" }
           # ignored
-        in method: "shutdown" # tolerate missing ID to be a good citizen
+        in { method: "shutdown" } # tolerate missing ID to be a good citizen
           store.clear
           write(id: request[:id], result: {})
           return
-        in {
-             method: "textDocument/didChange",
-             params: { textDocument: { uri: }, contentChanges: [{ text: }, *] }
-           }
+        in { method: "textDocument/didChange", params: { textDocument: { uri: }, contentChanges: [{ text: }, *] } }
           store[uri] = text
-        in {
-             method: "textDocument/didOpen",
-             params: { textDocument: { uri:, text: } }
-           }
+        in { method: "textDocument/didOpen", params: { textDocument: { uri:, text: } } }
           store[uri] = text
-        in {
-             method: "textDocument/didClose", params: { textDocument: { uri: } }
-           }
+        in { method: "textDocument/didClose", params: { textDocument: { uri: } } }
           store.delete(uri)
-        in {
-             method: "textDocument/formatting",
-             id:,
-             params: { textDocument: { uri: } }
-           }
-          write(id: id, result: [format(store[uri])])
-        in {
-             method: "textDocument/inlayHints",
-             id:,
-             params: { textDocument: { uri: } }
-           }
-          write(id: id, result: inlay_hints(store[uri]))
-        in {
-             method: "syntaxTree/visualizing",
-             id:,
-             params: { textDocument: { uri: } }
-           }
+        in { method: "textDocument/formatting", id:, params: { textDocument: { uri: } } }
+          contents = store[uri]
+          write(id: id, result: contents ? [format(store[uri])] : nil)
+        in { method: "textDocument/inlayHint", id:, params: { textDocument: { uri: } } }
+          contents = store[uri]
+          write(id: id, result: contents ? inlay_hints(store[uri]) : nil)
+        in { method: "syntaxTree/visualizing", id:, params: { textDocument: { uri: } } }
           write(id: id, result: PP.pp(SyntaxTree.parse(store[uri]), +""))
-        in method: %r{\$/.+}
+        in { method: %r{\$/.+} }
           # ignored
         else
           raise ArgumentError, "Unhandled: #{request}"
         end
       end
     end
+    # rubocop:enable Layout/LineLength
 
     private
 
     def capabilities
       {
         documentFormattingProvider: true,
+        inlayHintProvider: {
+          resolveProvider: false
+        },
         textDocumentSync: {
           change: 1,
           openClose: true
@@ -109,16 +98,13 @@ module SyntaxTree
     end
 
     def inlay_hints(source)
-      inlay_hints = InlayHints.find(SyntaxTree.parse(source))
-      serialize = ->(position, text) { { position: position, text: text } }
-
-      {
-        before: inlay_hints.before.map(&serialize),
-        after: inlay_hints.after.map(&serialize)
-      }
+      visitor = InlayHints.new
+      SyntaxTree.parse(source).accept(visitor)
+      visitor.hints
     rescue Parser::ParseError
       # If there is a parse error, then we're not going to return any inlay
       # hints for this source.
+      []
     end
 
     def write(value)

data/lib/syntax_tree/parser.rb

@@ -1641,12 +1641,12 @@ module SyntaxTree
       heredoc = @heredocs[-1]
 
       location =
-      Location.token(
-        line: lineno,
-        char: char_pos,
-        column: current_column,
-        size: value.size + 1
-      )
+        Location.token(
+          line: lineno,
+          char: char_pos,
+          column: current_column,
+          size: value.size + 1
+        )
 
       heredoc_end = HeredocEnd.new(value: value.chomp, location: location)
 

data/lib/syntax_tree/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module SyntaxTree
-  VERSION = "2.8.0"
+  VERSION = "3.0.1"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: syntax_tree
 version: !ruby/object:Gem::Version
-  version: 2.8.0
+  version: 3.0.1
 platform: ruby
 authors:
 - Kevin Newton
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2022-06-21 00:00:00.000000000 Z
+date: 2022-07-15 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: prettier_print