spoom 1.7.7 → 1.7.9

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: dee74aa6f300c648be7b9c74808c1f24507e3c806a9fb80565f6bad3a84ca724
-  data.tar.gz: a6202c46d255610003479c753cd209a8511b5bc7511bcfe9d092e7619ed7d68a
+  metadata.gz: 24a0283b0a0b16cef6e3547725768b9d3d63673efec428dee7859e6bb398add0
+  data.tar.gz: 2e3037e4cf693ac776412e9817d2a1309a39b50bc58bff639dccce5fc9790a9e
 SHA512:
-  metadata.gz: ed6f6fb93669b54ce54010fb657d8f3264e29e7c825382b49dbbc718aad8d48177392cc3ab89c9a2c669bf183c87653cb5c2682c222c311991cfaaca3f7e5088
-  data.tar.gz: b763bdbc1480b4e6290cd152190726855bd0c0347cfd582ba12d79e3d106703cf3117a471ff4493c7f579d1713260e3c7b423d2de633fafaacb3945b26ae37d4
+  metadata.gz: 1168d181aa2f2d7512dfae7f01b8845a247bfecc5b8ea85441c9377a7bd33e51ab288d4078f3b86bbceef129c81721ba68a386095dd8feb215d0afea93bb1788
+  data.tar.gz: f9e7e65da944d81186ca772535b84befff429ce4c0cb9406ce2d0f6b9f0b5b46ba2efc67ab942782e635dd339139f9d902e71092a86c1ea28f221a0e219af0be

data/lib/spoom/context/file_system.rb

@@ -39,7 +39,11 @@ module Spoom
         glob("*")
       end
 
-      #: (?allow_extensions: Array[String], ?allow_mime_types: Array[String], ?exclude_patterns: Array[String]) -> Array[String]
+      #: (
+      #|   ?allow_extensions: Array[String],
+      #|   ?allow_mime_types: Array[String],
+      #|   ?exclude_patterns: Array[String]
+      #| ) -> Array[String]
       def collect_files(allow_extensions: [], allow_mime_types: [], exclude_patterns: [])
         collector = FileCollector.new(
           allow_extensions: allow_extensions,

data/lib/spoom/coverage/d3/circle_map.rb

@@ -145,7 +145,12 @@ module Spoom
         end
 
         class Sigils < CircleMap
-          #: (String id, FileTree file_tree, Hash[FileTree::Node, String?] nodes_strictnesses, Hash[FileTree::Node, Float] nodes_scores) -> void
+          #: (
+          #|   String id,
+          #|   FileTree file_tree,
+          #|   Hash[FileTree::Node, String?] nodes_strictnesses,
+          #|   Hash[FileTree::Node, Float] nodes_scores
+          #| ) -> void
           def initialize(id, file_tree, nodes_strictnesses, nodes_scores)
             @nodes_strictnesses = nodes_strictnesses
             @nodes_scores = nodes_scores

data/lib/spoom/coverage/report.rb

@@ -138,7 +138,12 @@ module Spoom
       end
 
       class Map < Card
-        #: (file_tree: FileTree, nodes_strictnesses: Hash[FileTree::Node, String?], nodes_strictness_scores: Hash[FileTree::Node, Float], ?title: String) -> void
+        #: (
+        #|   file_tree: FileTree,
+        #|   nodes_strictnesses: Hash[FileTree::Node, String?],
+        #|   nodes_strictness_scores: Hash[FileTree::Node, Float],
+        #|   ?title: String
+        #| ) -> void
         def initialize(file_tree:, nodes_strictnesses:, nodes_strictness_scores:, title: "Strictness Map")
           super(
             title: title,
@@ -222,7 +227,16 @@ module Spoom
     end
 
     class Report < Page
-      #: (project_name: String, palette: D3::ColorPalette, snapshots: Array[Snapshot], file_tree: FileTree, nodes_strictnesses: Hash[FileTree::Node, String?], nodes_strictness_scores: Hash[FileTree::Node, Float], ?sorbet_intro_commit: String?, ?sorbet_intro_date: Time?) -> void
+      #: (
+      #|   project_name: String,
+      #|   palette: D3::ColorPalette,
+      #|   snapshots: Array[Snapshot],
+      #|   file_tree: FileTree,
+      #|   nodes_strictnesses: Hash[FileTree::Node, String?],
+      #|   nodes_strictness_scores: Hash[FileTree::Node, Float],
+      #|   ?sorbet_intro_commit: String?,
+      #|   ?sorbet_intro_date: Time?
+      #| ) -> void
       def initialize(
         project_name:,
         palette:,

data/lib/spoom/deadcode/index.rb

@@ -49,7 +49,7 @@ module Spoom
 
       #: (String rb, file: String, ?plugins: Array[Plugins::Base]) -> void
       def index_ruby(rb, file:, plugins: [])
-        node = Spoom.parse_ruby(rb, file: file, comments: true)
+        node, _ = Spoom.parse_ruby(rb, file: file)
 
         # Index definitions
         model_builder = Model::Builder.new(@model, file)

data/lib/spoom/model/model.rb

@@ -129,7 +129,13 @@ module Spoom
       #: String?
       attr_accessor :superclass_name
 
-      #: (Symbol symbol, owner: Namespace?, location: Location, ?superclass_name: String?, ?comments: Array[Comment]) -> void
+      #: (
+      #|   Symbol symbol,
+      #|   owner: Namespace?,
+      #|   location: Location,
+      #|   ?superclass_name: String?,
+      #|   ?comments: Array[Comment]
+      #| ) -> void
       def initialize(symbol, owner:, location:, superclass_name: nil, comments: [])
         super(symbol, owner: owner, location: location, comments: comments)
 
@@ -160,7 +166,14 @@ module Spoom
       #: Array[Sig]
       attr_reader :sigs
 
-      #: (Symbol symbol, owner: Namespace?, location: Location, visibility: Visibility, ?sigs: Array[Sig], ?comments: Array[Comment]) -> void
+      #: (
+      #|   Symbol symbol,
+      #|   owner: Namespace?,
+      #|   location: Location,
+      #|   visibility: Visibility,
+      #|   ?sigs: Array[Sig],
+      #|   ?comments: Array[Comment]
+      #| ) -> void
       def initialize(symbol, owner:, location:, visibility:, sigs: [], comments: [])
         super(symbol, owner: owner, location: location, comments: comments)
 

data/lib/spoom/parse.rb

@@ -7,22 +7,21 @@ module Spoom
   class ParseError < Error; end
 
   class << self
-    #: (String ruby, file: String, ?comments: bool) -> Prism::Node
-    def parse_ruby(ruby, file:, comments: false)
+    #: (String ruby, file: String) -> [Prism::Node, Array[Prism::Comment]]
+    def parse_ruby(ruby, file:)
       result = Prism.parse(ruby)
+
       unless result.success?
         message = +"Error while parsing #{file}:\n"
-
         result.errors.each do |e|
           message << "- #{e.message} (at #{e.location.start_line}:#{e.location.start_column})\n"
         end
-
         raise ParseError, message
       end
 
-      result.attach_comments! if comments
+      result.attach_comments!
 
-      result.value
+      [result.value, result.comments]
     end
   end
 end

data/lib/spoom/rbs.rb

@@ -39,7 +39,13 @@ module Spoom
       def method_annotations
         @annotations.select do |annotation|
           case annotation.string
-          when "@abstract", "@final", "@override", "@override(allow_incompatible: true)", "@overridable", "@without_runtime"
+          when "@abstract",
+               "@final",
+               "@override",
+               "@override(allow_incompatible: true)",
+               "@override(allow_incompatible: :visibility)",
+               "@overridable",
+               "@without_runtime"
             true
           else
             false
@@ -64,6 +70,7 @@ module Spoom
 
     class Annotation < Comment; end
     class Signature < Comment; end
+    class TypeAlias < Comment; end
 
     module ExtractRBSComments
       #: (Prism::Node) -> Comments

data/lib/spoom/sorbet/metrics/code_metrics_visitor.rb

@@ -13,7 +13,7 @@ module Spoom
             counters.increment("files")
 
             content = File.read(file)
-            node = Spoom.parse_ruby(content, file: file, comments: true)
+            node, _ = Spoom.parse_ruby(content, file: file)
             visitor = CodeMetricsVisitor.new(counters)
             visitor.visit(node)
           end

data/lib/spoom/sorbet/translate/rbs_comments_to_sorbet_sigs.rb

@@ -14,6 +14,16 @@ module Spoom
           @max_line_length = max_line_length
         end
 
+        # @override
+        #: (Prism::ProgramNode node) -> void
+        def visit_program_node(node)
+          # Process all type aliases from the entire file first
+          apply_type_aliases(@comments)
+
+          # Now process the rest of the file with type aliases available
+          super
+        end
+
         # @override
         #: (Prism::ClassNode node) -> void
         def visit_class_node(node)
@@ -248,6 +258,9 @@ module Spoom
             when "@override(allow_incompatible: true)"
               sig.is_override = true
               sig.allow_incompatible_override = true
+            when "@override(allow_incompatible: :visibility)"
+              sig.is_override = true
+              sig.allow_incompatible_override_visibility = true
             when "@overridable"
               sig.is_overridable = true
             when "@without_runtime"
@@ -271,6 +284,78 @@ module Spoom
             true
           end
         end
+
+        #: (Array[Prism::Comment]) -> Array[RBS::TypeAlias]
+        def collect_type_aliases(comments)
+          type_aliases = [] #: Array[RBS::TypeAlias]
+
+          return type_aliases if comments.empty?
+
+          continuation_comments = [] #: Array[Prism::Comment]
+
+          comments.reverse_each do |comment|
+            string = comment.slice
+
+            if string.start_with?("#:")
+              string = string.delete_prefix("#:").strip
+              location = comment.location
+
+              if string.start_with?("type ")
+                continuation_comments.reverse_each do |continuation_comment|
+                  string = "#{string}#{continuation_comment.slice.delete_prefix("#|")}"
+                  location = location.join(continuation_comment.location)
+                end
+
+                type_aliases << Spoom::RBS::TypeAlias.new(string, location)
+              end
+
+              # Clear the continuation comments regardless of whether we found a type alias or not
+              continuation_comments.clear
+            elsif string.start_with?("#|")
+              continuation_comments << comment
+            else
+              continuation_comments.clear
+            end
+          end
+
+          type_aliases
+        end
+
+        #: (Array[Prism::Comment]) -> void
+        def apply_type_aliases(comments)
+          type_aliases = collect_type_aliases(comments)
+
+          type_aliases.each do |type_alias|
+            indent = " " * type_alias.location.start_column
+            insert_pos = adjust_to_line_start(type_alias.location.start_offset)
+
+            from = insert_pos
+            to = adjust_to_line_end(type_alias.location.end_offset)
+
+            *, decls = ::RBS::Parser.parse_signature(type_alias.string)
+
+            # We only expect there to be a single type alias declaration
+            next unless decls.size == 1 && decls.first.is_a?(::RBS::AST::Declarations::TypeAlias)
+
+            rbs_type = decls.first
+            sorbet_type = RBI::RBS::TypeTranslator.translate(rbs_type.type)
+
+            alias_name = ::RBS::TypeName.new(
+              namespace: rbs_type.name.namespace,
+              name: rbs_type.name.name.to_s.gsub(/(?:^|_)([a-z\d]*)/i) do |match|
+                match = match.delete_prefix("_")
+                !match.empty? ? match[0].upcase.concat(match[1..-1]) : +""
+              end,
+            )
+
+            @rewriter << Source::Delete.new(from, to)
+            content = "#{indent}#{alias_name} = T.type_alias { #{sorbet_type.to_rbi} }\n"
+            @rewriter << Source::Insert.new(insert_pos, content)
+          rescue ::RBS::ParsingError, ::RBI::Error
+            # Ignore type aliases with errors
+            next
+          end
+        end
       end
     end
   end

data/lib/spoom/sorbet/translate/sorbet_assertions_to_rbs_comments.rb

@@ -74,8 +74,10 @@ module Spoom
                Prism::ClassVariableWriteNode, Prism::ClassVariableAndWriteNode, Prism::ClassVariableOperatorWriteNode, Prism::ClassVariableOrWriteNode,
                Prism::ConstantWriteNode, Prism::ConstantAndWriteNode, Prism::ConstantOperatorWriteNode, Prism::ConstantOrWriteNode,
                Prism::ConstantPathWriteNode, Prism::ConstantPathAndWriteNode, Prism::ConstantPathOperatorWriteNode, Prism::ConstantPathOrWriteNode,
-               Prism::GlobalVariableWriteNode, Prism::GlobalVariableAndWriteNode, Prism::GlobalVariableOperatorWriteNode, Prism::GlobalVariableOrWriteNode,
-               Prism::InstanceVariableWriteNode, Prism::InstanceVariableAndWriteNode, Prism::InstanceVariableOperatorWriteNode, Prism::InstanceVariableOrWriteNode,
+               Prism::GlobalVariableWriteNode, Prism::GlobalVariableAndWriteNode,
+               Prism::GlobalVariableOperatorWriteNode, Prism::GlobalVariableOrWriteNode,
+               Prism::InstanceVariableWriteNode, Prism::InstanceVariableAndWriteNode,
+               Prism::InstanceVariableOperatorWriteNode, Prism::InstanceVariableOrWriteNode,
                Prism::LocalVariableWriteNode, Prism::LocalVariableAndWriteNode, Prism::LocalVariableOperatorWriteNode, Prism::LocalVariableOrWriteNode,
                Prism::CallAndWriteNode, Prism::CallOperatorWriteNode, Prism::CallOrWriteNode
             node.value

data/lib/spoom/sorbet/translate/sorbet_sigs_to_rbs_comments.rb

@@ -260,7 +260,10 @@ module Spoom
 
             arg = body.body.first #: as Prism::Node
             srb_type = RBI::Type.parse_node(arg)
-            @rewriter << Source::Insert.new(parent.location.start_offset, "# @requires_ancestor: #{srb_type.rbs_string}\n#{indent}")
+            @rewriter << Source::Insert.new(
+              parent.location.start_offset,
+              "# @requires_ancestor: #{srb_type.rbs_string}\n#{indent}",
+            )
           end
 
           from = adjust_to_line_start(node.location.start_offset)
@@ -294,6 +297,8 @@ module Spoom
           if sigs.any? { |_, sig| sig.is_override }
             @rewriter << if sigs.any? { |_, sig| sig.allow_incompatible_override }
               Source::Insert.new(insert_pos, "# @override(allow_incompatible: true)\n#{indent}")
+            elsif sigs.any? { |_, sig| sig.allow_incompatible_override_visibility }
+              Source::Insert.new(insert_pos, "# @override(allow_incompatible: :visibility)\n#{indent}")
             else
               Source::Insert.new(insert_pos, "# @override\n#{indent}")
             end

data/lib/spoom/sorbet/translate/translator.rb

@@ -19,8 +19,9 @@ module Spoom
             ruby_contents.encode("UTF-8")
           end #: String
 
-          node = Spoom.parse_ruby(ruby_contents, file: file, comments: true)
+          node, comments = Spoom.parse_ruby(ruby_contents, file: file)
           @node = node #: Prism::Node
+          @comments = comments #: Array[Prism::Comment]
           @ruby_bytes = ruby_contents.bytes #: Array[Integer]
           @rewriter = Spoom::Source::Rewriter.new #: Source::Rewriter
         end

data/lib/spoom/source/rewriter.rb

@@ -92,7 +92,8 @@ module Spoom
       # @override
       #: (Array[Integer]) -> void
       def apply(bytes)
-        raise PositionError, "Position is out of bounds" if from < 0 || to < 0 || from > bytes.size || to > bytes.size || from > to
+        raise PositionError,
+          "Position is out of bounds" if from < 0 || to < 0 || from > bytes.size || to > bytes.size || from > to
 
         bytes[from..to] = *text.bytes
       end
@@ -125,7 +126,8 @@ module Spoom
       # @override
       #: (Array[untyped]) -> void
       def apply(bytes)
-        raise PositionError, "Position is out of bounds" if from < 0 || to < 0 || from > bytes.size || to > bytes.size || from > to
+        raise PositionError,
+          "Position is out of bounds" if from < 0 || to < 0 || from > bytes.size || to > bytes.size || from > to
 
         bytes[from..to] = "".bytes
       end

data/lib/spoom/version.rb

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

data/rbi/spoom.rbi

@@ -6,8 +6,8 @@
 
 module Spoom
   class << self
-    sig { params(ruby: ::String, file: ::String, comments: T::Boolean).returns(::Prism::Node) }
-    def parse_ruby(ruby, file:, comments: T.unsafe(nil)); end
+    sig { params(ruby: ::String, file: ::String).returns([::Prism::Node, T::Array[::Prism::Comment]]) }
+    def parse_ruby(ruby, file:); end
   end
 end
 
@@ -2584,6 +2584,7 @@ module Spoom::RBS::ExtractRBSComments
 end
 
 class Spoom::RBS::Signature < ::Spoom::RBS::Comment; end
+class Spoom::RBS::TypeAlias < ::Spoom::RBS::Comment; end
 Spoom::SPOOM_PATH = T.let(T.unsafe(nil), String)
 module Spoom::Sorbet; end
 Spoom::Sorbet::BIN_PATH = T.let(T.unsafe(nil), String)
@@ -2893,6 +2894,9 @@ class Spoom::Sorbet::Translate::RBSCommentsToSorbetSigs < ::Spoom::Sorbet::Trans
   sig { override.params(node: ::Prism::ModuleNode).void }
   def visit_module_node(node); end
 
+  sig { override.params(node: ::Prism::ProgramNode).void }
+  def visit_program_node(node); end
+
   sig { override.params(node: ::Prism::SingletonClassNode).void }
   def visit_singleton_class_node(node); end
 
@@ -2912,6 +2916,12 @@ class Spoom::Sorbet::Translate::RBSCommentsToSorbetSigs < ::Spoom::Sorbet::Trans
   sig { params(annotations: T::Array[::Spoom::RBS::Annotation], sig: ::RBI::Sig).void }
   def apply_member_annotations(annotations, sig); end
 
+  sig { params(comments: T::Array[::Prism::Comment]).void }
+  def apply_type_aliases(comments); end
+
+  sig { params(comments: T::Array[::Prism::Comment]).returns(T::Array[::Spoom::RBS::TypeAlias]) }
+  def collect_type_aliases(comments); end
+
   sig { params(def_node: ::Prism::DefNode, comments: ::Spoom::RBS::Comments).void }
   def rewrite_def(def_node, comments); end
 

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: spoom
 version: !ruby/object:Gem::Version
-  version: 1.7.7
+  version: 1.7.9
 platform: ruby
 authors:
 - Alexandre Terrasa