spoom 1.7.3 → 1.7.4

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: c8447b66e12a52fef3147761f8331749ba52cebaaba146888a7ca35a253acdf9
-  data.tar.gz: d6a84c3091e71c56d26aceebb40f3a6486589266c0b9b984268bf32036b98a26
+  metadata.gz: e63e36fda1906fc8f047e6c4abab3ab8c887035f9e7b6c4c1d2c07d55ae3adaf
+  data.tar.gz: bf63f0df57b0c6dbed78a6a10021a6e94cdbbddbb8e072d145805829dae78cf2
 SHA512:
-  metadata.gz: 9827d000700721b1e30028eedcaf41c5e5e45811e1b62693dbaa2d859b5adf379c5f5da4acbaac8e0a0a78a8bb4928fbd5d8a395b5527a7c1f3fc0a72f207cc3
-  data.tar.gz: a7c46380dc2e26c622b8b96290964ede0b5f455d060a176d1336db3aa09ca3e7dbccb656d7a6c1451e43406b0e9cf7847b9a985418b905ae8114c20dae294240
+  metadata.gz: 51d63f6ef122e99b679f317fe2082df8956c7f0e25cf11afd612395101edf67e025698ef2e9a4deac795c0d49077e18cbf9e46771313536deb79f3aec5e31d21
+  data.tar.gz: bb0a342c5c8ac4bfd0a5310d2ced6541b13d0980fdab309124fca657192fcb8fefe34bde16a347d3974563989f38713a1519a389f803a7c1ace4b18e17fe1438

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/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/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/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)
@@ -53,7 +60,7 @@ module Spoom
             @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
@@ -104,7 +111,7 @@ module Spoom
             @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

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

@@ -7,8 +7,8 @@ module Spoom
       # Converts all `sig` nodes to RBS comments in the given Ruby code.
       # It also handles type members and class annotations.
       class SorbetSigsToRBSComments < Translator
-        #: (String, file: String, positional_names: bool) -> void
-        def initialize(ruby_contents, file:, positional_names:)
+        #: (String, file: String, positional_names: bool, ?max_line_length: Integer?) -> void
+        def initialize(ruby_contents, file:, positional_names:, max_line_length: nil)
           super(ruby_contents, file: file)
 
           @positional_names = positional_names #: bool
@@ -18,6 +18,7 @@ module Spoom
           @extend_t_helpers = [] #: Array[Prism::CallNode]
           @extend_t_generics = [] #: Array[Prism::CallNode]
           @seen_mixes_in_class_methods = false #: bool
+          @max_line_length = max_line_length #: Integer?
         end
 
         # @override
@@ -53,12 +54,10 @@ module Spoom
           rbi_node = builder.tree.nodes.first #: as RBI::Method
 
           last_sigs.each do |node, sig|
-            out = StringIO.new
-            p = RBI::RBSPrinter.new(out: out, indent: node.location.start_column, positional_names: @positional_names)
-            p.print("#: ")
-            p.send(:print_method_sig, rbi_node, sig)
-            p.print("\n")
-            @rewriter << Source::Replace.new(node.location.start_offset, node.location.end_offset, out.string)
+            out = rbs_print(node.location.start_column) do |printer|
+              printer.print_method_sig(rbi_node, sig)
+            end
+            @rewriter << Source::Replace.new(node.location.start_offset, node.location.end_offset, out)
           end
         end
 
@@ -165,12 +164,10 @@ module Spoom
           rbi_node = builder.tree.nodes.first #: as RBI::Attr
 
           last_sigs.each do |node, sig|
-            out = StringIO.new
-            p = RBI::RBSPrinter.new(out: out, indent: node.location.start_column, positional_names: @positional_names)
-            p.print("#: ")
-            p.print_attr_sig(rbi_node, sig)
-            p.print("\n")
-            @rewriter << Source::Replace.new(node.location.start_offset, node.location.end_offset, out.string)
+            out = rbs_print(node.location.start_column) do |printer|
+              printer.print_attr_sig(rbi_node, sig)
+            end
+            @rewriter << Source::Replace.new(node.location.start_offset, node.location.end_offset, out)
           end
         end
 
@@ -342,6 +339,22 @@ module Spoom
           @last_sigs = []
           last_sigs
         end
+
+        #: (Integer) { (RBI::RBSPrinter) -> void } -> String
+        def rbs_print(indent, &block)
+          out = StringIO.new
+          p = RBI::RBSPrinter.new(out: out, positional_names: @positional_names, max_line_length: @max_line_length)
+          block.call(p)
+          string = out.string
+
+          string.lines.map.with_index do |line, index|
+            if index == 0
+              "#: #{line}"
+            else
+              "#{" " * indent}#| #{line}"
+            end
+          end.join + "\n"
+        end
       end
     end
   end

data/lib/spoom/sorbet/translate.rb

@@ -25,16 +25,16 @@ module Spoom
 
         # Converts all `sig` nodes to RBS comments in the given Ruby code.
         # It also handles type members and class annotations.
-        #: (String ruby_contents, file: String, ?positional_names: bool) -> String
-        def sorbet_sigs_to_rbs_comments(ruby_contents, file:, positional_names: true)
-          SorbetSigsToRBSComments.new(ruby_contents, file: file, positional_names: positional_names).rewrite
+        #: (String ruby_contents, file: String, ?positional_names: bool, ?max_line_length: Integer?) -> String
+        def sorbet_sigs_to_rbs_comments(ruby_contents, file:, positional_names: true, max_line_length: nil)
+          SorbetSigsToRBSComments.new(ruby_contents, file: file, positional_names: positional_names, max_line_length: max_line_length).rewrite
         end
 
         # Converts all the RBS comments in the given Ruby code to `sig` nodes.
         # It also handles type members and class annotations.
-        #: (String ruby_contents, file: String) -> String
-        def rbs_comments_to_sorbet_sigs(ruby_contents, file:)
-          RBSCommentsToSorbetSigs.new(ruby_contents, file: file).rewrite
+        #: (String ruby_contents, file: String, ?max_line_length: Integer?) -> String
+        def rbs_comments_to_sorbet_sigs(ruby_contents, file:, max_line_length: nil)
+          RBSCommentsToSorbetSigs.new(ruby_contents, file: file, max_line_length: max_line_length).rewrite
         end
 
         # Converts all `T.let` and `T.cast` nodes to RBS comments in the given Ruby code.

data/lib/spoom/version.rb

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

data/rbi/spoom.rbi

@@ -2839,14 +2839,21 @@ Spoom::Sorbet::Sigils::VALID_STRICTNESS = T.let(T.unsafe(nil), Array)
 
 module Spoom::Sorbet::Translate
   class << self
-    sig { params(ruby_contents: ::String, file: ::String).returns(::String) }
-    def rbs_comments_to_sorbet_sigs(ruby_contents, file:); end
+    sig { params(ruby_contents: ::String, file: ::String, max_line_length: T.nilable(::Integer)).returns(::String) }
+    def rbs_comments_to_sorbet_sigs(ruby_contents, file:, max_line_length: T.unsafe(nil)); end
 
     sig { params(ruby_contents: ::String, file: ::String).returns(::String) }
     def sorbet_assertions_to_rbs_comments(ruby_contents, file:); end
 
-    sig { params(ruby_contents: ::String, file: ::String, positional_names: T::Boolean).returns(::String) }
-    def sorbet_sigs_to_rbs_comments(ruby_contents, file:, positional_names: T.unsafe(nil)); end
+    sig do
+      params(
+        ruby_contents: ::String,
+        file: ::String,
+        positional_names: T::Boolean,
+        max_line_length: T.nilable(::Integer)
+      ).returns(::String)
+    end
+    def sorbet_sigs_to_rbs_comments(ruby_contents, file:, positional_names: T.unsafe(nil), max_line_length: T.unsafe(nil)); end
 
     sig { params(ruby_contents: ::String, file: ::String).returns(::String) }
     def strip_sorbet_sigs(ruby_contents, file:); end
@@ -2858,6 +2865,9 @@ class Spoom::Sorbet::Translate::Error < ::Spoom::Error; end
 class Spoom::Sorbet::Translate::RBSCommentsToSorbetSigs < ::Spoom::Sorbet::Translate::Translator
   include ::Spoom::RBS::ExtractRBSComments
 
+  sig { params(ruby_contents: ::String, file: ::String, max_line_length: T.nilable(::Integer)).void }
+  def initialize(ruby_contents, file:, max_line_length: T.unsafe(nil)); end
+
   sig { override.params(node: ::Prism::CallNode).void }
   def visit_call_node(node); end
 
@@ -2924,8 +2934,15 @@ end
 Spoom::Sorbet::Translate::SorbetAssertionsToRBSComments::LINE_BREAK = T.let(T.unsafe(nil), Integer)
 
 class Spoom::Sorbet::Translate::SorbetSigsToRBSComments < ::Spoom::Sorbet::Translate::Translator
-  sig { params(ruby_contents: ::String, file: ::String, positional_names: T::Boolean).void }
-  def initialize(ruby_contents, file:, positional_names:); end
+  sig do
+    params(
+      ruby_contents: ::String,
+      file: ::String,
+      positional_names: T::Boolean,
+      max_line_length: T.nilable(::Integer)
+    ).void
+  end
+  def initialize(ruby_contents, file:, positional_names:, max_line_length: T.unsafe(nil)); end
 
   sig { override.params(node: ::Prism::CallNode).void }
   def visit_call_node(node); end
@@ -2970,6 +2987,9 @@ class Spoom::Sorbet::Translate::SorbetSigsToRBSComments < ::Spoom::Sorbet::Trans
   sig { void }
   def delete_extend_t_helpers; end
 
+  sig { params(indent: ::Integer, block: T.proc.params(arg0: ::RBI::RBSPrinter).void).returns(::String) }
+  def rbs_print(indent, &block); end
+
   sig { params(node: ::Prism::CallNode).void }
   def visit_attr(node); end
 

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: spoom
 version: !ruby/object:Gem::Version
-  version: 1.7.3
+  version: 1.7.4
 platform: ruby
 authors:
 - Alexandre Terrasa