spoom 1.7.8 → 1.7.10

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: aedf28669e780fce835616cbafcd7e45183d0cd474127dc26c1e9d169f3b4920
-  data.tar.gz: 5ac37ac73623a9158a7ee6d5f60aa93f46d83140fa718129c4fa73fc15ba85f4
+  metadata.gz: 82dc04cf069a738410f097150bff4d94af38dc6f7eefca31c368596eaf138da0
+  data.tar.gz: ea4046ff175a5c05eb85dc8cc22b6cb88f294d63b378b88a790f6bd4d92bfaff
 SHA512:
-  metadata.gz: c309dba40798848147342ffd5c9c4657ce77e8e724d6ece2ceb4851ab8f4c21b432c4684845d1042a81937d52d6cbb47f6b27f3b6440f091e87ddb6c8e8e4077
-  data.tar.gz: aa5e4e6c8021cc62b4147ef76ff6350c3917838c154d7fdf3ce5ebcf2f54f733bc33bf4caff33ef904a6ef58a8e2b8c436996879982639e7c324110787aa343e
+  metadata.gz: a6c72f54e3398d0d599b92d5c266bdea3db2ee78b10151bf9a5644f2679d0778ecef4cfce105bb8dd284947e6c737ff194599c2e72ab7894dd0122466034c553
+  data.tar.gz: ed0df1194a93939bbb4117efbc3218d9f18d079cd2dd6b704579ba8e4c78f6f5f8a58b02072dc99bd19870eeaed0bc449ee70ea5c965e152685239b801d97c99

data/lib/spoom/bundler_helper.rb

@@ -0,0 +1,33 @@
+# typed: strict
+# frozen_string_literal: true
+
+module Spoom
+  module BundlerHelper
+    extend T::Sig
+
+    class << self
+      # Generate a gem requirement for the given gem name, using that gem's version in the "real" current bundle.
+      #
+      # This ensures that any child Spoom::Contexts use predictable gem versions,
+      # without having to manually specify them and bump them to stay in sync with Spoom's real Gemfile.
+      #
+      # Given `"foo"`, returns a string like 'gem "foo", "= 1.2.3"', suitable for inserting into a Gemfile.
+      #: (String) -> String
+      def gem_requirement_from_real_bundle(gem_name)
+        specs = Bundler.load.gems[gem_name]
+
+        if specs.nil? || specs.empty?
+          raise "Did not find gem #{gem_name.inspect} in the current bundle"
+        elsif specs.count > 1
+          raise <<~MSG
+            Found multiple versions of #{gem_name.inspect} in the current bundle:
+            #{specs.sort_by(&:version).map { |spec| "  - #{spec.name} #{spec.version}" }.join("\n")}
+          MSG
+        else
+          spec = specs.first
+          %(gem "#{spec.name}", "= #{spec.version}")
+        end
+      end
+    end
+  end
+end

data/lib/spoom/cli/srb/sigs.rb

@@ -1,6 +1,8 @@
 # typed: true
 # frozen_string_literal: true
 
+require "spoom/bundler_helper"
+
 module Spoom
   module Cli
     module Srb
@@ -142,12 +144,14 @@ module Spoom
           # Now we create a new context to import our modified gem and run tapioca
           say("Running Tapioca...")
           tapioca_context = Spoom::Context.mktmp!
-          tapioca_context.write!("Gemfile", <<~RB)
+          tapioca_context.write_gemfile!(<<~GEMFILE)
             source "https://rubygems.org"
 
-            gem "tapioca"
+            #{Spoom::BundlerHelper.gem_requirement_from_real_bundle("rbs")}
+            #{Spoom::BundlerHelper.gem_requirement_from_real_bundle("tapioca")}
+
             gem "#{spec.name}", path: "#{copy_context.absolute_path}"
-          RB
+          GEMFILE
           exec(tapioca_context, "bundle install")
           exec(tapioca_context, "bundle exec tapioca gem #{spec.name} --no-doc --no-loc --no-file-header")
 

data/lib/spoom/context/bundle.rb

@@ -48,7 +48,7 @@ module Spoom
         return {} unless file?("Gemfile.lock")
 
         parser = Bundler::LockfileParser.new(read_gemfile_lock)
-        parser.specs.map { |spec| [spec.name, spec] }.to_h
+        parser.specs.to_h { |spec| [spec.name, spec] }
       end
 
       # Get `gem` version from the `Gemfile.lock` content

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/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/poset.rb

@@ -119,7 +119,7 @@ module Spoom
             dot << "  \"#{value}\" -> \"#{to}\";\n"
           end
         end
-        if transitive # rubocop:disable Style/Next
+        if transitive
           element.ancestors.each do |ancestor|
             dot << "  \"#{value}\" -> \"#{ancestor}\" [style=dotted];\n"
           end

data/lib/spoom/rbs.rb

@@ -70,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)
@@ -274,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/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/version.rb

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

data/rbi/spoom.rbi

@@ -6,8 +6,15 @@
 
 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
+
+module Spoom::BundlerHelper
+  class << self
+    sig { params(gem_name: ::String).returns(::String) }
+    def gem_requirement_from_real_bundle(gem_name); end
   end
 end
 
@@ -2584,6 +2591,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 +2901,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 +2923,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.8
+  version: 1.7.10
 platform: ruby
 authors:
 - Alexandre Terrasa
@@ -162,6 +162,7 @@ files:
 - exe/spoom
 - lib/spoom.rb
 - lib/spoom/backtrace_filter/minitest.rb
+- lib/spoom/bundler_helper.rb
 - lib/spoom/cli.rb
 - lib/spoom/cli/config.rb
 - lib/spoom/cli/deadcode.rb