Rename ForbidRBIOutsideOfAllowedPaths to RBIFilePath

This name is more idiomatic and focussed on what is allowed (using the allowed paths) rather than forbidding other paths.
Shopify · Mar 20, 2024 · 95e349d · 95e349d
1 parent c5a84ee
commit 95e349d
Show file tree

Hide file tree

Showing 7 changed files with 39 additions and 38 deletions.
diff --git a/config/default.yml b/config/default.yml
@@ -73,7 +73,7 @@ Sorbet/ForbidExtendTSigHelpersInShims:
   Include:
   - "**/*.rbi"
 
-Sorbet/ForbidRBIOutsideOfAllowedPaths:
+Sorbet/RBIFilePath:
   Description: 'Forbids RBI files outside of the allowed paths'
   Enabled: true
   VersionAdded: 0.6.1

diff --git a/config/obsoletion.yml b/config/obsoletion.yml
@@ -3,4 +3,5 @@
 #
 # See: https://docs.rubocop.org/rubocop/extensions.html#config-obsoletions
 #
-{}
+renamed:
+  Sorbet/ForbidRBIOutsideOfAllowedPaths: Sorbet/RBIFilePath
diff --git a/...bi/forbid_rbi_outside_of_allowed_paths.rb → lib/rubocop/cop/sorbet/rbi/rbi_file_path.rb b/...bi/forbid_rbi_outside_of_allowed_paths.rb → lib/rubocop/cop/sorbet/rbi/rbi_file_path.rb
@@ -20,7 +20,7 @@ module Sorbet
       #   # rbi/external_interface.rbi
       #   # sorbet/rbi/some_file.rbi
       #   # sorbet/rbi/any/path/for/file.rbi
-      class ForbidRBIOutsideOfAllowedPaths < RuboCop::Cop::Base
+      class RBIFilePath < RuboCop::Cop::Base
         MSG = "RBI file path should match one of: %<allowed_paths>s"
 
         def on_new_investigation

diff --git a/lib/rubocop/cop/sorbet_cops.rb b/lib/rubocop/cop/sorbet_cops.rb
@@ -21,7 +21,7 @@
 require_relative "sorbet/buggy_obsolete_strict_memoization"
 
 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/rbi_file_path"
 require_relative "sorbet/rbi/single_line_rbi_class_module_definitions"
 
 require_relative "sorbet/signatures/allow_incompatible_override"

diff --git a/manual/cops.md b/manual/cops.md
@@ -18,7 +18,6 @@ In the following section you find all available cops:
 * [Sorbet/FalseSigil](cops_sorbet.md#sorbetfalsesigil)
 * [Sorbet/ForbidExtendTSigHelpersInShims](cops_sorbet.md#sorbetforbidextendtsighelpersinshims)
 * [Sorbet/ForbidIncludeConstLiteral](cops_sorbet.md#sorbetforbidincludeconstliteral)
-* [Sorbet/ForbidRBIOutsideOfAllowedPaths](cops_sorbet.md#sorbetforbidrbioutsideofallowedpaths)
 * [Sorbet/ForbidSuperclassConstLiteral](cops_sorbet.md#sorbetforbidsuperclassconstliteral)
 * [Sorbet/ForbidTStruct](cops_sorbet.md#sorbetforbidtstruct)
 * [Sorbet/ForbidTUnsafe](cops_sorbet.md#sorbetforbidtunsafe)
@@ -31,6 +30,7 @@ In the following section you find all available cops:
 * [Sorbet/KeywordArgumentOrdering](cops_sorbet.md#sorbetkeywordargumentordering)
 * [Sorbet/ObsoleteStrictMemoization](cops_sorbet.md#sorbetobsoletestrictmemoization)
 * [Sorbet/OneAncestorPerLine](cops_sorbet.md#sorbetoneancestorperline)
+* [Sorbet/RBIFilePath](cops_sorbet.md#sorbetrbifilepath)
 * [Sorbet/RedundantExtendTSig](cops_sorbet.md#sorbetredundantextendtsig)
 * [Sorbet/SignatureBuildOrder](cops_sorbet.md#sorbetsignaturebuildorder)
 * [Sorbet/SingleLineRbiClassModuleDefinitions](cops_sorbet.md#sorbetsinglelinerbiclassmoduledefinitions)

diff --git a/manual/cops_sorbet.md b/manual/cops_sorbet.md
@@ -356,38 +356,6 @@ or
 include Polaris::Engine.helpers
 ```
 
-## Sorbet/ForbidRBIOutsideOfAllowedPaths
-
-Enabled by default | Safe | Supports autocorrection | VersionAdded | VersionChanged
---- | --- | --- | --- | ---
-Enabled | Yes | No | 0.6.1 | -
-
-Makes sure that RBI files are always located under the defined allowed paths.
-
-Options:
-
-* `AllowedPaths`: A list of the paths where RBI files are allowed (default: ["rbi/**", "sorbet/rbi/**"])
-
-### Examples
-
-```ruby
-# bad
-# lib/some_file.rbi
-# other_file.rbi
-
-# good
-# rbi/external_interface.rbi
-# sorbet/rbi/some_file.rbi
-# sorbet/rbi/any/path/for/file.rbi
-```
-
-### Configurable attributes
-
-Name | Default value | Configurable values
---- | --- | ---
-AllowedPaths | `rbi/**`, `sorbet/rbi/**` | Array
-Include | `**/*.rbi` | Array
-
 ## Sorbet/ForbidSuperclassConstLiteral
 
 Enabled by default | Safe | Supports autocorrection | VersionAdded | VersionChanged
@@ -700,6 +668,38 @@ module SomeModule
 end
 ```
 
+## Sorbet/RBIFilePath
+
+Enabled by default | Safe | Supports autocorrection | VersionAdded | VersionChanged
+--- | --- | --- | --- | ---
+Enabled | Yes | No | 0.6.1 | -
+
+Makes sure that RBI files are always located under the defined allowed paths.
+
+Options:
+
+* `AllowedPaths`: A list of the paths where RBI files are allowed (default: ["rbi/**", "sorbet/rbi/**"])
+
+### Examples
+
+```ruby
+# bad
+# lib/some_file.rbi
+# other_file.rbi
+
+# good
+# rbi/external_interface.rbi
+# sorbet/rbi/some_file.rbi
+# sorbet/rbi/any/path/for/file.rbi
+```
+
+### Configurable attributes
+
+Name | Default value | Configurable values
+--- | --- | ---
+AllowedPaths | `rbi/**`, `sorbet/rbi/**` | Array
+Include | `**/*.rbi` | Array
+
 ## Sorbet/RedundantExtendTSig
 
 Enabled by default | Safe | Supports autocorrection | VersionAdded | VersionChanged

diff --git a/...rbid_rbi_outside_of_allowed_paths_spec.rb → spec/rubocop/cop/sorbet/rbi/rbi_file_path.rb b/...rbid_rbi_outside_of_allowed_paths_spec.rb → spec/rubocop/cop/sorbet/rbi/rbi_file_path.rb
@@ -2,7 +2,7 @@
 
 require "spec_helper"
 
-RSpec.describe(RuboCop::Cop::Sorbet::ForbidRBIOutsideOfAllowedPaths, :config) do
+RSpec.describe(RuboCop::Cop::Sorbet::RBIFilePath, :config) do
   describe "with default configuration" do
     it "registers an offense if an RBI file is outside AllowedPaths" do
       expect_offense(<<~RUBY, filename: "some/dir/file.rbi")