spoom 1.7.14 → 1.7.16

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 7e36809d27f631413357c7b2287d7c51de3b8ed7d17ed7da03d4943bed071b23
-  data.tar.gz: b299e3da2929b3a80b1466566e22b207ddceeab71f8ee98ccbc85d259f39fcf8
+  metadata.gz: 2110b75c9f1cfaf75e50c901f26af66d149f2a6353a22ee2154062f24f808472
+  data.tar.gz: 1f8daac5e4e94b7b135ed0b2d7dafb701dcf338302f337982ced3e6a32aa65fa
 SHA512:
-  metadata.gz: c39b635f9e3b26ca6bfa42ae4d89758d83e7f5c06bc4b7e263dae5f6b3b3debd7845e6cf90fdf54b854b1a8019957bc662dc36a05f2e560f6bb7e65a0dc224ba
-  data.tar.gz: f1ec06e214fc1f98ceb3915d659fe745951515e2edbd16219ebe1f77cb4d3ab79a28409b352dc35f92f9c9dbe85dcf176e696d7b1d48eae7bd665f21f12f997e
+  metadata.gz: bb98e214157092a61b830ce8e5836b1bc9c304d902b2886e10ab52c753febd6c7233142a509b461b26ee9c1c1150bd8346b02370c031bda68a6c555b2bc1c128
+  data.tar.gz: 6b3b0ec9bbc739161a4c642084aa1edcae82cf9293e20e3997656cfa2108eff1c32369c5d4225c6ebdd0716cb030eaec7c749cfa623273cdb59dce848f5ab039

data/Gemfile

@@ -12,5 +12,6 @@ group :development do
   gem "debug"
   gem "rubocop-shopify", require: false
   gem "rubocop-sorbet", require: false
+  gem "rubocop-minitest", require: false
   gem "tapioca", require: false
 end

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

@@ -60,7 +60,7 @@ module Spoom
             .sort_by { |_key, value| -value }
             .each do |key, value|
               say(" * #{key}: `#{value}`")
-          end
+            end
         end
       end
     end

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

@@ -213,8 +213,10 @@ module Spoom
                 contents = contents.force_encoding(encoding)
               end
 
-              contents = block.call(file, contents)
-              File.write(file, contents)
+              new_contents = block.call(file, contents)
+              next if new_contents == contents
+
+              File.write(file, new_contents)
               transformed_count += 1
             rescue RBI::Error => error
               say_warning("Can't parse #{file}: #{error.message}")

data/lib/spoom/context/bundle.rb

@@ -10,12 +10,16 @@ module Spoom
       #: -> String?
       def read_gemfile
         read("Gemfile")
+      rescue Errno::ENOENT, Errno::EACCES
+        nil
       end
 
       # Read the contents of the Gemfile.lock in this context directory
       #: -> String?
       def read_gemfile_lock
         read("Gemfile.lock")
+      rescue Errno::ENOENT, Errno::EACCES
+        nil
       end
 
       # Set the `contents` of the Gemfile in this context directory
@@ -45,9 +49,10 @@ module Spoom
 
       #: -> Hash[String, Bundler::LazySpecification]
       def gemfile_lock_specs
-        return {} unless file?("Gemfile.lock")
+        lockfile = read_gemfile_lock
+        return {} unless lockfile
 
-        parser = Bundler::LockfileParser.new(read_gemfile_lock)
+        parser = Bundler::LockfileParser.new(lockfile)
         parser.specs.to_h { |spec| [spec.name, spec] }
       end
 

data/lib/spoom/context/sorbet.rb

@@ -42,10 +42,15 @@ module Spoom
           sorbet_bin: sorbet_bin,
           capture_err: capture_err,
         )
-        return unless file?(metrics_file)
 
         metrics_path = absolute_path_to(metrics_file)
-        metrics = Spoom::Sorbet::Metrics::MetricsFileParser.parse_file(metrics_path)
+
+        begin
+          metrics = Spoom::Sorbet::Metrics::MetricsFileParser.parse_file(metrics_path)
+        rescue Errno::ENOENT, Errno::EACCES
+          return
+        end
+
         remove!(metrics_file)
         metrics
       end

data/lib/spoom/file_collector.rb

@@ -33,11 +33,17 @@ module Spoom
 
       return if excluded_path?(path)
 
-      if File.file?(path)
+      begin
+        stat = File.stat(path)
+      rescue Errno::ENOENT, Errno::EACCES
+        return
+      end
+
+      if stat.file?
         visit_file(path)
-      elsif File.directory?(path)
+      elsif stat.directory?
         visit_directory(path)
-      else # rubocop:disable Style/EmptyElse
+      else
         # Ignore aliases, sockets, etc.
       end
     end

data/lib/spoom/rbs.rb

@@ -105,7 +105,7 @@ module Spoom
               location = location.join(continuation_comment.location)
             end
             continuation_comments.clear
-            res.signatures << Signature.new(string, location)
+            res.signatures.prepend(Signature.new(string, location))
           elsif string.start_with?("#|")
             continuation_comments << comment
           end

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

@@ -10,6 +10,7 @@ module Spoom
         DEFAULT_PREFIX = "ruby_typer.unknown."
 
         class << self
+          # Raises if `path` doesn't point to a valid file that we have access to (see `File.read` for details)
           #: (String path, ?String prefix) -> Hash[String, Integer]
           def parse_file(path, prefix = DEFAULT_PREFIX)
             parse_string(File.read(path), prefix)

data/lib/spoom/sorbet/sigils.rb

@@ -44,6 +44,13 @@ module Spoom
           SIGIL_REGEXP.match(content)&.[](1)
         end
 
+        # returns true if the passed content contains a valid sigil
+        #: (String content) -> bool
+        def contains_valid_sigil?(content)
+          strictness = strictness_in_content(content)
+          !!strictness && valid_strictness?(strictness)
+        end
+
         # returns a string which is the passed content but with the sigil updated to a new strictness
         #: (String content, String new_strictness) -> String
         def update_sigil(content, new_strictness)

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

@@ -7,11 +7,46 @@ module Spoom
       class RBSCommentsToSorbetSigs < Translator
         include Spoom::RBS::ExtractRBSComments
 
-        #: (String, file: String, ?max_line_length: Integer?) -> void
-        def initialize(ruby_contents, file:, max_line_length: nil)
+        RBS_ANNOTATION_MARKERS = [
+          "# @abstract",
+          "# @interface",
+          "# @sealed",
+          "# @final",
+          "# @requires_ancestor:",
+          "# @override",
+          "# @overridable",
+          "# @without_runtime",
+        ].freeze #: Array[String]
+        RBS_REWRITE_PATTERN = Regexp.union(["#:", "#|", *RBS_ANNOTATION_MARKERS]).freeze #: Regexp
+        private_constant :RBS_ANNOTATION_MARKERS, :RBS_REWRITE_PATTERN
+
+        ALLOWED_OVERLOAD_STRATEGIES = [:translate_all, :translate_last, :raise].freeze #: Array[Symbol]
+
+        class << self
+          #: (String source) -> bool
+          def contains_rbs_syntax?(source)
+            Sigils.contains_valid_sigil?(source) && source.match?(RBS_REWRITE_PATTERN)
+          end
+
+          #: (String ruby_contents, file: String, ?max_line_length: Integer?, ?overloads_strategy: Symbol) -> String
+          def rewrite_if_needed(ruby_contents, file:, max_line_length: nil, overloads_strategy: :translate_all)
+            return ruby_contents unless contains_rbs_syntax?(ruby_contents)
+
+            new(ruby_contents, file:, max_line_length:, overloads_strategy:).rewrite
+          end
+        end
+
+        #: (String, file: String, ?max_line_length: Integer?, ?overloads_strategy: Symbol) -> void
+        def initialize(ruby_contents, file:, max_line_length: nil, overloads_strategy: :translate_all)
           super(ruby_contents, file: file)
 
+          unless ALLOWED_OVERLOAD_STRATEGIES.include?(overloads_strategy)
+            raise ArgumentError, "Unknown overloads_strategy: #{overloads_strategy.inspect}. " \
+              "Must be one of: #{ALLOWED_OVERLOAD_STRATEGIES.map(&:inspect).join(", ")}"
+          end
+
           @max_line_length = max_line_length
+          @overloads_strategy = overloads_strategy
         end
 
         # @override
@@ -80,7 +115,13 @@ module Spoom
 
           return if comments.signatures.empty?
 
-          comments.signatures.each do |signature|
+          signatures = apply_overloads_strategy(
+            comments.signatures,
+            method_name: node.message.to_s,
+            location: "#{@file}:#{node.location.start_line}",
+          )
+
+          signatures.each do |signature|
             attr_type = ::RBS::Parser.parse_type(signature.string)
             sig = RBI::Sig.new
 
@@ -116,11 +157,17 @@ module Spoom
           return if comments.empty?
           return if comments.signatures.empty?
 
+          signatures = apply_overloads_strategy(
+            comments.signatures,
+            method_name: def_node.name.to_s,
+            location: "#{@file}:#{def_node.location.start_line}",
+          )
+
           builder = RBI::Parser::TreeBuilder.new(@ruby_contents, comments: [], file: @file)
           builder.visit(def_node)
           rbi_node = builder.tree.nodes.first #: as RBI::Method
 
-          comments.signatures.each do |signature|
+          signatures.each do |signature|
             begin
               method_type = ::RBS::Parser.parse_method_type(signature.string)
             rescue ::RBS::ParsingError
@@ -153,6 +200,29 @@ module Spoom
           end
         end
 
+        #: (Array[RBS::Signature], method_name: String, location: String) -> Array[RBS::Signature]
+        def apply_overloads_strategy(signatures, method_name:, location:)
+          return signatures if signatures.size <= 1
+
+          case @overloads_strategy
+          when :translate_all
+            signatures
+          when :translate_last
+            kept = signatures.last #: as RBS::Signature
+            others = signatures[0...-1] #: as !nil
+
+            # Delete all the signatures we didn't keep
+            others.each do |signature|
+              from = adjust_to_line_start(signature.location.start_offset)
+              to = adjust_to_line_end(signature.location.end_offset)
+              @rewriter << Source::Delete.new(from, to)
+            end
+            [kept]
+          else # :raise
+            raise Error, "Method `#{method_name}` at #{location} has multiple overloaded signatures"
+          end
+        end
+
         #: (Prism::ClassNode | Prism::ModuleNode | Prism::SingletonClassNode) -> void
         def apply_class_annotations(node)
           comments = node_rbs_comments(node)

data/lib/spoom/sorbet/translate.rb

@@ -53,9 +53,14 @@ module Spoom
 
         # Converts all the RBS comments in the given Ruby code to `sig` nodes.
         # It also handles type members and class annotations.
-        #: (String ruby_contents, file: String, ?max_line_length: Integer?) -> String
-        def rbs_comments_to_sorbet_sigs(ruby_contents, file:, max_line_length: nil)
-          RBSCommentsToSorbetSigs.new(ruby_contents, file: file, max_line_length: max_line_length).rewrite
+        #: (String ruby_contents, file: String, ?max_line_length: Integer?, ?overloads_strategy: Symbol) -> String
+        def rbs_comments_to_sorbet_sigs(ruby_contents, file:, max_line_length: nil, overloads_strategy: :translate_all)
+          RBSCommentsToSorbetSigs.rewrite_if_needed(
+            ruby_contents,
+            file: file,
+            max_line_length: max_line_length,
+            overloads_strategy: overloads_strategy,
+          )
         end
 
         # Converts all `T.let` and `T.cast` nodes to RBS comments in the given Ruby code.

data/lib/spoom/version.rb

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

data/rbi/spoom.rbi

@@ -2823,6 +2823,9 @@ module Spoom::Sorbet::Sigils
     sig { params(path_list: T::Array[::String], new_strictness: ::String).returns(T::Array[::String]) }
     def change_sigil_in_files(path_list, new_strictness); end
 
+    sig { params(content: ::String).returns(T::Boolean) }
+    def contains_valid_sigil?(content); end
+
     sig { params(path: T.any(::Pathname, ::String)).returns(T.nilable(::String)) }
     def file_strictness(path); end
 
@@ -2851,8 +2854,15 @@ Spoom::Sorbet::Sigils::VALID_STRICTNESS = T.let(T.unsafe(nil), Array)
 
 module Spoom::Sorbet::Translate
   class << self
-    sig { params(ruby_contents: ::String, file: ::String, max_line_length: T.nilable(::Integer)).returns(::String) }
-    def rbs_comments_to_sorbet_sigs(ruby_contents, file:, max_line_length: T.unsafe(nil)); end
+    sig do
+      params(
+        ruby_contents: ::String,
+        file: ::String,
+        max_line_length: T.nilable(::Integer),
+        overloads_strategy: ::Symbol
+      ).returns(::String)
+    end
+    def rbs_comments_to_sorbet_sigs(ruby_contents, file:, max_line_length: T.unsafe(nil), overloads_strategy: T.unsafe(nil)); end
 
     sig do
       params(
@@ -2890,8 +2900,15 @@ class Spoom::Sorbet::Translate::Error < ::Spoom::Error; end
 class Spoom::Sorbet::Translate::RBSCommentsToSorbetSigs < ::Spoom::Sorbet::Translate::Translator
   include ::Spoom::RBS::ExtractRBSComments
 
-  sig { params(ruby_contents: ::String, file: ::String, max_line_length: T.nilable(::Integer)).void }
-  def initialize(ruby_contents, file:, max_line_length: T.unsafe(nil)); end
+  sig do
+    params(
+      ruby_contents: ::String,
+      file: ::String,
+      max_line_length: T.nilable(::Integer),
+      overloads_strategy: ::Symbol
+    ).void
+  end
+  def initialize(ruby_contents, file:, max_line_length: T.unsafe(nil), overloads_strategy: T.unsafe(nil)); end
 
   sig { override.params(node: ::Prism::CallNode).void }
   def visit_call_node(node); end
@@ -2927,6 +2944,15 @@ 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 do
+    params(
+      signatures: T::Array[::Spoom::RBS::Signature],
+      method_name: ::String,
+      location: ::String
+    ).returns(T::Array[::Spoom::RBS::Signature])
+  end
+  def apply_overloads_strategy(signatures, method_name:, location:); end
+
   sig { params(comments: T::Array[::Prism::Comment]).void }
   def apply_type_aliases(comments); end
 
@@ -2938,8 +2964,27 @@ class Spoom::Sorbet::Translate::RBSCommentsToSorbetSigs < ::Spoom::Sorbet::Trans
 
   sig { params(node: ::Prism::CallNode).void }
   def visit_attr(node); end
+
+  class << self
+    sig { params(source: ::String).returns(T::Boolean) }
+    def contains_rbs_syntax?(source); end
+
+    sig do
+      params(
+        ruby_contents: ::String,
+        file: ::String,
+        max_line_length: T.nilable(::Integer),
+        overloads_strategy: ::Symbol
+      ).returns(::String)
+    end
+    def rewrite_if_needed(ruby_contents, file:, max_line_length: T.unsafe(nil), overloads_strategy: T.unsafe(nil)); end
+  end
 end
 
+Spoom::Sorbet::Translate::RBSCommentsToSorbetSigs::ALLOWED_OVERLOAD_STRATEGIES = T.let(T.unsafe(nil), Array)
+Spoom::Sorbet::Translate::RBSCommentsToSorbetSigs::RBS_ANNOTATION_MARKERS = T.let(T.unsafe(nil), Array)
+Spoom::Sorbet::Translate::RBSCommentsToSorbetSigs::RBS_REWRITE_PATTERN = T.let(T.unsafe(nil), Regexp)
+
 class Spoom::Sorbet::Translate::SorbetAssertionsToRBSComments < ::Spoom::Sorbet::Translate::Translator
   sig do
     params(

metadata

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