rubocop-sorbet 0.6.5 → 0.6.8

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 7c1aed7de77dddecfab7d01e2370897d1da0081d92795aa9fdd221b831da980d
-  data.tar.gz: ecc9c7d3168bd636a45d2e9f9c4c9f20e04e42379ea89280452d7a9f59e2f3f8
+  metadata.gz: 64fed7c9d13d31d36b4291400c35f40857cd11522f877538aa4225bf0da1382b
+  data.tar.gz: f813a95fd882e1d51585cb1cffb79169f378d2a27ff5956b4a1f7b2f397e4f21
 SHA512:
-  metadata.gz: 555054526bf69633f6faf63c83514255c0622c0b7604eab94dfd31933c023285e53aadd4e76eb49418d92532ca9953a8a0d42bb7d74ef0cfd7478cd4b244dab1
-  data.tar.gz: fa2e73581f867b029b1a853647b0bbea47f433037064d29773366aa02e2374f9e79209ae712dc7cd54c2d3654dbbf097fe324a5683e34f3180a93b8c88d7da96
+  metadata.gz: 5582a0d4b3e833504826549d967eded49aa32403741eea67af4a89dd3a95170164ae0ff540bc6f2422c9c34a82ceec281f991312c525937d956659773250f9ca
+  data.tar.gz: b3354da7079b05cfd16a541d25db45c271eb2dc43e1fae34dd336e38fca8b290ea8a58c643a178bebe722e2ed5b3d4f2f2d2096ad67ab943fdbae950a67f5f04

data/.github/workflows/ci.yml

@@ -11,7 +11,7 @@ jobs:
     strategy:
       fail-fast: false
       matrix:
-        ruby: [ 2.5, 2.6, 2.7, 3.0 ]
+        ruby: [ '2.5', '2.6', '2.7', '3.0', '3.1' ]
     name: Test Ruby ${{ matrix.ruby }}
     steps:
       - uses: actions/checkout@v2

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    rubocop-sorbet (0.6.5)
+    rubocop-sorbet (0.6.8)
       rubocop (>= 0.90.0)
 
 GEM
@@ -10,12 +10,12 @@ GEM
     ast (2.4.2)
     byebug (11.1.3)
     diff-lcs (1.3)
-    parallel (1.20.1)
+    parallel (1.21.0)
     parser (3.0.1.1)
       ast (~> 2.4.1)
-    rainbow (3.0.0)
+    rainbow (3.1.1)
     rake (13.0.1)
-    regexp_parser (2.1.1)
+    regexp_parser (2.2.0)
     rexml (3.2.5)
     rspec (3.8.0)
       rspec-core (~> 3.8.0)
@@ -30,21 +30,21 @@ GEM
       diff-lcs (>= 1.2.0, < 2.0)
       rspec-support (~> 3.8.0)
     rspec-support (3.8.2)
-    rubocop (1.16.0)
+    rubocop (1.24.1)
       parallel (~> 1.10)
       parser (>= 3.0.0.0)
       rainbow (>= 2.2.2, < 4.0)
       regexp_parser (>= 1.8, < 3.0)
       rexml
-      rubocop-ast (>= 1.7.0, < 2.0)
+      rubocop-ast (>= 1.15.1, < 2.0)
       ruby-progressbar (~> 1.7)
       unicode-display_width (>= 1.4.0, < 3.0)
-    rubocop-ast (1.7.0)
+    rubocop-ast (1.15.1)
       parser (>= 3.0.1.1)
     rubocop-shopify (2.1.0)
       rubocop (~> 1.13)
     ruby-progressbar (1.11.0)
-    unicode-display_width (2.0.0)
+    unicode-display_width (2.1.0)
     unparser (0.6.0)
       diff-lcs (~> 1.3)
       parser (>= 3.0.0)

data/README.md

@@ -60,13 +60,15 @@ end
 
 ### Rubocop rules for RBI files
 
-Put this into your `.rubocop.yml`:
+To enable the cops related to RBI files under the `sorbet/rbi/` directory, put this in `sorbet/rbi/.rubocop.yml`:
 
 ```yaml
 inherit_gem:
   rubocop-sorbet: config/rbi.yml
 ```
 
+This will turn off default cops for `**/*.rbi` files and enable the RBI specific cops.
+
 ## The Cops
 All cops are located under [`lib/rubocop/cop/sorbet`](lib/rubocop/cop/sorbet), and contain examples/documentation.
 

data/config/default.yml

@@ -39,7 +39,7 @@ Sorbet/EnforceSigilOrder:
   Enabled: true
   VersionAdded: 0.3.4
 
-Sorbet/sigils/EnforceSingleSigil:
+Sorbet/EnforceSingleSigil:
   Description: 'Ensures that there is only one Sorbet sigil in a file.'
   Enabled: true
   VersionAdded: '<<next>>'
@@ -197,6 +197,17 @@ Sorbet/TrueSigil:
   - db/**/*.rb
   - script/**/*
 
+Sorbet/TypeAliasName:
+  Description: 'Type alias constant names must be in CamelCase.'
+  Enabled: true
+  VersionAdded: 0.6.6
+  Include:
+  - "**/*.{rb,rbi,rake,ru}"
+  Exclude:
+  - bin/**/*
+  - db/**/*.rb
+  - script/**/*
+
 Sorbet/ValidSigil:
   Description: 'All files must have a valid sigil.'
   Enabled: true

data/config/rbi.yml

@@ -220,6 +220,9 @@ Sorbet/SignatureBuildOrder:
 Sorbet/SingleLineRbiClassModuleDefinitions:
   Enabled: true
 
+Sorbet/TypeAliasName:
+  Enabled: true
+
 Sorbet/ValidSigil:
   Enabled: true
   RequireSigilOnAllFiles: true

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

@@ -57,12 +57,18 @@ module RuboCop
           )
         PATTERN
 
-        def_node_matcher(:generic_parameter_decl?, <<-PATTERN)
+        def_node_matcher(:generic_parameter_decl_call?, <<-PATTERN)
           (
             send nil? {:type_template :type_member} ...
           )
         PATTERN
 
+        def_node_matcher(:generic_parameter_decl_block_call?, <<-PATTERN)
+          (block
+            (send nil? {:type_template :type_member}) ...
+          )
+        PATTERN
+
         def_node_search(:method_needing_aliasing_on_t?, <<-PATTERN)
           (
             send
@@ -81,7 +87,7 @@ module RuboCop
         end
 
         def not_generic_parameter_decl?(node)
-          !generic_parameter_decl?(node)
+          !generic_parameter_decl_call?(node) && !generic_parameter_decl_block_call?(node)
         end
 
         def not_nil?(node)

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

@@ -0,0 +1,29 @@
+# frozen_string_literal: true
+
+require "rubocop/cop/style/mutable_constant"
+
+module RuboCop
+  module Cop
+    module Sorbet
+      module MutableConstantSorbetAwareBehaviour
+        def self.prepended(base)
+          base.def_node_matcher(:t_let, <<~PATTERN)
+            (send (const nil? :T) :let $_constant _type)
+          PATTERN
+        end
+
+        def on_assignment(value)
+          t_let(value) do |constant|
+            value = constant
+          end
+
+          super(value)
+        end
+      end
+    end
+  end
+end
+
+RuboCop::Cop::Style::MutableConstant.prepend(
+  RuboCop::Cop::Sorbet::MutableConstantSorbetAwareBehaviour
+)

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

@@ -0,0 +1,45 @@
+# frozen_string_literal: true
+
+require "rubocop"
+
+module RuboCop
+  module Cop
+    module Sorbet
+      # This cop ensures all constants used as `T.type_alias` are using CamelCase.
+      #
+      # @example
+      #
+      #   # bad
+      #   FOO_OR_BAR = T.type_alias { T.any(Foo, Bar) }
+      #
+      #   # good
+      #   FooOrBar = T.type_alias { T.any(Foo, Bar) }
+      class TypeAliasName < RuboCop::Cop::Cop
+        MSG = "Type alias constant name should be in CamelCase"
+
+        def_node_matcher(:casgn_type_alias?, <<-PATTERN)
+          (casgn
+            _
+            _
+            (block
+              (send
+                (const nil? :T) :type_alias)
+                _
+                _
+            ))
+        PATTERN
+
+        def on_casgn(node)
+          return unless casgn_type_alias?(node)
+
+          name = node.children[1]
+
+          # From https://github.com/rubocop/rubocop/blob/master/lib/rubocop/cop/naming/class_and_module_camel_case.rb
+          return unless /_/.match?(name)
+
+          add_offense(node)
+        end
+      end
+    end
+  end
+end

data/lib/rubocop/cop/sorbet_cops.rb

@@ -7,6 +7,7 @@ require_relative "sorbet/forbid_untyped_struct_props"
 require_relative "sorbet/one_ancestor_per_line"
 require_relative "sorbet/callback_conditionals_binding"
 require_relative "sorbet/forbid_t_unsafe"
+require_relative "sorbet/type_alias_name"
 
 require_relative "sorbet/rbi/forbid_extend_t_sig_helpers_in_shims"
 require_relative "sorbet/rbi/forbid_rbi_outside_of_allowed_paths"
@@ -27,3 +28,5 @@ require_relative "sorbet/sigils/strict_sigil"
 require_relative "sorbet/sigils/strong_sigil"
 require_relative "sorbet/sigils/enforce_sigil_order"
 require_relative "sorbet/sigils/enforce_single_sigil"
+
+require_relative "sorbet/mutable_constant_sorbet_aware_behaviour"

data/lib/rubocop/sorbet/version.rb

@@ -1,6 +1,6 @@
 # frozen_string_literal: true
 module RuboCop
   module Sorbet
-    VERSION = "0.6.5"
+    VERSION = "0.6.8"
   end
 end

data/manual/cops.md

@@ -30,6 +30,12 @@ In the following section you find all available cops:
 * [Sorbet/StrictSigil](cops_sorbet.md#sorbetstrictsigil)
 * [Sorbet/StrongSigil](cops_sorbet.md#sorbetstrongsigil)
 * [Sorbet/TrueSigil](cops_sorbet.md#sorbettruesigil)
+* [Sorbet/TypeAliasName](cops_sorbet.md#sorbettypealiasname)
 * [Sorbet/ValidSigil](cops_sorbet.md#sorbetvalidsigil)
 
 <!-- END_COP_LIST -->
+
+In addition to the cops defined in this gem, it also modifies the behaviour of some other cops
+defined in other RuboCop gems:
+
+* [Style/MutableConstant](https://docs.rubocop.org/rubocop/cops_style.html#stylemutableconstant): In addition to the default behaviour, RuboCop Sorbet makes this cop `T.let` aware, so that `CONST = T.let([1, 2, 3], T::Array[Integer])` is also treated as a mutable literal constant value.

data/manual/cops_sorbet.md

@@ -545,6 +545,31 @@ SuggestedStrictness | `true` | String
 Include | `**/*.{rb,rbi,rake,ru}` | Array
 Exclude | `bin/**/*`, `db/**/*.rb`, `script/**/*` | Array
 
+## Sorbet/TypeAliasName
+
+Enabled by default | Safe | Supports autocorrection | VersionAdded | VersionChanged
+--- | --- | --- | --- | ---
+Enabled | Yes | No | 0.6.6 | -
+
+This cop ensures all constants used as `T.type_alias` are using CamelCase.
+
+### Examples
+
+```ruby
+# bad
+FOO_OR_BAR = T.type_alias { T.any(Foo, Bar) }
+
+# good
+FooOrBar = T.type_alias { T.any(Foo, Bar) }
+```
+
+### Configurable attributes
+
+Name | Default value | Configurable values
+--- | --- | ---
+Include | `**/*.{rb,rbi,rake,ru}` | Array
+Exclude | `bin/**/*`, `db/**/*.rb`, `script/**/*` | Array
+
 ## 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.6.5
+  version: 0.6.8
 platform: ruby
 authors:
 - Ufuk Kayserilioglu
@@ -11,7 +11,7 @@ authors:
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2021-12-17 00:00:00.000000000 Z
+date: 2022-04-28 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rspec
@@ -92,6 +92,7 @@ files:
 - lib/rubocop/cop/sorbet/forbid_superclass_const_literal.rb
 - lib/rubocop/cop/sorbet/forbid_t_unsafe.rb
 - lib/rubocop/cop/sorbet/forbid_untyped_struct_props.rb
+- lib/rubocop/cop/sorbet/mutable_constant_sorbet_aware_behaviour.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
@@ -111,6 +112,7 @@ files:
 - lib/rubocop/cop/sorbet/signatures/keyword_argument_ordering.rb
 - lib/rubocop/cop/sorbet/signatures/signature_build_order.rb
 - lib/rubocop/cop/sorbet/signatures/signature_cop.rb
+- lib/rubocop/cop/sorbet/type_alias_name.rb
 - lib/rubocop/cop/sorbet_cops.rb
 - lib/rubocop/sorbet.rb
 - lib/rubocop/sorbet/inject.rb
@@ -119,7 +121,7 @@ files:
 - manual/cops_sorbet.md
 - rubocop-sorbet.gemspec
 - service.yml
-- shipit.yml
+- shipit.production.yml
 - tasks/cops_documentation.rake
 homepage: https://github.com/shopify/rubocop-sorbet
 licenses: