spoom 1.5.0 → 1.7.2

data/lib/spoom/sorbet/lsp/base.rb

@@ -10,14 +10,12 @@ module Spoom
     #
     # The language server protocol always uses `"2.0"` as the `jsonrpc` version.
     class Message
-      extend T::Sig
-
-      sig { void }
+      #: -> void
       def initialize
-        @jsonrpc = T.let("2.0", String)
+        @jsonrpc = "2.0" #: String
       end
 
-      sig { returns(T::Hash[T.untyped, T.untyped]) }
+      #: -> Hash[untyped, untyped]
       def as_json
         instance_variables.each_with_object({}) do |var, obj|
           val = instance_variable_get(var)
@@ -25,7 +23,7 @@ module Spoom
         end
       end
 
-      sig { params(args: T.untyped).returns(String) }
+      #: (*untyped args) -> String
       def to_json(*args)
         T.unsafe(as_json).to_json(*args)
       end
@@ -35,15 +33,13 @@ module Spoom
     #
     # Every processed request must send a response back to the sender of the request.
     class Request < Message
-      extend T::Sig
-
-      sig { returns(Integer) }
+      #: Integer
       attr_reader :id
 
-      sig { returns(T::Hash[T.untyped, T.untyped]) }
+      #: Hash[untyped, untyped]
       attr_reader :params
 
-      sig { params(id: Integer, method: String, params: T::Hash[T.untyped, T.untyped]).void }
+      #: (Integer id, String method, Hash[untyped, untyped] params) -> void
       def initialize(id, method, params)
         super()
         @id = id
@@ -56,15 +52,13 @@ module Spoom
     #
     # A processed notification message must not send a response back. They work like events.
     class Notification < Message
-      extend T::Sig
-
-      sig { returns(String) }
+      #: String
       attr_reader :method
 
-      sig { returns(T::Hash[T.untyped, T.untyped]) }
+      #: Hash[untyped, untyped]
       attr_reader :params
 
-      sig { params(method: String, params: T::Hash[T.untyped, T.untyped]).void }
+      #: (String method, Hash[untyped, untyped] params) -> void
       def initialize(method, params)
         super()
         @method = method

data/lib/spoom/sorbet/lsp/errors.rb

@@ -8,18 +8,14 @@ module Spoom
       class BadHeaders < Error; end
 
       class Diagnostics < Error
-        extend T::Sig
-
-        sig { returns(String) }
+        #: String
         attr_reader :uri
 
-        sig { returns(T::Array[Diagnostic]) }
+        #: Array[Diagnostic]
         attr_reader :diagnostics
 
         class << self
-          extend T::Sig
-
-          sig { params(json: T::Hash[T.untyped, T.untyped]).returns(Diagnostics) }
+          #: (Hash[untyped, untyped] json) -> Diagnostics
           def from_json(json)
             Diagnostics.new(
               json["uri"],
@@ -28,7 +24,7 @@ module Spoom
           end
         end
 
-        sig { params(uri: String, diagnostics: T::Array[Diagnostic]).void }
+        #: (String uri, Array[Diagnostic] diagnostics) -> void
         def initialize(uri, diagnostics)
           @uri = uri
           @diagnostics = diagnostics
@@ -38,18 +34,14 @@ module Spoom
     end
 
     class ResponseError < Error
-      extend T::Sig
-
-      sig { returns(Integer) }
+      #: Integer
       attr_reader :code
 
-      sig { returns(T::Hash[T.untyped, T.untyped]) }
+      #: Hash[untyped, untyped]
       attr_reader :data
 
       class << self
-        extend T::Sig
-
-        sig { params(json: T::Hash[T.untyped, T.untyped]).returns(ResponseError) }
+        #: (Hash[untyped, untyped] json) -> ResponseError
         def from_json(json)
           ResponseError.new(
             json["code"],
@@ -59,7 +51,7 @@ module Spoom
         end
       end
 
-      sig { params(code: Integer, message: String, data: T::Hash[T.untyped, T.untyped]).void }
+      #: (Integer code, String message, Hash[untyped, untyped] data) -> void
       def initialize(code, message, data)
         super(message)
         @code = code

data/lib/spoom/sorbet/lsp/structures.rb

@@ -17,16 +17,13 @@ module Spoom
     end
 
     class Hover < T::Struct
-      extend T::Sig
       include PrintableSymbol
 
       const :contents, String
       const :range, T.nilable(Range)
 
       class << self
-        extend T::Sig
-
-        sig { params(json: T::Hash[T.untyped, T.untyped]).returns(Hover) }
+        #: (Hash[untyped, untyped] json) -> Hover
         def from_json(json)
           Hover.new(
             contents: json["contents"]["value"],
@@ -35,29 +32,27 @@ module Spoom
         end
       end
 
-      sig { override.params(printer: SymbolPrinter).void }
+      # @override
+      #: (SymbolPrinter printer) -> void
       def accept_printer(printer)
         printer.print("#{contents}\n")
         printer.print_object(range) if range
       end
 
-      sig { returns(String) }
+      #: -> String
       def to_s
         "#{contents} (#{range})."
       end
     end
 
     class Position < T::Struct
-      extend T::Sig
       include PrintableSymbol
 
       const :line, Integer
       const :char, Integer
 
       class << self
-        extend T::Sig
-
-        sig { params(json: T::Hash[T.untyped, T.untyped]).returns(Position) }
+        #: (Hash[untyped, untyped] json) -> Position
         def from_json(json)
           Position.new(
             line: json["line"].to_i,
@@ -66,28 +61,26 @@ module Spoom
         end
       end
 
-      sig { override.params(printer: SymbolPrinter).void }
+      # @override
+      #: (SymbolPrinter printer) -> void
       def accept_printer(printer)
         printer.print_colored("#{line}:#{char}", Color::LIGHT_BLACK)
       end
 
-      sig { returns(String) }
+      #: -> String
       def to_s
         "#{line}:#{char}"
       end
     end
 
     class Range < T::Struct
-      extend T::Sig
       include PrintableSymbol
 
       const :start, Position
       const :end, Position
 
       class << self
-        extend T::Sig
-
-        sig { params(json: T::Hash[T.untyped, T.untyped]).returns(Range) }
+        #: (Hash[untyped, untyped] json) -> Range
         def from_json(json)
           Range.new(
             start: Position.from_json(json["start"]),
@@ -96,30 +89,28 @@ module Spoom
         end
       end
 
-      sig { override.params(printer: SymbolPrinter).void }
+      # @override
+      #: (SymbolPrinter printer) -> void
       def accept_printer(printer)
         printer.print_object(start)
         printer.print_colored("-", Color::LIGHT_BLACK)
         printer.print_object(self.end)
       end
 
-      sig { returns(String) }
+      #: -> String
       def to_s
         "#{start}-#{self.end}"
       end
     end
 
     class Location < T::Struct
-      extend T::Sig
       include PrintableSymbol
 
       const :uri, String
       const :range, LSP::Range
 
       class << self
-        extend T::Sig
-
-        sig { params(json: T::Hash[T.untyped, T.untyped]).returns(Location) }
+        #: (Hash[untyped, untyped] json) -> Location
         def from_json(json)
           Location.new(
             uri: json["uri"],
@@ -128,20 +119,20 @@ module Spoom
         end
       end
 
-      sig { override.params(printer: SymbolPrinter).void }
+      # @override
+      #: (SymbolPrinter printer) -> void
       def accept_printer(printer)
         printer.print_colored("#{printer.clean_uri(uri)}:", Color::LIGHT_BLACK)
         printer.print_object(range)
       end
 
-      sig { returns(String) }
+      #: -> String
       def to_s
         "#{uri}:#{range}"
       end
     end
 
     class SignatureHelp < T::Struct
-      extend T::Sig
       include PrintableSymbol
 
       const :label, T.nilable(String)
@@ -149,9 +140,7 @@ module Spoom
       const :params, T::Array[T.untyped] # TODO
 
       class << self
-        extend T::Sig
-
-        sig { params(json: T::Hash[T.untyped, T.untyped]).returns(SignatureHelp) }
+        #: (Hash[untyped, untyped] json) -> SignatureHelp
         def from_json(json)
           SignatureHelp.new(
             label: json["label"],
@@ -161,7 +150,8 @@ module Spoom
         end
       end
 
-      sig { override.params(printer: SymbolPrinter).void }
+      # @override
+      #: (SymbolPrinter printer) -> void
       def accept_printer(printer)
         printer.print(label)
         printer.print("(")
@@ -169,14 +159,13 @@ module Spoom
         printer.print(")")
       end
 
-      sig { returns(String) }
+      #: -> String
       def to_s
         "#{label}(#{params})."
       end
     end
 
     class Diagnostic < T::Struct
-      extend T::Sig
       include PrintableSymbol
 
       const :range, LSP::Range
@@ -185,9 +174,7 @@ module Spoom
       const :information, Object
 
       class << self
-        extend T::Sig
-
-        sig { params(json: T::Hash[T.untyped, T.untyped]).returns(Diagnostic) }
+        #: (Hash[untyped, untyped] json) -> Diagnostic
         def from_json(json)
           Diagnostic.new(
             range: Range.from_json(json["range"]),
@@ -198,19 +185,19 @@ module Spoom
         end
       end
 
-      sig { override.params(printer: SymbolPrinter).void }
+      # @override
+      #: (SymbolPrinter printer) -> void
       def accept_printer(printer)
         printer.print(to_s)
       end
 
-      sig { returns(String) }
+      #: -> String
       def to_s
         "Error: #{message} (#{code})."
       end
     end
 
     class DocumentSymbol < T::Struct
-      extend T::Sig
       include PrintableSymbol
 
       const :name, String
@@ -221,9 +208,7 @@ module Spoom
       const :children, T::Array[DocumentSymbol]
 
       class << self
-        extend T::Sig
-
-        sig { params(json: T::Hash[T.untyped, T.untyped]).returns(DocumentSymbol) }
+        #: (Hash[untyped, untyped] json) -> DocumentSymbol
         def from_json(json)
           DocumentSymbol.new(
             name: json["name"],
@@ -236,7 +221,8 @@ module Spoom
         end
       end
 
-      sig { override.params(printer: SymbolPrinter).void }
+      # @override
+      #: (SymbolPrinter printer) -> void
       def accept_printer(printer)
         h = serialize.hash
         return if printer.seen.include?(h)
@@ -263,88 +249,76 @@ module Spoom
         # TODO: also display details?
       end
 
-      sig { returns(String) }
+      #: -> String
       def to_s
         "#{name} (#{range})"
       end
 
-      sig { returns(String) }
+      #: -> String
       def kind_string
         SYMBOL_KINDS[kind] || "<unknown:#{kind}>"
       end
 
-      SYMBOL_KINDS = T.let(
-        {
-          1 => "file",
-          2 => "module",
-          3 => "namespace",
-          4 => "package",
-          5 => "class",
-          6 => "def",
-          7 => "property",
-          8 => "field",
-          9 => "constructor",
-          10 => "enum",
-          11 => "interface",
-          12 => "function",
-          13 => "variable",
-          14 => "const",
-          15 => "string",
-          16 => "number",
-          17 => "boolean",
-          18 => "array",
-          19 => "object",
-          20 => "key",
-          21 => "null",
-          22 => "enum_member",
-          23 => "struct",
-          24 => "event",
-          25 => "operator",
-          26 => "type_parameter",
-        },
-        T::Hash[Integer, String],
-      )
+      SYMBOL_KINDS = {
+        1 => "file",
+        2 => "module",
+        3 => "namespace",
+        4 => "package",
+        5 => "class",
+        6 => "def",
+        7 => "property",
+        8 => "field",
+        9 => "constructor",
+        10 => "enum",
+        11 => "interface",
+        12 => "function",
+        13 => "variable",
+        14 => "const",
+        15 => "string",
+        16 => "number",
+        17 => "boolean",
+        18 => "array",
+        19 => "object",
+        20 => "key",
+        21 => "null",
+        22 => "enum_member",
+        23 => "struct",
+        24 => "event",
+        25 => "operator",
+        26 => "type_parameter",
+      } #: Hash[Integer, String]
     end
 
     class SymbolPrinter < Printer
-      extend T::Sig
-
-      sig { returns(T::Set[Integer]) }
+      #: Set[Integer]
       attr_reader :seen
 
-      sig { returns(T.nilable(String)) }
+      #: String?
       attr_accessor :prefix
 
-      sig do
-        params(
-          out: T.any(IO, StringIO),
-          colors: T::Boolean,
-          indent_level: Integer,
-          prefix: T.nilable(String),
-        ).void
-      end
+      #: (?out: (IO | StringIO), ?colors: bool, ?indent_level: Integer, ?prefix: String?) -> void
       def initialize(out: $stdout, colors: true, indent_level: 0, prefix: nil)
         super(out: out, colors: colors, indent_level: indent_level)
-        @seen = T.let(Set.new, T::Set[Integer])
+        @seen = Set.new #: Set[Integer]
         @out = out
         @colors = colors
         @indent_level = indent_level
         @prefix = prefix
       end
 
-      sig { params(object: T.nilable(PrintableSymbol)).void }
+      #: (PrintableSymbol? object) -> void
       def print_object(object)
         return unless object
 
         object.accept_printer(self)
       end
 
-      sig { params(objects: T::Array[PrintableSymbol]).void }
+      #: (Array[PrintableSymbol] objects) -> void
       def print_objects(objects)
         objects.each { |object| print_object(object) }
       end
 
-      sig { params(uri: String).returns(String) }
+      #: (String uri) -> String
       def clean_uri(uri)
         prefix = self.prefix
         return uri unless prefix
@@ -352,7 +326,7 @@ module Spoom
         uri.delete_prefix(prefix)
       end
 
-      sig { params(objects: T::Array[PrintableSymbol]).void }
+      #: (Array[PrintableSymbol] objects) -> void
       def print_list(objects)
         objects.each do |object|
           printt

data/lib/spoom/sorbet/lsp.rb

@@ -11,35 +11,33 @@ require_relative "lsp/errors"
 module Spoom
   module LSP
     class Client
-      extend T::Sig
-
-      sig { params(sorbet_bin: String, sorbet_args: String, path: String).void }
+      #: (String sorbet_bin, *String sorbet_args, ?path: String) -> void
       def initialize(sorbet_bin, *sorbet_args, path: ".")
-        @id = T.let(0, Integer)
-        @open = T.let(false, T::Boolean)
+        @id = 0 #: Integer
+        @open = false #: bool
         io_in, io_out, io_err, _status = T.unsafe(Open3).popen3(sorbet_bin, *sorbet_args, chdir: path)
-        @in = T.let(io_in, IO)
-        @out = T.let(io_out, IO)
-        @err = T.let(io_err, IO)
+        @in = io_in #: IO
+        @out = io_out #: IO
+        @err = io_err #: IO
       end
 
-      sig { returns(Integer) }
+      #: -> Integer
       def next_id
         @id += 1
       end
 
-      sig { params(json_string: String).void }
+      #: (String json_string) -> void
       def send_raw(json_string)
         @in.puts("Content-Length:#{json_string.length}\r\n\r\n#{json_string}")
       end
 
-      sig { params(message: Message).returns(T.nilable(T::Hash[T.untyped, T.untyped])) }
+      #: (Message message) -> Hash[untyped, untyped]?
       def send(message)
         send_raw(message.to_json)
         read if message.is_a?(Request)
       end
 
-      sig { returns(T.nilable(String)) }
+      #: -> String?
       def read_raw
         header = @out.gets
 
@@ -50,7 +48,7 @@ module Spoom
         @out.read(len + 2) # +2 'cause of the final \r\n
       end
 
-      sig { returns(T.nilable(T::Hash[T.untyped, T.untyped])) }
+      #: -> Hash[untyped, untyped]?
       def read
         raw_string = read_raw
         return unless raw_string
@@ -68,7 +66,7 @@ module Spoom
 
       # LSP requests
 
-      sig { params(workspace_path: String).void }
+      #: (String workspace_path) -> void
       def open(workspace_path)
         raise Error::AlreadyOpen, "Error: CLI already opened" if @open
 
@@ -85,7 +83,7 @@ module Spoom
         @open = true
       end
 
-      sig { params(uri: String, line: Integer, column: Integer).returns(T.nilable(Hover)) }
+      #: (String uri, Integer line, Integer column) -> Hover?
       def hover(uri, line, column)
         json = send(Request.new(
           next_id,
@@ -106,7 +104,7 @@ module Spoom
         Hover.from_json(json["result"])
       end
 
-      sig { params(uri: String, line: Integer, column: Integer).returns(T::Array[SignatureHelp]) }
+      #: (String uri, Integer line, Integer column) -> Array[SignatureHelp]
       def signatures(uri, line, column)
         json = send(Request.new(
           next_id,
@@ -127,7 +125,7 @@ module Spoom
         json["result"]["signatures"].map { |loc| SignatureHelp.from_json(loc) }
       end
 
-      sig { params(uri: String, line: Integer, column: Integer).returns(T::Array[Location]) }
+      #: (String uri, Integer line, Integer column) -> Array[Location]
       def definitions(uri, line, column)
         json = send(Request.new(
           next_id,
@@ -148,7 +146,7 @@ module Spoom
         json["result"].map { |loc| Location.from_json(loc) }
       end
 
-      sig { params(uri: String, line: Integer, column: Integer).returns(T::Array[Location]) }
+      #: (String uri, Integer line, Integer column) -> Array[Location]
       def type_definitions(uri, line, column)
         json = send(Request.new(
           next_id,
@@ -169,7 +167,7 @@ module Spoom
         json["result"].map { |loc| Location.from_json(loc) }
       end
 
-      sig { params(uri: String, line: Integer, column: Integer, include_decl: T::Boolean).returns(T::Array[Location]) }
+      #: (String uri, Integer line, Integer column, ?bool include_decl) -> Array[Location]
       def references(uri, line, column, include_decl = true)
         json = send(Request.new(
           next_id,
@@ -193,7 +191,7 @@ module Spoom
         json["result"].map { |loc| Location.from_json(loc) }
       end
 
-      sig { params(query: String).returns(T::Array[DocumentSymbol]) }
+      #: (String query) -> Array[DocumentSymbol]
       def symbols(query)
         json = send(Request.new(
           next_id,
@@ -208,7 +206,7 @@ module Spoom
         json["result"].map { |loc| DocumentSymbol.from_json(loc) }
       end
 
-      sig { params(uri: String).returns(T::Array[DocumentSymbol]) }
+      #: (String uri) -> Array[DocumentSymbol]
       def document_symbols(uri)
         json = send(Request.new(
           next_id,
@@ -225,7 +223,7 @@ module Spoom
         json["result"].map { |loc| DocumentSymbol.from_json(loc) }
       end
 
-      sig { void }
+      #: -> void
       def close
         send(Request.new(next_id, "shutdown", {}))
         @in.close