spoom 1.8.12 → 1.8.13

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 284bf38248b3fb6c057966d56d0bbcd01e3fa4142e6a619ffacb98eb159a6d7d
-  data.tar.gz: 44551f71e890cde0d0a71e77b8a4d627c7aafbddaa8e0e3a7106135c6962398a
+  metadata.gz: f635fde4d393174f9f980312bd71fb2e2acb319e10d77ed894c62d795dde5ef9
+  data.tar.gz: fd6e3c6f2a271dd4b27e92c98373212d5aa61f5bfcd3c0519bf046d2255cccba
 SHA512:
-  metadata.gz: 60c251eaa56b3ad7ffac08afe381203869146040b144c7893013dcb098fc9150bad9a05b49bc303919946904b0757a6ddd285282a80bf64f607630d942b57d19
-  data.tar.gz: 462f445ffb6b740ef17486e52d3e3c65d000f482199206ea3ef6e39c7a9aa7183c9df8097b73967f89f3db5c88d3e751edba61c3fb691f2909a48930a0d78b5e
+  metadata.gz: 7cf3ad6755704d567b904fdbfe1f0508682f70f09f320e97e9b5c095c9edd62cfcc426443575078d1dc97ee7aa9045e73d1433f53706ab9e08a314b004e982fc
+  data.tar.gz: ec8a52440bb314422240b686f5abffbcd0351d61e96576cf38bf77cf2678d1fa72a84e2dc33c20af34deb7a9829a68927bc4f1c4fcda8ec0b1d083559ccdbd99

data/README.md

@@ -256,6 +256,12 @@ Translate signatures from RBI to RBS comments:
 spoom srb sigs translate
 ```
 
+Include abstract methods:
+
+```sh
+spoom srb sigs translate --translate-abstract-methods
+```
+
 Translate signatures from RBS comments to RBI:
 
 ```sh

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

@@ -45,7 +45,7 @@ module Spoom
 
         # @abstract
         #: -> String
-        def script = raise NotImplementedError, "Abstract method called"
+        def script = super
 
         private
 

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

@@ -119,7 +119,7 @@ module Spoom
 
         # @abstract
         #: -> String
-        def plot = raise NotImplementedError, "Abstract method called"
+        def plot = super
 
         #: -> String
         def x_scale

data/lib/spoom/coverage/report.rb

@@ -70,7 +70,7 @@ module Spoom
 
       # @abstract
       #: -> Array[Cards::Card]
-      def cards = raise NotImplementedError, "Abstract method called"
+      def cards = super
 
       #: -> String
       def footer_html
@@ -106,7 +106,7 @@ module Spoom
 
         # @abstract
         #: -> String
-        def erb = raise NotImplementedError, "Abstract method called"
+        def erb = super
       end
 
       class Snapshot < Card

data/lib/spoom/rbs.rb

@@ -66,6 +66,20 @@ module Spoom
         @string = string
         @location = location
       end
+
+      # The `#` comments written inside this RBS comment (e.g.: #| String, # this is the inner comment)
+      #
+      # The RBS parser discards them, so they are found by lexing the RBS, which unlike looking for `#` doesn't
+      # mistake one written inside a string literal type (e.g. `"#"`) for a comment.
+      #
+      #: -> Array[String]
+      def inner_comments
+        return [] unless @string.include?("#")
+
+        ::RBS::Parser.lex(@string).value.filter_map do |token|
+          token.location.source if token.type == :tCOMMENT || token.type == :tLINECOMMENT
+        end
+      end
     end
 
     class Annotation < Comment
@@ -120,7 +134,7 @@ module Spoom
             continuation_locations = [] #: Array[Prism::Location]
 
             continuation_comments.reverse_each do |continuation_comment|
-              string = "#{string}#{continuation_comment.slice.delete_prefix("#|")}"
+              string = "#{string}\n#{continuation_comment.slice.delete_prefix("#|")}"
               location = location.join(continuation_comment.location)
               continuation_locations << continuation_comment.location
             end

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

@@ -10,7 +10,7 @@ module Spoom
     module PrintableSymbol
       # @abstract
       #: (SymbolPrinter printer) -> void
-      def accept_printer(printer) = raise NotImplementedError, "Abstract method called"
+      def accept_printer(printer) = super
     end
 
     class Position

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

@@ -127,7 +127,10 @@ module Spoom
               @rewriter << Source::Replace.new(
                 signature.location.start_offset,
                 signature.location.end_offset,
-                pad_out_line_count(of: sig.string(max_line_length: @max_line_length), to_height_of: signature),
+                pad_out_line_count(
+                  of: preserve_comments(sig.string(max_line_length: @max_line_length), from: signature),
+                  to_height_of: signature,
+                ),
               )
             rescue ::RBS::ParsingError, ::RBI::Error
               # Ignore signatures with errors
@@ -185,7 +188,10 @@ module Spoom
               @rewriter << Source::Replace.new(
                 signature.location.start_offset,
                 signature.location.end_offset,
-                pad_out_line_count(of: sig.string(max_line_length: @max_line_length), to_height_of: signature),
+                pad_out_line_count(
+                  of: preserve_comments(sig.string(max_line_length: @max_line_length), from: signature),
+                  to_height_of: signature,
+                ),
               )
             end
 
@@ -215,7 +221,7 @@ module Spoom
           # Called for every overloaded method sig that we discard because it wasn't the last one.
           # @abstract
           #: (Spoom::RBS::Signature) -> void
-          def rewrite_discarded_overload(signature) = raise
+          def rewrite_discarded_overload(signature) = super
 
           #: (PrismTypes::anyScopeNode) -> void
           def apply_class_annotations(node)
@@ -326,17 +332,17 @@ module Spoom
           #|   insert_pos: Integer,
           #|   sorbet_replacement: String?
           #| ) -> void
-          def apply_class_annotation(annotation, parent_node:, insert_pos:, sorbet_replacement:) = raise
+          def apply_class_annotation(annotation, parent_node:, insert_pos:, sorbet_replacement:) = super
 
           # Rewrites the `#: [...]` type params comment (e.g. delete it, or mark it as translated).
           # @abstract
           #: (Spoom::RBS::Signature, type_params: Array[::RBS::AST::TypeParam]) -> void
-          def rewrite_type_params_signature(signature, type_params:) = raise
+          def rewrite_type_params_signature(signature, type_params:) = super
 
           # Inserts a single `type_member` declaration into the class/module body.
           # @abstract
           #: (String type_member, parent_node: PrismTypes::anyScopeNode, insert_pos: Integer) -> void
-          def insert_type_member(type_member, parent_node:, insert_pos:) = raise
+          def insert_type_member(type_member, parent_node:, insert_pos:) = super
 
           #: (Array[Spoom::RBS::Annotation], RBI::Sig) -> Array[Spoom::RBS::Annotation]
           def apply_member_annotations(annotations, sig)
@@ -389,7 +395,7 @@ module Spoom
 
           # @abstract
           #: (String mixin_name, into: PrismTypes::anyScopeNode, at: Integer) -> void
-          def extend_with(mixin_name, into:, at:) = raise
+          def extend_with(mixin_name, into:, at:) = super
 
           #: (Array[Prism::Comment]) -> Array[Spoom::RBS::TypeAlias]
           def collect_type_aliases(comments)
@@ -408,7 +414,7 @@ module Spoom
 
                 if string.start_with?("type ")
                   continuation_comments.reverse_each do |continuation_comment|
-                    string = "#{string}#{continuation_comment.slice.delete_prefix("#|")}"
+                    string = "#{string}\n#{continuation_comment.slice.delete_prefix("#|")}"
                     location = location.join(continuation_comment.location)
                   end
 
@@ -455,8 +461,8 @@ module Spoom
               )
 
               @rewriter << Source::Delete.new(from, to)
-              content = "#{indent}#{alias_name} = ::T.type_alias { #{sorbet_type.to_rbi} }\n"
-              content = pad_out_line_count(of: content, to_height_of: type_alias)
+              content = preserve_comments("#{alias_name} = ::T.type_alias { #{sorbet_type.to_rbi} }", from: type_alias)
+              content = pad_out_line_count(of: "#{indent}#{content}\n", to_height_of: type_alias)
               @rewriter << Source::Insert.new(insert_pos, content)
             rescue ::RBS::ParsingError, ::RBI::Error
               # Ignore type aliases with errors
@@ -464,6 +470,10 @@ module Spoom
             end
           end
 
+          # @overridable
+          #: (String replacement, from: Spoom::RBS::Comment) -> String
+          def preserve_comments(replacement, from:) = replacement # no-op
+
           # @overridable
           #: (of: String, to_height_of: Spoom::RBS::Comment) -> String
           def pad_out_line_count(of:, to_height_of:)

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

@@ -56,6 +56,15 @@ module Spoom
             @rewriter << Source::Insert.new(insert_pos, "\n#{indent}#{type_member}#{newline}")
           end
 
+          # Keeps the comments written inside the RBS comment as lines above the replacement
+          #
+          # @override
+          #: (String replacement, from: Spoom::RBS::Comment) -> String
+          def preserve_comments(replacement, from:)
+            indent = " " * from.location.start_column
+            from.inner_comments.map { |comment| "#{comment}\n#{indent}" }.join + replacement
+          end
+
           # @override
           #: (String mixin_name, into: Prism::Node, at: Integer) -> void
           def extend_with(mixin_name, into:, at:)

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

@@ -90,14 +90,22 @@ module Spoom
           end
 
           if last_sigs.any? { |_, sig| sig.is_abstract }
+            header = node.rparen_loc || node.parameters&.location || node.name_loc
+            comment = @comments.find do |comment|
+              comment.location.start_line == header.end_line &&
+                comment.location.start_offset >= header.end_offset &&
+                comment.location.end_offset < node.location.end_offset
+            end
+            header_comment = comment ? " #{comment.location.slice}" : ""
+
             @rewriter << Source::Replace.new(
-              node.rparen_loc&.end_offset || node.name_loc.end_offset,
+              header.end_offset,
               node.location.end_offset - 1,
-              if node.name.end_with?("=")
+              if node.name.end_with?("=") || (node.parameters && !node.rparen_loc)
                 indent = " " * node.location.start_column
-                "\n#{indent}  raise NotImplementedError, \"Abstract method called\"\n#{indent}end"
+                "#{header_comment}\n#{indent}  super\n#{indent}end"
               else
-                " = raise NotImplementedError, \"Abstract method called\""
+                " = super#{header_comment}"
               end,
             )
           end

data/lib/spoom/source/rewriter.rb

@@ -29,11 +29,11 @@ module Spoom
     class Edit
       # @abstract
       #: (Array[Integer]) -> void
-      def apply(bytes) = raise NotImplementedError, "Abstract method called"
+      def apply(bytes) = super
 
       # @abstract
       #: -> [Integer, Integer]
-      def range = raise NotImplementedError, "Abstract method called"
+      def range = super
     end
 
     class Insert < Edit

data/lib/spoom/version.rb

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

data/rbi/spoom.rbi

@@ -2950,6 +2950,9 @@ class Spoom::RBS::Comment
   sig { params(string: ::String, location: ::Prism::Location).void }
   def initialize(string, location); end
 
+  sig { returns(T::Array[::String]) }
+  def inner_comments; end
+
   sig { returns(::Prism::Location) }
   def location; end
 
@@ -3483,6 +3486,9 @@ class Spoom::Sorbet::Translate::RBSCommentsToSorbetSigs::BaseTranslator < ::Spoo
   sig { overridable.params(of: ::String, to_height_of: ::Spoom::RBS::Comment).returns(::String) }
   def pad_out_line_count(of:, to_height_of:); end
 
+  sig { overridable.params(replacement: ::String, from: ::Spoom::RBS::Comment).returns(::String) }
+  def preserve_comments(replacement, from:); end
+
   sig { overridable.params(annotation: ::Spoom::RBS::Annotation, is_known: T::Boolean).void }
   def rewrite_annotation(annotation, is_known:); end
 
@@ -3542,6 +3548,9 @@ class Spoom::Sorbet::Translate::RBSCommentsToSorbetSigs::HumanReadableTranslator
   end
   def insert_type_member(type_member, parent_node:, insert_pos:); end
 
+  sig { override.params(replacement: ::String, from: ::Spoom::RBS::Comment).returns(::String) }
+  def preserve_comments(replacement, from:); end
+
   sig { override.params(signature: ::Spoom::RBS::Signature).void }
   def rewrite_discarded_overload(signature); end
 

metadata

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