Merge pull request #762 from Shopify/at-rbs-helpers

Morriar · web-flow · commit db5e88fec49c · 2025-06-11T12:25:50.000-04:00
Translate Sorbet helpers to RBs comments
diff --git a/lib/spoom/cli/helper.rb b/lib/spoom/cli/helper.rb
@@ -7,13 +7,10 @@
 
 module Spoom
   module Cli
+    # @requires_ancestor: Thor
     module Helper
-      extend T::Helpers
-
       include Colorize
 
-      requires_ancestor { Thor }
-
       # Print `message` on `$stdout`
       #: (String message) -> void
       def say(message)
diff --git a/lib/spoom/context/bundle.rb b/lib/spoom/context/bundle.rb
@@ -4,11 +4,8 @@
 module Spoom
   class Context
     # Bundle features for a context
+    # @requires_ancestor: Context
     module Bundle
-      extend T::Helpers
-
-      requires_ancestor { Context }
-
       # Read the contents of the Gemfile in this context directory
       #: -> String?
       def read_gemfile
diff --git a/lib/spoom/context/exec.rb b/lib/spoom/context/exec.rb
@@ -22,11 +22,8 @@ def to_s
 
   class Context
     # Execution features for a context
+    # @requires_ancestor: Context
     module Exec
-      extend T::Helpers
-
-      requires_ancestor { Context }
-
       # Run a command in this context directory
       #: (String command, ?capture_err: bool) -> ExecResult
       def exec(command, capture_err: true)
diff --git a/lib/spoom/context/file_system.rb b/lib/spoom/context/file_system.rb
@@ -4,11 +4,8 @@
 module Spoom
   class Context
     # File System features for a context
+    # @requires_ancestor: Context
     module FileSystem
-      extend T::Helpers
-
-      requires_ancestor { Context }
-
       # Returns the absolute path to `relative_path` in the context's directory
       #: (String relative_path) -> String
       def absolute_path_to(relative_path)
diff --git a/lib/spoom/context/git.rb b/lib/spoom/context/git.rb
@@ -28,11 +28,8 @@ def timestamp
 
   class Context
     # Git features for a context
+    # @requires_ancestor: Context
     module Git
-      extend T::Helpers
-
-      requires_ancestor { Context }
-
       # Run a command prefixed by `git` in this context directory
       #: (String command) -> ExecResult
       def git(command)
diff --git a/lib/spoom/context/sorbet.rb b/lib/spoom/context/sorbet.rb
@@ -4,11 +4,8 @@
 module Spoom
   class Context
     # Sorbet features for a context
+    # @requires_ancestor: Context
     module Sorbet
-      extend T::Helpers
-
-      requires_ancestor { Context }
-
       # Run `bundle exec srb` in this context directory
       #: (*String arg, ?sorbet_bin: String?, ?capture_err: bool) -> ExecResult
       def srb(*arg, sorbet_bin: nil, capture_err: true)
diff --git a/lib/spoom/coverage/d3/base.rb b/lib/spoom/coverage/d3/base.rb
@@ -4,12 +4,8 @@
 module Spoom
   module Coverage
     module D3
+      # @abstract
       class Base
-        extend T::Sig
-        extend T::Helpers
-
-        abstract!
-
         #: String
         attr_reader :id
 
@@ -44,7 +40,8 @@ def tooltip
           ""
         end
 
-        sig { abstract.returns(String) }
+        # @abstract
+        #: -> String
         def script; end
       end
     end
diff --git a/lib/spoom/coverage/d3/pie.rb b/lib/spoom/coverage/d3/pie.rb
@@ -6,11 +6,8 @@
 module Spoom
   module Coverage
     module D3
+      # @abstract
       class Pie < Base
-        extend T::Helpers
-
-        abstract!
-
         #: (String id, String title, untyped data) -> void
         def initialize(id, title, data)
           super(id, data)
diff --git a/lib/spoom/coverage/d3/timeline.rb b/lib/spoom/coverage/d3/timeline.rb
@@ -6,11 +6,8 @@
 module Spoom
   module Coverage
     module D3
+      # @abstract
       class Timeline < Base
-        extend T::Helpers
-
-        abstract!
-
         #: (String id, untyped data, Array[String] keys) -> void
         def initialize(id, data, keys)
           super(id, data)
@@ -120,7 +117,8 @@ def script
           HTML
         end
 
-        sig { abstract.returns(String) }
+        # @abstract
+        #: -> String
         def plot; end
 
         #: -> String
@@ -324,11 +322,8 @@ def plot
           end
         end
 
+        # @abstract
         class Stacked < Timeline
-          extend T::Helpers
-
-          abstract!
-
           # @override
           #: -> String
           def script
diff --git a/lib/spoom/coverage/report.rb b/lib/spoom/coverage/report.rb
@@ -7,11 +7,8 @@
 
 module Spoom
   module Coverage
+    # @abstract
     class Template
-      extend T::Helpers
-
-      abstract!
-
       # Create a new template from an Erb file path
       #: (template: String) -> void
       def initialize(template:)
@@ -34,12 +31,8 @@ def get_binding # rubocop:disable Naming/AccessorMethodName
       end
     end
 
+    # @abstract
     class Page < Template
-      extend T::Sig
-      extend T::Helpers
-
-      abstract!
-
       TEMPLATE = "#{Spoom::SPOOM_PATH}/templates/page.erb" #: String
 
       #: String
@@ -75,7 +68,8 @@ def body_html
         cards.map(&:html).join("\n")
       end
 
-      sig { abstract.returns(T::Array[Cards::Card]) }
+      # @abstract
+      #: -> Array[Cards::Card]
       def cards; end
 
       #: -> String
@@ -86,8 +80,6 @@ def footer_html
 
     module Cards
       class Card < Template
-        extend T::Sig
-
         TEMPLATE = "#{Spoom::SPOOM_PATH}/templates/card.erb" #: String
 
         #: String?
@@ -101,11 +93,8 @@ def initialize(template: TEMPLATE, title: nil, body: nil)
         end
       end
 
+      # @abstract
       class Erb < Card
-        extend T::Helpers
-
-        abstract!
-
         #: -> void
         def initialize; end # rubocop:disable Lint/MissingSuper
 
@@ -115,7 +104,8 @@ def html
           ERB.new(erb).result(get_binding)
         end
 
-        sig { abstract.returns(String) }
+        # @abstract
+        #: -> String
         def erb; end
       end
 
diff --git a/lib/spoom/deadcode/plugins/base.rb b/lib/spoom/deadcode/plugins/base.rb
@@ -6,11 +6,8 @@
 module Spoom
   module Deadcode
     module Plugins
+      # @abstract
       class Base
-        extend T::Helpers
-
-        abstract!
-
         class << self
           # Plugins DSL
 
diff --git a/lib/spoom/file_tree.rb b/lib/spoom/file_tree.rb
@@ -94,11 +94,8 @@ def path
     end
 
     # An abstract visitor for FileTree
+    # @abstract
     class Visitor
-      extend T::Helpers
-
-      abstract!
-
       #: (FileTree tree) -> void
       def visit_tree(tree)
         visit_nodes(tree.roots)
diff --git a/lib/spoom/model/model.rb b/lib/spoom/model/model.rb
@@ -63,11 +63,8 @@ def to_s
     #
     # It can be a class, module, constant, method, etc.
     # A SymbolDef has a location pointing to the actual code that defines the symbol.
+    # @abstract
     class SymbolDef
-      extend T::Helpers
-
-      abstract!
-
       # The symbol this definition belongs to
       #: Symbol
       attr_reader :symbol
@@ -109,9 +106,8 @@ def name
     end
 
     # A class or module
+    # @abstract
     class Namespace < SymbolDef
-      abstract!
-
       #: Array[SymbolDef]
       attr_reader :children
 
@@ -156,9 +152,8 @@ def initialize(symbol, owner:, location:, value:, comments: [])
     end
 
     # A method or an attribute accessor
+    # @abstract
     class Property < SymbolDef
-      abstract!
-
       #: Visibility
       attr_reader :visibility
 
@@ -176,8 +171,8 @@ def initialize(symbol, owner:, location:, visibility:, sigs: [], comments: [])
 
     class Method < Property; end
 
+    # @abstract
     class Attr < Property
-      abstract!
     end
 
     class AttrReader < Attr; end
@@ -193,11 +188,8 @@ class Visibility < T::Enum
     end
 
     # A mixin (include, prepend, extend) to a namespace
+    # @abstract
     class Mixin
-      extend T::Helpers
-
-      abstract!
-
       #: String
       attr_reader :name
 
@@ -234,7 +226,7 @@ def initialize(string)
     #: -> void
     def initialize
       @symbols = {} #: Hash[String, Symbol]
-      @symbols_hierarchy = Poset[Symbol].new #: Poset[Symbol]
+      @symbols_hierarchy = Poset.new #: Poset[Symbol]
     end
 
     # Get a symbol by it's full name
diff --git a/lib/spoom/model/namespace_visitor.rb b/lib/spoom/model/namespace_visitor.rb
@@ -3,11 +3,8 @@
 
 module Spoom
   class Model
+    # @abstract
     class NamespaceVisitor < Visitor
-      extend T::Helpers
-
-      abstract!
-
       #: -> void
       def initialize
         super()
diff --git a/lib/spoom/poset.rb b/lib/spoom/poset.rb
@@ -6,13 +6,10 @@ module Spoom
   #
   # The partial order relation is a binary relation that is reflexive, antisymmetric, and transitive.
   # It can be used to represent a hierarchy of classes or modules, the dependencies between gems, etc.
+  #: [E < Object]
   class Poset
-    extend T::Generic
-
     class Error < Spoom::Error; end
 
-    E = type_member { { upper: Object } }
-
     #: -> void
     def initialize
       @elements = {} #: Hash[E, Element[E]]
@@ -35,7 +32,7 @@ def add_element(value)
       element = @elements[value]
       return element if element
 
-      @elements[value] = Element[E].new(value)
+      @elements[value] = Element.new(value) #: Element[E]
     end
 
     # Is the given value a element in the POSet?
@@ -132,12 +129,10 @@ def to_dot(direct: true, transitive: true)
     end
 
     # An element in a POSet
+    #: [E < Object]
     class Element
-      extend T::Generic
       include Comparable
 
-      E = type_member { { upper: Object } }
-
       # The value held by this element
       #: E
       attr_reader :value
diff --git a/lib/spoom/sorbet/lsp/structures.rb b/lib/spoom/sorbet/lsp/structures.rb
@@ -6,13 +6,10 @@
 
 module Spoom
   module LSP
+    # @interface
     module PrintableSymbol
-      extend T::Sig
-      extend T::Helpers
-
-      interface!
-
-      sig { abstract.params(printer: SymbolPrinter).void }
+      # @abstract
+      #: (SymbolPrinter printer) -> void
       def accept_printer(printer); end
     end
 
diff --git a/sorbet/config b/sorbet/config
@@ -2,5 +2,4 @@
 --ignore=vendor/
 --ignore=rbi/spoom.rbi
 --enable-experimental-requires-ancestor
---enable-experimental-rbs-signatures
---enable-experimental-rbs-assertions
+--enable-experimental-rbs-comments
diff --git a/test/helpers/deadcode_helper.rb b/test/helpers/deadcode_helper.rb
diff --git a/test/spoom/poset_test.rb b/test/spoom/poset_test.rb
diff --git a/test/test_helper.rb b/test/test_helper.rb
diff --git a/test/test_with_project.rb b/test/test_with_project.rb
