spoom 1.5.4 → 1.6.0

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

@@ -5,8 +5,6 @@ module Spoom
   module Deadcode
     module Plugins
       class GraphQL < Base
-        extend T::Sig
-
         ignore_classes_inheriting_from(
           "GraphQL::Schema::Enum",
           "GraphQL::Schema::Object",
@@ -24,7 +22,8 @@ module Spoom
           "unsubscribed",
         )
 
-        sig { override.params(send: Send).void }
+        # @override
+        #: (Send send) -> void
         def on_send(send)
           return unless send.recv.nil? && send.name == "field"
 

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

@@ -5,8 +5,6 @@ module Spoom
   module Deadcode
     module Plugins
       class Minitest < Base
-        extend T::Sig
-
         ignore_classes_named(/Test$/)
 
         ignore_methods_named(
@@ -18,13 +16,15 @@ module Spoom
           "teardown",
         )
 
-        sig { override.params(definition: Model::Method).void }
+        # @override
+        #: (Model::Method definition) -> void
         def on_define_method(definition)
           file = definition.location.file
           @index.ignore(definition) if file.match?(%r{test/.*test\.rb$}) && definition.name.match?(/^test_/)
         end
 
-        sig { override.params(send: Send).void }
+        # @override
+        #: (Send send) -> void
         def on_send(send)
           case send.name
           when "assert_predicate", "refute_predicate"

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

@@ -5,21 +5,21 @@ module Spoom
   module Deadcode
     module Plugins
       class Namespaces < Base
-        extend T::Sig
-
-        sig { override.params(definition: Model::Class).void }
+        # @override
+        #: (Model::Class definition) -> void
         def on_define_class(definition)
           @index.ignore(definition) if used_as_namespace?(definition)
         end
 
-        sig { override.params(definition: Model::Module).void }
+        # @override
+        #: (Model::Module definition) -> void
         def on_define_module(definition)
           @index.ignore(definition) if used_as_namespace?(definition)
         end
 
         private
 
-        sig { params(symbol_def: Model::Namespace).returns(T::Boolean) }
+        #: (Model::Namespace symbol_def) -> bool
         def used_as_namespace?(symbol_def)
           symbol_def.children.any?
         end

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

@@ -5,23 +5,23 @@ module Spoom
   module Deadcode
     module Plugins
       class Rails < Base
-        extend T::Sig
-
         ignore_constants_named("APP_PATH", "ENGINE_PATH", "ENGINE_ROOT")
 
-        sig { override.params(definition: Model::Class).void }
+        # @override
+        #: (Model::Class definition) -> void
         def on_define_class(definition)
           @index.ignore(definition) if file_is_helper?(definition)
         end
 
-        sig { override.params(definition: Model::Module).void }
+        # @override
+        #: (Model::Module definition) -> void
         def on_define_module(definition)
           @index.ignore(definition) if file_is_helper?(definition)
         end
 
         private
 
-        sig { params(symbol_def: Model::Namespace).returns(T::Boolean) }
+        #: (Model::Namespace symbol_def) -> bool
         def file_is_helper?(symbol_def)
           symbol_def.location.file.match?(%r{app/helpers/.*\.rb$})
         end

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

@@ -5,8 +5,6 @@ module Spoom
   module Deadcode
     module Plugins
       class Rubocop < Base
-        extend T::Sig
-
         RUBOCOP_CONSTANTS = T.let(["MSG", "RESTRICT_ON_SEND"].to_set.freeze, T::Set[String])
 
         ignore_classes_inheriting_from(
@@ -14,7 +12,8 @@ module Spoom
           "RuboCop::Cop::Base",
         )
 
-        sig { override.params(definition: Model::Constant).void }
+        # @override
+        #: (Model::Constant definition) -> void
         def on_define_constant(definition)
           owner = definition.owner
           return false unless owner.is_a?(Model::Class)
@@ -22,7 +21,8 @@ module Spoom
           @index.ignore(definition) if ignored_subclass?(owner) && RUBOCOP_CONSTANTS.include?(definition.name)
         end
 
-        sig { override.params(definition: Model::Method).void }
+        # @override
+        #: (Model::Method definition) -> void
         def on_define_method(definition)
           return unless definition.name == "on_send"
 

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

@@ -5,8 +5,6 @@ module Spoom
   module Deadcode
     module Plugins
       class Ruby < Base
-        extend T::Sig
-
         ignore_methods_named(
           "==",
           "extended",
@@ -20,7 +18,8 @@ module Spoom
           "to_s",
         )
 
-        sig { override.params(send: Send).void }
+        # @override
+        #: (Send send) -> void
         def on_send(send)
           case send.name
           when "const_defined?", "const_get", "const_source_location"
@@ -42,7 +41,7 @@ module Spoom
 
         private
 
-        sig { params(send: Send, node: Prism::Node).void }
+        #: (Send send, Prism::Node node) -> void
         def reference_symbol_as_constant(send, node)
           case node
           when Prism::SymbolNode

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

@@ -5,26 +5,32 @@ module Spoom
   module Deadcode
     module Plugins
       class Sorbet < Base
-        extend T::Sig
-
-        sig { override.params(definition: Model::Constant).void }
+        # @override
+        #: (Model::Constant definition) -> void
         def on_define_constant(definition)
           @index.ignore(definition) if sorbet_type_member?(definition) || sorbet_enum_constant?(definition)
         end
 
-        sig { override.params(definition: Model::Method).void }
+        # @override
+        #: (Model::Method definition) -> void
         def on_define_method(definition)
+          # Ignore signatures containing `override` or `overridable`, like `sig { override.void }`
           @index.ignore(definition) if definition.sigs.any? { |sig| sig.string =~ /(override|overridable)/ }
+
+          # Ignore comments `@override` and `@overridable`
+          @index.ignore(definition) if definition.comments.any? do |comment|
+            comment.string == "@override" || comment.string == "@overridable"
+          end
         end
 
         private
 
-        sig { params(definition: Model::Constant).returns(T::Boolean) }
+        #: (Model::Constant definition) -> bool
         def sorbet_type_member?(definition)
           definition.value.match?(/^(type_member|type_template)/)
         end
 
-        sig { params(definition: Model::Constant).returns(T::Boolean) }
+        #: (Model::Constant definition) -> bool
         def sorbet_enum_constant?(definition)
           owner = definition.owner
           return false unless owner.is_a?(Model::Class)

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

@@ -5,11 +5,10 @@ module Spoom
   module Deadcode
     module Plugins
       class Thor < Base
-        extend T::Sig
-
         ignore_methods_named("exit_on_failure?")
 
-        sig { override.params(definition: Model::Method).void }
+        # @override
+        #: (Model::Method definition) -> void
         def on_define_method(definition)
           owner = definition.owner
           return unless owner.is_a?(Model::Class)

data/lib/spoom/deadcode/plugins.rb

@@ -55,9 +55,7 @@ module Spoom
     )
 
     class << self
-      extend T::Sig
-
-      sig { params(context: Context).returns(T::Set[T.class_of(Plugins::Base)]) }
+      #: (Context context) -> Set[singleton(Plugins::Base)]
       def plugins_from_gemfile_lock(context)
         # These plugins are always loaded
         plugin_classes = DEFAULT_PLUGINS.dup
@@ -71,7 +69,7 @@ module Spoom
         plugin_classes
       end
 
-      sig { params(context: Context).returns(T::Array[T.class_of(Plugins::Base)]) }
+      #: (Context context) -> Array[singleton(Plugins::Base)]
       def load_custom_plugins(context)
         context.glob("#{DEFAULT_CUSTOM_PLUGINS_PATH}/*.rb").each do |path|
           require("#{context.absolute_path}/#{path}")

data/lib/spoom/deadcode/remover.rb

@@ -4,16 +4,14 @@
 module Spoom
   module Deadcode
     class Remover
-      extend T::Sig
-
       class Error < Spoom::Error; end
 
-      sig { params(context: Context).void }
+      #: (Context context) -> void
       def initialize(context)
         @context = context
       end
 
-      sig { params(kind: T.nilable(Definition::Kind), location: Location).returns(String) }
+      #: (Definition::Kind? kind, Location location) -> String
       def remove_location(kind, location)
         file = location.file
 
@@ -27,12 +25,10 @@ module Spoom
       end
 
       class NodeRemover
-        extend T::Sig
-
-        sig { returns(String) }
+        #: String
         attr_reader :new_source
 
-        sig { params(source: String, kind: T.nilable(Definition::Kind), location: Location).void }
+        #: (String source, Definition::Kind? kind, Location location) -> void
         def initialize(source, kind, location)
           @old_source = source
           @new_source = T.let(source.dup, String)
@@ -42,7 +38,7 @@ module Spoom
           @node_context = T.let(NodeFinder.find(source, location, kind), NodeContext)
         end
 
-        sig { void }
+        #: -> void
         def apply_edit
           sclass_context = @node_context.sclass_context
           if sclass_context
@@ -69,7 +65,7 @@ module Spoom
 
         private
 
-        sig { params(context: NodeContext).void }
+        #: (NodeContext context) -> void
         def delete_constant_assignment(context)
           case context.node
           when Prism::ConstantWriteNode, Prism::ConstantOperatorWriteNode,
@@ -149,7 +145,7 @@ module Spoom
           end
         end
 
-        sig { params(context: NodeContext).void }
+        #: (NodeContext context) -> void
         def delete_attr_accessor(context)
           args_context = context.parent_context
           send_context = args_context.parent_context
@@ -208,13 +204,7 @@ module Spoom
           insert_accessor(context.node, send_context, was_removed: false) if need_accessor
         end
 
-        sig do
-          params(
-            node: Prism::Node,
-            send_context: NodeContext,
-            was_removed: T::Boolean,
-          ).void
-        end
+        #: (Prism::Node node, NodeContext send_context, was_removed: bool) -> void
         def insert_accessor(node, send_context, was_removed:)
           name = node.slice
           code = case @kind
@@ -257,7 +247,7 @@ module Spoom
           @new_source = lines.join
         end
 
-        sig { params(context: NodeContext).void }
+        #: (NodeContext context) -> void
         def delete_node_and_comments_and_sigs(context)
           start_line = context.node.location.start_line
           end_line = context.node.location.end_line
@@ -320,24 +310,24 @@ module Spoom
           delete_lines(start_line, end_line)
         end
 
-        sig { params(start_line: Integer, end_line: Integer).void }
+        #: (Integer start_line, Integer end_line) -> void
         def delete_lines(start_line, end_line)
           lines = @new_source.lines
           lines[start_line - 1...end_line] = []
           @new_source = lines.join
         end
 
-        sig { params(start_char: Integer, end_char: Integer).void }
+        #: (Integer start_char, Integer end_char) -> void
         def delete_chars(start_char, end_char)
           @new_source[start_char...end_char] = ""
         end
 
-        sig { params(start_char: Integer, end_char: Integer, replacement: String).void }
+        #: (Integer start_char, Integer end_char, String replacement) -> void
         def replace_chars(start_char, end_char, replacement)
           @new_source[start_char...end_char] = replacement
         end
 
-        sig { params(node: Prism::CallNode, name: String, kind: T.nilable(Definition::Kind)).returns(String) }
+        #: (Prism::CallNode node, name: String, kind: Definition::Kind?) -> String
         def transform_sig(node, name:, kind:)
           type = T.let(nil, T.nilable(String))
 
@@ -370,25 +360,16 @@ module Spoom
       end
 
       class NodeContext
-        extend T::Sig
-
-        sig { returns(T::Hash[Integer, Prism::Comment]) }
+        #: Hash[Integer, Prism::Comment]
         attr_reader :comments
 
-        sig { returns(Prism::Node) }
+        #: Prism::Node
         attr_reader :node
 
-        sig { returns(T::Array[Prism::Node]) }
+        #: Array[Prism::Node]
         attr_accessor :nesting
 
-        sig do
-          params(
-            source: String,
-            comments: T::Hash[Integer, Prism::Comment],
-            node: Prism::Node,
-            nesting: T::Array[Prism::Node],
-          ).void
-        end
+        #: (String source, Hash[Integer, Prism::Comment] comments, Prism::Node node, Array[Prism::Node] nesting) -> void
         def initialize(source, comments, node, nesting)
           @source = source
           @comments = comments
@@ -396,7 +377,7 @@ module Spoom
           @nesting = nesting
         end
 
-        sig { returns(Prism::Node) }
+        #: -> Prism::Node
         def parent_node
           parent = @nesting.last
           raise Error, "No parent for node #{node}" unless parent
@@ -404,7 +385,7 @@ module Spoom
           parent
         end
 
-        sig { returns(NodeContext) }
+        #: -> NodeContext
         def parent_context
           nesting = @nesting.dup
           parent = nesting.pop
@@ -413,7 +394,7 @@ module Spoom
           NodeContext.new(@source, @comments, parent, nesting)
         end
 
-        sig { returns(T::Array[Prism::Node]) }
+        #: -> Array[Prism::Node]
         def previous_nodes
           parent = parent_node
           child_nodes = parent.child_nodes.compact
@@ -424,12 +405,12 @@ module Spoom
           T.must(child_nodes[0...index])
         end
 
-        sig { returns(T.nilable(Prism::Node)) }
+        #: -> Prism::Node?
         def previous_node
           previous_nodes.last
         end
 
-        sig { returns(T::Array[Prism::Node]) }
+        #: -> Array[Prism::Node]
         def next_nodes
           parent = parent_node
           child_nodes = parent.child_nodes.compact
@@ -440,12 +421,12 @@ module Spoom
           T.must(child_nodes.compact[(index + 1)..-1])
         end
 
-        sig { returns(T.nilable(Prism::Node)) }
+        #: -> Prism::Node?
         def next_node
           next_nodes.first
         end
 
-        sig { returns(T.nilable(NodeContext)) }
+        #: -> NodeContext?
         def sclass_context
           sclass = T.let(nil, T.nilable(Prism::SingletonClassNode))
 
@@ -473,12 +454,12 @@ module Spoom
           nil
         end
 
-        sig { params(node: T.nilable(Prism::Node)).returns(T::Boolean) }
+        #: (Prism::Node? node) -> bool
         def sorbet_signature?(node)
           node.is_a?(Prism::CallNode) && node.name == :sig
         end
 
-        sig { params(node: T.nilable(Prism::Node)).returns(T::Boolean) }
+        #: (Prism::Node? node) -> bool
         def sorbet_extend_sig?(node)
           return false unless node.is_a?(Prism::CallNode)
           return false unless node.name == :extend
@@ -490,7 +471,7 @@ module Spoom
           args.arguments.first&.slice == "T::Sig"
         end
 
-        sig { params(start_line: Integer, end_line: Integer).returns(T::Array[Prism::Comment]) }
+        #: (Integer start_line, Integer end_line) -> Array[Prism::Comment]
         def comments_between_lines(start_line, end_line)
           comments = T.let([], T::Array[Prism::Comment])
 
@@ -502,7 +483,7 @@ module Spoom
           comments
         end
 
-        sig { params(node: Prism::Node).returns(T::Array[Prism::Comment]) }
+        #: (Prism::Node node) -> Array[Prism::Comment]
         def attached_comments(node)
           comments = T.let([], T::Array[Prism::Comment])
 
@@ -517,7 +498,7 @@ module Spoom
           comments.reverse
         end
 
-        sig { returns(T::Array[Prism::Node]) }
+        #: -> Array[Prism::Node]
         def attached_sigs
           nodes = T.let([], T::Array[Prism::Node])
 
@@ -530,7 +511,7 @@ module Spoom
           nodes.reverse
         end
 
-        sig { returns(T.nilable(Prism::CallNode)) }
+        #: -> Prism::CallNode?
         def attached_sig
           previous_nodes.reverse_each do |node|
             if node.is_a?(Prism::Comment)
@@ -547,12 +528,8 @@ module Spoom
       end
 
       class NodeFinder < Visitor
-        extend T::Sig
-
         class << self
-          extend T::Sig
-
-          sig { params(source: String, location: Location, kind: T.nilable(Definition::Kind)).returns(NodeContext) }
+          #: (String source, Location location, Definition::Kind? kind) -> NodeContext
           def find(source, location, kind)
             result = Prism.parse(source)
 
@@ -586,7 +563,7 @@ module Spoom
             NodeContext.new(source, comments_by_line, node, visitor.nodes_nesting)
           end
 
-          sig { params(node: Prism::Node, kind: Definition::Kind).returns(T::Boolean) }
+          #: (Prism::Node node, Definition::Kind kind) -> bool
           def node_match_kind?(node, kind)
             case kind
             when Definition::Kind::AttrReader, Definition::Kind::AttrWriter
@@ -611,13 +588,13 @@ module Spoom
           end
         end
 
-        sig { returns(T.nilable(Prism::Node)) }
+        #: Prism::Node?
         attr_reader :node
 
-        sig { returns(T::Array[Prism::Node]) }
+        #: Array[Prism::Node]
         attr_reader :nodes_nesting
 
-        sig { params(location: Location, kind: T.nilable(Definition::Kind)).void }
+        #: (Location location, Definition::Kind? kind) -> void
         def initialize(location, kind)
           super()
           @location = location
@@ -626,7 +603,8 @@ module Spoom
           @nodes_nesting = T.let([], T::Array[Prism::Node])
         end
 
-        sig { override.params(node: T.nilable(Prism::Node)).void }
+        # @override
+        #: (Prism::Node? node) -> void
         def visit(node)
           return unless node
 

data/lib/spoom/deadcode/send.rb

@@ -5,8 +5,6 @@ module Spoom
   module Deadcode
     # An abstraction to simplify handling of Prism::CallNode nodes.
     class Send < T::Struct
-      extend T::Sig
-
       const :node, Prism::CallNode
       const :name, String
       const :recv, T.nilable(Prism::Node), default: nil
@@ -14,18 +12,14 @@ module Spoom
       const :block, T.nilable(Prism::Node), default: nil
       const :location, Location
 
-      sig do
-        type_parameters(:T)
-          .params(arg_type: T::Class[T.type_parameter(:T)], block: T.proc.params(arg: T.type_parameter(:T)).void)
-          .void
-      end
+      #: [T] (Class[T] arg_type) { (T arg) -> void } -> void
       def each_arg(arg_type, &block)
         args.each do |arg|
           yield(T.unsafe(arg)) if arg.is_a?(arg_type)
         end
       end
 
-      sig { params(block: T.proc.params(key: Prism::Node, value: T.nilable(Prism::Node)).void).void }
+      #: { (Prism::Node key, Prism::Node? value) -> void } -> void
       def each_arg_assoc(&block)
         args.each do |arg|
           next unless arg.is_a?(Prism::KeywordHashNode) || arg.is_a?(Prism::HashNode)

data/lib/spoom/file_collector.rb

@@ -3,9 +3,7 @@
 
 module Spoom
   class FileCollector
-    extend T::Sig
-
-    sig { returns(T::Array[String]) }
+    #: Array[String]
     attr_reader :files
 
     # Initialize a new file collector
@@ -16,13 +14,7 @@ module Spoom
     # If `allow_mime_types` is empty, all files are collected.
     # If `allow_mime_types` is an array of mimetypes, files without an extension are collected if their mimetype is in
     # the list.
-    sig do
-      params(
-        allow_extensions: T::Array[String],
-        allow_mime_types: T::Array[String],
-        exclude_patterns: T::Array[String],
-      ).void
-    end
+    #: (?allow_extensions: Array[String], ?allow_mime_types: Array[String], ?exclude_patterns: Array[String]) -> void
     def initialize(allow_extensions: [], allow_mime_types: [], exclude_patterns: [])
       @files = T.let([], T::Array[String])
       @allow_extensions = allow_extensions
@@ -30,12 +22,12 @@ module Spoom
       @exclude_patterns = exclude_patterns
     end
 
-    sig { params(paths: T::Array[String]).void }
+    #: (Array[String] paths) -> void
     def visit_paths(paths)
       paths.each { |path| visit_path(path) }
     end
 
-    sig { params(path: String).void }
+    #: (String path) -> void
     def visit_path(path)
       path = clean_path(path)
 
@@ -52,24 +44,24 @@ module Spoom
 
     private
 
-    sig { params(path: String).returns(String) }
+    #: (String path) -> String
     def clean_path(path)
       Pathname.new(path).cleanpath.to_s
     end
 
-    sig { params(path: String).void }
+    #: (String path) -> void
     def visit_file(path)
       return if excluded_file?(path)
 
       @files << path
     end
 
-    sig { params(path: String).void }
+    #: (String path) -> void
     def visit_directory(path)
       visit_paths(Dir.glob("#{path}/*"))
     end
 
-    sig { params(path: String).returns(T::Boolean) }
+    #: (String path) -> bool
     def excluded_file?(path)
       return false if @allow_extensions.empty?
 
@@ -84,7 +76,7 @@ module Spoom
       end
     end
 
-    sig { params(path: String).returns(T::Boolean) }
+    #: (String path) -> bool
     def excluded_path?(path)
       @exclude_patterns.any? do |pattern|
         # Use `FNM_PATHNAME` so patterns do not match directory separators
@@ -93,7 +85,7 @@ module Spoom
       end
     end
 
-    sig { params(path: String).returns(T.nilable(String)) }
+    #: (String path) -> String?
     def mime_type_for(path)
       # The `file` command appears to be hanging on MacOS for some files so we timeout after 1s.
       %x{timeout 1s file --mime-type -b '#{path}'}.split("; ").first&.strip