rubocop-sorbet 0.8.1 → 0.8.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: d0993b56c619f271efe5948d6a3b090695290b91d55db8948b95cf690c610cbf
-  data.tar.gz: 0f69733c05f1391747711ee316152b6541800a35682b71482d50903c8981bfdc
+  metadata.gz: 1cf8cfdff3aedba93731774d5f47fd8c4f10ef8d615ea2cb9f4cdfd2f20d1522
+  data.tar.gz: 69b6974d9a6de86eeed4b29dcfcae25648a3880036b49ceb57a426821da4535c
 SHA512:
-  metadata.gz: aa9413ff649b22b1afab51d3e6f8c48cfb1387ff52a0d3e8547db70c42824d9d2e0da53e093b79fb57f916d07100b655368831bf23abe12c69371281185faab9
-  data.tar.gz: 8cffb6fdef999a34b5f0c92ec7c2712b993f7851b8d7cb7c9ae7c9e764bd132f4d25b3bb733bb31facfb38cc17e62cbe042ac77aee92e74df093a20e56f5c7d4
+  metadata.gz: 98a957ed012dcfefb642d54ee332d1435c0931bafe6fa07e2d36d280b7a1c4391bab2f05d2b77b1f44da850196a7edb322886b0d50bbe154e0e6d9d80a9f8f62
+  data.tar.gz: 25634e48e2daf8db8b41211d64f49560f9ddcd7236cc181364e7ab6ecc67cbdcd5d169454825a92ffebb2e6337ed81c1847d54483f0a073447034333c2b4b150

data/Gemfile

@@ -5,7 +5,7 @@ source "https://rubygems.org"
 # Specify your gem's dependencies in rubocop-sorbet.gemspec
 gemspec
 
-gem "byebug"
+gem "debug"
 gem "rake", ">= 12.3.3"
 gem "rspec", "~> 3.13"
 gem "rubocop-shopify", require: false

data/Gemfile.lock

@@ -1,25 +1,37 @@
 PATH
   remote: .
   specs:
-    rubocop-sorbet (0.8.1)
+    rubocop-sorbet (0.8.2)
       rubocop (>= 0.90.0)
 
 GEM
   remote: https://rubygems.org/
   specs:
     ast (2.4.2)
-    byebug (11.1.3)
+    debug (1.9.2)
+      irb (~> 1.10)
+      reline (>= 0.3.8)
     diff-lcs (1.5.1)
-    json (2.7.1)
+    io-console (0.7.2)
+    irb (1.12.0)
+      rdoc
+      reline (>= 0.4.2)
+    json (2.7.2)
     language_server-protocol (3.17.0.3)
     parallel (1.24.0)
     parser (3.3.0.5)
       ast (~> 2.4.1)
       racc
+    psych (5.1.2)
+      stringio
     racc (1.7.3)
     rainbow (3.1.1)
     rake (13.2.1)
+    rdoc (6.6.3.1)
+      psych (>= 4.0.0)
     regexp_parser (2.9.0)
+    reline (0.5.1)
+      io-console (~> 0.5)
     rexml (3.2.6)
     rspec (3.13.0)
       rspec-core (~> 3.13.0)
@@ -34,7 +46,7 @@ GEM
       diff-lcs (>= 1.2.0, < 2.0)
       rspec-support (~> 3.13.0)
     rspec-support (3.13.1)
-    rubocop (1.62.1)
+    rubocop (1.63.2)
       json (~> 2.3)
       language_server-protocol (>= 3.17.0)
       parallel (~> 1.10)
@@ -47,9 +59,10 @@ GEM
       unicode-display_width (>= 2.4.0, < 3.0)
     rubocop-ast (1.31.2)
       parser (>= 3.3.0.4)
-    rubocop-shopify (2.14.0)
+    rubocop-shopify (2.15.1)
       rubocop (~> 1.51)
     ruby-progressbar (1.13.0)
+    stringio (3.1.0)
     unicode-display_width (2.5.0)
     yard (0.9.36)
 
@@ -57,7 +70,7 @@ PLATFORMS
   ruby
 
 DEPENDENCIES
-  byebug
+  debug
   rake (>= 12.3.3)
   rspec (~> 3.13)
   rubocop-shopify

data/config/default.yml

@@ -200,11 +200,6 @@ Sorbet/BuggyObsoleteStrictMemoization:
   Safe: true
   SafeAutoCorrect: false
 
-Sorbet/OneAncestorPerLine:
-  Description: 'Enforces one ancestor per call to requires_ancestor'
-  Enabled: false
-  VersionAdded: '0.6.0'
-
 Sorbet/RedundantExtendTSig:
   Description: >-
     Forbid the usage of redundant `extend T::Sig`.
@@ -312,3 +307,13 @@ Sorbet/VoidCheckedTests:
   Description: 'Forbid `.void.checked(:tests)`'
   Enabled: true
   VersionAdded: 0.7.7
+
+Sorbet/MultipleTEnumValues:
+  Description: 'Ensures that all `T::Enum`s have multiple values.'
+  Enabled: true
+  VersionAdded: 0.8.2
+
+Sorbet/ForbidComparableTEnum:
+  Description: 'Disallows including the `Comparable` module in a `T::Enum`.'
+  Enabled: true
+  VersionAdded: 0.8.2

data/config/obsoletion.yml

@@ -3,4 +3,6 @@
 #
 # See: https://docs.rubocop.org/rubocop/extensions.html#config-obsoletions
 #
-{}
+removed:
+  Sorbet/OneAncestorPerLine:
+    reason: '`require_ancestor` now takes a block instead of arguments'

data/lib/rubocop/cop/sorbet/buggy_obsolete_strict_memoization.rb

@@ -48,8 +48,8 @@ module RuboCop
 
         include TargetSorbetVersion
 
-        MSG = "This might be a mistaken variant of the two-stage workaround that used to be needed for memoization in "\
-          "`#typed: strict` files. See https://sorbet.org/docs/type-assertions#put-type-assertions-behind-memoization."
+        MSG = "This might be a mistaken variant of the two-stage workaround that used to be needed for memoization " \
+          "in `#typed: strict` files. See https://sorbet.org/docs/type-assertions#put-type-assertions-behind-memoization."
 
         # @!method buggy_legacy_memoization_pattern?(node)
         def_node_matcher :buggy_legacy_memoization_pattern?, <<~PATTERN

data/lib/rubocop/cop/sorbet/mixin/t_enum.rb

@@ -0,0 +1,35 @@
+# frozen_string_literal: true
+
+module RuboCop
+  module Cop
+    module Sorbet
+      # Mixing for writing cops that deal with `T::Enum`s
+      module TEnum
+        extend RuboCop::NodePattern::Macros
+        def initialize(*)
+          @scopes = []
+          super
+        end
+
+        # @!method t_enum?(node)
+        def_node_matcher :t_enum?, <<~PATTERN
+          (class (const...) (const (const nil? :T) :Enum) ...)
+        PATTERN
+
+        def on_class(node)
+          @scopes.push(node)
+        end
+
+        def after_class(node)
+          @scopes.pop
+        end
+
+        private
+
+        def in_t_enum_class?
+          t_enum?(@scopes&.last)
+        end
+      end
+    end
+  end
+end

data/lib/rubocop/cop/sorbet/t_enum/forbid_comparable_t_enum.rb

@@ -0,0 +1,44 @@
+# frozen_string_literal: true
+
+module RuboCop
+  module Cop
+    module Sorbet
+      # Disallow including the `Comparable` module in `T::Enum`.
+      #
+      # @example
+      #
+      #  # bad
+      #  class Priority < T::Enum
+      #    include Comparable
+      #
+      #    enums do
+      #      High = new(3)
+      #      Medium = new(2)
+      #      Low = new(1)
+      #    end
+      #
+      #    def <=>(other)
+      #      serialize <=> other.serialize
+      #    end
+      #  end
+      class ForbidComparableTEnum < Base
+        include TEnum
+
+        MSG = "Do not use `T::Enum` as a comparable object because of significant performance overhead."
+
+        RESTRICT_ON_SEND = [:include, :prepend].freeze
+
+        # @!method mix_in_comparable?(node)
+        def_node_matcher :mix_in_comparable?, <<~PATTERN
+          (send nil? {:include | :prepend} (const nil? :Comparable))
+        PATTERN
+
+        def on_send(node)
+          return unless in_t_enum_class? && mix_in_comparable?(node)
+
+          add_offense(node)
+        end
+      end
+    end
+  end
+end

data/lib/rubocop/cop/sorbet/t_enum/multiple_t_enum_values.rb

@@ -0,0 +1,59 @@
+# frozen_string_literal: true
+
+module RuboCop
+  module Cop
+    module Sorbet
+      # Disallow creating a `T::Enum` with less than two values.
+      #
+      # @example
+      #
+      #  # bad
+      #  class ErrorMessages < T::Enum
+      #    enums do
+      #      ServerError = new("There was a server error.")
+      #    end
+      #  end
+      #
+      #  # good
+      #  class ErrorMessages < T::Enum
+      #    enums do
+      #      ServerError = new("There was a server error.")
+      #      NotFound = new("The resource was not found.")
+      #    end
+      #  end
+      class MultipleTEnumValues < Base
+        include TEnum
+
+        MSG = "`T::Enum` should have at least two values."
+
+        # @!method enums_block?(node)
+        def_node_matcher :enums_block?, <<~PATTERN
+          (block (send nil? :enums) ...)
+        PATTERN
+
+        def on_class(node)
+          super
+
+          add_offense(node) if t_enum?(node) && node.body.nil?
+        end
+
+        def on_block(node) # rubocop:disable InternalAffairs/NumblockHandler
+          return unless in_t_enum_class?
+          return unless enums_block?(node)
+
+          scope = @scopes.last
+
+          if node.body.nil?
+            add_offense(scope)
+            return
+          end
+
+          begin_node = node.children.find(&:begin_type?)
+
+          num_casgn_nodes = (begin_node || node).children.count(&:casgn_type?)
+          add_offense(scope) if num_casgn_nodes < 2
+        end
+      end
+    end
+  end
+end

data/lib/rubocop/cop/sorbet_cops.rb

@@ -1,7 +1,8 @@
 # frozen_string_literal: true
 
-require_relative "sorbet/mixin/target_sorbet_version.rb"
-require_relative "sorbet/mixin/signature_help.rb"
+require_relative "sorbet/mixin/target_sorbet_version"
+require_relative "sorbet/mixin/t_enum"
+require_relative "sorbet/mixin/signature_help"
 
 require_relative "sorbet/binding_constant_without_type_alias"
 require_relative "sorbet/constants_from_strings"
@@ -10,7 +11,6 @@ require_relative "sorbet/forbid_include_const_literal"
 require_relative "sorbet/forbid_type_aliased_shapes"
 require_relative "sorbet/forbid_untyped_struct_props"
 require_relative "sorbet/implicit_conversion_method"
-require_relative "sorbet/one_ancestor_per_line"
 require_relative "sorbet/callback_conditionals_binding"
 require_relative "sorbet/forbid_t_struct"
 require_relative "sorbet/forbid_t_unsafe"
@@ -42,4 +42,7 @@ require_relative "sorbet/sigils/strong_sigil"
 require_relative "sorbet/sigils/enforce_sigil_order"
 require_relative "sorbet/sigils/enforce_single_sigil"
 
+require_relative "sorbet/t_enum/forbid_comparable_t_enum"
+require_relative "sorbet/t_enum/multiple_t_enum_values"
+
 require_relative "sorbet/mutable_constant_sorbet_aware_behaviour"

data/lib/rubocop/sorbet/version.rb

@@ -2,6 +2,6 @@
 
 module RuboCop
   module Sorbet
-    VERSION = "0.8.1"
+    VERSION = "0.8.2"
   end
 end

data/manual/cops.md

@@ -16,6 +16,7 @@ In the following section you find all available cops:
 * [Sorbet/EnforceSignatures](cops_sorbet.md#sorbetenforcesignatures)
 * [Sorbet/EnforceSingleSigil](cops_sorbet.md#sorbetenforcesinglesigil)
 * [Sorbet/FalseSigil](cops_sorbet.md#sorbetfalsesigil)
+* [Sorbet/ForbidComparableTEnum](cops_sorbet.md#sorbetforbidcomparabletenum)
 * [Sorbet/ForbidExtendTSigHelpersInShims](cops_sorbet.md#sorbetforbidextendtsighelpersinshims)
 * [Sorbet/ForbidIncludeConstLiteral](cops_sorbet.md#sorbetforbidincludeconstliteral)
 * [Sorbet/ForbidRBIOutsideOfAllowedPaths](cops_sorbet.md#sorbetforbidrbioutsideofallowedpaths)
@@ -29,8 +30,8 @@ In the following section you find all available cops:
 * [Sorbet/IgnoreSigil](cops_sorbet.md#sorbetignoresigil)
 * [Sorbet/ImplicitConversionMethod](cops_sorbet.md#sorbetimplicitconversionmethod)
 * [Sorbet/KeywordArgumentOrdering](cops_sorbet.md#sorbetkeywordargumentordering)
+* [Sorbet/MultipleTEnumValues](cops_sorbet.md#sorbetmultipletenumvalues)
 * [Sorbet/ObsoleteStrictMemoization](cops_sorbet.md#sorbetobsoletestrictmemoization)
-* [Sorbet/OneAncestorPerLine](cops_sorbet.md#sorbetoneancestorperline)
 * [Sorbet/RedundantExtendTSig](cops_sorbet.md#sorbetredundantextendtsig)
 * [Sorbet/SignatureBuildOrder](cops_sorbet.md#sorbetsignaturebuildorder)
 * [Sorbet/SingleLineRbiClassModuleDefinitions](cops_sorbet.md#sorbetsinglelinerbiclassmoduledefinitions)

data/manual/cops_sorbet.md

@@ -295,6 +295,33 @@ SuggestedStrictness | `false` | String
 Include | `**/*.{rb,rbi,rake,ru}` | Array
 Exclude | `bin/**/*`, `db/**/*.rb`, `script/**/*` | Array
 
+## Sorbet/ForbidComparableTEnum
+
+Enabled by default | Safe | Supports autocorrection | VersionAdded | VersionChanged
+--- | --- | --- | --- | ---
+Enabled | Yes | No | 0.8.2 | -
+
+Disallow including the `Comparable` module in `T::Enum`.
+
+### Examples
+
+```ruby
+# bad
+class Priority < T::Enum
+  include Comparable
+
+  enums do
+    High = new(3)
+    Medium = new(2)
+    Low = new(1)
+  end
+
+  def <=>(other)
+    serialize <=> other.serialize
+  end
+end
+```
+
 ## Sorbet/ForbidExtendTSigHelpersInShims
 
 Enabled by default | Safe | Supports autocorrection | VersionAdded | VersionChanged
@@ -639,6 +666,33 @@ sig { params(b: String, a: Integer).void }
 def foo(b:, a: 1); end
 ```
 
+## Sorbet/MultipleTEnumValues
+
+Enabled by default | Safe | Supports autocorrection | VersionAdded | VersionChanged
+--- | --- | --- | --- | ---
+Enabled | Yes | No | 0.8.2 | -
+
+Disallow creating a `T::Enum` with less than two values.
+
+### Examples
+
+```ruby
+# bad
+class ErrorMessages < T::Enum
+  enums do
+    ServerError = new("There was a server error.")
+  end
+end
+
+# good
+class ErrorMessages < T::Enum
+  enums do
+    ServerError = new("There was a server error.")
+    NotFound = new("The resource was not found.")
+  end
+end
+```
+
 ## Sorbet/ObsoleteStrictMemoization
 
 Enabled by default | Safe | Supports autocorrection | VersionAdded | VersionChanged
@@ -676,30 +730,6 @@ def foo
 end
 ```
 
-## Sorbet/OneAncestorPerLine
-
-Enabled by default | Safe | Supports autocorrection | VersionAdded | VersionChanged
---- | --- | --- | --- | ---
-Disabled | Yes | Yes  | 0.6.0 | -
-
-Ensures one ancestor per requires_ancestor line
-rather than chaining them as a comma-separated list.
-
-### Examples
-
-```ruby
-# bad
-module SomeModule
-  requires_ancestor Kernel, Minitest::Assertions
-end
-
-# good
-module SomeModule
-  requires_ancestor Kernel
-  requires_ancestor Minitest::Assertions
-end
-```
-
 ## Sorbet/RedundantExtendTSig
 
 Enabled by default | Safe | Supports autocorrection | VersionAdded | VersionChanged

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: rubocop-sorbet
 version: !ruby/object:Gem::Version
-  version: 0.8.1
+  version: 0.8.2
 platform: ruby
 authors:
 - Ufuk Kayserilioglu
@@ -11,7 +11,7 @@ authors:
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2024-04-09 00:00:00.000000000 Z
+date: 2024-04-23 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rubocop
@@ -74,10 +74,10 @@ files:
 - lib/rubocop/cop/sorbet/forbid_untyped_struct_props.rb
 - lib/rubocop/cop/sorbet/implicit_conversion_method.rb
 - lib/rubocop/cop/sorbet/mixin/signature_help.rb
+- lib/rubocop/cop/sorbet/mixin/t_enum.rb
 - lib/rubocop/cop/sorbet/mixin/target_sorbet_version.rb
 - lib/rubocop/cop/sorbet/mutable_constant_sorbet_aware_behaviour.rb
 - lib/rubocop/cop/sorbet/obsolete_strict_memoization.rb
-- lib/rubocop/cop/sorbet/one_ancestor_per_line.rb
 - lib/rubocop/cop/sorbet/rbi/forbid_extend_t_sig_helpers_in_shims.rb
 - lib/rubocop/cop/sorbet/rbi/forbid_rbi_outside_of_allowed_paths.rb
 - lib/rubocop/cop/sorbet/rbi/single_line_rbi_class_module_definitions.rb
@@ -98,6 +98,8 @@ files:
 - lib/rubocop/cop/sorbet/signatures/keyword_argument_ordering.rb
 - lib/rubocop/cop/sorbet/signatures/signature_build_order.rb
 - lib/rubocop/cop/sorbet/signatures/void_checked_tests.rb
+- lib/rubocop/cop/sorbet/t_enum/forbid_comparable_t_enum.rb
+- lib/rubocop/cop/sorbet/t_enum/multiple_t_enum_values.rb
 - lib/rubocop/cop/sorbet/type_alias_name.rb
 - lib/rubocop/cop/sorbet_cops.rb
 - lib/rubocop/sorbet.rb
@@ -131,7 +133,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.5.7
+rubygems_version: 3.5.9
 signing_key: 
 specification_version: 4
 summary: Automatic Sorbet code style checking tool.

data/lib/rubocop/cop/sorbet/one_ancestor_per_line.rb

@@ -1,80 +0,0 @@
-# encoding: utf-8
-# frozen_string_literal: true
-
-require "rubocop"
-
-module RuboCop
-  module Cop
-    module Sorbet
-      # Ensures one ancestor per requires_ancestor line
-      # rather than chaining them as a comma-separated list.
-      #
-      # @example
-      #
-      #   # bad
-      #   module SomeModule
-      #     requires_ancestor Kernel, Minitest::Assertions
-      #   end
-      #
-      #   # good
-      #   module SomeModule
-      #     requires_ancestor Kernel
-      #     requires_ancestor Minitest::Assertions
-      #   end
-      class OneAncestorPerLine < RuboCop::Cop::Cop # rubocop:todo InternalAffairs/InheritDeprecatedCopClass
-        MSG = "Cannot require more than one ancestor per line"
-
-        # @!method requires_ancestors(node)
-        def_node_search :requires_ancestors, <<~PATTERN
-          (send nil? :requires_ancestor ...)
-        PATTERN
-
-        # @!method more_than_one_ancestor(node)
-        def_node_matcher :more_than_one_ancestor, <<~PATTERN
-          (send nil? :requires_ancestor const const+)
-        PATTERN
-
-        # @!method abstract?(node)
-        def_node_search :abstract?, <<~PATTERN
-          (send nil? :abstract!)
-        PATTERN
-
-        def on_module(node)
-          return unless node.body
-          return unless requires_ancestors(node)
-
-          process_node(node)
-        end
-
-        def on_class(node)
-          return unless abstract?(node)
-          return unless requires_ancestors(node)
-
-          process_node(node)
-        end
-
-        def autocorrect(node)
-          ->(corrector) do
-            ra_call = node.parent
-            split_ra_calls = ra_call.source.gsub(/,\s+/, new_ra_line(ra_call.loc.column))
-            corrector.replace(ra_call, split_ra_calls)
-          end
-        end
-
-        private
-
-        def process_node(node)
-          requires_ancestors(node).each do |ra|
-            add_offense(ra.child_nodes[1]) if more_than_one_ancestor(ra)
-          end
-        end
-
-        def new_ra_line(indent_count)
-          indents = " " * indent_count
-          indented_ra_call = "#{indents}requires_ancestor "
-          "\n#{indented_ra_call}"
-        end
-      end
-    end
-  end
-end