spoom 1.7.6 → 1.7.8

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: dec9f21040705b60c827261ea327500b26e3e7c66c773c489d85bc429e140c77
-  data.tar.gz: 70bc96fd29f8063b9bb406694c7b995fd69b1cffb06a1351b4b1949e2bb934af
+  metadata.gz: aedf28669e780fce835616cbafcd7e45183d0cd474127dc26c1e9d169f3b4920
+  data.tar.gz: 5ac37ac73623a9158a7ee6d5f60aa93f46d83140fa718129c4fa73fc15ba85f4
 SHA512:
-  metadata.gz: 3a72173af92b3561d80b0fde5489906761aae18f27c0b65fd95d4e862d3912ab819a04dba5dcf52de86b5e22859b837d57c2c2d01dea5bb61469537d2814c739
-  data.tar.gz: bdff8e05e1de869f65ce1ee841b5a5bd87622cd3671a373a1b8f442a4c45f2460ae0c7ff6efe5d79ba23ae58e3eb233be6302059c1c6d16edfbe5140ac4577c0
+  metadata.gz: c309dba40798848147342ffd5c9c4657ce77e8e724d6ece2ceb4851ab8f4c21b432c4684845d1042a81937d52d6cbb47f6b27f3b6440f091e87ddb6c8e8e4077
+  data.tar.gz: aa5e4e6c8021cc62b4147ef76ff6350c3917838c154d7fdf3ce5ebcf2f54f733bc33bf4caff33ef904a6ef58a8e2b8c436996879982639e7c324110787aa343e

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/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/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

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

@@ -248,6 +248,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"

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
@@ -89,18 +91,26 @@ module Spoom
           return false unless translatable_annotation?(node)
           return false unless at_end_of_line?(node)
 
+          trailing_comment, comment_end_offset = extract_trailing_comment(node)
+          # If extract_trailing_comment returns nil when there's an RBS annotation, don't translate
+          return false if trailing_comment.nil? && has_rbs_annotation?(node)
+
           value = T.must(node.arguments&.arguments&.first)
           rbs_annotation = build_rbs_annotation(node)
 
           start_offset = node.location.start_offset
-          end_offset = node.location.end_offset
+          # If there's a trailing comment, replace up to the end of the comment
+          # Otherwise, replace up to the end of the node
+          end_offset = comment_end_offset || node.location.end_offset
 
-          @rewriter << if node.name == :bind
-            Source::Replace.new(start_offset, end_offset - 1, rbs_annotation)
+          replacement = if node.name == :bind
+            "#{rbs_annotation}#{trailing_comment}"
           else
-            Source::Replace.new(start_offset, end_offset - 1, "#{dedent_value(node, value)} #{rbs_annotation}")
+            "#{dedent_value(node, value)} #{rbs_annotation}#{trailing_comment}"
           end
 
+          @rewriter << Source::Replace.new(start_offset, end_offset - 1, replacement)
+
           true
         end
 
@@ -166,7 +176,40 @@ module Spoom
         def at_end_of_line?(node)
           end_offset = node.location.end_offset
           end_offset += 1 while (@ruby_bytes[end_offset] == " ".ord) && (end_offset < @ruby_bytes.size)
-          @ruby_bytes[end_offset] == LINE_BREAK
+          # Check if we're at a newline OR at the start of a comment
+          @ruby_bytes[end_offset] == LINE_BREAK || @ruby_bytes[end_offset] == "#".ord
+        end
+
+        # Check if the node has an RBS annotation comment (#:) after it
+        #: (Prism::Node) -> bool
+        def has_rbs_annotation?(node)
+          end_offset = node.location.end_offset
+          # Skip spaces
+          end_offset += 1 while (@ruby_bytes[end_offset] == " ".ord) && (end_offset < @ruby_bytes.size)
+          # Check if there's a comment starting with #:
+          @ruby_bytes[end_offset] == "#".ord && @ruby_bytes[end_offset + 1] == ":".ord
+        end
+
+        # Extract any trailing comment after the node
+        # Returns [comment_text, comment_end_offset] or [nil, nil] if no comment or RBS annotation
+        #: (Prism::Node) -> [String?, Integer?]
+        def extract_trailing_comment(node)
+          end_offset = node.location.end_offset
+          # Skip spaces
+          end_offset += 1 while (@ruby_bytes[end_offset] == " ".ord) && (end_offset < @ruby_bytes.size)
+          # Check if there's a comment
+          return [nil, nil] unless @ruby_bytes[end_offset] == "#".ord
+
+          # If it's an RBS annotation comment (#:), return nil to prevent translation
+          return [nil, nil] if @ruby_bytes[end_offset + 1] == ":".ord
+
+          # Find the end of the comment (end of line)
+          comment_start = end_offset
+          end_offset += 1 while @ruby_bytes[end_offset] != LINE_BREAK && end_offset < @ruby_bytes.size
+
+          # Extract the comment including the leading space and return the end offset
+          range = @ruby_bytes[comment_start...end_offset] #: as !nil
+          [" #{range.pack("C*")}", end_offset]
         end
 
         #: (Prism::Node, Prism::Node) -> String

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/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.6"
+  VERSION = "1.7.8"
 end

data/rbi/spoom.rbi

@@ -2950,6 +2950,12 @@ class Spoom::Sorbet::Translate::SorbetAssertionsToRBSComments < ::Spoom::Sorbet:
   sig { params(assign: ::Prism::Node, value: ::Prism::Node).returns(::String) }
   def dedent_value(assign, value); end
 
+  sig { params(node: ::Prism::Node).returns([T.nilable(::String), T.nilable(::Integer)]) }
+  def extract_trailing_comment(node); end
+
+  sig { params(node: ::Prism::Node).returns(T::Boolean) }
+  def has_rbs_annotation?(node); end
+
   sig { params(node: ::Prism::Node).returns(T::Boolean) }
   def maybe_translate_assertion(node); end
 

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: spoom
 version: !ruby/object:Gem::Version
-  version: 1.7.6
+  version: 1.7.8
 platform: ruby
 authors:
 - Alexandre Terrasa
@@ -274,7 +274,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.7.1
+rubygems_version: 3.7.2
 specification_version: 4
 summary: Useful tools for Sorbet enthusiasts.
 test_files: []