spoom 1.2.4 → 1.3.0

data/lib/spoom/deadcode.rb

@@ -2,8 +2,9 @@
 # frozen_string_literal: true
 
 require "erubi"
-require "syntax_tree"
+require "prism"
 
+require_relative "deadcode/visitor"
 require_relative "deadcode/erb"
 require_relative "deadcode/index"
 require_relative "deadcode/indexer"
@@ -18,10 +19,15 @@ require_relative "deadcode/remover"
 module Spoom
   module Deadcode
     class Error < Spoom::Error
-      extend T::Sig
       extend T::Helpers
 
       abstract!
+    end
+
+    class ParserError < Error; end
+
+    class IndexerError < Error
+      extend T::Sig
 
       sig { params(message: String, parent: Exception).void }
       def initialize(message, parent:)
@@ -30,23 +36,47 @@ module Spoom
       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)
+      sig { params(ruby: String, file: String).returns(Prism::Node) }
+      def parse_ruby(ruby, file:)
+        result = Prism.parse(ruby)
+        unless result.success?
+          message = +"Error while parsing #{file}:\n"
+
+          result.errors.each do |e|
+            message << "- #{e.message} (at #{e.location.start_line}:#{e.location.start_column})\n"
+          end
+
+          raise ParserError, message
+        end
+
+        result.value
+      end
+
+      sig do
+        params(
+          index: Index,
+          node: Prism::Node,
+          ruby: String,
+          file: String,
+          plugins: T::Array[Deadcode::Plugins::Base],
+        ).void
+      end
+      def index_node(index, node, ruby, file:, plugins: [])
         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, ruby: String, file: String, plugins: T::Array[Deadcode::Plugins::Base]).void }
+      def index_ruby(index, ruby, file:, plugins: [])
+        node = parse_ruby(ruby, file: file)
+        index_node(index, node, ruby, file: file, plugins: plugins)
+      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

data/lib/spoom/file_tree.rb

@@ -54,14 +54,6 @@ module Spoom
       nodes.map(&:path)
     end
 
-    # Return a map of strictnesses for each node in the tree
-    sig { params(context: Context).returns(T::Hash[Node, T.nilable(String)]) }
-    def nodes_strictnesses(context)
-      v = CollectStrictnesses.new(context)
-      v.visit_tree(self)
-      v.strictnesses
-    end
-
     # Return a map of typing scores for each node in the tree
     sig { params(context: Context).returns(T::Hash[Node, Float]) }
     def nodes_strictness_scores(context)
@@ -82,14 +74,6 @@ module Spoom
       printer.visit_tree(self)
     end
 
-    sig { params(context: Context, out: T.any(IO, StringIO), colors: T::Boolean).void }
-    def print_with_strictnesses(context, out: $stdout, colors: true)
-      strictnesses = nodes_strictnesses(context)
-
-      printer = Printer.new(strictnesses, out: out, colors: colors)
-      printer.visit_tree(self)
-    end
-
     # A node representing either a file or a directory inside a FileTree
     class Node < T::Struct
       extend T::Sig

data/lib/spoom/sorbet/errors.rb

@@ -76,7 +76,7 @@ module Spoom
             ^         # match beginning of line
             (\S[^:]*) # capture filename as something that starts with a non-space character
                       # followed by anything that is not a colon character
-            :         # match the filename - line number seperator
+            :         # match the filename - line number separator
             (\d+)     # capture the line number
             :\s       # match the line number - error message separator
             (.*)      # capture the error message

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

@@ -182,7 +182,7 @@ module Spoom
       const :range, LSP::Range
       const :code, Integer
       const :message, String
-      const :informations, Object
+      const :information, Object
 
       class << self
         extend T::Sig
@@ -193,7 +193,7 @@ module Spoom
             range: Range.from_json(json["range"]),
             code: json["code"].to_i,
             message: json["message"],
-            informations: json["relatedInformation"],
+            information: json["relatedInformation"],
           )
         end
       end

data/lib/spoom/version.rb

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

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: spoom
 version: !ruby/object:Gem::Version
-  version: 1.2.4
+  version: 1.3.0
 platform: ruby
 authors:
 - Alexandre Terrasa
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2023-09-15 00:00:00.000000000 Z
+date: 2024-03-26 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -58,14 +58,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 13.0.1
+        version: 13.1.0
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 13.0.1
+        version: 13.1.0
 - !ruby/object:Gem::Dependency
   name: erubi
   requirement: !ruby/object:Gem::Requirement
@@ -81,33 +81,33 @@ dependencies:
       - !ruby/object:Gem::Version
         version: 1.10.0
 - !ruby/object:Gem::Dependency
-  name: sorbet-static-and-runtime
+  name: prism
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: 0.5.10187
+        version: 0.19.0
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: 0.5.10187
+        version: 0.19.0
 - !ruby/object:Gem::Dependency
-  name: syntax_tree
+  name: sorbet-static-and-runtime
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: 6.1.1
+        version: 0.5.10187
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: 6.1.1
+        version: 0.5.10187
 - !ruby/object:Gem::Dependency
   name: thor
   requirement: !ruby/object:Gem::Requirement
@@ -137,12 +137,14 @@ files:
 - lib/spoom.rb
 - lib/spoom/backtrace_filter/minitest.rb
 - lib/spoom/cli.rb
-- lib/spoom/cli/bump.rb
 - lib/spoom/cli/config.rb
-- lib/spoom/cli/coverage.rb
+- lib/spoom/cli/deadcode.rb
 - lib/spoom/cli/helper.rb
-- lib/spoom/cli/lsp.rb
-- lib/spoom/cli/run.rb
+- lib/spoom/cli/srb.rb
+- lib/spoom/cli/srb/bump.rb
+- lib/spoom/cli/srb/coverage.rb
+- lib/spoom/cli/srb/lsp.rb
+- lib/spoom/cli/srb/tc.rb
 - lib/spoom/colors.rb
 - lib/spoom/context.rb
 - lib/spoom/context/bundle.rb
@@ -166,6 +168,7 @@ files:
 - lib/spoom/deadcode/location.rb
 - lib/spoom/deadcode/plugins.rb
 - lib/spoom/deadcode/plugins/action_mailer.rb
+- lib/spoom/deadcode/plugins/action_mailer_preview.rb
 - lib/spoom/deadcode/plugins/actionpack.rb
 - lib/spoom/deadcode/plugins/active_job.rb
 - lib/spoom/deadcode/plugins/active_model.rb
@@ -185,6 +188,7 @@ files:
 - lib/spoom/deadcode/reference.rb
 - lib/spoom/deadcode/remover.rb
 - lib/spoom/deadcode/send.rb
+- lib/spoom/deadcode/visitor.rb
 - lib/spoom/file_collector.rb
 - lib/spoom/file_tree.rb
 - lib/spoom/printer.rb
@@ -222,7 +226,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.4.19
+rubygems_version: 3.5.7
 signing_key: 
 specification_version: 4
 summary: Useful tools for Sorbet enthusiasts.

data/lib/spoom/cli/bump.rb

@@ -1,198 +0,0 @@
-# typed: true
-# frozen_string_literal: true
-
-require "find"
-require "open3"
-
-module Spoom
-  module Cli
-    class Bump < Thor
-      extend T::Sig
-      include Helper
-
-      default_task :bump
-
-      desc "bump DIRECTORY", "Change Sorbet sigils from one strictness to another when no errors"
-      option :from,
-        type: :string,
-        default: Spoom::Sorbet::Sigils::STRICTNESS_FALSE,
-        desc: "Change only files from this strictness"
-      option :to,
-        type: :string,
-        default: Spoom::Sorbet::Sigils::STRICTNESS_TRUE,
-        desc: "Change files to this strictness"
-      option :force,
-        type: :boolean,
-        default: false,
-        aliases: :f,
-        desc: "Change strictness without type checking"
-      option :sorbet, type: :string, desc: "Path to custom Sorbet bin"
-      option :dry,
-        type: :boolean,
-        default: false,
-        aliases: :d,
-        desc: "Only display what would happen, do not actually change sigils"
-      option :only,
-        type: :string,
-        default: nil,
-        aliases: :o,
-        desc: "Only change specified list (one file by line)"
-      option :suggest_bump_command,
-        type: :string,
-        desc: "Command to suggest if files can be bumped"
-      option :count_errors,
-        type: :boolean,
-        default: false,
-        desc: "Count the number of errors if all files were bumped"
-      option :sorbet_options, type: :string, default: "", desc: "Pass options to Sorbet"
-      sig { params(directory: String).void }
-      def bump(directory = ".")
-        context = context_requiring_sorbet!
-        from = options[:from]
-        to = options[:to]
-        force = options[:force]
-        dry = options[:dry]
-        only = options[:only]
-        cmd = options[:suggest_bump_command]
-        directory = File.expand_path(directory)
-        exec_path = File.expand_path(self.exec_path)
-
-        unless Sorbet::Sigils.valid_strictness?(from)
-          say_error("Invalid strictness `#{from}` for option `--from`")
-          exit(1)
-        end
-
-        unless Sorbet::Sigils.valid_strictness?(to)
-          say_error("Invalid strictness `#{to}` for option `--to`")
-          exit(1)
-        end
-
-        if options[:count_errors] && !dry
-          say_error("`--count-errors` can only be used with `--dry`")
-          exit(1)
-        end
-
-        say("Checking files...")
-
-        files_to_bump = context.srb_files_with_strictness(from, include_rbis: false)
-          .map { |file| File.expand_path(file, context.absolute_path) }
-          .select { |file| file.start_with?(directory) }
-
-        if only
-          list = File.read(only).lines.map { |file| File.expand_path(file.strip) }
-          files_to_bump.select! { |file| list.include?(File.expand_path(file)) }
-        end
-
-        say("\n")
-
-        if files_to_bump.empty?
-          say("No files to bump from `#{from}` to `#{to}`")
-          exit(0)
-        end
-
-        Sorbet::Sigils.change_sigil_in_files(files_to_bump, to)
-
-        if force
-          print_changes(files_to_bump, command: cmd, from: from, to: to, dry: dry, path: exec_path)
-          undo_changes(files_to_bump, from) if dry
-          exit(files_to_bump.empty?)
-        end
-
-        error_url_base = Spoom::Sorbet::Errors::DEFAULT_ERROR_URL_BASE
-        result = begin
-          T.unsafe(context).srb_tc(
-            *options[:sorbet_options].split(" "),
-            "--error-url-base=#{error_url_base}",
-            capture_err: true,
-            sorbet_bin: options[:sorbet],
-          )
-        rescue Spoom::Sorbet::Error::Segfault => error
-          say_error(<<~ERR, status: nil)
-            !!! Sorbet exited with code #{Spoom::Sorbet::SEGFAULT_CODE} - SEGFAULT !!!
-
-            This is most likely related to a bug in Sorbet.
-            It means one of the file bumped to `typed: #{to}` made Sorbet crash.
-            Run `spoom bump -f` locally followed by `bundle exec srb tc` to investigate the problem.
-          ERR
-          undo_changes(files_to_bump, from)
-          exit(error.result.exit_code)
-        rescue Spoom::Sorbet::Error::Killed => error
-          say_error(<<~ERR, status: nil)
-            !!! Sorbet exited with code #{Spoom::Sorbet::KILLED_CODE} - KILLED !!!
-
-            It means Sorbet was killed while executing. Changes to files have not been applied.
-            Re-run `spoom bump` to try again.
-          ERR
-          undo_changes(files_to_bump, from)
-          exit(error.result.exit_code)
-        end
-
-        if result.status
-          print_changes(files_to_bump, command: cmd, from: from, to: to, dry: dry, path: exec_path)
-          undo_changes(files_to_bump, from) if dry
-          exit(files_to_bump.empty?)
-        end
-
-        unless result.exit_code == 100
-          # Sorbet will return exit code 100 if there are type checking errors.
-          # If Sorbet returned something else, it means it didn't terminate normally.
-          say_error(result.err, status: nil, nl: false)
-          undo_changes(files_to_bump, from)
-          exit(1)
-        end
-
-        errors = Sorbet::Errors::Parser.parse_string(result.err, error_url_base: error_url_base)
-
-        all_files = errors.flat_map do |err|
-          [err.file, *err.files_from_error_sections]
-        end
-
-        files_with_errors = all_files.map do |file|
-          path = File.expand_path(file)
-          next unless path.start_with?(directory)
-          next unless File.file?(path)
-          next unless files_to_bump.include?(path)
-
-          path
-        end.compact.uniq
-
-        undo_changes(files_with_errors, from)
-
-        say("Found #{errors.length} type checking error#{"s" if errors.length > 1}") if options[:count_errors]
-
-        files_changed = files_to_bump - files_with_errors
-        print_changes(files_changed, command: cmd, from: from, to: to, dry: dry, path: exec_path)
-        undo_changes(files_to_bump, from) if dry
-        exit(files_changed.empty?)
-      end
-
-      no_commands do
-        def print_changes(files, command:, from: "false", to: "true", dry: false, path: File.expand_path("."))
-          files_count = files.size
-          if files_count.zero?
-            say("No files to bump from `#{from}` to `#{to}`")
-            return
-          end
-          message = StringIO.new
-          message << (dry ? "Can bump" : "Bumped")
-          message << " `#{files_count}` file#{"s" if files_count > 1}"
-          message << " from `#{from}` to `#{to}`:"
-          say(message.string)
-          files.each do |file|
-            file_path = Pathname.new(file).relative_path_from(path)
-            say(" + #{file_path}")
-          end
-          if dry && command
-            say("\nRun `#{command}` to bump #{files_count > 1 ? "them" : "it"}")
-          elsif dry
-            say("\nRun `spoom bump --from #{from} --to #{to}` locally then `commit the changes` and `push them`")
-          end
-        end
-
-        def undo_changes(files, from_strictness)
-          Sorbet::Sigils.change_sigil_in_files(files, from_strictness)
-        end
-      end
-    end
-  end
-end

data/lib/spoom/cli/coverage.rb

@@ -1,222 +0,0 @@
-# typed: true
-# frozen_string_literal: true
-
-require_relative "../coverage"
-require_relative "../timeline"
-
-module Spoom
-  module Cli
-    class Coverage < Thor
-      include Helper
-
-      DATA_DIR = "spoom_data"
-
-      default_task :snapshot
-
-      desc "snapshot", "Run srb tc and display metrics"
-      option :save, type: :string, lazy_default: DATA_DIR, desc: "Save snapshot data as json"
-      option :rbi, type: :boolean, default: true, desc: "Include RBI files in metrics"
-      option :sorbet, type: :string, desc: "Path to custom Sorbet bin"
-      def snapshot
-        context = context_requiring_sorbet!
-        sorbet = options[:sorbet]
-
-        snapshot = Spoom::Coverage.snapshot(context, rbi: options[:rbi], sorbet_bin: sorbet)
-        snapshot.print
-
-        save_dir = options[:save]
-        return unless save_dir
-
-        FileUtils.mkdir_p(save_dir)
-        file = "#{save_dir}/#{snapshot.commit_sha || snapshot.timestamp}.json"
-        File.write(file, snapshot.to_json)
-        say("\nSnapshot data saved under `#{file}`")
-      end
-
-      desc "timeline", "Replay a project and collect metrics"
-      option :from, type: :string, desc: "From commit date"
-      option :to, type: :string, default: Time.now.strftime("%F"), desc: "To commit date"
-      option :save, type: :string, lazy_default: DATA_DIR, desc: "Save snapshot data as json"
-      option :bundle_install, type: :boolean, desc: "Execute `bundle install` before collecting metrics"
-      option :sorbet, type: :string, desc: "Path to custom Sorbet bin"
-      def timeline
-        context = context_requiring_sorbet!
-        path = exec_path
-        sorbet = options[:sorbet]
-
-        ref_before = context.git_current_branch
-        ref_before = context.git_last_commit&.sha unless ref_before
-        unless ref_before
-          say_error("Not in a git repository")
-          say_error("\nSpoom needs to checkout into your previous commits to build the timeline.", status: nil)
-          exit(1)
-        end
-
-        unless context.git_workdir_clean?
-          say_error("Uncommited changes")
-          say_error(<<~ERR, status: nil)
-
-            Spoom needs to checkout into your previous commits to build the timeline."
-
-            Please `git commit` or `git stash` your changes then try again
-          ERR
-          exit(1)
-        end
-
-        save_dir = options[:save]
-        FileUtils.mkdir_p(save_dir) if save_dir
-
-        from = parse_time(options[:from], "--from")
-        to = parse_time(options[:to], "--to")
-
-        unless from
-          intro_commit = context.sorbet_intro_commit
-          intro_commit = T.must(intro_commit) # we know it's in there since in_sorbet_project!
-          from = intro_commit.time
-        end
-
-        timeline = Spoom::Timeline.new(context, from, to)
-        ticks = timeline.ticks
-
-        if ticks.empty?
-          say_error("No commits to replay, try different `--from` and `--to` options")
-          exit(1)
-        end
-
-        ticks.each_with_index do |commit, i|
-          say("Analyzing commit `#{commit.sha}` - #{commit.time.strftime("%F")} (#{i + 1} / #{ticks.size})")
-
-          context.git_checkout!(ref: commit.sha)
-
-          snapshot = T.let(nil, T.nilable(Spoom::Coverage::Snapshot))
-          if options[:bundle_install]
-            Bundler.with_unbundled_env do
-              next unless bundle_install(path, commit.sha)
-
-              snapshot = Spoom::Coverage.snapshot(context, sorbet_bin: sorbet)
-            end
-          else
-            snapshot = Spoom::Coverage.snapshot(context, sorbet_bin: sorbet)
-          end
-          next unless snapshot
-
-          snapshot.print(indent_level: 2)
-          say("\n")
-
-          next unless save_dir
-
-          file = "#{save_dir}/#{commit.sha}.json"
-          File.write(file, snapshot.to_json)
-          say("  Snapshot data saved under `#{file}`\n\n")
-        end
-        context.git_checkout!(ref: ref_before)
-      end
-
-      desc "report", "Produce a typing coverage report"
-      option :data, type: :string, default: DATA_DIR, desc: "Snapshots JSON data"
-      option :file,
-        type: :string,
-        default: "spoom_report.html",
-        aliases: :f,
-        desc: "Save report to file"
-      option :color_ignore,
-        type: :string,
-        default: Spoom::Coverage::D3::COLOR_IGNORE,
-        desc: "Color used for typed: ignore"
-      option :color_false,
-        type: :string,
-        default: Spoom::Coverage::D3::COLOR_FALSE,
-        desc: "Color used for typed: false"
-      option :color_true,
-        type: :string,
-        default: Spoom::Coverage::D3::COLOR_TRUE,
-        desc: "Color used for typed: true"
-      option :color_strict,
-        type: :string,
-        default: Spoom::Coverage::D3::COLOR_STRICT,
-        desc: "Color used for typed: strict"
-      option :color_strong,
-        type: :string,
-        default: Spoom::Coverage::D3::COLOR_STRONG,
-        desc: "Color used for typed: strong"
-      def report
-        context = context_requiring_sorbet!
-
-        data_dir = options[:data]
-        files = Dir.glob("#{data_dir}/*.json")
-        if files.empty?
-          message_no_data(data_dir)
-          exit(1)
-        end
-
-        snapshots = files.sort.map do |file|
-          json = File.read(file)
-          Spoom::Coverage::Snapshot.from_json(json)
-        end.filter(&:commit_timestamp).sort_by!(&:commit_timestamp)
-
-        palette = Spoom::Coverage::D3::ColorPalette.new(
-          ignore: options[:color_ignore],
-          false: options[:color_false],
-          true: options[:color_true],
-          strict: options[:color_strict],
-          strong: options[:color_strong],
-        )
-
-        report = Spoom::Coverage.report(context, snapshots, palette: palette)
-        file = options[:file]
-        File.write(file, report.html)
-        say("Report generated under `#{file}`")
-        say("\nUse `spoom coverage open` to open it.")
-      end
-
-      desc "open", "Open the typing coverage report"
-      def open(file = "spoom_report.html")
-        unless File.exist?(file)
-          say_error("No report file to open `#{file}`")
-          say_error(<<~ERR, status: nil)
-
-            If you already generated a report under another name use #{blue("spoom coverage open PATH")}.
-
-            To generate a report run #{blue("spoom coverage report")}.
-          ERR
-          exit(1)
-        end
-
-        exec("open #{file}")
-      end
-
-      no_commands do
-        def parse_time(string, option)
-          return unless string
-
-          Time.parse(string)
-        rescue ArgumentError
-          say_error("Invalid date `#{string}` for option `#{option}` (expected format `YYYY-MM-DD`)")
-          exit(1)
-        end
-
-        def bundle_install(path, sha)
-          opts = {}
-          opts[:chdir] = path
-          out, status = Open3.capture2e("bundle install", opts)
-          unless status.success?
-            say_error("Can't run `bundle install` for commit `#{sha}`. Skipping snapshot")
-            say_error(out, status: nil)
-            return false
-          end
-          true
-        end
-
-        def message_no_data(file)
-          say_error("No snapshot files found in `#{file}`")
-          say_error(<<~ERR, status: nil)
-
-            If you already generated snapshot files under another directory use #{blue("spoom coverage report PATH")}.
-
-            To generate snapshot files run #{blue("spoom coverage timeline --save")}.
-          ERR
-        end
-      end
-    end
-  end
-end