Merge pull request #805 from Shopify/at-rubocop-line-length

Morriar · web-flow · commit 2fd878b83938 · 2025-10-10T13:27:33.000-04:00
Migrate long RBS signature comments to multiline sigs
diff --git a/.rubocop.yml b/.rubocop.yml
@@ -1,7 +1,8 @@
 # This file strictly follows the rules defined in the Ruby style guide:
 #   http://shopify.github.io/ruby-style-guide/
 
-require: 'rubocop-sorbet'
+plugins:
+  - rubocop-sorbet
 
 inherit_gem:
   rubocop-shopify: rubocop.yml
@@ -17,8 +18,8 @@ Layout/LeadingCommentSpace:
   AllowRBSInlineAnnotation: true
 
 Layout/LineLength:
+  Enabled: true
   Max: 120
-  AllowedPatterns: ['\A\s*#:']
 
 Sorbet:
   Enabled: true
diff --git a/lib/spoom/context/file_system.rb b/lib/spoom/context/file_system.rb
@@ -39,7 +39,11 @@ def list
         glob("*")
       end
 
-      #: (?allow_extensions: Array[String], ?allow_mime_types: Array[String], ?exclude_patterns: Array[String]) -> Array[String]
+      #: (
+      #|   ?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,
diff --git a/lib/spoom/coverage/d3/circle_map.rb b/lib/spoom/coverage/d3/circle_map.rb
@@ -145,7 +145,12 @@ def script
         end
 
         class Sigils < CircleMap
-          #: (String id, FileTree file_tree, Hash[FileTree::Node, String?] nodes_strictnesses, Hash[FileTree::Node, Float] nodes_scores) -> void
+          #: (
+          #|   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
diff --git a/lib/spoom/coverage/report.rb b/lib/spoom/coverage/report.rb
@@ -138,7 +138,12 @@ def pie_sigs
       end
 
       class Map < Card
-        #: (file_tree: FileTree, nodes_strictnesses: Hash[FileTree::Node, String?], nodes_strictness_scores: Hash[FileTree::Node, Float], ?title: String) -> void
+        #: (
+        #|   file_tree: FileTree,
+        #|   nodes_strictnesses: Hash[FileTree::Node, String?],
+        #|   nodes_strictness_scores: Hash[FileTree::Node, Float],
+        #|   ?title: String
+        #| ) -> void
         def initialize(file_tree:, nodes_strictnesses:, nodes_strictness_scores:, title: "Strictness Map")
           super(
             title: title,
@@ -222,7 +227,16 @@ def erb
     end
 
     class Report < Page
-      #: (project_name: String, palette: D3::ColorPalette, snapshots: Array[Snapshot], file_tree: FileTree, nodes_strictnesses: Hash[FileTree::Node, String?], nodes_strictness_scores: Hash[FileTree::Node, Float], ?sorbet_intro_commit: String?, ?sorbet_intro_date: Time?) -> void
+      #: (
+      #|   project_name: String,
+      #|   palette: D3::ColorPalette,
+      #|   snapshots: Array[Snapshot],
+      #|   file_tree: FileTree,
+      #|   nodes_strictnesses: Hash[FileTree::Node, String?],
+      #|   nodes_strictness_scores: Hash[FileTree::Node, Float],
+      #|   ?sorbet_intro_commit: String?,
+      #|   ?sorbet_intro_date: Time?
+      #| ) -> void
       def initialize(
         project_name:,
         palette:,
diff --git a/lib/spoom/model/model.rb b/lib/spoom/model/model.rb
@@ -129,7 +129,13 @@ class Class < Namespace
       #: String?
       attr_accessor :superclass_name
 
-      #: (Symbol symbol, owner: Namespace?, location: Location, ?superclass_name: String?, ?comments: Array[Comment]) -> void
+      #: (
+      #|   Symbol symbol,
+      #|   owner: Namespace?,
+      #|   location: Location,
+      #|   ?superclass_name: String?,
+      #|   ?comments: Array[Comment]
+      #| ) -> void
       def initialize(symbol, owner:, location:, superclass_name: nil, comments: [])
         super(symbol, owner: owner, location: location, comments: comments)
 
@@ -160,7 +166,14 @@ class Property < SymbolDef
       #: Array[Sig]
       attr_reader :sigs
 
-      #: (Symbol symbol, owner: Namespace?, location: Location, visibility: Visibility, ?sigs: Array[Sig], ?comments: Array[Comment]) -> void
+      #: (
+      #|   Symbol symbol,
+      #|   owner: Namespace?,
+      #|   location: Location,
+      #|   visibility: Visibility,
+      #|   ?sigs: Array[Sig],
+      #|   ?comments: Array[Comment]
+      #| ) -> void
       def initialize(symbol, owner:, location:, visibility:, sigs: [], comments: [])
         super(symbol, owner: owner, location: location, comments: comments)
 
diff --git a/lib/spoom/rbs.rb b/lib/spoom/rbs.rb
@@ -39,7 +39,12 @@ def class_annotations
       def method_annotations
         @annotations.select do |annotation|
           case annotation.string
-          when "@abstract", "@final", "@override", "@override(allow_incompatible: true)", "@overridable", "@without_runtime"
+          when "@abstract",
+               "@final",
+               "@override",
+               "@override(allow_incompatible: true)",
+               "@overridable",
+               "@without_runtime"
             true
           else
             false
diff --git a/lib/spoom/sorbet/translate/sorbet_assertions_to_rbs_comments.rb b/lib/spoom/sorbet/translate/sorbet_assertions_to_rbs_comments.rb
@@ -74,8 +74,10 @@ def maybe_translate_assertion(node)
                Prism::ClassVariableWriteNode, Prism::ClassVariableAndWriteNode, Prism::ClassVariableOperatorWriteNode, Prism::ClassVariableOrWriteNode,
                Prism::ConstantWriteNode, Prism::ConstantAndWriteNode, Prism::ConstantOperatorWriteNode, Prism::ConstantOrWriteNode,
                Prism::ConstantPathWriteNode, Prism::ConstantPathAndWriteNode, Prism::ConstantPathOperatorWriteNode, Prism::ConstantPathOrWriteNode,
-               Prism::GlobalVariableWriteNode, Prism::GlobalVariableAndWriteNode, Prism::GlobalVariableOperatorWriteNode, Prism::GlobalVariableOrWriteNode,
-               Prism::InstanceVariableWriteNode, Prism::InstanceVariableAndWriteNode, Prism::InstanceVariableOperatorWriteNode, Prism::InstanceVariableOrWriteNode,
+               Prism::GlobalVariableWriteNode, Prism::GlobalVariableAndWriteNode,
+               Prism::GlobalVariableOperatorWriteNode, Prism::GlobalVariableOrWriteNode,
+               Prism::InstanceVariableWriteNode, Prism::InstanceVariableAndWriteNode,
+               Prism::InstanceVariableOperatorWriteNode, Prism::InstanceVariableOrWriteNode,
                Prism::LocalVariableWriteNode, Prism::LocalVariableAndWriteNode, Prism::LocalVariableOperatorWriteNode, Prism::LocalVariableOrWriteNode,
                Prism::CallAndWriteNode, Prism::CallOperatorWriteNode, Prism::CallOrWriteNode
             node.value
diff --git a/lib/spoom/sorbet/translate/sorbet_sigs_to_rbs_comments.rb b/lib/spoom/sorbet/translate/sorbet_sigs_to_rbs_comments.rb
@@ -260,7 +260,10 @@ def apply_class_annotation(parent, node)
 
             arg = body.body.first #: as Prism::Node
             srb_type = RBI::Type.parse_node(arg)
-            @rewriter << Source::Insert.new(parent.location.start_offset, "# @requires_ancestor: #{srb_type.rbs_string}\n#{indent}")
+            @rewriter << Source::Insert.new(
+              parent.location.start_offset,
+              "# @requires_ancestor: #{srb_type.rbs_string}\n#{indent}",
+            )
           end
 
           from = adjust_to_line_start(node.location.start_offset)
diff --git a/lib/spoom/source/rewriter.rb b/lib/spoom/source/rewriter.rb
@@ -92,7 +92,8 @@ def initialize(from, to, text)
       # @override
       #: (Array[Integer]) -> void
       def apply(bytes)
-        raise PositionError, "Position is out of bounds" if from < 0 || to < 0 || from > bytes.size || to > bytes.size || from > to
+        raise PositionError,
+          "Position is out of bounds" if from < 0 || to < 0 || from > bytes.size || to > bytes.size || from > to
 
         bytes[from..to] = *text.bytes
       end
@@ -125,7 +126,8 @@ def initialize(from, to)
       # @override
       #: (Array[untyped]) -> void
       def apply(bytes)
-        raise PositionError, "Position is out of bounds" if from < 0 || to < 0 || from > bytes.size || to > bytes.size || from > to
+        raise PositionError,
+          "Position is out of bounds" if from < 0 || to < 0 || from > bytes.size || to > bytes.size || from > to
 
         bytes[from..to] = "".bytes
       end
diff --git a/test/spoom/cli/srb/assertions_test.rb b/test/spoom/cli/srb/assertions_test.rb
@@ -42,7 +42,15 @@ def test_translate_from_rbi_to_rbs_with_options
 
           @project.write!("file.rb", contents)
 
-          result = @project.spoom("srb assertions translate --no-color --no-translate-t-let --no-translate-t-cast --no-translate-t-bind --no-translate-t-must --no-translate-t-unsafe")
+          result = @project.spoom(<<~CMD)
+            srb assertions translate \
+              --no-color \
+              --no-translate-t-let \
+              --no-translate-t-cast \
+              --no-translate-t-bind \
+              --no-translate-t-must \
+              --no-translate-t-unsafe
+          CMD
 
           assert_empty(result.err)
           assert(result.status)
diff --git a/test/spoom/file_collector_test.rb b/test/spoom/file_collector_test.rb
@@ -101,7 +101,12 @@ def test_collect_files_with_allowed_mime_types
 
       private
 
-      #: (Context context, ?allow_extensions: Array[String], ?allow_mime_types: Array[String], ?exclude_patterns: Array[String]) -> Array[String]
+      #: (
+      #|   Context context,
+      #|   ?allow_extensions: Array[String],
+      #|   ?allow_mime_types: Array[String],
+      #|   ?exclude_patterns: Array[String]
+      #| ) -> Array[String]
       def collect_files(context, allow_extensions: [], allow_mime_types: [], exclude_patterns: [])
         # Since we work in the context directory, we need to prefix the patterns with it
         exclude_patterns = exclude_patterns.map { |p| File.join(context.absolute_path, p) }
