spoom 1.7.2 → 1.7.4

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 59987238a3b2bae115f02d1da2a7e2a4cd6b3532d816bbe80d9153fa7819f989
-  data.tar.gz: d7e6bccfa046b7c457cb3e5d3d4383141243949021bd584b22cde0db0cc165ef
+  metadata.gz: e63e36fda1906fc8f047e6c4abab3ab8c887035f9e7b6c4c1d2c07d55ae3adaf
+  data.tar.gz: bf63f0df57b0c6dbed78a6a10021a6e94cdbbddbb8e072d145805829dae78cf2
 SHA512:
-  metadata.gz: b2f53478b7fdee59bfa7c579c3686b6d6c388db8737584c02f613daa2c4d42c0be2c1baaa39c50e90137697f62d7b8bb04e9fdbb458defdfa7813be3b6cbbd36
-  data.tar.gz: 57b26d457d2235bedaff15c832accc34a9c5ffcb89876306394f12b74a87ce03964d0309cd62e213e9954607150968607227436ebeb522a84f27782f7cc8cac8
+  metadata.gz: 51d63f6ef122e99b679f317fe2082df8956c7f0e25cf11afd612395101edf67e025698ef2e9a4deac795c0d49077e18cbf9e46771313536deb79f3aec5e31d21
+  data.tar.gz: bb0a342c5c8ac4bfd0a5310d2ced6541b13d0980fdab309124fca657192fcb8fefe34bde16a347d3974563989f38713a1519a389f803a7c1ace4b18e17fe1438

data/Gemfile

@@ -5,6 +5,8 @@ source "https://rubygems.org"
 
 gemspec
 
+gem "minitest"
+
 group :development do
   gem "debug"
   gem "rubocop-shopify", require: false

data/lib/spoom/cli/helper.rb

@@ -7,13 +7,10 @@ require "stringio"
 
 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)

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

@@ -16,15 +16,26 @@ module Spoom
           desc: "Use positional names when translating from RBI to RBS",
           default: true
         option :include_rbi_files, type: :boolean, desc: "Include RBI files", default: false
+        option :max_line_length, type: :numeric, desc: "Max line length (pass 0 to disable)", default: 120
         def translate(*paths)
           from = options[:from]
           to = options[:to]
+          max_line_length = options[:max_line_length]
 
           if from == to
             say_error("Can't translate signatures from `#{from}` to `#{to}`")
             exit(1)
           end
 
+          if max_line_length.nil? || max_line_length.zero?
+            max_line_length = nil
+          elsif max_line_length.negative?
+            say_error("--max-line-length can't be negative")
+            exit(1)
+          else
+            max_line_length = max_line_length.to_i
+          end
+
           files = collect_files(paths, include_rbi_files: options[:include_rbi_files])
 
           say("Translating signatures from `#{from}` to `#{to}` " \
@@ -33,11 +44,20 @@ module Spoom
           case from
           when "rbi"
             transformed_files = transform_files(files) do |file, contents|
-              Spoom::Sorbet::Translate.sorbet_sigs_to_rbs_comments(contents, file: file, positional_names: options[:positional_names])
+              Spoom::Sorbet::Translate.sorbet_sigs_to_rbs_comments(
+                contents,
+                file: file,
+                positional_names: options[:positional_names],
+                max_line_length: max_line_length,
+              )
             end
           when "rbs"
             transformed_files = transform_files(files) do |file, contents|
-              Spoom::Sorbet::Translate.rbs_comments_to_sorbet_sigs(contents, file: file)
+              Spoom::Sorbet::Translate.rbs_comments_to_sorbet_sigs(
+                contents,
+                file: file,
+                max_line_length: max_line_length,
+              )
             end
           end
 

data/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

data/lib/spoom/context/exec.rb

@@ -22,11 +22,8 @@ module Spoom
 
   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)

data/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)

data/lib/spoom/context/git.rb

@@ -28,11 +28,8 @@ module Spoom
 
   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)

data/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)

data/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 @@ module Spoom
           ""
         end
 
-        sig { abstract.returns(String) }
+        # @abstract
+        #: -> String
         def script; end
       end
     end

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

@@ -6,11 +6,8 @@ require_relative "base"
 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)

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

@@ -6,11 +6,8 @@ require_relative "base"
 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 @@ module Spoom
           HTML
         end
 
-        sig { abstract.returns(String) }
+        # @abstract
+        #: -> String
         def plot; end
 
         #: -> String
@@ -324,11 +322,8 @@ module Spoom
           end
         end
 
+        # @abstract
         class Stacked < Timeline
-          extend T::Helpers
-
-          abstract!
-
           # @override
           #: -> String
           def script

data/lib/spoom/coverage/report.rb

@@ -7,11 +7,8 @@ require "erb"
 
 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 @@ module Spoom
       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 @@ module Spoom
         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 @@ module Spoom
 
     module Cards
       class Card < Template
-        extend T::Sig
-
         TEMPLATE = "#{Spoom::SPOOM_PATH}/templates/card.erb" #: String
 
         #: String?
@@ -101,11 +93,8 @@ module Spoom
         end
       end
 
+      # @abstract
       class Erb < Card
-        extend T::Helpers
-
-        abstract!
-
         #: -> void
         def initialize; end # rubocop:disable Lint/MissingSuper
 
@@ -115,7 +104,8 @@ module Spoom
           ERB.new(erb).result(get_binding)
         end
 
-        sig { abstract.returns(String) }
+        # @abstract
+        #: -> String
         def erb; end
       end
 

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

@@ -7,6 +7,25 @@ module Spoom
       class ActiveJob < Base
         ignore_classes_named("ApplicationJob")
         ignore_methods_named("perform", "build_enumerator", "each_iteration")
+
+        CALLBACKS = [
+          "after_enqueue",
+          "after_perform",
+          "around_enqueue",
+          "around_perform",
+          "before_enqueue",
+          "before_perform",
+        ].freeze
+
+        # @override
+        #: (Send send) -> void
+        def on_send(send)
+          return unless send.recv.nil? && CALLBACKS.include?(send.name)
+
+          send.each_arg(Prism::SymbolNode) do |arg|
+            @index.reference_method(arg.unescaped, send.location)
+          end
+        end
       end
     end
   end

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

@@ -6,11 +6,8 @@ require "set"
 module Spoom
   module Deadcode
     module Plugins
+      # @abstract
       class Base
-        extend T::Helpers
-
-        abstract!
-
         class << self
           # Plugins DSL
 

data/lib/spoom/file_tree.rb

@@ -94,11 +94,8 @@ module Spoom
     end
 
     # An abstract visitor for FileTree
+    # @abstract
     class Visitor
-      extend T::Helpers
-
-      abstract!
-
       #: (FileTree tree) -> void
       def visit_tree(tree)
         visit_nodes(tree.roots)

data/lib/spoom/model/model.rb

@@ -63,11 +63,8 @@ module Spoom
     #
     # 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 @@ module Spoom
     end
 
     # A class or module
+    # @abstract
     class Namespace < SymbolDef
-      abstract!
-
       #: Array[SymbolDef]
       attr_reader :children
 
@@ -156,9 +152,8 @@ module Spoom
     end
 
     # A method or an attribute accessor
+    # @abstract
     class Property < SymbolDef
-      abstract!
-
       #: Visibility
       attr_reader :visibility
 
@@ -176,8 +171,8 @@ module Spoom
 
     class Method < Property; end
 
+    # @abstract
     class Attr < Property
-      abstract!
     end
 
     class AttrReader < Attr; end
@@ -193,11 +188,8 @@ module Spoom
     end
 
     # A mixin (include, prepend, extend) to a namespace
+    # @abstract
     class Mixin
-      extend T::Helpers
-
-      abstract!
-
       #: String
       attr_reader :name
 
@@ -234,7 +226,7 @@ module Spoom
     #: -> 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

data/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()

data/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 @@ module Spoom
       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 @@ module Spoom
     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

data/lib/spoom/rbs.rb

@@ -4,7 +4,7 @@
 module Spoom
   module RBS
     class Comments
-      #: Array[Annotations]
+      #: Array[Annotation]
       attr_reader :annotations
 
       #: Array[Signature]
@@ -12,7 +12,7 @@ module Spoom
 
       #: -> void
       def initialize
-        @annotations = [] #: Array[Annotations]
+        @annotations = [] #: Array[Annotation]
         @signatures = [] #: Array[Signature]
       end
 
@@ -20,6 +20,32 @@ module Spoom
       def empty?
         @annotations.empty? && @signatures.empty?
       end
+
+      #: -> Array[Annotation]
+      def class_annotations
+        @annotations.select do |annotation|
+          case annotation.string
+          when "@abstract", "@interface", "@sealed", "@final"
+            true
+          when /^@requires_ancestor: /
+            true
+          else
+            false
+          end
+        end
+      end
+
+      #: -> Array[Annotation]
+      def method_annotations
+        @annotations.select do |annotation|
+          case annotation.string
+          when "@abstract", "@final", "@override", "@override(allow_incompatible: true)", "@overridable", "@without_runtime"
+            true
+          else
+            false
+          end
+        end
+      end
     end
 
     class Comment
@@ -36,7 +62,7 @@ module Spoom
       end
     end
 
-    class Annotations < Comment; end
+    class Annotation < Comment; end
     class Signature < Comment; end
 
     module ExtractRBSComments
@@ -54,7 +80,7 @@ module Spoom
 
           if string.start_with?("# @")
             string = string.delete_prefix("#").strip
-            res.annotations << Annotations.new(string, comment.location)
+            res.annotations << Annotation.new(string, comment.location)
           elsif string.start_with?("#: ")
             string = string.delete_prefix("#:").strip
             location = comment.location

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

@@ -6,13 +6,10 @@ require "set"
 
 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
 

data/lib/spoom/sorbet/metrics/code_metrics_visitor.rb

@@ -34,9 +34,6 @@ module Spoom
       class CodeMetricsVisitor < Spoom::Visitor
         include RBS::ExtractRBSComments
 
-        #: Counters
-        attr_reader :counters
-
         #: (Spoom::Counters) -> void
         def initialize(counters)
           super()

data/lib/spoom/sorbet/translate/rbs_comments_to_sorbet_sigs.rb

@@ -7,6 +7,13 @@ module Spoom
       class RBSCommentsToSorbetSigs < Translator
         include Spoom::RBS::ExtractRBSComments
 
+        #: (String, file: String, ?max_line_length: Integer?) -> void
+        def initialize(ruby_contents, file:, max_line_length: nil)
+          super(ruby_contents, file: file)
+
+          @max_line_length = max_line_length
+        end
+
         # @override
         #: (Prism::ClassNode node) -> void
         def visit_class_node(node)
@@ -48,14 +55,14 @@ module Spoom
             translator = RBI::RBS::MethodTypeTranslator.new(rbi_node)
             translator.visit(method_type)
             sig = translator.result
-            apply_member_annotations(comments.annotations, sig)
+            apply_member_annotations(comments.method_annotations, sig)
 
             @rewriter << Source::Replace.new(
               signature.location.start_offset,
               signature.location.end_offset,
-              sig.string,
+              sig.string(max_line_length: @max_line_length),
             )
-          rescue ::RBS::ParsingError
+          rescue ::RBS::ParsingError, ::RBI::Error
             # Ignore signatures with errors
             next
           end
@@ -99,13 +106,16 @@ module Spoom
 
             sig.return_type = RBI::RBS::TypeTranslator.translate(attr_type)
 
-            apply_member_annotations(comments.annotations, sig)
+            apply_member_annotations(comments.method_annotations, sig)
 
             @rewriter << Source::Replace.new(
               signature.location.start_offset,
               signature.location.end_offset,
-              sig.string,
+              sig.string(max_line_length: @max_line_length),
             )
+          rescue ::RBS::ParsingError, ::RBI::Error
+            # Ignore signatures with errors
+            next
           end
         end
 
@@ -124,12 +134,13 @@ module Spoom
             node.expression.location.end_offset
           end
 
-          if comments.annotations.any?
+          class_annotations = comments.class_annotations
+          if class_annotations.any?
             unless already_extends?(node, /^(::)?T::Helpers$/)
               @rewriter << Source::Insert.new(insert_pos, "\n#{indent}extend T::Helpers\n")
             end
 
-            comments.annotations.reverse_each do |annotation|
+            class_annotations.reverse_each do |annotation|
               from = adjust_to_line_start(annotation.location.start_offset)
               to = adjust_to_line_end(annotation.location.end_offset)
 
@@ -154,6 +165,9 @@ module Spoom
 
               newline = node.body.nil? ? "" : "\n"
               @rewriter << Source::Insert.new(insert_pos, "\n#{indent}#{content}#{newline}")
+            rescue ::RBS::ParsingError, ::RBI::Error
+              # Ignore annotations with errors
+              next
             end
           end
 
@@ -195,12 +209,15 @@ module Spoom
 
                 newline = node.body.nil? ? "" : "\n"
                 @rewriter << Source::Insert.new(insert_pos, "\n#{indent}#{type_member}#{newline}")
+              rescue ::RBS::ParsingError, ::RBI::Error
+                # Ignore signatures with errors
+                next
               end
             end
           end
         end
 
-        #: (Array[RBS::Annotations], RBI::Sig) -> void
+        #: (Array[RBS::Annotation], RBI::Sig) -> void
         def apply_member_annotations(annotations, sig)
           annotations.each do |annotation|
             case annotation.string