spoom 1.8.7 → 1.8.8

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: e5c2341851ed3a30add3601c9ea08a4913b9ecebe17c7da96002de914874d3d8
-  data.tar.gz: 127b2b8f6771f0f75d09d7d7d1bd269c069f4d5776e4a7bd5e7fdf92db9d8f6e
+  metadata.gz: f156e3fd1596713d8fb893ba5e4e0cdc127fc9ee1a21006c751773178e4eb1d3
+  data.tar.gz: 84ce5c28958b0fe1b45251336dc283e005738b3c0d280a7f8cb5b643d4b8e8da
 SHA512:
-  metadata.gz: 6eaaabb907a1d9e625dc44756b9ddcaae59270b96a080c37331979d2450403e3bc6f6b72c483db782c49983799f4dd7f7ed0cbe114462349ff30e356d6779039
-  data.tar.gz: 80b4dae7fd1c464b80fdfa4345f57d02512391f0d500cc62b4ea22aac2491074fd32dd471e225e1c5e25fd8d196bcf779e2c561da4c4a0de4332989c133b6a7f
+  metadata.gz: 98c8db47ce06755ac7ca5b3426f4f0413d611297240f28d19e767f3c76230c5ed963f54e51b092b6d5361f41b4c7a000423355ef4d4eb445d6ebe334c870c5f5
+  data.tar.gz: 4c7a33cef72bc373fe5f7bd9f3230669d301baab006a26f5ce7c0483d627e3dd01e30b5a215282d3c537c77b10b5cc20eff739259bec6bfbb55851b6a654eb39

data/lib/spoom/cli/deadcode.rb

@@ -106,7 +106,7 @@ module Spoom
           index.definitions.each do |name, definitions|
             $stderr.puts "  #{blue(name)}"
             definitions.each do |definition|
-              $stderr.puts "    #{yellow(definition.kind.serialize)} #{gray(definition.location.to_s)}"
+              $stderr.puts "    #{yellow(definition.kind.to_s)} #{gray(definition.location.to_s)}"
             end
           end
           $stderr.puts
@@ -116,7 +116,7 @@ module Spoom
           $stderr.puts "\nReferences:"
           index.references.values.flatten.sort_by(&:name).each do |references|
             name = references.name
-            kind = references.kind.serialize
+            kind = references.kind.to_s
             loc = references.location.to_s
             $stderr.puts "  #{blue(name)} #{yellow(kind)} #{gray(loc)}"
           end

data/lib/spoom/cli/srb/coverage.rb

@@ -156,11 +156,11 @@ module Spoom
           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],
+            ignore_color: options[:color_ignore],
+            false_color: options[:color_false],
+            true_color: options[:color_true],
+            strict_color: options[:color_strict],
+            strong_color: options[:color_strong],
           )
 
           report = Spoom::Coverage.report(context, snapshots, palette: palette)

data/lib/spoom/colors.rb

@@ -2,34 +2,35 @@
 # frozen_string_literal: true
 
 module Spoom
-  class Color < T::Enum
-    enums do
-      CLEAR           = new("\e[0m")
-      BOLD            = new("\e[1m")
+  class Color
+    #: String
+    attr_reader :ansi_code
 
-      BLACK           = new("\e[30m")
-      RED             = new("\e[31m")
-      GREEN           = new("\e[32m")
-      YELLOW          = new("\e[33m")
-      BLUE            = new("\e[34m")
-      MAGENTA         = new("\e[35m")
-      CYAN            = new("\e[36m")
-      WHITE           = new("\e[37m")
-
-      LIGHT_BLACK     = new("\e[90m")
-      LIGHT_RED       = new("\e[91m")
-      LIGHT_GREEN     = new("\e[92m")
-      LIGHT_YELLOW    = new("\e[93m")
-      LIGHT_BLUE      = new("\e[94m")
-      LIGHT_MAGENTA   = new("\e[95m")
-      LIGHT_CYAN      = new("\e[96m")
-      LIGHT_WHITE     = new("\e[97m")
+    #: (String) -> void
+    def initialize(ansi_code)
+      @ansi_code = ansi_code
     end
 
-    #: -> String
-    def ansi_code
-      serialize
-    end
+    CLEAR           = new("\e[0m") #: Color
+    BOLD            = new("\e[1m") #: Color
+
+    BLACK           = new("\e[30m") #: Color
+    RED             = new("\e[31m") #: Color
+    GREEN           = new("\e[32m") #: Color
+    YELLOW          = new("\e[33m") #: Color
+    BLUE            = new("\e[34m") #: Color
+    MAGENTA         = new("\e[35m") #: Color
+    CYAN            = new("\e[36m") #: Color
+    WHITE           = new("\e[37m") #: Color
+
+    LIGHT_BLACK     = new("\e[90m") #: Color
+    LIGHT_RED       = new("\e[91m") #: Color
+    LIGHT_GREEN     = new("\e[92m") #: Color
+    LIGHT_YELLOW    = new("\e[93m") #: Color
+    LIGHT_BLUE      = new("\e[94m") #: Color
+    LIGHT_MAGENTA   = new("\e[95m") #: Color
+    LIGHT_CYAN      = new("\e[96m") #: Color
+    LIGHT_WHITE     = new("\e[97m") #: Color
   end
 
   module Colorize

data/lib/spoom/context/exec.rb

@@ -4,11 +4,26 @@
 require "shellwords"
 
 module Spoom
-  class ExecResult < T::Struct
-    const :out, String
-    const :err, T.nilable(String)
-    const :status, T::Boolean
-    const :exit_code, Integer
+  class ExecResult
+    #: String
+    attr_reader :out
+
+    #: String?
+    attr_reader :err
+
+    #: bool
+    attr_reader :status
+
+    #: Integer
+    attr_reader :exit_code
+
+    #: (out: String, status: bool, exit_code: Integer, ?err: String?) -> void
+    def initialize(out:, status:, exit_code:, err: nil)
+      @out = out
+      @err = err
+      @status = status
+      @exit_code = exit_code
+    end
 
     #: -> String
     def to_s

data/lib/spoom/context/git.rb

@@ -3,7 +3,7 @@
 
 module Spoom
   module Git
-    class Commit < T::Struct
+    class Commit
       class << self
         # Parse a line formatted as `%h %at` into a `Commit`
         #: (String string) -> Commit?
@@ -16,8 +16,17 @@ module Spoom
         end
       end
 
-      const :sha, String
-      const :time, Time
+      #: String
+      attr_reader :sha
+
+      #: Time
+      attr_reader :time
+
+      #: (sha: String, time: Time) -> void
+      def initialize(sha:, time:)
+        @sha = sha
+        @time = time
+      end
 
       #: -> Integer
       def timestamp

data/lib/spoom/coverage/d3.rb

@@ -63,17 +63,17 @@ module Spoom
             function strictnessColor(strictness) {
               switch(strictness) {
                 case "ignore":
-                  return "#{palette.ignore}";
+                  return "#{palette.ignore_color}";
                 case "false":
-                  return "#{palette.false}";
+                  return "#{palette.false_color}";
                 case "true":
-                  return "#{palette.true}";
+                  return "#{palette.true_color}";
                 case "strict":
-                  return "#{palette.strict}";
+                  return "#{palette.strict_color}";
                 case "strong":
-                  return "#{palette.strong}";
+                  return "#{palette.strong_color}";
               }
-              return "#{palette.false}";
+              return "#{palette.false_color}";
             }
 
             function toPercent(value, sum) {
@@ -98,12 +98,36 @@ module Spoom
         end
       end
 
-      class ColorPalette < T::Struct
-        prop :ignore, String
-        prop :false, String
-        prop :true, String
-        prop :strict, String
-        prop :strong, String
+      class ColorPalette
+        #: String
+        attr_accessor :ignore_color
+
+        #: String
+        attr_accessor :false_color
+
+        #: String
+        attr_accessor :true_color
+
+        #: String
+        attr_accessor :strict_color
+
+        #: String
+        attr_accessor :strong_color
+
+        #: (
+        #|   ignore_color: String,
+        #|   false_color: String,
+        #|   true_color: String,
+        #|   strict_color: String,
+        #|   strong_color: String
+        #| ) -> void
+        def initialize(ignore_color:, false_color:, true_color:, strict_color:, strong_color:)
+          @ignore_color = ignore_color
+          @false_color = false_color
+          @true_color = true_color
+          @strict_color = strict_color
+          @strong_color = strong_color
+        end
       end
     end
   end

data/lib/spoom/coverage/snapshot.rb

@@ -3,26 +3,126 @@
 
 module Spoom
   module Coverage
-    class Snapshot < T::Struct
-      prop :timestamp, Integer, default: Time.new.getutc.to_i
-      prop :version_static, T.nilable(String), default: nil
-      prop :version_runtime, T.nilable(String), default: nil
-      prop :duration, Integer, default: 0
-      prop :commit_sha, T.nilable(String), default: nil
-      prop :commit_timestamp, T.nilable(Integer), default: nil
-      prop :files, Integer, default: 0
-      prop :rbi_files, Integer, default: 0
-      prop :modules, Integer, default: 0
-      prop :classes, Integer, default: 0
-      prop :singleton_classes, Integer, default: 0
-      prop :methods_without_sig, Integer, default: 0
-      prop :methods_with_sig, Integer, default: 0
-      prop :calls_untyped, Integer, default: 0
-      prop :calls_typed, Integer, default: 0
-      prop :sigils, T::Hash[String, Integer], default: Hash.new(0)
-      prop :methods_with_sig_excluding_rbis, Integer, default: 0
-      prop :methods_without_sig_excluding_rbis, Integer, default: 0
-      prop :sigils_excluding_rbis, T::Hash[String, Integer], default: Hash.new(0)
+    class Snapshot
+      #: Integer
+      attr_accessor :timestamp
+
+      #: String?
+      attr_accessor :version_static
+
+      #: String?
+      attr_accessor :version_runtime
+
+      #: Integer
+      attr_accessor :duration
+
+      #: String?
+      attr_accessor :commit_sha
+
+      #: Integer?
+      attr_accessor :commit_timestamp
+
+      #: Integer
+      attr_accessor :files
+
+      #: Integer
+      attr_accessor :rbi_files
+
+      #: Integer
+      attr_accessor :modules
+
+      #: Integer
+      attr_accessor :classes
+
+      #: Integer
+      attr_accessor :singleton_classes
+
+      #: Integer
+      attr_accessor :methods_without_sig
+
+      #: Integer
+      attr_accessor :methods_with_sig
+
+      #: Integer
+      attr_accessor :calls_untyped
+
+      #: Integer
+      attr_accessor :calls_typed
+
+      #: Hash[String, Integer]
+      attr_accessor :sigils
+
+      #: Integer
+      attr_accessor :methods_with_sig_excluding_rbis
+
+      #: Integer
+      attr_accessor :methods_without_sig_excluding_rbis
+
+      #: Hash[String, Integer]
+      attr_accessor :sigils_excluding_rbis
+
+      #: (
+      #|   ?timestamp: Integer,
+      #|   ?version_static: String?,
+      #|   ?version_runtime: String?,
+      #|   ?duration: Integer,
+      #|   ?commit_sha: String?,
+      #|   ?commit_timestamp: Integer?,
+      #|   ?files: Integer,
+      #|   ?rbi_files: Integer,
+      #|   ?modules: Integer,
+      #|   ?classes: Integer,
+      #|   ?singleton_classes: Integer,
+      #|   ?methods_without_sig: Integer,
+      #|   ?methods_with_sig: Integer,
+      #|   ?calls_untyped: Integer,
+      #|   ?calls_typed: Integer,
+      #|   ?sigils: Hash[String, Integer],
+      #|   ?methods_with_sig_excluding_rbis: Integer,
+      #|   ?methods_without_sig_excluding_rbis: Integer,
+      #|   ?sigils_excluding_rbis: Hash[String, Integer],
+      #|  ) -> void
+      def initialize(
+        timestamp: Time.new.getutc.to_i,
+        version_static: nil,
+        version_runtime: nil,
+        duration: 0,
+        commit_sha: nil,
+        commit_timestamp: nil,
+        files: 0,
+        rbi_files: 0,
+        modules: 0,
+        classes: 0,
+        singleton_classes: 0,
+        methods_without_sig: 0,
+        methods_with_sig: 0,
+        calls_untyped: 0,
+        calls_typed: 0,
+        sigils: Hash.new(0),
+        methods_with_sig_excluding_rbis: 0,
+        methods_without_sig_excluding_rbis: 0,
+        sigils_excluding_rbis: Hash.new(0)
+      )
+        @timestamp = timestamp
+        @version_static = version_static
+        @version_runtime = version_runtime
+        @duration = duration
+        @commit_sha = commit_sha
+        @commit_timestamp = commit_timestamp
+        @files = files
+        @rbi_files = rbi_files
+        @modules = modules
+        @classes = classes
+        @singleton_classes = singleton_classes
+        @methods_without_sig = methods_without_sig
+        @methods_with_sig = methods_with_sig
+        @calls_untyped = calls_untyped
+        @calls_typed = calls_typed
+        @sigils = sigils
+        @methods_with_sig_excluding_rbis = methods_with_sig_excluding_rbis
+        @methods_without_sig_excluding_rbis = methods_without_sig_excluding_rbis
+        @sigils_excluding_rbis = sigils_excluding_rbis
+      end
 
       # The strictness name as found in the Sorbet metrics file
       STRICTNESSES = ["ignore", "false", "true", "strict", "strong", "stdlib"].freeze #: Array[String]
@@ -35,7 +135,33 @@ module Spoom
 
       #: (*untyped arg) -> String
       def to_json(*arg)
-        serialize.to_json(*arg)
+        to_h #: untyped
+          .to_json(*arg)
+      end
+
+      #: -> Hash[String, untyped]
+      def to_h
+        {
+          "timestamp" => timestamp,
+          "version_static" => version_static,
+          "version_runtime" => version_runtime,
+          "duration" => duration,
+          "commit_sha" => commit_sha,
+          "commit_timestamp" => commit_timestamp,
+          "files" => files,
+          "rbi_files" => rbi_files,
+          "modules" => modules,
+          "classes" => classes,
+          "singleton_classes" => singleton_classes,
+          "methods_with_sig" => methods_with_sig,
+          "methods_without_sig" => methods_without_sig,
+          "calls_typed" => calls_typed,
+          "calls_untyped" => calls_untyped,
+          "sigils" => sigils,
+          "methods_with_sig_excluding_rbis" => methods_with_sig_excluding_rbis,
+          "methods_without_sig_excluding_rbis" => methods_without_sig_excluding_rbis,
+          "sigils_excluding_rbis" => sigils_excluding_rbis,
+        }
       end
 
       class << self

data/lib/spoom/deadcode/definition.rb

@@ -4,34 +4,59 @@
 module Spoom
   module Deadcode
     # A definition is a class, module, method, constant, etc. being defined in the code
-    class Definition < T::Struct
-      class Kind < T::Enum
-        enums do
-          AttrReader = new("attr_reader")
-          AttrWriter = new("attr_writer")
-          Class = new("class")
-          Constant = new("constant")
-          Method = new("method")
-          Module = new("module")
+    class Definition
+      class Kind
+        #: (String) -> void
+        def initialize(name)
+          @name = name
         end
-      end
 
-      class Status < T::Enum
-        enums do
-          # A definition is marked as `ALIVE` if it has at least one reference with the same name
-          ALIVE = new
-          # A definition is marked as `DEAD` if it has no reference with the same name
-          DEAD = new
-          # A definition can be marked as `IGNORED` if it is not relevant for the analysis
-          IGNORED = new
+        # @override
+        #: -> String
+        def to_s
+          @name
         end
+
+        AttrReader = new("attr_reader") #: Kind
+        AttrWriter = new("attr_writer") #: Kind
+        Class = new("class") #: Kind
+        Constant = new("constant") #: Kind
+        Method = new("method") #: Kind
+        Module = new("module") #: Kind
       end
 
-      const :kind, Kind
-      const :name, String
-      const :full_name, String
-      const :location, Location
-      const :status, Status, default: Status::DEAD
+      class Status
+        # A definition is marked as `ALIVE` if it has at least one reference with the same name
+        ALIVE = new #: Status
+        # A definition is marked as `DEAD` if it has no reference with the same name
+        DEAD = new #: Status
+        # A definition can be marked as `IGNORED` if it is not relevant for the analysis
+        IGNORED = new #: Status
+      end
+
+      #: Kind
+      attr_reader :kind
+
+      #: String
+      attr_reader :name
+
+      #: String
+      attr_reader :full_name
+
+      #: Location
+      attr_reader :location
+
+      #: Status
+      attr_reader :status
+
+      #: (kind: Kind, name: String, full_name: String, location: Location, ?status: Status) -> void
+      def initialize(kind:, name:, full_name:, location:, status: Status::DEAD)
+        @kind = kind
+        @name = name
+        @full_name = full_name
+        @location = location
+        @status = status
+      end
 
       # Kind
 

data/lib/spoom/deadcode/remover.rb

@@ -356,21 +356,9 @@ module Spoom
 
         #: (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
-
-          # TODO: remove once Prism location are fixed
           node = context.node
-          case node
-          when Prism::ConstantWriteNode, Prism::ConstantOperatorWriteNode,
-                Prism::ConstantAndWriteNode, Prism::ConstantOrWriteNode,
-                Prism::ConstantPathWriteNode, Prism::ConstantPathOperatorWriteNode,
-                Prism::ConstantPathAndWriteNode, Prism::ConstantPathOrWriteNode
-            value = node.value
-            if value.is_a?(Prism::StringNode)
-              end_line = value.closing_loc&.start_line || value.location.end_line
-            end
-          end
+          start_line = node.location.start_line
+          end_line = node_end_line(node)
 
           # Adjust the lines to remove to include sigs attached to the node
           first_node = context.attached_sigs.first || context.node
@@ -388,13 +376,16 @@ module Spoom
           # if there is, we only want to delete lines up to the last comment found
           if before
             to_node = first_comment || node
-            comment = @node_context.comments_between_lines(before.location.end_line, to_node.location.start_line).last
+            comment = @node_context.comments_between_lines(node_end_line(before), to_node.location.start_line).last
             before = comment if comment
           end
 
-          if before && before.location.end_line < start_line - 1
+          # `before` may have been swapped for a comment just above, so resolve its end line after that
+          before_end_line = node_end_line(before) if before
+
+          if before_end_line && before_end_line < start_line - 1
             # There is a node before and a blank line
-            start_line = before.location.end_line + 1
+            start_line = before_end_line + 1
           elsif before.nil?
             # There is no node before, check if there is a blank line
             parent_context = context.parent_context
@@ -417,6 +408,45 @@ module Spoom
           delete_lines(start_line, end_line)
         end
 
+        # Prism reports a node ending in a heredoc as ending on the heredoc's opening line rather than
+        # its closing terminator (e.g. `def_node_matcher :foo, <<~PATTERN` spanning several lines).
+        # Return the last line the node actually occupies so the heredoc body isn't mistaken for blank
+        # filler, either when deleting the node itself or when accounting for the node that follows it.
+        # TODO: remove once Prism locations are fixed
+        #: ((Prism::Node | Prism::Comment) node) -> Integer
+        def node_end_line(node)
+          end_line = node.location.end_line
+          return end_line unless node.is_a?(Prism::Node)
+
+          stack = [node] #: Array[Prism::Node]
+          until stack.empty?
+            child = stack.pop
+            next unless child
+
+            heredoc_end = heredoc_terminator_line(child)
+            end_line = heredoc_end if heredoc_end && heredoc_end > end_line
+            stack.concat(child.compact_child_nodes)
+          end
+          end_line
+        end
+
+        # The last line occupied by `node` if it is a heredoc string (its closing terminator), or `nil`
+        # otherwise.
+        #: (Prism::Node node) -> Integer?
+        def heredoc_terminator_line(node)
+          case node
+          when Prism::StringNode, Prism::InterpolatedStringNode,
+               Prism::XStringNode, Prism::InterpolatedXStringNode
+            opening = node.opening_loc
+            return unless opening&.slice&.start_with?("<<")
+
+            # The terminator's location runs to the newline (column 0 of the next line), so use its
+            # start line rather than its end line.
+            closing = node.closing_loc
+            closing ? closing.start_line : node.location.end_line
+          end
+        end
+
         #: (Integer start_line, Integer end_line) -> void
         def delete_lines(start_line, end_line)
           lines = @new_source.lines
@@ -688,6 +718,8 @@ module Spoom
               node.is_a?(Prism::DefNode)
             when Definition::Kind::Module
               node.is_a?(Prism::ModuleNode)
+            else
+              raise Error, "Unsupported node kind: #{node.class}"
             end
           end
         end

data/lib/spoom/deadcode/send.rb

@@ -4,13 +4,41 @@
 module Spoom
   module Deadcode
     # An abstraction to simplify handling of Prism::CallNode nodes.
-    class Send < T::Struct
-      const :node, Prism::CallNode
-      const :name, String
-      const :recv, T.nilable(Prism::Node), default: nil
-      const :args, T::Array[Prism::Node], default: []
-      const :block, T.nilable(Prism::Node), default: nil
-      const :location, Location
+    class Send
+      #: Prism::CallNode
+      attr_reader :node
+
+      #: String
+      attr_reader :name
+
+      #: Prism::Node?
+      attr_reader :recv
+
+      #: Array[Prism::Node]
+      attr_reader :args
+
+      #: Prism::Node?
+      attr_reader :block
+
+      #: Location
+      attr_reader :location
+
+      #: (
+      #|   node: Prism::CallNode,
+      #|   name: String,
+      #|   location: Location,
+      #|   ?recv: Prism::Node?,
+      #|   ?args: Array[Prism::Node],
+      #|   ?block: Prism::Node?
+      #| ) -> void
+      def initialize(node:, name:, location:, recv: nil, args: [], block: nil)
+        @node = node
+        @name = name
+        @recv = recv
+        @args = args
+        @block = block
+        @location = location
+      end
 
       #: [T] (Class[T] arg_type) { (T arg) -> void } -> void
       def each_arg(arg_type, &block)