syntax_tree 2.9.0 → 3.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: f8818212d64fea80bd776267ea9dac3a10c454e789b47ed72f4cf715dc087b30
-  data.tar.gz: ac90d097d6cbd8b50427c5ead994021448732022ce680a809c17e5e7fe9b427f
+  metadata.gz: 28783cde4387bbc7d38d9de500564804cd885733abe59e017be73ce04981a854
+  data.tar.gz: 6a54750102b8978df75e7f8a7d611e596067bb69863f91d5a8daa9aec8509c31
 SHA512:
-  metadata.gz: cfe0af3c52f742ed24f5643710df53fd09b761f428c007ac9434d0e96828bc75c8e082884685173e6b7ea5cf5343d264219c5f5d2c9eb0a90a1fd58d2bec70c8
-  data.tar.gz: 0ee8b8362d6d18945f5bca0a0bfef1d1dc85e2fa5f27c61e807d7c4aa15b23cbb70fe6a8ebe4b1d6e73fd26e473c6fbb158287de2ee7343d0231e75b3529329b
+  metadata.gz: c2f61f01bfa53604686798c96a53d8c98abd30145038db3b7f73f92c5c6b282447f3fe355382f6b3325b3ee98ce60ddcc5c102234b78e9c8d1fe9cbf006cb38d
+  data.tar.gz: e5a63e7fdc4f7e70e354a5861e42b8c0dffbbd2ffde38754c0a1fca8a6033be2deecd52ea3ec5fb7a2aa05e0d07ab93d3b4d69762ca3c911f36a6e898ef2ffaf

data/CHANGELOG.md

@@ -6,8 +6,20 @@ The format is based on [Keep a Changelog](http://keepachangelog.com/en/1.0.0/) a
 
 ## [Unreleased]
 
+## [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
@@ -276,8 +288,8 @@ 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
-[2.1.0]: https://github.com/ruby-syntax-tree/syntax_tree/compare/v2.8.0...v2.1.0
+[unreleased]: https://github.com/ruby-syntax-tree/syntax_tree/compare/v2.9.0...HEAD
+[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.9.0)
+    syntax_tree (3.0.0)
       prettier_print
 
 GEM

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/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,21 +2,37 @@
 
 module SyntaxTree
   class LanguageServer
-    # This class provides inlay hints for the language server. It existed
-    # before the spec was finalized so, so it provides two result formats:
-    # aligned with the spec (`#all`) and proprietary (`#before` and `#after`).
-    #
-    # 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, :all, :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 = []
-        @all = []
-        @before = Hash.new { |hash, key| hash[key] = +"" }
-        @after = Hash.new { |hash, key| hash[key] = +"" }
+        @hints = []
       end
 
       def visit(node)
@@ -98,14 +114,11 @@ module SyntaxTree
       #
       def visit_rescue(node)
         if node.exception.nil?
-          after[node.location.start_char + "rescue".length] << " StandardError"
-          all << {
-            position: {
-              line: node.location.start_line - 1,
-              character: node.location.start_column + "rescue".length
-            },
+          hints << Hint.new(
+            line: node.location.start_line - 1,
+            character: node.location.start_column + "rescue".length,
             label: " StandardError"
-          }
+          )
         end
 
         super
@@ -128,31 +141,20 @@ module SyntaxTree
         super
       end
 
-      def self.find(program)
-        visitor = new
-        visitor.visit(program)
-        visitor
-      end
-
       private
 
       def parentheses(location)
-        all << {
-          position: {
-            line: location.start_line - 1,
-            character: location.start_column
-          },
+        hints << Hint.new(
+          line: location.start_line - 1,
+          character: location.start_column,
           label: "₍"
-        }
-        all << {
-          position: {
-            line: location.end_line - 1,
-            character: location.end_column
-          },
+        )
+
+        hints << Hint.new(
+          line: location.end_line - 1,
+          character: location.end_column,
           label: "₎"
-        }
-        before[location.start_char] << "₍"
-        after[location.end_char] << "₎"
+        )
       end
     end
   end

data/lib/syntax_tree/language_server.rb

@@ -20,73 +20,51 @@ 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 {
-             # official RPC in LSP spec 3.17
-             method: "textDocument/inlayHint",
-             id:,
-             params: { textDocument: { uri: } }
-           }
-          write(id: id, result: inlay_hints(store[uri], false))
-        in {
-             # proprietary RPC (deprecated) between this gem and vscode-syntax-tree
-             method: "textDocument/inlayHints",
-             id:,
-             params: { textDocument: { uri: } }
-           }
-          write(id: id, result: inlay_hints(store[uri], true))
-        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
 
@@ -119,21 +97,14 @@ module SyntaxTree
       }
     end
 
-    def inlay_hints(source, proprietary)
-      inlay_hints = InlayHints.find(SyntaxTree.parse(source))
-      serialize = ->(position, text) { { position: position, text: text } }
-
-      if proprietary
-        {
-          before: inlay_hints.before.map(&serialize),
-          after: inlay_hints.after.map(&serialize)
-        }
-      else
-        inlay_hints.all
-      end
+    def inlay_hints(source)
+      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.9.0"
+  VERSION = "3.0.0"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: syntax_tree
 version: !ruby/object:Gem::Version
-  version: 2.9.0
+  version: 3.0.0
 platform: ruby
 authors:
 - Kevin Newton
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2022-07-04 00:00:00.000000000 Z
+date: 2022-07-05 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: prettier_print
@@ -160,7 +160,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.4.0.dev
+rubygems_version: 3.3.3
 signing_key:
 specification_version: 4
 summary: A parser based on ripper