spoom 1.6.0 → 1.6.2

data/lib/spoom/file_tree.rb

@@ -6,7 +6,7 @@ module Spoom
   class FileTree
     #: (?T::Enumerable[String] paths) -> void
     def initialize(paths = [])
-      @roots = T.let({}, T::Hash[String, Node])
+      @roots = {} #: Hash[String, Node]
       add_paths(paths)
     end
 
@@ -123,7 +123,7 @@ module Spoom
       #: -> void
       def initialize
         super()
-        @nodes = T.let([], T::Array[FileTree::Node])
+        @nodes = [] #: Array[FileTree::Node]
       end
 
       # @override
@@ -143,7 +143,7 @@ module Spoom
       def initialize(context)
         super()
         @context = context
-        @strictnesses = T.let({}, T::Hash[Node, T.nilable(String)])
+        @strictnesses = {} #: Hash[Node, String?]
       end
 
       # @override
@@ -165,7 +165,7 @@ module Spoom
       def initialize(context)
         super
         @context = context
-        @scores = T.let({}, T::Hash[Node, Float])
+        @scores = {} #: Hash[Node, Float]
       end
 
       # @override
@@ -207,7 +207,7 @@ module Spoom
         super()
         @strictnesses = strictnesses
         @colors = colors
-        @printer = T.let(Spoom::Printer.new(out: out, colors: colors), Spoom::Printer)
+        @printer = Spoom::Printer.new(out: out, colors: colors) #: Spoom::Printer
       end
 
       # @override

data/lib/spoom/model/builder.rb

@@ -11,15 +11,12 @@ module Spoom
 
         @model = model
         @file = file
-        @comments_by_line = T.let(
-          comments.to_h do |c|
-            [c.location.start_line, c]
-          end,
-          T::Hash[Integer, Prism::Comment],
-        )
-        @namespace_nesting = T.let([], T::Array[Namespace])
-        @visibility_stack = T.let([Visibility::Public], T::Array[Visibility])
-        @last_sigs = T.let([], T::Array[Sig])
+        @comments_by_line = comments.to_h do |c|
+          [c.location.start_line, c]
+        end #: Hash[Integer, Prism::Comment]
+        @namespace_nesting = [] #: Array[Namespace]
+        @visibility_stack = [Visibility::Public] #: Array[Visibility]
+        @last_sigs = [] #: Array[Sig]
       end
 
       # Classes

data/lib/spoom/model/model.rb

@@ -36,7 +36,7 @@ module Spoom
       #: (String full_name) -> void
       def initialize(full_name)
         @full_name = full_name
-        @definitions = T.let([], T::Array[SymbolDef])
+        @definitions = [] #: Array[SymbolDef]
       end
 
       # The short name of this symbol
@@ -122,8 +122,8 @@ module Spoom
       def initialize(symbol, owner:, location:, comments: [])
         super(symbol, owner: owner, location: location, comments: comments)
 
-        @children = T.let([], T::Array[SymbolDef])
-        @mixins = T.let([], T::Array[Mixin])
+        @children = [] #: Array[SymbolDef]
+        @mixins = [] #: Array[Mixin]
       end
     end
 
@@ -233,8 +233,8 @@ module Spoom
 
     #: -> void
     def initialize
-      @symbols = T.let({}, T::Hash[String, Symbol])
-      @symbols_hierarchy = T.let(Poset[Symbol].new, Poset[Symbol])
+      @symbols = {} #: Hash[String, Symbol]
+      @symbols_hierarchy = Poset[Symbol].new #: Poset[Symbol]
     end
 
     # Get a symbol by it's full name
@@ -263,7 +263,7 @@ module Spoom
         return @symbols[full_name] ||= UnresolvedSymbol.new(full_name)
       end
 
-      target = T.let(@symbols[full_name], T.nilable(Symbol))
+      target = @symbols[full_name] #: Symbol?
       return target if target
 
       parts = context.full_name.split("::")

data/lib/spoom/model/namespace_visitor.rb

@@ -12,7 +12,7 @@ module Spoom
       def initialize
         super()
 
-        @names_nesting = T.let([], T::Array[String])
+        @names_nesting = [] #: Array[String]
       end
 
       # @override

data/lib/spoom/model/references_visitor.rb

@@ -13,7 +13,7 @@ module Spoom
         super()
 
         @file = file
-        @references = T.let([], T::Array[Reference])
+        @references = [] #: Array[Reference]
       end
 
       # @override

data/lib/spoom/poset.rb

@@ -15,7 +15,7 @@ module Spoom
 
     #: -> void
     def initialize
-      @elements = T.let({}, T::Hash[E, Element[E]])
+      @elements = {} #: Hash[E, Element[E]]
     end
 
     # Get the POSet element for a given value
@@ -149,10 +149,10 @@ module Spoom
       #: (E value) -> void
       def initialize(value)
         @value = value
-        @dtos = T.let(Set.new, T::Set[Element[E]])
-        @tos = T.let(Set.new, T::Set[Element[E]])
-        @dfroms = T.let(Set.new, T::Set[Element[E]])
-        @froms = T.let(Set.new, T::Set[Element[E]])
+        @dtos = Set.new #: Set[Element[E]]
+        @tos = Set.new #: Set[Element[E]]
+        @dfroms = Set.new #: Set[Element[E]]
+        @froms = Set.new #: Set[Element[E]]
       end
 
       #: (untyped other) -> Integer?

data/lib/spoom/sorbet/assertions.rb

@@ -144,7 +144,7 @@ module Spoom
       end
 
       class Locator < Spoom::Visitor
-        ANNOTATION_METHODS = T.let([:let], T::Array[Symbol])
+        ANNOTATION_METHODS = [:let] #: Array[Symbol]
 
         #: Array[AssignNode]
         attr_reader :assigns
@@ -152,7 +152,7 @@ module Spoom
         #: -> void
         def initialize
           super
-          @assigns = T.let([], T::Array[AssignNode])
+          @assigns = [] #: Array[AssignNode]
         end
 
         #: (AssignType) -> void
@@ -254,7 +254,7 @@ module Spoom
 
           #: -> void
           def initialize
-            @contains_heredoc = T.let(false, T::Boolean)
+            @contains_heredoc = false #: bool
 
             super
           end

data/lib/spoom/sorbet/config.rb

@@ -24,7 +24,7 @@ module Spoom
     # puts config.ignore  # "c"
     # ```
     class Config
-      DEFAULT_ALLOWED_EXTENSIONS = T.let([".rb", ".rbi"].freeze, T::Array[String])
+      DEFAULT_ALLOWED_EXTENSIONS = [".rb", ".rbi"].freeze #: Array[String]
 
       #: Array[String]
       attr_accessor :paths, :ignore, :allowed_extensions
@@ -34,10 +34,10 @@ module Spoom
 
       #: -> void
       def initialize
-        @paths = T.let([], T::Array[String])
-        @ignore = T.let([], T::Array[String])
-        @allowed_extensions = T.let([], T::Array[String])
-        @no_stdlib = T.let(false, T::Boolean)
+        @paths = [] #: Array[String]
+        @ignore = [] #: Array[String]
+        @allowed_extensions = [] #: Array[String]
+        @no_stdlib = false #: bool
       end
 
       #: -> Config
@@ -81,7 +81,7 @@ module Spoom
         #: (String sorbet_config) -> Spoom::Sorbet::Config
         def parse_string(sorbet_config)
           config = Config.new
-          state = T.let(nil, T.nilable(Symbol))
+          state = nil #: Symbol?
           sorbet_config.each_line do |line|
             line = line.strip
             case line

data/lib/spoom/sorbet/errors.rb

@@ -1,6 +1,8 @@
 # typed: strict
 # frozen_string_literal: true
 
+require "rexml/document"
+
 module Spoom
   module Sorbet
     module Errors
@@ -11,21 +13,47 @@ module Spoom
         def sort_errors_by_code(errors)
           errors.sort_by { |e| [e.code, e.file, e.line, e.message] }
         end
+
+        #: (Array[Error]) -> REXML::Document
+        def to_junit_xml(errors)
+          testsuite_element = REXML::Element.new("testsuite")
+          testsuite_element.add_attributes(
+            "name" => "Sorbet",
+            "failures" => errors.size,
+          )
+
+          if errors.empty?
+            # Avoid creating an empty report when there are no errors so that
+            # reporting tools know that the type checking ran successfully.
+            testcase_element = testsuite_element.add_element("testcase")
+            testcase_element.add_attributes(
+              "name" => "Typecheck",
+              "tests" => 1,
+            )
+          else
+            errors.each do |error|
+              testsuite_element.add_element(error.to_junit_xml_element)
+            end
+          end
+
+          doc = REXML::Document.new
+          doc << REXML::XMLDecl.new
+          doc.add_element(testsuite_element)
+
+          doc
+        end
       end
       # Parse errors from Sorbet output
       class Parser
         class ParseError < Spoom::Error; end
 
-        HEADER = T.let(
-          [
-            "👋 Hey there! Heads up that this is not a release build of sorbet.",
-            "Release builds are faster and more well-supported by the Sorbet team.",
-            "Check out the README to learn how to build Sorbet in release mode.",
-            "To forcibly silence this error, either pass --silence-dev-message,",
-            "or set SORBET_SILENCE_DEV_MESSAGE=1 in your shell environment.",
-          ],
-          T::Array[String],
-        )
+        HEADER = [
+          "👋 Hey there! Heads up that this is not a release build of sorbet.",
+          "Release builds are faster and more well-supported by the Sorbet team.",
+          "Check out the README to learn how to build Sorbet in release mode.",
+          "To forcibly silence this error, either pass --silence-dev-message,",
+          "or set SORBET_SILENCE_DEV_MESSAGE=1 in your shell environment.",
+        ] #: Array[String]
 
         class << self
           #: (String output, ?error_url_base: String) -> Array[Error]
@@ -37,9 +65,9 @@ module Spoom
 
         #: (?error_url_base: String) -> void
         def initialize(error_url_base: DEFAULT_ERROR_URL_BASE)
-          @errors = T.let([], T::Array[Error])
-          @error_line_match_regex = T.let(error_line_match_regexp(error_url_base), Regexp)
-          @current_error = T.let(nil, T.nilable(Error))
+          @errors = [] #: Array[Error]
+          @error_line_match_regex = error_line_match_regexp(error_url_base) #: Regexp
+          @current_error = nil #: Error?
         end
 
         #: (String output) -> Array[Error]
@@ -141,7 +169,7 @@ module Spoom
           @message = message
           @code = code
           @more = more
-          @files_from_error_sections = T.let(Set.new, T::Set[String])
+          @files_from_error_sections = Set.new #: Set[String]
         end
 
         # By default errors are sorted by location
@@ -156,6 +184,35 @@ module Spoom
         def to_s
           "#{file}:#{line}: #{message} (#{code})"
         end
+
+        #: -> REXML::Element
+        def to_junit_xml_element
+          testcase_element = REXML::Element.new("testcase")
+          # Unlike traditional test suites, we can't report all tests
+          # regardless of outcome; we only have errors to report. As a
+          # result we reinterpret the definitions of the test properties
+          # bit: the error message becomes the test name and the full error
+          # info gets plugged into the failure body along with file/line
+          # information (displayed in Jenkins as the "Stacktrace" for the
+          # error).
+          testcase_element.add_attributes(
+            "name" => message,
+            "file" => file,
+            "line" => line,
+          )
+          failure_element = testcase_element.add_element("failure")
+          failure_element.add_attributes(
+            "type" => code,
+          )
+          explanation_text = [
+            "In file #{file}:\n",
+            *more,
+          ].join.chomp
+          # Use CDATA so that parsers know the whitespace is significant.
+          failure_element.add(REXML::CData.new(explanation_text))
+
+          testcase_element
+        end
       end
     end
   end

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

@@ -12,7 +12,7 @@ module Spoom
     class Message
       #: -> void
       def initialize
-        @jsonrpc = T.let("2.0", String)
+        @jsonrpc = "2.0" #: String
       end
 
       #: -> Hash[untyped, untyped]

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

@@ -259,37 +259,34 @@ module Spoom
         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
@@ -302,7 +299,7 @@ module Spoom
       #: (?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

data/lib/spoom/sorbet/lsp.rb

@@ -13,12 +13,12 @@ module Spoom
     class Client
       #: (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
 
       #: -> Integer

data/lib/spoom/sorbet/sigils.rb

@@ -14,19 +14,16 @@ module Spoom
       STRICTNESS_STRONG = "strong"
       STRICTNESS_INTERNAL = "__STDLIB_INTERNAL"
 
-      VALID_STRICTNESS = T.let(
-        [
-          STRICTNESS_IGNORE,
-          STRICTNESS_FALSE,
-          STRICTNESS_TRUE,
-          STRICTNESS_STRICT,
-          STRICTNESS_STRONG,
-          STRICTNESS_INTERNAL,
-        ].freeze,
-        T::Array[String],
-      )
+      VALID_STRICTNESS = [
+        STRICTNESS_IGNORE,
+        STRICTNESS_FALSE,
+        STRICTNESS_TRUE,
+        STRICTNESS_STRICT,
+        STRICTNESS_STRONG,
+        STRICTNESS_INTERNAL,
+      ].freeze #: Array[String]
 
-      SIGIL_REGEXP = T.let(/^#[[:blank:]]*typed:[[:blank:]]*(\S*)/, Regexp)
+      SIGIL_REGEXP = /^#[[:blank:]]*typed:[[:blank:]]*(\S*)/ #: Regexp
 
       class << self
         # returns the full sigil comment string for the passed strictness

data/lib/spoom/sorbet/sigs.rb

@@ -20,8 +20,8 @@ module Spoom
           lines.join
         end
 
-        #: (String ruby_contents) -> String
-        def rbi_to_rbs(ruby_contents)
+        #: (String ruby_contents, positional_names: bool) -> String
+        def rbi_to_rbs(ruby_contents, positional_names: true)
           ruby_contents = ruby_contents.dup
           sigs = collect_sorbet_sigs(ruby_contents)
 
@@ -35,7 +35,8 @@ module Spoom
               sig.loc&.end_line&.pred,
               T.must(sig.loc).end_column,
             )
-            ruby_contents[start_index...end_index] = RBIToRBSTranslator.translate(sig, node)
+            rbs = RBIToRBSTranslator.translate(sig, node, positional_names: positional_names)
+            ruby_contents[start_index...end_index] = rbs
           end
 
           ruby_contents
@@ -56,7 +57,10 @@ module Spoom
               rbs_comment.loc&.end_line&.pred,
               T.must(rbs_comment.loc).end_column,
             )
-            ruby_contents[start_index...end_index] = RBSToRBITranslator.translate(rbs_comment, node)
+            rbi = RBSToRBITranslator.translate(rbs_comment, node)
+            next unless rbi
+
+            ruby_contents[start_index...end_index] = rbi
           end
 
           ruby_contents
@@ -91,8 +95,8 @@ module Spoom
         #: -> void
         def initialize
           super
-          @sigs = T.let([], T::Array[[RBI::Sig, T.any(RBI::Method, RBI::Attr)]])
-          @rbs_comments = T.let([], T::Array[[RBI::RBSComment, T.any(RBI::Method, RBI::Attr)]])
+          @sigs = [] #: Array[[RBI::Sig, (RBI::Method | RBI::Attr)]]
+          @rbs_comments = [] #: Array[[RBI::RBSComment, (RBI::Method | RBI::Attr)]]
         end
 
         # @override
@@ -118,22 +122,22 @@ module Spoom
 
       class RBIToRBSTranslator
         class << self
-          #: (RBI::Sig sig, (RBI::Method | RBI::Attr) node) -> String
-          def translate(sig, node)
+          #: (RBI::Sig sig, (RBI::Method | RBI::Attr) node, positional_names: bool) -> String
+          def translate(sig, node, positional_names: true)
             case node
             when RBI::Method
-              translate_method_sig(sig, node)
+              translate_method_sig(sig, node, positional_names: positional_names)
             when RBI::Attr
-              translate_attr_sig(sig, node)
+              translate_attr_sig(sig, node, positional_names: positional_names)
             end
           end
 
           private
 
-          #: (RBI::Sig sig, RBI::Method node) -> String
-          def translate_method_sig(sig, node)
+          #: (RBI::Sig sig, RBI::Method node, positional_names: bool) -> String
+          def translate_method_sig(sig, node, positional_names: true)
             out = StringIO.new
-            p = RBI::RBSPrinter.new(out: out, indent: sig.loc&.begin_column)
+            p = RBI::RBSPrinter.new(out: out, indent: sig.loc&.begin_column, positional_names: positional_names)
 
             if node.sigs.any?(&:is_final)
               p.printn("# @final")
@@ -165,10 +169,10 @@ module Spoom
             out.string
           end
 
-          #: (RBI::Sig sig, RBI::Attr node) -> String
-          def translate_attr_sig(sig, node)
+          #: (RBI::Sig sig, RBI::Attr node, positional_names: bool) -> String
+          def translate_attr_sig(sig, node, positional_names: true)
             out = StringIO.new
-            p = RBI::RBSPrinter.new(out: out)
+            p = RBI::RBSPrinter.new(out: out, positional_names: positional_names)
             p.print_attr_sig(node, sig)
             "#: #{out.string}"
           end
@@ -179,7 +183,7 @@ module Spoom
         class << self
           extend T::Sig
 
-          #: (RBI::RBSComment comment, (RBI::Method | RBI::Attr) node) -> String
+          #: (RBI::RBSComment comment, (RBI::Method | RBI::Attr) node) -> String?
           def translate(comment, node)
             case node
             when RBI::Method
@@ -187,6 +191,8 @@ module Spoom
             when RBI::Attr
               translate_attr_sig(comment, node)
             end
+          rescue RBS::ParsingError
+            nil
           end
 
           private
@@ -240,13 +246,13 @@ module Spoom
 
       # From https://github.com/Shopify/ruby-lsp/blob/9154bfc6ef/lib/ruby_lsp/document.rb#L127
       class Scanner
-        LINE_BREAK = T.let(0x0A, Integer)
+        LINE_BREAK = 0x0A #: Integer
 
         #: (String source) -> void
         def initialize(source)
-          @current_line = T.let(0, Integer)
-          @pos = T.let(0, Integer)
-          @source = T.let(source.codepoints, T::Array[Integer])
+          @current_line = 0 #: Integer
+          @pos = 0 #: Integer
+          @source = source.codepoints #: Array[Integer]
         end
 
         # Finds the character index inside the source string for a given line and column

data/lib/spoom/sorbet.rb

@@ -28,9 +28,9 @@ module Spoom
     end
 
     CONFIG_PATH = "sorbet/config"
-    GEM_PATH = T.let(Gem::Specification.find_by_name("sorbet-static").full_gem_path, String)
-    GEM_VERSION = T.let(Gem::Specification.find_by_name("sorbet-static-and-runtime").version.to_s, String)
-    BIN_PATH = T.let((Pathname.new(GEM_PATH) / "libexec" / "sorbet").to_s, String)
+    GEM_PATH = Gem::Specification.find_by_name("sorbet-static").full_gem_path #: String
+    GEM_VERSION = Gem::Specification.find_by_name("sorbet-static-and-runtime").version.to_s #: String
+    BIN_PATH = (Pathname.new(GEM_PATH) / "libexec" / "sorbet").to_s #: String
 
     KILLED_CODE = 137
     SEGFAULT_CODE = 139

data/lib/spoom/version.rb

@@ -2,5 +2,5 @@
 # frozen_string_literal: true
 
 module Spoom
-  VERSION = "1.6.0"
+  VERSION = "1.6.2"
 end

data/lib/spoom.rb

@@ -5,7 +5,7 @@ require "sorbet-runtime"
 require "pathname"
 
 module Spoom
-  SPOOM_PATH = T.let((Pathname.new(__FILE__) / ".." / "..").to_s, String)
+  SPOOM_PATH = (Pathname.new(__FILE__) / ".." / "..").to_s #: String
 
   class Error < StandardError; end
 end