Refactor parse_ruby to always attach & return comments

Author: KaanOzkan

lib/spoom/deadcode/index.rb

@@ -49,7 +49,7 @@ def index_erb(erb, file:, plugins: [])
 
       #: (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)

lib/spoom/parse.rb

@@ -7,26 +7,8 @@ module Spoom
   class ParseError < Error; end
 
   class << self
-    #: (String ruby, file: String, ?comments: bool) -> Prism::Node
-    def parse_ruby(ruby, file:, comments: false)
-      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.value
-    end
-
     #: (String ruby, file: String) -> [Prism::Node, Array[Prism::Comment]]
-    def parse_ruby_with_comments(ruby, file:)
+    def parse_ruby(ruby, file:)
       result = Prism.parse(ruby)
 
       unless result.success?

lib/spoom/sorbet/metrics/code_metrics_visitor.rb

@@ -13,7 +13,7 @@ def collect_code_metrics(files)
             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

lib/spoom/sorbet/translate/rbs_comments_to_sorbet_sigs.rb

@@ -349,7 +349,8 @@ def apply_type_aliases(comments)
             )
 
             @rewriter << Source::Delete.new(from, to)
-            @rewriter << Source::Insert.new(insert_pos, "#{indent}#{alias_name} = T.type_alias { #{sorbet_type.to_rbi} }\n")
+            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

lib/spoom/sorbet/translate/translator.rb

@@ -19,7 +19,7 @@ def initialize(ruby_contents, file:)
             ruby_contents.encode("UTF-8")
           end #: String
 
-          node, comments = Spoom.parse_ruby_with_comments(ruby_contents, file: file)
+          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]

rbi/spoom.rbi

@@ -6,11 +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_with_comments(ruby, file:); end
+    def parse_ruby(ruby, file:); end
   end
 end
 

test/spoom/model/builder_test.rb

@@ -464,7 +464,7 @@ def m1; end
       #: (String rb) -> Model
       def model(rb)
         file = "foo.rb"
-        node = Spoom.parse_ruby(rb, file: file, comments: true)
+        node, _ = Spoom.parse_ruby(rb, file: file)
         model = Model.new
         builder = Builder.new(model, file)
         builder.visit(node)

test/spoom/model/model_test.rb

@@ -104,7 +104,7 @@ module E; end
 
       #: (String rb) -> Model
       def model(rb)
-        node = Spoom.parse_ruby(rb, file: "foo.rb", comments: true)
+        node, _ = Spoom.parse_ruby(rb, file: "foo.rb")
 
         model = Model.new
         builder = Builder.new(model, "foo.rb")

test/spoom/model/namespace_visitor_test.rb

@@ -101,7 +101,7 @@ module ::M9::M10; end
 
       #: (String rb) -> Hash[String, String]
       def namespaces_for_locs(rb)
-        node = Spoom.parse_ruby(rb, file: "foo.rb")
+        node, _ = Spoom.parse_ruby(rb, file: "foo.rb")
 
         visitor = NamespacesForLocs.new
         visitor.visit(node)

test/spoom/model/references_visitor_test.rb

@@ -296,7 +296,7 @@ def test_visit_method_operators
       private
 
       def visit(code)
-        node = Spoom.parse_ruby(code, file: "-")
+        node, _ = Spoom.parse_ruby(code, file: "-")
 
         v = ReferencesVisitor.new("-")
         v.visit(node)