spoom 1.2.2 → 1.2.4

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

@@ -0,0 +1,21 @@
+# typed: strict
+# frozen_string_literal: true
+
+module Spoom
+  module Deadcode
+    module Plugins
+      class Thor < Base
+        extend T::Sig
+
+        ignore_methods_named("exit_on_failure?")
+
+        sig { override.params(indexer: Indexer, definition: Definition).void }
+        def on_define_method(indexer, definition)
+          return if indexer.nesting_block # method defined in `no_commands do ... end`, we don't want to ignore it
+
+          definition.ignored! if indexer.nesting_class_superclass_name =~ /^(::)?Thor$/
+        end
+      end
+    end
+  end
+end

data/lib/spoom/deadcode/plugins.rb

@@ -0,0 +1,95 @@
+# typed: strict
+# frozen_string_literal: true
+
+require_relative "plugins/base"
+
+require_relative "plugins/actionpack"
+require_relative "plugins/active_job"
+require_relative "plugins/action_mailer"
+require_relative "plugins/active_model"
+require_relative "plugins/active_record"
+require_relative "plugins/active_support"
+require_relative "plugins/graphql"
+require_relative "plugins/minitest"
+require_relative "plugins/namespaces"
+require_relative "plugins/rails"
+require_relative "plugins/rake"
+require_relative "plugins/rspec"
+require_relative "plugins/rubocop"
+require_relative "plugins/ruby"
+require_relative "plugins/sorbet"
+require_relative "plugins/thor"
+
+module Spoom
+  module Deadcode
+    DEFAULT_CUSTOM_PLUGINS_PATH = ".spoom/deadcode/plugins"
+
+    DEFAULT_PLUGINS = T.let(
+      Set.new([
+        Spoom::Deadcode::Plugins::Namespaces,
+        Spoom::Deadcode::Plugins::Ruby,
+      ]).freeze,
+      T::Set[T.class_of(Plugins::Base)],
+    )
+
+    PLUGINS_FOR_GEM = T.let(
+      {
+        "actionmailer" => Spoom::Deadcode::Plugins::ActionMailer,
+        "actionpack" => Spoom::Deadcode::Plugins::ActionPack,
+        "activejob" => Spoom::Deadcode::Plugins::ActiveJob,
+        "activemodel" => Spoom::Deadcode::Plugins::ActiveModel,
+        "activerecord" => Spoom::Deadcode::Plugins::ActiveRecord,
+        "activesupport" => Spoom::Deadcode::Plugins::ActiveSupport,
+        "graphql" => Spoom::Deadcode::Plugins::GraphQL,
+        "minitest" => Spoom::Deadcode::Plugins::Minitest,
+        "rails" => Spoom::Deadcode::Plugins::Rails,
+        "rake" => Spoom::Deadcode::Plugins::Rake,
+        "rspec" => Spoom::Deadcode::Plugins::RSpec,
+        "rubocop" => Spoom::Deadcode::Plugins::Rubocop,
+        "sorbet-runtime" => Spoom::Deadcode::Plugins::Sorbet,
+        "sorbet-static" => Spoom::Deadcode::Plugins::Sorbet,
+        "thor" => Spoom::Deadcode::Plugins::Thor,
+      }.freeze,
+      T::Hash[String, T.class_of(Plugins::Base)],
+    )
+
+    class << self
+      extend T::Sig
+
+      sig { params(context: Context).returns(T::Array[Plugins::Base]) }
+      def plugins_from_gemfile_lock(context)
+        # These plugins are always loaded
+        plugin_classes = DEFAULT_PLUGINS.dup
+
+        # These plugins depends on the gems used by the project
+        context.gemfile_lock_specs.keys.each do |name|
+          plugin_class = PLUGINS_FOR_GEM[name]
+          plugin_classes << plugin_class if plugin_class
+        end
+
+        plugin_classes.map(&:new)
+      end
+
+      sig { params(context: Context).returns(T::Array[Plugins::Base]) }
+      def load_custom_plugins(context)
+        context.glob("#{DEFAULT_CUSTOM_PLUGINS_PATH}/*.rb").each do |path|
+          require("#{context.absolute_path}/#{path}")
+        end
+
+        ObjectSpace
+          .each_object(Class)
+          .select do |klass|
+            next unless T.unsafe(klass).name # skip anonymous classes, we only use them in tests
+            next unless T.unsafe(klass) < Plugins::Base
+
+            location = Object.const_source_location(T.unsafe(klass).to_s)&.first
+            next unless location
+            next unless location.start_with?("#{context.absolute_path}/#{DEFAULT_CUSTOM_PLUGINS_PATH}")
+
+            true
+          end
+          .map { |klass| T.unsafe(klass).new }
+      end
+    end
+  end
+end