rubocop-sorbet 0.8.4 → 0.8.5

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 9cb17e31fa88a9bf6693e1bbdad97425f25920b8293782b2dbf3642df2b3138d
-  data.tar.gz: 1a7cc0e93155410faf2f7e9f431b7a182e72b081217774796ff63515a1b2bbc4
+  metadata.gz: 9dfcaff074a9af626b94a6909e3d6c3ea99749bced60c513d123cc00d4af2f26
+  data.tar.gz: 961d6723c8fa9e67dd25febab735a58ea4a7023c46132b008f3a8c4f996a18c6
 SHA512:
-  metadata.gz: 694a6aeff04a8c14a8a511f0f44ffc6abb0035fbbedc9a9e0bdaeeef3ba97d5a360cdc8141048f502f663475743441d8537f7f27c4c2cae78b40cb8d050e8375
-  data.tar.gz: 8781a983e0e0e97a3535943c9ffe76beab985cc5643832b9b138590d3585220dddba6ec3fcdbe6d2ea58152a6349d6fb28c418d7874a7b53b271190120d7bf93
+  metadata.gz: 927874817f3166896f9cbb5267f95fa18570ce29c01432ff076a9949b71986bc13ccdbb849bf943b4b908bc5b682448d381c5b7e579af3f1f963662ef93bf606
+  data.tar.gz: 2ad69a1852bea8490f7c3b0cb157482dc0176abeae0f8834f8e8afcc7b582db822a3fa86df331d3315743628f40a9352af45a320de12bb4e990c216babc041a1

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    rubocop-sorbet (0.8.4)
+    rubocop-sorbet (0.8.5)
       rubocop (>= 1)
 
 GEM

data/config/rbi.yml

@@ -169,9 +169,15 @@ Layout/SpaceBeforeFirstArg:
 Layout/SpaceBeforeSemicolon:
   Enabled: true
 
+Layout/SpaceInsideBlockBraces:
+  Enabled: true
+
 Layout/SpaceInsideParens:
   Enabled: true
 
+Layout/SpaceInsideReferenceBrackets:
+  Enabled: true
+
 Layout/TrailingEmptyLines:
   Enabled: true
   EnforcedStyle: final_newline
@@ -220,6 +226,16 @@ Sorbet/SingleLineRbiClassModuleDefinitions:
 Sorbet/TypeAliasName:
   Enabled: true
 
+Sorbet/ValidGemVersionAnnotations:
+  Description: >-
+                  Ensures all gem version annotations in RBI files are correctly formatted per
+                  Ruby's gem version specification guidelines.
+
+                  See the rubygems.org documentation for more information on how to format gem
+                  versions: https://guides.rubygems.org/patterns/#pessimistic-version-constraint
+  Enabled: false
+  VersionAdded: 0.8.5
+
 Sorbet/ValidSigil:
   Enabled: true
   RequireSigilOnAllFiles: true

data/lib/rubocop/cop/sorbet/rbi_versioning/gem_version_annotation_helper.rb

@@ -0,0 +1,27 @@
+# frozen_string_literal: true
+
+module RuboCop
+  module Cop
+    module Sorbet
+      module GemVersionAnnotationHelper
+        VERSION_PREFIX = "# @version"
+
+        def gem_version_annotations
+          processed_source.comments.select do |comment|
+            gem_version_annotation?(comment)
+          end
+        end
+
+        private
+
+        def gem_version_annotation?(comment)
+          comment.text.start_with?(VERSION_PREFIX)
+        end
+
+        def gem_versions(comment)
+          comment.text.delete_prefix(VERSION_PREFIX).split(/, ?/).map(&:strip)
+        end
+      end
+    end
+  end
+end

data/lib/rubocop/cop/sorbet/rbi_versioning/valid_gem_version_annotations.rb

@@ -0,0 +1,62 @@
+# frozen_string_literal: true
+
+module RuboCop
+  module Cop
+    module Sorbet
+      # Checks that gem versions in RBI annotations are properly formatted per the Bundler gem specification.
+      #
+      # @example
+      #   # bad
+      #   # @version > not a version number
+      #
+      #   # good
+      #   # @version = 1
+      #
+      #   # good
+      #   # @version > 1.2.3
+      #
+      #   # good
+      #   # @version <= 4.3-preview
+      #
+      class ValidGemVersionAnnotations < RuboCop::Cop::Base
+        include GemVersionAnnotationHelper
+
+        MSG = "Invalid gem version(s) detected: %<versions>s"
+        VALID_OPERATORS = ["=", "!=", ">", ">=", "<", "<=", "~>"]
+
+        def on_new_investigation
+          gem_version_annotations.each do |comment|
+            gem_versions = gem_versions(comment)
+
+            if gem_versions.empty?
+              message = format(MSG, versions: "empty version")
+              add_offense(comment, message: message)
+              break
+            end
+
+            invalid_versions = gem_versions.reject do |version|
+              valid_version?(version)
+            end
+
+            unless invalid_versions.empty?
+              message = format(MSG, versions: invalid_versions.map(&:strip).join(", "))
+              add_offense(comment, message: message)
+            end
+          end
+        end
+
+        private
+
+        def valid_version?(version_string)
+          parts = version_string.strip.split(" ")
+          operator, version = parts
+
+          return false unless operator && parts
+          return false unless VALID_OPERATORS.include?(operator)
+
+          Gem::Version.correct?(version)
+        end
+      end
+    end
+  end
+end

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

@@ -21,7 +21,7 @@ module RuboCop
       #      serialize <=> other.serialize
       #    end
       #  end
-      class ForbidComparableTEnum < Base
+      class ForbidComparableTEnum < RuboCop::Cop::Base
         include TEnum
 
         MSG = "Do not use `T::Enum` as a comparable object because of significant performance overhead."

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

@@ -21,7 +21,7 @@ module RuboCop
       #      NotFound = new("The resource was not found.")
       #    end
       #  end
-      class MultipleTEnumValues < Base
+      class MultipleTEnumValues < RuboCop::Cop::Base
         include TEnum
 
         MSG = "`T::Enum` should have at least two values."

data/lib/rubocop/cop/sorbet_cops.rb

@@ -24,6 +24,9 @@ require_relative "sorbet/rbi/forbid_extend_t_sig_helpers_in_shims"
 require_relative "sorbet/rbi/forbid_rbi_outside_of_allowed_paths"
 require_relative "sorbet/rbi/single_line_rbi_class_module_definitions"
 
+require_relative "sorbet/rbi_versioning/gem_version_annotation_helper"
+require_relative "sorbet/rbi_versioning/valid_gem_version_annotations"
+
 require_relative "sorbet/signatures/allow_incompatible_override"
 require_relative "sorbet/signatures/checked_true_in_signature"
 require_relative "sorbet/signatures/void_checked_tests"

data/lib/rubocop/sorbet/version.rb

@@ -2,6 +2,6 @@
 
 module RuboCop
   module Sorbet
-    VERSION = "0.8.4"
+    VERSION = "0.8.5"
   end
 end

data/manual/cops.md

@@ -39,6 +39,7 @@ In the following section you find all available cops:
 * [Sorbet/StrongSigil](cops_sorbet.md#sorbetstrongsigil)
 * [Sorbet/TrueSigil](cops_sorbet.md#sorbettruesigil)
 * [Sorbet/TypeAliasName](cops_sorbet.md#sorbettypealiasname)
+* [Sorbet/ValidGemVersionAnnotations](cops_sorbet.md#sorbetvalidgemversionannotations)
 * [Sorbet/ValidSigil](cops_sorbet.md#sorbetvalidsigil)
 * [Sorbet/VoidCheckedTests](cops_sorbet.md#sorbetvoidcheckedtests)
 

data/manual/cops_sorbet.md

@@ -892,6 +892,30 @@ Name | Default value | Configurable values
 Include | `**/*.{rb,rbi,rake,ru}` | Array
 Exclude | `bin/**/*`, `db/**/*.rb`, `script/**/*` | Array
 
+## Sorbet/ValidGemVersionAnnotations
+
+Enabled by default | Safe | Supports autocorrection | VersionAdded | VersionChanged
+--- | --- | --- | --- | ---
+Enabled | Yes | No | - | -
+
+Checks that gem versions in RBI annotations are properly formatted per the Bundler gem specification.
+
+### Examples
+
+```ruby
+# bad
+# @version > not a version number
+
+# good
+# @version = 1
+
+# good
+# @version > 1.2.3
+
+# good
+# @version <= 4.3-preview
+```
+
 ## Sorbet/ValidSigil
 
 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.4
+  version: 0.8.5
 platform: ruby
 authors:
 - Ufuk Kayserilioglu
@@ -11,7 +11,7 @@ authors:
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2024-07-16 00:00:00.000000000 Z
+date: 2024-07-25 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rubocop
@@ -81,6 +81,8 @@ files:
 - 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
+- lib/rubocop/cop/sorbet/rbi_versioning/gem_version_annotation_helper.rb
+- lib/rubocop/cop/sorbet/rbi_versioning/valid_gem_version_annotations.rb
 - lib/rubocop/cop/sorbet/redundant_extend_t_sig.rb
 - lib/rubocop/cop/sorbet/sigils/enforce_sigil_order.rb
 - lib/rubocop/cop/sorbet/sigils/enforce_single_sigil.rb
@@ -133,7 +135,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.5.15
+rubygems_version: 3.5.16
 signing_key:
 specification_version: 4
 summary: Automatic Sorbet code style checking tool.