spoom 1.2.1 → 1.2.3

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

@@ -0,0 +1,64 @@
+# typed: strict
+# frozen_string_literal: true
+
+module Spoom
+  module Deadcode
+    module Plugins
+      class Ruby < Base
+        extend T::Sig
+
+        ignore_method_names(
+          "==",
+          "extended",
+          "included",
+          "inherited",
+          "initialize",
+          "method_added",
+          "method_missing",
+          "prepended",
+          "respond_to_missing?",
+          "to_s",
+        )
+
+        sig { override.params(indexer: Indexer, send: Send).void }
+        def on_send(indexer, send)
+          case send.name
+          when "const_defined?", "const_get", "const_source_location"
+            reference_symbol_as_constant(indexer, send, T.must(send.args.first))
+          when "send", "__send__", "try"
+            reference_send_first_symbol_as_method(indexer, send)
+          when "alias_method"
+            last_arg = send.args.last
+
+            name = case last_arg
+            when SyntaxTree::SymbolLiteral
+              indexer.node_string(last_arg.value)
+            when SyntaxTree::StringLiteral
+              last_arg.parts.map { |part| indexer.node_string(part) }.join
+            end
+
+            return unless name
+
+            indexer.reference_method(name, send.node)
+          end
+        end
+
+        private
+
+        sig { params(indexer: Indexer, send: Send, node: SyntaxTree::Node).void }
+        def reference_symbol_as_constant(indexer, send, node)
+          case node
+          when SyntaxTree::SymbolLiteral
+            name = indexer.node_string(node.value)
+            indexer.reference_constant(name, send.node)
+          when SyntaxTree::StringLiteral
+            string = T.must(indexer.node_string(node)[1..-2])
+            string.split("::").each do |name|
+              indexer.reference_constant(name, send.node) unless name.empty?
+            end
+          end
+        end
+      end
+    end
+  end
+end

data/lib/spoom/deadcode/plugins.rb

@@ -0,0 +1,5 @@
+# typed: strict
+# frozen_string_literal: true
+
+require_relative "plugins/base"
+require_relative "plugins/ruby"

data/lib/spoom/deadcode/reference.rb

@@ -0,0 +1,34 @@
+# typed: strict
+# frozen_string_literal: true
+
+module Spoom
+  module Deadcode
+    # A reference is a call to a method or a constant
+    class Reference < T::Struct
+      extend T::Sig
+
+      class Kind < T::Enum
+        enums do
+          Constant = new
+          Method = new
+        end
+      end
+
+      const :kind, Kind
+      const :name, String
+      const :location, Location
+
+      # Kind
+
+      sig { returns(T::Boolean) }
+      def constant?
+        kind == Kind::Constant
+      end
+
+      sig { returns(T::Boolean) }
+      def method?
+        kind == Kind::Method
+      end
+    end
+  end
+end

data/lib/spoom/deadcode/send.rb

@@ -0,0 +1,18 @@
+# typed: strict
+# frozen_string_literal: true
+
+module Spoom
+  module Deadcode
+    # An abstraction to simplify handling of SyntaxTree::CallNode, SyntaxTree::Command, SyntaxTree::CommandCall and
+    # SyntaxTree::VCall nodes.
+    class Send < T::Struct
+      extend T::Sig
+
+      const :node, SyntaxTree::Node
+      const :name, String
+      const :recv, T.nilable(SyntaxTree::Node), default: nil
+      const :args, T::Array[SyntaxTree::Node], default: []
+      const :block, T.nilable(SyntaxTree::Node), default: nil
+    end
+  end
+end

data/lib/spoom/deadcode.rb

@@ -0,0 +1,56 @@
+# typed: strict
+# frozen_string_literal: true
+
+require "erubi"
+require "syntax_tree"
+
+require_relative "deadcode/erb"
+require_relative "deadcode/index"
+require_relative "deadcode/indexer"
+
+require_relative "deadcode/location"
+require_relative "deadcode/definition"
+require_relative "deadcode/reference"
+require_relative "deadcode/send"
+require_relative "deadcode/plugins"
+
+module Spoom
+  module Deadcode
+    class Error < Spoom::Error
+      extend T::Sig
+      extend T::Helpers
+
+      abstract!
+
+      sig { params(message: String, parent: Exception).void }
+      def initialize(message, parent:)
+        super(message)
+        set_backtrace(parent.backtrace)
+      end
+    end
+
+    class ParserError < Error; end
+    class IndexerError < Error; end
+
+    class << self
+      extend T::Sig
+
+      sig { params(index: Index, ruby: String, file: String, plugins: T::Array[Deadcode::Plugins::Base]).void }
+      def index_ruby(index, ruby, file:, plugins: [])
+        node = SyntaxTree.parse(ruby)
+        visitor = Spoom::Deadcode::Indexer.new(file, ruby, index, plugins: plugins)
+        visitor.visit(node)
+      rescue SyntaxTree::Parser::ParseError => e
+        raise ParserError.new("Error while parsing #{file} (#{e.message} at #{e.lineno}:#{e.column})", parent: e)
+      rescue => e
+        raise IndexerError.new("Error while indexing #{file} (#{e.message})", parent: e)
+      end
+
+      sig { params(index: Index, erb: String, file: String, plugins: T::Array[Deadcode::Plugins::Base]).void }
+      def index_erb(index, erb, file:, plugins: [])
+        ruby = ERB.new(erb).src
+        index_ruby(index, ruby, file: file, plugins: plugins)
+      end
+    end
+  end
+end

data/lib/spoom/file_collector.rb

@@ -12,15 +12,21 @@ module Spoom
     #
     # If `allow_extensions` is empty, all files are collected.
     # If `allow_extensions` is an array of extensions, only files with one of these extensions are collected.
+    #
+    # 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
-    def initialize(allow_extensions: [], exclude_patterns: [])
+    def initialize(allow_extensions: [], allow_mime_types: [], exclude_patterns: [])
       @files = T.let([], T::Array[String])
       @allow_extensions = allow_extensions
+      @allow_mime_types = allow_mime_types
       @exclude_patterns = exclude_patterns
     end
 
@@ -68,12 +74,29 @@ module Spoom
       return false if @allow_extensions.empty?
 
       extension = File.extname(path)
-      @allow_extensions.none? { |allowed| extension == allowed }
+      if extension.empty?
+        return true if @allow_mime_types.empty?
+
+        mime = mime_type_for(path)
+        @allow_mime_types.none? { |allowed| mime == allowed }
+      else
+        @allow_extensions.none? { |allowed| extension == allowed }
+      end
     end
 
     sig { params(path: String).returns(T::Boolean) }
     def excluded_path?(path)
-      @exclude_patterns.any? { |pattern| File.fnmatch?(pattern, path) }
+      @exclude_patterns.any? do |pattern|
+        # Use `FNM_PATHNAME` so patterns do not match directory separators
+        # Use `FNM_EXTGLOB` to allow file globbing through `{a,b}`
+        File.fnmatch?(pattern, path, File::FNM_PATHNAME | File::FNM_EXTGLOB)
+      end
+    end
+
+    sig { params(path: String).returns(T.nilable(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
     end
   end
 end

data/lib/spoom/printer.rb

@@ -10,8 +10,6 @@ module Spoom
 
     include Colorize
 
-    abstract!
-
     sig { returns(T.any(IO, StringIO)) }
     attr_accessor :out
 

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

@@ -12,9 +12,6 @@ module Spoom
     class Message
       extend T::Sig
 
-      sig { returns(String) }
-      attr_reader :jsonrpc
-
       sig { void }
       def initialize
         @jsonrpc = T.let("2.0", String)
@@ -43,9 +40,6 @@ module Spoom
       sig { returns(Integer) }
       attr_reader :id
 
-      sig { returns(String) }
-      attr_reader :method
-
       sig { returns(T::Hash[T.untyped, T.untyped]) }
       attr_reader :params
 

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

@@ -310,7 +310,7 @@ module Spoom
       extend T::Sig
 
       sig { returns(T::Set[Integer]) }
-      attr_accessor :seen
+      attr_reader :seen
 
       sig { returns(T.nilable(String)) }
       attr_accessor :prefix

data/lib/spoom/sorbet/lsp.rb

@@ -53,7 +53,7 @@ module Spoom
       sig { returns(T.nilable(T::Hash[T.untyped, T.untyped])) }
       def read
         raw_string = read_raw
-        return nil unless raw_string
+        return unless raw_string
 
         json = JSON.parse(raw_string)
 
@@ -101,7 +101,7 @@ module Spoom
           },
         ))
 
-        return nil unless json && json["result"]
+        return unless json && json["result"]
 
         Hover.from_json(json["result"])
       end

data/lib/spoom/sorbet/sigils.rb

@@ -28,7 +28,7 @@ module Spoom
         T::Array[String],
       )
 
-      SIGIL_REGEXP = T.let(/^#[\ t]*typed[\ t]*:[ \t]*(\w*)[ \t]*/.freeze, Regexp)
+      SIGIL_REGEXP = T.let(/^#[[:blank:]]*typed:[[:blank:]]*(\S*)/, Regexp)
 
       class << self
         extend T::Sig
@@ -61,7 +61,7 @@ module Spoom
         # * returns nil if no sigil
         sig { params(path: T.any(String, Pathname)).returns(T.nilable(String)) }
         def file_strictness(path)
-          return nil unless File.file?(path)
+          return unless File.file?(path)
 
           content = File.read(path, encoding: Encoding::ASCII_8BIT)
           strictness_in_content(content)

data/lib/spoom/sorbet.rb

@@ -35,6 +35,7 @@ module Spoom
 
     CONFIG_PATH = "sorbet/config"
     GEM_PATH = T.let(Gem::Specification.find_by_name("sorbet-static").full_gem_path, String)
+    GEM_VERSION = T.let(Gem::Specification.find_by_name("sorbet-static-and-runtime").version.to_s, String)
     BIN_PATH = T.let((Pathname.new(GEM_PATH) / "libexec" / "sorbet").to_s, String)
 
     KILLED_CODE = 137

data/lib/spoom/version.rb

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

data/lib/spoom.rb

@@ -15,6 +15,7 @@ end
 require "spoom/file_collector"
 require "spoom/context"
 require "spoom/colors"
+require "spoom/deadcode"
 require "spoom/sorbet"
 require "spoom/cli"
 require "spoom/version"

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: spoom
 version: !ruby/object:Gem::Version
-  version: 1.2.1
+  version: 1.2.3
 platform: ruby
 authors:
 - Alexandre Terrasa
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2023-03-31 00:00:00.000000000 Z
+date: 2023-08-08 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -67,7 +67,21 @@ dependencies:
       - !ruby/object:Gem::Version
         version: 13.0.1
 - !ruby/object:Gem::Dependency
-  name: sorbet
+  name: erubi
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 1.10.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 1.10.0
+- !ruby/object:Gem::Dependency
+  name: sorbet-static-and-runtime
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
@@ -81,19 +95,19 @@ dependencies:
       - !ruby/object:Gem::Version
         version: 0.5.10187
 - !ruby/object:Gem::Dependency
-  name: sorbet-runtime
+  name: syntax_tree
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: 0.5.9204
+        version: 6.1.1
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: 0.5.9204
+        version: 6.1.1
 - !ruby/object:Gem::Dependency
   name: thor
   requirement: !ruby/object:Gem::Requirement
@@ -143,6 +157,17 @@ files:
 - lib/spoom/coverage/d3/timeline.rb
 - lib/spoom/coverage/report.rb
 - lib/spoom/coverage/snapshot.rb
+- lib/spoom/deadcode.rb
+- lib/spoom/deadcode/definition.rb
+- lib/spoom/deadcode/erb.rb
+- lib/spoom/deadcode/index.rb
+- lib/spoom/deadcode/indexer.rb
+- lib/spoom/deadcode/location.rb
+- lib/spoom/deadcode/plugins.rb
+- lib/spoom/deadcode/plugins/base.rb
+- lib/spoom/deadcode/plugins/ruby.rb
+- lib/spoom/deadcode/reference.rb
+- lib/spoom/deadcode/send.rb
 - lib/spoom/file_collector.rb
 - lib/spoom/file_tree.rb
 - lib/spoom/printer.rb
@@ -173,14 +198,14 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: 2.7.0
+      version: 3.0.0
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.4.9
+rubygems_version: 3.4.17
 signing_key: 
 specification_version: 4
 summary: Useful tools for Sorbet enthusiasts.