spoom 1.5.4 → 1.6.0

data/lib/spoom/context/file_system.rb

@@ -5,32 +5,31 @@ module Spoom
   class Context
     # File System features for a context
     module FileSystem
-      extend T::Sig
       extend T::Helpers
 
       requires_ancestor { Context }
 
       # Returns the absolute path to `relative_path` in the context's directory
-      sig { params(relative_path: String).returns(String) }
+      #: (String relative_path) -> String
       def absolute_path_to(relative_path)
         File.join(absolute_path, relative_path)
       end
 
       # Does the context directory at `absolute_path` exist and is a directory?
-      sig { returns(T::Boolean) }
+      #: -> bool
       def exist?
         File.directory?(absolute_path)
       end
 
       # Create the context directory at `absolute_path`
-      sig { void }
+      #: -> void
       def mkdir!
         FileUtils.rm_rf(absolute_path)
         FileUtils.mkdir_p(absolute_path)
       end
 
       # List all files in this context matching `pattern`
-      sig { params(pattern: String).returns(T::Array[String]) }
+      #: (?String pattern) -> Array[String]
       def glob(pattern = "**/*")
         Dir.glob(absolute_path_to(pattern)).map do |path|
           Pathname.new(path).relative_path_from(absolute_path).to_s
@@ -38,18 +37,12 @@ module Spoom
       end
 
       # List all files at the top level of this context directory
-      sig { returns(T::Array[String]) }
+      #: -> Array[String]
       def list
         glob("*")
       end
 
-      sig do
-        params(
-          allow_extensions: T::Array[String],
-          allow_mime_types: T::Array[String],
-          exclude_patterns: T::Array[String],
-        ).returns(T::Array[String])
-      end
+      #: (?allow_extensions: Array[String], ?allow_mime_types: Array[String], ?exclude_patterns: Array[String]) -> Array[String]
       def collect_files(allow_extensions: [], allow_mime_types: [], exclude_patterns: [])
         collector = FileCollector.new(
           allow_extensions: allow_extensions,
@@ -61,7 +54,7 @@ module Spoom
       end
 
       # Does `relative_path` point to an existing file in this context directory?
-      sig { params(relative_path: String).returns(T::Boolean) }
+      #: (String relative_path) -> bool
       def file?(relative_path)
         File.file?(absolute_path_to(relative_path))
       end
@@ -69,7 +62,7 @@ module Spoom
       # Return the contents of the file at `relative_path` in this context directory
       #
       # Will raise if the file doesn't exist.
-      sig { params(relative_path: String).returns(String) }
+      #: (String relative_path) -> String
       def read(relative_path)
         File.read(absolute_path_to(relative_path))
       end
@@ -77,7 +70,7 @@ module Spoom
       # Write `contents` in the file at `relative_path` in this context directory
       #
       # Append to the file if `append` is true.
-      sig { params(relative_path: String, contents: String, append: T::Boolean).void }
+      #: (String relative_path, ?String contents, ?append: bool) -> void
       def write!(relative_path, contents = "", append: false)
         absolute_path = absolute_path_to(relative_path)
         FileUtils.mkdir_p(File.dirname(absolute_path))
@@ -85,13 +78,13 @@ module Spoom
       end
 
       # Remove the path at `relative_path` (recursive + force) in this context directory
-      sig { params(relative_path: String).void }
+      #: (String relative_path) -> void
       def remove!(relative_path)
         FileUtils.rm_rf(absolute_path_to(relative_path))
       end
 
       # Move the file or directory from `from_relative_path` to `to_relative_path`
-      sig { params(from_relative_path: String, to_relative_path: String).void }
+      #: (String from_relative_path, String to_relative_path) -> void
       def move!(from_relative_path, to_relative_path)
         destination_path = absolute_path_to(to_relative_path)
         FileUtils.mkdir_p(File.dirname(destination_path))
@@ -101,7 +94,7 @@ module Spoom
       # Delete this context and its content
       #
       # Warning: it will `rm -rf` the context directory on the file system.
-      sig { void }
+      #: -> void
       def destroy!
         FileUtils.rm_rf(absolute_path)
       end

data/lib/spoom/context/git.rb

@@ -4,13 +4,9 @@
 module Spoom
   module Git
     class Commit < T::Struct
-      extend T::Sig
-
       class << self
-        extend T::Sig
-
         # Parse a line formatted as `%h %at` into a `Commit`
-        sig { params(string: String).returns(T.nilable(Commit)) }
+        #: (String string) -> Commit?
         def parse_line(string)
           sha, epoch = string.split(" ", 2)
           return unless sha && epoch
@@ -23,7 +19,7 @@ module Spoom
       const :sha, String
       const :time, Time
 
-      sig { returns(Integer) }
+      #: -> Integer
       def timestamp
         time.to_i
       end
@@ -33,13 +29,12 @@ module Spoom
   class Context
     # Git features for a context
     module Git
-      extend T::Sig
       extend T::Helpers
 
       requires_ancestor { Context }
 
       # Run a command prefixed by `git` in this context directory
-      sig { params(command: String).returns(ExecResult) }
+      #: (String command) -> ExecResult
       def git(command)
         exec("git #{command}")
       end
@@ -48,7 +43,7 @@ module Spoom
       #
       # Warning: passing a branch will run `git init -b <branch>` which is only available in git 2.28+.
       # In older versions, use `git_init!` followed by `git("checkout -b <branch>")`.
-      sig { params(branch: T.nilable(String)).returns(ExecResult) }
+      #: (?branch: String?) -> ExecResult
       def git_init!(branch: nil)
         if branch
           git("init -b #{branch}")
@@ -58,13 +53,13 @@ module Spoom
       end
 
       # Run `git checkout` in this context directory
-      sig { params(ref: String).returns(ExecResult) }
+      #: (?ref: String) -> ExecResult
       def git_checkout!(ref: "main")
         git("checkout #{ref}")
       end
 
       # Run `git checkout -b <branch-name> <ref>` in this context directory
-      sig { params(branch_name: String, ref: T.nilable(String)).returns(ExecResult) }
+      #: (String branch_name, ?ref: String?) -> ExecResult
       def git_checkout_new_branch!(branch_name, ref: nil)
         if ref
           git("checkout -b #{branch_name} #{ref}")
@@ -74,7 +69,7 @@ module Spoom
       end
 
       # Run `git add . && git commit` in this context directory
-      sig { params(message: String, time: Time, allow_empty: T::Boolean).returns(ExecResult) }
+      #: (?message: String, ?time: Time, ?allow_empty: bool) -> ExecResult
       def git_commit!(message: "message", time: Time.now.utc, allow_empty: false)
         git("add --all")
 
@@ -85,7 +80,7 @@ module Spoom
       end
 
       # Get the current git branch in this context directory
-      sig { returns(T.nilable(String)) }
+      #: -> String?
       def git_current_branch
         res = git("branch --show-current")
         return unless res.status
@@ -94,13 +89,13 @@ module Spoom
       end
 
       # Run `git diff` in this context directory
-      sig { params(arg: String).returns(ExecResult) }
+      #: (*String arg) -> ExecResult
       def git_diff(*arg)
         git("diff #{arg.join(" ")}")
       end
 
       # Get the last commit in the currently checked out branch
-      sig { params(short_sha: T::Boolean).returns(T.nilable(Spoom::Git::Commit)) }
+      #: (?short_sha: bool) -> Spoom::Git::Commit?
       def git_last_commit(short_sha: true)
         res = git_log("HEAD --format='%#{short_sha ? "h" : "H"} %at' -1")
         return unless res.status
@@ -111,24 +106,24 @@ module Spoom
         Spoom::Git::Commit.parse_line(out)
       end
 
-      sig { params(arg: String).returns(ExecResult) }
+      #: (*String arg) -> ExecResult
       def git_log(*arg)
         git("log #{arg.join(" ")}")
       end
 
       # Run `git push <remote> <ref>` in this context directory
-      sig { params(remote: String, ref: String, force: T::Boolean).returns(ExecResult) }
+      #: (String remote, String ref, ?force: bool) -> ExecResult
       def git_push!(remote, ref, force: false)
         git("push #{force ? "-f" : ""} #{remote} #{ref}")
       end
 
-      sig { params(arg: String).returns(ExecResult) }
+      #: (*String arg) -> ExecResult
       def git_show(*arg)
         git("show #{arg.join(" ")}")
       end
 
       # Is there uncommitted changes in this context directory?
-      sig { params(path: String).returns(T::Boolean) }
+      #: (?path: String) -> bool
       def git_workdir_clean?(path: ".")
         git_diff("HEAD").out.empty?
       end

data/lib/spoom/context/sorbet.rb

@@ -5,13 +5,12 @@ module Spoom
   class Context
     # Sorbet features for a context
     module Sorbet
-      extend T::Sig
       extend T::Helpers
 
       requires_ancestor { Context }
 
       # Run `bundle exec srb` in this context directory
-      sig { params(arg: String, sorbet_bin: T.nilable(String), capture_err: T::Boolean).returns(ExecResult) }
+      #: (*String arg, ?sorbet_bin: String?, ?capture_err: bool) -> ExecResult
       def srb(*arg, sorbet_bin: nil, capture_err: true)
         res = if sorbet_bin
           exec("#{sorbet_bin} #{arg.join(" ")}", capture_err: capture_err)
@@ -29,19 +28,13 @@ module Spoom
         res
       end
 
-      sig { params(arg: String, sorbet_bin: T.nilable(String), capture_err: T::Boolean).returns(ExecResult) }
+      #: (*String arg, ?sorbet_bin: String?, ?capture_err: bool) -> ExecResult
       def srb_tc(*arg, sorbet_bin: nil, capture_err: true)
         arg.prepend("tc") unless sorbet_bin
         T.unsafe(self).srb(*arg, sorbet_bin: sorbet_bin, capture_err: capture_err)
       end
 
-      sig do
-        params(
-          arg: String,
-          sorbet_bin: T.nilable(String),
-          capture_err: T::Boolean,
-        ).returns(T.nilable(T::Hash[String, Integer]))
-      end
+      #: (*String arg, ?sorbet_bin: String?, ?capture_err: bool) -> Hash[String, Integer]?
       def srb_metrics(*arg, sorbet_bin: nil, capture_err: true)
         metrics_file = "metrics.tmp"
 
@@ -61,7 +54,7 @@ module Spoom
       end
 
       # List all files typechecked by Sorbet from its `config`
-      sig { params(with_config: T.nilable(Spoom::Sorbet::Config), include_rbis: T::Boolean).returns(T::Array[String]) }
+      #: (?with_config: Spoom::Sorbet::Config?, ?include_rbis: bool) -> Array[String]
       def srb_files(with_config: nil, include_rbis: true)
         config = with_config || sorbet_config
 
@@ -94,19 +87,13 @@ module Spoom
       end
 
       # List all files typechecked by Sorbet from its `config` that matches `strictness`
-      sig do
-        params(
-          strictness: String,
-          with_config: T.nilable(Spoom::Sorbet::Config),
-          include_rbis: T::Boolean,
-        ).returns(T::Array[String])
-      end
+      #: (String strictness, ?with_config: Spoom::Sorbet::Config?, ?include_rbis: bool) -> Array[String]
       def srb_files_with_strictness(strictness, with_config: nil, include_rbis: true)
         srb_files(with_config: with_config, include_rbis: include_rbis)
           .select { |file| read_file_strictness(file) == strictness }
       end
 
-      sig { params(arg: String, sorbet_bin: T.nilable(String), capture_err: T::Boolean).returns(T.nilable(String)) }
+      #: (*String arg, ?sorbet_bin: String?, ?capture_err: bool) -> String?
       def srb_version(*arg, sorbet_bin: nil, capture_err: true)
         res = T.unsafe(self).srb_tc("--no-config", "--version", *arg, sorbet_bin: sorbet_bin, capture_err: capture_err)
         return unless res.status
@@ -115,36 +102,36 @@ module Spoom
       end
 
       # Does this context has a `sorbet/config` file?
-      sig { returns(T::Boolean) }
+      #: -> bool
       def has_sorbet_config?
         file?(Spoom::Sorbet::CONFIG_PATH)
       end
 
-      sig { returns(Spoom::Sorbet::Config) }
+      #: -> Spoom::Sorbet::Config
       def sorbet_config
         Spoom::Sorbet::Config.parse_string(read_sorbet_config)
       end
 
       # Read the contents of `sorbet/config` in this context directory
-      sig { returns(String) }
+      #: -> String
       def read_sorbet_config
         read(Spoom::Sorbet::CONFIG_PATH)
       end
 
       # Set the `contents` of `sorbet/config` in this context directory
-      sig { params(contents: String, append: T::Boolean).void }
+      #: (String contents, ?append: bool) -> void
       def write_sorbet_config!(contents, append: false)
         write!(Spoom::Sorbet::CONFIG_PATH, contents, append: append)
       end
 
       # Read the strictness sigil from the file at `relative_path` (returns `nil` if no sigil)
-      sig { params(relative_path: String).returns(T.nilable(String)) }
+      #: (String relative_path) -> String?
       def read_file_strictness(relative_path)
         Spoom::Sorbet::Sigils.file_strictness(absolute_path_to(relative_path))
       end
 
       # Get the commit introducing the `sorbet/config` file
-      sig { returns(T.nilable(Spoom::Git::Commit)) }
+      #: -> Spoom::Git::Commit?
       def sorbet_intro_commit
         res = git_log("--diff-filter=A --format='%h %at' -1 -- sorbet/config")
         return unless res.status
@@ -156,7 +143,7 @@ module Spoom
       end
 
       # Get the commit removing the `sorbet/config` file
-      sig { returns(T.nilable(Spoom::Git::Commit)) }
+      #: -> Spoom::Git::Commit?
       def sorbet_removal_commit
         res = git_log("--diff-filter=D --format='%h %at' -1 -- sorbet/config")
         return unless res.status

data/lib/spoom/context.rb

@@ -18,8 +18,6 @@ module Spoom
   # A context maps to a directory in the file system.
   # It is used to manipulate files and run commands in the context of this directory.
   class Context
-    extend T::Sig
-
     include Bundle
     include Exec
     include FileSystem
@@ -27,27 +25,25 @@ module Spoom
     include Sorbet
 
     class << self
-      extend T::Sig
-
       # Create a new context in the system's temporary directory
       #
       # `name` is used as prefix to the temporary directory name.
       # The directory will be created if it doesn't exist.
-      sig { params(name: T.nilable(String)).returns(T.attached_class) }
+      #: (?String? name) -> instance
       def mktmp!(name = nil)
         new(::Dir.mktmpdir(name))
       end
     end
 
     # The absolute path to the directory this context is about
-    sig { returns(String) }
+    #: String
     attr_reader :absolute_path
 
     # Create a new context about `absolute_path`
     #
     # The directory will not be created if it doesn't exist.
     # Call `#make!` to create it.
-    sig { params(absolute_path: String).void }
+    #: (String absolute_path) -> void
     def initialize(absolute_path)
       @absolute_path = T.let(::File.expand_path(absolute_path), String)
     end

data/lib/spoom/coverage/d3/base.rb

@@ -10,30 +10,28 @@ module Spoom
 
         abstract!
 
-        sig { returns(String) }
+        #: String
         attr_reader :id
 
-        sig { params(id: String, data: T.untyped).void }
+        #: (String id, untyped data) -> void
         def initialize(id, data)
           @id = id
           @data = data
         end
 
         class << self
-          extend T::Sig
-
-          sig { returns(String) }
+          #: -> String
           def header_style
             ""
           end
 
-          sig { returns(String) }
+          #: -> String
           def header_script
             ""
           end
         end
 
-        sig { returns(String) }
+        #: -> String
         def html
           <<~HTML
             <svg id="#{id}"></svg>
@@ -41,7 +39,7 @@ module Spoom
           HTML
         end
 
-        sig { returns(String) }
+        #: -> String
         def tooltip
           ""
         end

data/lib/spoom/coverage/d3/circle_map.rb

@@ -8,9 +8,7 @@ module Spoom
     module D3
       class CircleMap < Base
         class << self
-          extend T::Sig
-
-          sig { returns(String) }
+          #: -> String
           def header_style
             <<~CSS
               .node {
@@ -36,7 +34,7 @@ module Spoom
             CSS
           end
 
-          sig { returns(String) }
+          #: -> String
           def header_script
             <<~JS
               function treeHeight(root, height = 0) {
@@ -55,7 +53,8 @@ module Spoom
           end
         end
 
-        sig { override.returns(String) }
+        # @override
+        #: -> String
         def script
           <<~JS
             var root = {children: #{@data.to_json}}
@@ -146,23 +145,14 @@ module Spoom
         end
 
         class Sigils < CircleMap
-          extend T::Sig
-
-          sig do
-            params(
-              id: String,
-              file_tree: FileTree,
-              nodes_strictnesses: T::Hash[FileTree::Node, T.nilable(String)],
-              nodes_scores: T::Hash[FileTree::Node, Float],
-            ).void
-          end
+          #: (String id, FileTree file_tree, Hash[FileTree::Node, String?] nodes_strictnesses, Hash[FileTree::Node, Float] nodes_scores) -> void
           def initialize(id, file_tree, nodes_strictnesses, nodes_scores)
             @nodes_strictnesses = nodes_strictnesses
             @nodes_scores = nodes_scores
             super(id, file_tree.roots.map { |r| tree_node_to_json(r) })
           end
 
-          sig { params(node: FileTree::Node).returns(T::Hash[Symbol, T.untyped]) }
+          #: (FileTree::Node node) -> Hash[Symbol, untyped]
           def tree_node_to_json(node)
             if node.children.empty?
               {

data/lib/spoom/coverage/d3/pie.rb

@@ -7,21 +7,18 @@ module Spoom
   module Coverage
     module D3
       class Pie < Base
-        extend T::Sig
         extend T::Helpers
 
         abstract!
 
-        sig { params(id: String, title: String, data: T.untyped).void }
+        #: (String id, String title, untyped data) -> void
         def initialize(id, title, data)
           super(id, data)
           @title = title
         end
 
         class << self
-          extend T::Sig
-
-          sig { returns(String) }
+          #: -> String
           def header_style
             <<~CSS
               .pie .title {
@@ -39,7 +36,7 @@ module Spoom
             CSS
           end
 
-          sig { returns(String) }
+          #: -> String
           def header_script
             <<~JS
               function tooltipPie(d, title, kind, sum) {
@@ -52,7 +49,8 @@ module Spoom
           end
         end
 
-        sig { override.returns(String) }
+        # @override
+        #: -> String
         def script
           <<~JS
             #{tooltip}
@@ -121,14 +119,13 @@ module Spoom
         end
 
         class Sigils < Pie
-          extend T::Sig
-
-          sig { params(id: String, title: String, snapshot: Snapshot).void }
+          #: (String id, String title, Snapshot snapshot) -> void
           def initialize(id, title, snapshot)
             super(id, title, snapshot.sigils_excluding_rbis.select { |_k, v| v })
           end
 
-          sig { override.returns(String) }
+          # @override
+          #: -> String
           def tooltip
             <<~JS
               function tooltip_#{id}(d) {
@@ -139,14 +136,13 @@ module Spoom
         end
 
         class Calls < Pie
-          extend T::Sig
-
-          sig { params(id: String, title: String, snapshot: Snapshot).void }
+          #: (String id, String title, Snapshot snapshot) -> void
           def initialize(id, title, snapshot)
             super(id, title, { true: snapshot.calls_typed, false: snapshot.calls_untyped })
           end
 
-          sig { override.returns(String) }
+          # @override
+          #: -> String
           def tooltip
             <<~JS
               function tooltip_#{id}(d) {
@@ -157,9 +153,7 @@ module Spoom
         end
 
         class Sigs < Pie
-          extend T::Sig
-
-          sig { params(id: String, title: String, snapshot: Snapshot).void }
+          #: (String id, String title, Snapshot snapshot) -> void
           def initialize(id, title, snapshot)
             super(
               id,
@@ -168,7 +162,8 @@ module Spoom
             )
           end
 
-          sig { override.returns(String) }
+          # @override
+          #: -> String
           def tooltip
             <<~JS
               function tooltip_#{id}(d) {