rubocop-sorbet 0.6.3 → 0.6.7

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: bd3fcc1ddd15ba9418aeb852d83149b3594fb315c7aa77ab4641c9046466d109
-  data.tar.gz: 2b446c026647ebb8d312e8be0034af253f61dc5ac8903c2b75bf42c11be903fe
+  metadata.gz: abb9e641bb3b12d53d9364cd235ab21b63c48339d2ffba858f593d421d029868
+  data.tar.gz: 5e2758c93d99a35d2c93914bd3e2c2bba08de4770eb2519a6b9a938460cddd3e
 SHA512:
-  metadata.gz: dd23c876c6224baf1a3888c169291b6260286326329d9b48650d1c4113571257837e0fa96d12b4357d4aee62e78b20e1be6373295b0d1e7d065c139e8cf3e25f
-  data.tar.gz: 12c3c8aae878c4474284fd41f79da1f4671399bb8e1f01403fe556d36e25274d951f42771ecd0dfc0c3527686b0f3aa1a0d3a22db9b7287c802adf9c43cbc718
+  metadata.gz: d0ae42fc7fb217d55f94ed40dfe8d721c18666d9b5bfe5c87035694c978c4165a41089dac38db2594904befffb3c33c80d62f7fbee440bdcbfa3e1d1e9687bc3
+  data.tar.gz: e418a1bdbdcd084c0ebe76a976ee813836be481fdfa336eb3387ab569adacabdd3bea6f9b9fefb74a9968bb56c8ad4a2ec1d5915b467626ecddb6a4904f1d738

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    rubocop-sorbet (0.6.3)
+    rubocop-sorbet (0.6.7)
       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

@@ -1,7 +1,5 @@
 # Rubocop-Sorbet
 
-[![Build Status](https://travis-ci.org/Shopify/rubocop-sorbet.svg?branch=master)](https://travis-ci.org/Shopify/rubocop-sorbet)
-
 A collection of Rubocop rules for Sorbet.
 
 ## Installation
@@ -17,7 +15,7 @@ or, if you use `Bundler`, add this line your application's `Gemfile`:
 gem 'rubocop-sorbet', require: false
 ```
 
-Note: in order to use the [Sorbet/SignatureBuildOrder](https://github.com/Shopify/rubocop-sorbet/blob/master/manual/cops_sorbet.md#sorbetsignaturebuildorder) cop autocorrect feature, it is necessary
+Note: in order to use the [Sorbet/SignatureBuildOrder](https://github.com/Shopify/rubocop-sorbet/blob/main/manual/cops_sorbet.md#sorbetsignaturebuildorder) cop autocorrect feature, it is necessary
 to install `unparser` in addition to `rubocop-sorbet`.
 
 ```ruby
@@ -111,8 +109,8 @@ bundle exec rake generate_cops_documentation
 
 ## License
 
-The gem is available as open source under the terms of the [MIT License](https://github.com/Shopify/rubocop-sorbet/blob/master/LICENSE.txt).
+The gem is available as open source under the terms of the [MIT License](https://github.com/Shopify/rubocop-sorbet/blob/main/LICENSE.txt).
 
 ## Code of Conduct
 
-Everyone interacting in the Rubocop::Sorbet project’s codebases, issue trackers, chat rooms and mailing lists is expected to follow the [code of conduct](https://github.com/Shopify/rubocop-sorbet/blob/master/CODE_OF_CONDUCT.md).
+Everyone interacting in the Rubocop::Sorbet project’s codebases, issue trackers, chat rooms and mailing lists is expected to follow the [code of conduct](https://github.com/Shopify/rubocop-sorbet/blob/main/CODE_OF_CONDUCT.md).

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

@@ -188,7 +188,7 @@ Lint/EmptyFile:
   Enabled: true
   AllowComments: false
 
-Lint/SyntaxError:
+Lint/Syntax:
   Enabled: true
 
 ## Sorbet
@@ -199,6 +199,9 @@ Sorbet:
 Sorbet/EnforceSigilOrder:
   Enabled: true
 
+Sorbet/EnforceSingleSigil:
+  Enabled: true
+
 Sorbet/ForbidExtendTSigHelpersInShims:
   Enabled: true
 
@@ -217,6 +220,9 @@ Sorbet/SignatureBuildOrder:
 Sorbet/SingleLineRbiClassModuleDefinitions:
   Enabled: true
 
+Sorbet/TypeAliasName:
+  Enabled: true
+
 Sorbet/ValidSigil:
   Enabled: true
   RequireSigilOnAllFiles: true

data/lib/rubocop/cop/sorbet/rbi/forbid_rbi_outside_of_allowed_paths.rb

@@ -1,5 +1,7 @@
 # frozen_string_literal: true
 
+require "pathname"
+
 module RuboCop
   module Cop
     module Sorbet
@@ -21,25 +23,41 @@ module RuboCop
         include RangeHelp
 
         def investigate(processed_source)
+          paths = allowed_paths
+
+          if paths.nil?
+            add_offense(
+              nil,
+              location: source_range(processed_source.buffer, 1, 0),
+              message: "AllowedPaths expects an array"
+            )
+            return
+          elsif paths.empty?
+            add_offense(
+              nil,
+              location: source_range(processed_source.buffer, 1, 0),
+              message: "AllowedPaths cannot be empty"
+            )
+            return
+          end
+
+          # When executed the path to the source file is absolute.
+          # We need to remove the exec path directory prefix before matching with the filename regular expressions.
+          rel_path = processed_source.file_path.sub("#{Dir.pwd}/", "")
+
           add_offense(
             nil,
             location: source_range(processed_source.buffer, 1, 0),
-            message: message
-          ) if allowed_paths.none? { |pattern| File.fnmatch(pattern, processed_source.file_path) }
+            message: "RBI file path should match one of: #{paths.join(", ")}"
+          ) if paths.none? { |pattern| File.fnmatch(pattern, rel_path) }
         end
 
         private
 
         def allowed_paths
-          cop_config["AllowedPaths"]&.compact || []
-        end
-
-        def message
-          if allowed_paths.empty?
-            "RBI files should be located in an allowed path, but AllowedPaths is empty or nil"
-          else
-            "RBI file path should match one of: #{allowed_paths.join(", ")}"
-          end
+          paths = cop_config["AllowedPaths"]
+          return nil unless paths.is_a?(Array)
+          paths.compact
         end
       end
     end

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"

data/lib/rubocop/sorbet/version.rb

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

data/manual/cops.md

@@ -30,6 +30,7 @@ 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 -->

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.3
+  version: 0.6.7
 platform: ruby
 authors:
 - Ufuk Kayserilioglu
@@ -11,7 +11,7 @@ authors:
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2021-12-03 00:00:00.000000000 Z
+date: 2022-02-11 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rspec
@@ -111,6 +111,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