spoom 1.8.4 → 1.8.6

data/lib/spoom/backtrace_filter/minitest.rb

@@ -12,7 +12,7 @@ module Spoom
       #: (Array[String]? bt) -> Array[String]
       def filter(bt)
         super.select do |line|
-          SORBET_PATHS.none? { |path| line.include?(path) }
+          !SORBET_PATHS.intersect?(line)
         end
       end
     end

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

@@ -26,6 +26,10 @@ module Spoom
         option :translate_generics, type: :boolean, desc: "Translate generics", default: false
         option :translate_helpers, type: :boolean, desc: "Translate helpers", default: false
         option :translate_abstract_methods, type: :boolean, desc: "Translate abstract methods", default: false
+        option :erase_generic_types,
+          type: :boolean,
+          desc: "Drop generic types when translating from RBS to RBI",
+          default: false
         def translate(*paths)
           from = options[:from]
           to = options[:to]
@@ -70,6 +74,7 @@ module Spoom
                 contents,
                 file: file,
                 max_line_length: max_line_length,
+                erase_generic_types: options[:erase_generic_types],
               )
             end
           end

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

@@ -11,7 +11,7 @@ module Spoom
 
         SORT_CODE = "code"
         SORT_LOC = "loc"
-        SORT_ENUM = [SORT_CODE, SORT_LOC]
+        SORT_ENUM = [SORT_CODE, SORT_LOC].freeze
 
         DEFAULT_FORMAT = "%C - %F:%L: %M"
 

data/lib/spoom/cli.rb

@@ -79,7 +79,7 @@ module Spoom
 
       SORT_CODE = "code"
       SORT_LOC = "loc"
-      SORT_ENUM = [SORT_CODE, SORT_LOC]
+      SORT_ENUM = [SORT_CODE, SORT_LOC].freeze
 
       desc "tc", "Run Sorbet and parses its output"
       option :limit, type: :numeric, aliases: :l, desc: "Limit displayed errors"

data/lib/spoom/coverage/report.rb

@@ -26,14 +26,14 @@ module Spoom
       end
 
       #: -> Binding
-      def get_binding # rubocop:disable Naming/AccessorMethodName
+      def get_binding
         binding
       end
     end
 
     # @abstract
     class Page < Template
-      TEMPLATE = "#{Spoom::SPOOM_PATH}/templates/page.erb" #: String
+      TEMPLATE = "#{Spoom::SPOOM_PATH}/templates/page.erb".freeze #: String
 
       #: String
       attr_reader :title
@@ -80,7 +80,7 @@ module Spoom
 
     module Cards
       class Card < Template
-        TEMPLATE = "#{Spoom::SPOOM_PATH}/templates/card.erb" #: String
+        TEMPLATE = "#{Spoom::SPOOM_PATH}/templates/card.erb".freeze #: String
 
         #: String?
         attr_reader :title, :body
@@ -96,7 +96,7 @@ module Spoom
       # @abstract
       class Erb < Card
         #: -> void
-        def initialize; end # rubocop:disable Lint/MissingSuper
+        def initialize; end
 
         # @override
         #: -> String
@@ -110,7 +110,7 @@ module Spoom
       end
 
       class Snapshot < Card
-        TEMPLATE = "#{Spoom::SPOOM_PATH}/templates/card_snapshot.erb" #: String
+        TEMPLATE = "#{Spoom::SPOOM_PATH}/templates/card_snapshot.erb".freeze #: String
 
         #: Coverage::Snapshot
         attr_reader :snapshot
@@ -208,7 +208,7 @@ module Spoom
 
       class SorbetIntro < Erb
         #: (?sorbet_intro_commit: String?, ?sorbet_intro_date: Time?) -> void
-        def initialize(sorbet_intro_commit: nil, sorbet_intro_date: nil) # rubocop:disable Lint/MissingSuper
+        def initialize(sorbet_intro_commit: nil, sorbet_intro_date: nil)
           @sorbet_intro_commit = sorbet_intro_commit
           @sorbet_intro_date = sorbet_intro_date
         end

data/lib/spoom/deadcode/erb.rb

@@ -40,6 +40,15 @@ module Spoom
         super
       end
 
+      #: -> String
+      def wrapped_src
+        <<~RUBY
+          def __spoom_deadcode_erb_template__
+            #{src}
+          end
+        RUBY
+      end
+
       private
 
       # @override
@@ -50,32 +59,34 @@ module Spoom
         if text == "\n"
           @newline_pending += 1
         else
-          src << bufvar << ".safe_append='"
-          src << "\n" * @newline_pending if @newline_pending > 0
-          src << text.gsub(/['\\]/, '\\\\\&')
-          src << "'.freeze;"
-
+          with_buffer do
+            src << ".safe_append='"
+            src << "\n" * @newline_pending if @newline_pending > 0
+            src << text.gsub(/['\\]/, '\\\\\&') << @text_end
+          end
           @newline_pending = 0
         end
       end
 
-      BLOCK_EXPR = /\s*((\s+|\))do|\{)(\s*\|[^|]*\|)?\s*\Z/
+      BLOCK_EXPR = /((\s|\))do|\{)(\s*\|[^|]*\|)?\s*\Z/
 
       # @override
       #: (untyped indicator, untyped code) -> void
       def add_expression(indicator, code)
         flush_newline_if_pending(src)
 
-        src << bufvar << if (indicator == "==") || @escape
-          ".safe_expr_append="
-        else
-          ".append="
-        end
+        with_buffer do
+          src << if (indicator == "==") || @escape
+            ".safe_expr_append="
+          else
+            ".append="
+          end
 
-        if BLOCK_EXPR.match?(code)
-          src << " " << code
-        else
-          src << "(" << code << ");"
+          if BLOCK_EXPR.match?(code)
+            src << " " << code
+          else
+            src << "(" << code << ")"
+          end
         end
       end
 
@@ -96,7 +107,7 @@ module Spoom
       #: (untyped src) -> void
       def flush_newline_if_pending(src)
         if @newline_pending > 0
-          src << bufvar << ".safe_append='#{"\n" * @newline_pending}'.freeze;"
+          with_buffer { src << ".safe_append='#{"\n" * @newline_pending}" << @text_end }
           @newline_pending = 0
         end
       end

data/lib/spoom/deadcode/index.rb

@@ -44,7 +44,7 @@ module Spoom
 
       #: (String erb, file: String, ?plugins: Array[Plugins::Base]) -> void
       def index_erb(erb, file:, plugins: [])
-        index_ruby(Deadcode::ERB.new(erb).src, file: file, plugins: plugins)
+        index_ruby(Deadcode::ERB.new(erb).wrapped_src, file: file, plugins: plugins)
       end
 
       #: (String rb, file: String, ?plugins: Array[Plugins::Base]) -> void
@@ -55,6 +55,11 @@ module Spoom
         model_builder = Model::Builder.new(@model, file)
         model_builder.visit(node)
 
+        # Ignore the special synthetic method generated by the ERB engine
+        if (spoom_erb_wrapper = @model.symbols["__spoom_deadcode_erb_template__"])
+          @ignored.merge(spoom_erb_wrapper.definitions)
+        end
+
         # Index references
         refs_visitor = Model::ReferencesVisitor.new(file)
         refs_visitor.visit(node)

data/lib/spoom/deadcode/plugins/active_support.rb

@@ -16,7 +16,7 @@ module Spoom
           "before_teardown",
         )
 
-        SETUP_AND_TEARDOWN_METHODS = ["setup", "teardown"] #: Array[String]
+        SETUP_AND_TEARDOWN_METHODS = ["setup", "teardown"].freeze #: Array[String]
 
         # @override
         #: (Send send) -> void

data/lib/spoom/deadcode/remover.rb

@@ -117,6 +117,7 @@ module Spoom
                Prism::ConstantPathAndWriteNode, Prism::ConstantPathOrWriteNode
             # Nesting node is an assign, it means only one constant is assigned on the line
             # so we can remove the whole assign
+            remove_constant_visibility_call(context)
             delete_node_and_comments_and_sigs(context)
             return
           end
@@ -127,6 +128,7 @@ module Spoom
           if parent_node.is_a?(Prism::ConstantWriteNode)
             # Nesting node is an assign, it means only one constant is assigned on the line
             # so we can remove the whole assign
+            remove_constant_visibility_call(parent_context)
             delete_node_and_comments_and_sigs(parent_context)
             return
           elsif parent_node.is_a?(Prism::MultiWriteNode) && parent_node.lefts.size == 1
@@ -190,6 +192,64 @@ module Spoom
           end
         end
 
+        # A dead constant is often followed by a `private_constant`/`public_constant` call naming it.
+        # That call references the now-removed constant (a load-time `NameError` if left behind), so
+        # remove the reference too: delete the whole call when the constant is its only argument, or
+        # drop just that symbol when the call lists several constants.
+        #: (NodeContext context) -> void
+        def remove_constant_visibility_call(context)
+          node = context.node
+          return unless node.is_a?(Prism::ConstantWriteNode)
+
+          name = node.name
+          call = context.next_nodes.find { |sibling| constant_visibility_call?(sibling, name) }
+          return unless call.is_a?(Prism::CallNode)
+
+          call_context = NodeContext.new(@old_source, @node_context.comments, call, context.nesting)
+          arguments = call.arguments&.arguments #: Array[Prism::Node]?
+          if arguments && arguments.size > 1
+            delete_symbol_argument(call_context, name)
+          else
+            delete_node_and_comments_and_sigs(call_context)
+          end
+        end
+
+        # Whether `node` is a bare `private_constant`/`public_constant` call listing `name`.
+        #: (Prism::Node node, Symbol name) -> bool
+        def constant_visibility_call?(node, name)
+          return false unless node.is_a?(Prism::CallNode)
+          return false unless node.receiver.nil?
+          return false unless node.name == :private_constant || node.name == :public_constant
+
+          arguments = node.arguments&.arguments
+          return false unless arguments
+
+          arguments.any? { |argument| argument.is_a?(Prism::SymbolNode) && argument.value == name.to_s }
+        end
+
+        # Drop the `:name` symbol from a `private_constant`/`public_constant` call that lists several
+        # constants, keeping the call and the other names intact.
+        #: (NodeContext context, Symbol name) -> void
+        def delete_symbol_argument(context, name)
+          arguments = T.cast(context.node, Prism::CallNode).arguments&.arguments
+          return unless arguments
+
+          index = arguments.index { |argument| argument.is_a?(Prism::SymbolNode) && argument.value == name.to_s }
+          return unless index
+
+          argument = arguments.fetch(index)
+          prev_argument = arguments[index - 1] if index.positive?
+          next_argument = arguments[index + 1]
+
+          if prev_argument && next_argument
+            replace_chars(prev_argument.location.end_offset, next_argument.location.start_offset, ", ")
+          elsif prev_argument
+            delete_chars(prev_argument.location.end_offset, argument.location.end_offset)
+          elsif next_argument
+            delete_chars(argument.location.start_offset, next_argument.location.start_offset)
+          end
+        end
+
         #: (NodeContext context) -> void
         def delete_attr_accessor(context)
           args_context = context.parent_context

data/lib/spoom/sorbet/errors.rb

@@ -53,7 +53,7 @@ module Spoom
           "Check out the README to learn how to build Sorbet in release mode.",
           "To forcibly silence this error, either pass --silence-dev-message,",
           "or set SORBET_SILENCE_DEV_MESSAGE=1 in your shell environment.",
-        ] #: Array[String]
+        ].freeze #: Array[String]
 
         class << self
           # Used when only Sorbet errors are needed and leading stderr warnings can be ignored.

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

@@ -283,7 +283,7 @@ module Spoom
         24 => "event",
         25 => "operator",
         26 => "type_parameter",
-      } #: Hash[Integer, String]
+      }.freeze #: Hash[Integer, String]
     end
 
     class SymbolPrinter < Printer

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

@@ -73,6 +73,13 @@ module Spoom
         # @override
         #: (Prism::ClassNode) -> void
         def visit_class_node(node)
+          case node.superclass&.slice
+          when /^(::)?T::Struct$/
+            @counters.increment("t_structs")
+          when /^(::)?T::Enum$/
+            @counters.increment("t_enums")
+          end
+
           visit_scope(node) do
             super
           end

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

@@ -26,7 +26,8 @@ module Spoom
 
             @overloads_strategy = options.overloads_strategy #: Symbol
             @translate_abstract_methods = options.translate_abstract_methods #: bool
-            @type_translator = RBI::RBS::TypeTranslator.new #: RBI::RBS::TypeTranslator
+            @options = options #: Options
+            @type_translator = RBI::RBS::TypeTranslator.new(options: options.rbi_options) #: RBI::RBS::TypeTranslator
           end
 
           # @override
@@ -163,7 +164,7 @@ module Spoom
                 next
               end
 
-              translator = RBI::RBS::MethodTypeTranslator.new(rbi_node)
+              translator = RBI::RBS::MethodTypeTranslator.new(rbi_node, options: @options.rbi_options)
 
               begin
                 translator.visit(method_type)
@@ -273,6 +274,18 @@ module Spoom
                 rewrite_type_params_signature(signature, type_params:)
                 next if type_params.empty?
 
+                if @options.erase_generic_types
+                  type_params.each do |type_param|
+                    insert_type_member(
+                      "#{type_param.name} = ::T.type_alias { ::T.anything }",
+                      parent_node: node,
+                      insert_pos:,
+                    )
+                  end
+
+                  next
+                end
+
                 unless already_extends?(node, /^(::)?T::Generic$/)
                   extend_with("T::Generic", into: node, at: insert_pos)
                 end
@@ -462,7 +475,7 @@ module Spoom
               )
 
               @rewriter << Source::Delete.new(from, to)
-              content = "#{indent}#{alias_name} = T.type_alias { #{sorbet_type.to_rbi} }\n"
+              content = "#{indent}#{alias_name} = ::T.type_alias { #{sorbet_type.to_rbi} }\n"
               content = pad_out_line_count(of: content, to_height_of: type_alias)
               @rewriter << Source::Insert.new(insert_pos, content)
             rescue ::RBS::ParsingError, ::RBI::Error

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

@@ -44,6 +44,12 @@ module Spoom
 
           ALLOWED_OVERLOAD_STRATEGIES = [:translate_all, :translate_last, :raise].freeze
 
+          #: bool
+          attr_reader :erase_generic_types
+
+          #: RBI::RBS::MethodTypeTranslator::Options
+          attr_reader :rbi_options
+
           #: BaseRBIFormat
           attr_reader :output_format
 
@@ -52,11 +58,13 @@ module Spoom
 
           #: (
           #|   ?overloads_strategy: Symbol,
+          #|   ?erase_generic_types: bool,
           #|   ?output_format: BaseRBIFormat,
           #|   ?translate_abstract_methods: bool,
           #| ) -> void
           def initialize(
             overloads_strategy: :translate_all,
+            erase_generic_types: false,
             output_format: HumanReadableRBIFormat.default,
             translate_abstract_methods: true
           )
@@ -66,6 +74,8 @@ module Spoom
             end
 
             @overloads_strategy = overloads_strategy
+            @erase_generic_types = erase_generic_types
+            @rbi_options = RBI::RBS::MethodTypeTranslator::Options.new(erase_generic_types:) #: RBI::RBS::MethodTypeTranslator::Options
             @output_format = output_format
             @translate_abstract_methods = translate_abstract_methods
 

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

@@ -28,17 +28,20 @@ module Spoom
           #|   String ruby_contents,
           #|   file: String,
           #|   ?max_line_length: Integer?,
-          #|   ?overloads_strategy: Symbol) -> String
+          #|   ?overloads_strategy: Symbol,
+          #|   ?erase_generic_types: bool) -> String
           def rewrite_if_needed(
             ruby_contents,
             file:,
             max_line_length: nil,
-            overloads_strategy: :translate_all
+            overloads_strategy: :translate_all,
+            erase_generic_types: false
           )
             return ruby_contents unless contains_rbs_syntax?(ruby_contents)
 
             options = Options.new(
               overloads_strategy:,
+              erase_generic_types:,
               output_format: HumanReadableRBIFormat.new(
                 max_line_length:,
               ),

data/lib/spoom/sorbet/translate.rb

@@ -59,13 +59,16 @@ 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?, ?overloads_strategy: Symbol) -> String
-        def rbs_comments_to_sorbet_sigs(ruby_contents, file:, max_line_length: nil, overloads_strategy: :translate_all)
+        #: (String ruby_contents, file: String, ?max_line_length: Integer?,
+        #| ?overloads_strategy: Symbol, ?erase_generic_types: bool) -> String
+        def rbs_comments_to_sorbet_sigs(ruby_contents, file:, max_line_length: nil, overloads_strategy: :translate_all,
+          erase_generic_types: false)
           RBSCommentsToSorbetSigs.rewrite_if_needed(
             ruby_contents,
             file: file,
             max_line_length: max_line_length,
             overloads_strategy: overloads_strategy,
+            erase_generic_types: erase_generic_types,
           )
         end
 

data/lib/spoom/version.rb

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

data/rbi/spoom.rbi

@@ -1024,6 +1024,9 @@ class Spoom::Deadcode::ERB < ::Erubi::Engine
   sig { params(input: T.untyped, properties: T.untyped).void }
   def initialize(input, properties = T.unsafe(nil)); end
 
+  sig { returns(::String) }
+  def wrapped_src; end
+
   private
 
   sig { override.params(code: T.untyped).void }
@@ -1497,6 +1500,9 @@ class Spoom::Deadcode::Remover::NodeRemover
 
   private
 
+  sig { params(node: ::Prism::Node, name: ::Symbol).returns(T::Boolean) }
+  def constant_visibility_call?(node, name); end
+
   sig { params(context: ::Spoom::Deadcode::Remover::NodeContext).void }
   def delete_attr_accessor(context); end
 
@@ -1512,6 +1518,9 @@ class Spoom::Deadcode::Remover::NodeRemover
   sig { params(context: ::Spoom::Deadcode::Remover::NodeContext).void }
   def delete_node_and_comments_and_sigs(context); end
 
+  sig { params(context: ::Spoom::Deadcode::Remover::NodeContext, name: ::Symbol).void }
+  def delete_symbol_argument(context, name); end
+
   sig do
     params(
       node: ::Prism::Node,
@@ -1524,6 +1533,9 @@ class Spoom::Deadcode::Remover::NodeRemover
   sig { params(def_node: ::Prism::DefNode).returns(T.nilable(::Spoom::Deadcode::Remover::NodeContext)) }
   def modifier_call_context(def_node); end
 
+  sig { params(context: ::Spoom::Deadcode::Remover::NodeContext).void }
+  def remove_constant_visibility_call(context); end
+
   sig { params(start_char: ::Integer, end_char: ::Integer, replacement: ::String).void }
   def replace_chars(start_char, end_char, replacement); end
 
@@ -2926,10 +2938,11 @@ module Spoom::Sorbet::Translate
         ruby_contents: ::String,
         file: ::String,
         max_line_length: T.nilable(::Integer),
-        overloads_strategy: ::Symbol
+        overloads_strategy: ::Symbol,
+        erase_generic_types: T::Boolean
       ).returns(::String)
     end
-    def rbs_comments_to_sorbet_sigs(ruby_contents, file:, max_line_length: T.unsafe(nil), overloads_strategy: T.unsafe(nil)); end
+    def rbs_comments_to_sorbet_sigs(ruby_contents, file:, max_line_length: T.unsafe(nil), overloads_strategy: T.unsafe(nil), erase_generic_types: T.unsafe(nil)); end
 
     sig do
       params(
@@ -3008,10 +3021,11 @@ module Spoom::Sorbet::Translate::RBSCommentsToSorbetSigs
         ruby_contents: ::String,
         file: ::String,
         max_line_length: T.nilable(::Integer),
-        overloads_strategy: ::Symbol
+        overloads_strategy: ::Symbol,
+        erase_generic_types: T::Boolean
       ).returns(::String)
     end
-    def rewrite_if_needed(ruby_contents, file:, max_line_length: T.unsafe(nil), overloads_strategy: T.unsafe(nil)); end
+    def rewrite_if_needed(ruby_contents, file:, max_line_length: T.unsafe(nil), overloads_strategy: T.unsafe(nil), erase_generic_types: T.unsafe(nil)); end
   end
 end
 
@@ -3238,11 +3252,15 @@ class Spoom::Sorbet::Translate::RBSCommentsToSorbetSigs::Options
   sig do
     params(
       overloads_strategy: ::Symbol,
+      erase_generic_types: T::Boolean,
       output_format: ::Spoom::Sorbet::Translate::RBSCommentsToSorbetSigs::BaseRBIFormat,
       translate_abstract_methods: T::Boolean
     ).void
   end
-  def initialize(overloads_strategy: T.unsafe(nil), output_format: T.unsafe(nil), translate_abstract_methods: T.unsafe(nil)); end
+  def initialize(overloads_strategy: T.unsafe(nil), erase_generic_types: T.unsafe(nil), output_format: T.unsafe(nil), translate_abstract_methods: T.unsafe(nil)); end
+
+  sig { returns(T::Boolean) }
+  def erase_generic_types; end
 
   sig { returns(::Spoom::Sorbet::Translate::RBSCommentsToSorbetSigs::BaseRBIFormat) }
   def output_format; end
@@ -3250,6 +3268,9 @@ class Spoom::Sorbet::Translate::RBSCommentsToSorbetSigs::Options
   sig { returns(::Symbol) }
   def overloads_strategy; end
 
+  sig { returns(::RBI::RBS::MethodTypeTranslator::Options) }
+  def rbi_options; end
+
   sig { returns(T::Boolean) }
   def translate_abstract_methods; end
 

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: spoom
 version: !ruby/object:Gem::Version
-  version: 1.8.4
+  version: 1.8.6
 platform: ruby
 authors:
 - Alexandre Terrasa
@@ -9,48 +9,6 @@ bindir: exe
 cert_chain: []
 date: 1980-01-02 00:00:00.000000000 Z
 dependencies:
-- !ruby/object:Gem::Dependency
-  name: bundler
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: 2.2.10
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: 2.2.10
-- !ruby/object:Gem::Dependency
-  name: minitest-reporters
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '0'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '0'
-- !ruby/object:Gem::Dependency
-  name: rake
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: 13.4.2
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: 13.4.2
 - !ruby/object:Gem::Dependency
   name: erubi
   requirement: !ruby/object:Gem::Requirement
@@ -85,14 +43,14 @@ dependencies:
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: 0.3.15
+        version: 0.4.1
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: 0.3.15
+        version: 0.4.1
 - !ruby/object:Gem::Dependency
   name: rbs
   requirement: !ruby/object:Gem::Requirement