spoom 1.7.16 → 1.8.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 2110b75c9f1cfaf75e50c901f26af66d149f2a6353a22ee2154062f24f808472
-  data.tar.gz: 1f8daac5e4e94b7b135ed0b2d7dafb701dcf338302f337982ced3e6a32aa65fa
+  metadata.gz: ae2652efb4a3831e59c02c6a8cc5915f316078ab403afb51932592e83cf924ca
+  data.tar.gz: ae568069ab7100286b0260ef741616d24c228a8d35a7739b6a9c771ff48d6a6e
 SHA512:
-  metadata.gz: bb98e214157092a61b830ce8e5836b1bc9c304d902b2886e10ab52c753febd6c7233142a509b461b26ee9c1c1150bd8346b02370c031bda68a6c555b2bc1c128
-  data.tar.gz: 6b3b0ec9bbc739161a4c642084aa1edcae82cf9293e20e3997656cfa2108eff1c32369c5d4225c6ebdd0716cb030eaec7c749cfa623273cdb59dce848f5ab039
+  metadata.gz: 3b52cffe4c34d11dbfcb0f43a50b742aa69cc41b5baad2623504d55ab4252fe4ed541fad2952564ff42774586b15198f6eec713840ccce3e3a33df3e0fc14590
+  data.tar.gz: cf0d1e04b1c73e5d96ef84bc3ded2e8871bb3cd08dd875e2a108185d5287bd3b75e29e77d34514d522dcfeaf549ff3ce1394c32a66695652cc110de2961cd904

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

@@ -43,11 +43,13 @@ module Spoom
           end
 
           send.each_arg_assoc do |key, value|
-            key = key.slice.delete_suffix(":")
+            next unless key.is_a?(Prism::SymbolNode)
+
+            key = key.unescaped
 
             case key
             when "if", "unless"
-              @index.reference_method(value.slice.delete_prefix(":"), send.location) if value
+              @index.reference_method(value.unescaped, send.location) if value.is_a?(Prism::SymbolNode)
             else
               @index.reference_constant(camelize(key), send.location)
             end

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

@@ -23,13 +23,19 @@ module Spoom
               @index.reference_method(arg.unescaped, send.location)
             end
             send.each_arg_assoc do |key, value|
-              key = key.slice.delete_suffix(":")
+              next unless key.is_a?(Prism::SymbolNode)
+
+              key = key.unescaped
 
               case key
               when "if", "unless"
-                @index.reference_method(value.slice.delete_prefix(":"), send.location) if value
+                @index.reference_method(value.unescaped, send.location) if value.is_a?(Prism::SymbolNode)
               else
                 @index.reference_constant(camelize(key), send.location)
+
+                if value.is_a?(Prism::HashNode)
+                  reference_nested_symbol_options(value, send.location)
+                end
               end
             end
           when "validates_with"
@@ -39,6 +45,42 @@ module Spoom
             end
           end
         end
+
+        private
+
+        NESTED_METHOD_REFERENCE_KEYS = T.let(
+          [
+            "if",
+            "unless",
+            "in",
+            "with",
+            "less_than",
+            "greater_than",
+            "less_than_or_equal_to",
+            "greater_than_or_equal_to",
+            "equal_to",
+            "other_than",
+          ].freeze,
+          T::Array[String],
+        )
+
+        #: (Prism::HashNode hash_node, Location location) -> void
+        def reference_nested_symbol_options(hash_node, location)
+          hash_node.elements.each do |assoc|
+            next unless assoc.is_a?(Prism::AssocNode)
+
+            key = assoc.key
+            next unless key.is_a?(Prism::SymbolNode)
+
+            nested_key = key.unescaped
+            next unless NESTED_METHOD_REFERENCE_KEYS.include?(nested_key)
+
+            value = assoc.value
+            next unless value.is_a?(Prism::SymbolNode)
+
+            @index.reference_method(value.unescaped, location)
+          end
+        end
       end
     end
   end

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

@@ -75,11 +75,11 @@ module Spoom
 
             # Process hash arguments for conditions like if: :method_name
             send.each_arg_assoc do |key, value|
-              key = key.slice.delete_suffix(":")
+              next unless key.is_a?(Prism::SymbolNode)
 
-              case key
+              case key.unescaped
               when *CALLBACK_CONDITIONS
-                if value&.is_a?(Prism::SymbolNode)
+                if value.is_a?(Prism::SymbolNode)
                   @index.reference_method(value.unescaped, send.location)
                 end
               end
@@ -93,8 +93,9 @@ module Spoom
           case send.name
           when *CRUD_METHODS
             send.each_arg_assoc do |key, _value|
-              key = key.slice.delete_suffix(":")
-              @index.reference_method("#{key}=", send.location)
+              next unless key.is_a?(Prism::SymbolNode)
+
+              @index.reference_method("#{key.unescaped}=", send.location)
             end
           when *ARRAY_METHODS
             send.each_arg(Prism::ArrayNode) do |arg|
@@ -104,8 +105,10 @@ module Spoom
                 part.elements.each do |assoc|
                   next unless assoc.is_a?(Prism::AssocNode)
 
-                  key = assoc.key.slice.delete_suffix(":")
-                  @index.reference_method("#{key}=", send.location)
+                  key = assoc.key
+                  next unless key.is_a?(Prism::SymbolNode)
+
+                  @index.reference_method("#{key.unescaped}=", send.location)
                 end
               end
             end

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

@@ -267,10 +267,11 @@ module Spoom
         # class MyPlugin < Spoom::Deadcode::Plugins::Base
         #   def on_send(send)
         #     return unless send.name == "dsl_method"
-        #     return if send.args.empty?
         #
-        #     method_name = send.args.first.slice.delete_prefix(":")
-        #     @index.reference_method(method_name, send.node, send.loc)
+        #     arg = send.args.first
+        #     return unless arg.is_a?(Prism::SymbolNode)
+        #
+        #     @index.reference_method(arg.unescaped, send.node, send.loc)
         #   end
         # end
         # ~~~

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

@@ -22,22 +22,59 @@ module Spoom
           "unsubscribed",
         )
 
+        FIELD_SYMBOL_OPTION_KEYS = ["resolver_method", "method"].freeze #: Array[String]
+        ARGUMENT_SYMBOL_OPTION_KEYS = ["prepare", "method"].freeze #: Array[String]
+
         # @override
         #: (Send send) -> void
         def on_send(send)
-          return unless send.recv.nil? && send.name == "field"
+          return unless send.recv.nil?
+
+          case send.name
+          when "field"
+            on_field(send)
+          when "argument"
+            on_argument(send)
+          when "builds"
+            on_builds(send)
+          end
+        end
+
+        private
 
+        #: (Send send) -> void
+        def on_field(send)
           arg = send.args.first
           return unless arg.is_a?(Prism::SymbolNode)
 
           @index.reference_method(arg.unescaped, send.location)
 
           send.each_arg_assoc do |key, value|
-            key = key.slice.delete_suffix(":")
-            next unless key == "resolver_method"
-            next unless value
+            next unless key.is_a?(Prism::SymbolNode)
+            next unless FIELD_SYMBOL_OPTION_KEYS.include?(key.unescaped)
+            next unless value.is_a?(Prism::SymbolNode)
+
+            @index.reference_method(value.unescaped, send.location)
+          end
+        end
+
+        #: (Send send) -> void
+        def on_argument(send)
+          send.each_arg_assoc do |key, value|
+            next unless key.is_a?(Prism::SymbolNode)
+            next unless ARGUMENT_SYMBOL_OPTION_KEYS.include?(key.unescaped)
+            next unless value.is_a?(Prism::SymbolNode)
+
+            @index.reference_method(value.unescaped, send.location)
+          end
+        end
+
+        #: (Send send) -> void
+        def on_builds(send)
+          send.args.each do |arg|
+            next unless arg.is_a?(Prism::SymbolNode)
 
-            @index.reference_method(value.slice.delete_prefix(":"), send.location)
+            @index.reference_method("build_#{arg.unescaped}", send.location)
           end
         end
       end

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

@@ -28,10 +28,10 @@ module Spoom
         def on_send(send)
           case send.name
           when "assert_predicate", "refute_predicate"
-            name = send.args[1]&.slice
-            return unless name
+            arg = send.args[1]
+            return unless arg.is_a?(Prism::SymbolNode)
 
-            @index.reference_method(name.delete_prefix(":"), send.location)
+            @index.reference_method(arg.unescaped, send.location)
           end
         end
       end

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

@@ -24,7 +24,7 @@ module Spoom
           case send.name
           when "const_defined?", "const_get", "const_source_location"
             reference_symbol_as_constant(send, T.must(send.args.first))
-          when "send", "__send__", "try"
+          when "send", "__send__", "public_send", "try"
             arg = send.args.first
             @index.reference_method(arg.unescaped, send.location) if arg.is_a?(Prism::SymbolNode)
           when "alias_method"

data/lib/spoom/ext/prism_types.rb

@@ -0,0 +1,14 @@
+# typed: strict
+# frozen_string_literal: true
+
+module Spoom
+  module PrismTypes
+    # Ideally this would just be in a shim in `sorbet/rbi/shims/prism.rbi`, but that causes
+    # `bundle exec tapioca gem spoom` to fail. It Spoom's translator to rewrite the RBS signature comments into Sigs,
+    # which try to access the `Prism::AnyScopeNode` constant.
+    # Because shims aren't executed, no such constant exists at runtime, and the Sig raises a NameError.
+    #
+    # So instead, we define it here, where the translator can reify it into a real Sorbet `T.type_alias` at runtime.
+    #: type anyScopeNode = ::Prism::ClassNode | ::Prism::ModuleNode | ::Prism::SingletonClassNode
+  end
+end

data/lib/spoom/model/builder.rb

@@ -168,7 +168,7 @@ module Spoom
             next unless arg.is_a?(Prism::SymbolNode)
 
             AttrAccessor.new(
-              @model.register_symbol([*@names_nesting, arg.slice.delete_prefix(":")].join("::")),
+              @model.register_symbol([*@names_nesting, arg.unescaped].join("::")),
               owner: current_namespace,
               location: node_location(arg),
               visibility: current_visibility,
@@ -182,7 +182,7 @@ module Spoom
             next unless arg.is_a?(Prism::SymbolNode)
 
             AttrReader.new(
-              @model.register_symbol([*@names_nesting, arg.slice.delete_prefix(":")].join("::")),
+              @model.register_symbol([*@names_nesting, arg.unescaped].join("::")),
               owner: current_namespace,
               location: node_location(arg),
               visibility: current_visibility,
@@ -196,7 +196,7 @@ module Spoom
             next unless arg.is_a?(Prism::SymbolNode)
 
             AttrWriter.new(
-              @model.register_symbol([*@names_nesting, arg.slice.delete_prefix(":")].join("::")),
+              @model.register_symbol([*@names_nesting, arg.unescaped].join("::")),
               owner: current_namespace,
               location: node_location(arg),
               visibility: current_visibility,

data/lib/spoom/rbs.rb

@@ -69,7 +69,20 @@ module Spoom
     end
 
     class Annotation < Comment; end
-    class Signature < Comment; end
+
+    class Signature < Comment
+      # Locations of the `#|` continuation comment lines that make up a multiline signature,
+      # in addition to the `#:` line tracked by `location`.
+      #: Array[Prism::Location]
+      attr_reader :continuation_locations
+
+      #: (String, Prism::Location, ?continuation_locations: Array[Prism::Location]) -> void
+      def initialize(string, location, continuation_locations: [])
+        super(string, location)
+        @continuation_locations = continuation_locations
+      end
+    end
+
     class TypeAlias < Comment; end
 
     module ExtractRBSComments
@@ -99,13 +112,18 @@ module Spoom
           elsif string.start_with?("#: ")
             string = string.delete_prefix("#:").strip
             location = comment.location
+            continuation_locations = [] #: Array[Prism::Location]
 
             continuation_comments.reverse_each do |continuation_comment|
               string = "#{string}#{continuation_comment.slice.delete_prefix("#|")}"
               location = location.join(continuation_comment.location)
+              continuation_locations << continuation_comment.location
             end
             continuation_comments.clear
-            res.signatures.prepend(Signature.new(string, location))
+
+            next if string.start_with?("type ")
+
+            res.signatures.prepend(Signature.new(string, location, continuation_locations:))
           elsif string.start_with?("#|")
             continuation_comments << comment
           end

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

@@ -32,7 +32,7 @@ module Spoom
       # On the other hand, the metrics file is a snapshot of the metrics at type checking time and knows about
       # is calls are typed, how many assertions are done, etc.
       class CodeMetricsVisitor < Spoom::Visitor
-        include RBS::ExtractRBSComments
+        include Spoom::RBS::ExtractRBSComments
 
         #: (Spoom::Counters) -> void
         def initialize(counters)
@@ -147,7 +147,7 @@ module Spoom
 
         private
 
-        #: (Prism::ClassNode | Prism::ModuleNode | Prism::SingletonClassNode) { -> void } -> void
+        #: (PrismTypes::anyScopeNode) { -> void } -> void
         def visit_scope(node, &block)
           key = node_key(node)
           @counters.increment(key)
@@ -216,7 +216,7 @@ module Spoom
           sigs
         end
 
-        #: (Prism::ClassNode | Prism::ModuleNode | Prism::SingletonClassNode) -> String
+        #: (PrismTypes::anyScopeNode) -> String
         def node_key(node)
           case node
           when Prism::ClassNode