rubocop-vicenzo 0.8.0 → 0.10.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: '094cfb18e36f28e2f311e80f435b1b5159f22875cfb8f13b5a0551ca9b5e9218'
-  data.tar.gz: b96a9634c956e7cec399e10a2f7f512a5f2894822ba07fecf7294a502fee56b5
+  metadata.gz: 4f7a8f58f53c6f2e6b50f1645a55cb401cd33b1f2654c793eaecd52cbf879153
+  data.tar.gz: f2eaba7a6bbb615190abf109a64681372988e3f8cea255c6055f6ae40698c7e2
 SHA512:
-  metadata.gz: ba554984ec7092154352415043f2868cd59bd89015de29b0098e01c1f0b2016b8b3a837845cd22e8219e1115b37f4b6e80eb3d5861d0f3325c0ad2894466de23
-  data.tar.gz: 031a968654d68f7fa65e7a57a6178fc97651ae8c20cb4861f25a1f4c9feb5c6d044a3bc7e269e4de392a9a38483ce51296517f852abe61e88ba804ad723140b4
+  metadata.gz: '0258853f6e8d32fb88d7d4c53fb5520e2c828bd31d5968be91008ab34c13a729188c802e91539ef95eef937c56dc584cb59c7dbb9ddcc8c50e3cd6e991eb49a1'
+  data.tar.gz: c8a4a8d41af0c5d5f294acfd9361f1226f002590b051508b97a6fbcb9f3f36dbe695a6ae6efbccb7c122395bc9dd76e83f7cffc9a026f3d822954e20236483df

data/.release-please-manifest.json

@@ -1,3 +1,3 @@
 {
-  ".": "0.8.0"
+  ".": "0.10.0"
 }

data/.rubocop.yml

@@ -1,3 +1,5 @@
+inherit_from: config/style.yml
+
 plugins:
   - rubocop-performance
   - rubocop-rake
@@ -5,39 +7,17 @@ plugins:
   - rubocop-vicenzo
   - rubocop-internal_affairs
 
-AllCops:
-  Exclude:
-    - 'bin/**/*'
-    - 'vendor/**/*'
-  NewCops: enable
-
 InternalAffairs/UndefinedConfig: # False positive because conflicts with Rubocop Layout namespace
   Exclude:
     - 'lib/rubocop/cop/vicenzo/layout/**/*'
 
-Metrics/BlockLength:
-  Exclude:
-    - 'rakelib/**/*'
-    - 'Rakefile'
-
 Naming/FileName:
   Exclude:
     - lib/rubocop-vicenzo.rb
 
-RSpec/ContextWording:
-  Prefixes:
-    - and
-    - but
-    - when
-    - with
-    - without
-
 RSpec/ExampleLength:
   Enabled: false
 
-RSpec/NestedGroups:
-  Enabled: false
-
 Vicenzo/RSpec/LeakyDefinition:
   Exclude:
     - 'spec/support/**/*'

data/CHANGELOG.md

@@ -1,5 +1,29 @@
 # Changelog
 
+## [0.10.0](https://github.com/bvicenzo/rubocop-vicenzo/compare/v0.9.0...v0.10.0) (2026-10-23)
+
+
+### Features
+
+* add Vicenzo/RSpec/LetAliasingSubject cop ([#44](https://github.com/bvicenzo/rubocop-vicenzo/issues/44)) ([a8cebd3](https://github.com/bvicenzo/rubocop-vicenzo/commit/a8cebd3c0237e8805a58ff9efa7ca34f6beb34b0)), closes [#42](https://github.com/bvicenzo/rubocop-vicenzo/issues/42)
+* add Vicenzo/Style/PreferManyOverSizeComparison cop ([#38](https://github.com/bvicenzo/rubocop-vicenzo/issues/38)) ([910ea02](https://github.com/bvicenzo/rubocop-vicenzo/commit/910ea026f7e4c46f9de27db580e6330cf845bfe7))
+
+
+### Bug Fixes
+
+* report subjects that derive from an allowed method in SubjectIsMethodResult ([#41](https://github.com/bvicenzo/rubocop-vicenzo/issues/41)) ([a5efd33](https://github.com/bvicenzo/rubocop-vicenzo/commit/a5efd3330b32dd24b4291121a64e378091297a57)), closes [#40](https://github.com/bvicenzo/rubocop-vicenzo/issues/40)
+* see subjects declared in shared groups in LetIsMethodResult and LetAliasingSubject ([#45](https://github.com/bvicenzo/rubocop-vicenzo/issues/45)) ([a98039e](https://github.com/bvicenzo/rubocop-vicenzo/commit/a98039e2cbea568267d8b7832b4717b763678d14)), closes [#43](https://github.com/bvicenzo/rubocop-vicenzo/issues/43)
+
+## [0.9.0](https://github.com/bvicenzo/rubocop-vicenzo/compare/v0.8.0...v0.9.0) (2026-09-23)
+
+
+### Features
+
+* add Vicenzo/Naming/AnonymousUnusedName cop ([#33](https://github.com/bvicenzo/rubocop-vicenzo/issues/33)) ([fabbad6](https://github.com/bvicenzo/rubocop-vicenzo/commit/fabbad655dac0c362924dd0aaf245abd2c7023e1))
+* add Vicenzo/Naming/ShortName cop and an opinionated config/style.yml ([#35](https://github.com/bvicenzo/rubocop-vicenzo/issues/35)) ([1b67f46](https://github.com/bvicenzo/rubocop-vicenzo/commit/1b67f4643b4348f5768a8fbb3b88cea35046e5e2))
+* add Vicenzo/RSpec/DescribeInsideContext cop ([#37](https://github.com/bvicenzo/rubocop-vicenzo/issues/37)) ([3f3d6ae](https://github.com/bvicenzo/rubocop-vicenzo/commit/3f3d6aeb95d087e32594e8ded3d1ce0e3715dee7))
+* add Vicenzo/RSpec/UnnestedContextImproperStart cop ([#36](https://github.com/bvicenzo/rubocop-vicenzo/issues/36)) ([0a8fb0f](https://github.com/bvicenzo/rubocop-vicenzo/commit/0a8fb0fec62370ac331b9a3275b95a0b22998b1d))
+
 ## [0.8.0](https://github.com/bvicenzo/rubocop-vicenzo/compare/v0.7.0...v0.8.0) (2026-09-09)
 
 

data/README.md

@@ -11,7 +11,7 @@ Add it to the `development`/`test` group of your `Gemfile`:
 <!-- x-release-please-start-version -->
 ```ruby
 group :development, :test do
-  gem 'rubocop-vicenzo', '~> 0.8.0', require: false
+  gem 'rubocop-vicenzo', '~> 0.10.0', require: false
 end
 ```
 <!-- x-release-please-end-version -->
@@ -64,6 +64,31 @@ cops together with the standard cops.
 rubocop --plugin rubocop-vicenzo
 ```
 
+## Opinionated style guide
+
+Loading the plugin gives you the `Vicenzo/*` cops and nothing else: their defaults
+live in `config/default.yml` and are applied automatically.
+
+The gem also ships `config/style.yml`, an opinionated configuration of the cops the
+`Vicenzo/*` ones build on — line length, multiline layout, metrics, and the naming
+rules that back `Vicenzo/Naming/ShortName` (notably `Naming/BlockParameterName`,
+which RuboCop ships with `MinNameLength: 1` and which therefore never fires). It is
+**opt-in**:
+
+```yaml
+inherit_gem:
+  rubocop-vicenzo: config/style.yml
+```
+
+That single line brings the configuration **and** the plugins it builds on
+(`rubocop-rspec` and this gem's own cops), so there is no `plugins:` key left for you
+to write.
+
+> [!NOTE]
+> `AllCops: CacheRootDirectory` is not inheritable. RuboCop reads it from the
+> top-level config file before resolving `inherit_from`/`inherit_gem`, so it has to
+> stay in your own `.rubocop.yml`.
+
 ## Development
 
 After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake spec` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.

data/Rakefile

@@ -4,8 +4,8 @@ require 'bundler/setup'
 require 'bundler/gem_tasks'
 require 'rspec/core/rake_task'
 
-RSpec::Core::RakeTask.new(:spec) do |t|
-  t.rspec_opts = '--format progress'
+RSpec::Core::RakeTask.new(:spec) do |rspec_task|
+  rspec_task.rspec_opts = '--format progress'
 end
 
 require 'rubocop/rake_task'

data/config/default.yml

@@ -5,6 +5,19 @@ Vicenzo/Layout/MultilineMethodCallLineBreaks:
   IndentationWidth: 2
   VersionAdded: '0.3.0'
 
+Vicenzo/Naming/AnonymousUnusedName:
+  Description: 'An unused declaration must not be anonymous; name it after what it stands for.'
+  Enabled: true
+  Severity: convention
+  VersionAdded: '0.9.0'
+
+Vicenzo/Naming/ShortName:
+  Description: 'A name too short to carry meaning; spell out whole words from the domain.'
+  Enabled: true
+  Severity: convention
+  MinNameLength: 3
+  VersionAdded: '0.9.0'
+
 Vicenzo/Rails/EnumInclusionOfValidation:
   Description: 'Check if the enum has the inclusion of validation defined.'
   Enabled: true
@@ -45,6 +58,17 @@ Vicenzo/RSpec/DerivedPremises:
     - '**/spec/factories/**/*'
   VersionAdded: '0.6.0'
 
+Vicenzo/RSpec/DescribeInsideContext:
+  Description: 'A describe must not be nested in a context, which is a scenario of the behaviour a describe names.'
+  Enabled: true
+  Severity: warning
+  Include:
+    - '**/spec/**/*_spec.rb'
+  Exclude:
+    - '**/spec/support/**/*'
+    - '**/spec/factories/**/*'
+  VersionAdded: '0.9.0'
+
 Vicenzo/RSpec/DynamicExampleGeneration:
   Description: 'Do not use iteration to dynamically generate example groups or examples.'
   Enabled: true
@@ -103,6 +127,17 @@ Vicenzo/RSpec/LeakyDefinition:
     - '**/spec/support/**/*'
     - '**/spec/factories/**/*'
 
+Vicenzo/RSpec/LetAliasingSubject:
+  Description: 'A let must not hold the subject itself under another name.'
+  Enabled: true
+  Severity: convention
+  Include:
+    - '**/spec/**/*_spec.rb'
+  Exclude:
+    - '**/spec/support/**/*'
+    - '**/spec/factories/**/*'
+  VersionAdded: '0.10.0'
+
 Vicenzo/RSpec/LetIsMethodResult:
   Description: 'A let under an example group describing a method must not hold the result of calling that method on the subject.'
   Enabled: true
@@ -194,6 +229,21 @@ Vicenzo/RSpec/TopLevelSubject:
     - '**/spec/factories/**/*'
   VersionAdded: '0.8.0'
 
+Vicenzo/RSpec/UnnestedContextImproperStart:
+  Description: 'Check if a context with no parent scenario starts with a conjunction.'
+  Enabled: true
+  Severity: convention
+  ForbiddenPrefixes:
+    - and
+    - but
+    - however
+  Include:
+    - '**/spec/**/*_spec.rb'
+  Exclude:
+    - '**/spec/support/**/*'
+    - '**/spec/factories/**/*'
+  VersionAdded: '0.9.0'
+
 Vicenzo/Style/JsonParseSymbolizeNames:
   Description: 'Enforces passing `symbolize_names: true` to `JSON.parse` so keys are symbols.'
   Enabled: true
@@ -205,3 +255,10 @@ Vicenzo/Style/MultilineMethodCallParentheses:
   Enabled: true
   AllowedMethods: []
   VersionAdded: '0.3.0'
+
+Vicenzo/Style/PreferManyOverSizeComparison:
+  Description: 'Use many? instead of comparing size or length with one.'
+  Enabled: true
+  Severity: convention
+  SafeAutoCorrect: false
+  VersionAdded: '0.10.0'

data/config/style.yml

@@ -0,0 +1,228 @@
+plugins:
+  - rubocop-vicenzo
+  - rubocop-rspec
+
+AllCops:
+  SuggestExtensions: false
+  NewCops: enable
+  Exclude:
+    - 'node_modules/**/*'
+    - 'vendor/**/*'
+    - 'bin/**/*'
+    - '.git/**/*'
+    - 'db/**/*'
+
+##### LAYOUT #####
+
+Layout/ArgumentAlignment:
+  Enabled: true
+  EnforcedStyle: with_fixed_indentation
+
+Layout/CaseIndentation:
+  Enabled: true
+  EnforcedStyle: end
+
+Layout/EndAlignment:
+  Enabled: true
+  EnforcedStyleAlignWith: variable
+
+Layout/FirstArgumentIndentation:
+  Enabled: true
+  EnforcedStyle: consistent
+
+Layout/FirstArrayElementIndentation:
+  Enabled: true
+  EnforcedStyle: consistent
+
+Layout/FirstHashElementIndentation:
+  Enabled: true
+  EnforcedStyle: consistent
+
+Layout/FirstMethodArgumentLineBreak:
+  Enabled: true
+
+Layout/LineLength:
+  Max: 120
+  # (\A|\s)   -> Start of line or whitespace
+  # #         -> The hash character
+  # (?!\{)    -> Negative lookahead: NOT followed by `{` (prevents matching interpolation)
+  AllowedPatterns: ['(\A|\s)#(?!\{)']
+
+Layout/MultilineMethodArgumentLineBreaks:
+  Enabled: true
+
+Layout/MultilineMethodCallBraceLayout:
+  Enabled: true
+  EnforcedStyle: new_line
+
+Layout/MultilineMethodCallIndentation:
+  Enabled: true
+  EnforcedStyle: indented
+
+Layout/FirstArrayElementLineBreak:
+  Enabled: true
+
+Layout/MultilineArrayLineBreaks:
+  Enabled: true
+
+Layout/MultilineArrayBraceLayout:
+  Enabled: true
+  EnforcedStyle: new_line
+
+Layout/FirstHashElementLineBreak:
+  Enabled: true
+
+Layout/MultilineHashKeyLineBreaks:
+  Enabled: true
+
+Layout/MultilineHashBraceLayout:
+  Enabled: true
+  EnforcedStyle: new_line
+
+##### STYLE #####
+
+Style/PreferredHashMethods:
+  Enabled: true
+  Safe: false
+  EnforcedStyle: verbose
+
+Style/SymbolArray:
+  Enabled: true
+  EnforcedStyle: percent
+  MinSize: 3
+
+Style/WordArray:
+  Enabled: true
+  EnforcedStyle: percent
+  MinSize: 3
+
+Style/MultilineBlockChain:
+  Enabled: false
+
+Style/Lambda:
+  Enabled: true
+  EnforcedStyle: literal
+
+Style/LambdaCall:
+  Enabled: false
+
+Style/Documentation:
+  Enabled: false
+
+##### LINT #####
+
+Lint/MissingSuper:
+  Enabled: false
+
+##### NAMING #####
+
+Naming/InclusiveLanguage:
+  Enabled: false
+
+Naming/PredicatePrefix:
+  ForbiddenPrefixes:
+    - is_
+    - have_
+    # allows `has_` predicate
+
+# A single letter says nothing about what was rescued.
+Naming/RescuedExceptionsVariableName:
+  Enabled: true
+  PreferredName: error
+
+# Vicenzo/Naming/ShortName covers local variables. Block parameters are the core
+# cop's job, but it ships with MinNameLength: 1 and therefore never fires — raise
+# it so both halves of the rule agree.
+Naming/BlockParameterName:
+  MinNameLength: 3
+
+###### METRICS #####
+
+Metrics/AbcSize:
+  Enabled: true
+  Max: 22
+
+Metrics/BlockLength:
+  Enabled: true
+  CountComments: false
+  CountAsOne:
+    - array
+    - hash
+    - heredoc
+    - method_call
+  AllowedMethods:
+    - 'describe'
+    - 'context'
+    - 'it'
+    - 'let'
+    - 'subject'
+    - 'namespace'
+    - 'task'
+    - 'configure'
+  Exclude:
+    - '**/*.gemspec'
+    - 'Rakefile'
+    - 'rakelib/**/*'
+    - 'spec/**/*'
+
+Metrics/ClassLength:
+  Enabled: true
+  Max: 200
+  CountAsOne:
+    - array
+    - hash
+    - heredoc
+    - method_call
+
+Metrics/MethodLength:
+  Enabled: true
+  CountAsOne:
+    - array
+    - hash
+    - heredoc
+    - method_call
+  Max: 20
+
+Metrics/ModuleLength:
+  Enabled: true
+  Max: 200
+  CountAsOne:
+    - array
+    - hash
+    - heredoc
+    - method_call
+
+##### RSPEC #####
+
+RSpec/ContextWording:
+  Prefixes:
+    - and
+    - but
+    - when
+    - with
+    - without
+
+RSpec/ExampleLength:
+  Max: 20
+  CountAsOne:
+    - array
+    - hash
+    - heredoc
+    - method_call
+
+RSpec/MultipleMemoizedHelpers:
+  Max: 10
+
+RSpec/NestedGroups:
+  Enabled: false
+
+RSpec/PredicateMatcher:
+  Strict: false
+
+##### VICENZO #####
+
+Vicenzo/Style/MultilineMethodCallParentheses:
+  AllowedMethods:
+    - to
+    - not_to
+    - to_not

data/lib/rubocop/cop/vicenzo/naming/anonymous_unused_name.rb

@@ -0,0 +1,164 @@
+# frozen_string_literal: true
+
+module RuboCop
+  module Cop
+    module Vicenzo
+      module Naming
+        # Requires every declaration to carry a name, even when the value it
+        # holds is not used.
+        #
+        # A bare `_` states that a value is being ignored, but erases what that
+        # value is. Unused today does not mean unusable tomorrow: when the code
+        # grows, nobody reading the signature can tell whether the discarded
+        # value is the one the new problem needs.
+        #
+        # The cop only demands that a name exists — it cannot judge whether a
+        # name is a good one. That is the author's call, and the offense message
+        # asks for a name taken from the domain (`_previous_owner`) rather than
+        # one taken from the shape of the value (`_value`, `_key`, `_item`).
+        #
+        # Anonymous forwarding parameters (`*`, `**`, `&`, `...`) are ignored:
+        # they forward arguments instead of discarding them, and `Style/ArgumentsForwarding`
+        # actively pushes code towards that form.
+        #
+        # @example block parameters
+        #   # bad
+        #   catalog.each { |_, copies| copies.each(&:reserve) }
+        #
+        #   # good
+        #   catalog.each { |_isbn, copies| copies.each(&:reserve) }
+        #
+        # @example destructured block parameters
+        #   # bad
+        #   entries.each { |(_, id)| track(id) }
+        #
+        #   # good
+        #   entries.each { |(_label, id)| track(id) }
+        #
+        # @example method parameters
+        #   # bad
+        #   def notify(reader, _)
+        #     reader.deliver
+        #   end
+        #
+        #   # good
+        #   def notify(reader, _delivery_channel)
+        #     reader.deliver
+        #   end
+        #
+        # @example multiple assignment
+        #   # bad
+        #   title, _ = line.split(';')
+        #
+        #   # good
+        #   title, _author = line.split(';')
+        #
+        # @example rescued errors
+        #   # bad
+        #   begin
+        #     shelf.reorder
+        #   rescue ShelfLocked => _
+        #     shelf.skip
+        #   end
+        #
+        #   # good
+        #   begin
+        #     shelf.reorder
+        #   rescue ShelfLocked => _lock_conflict
+        #     shelf.skip
+        #   end
+        #
+        # @example anonymous forwarding (ignored)
+        #   # good
+        #   def notify(*)
+        #     channel.deliver(*)
+        #   end
+        #
+        #   # good
+        #   def notify(...)
+        #     channel.deliver(...)
+        #   end
+        class AnonymousUnusedName < Base
+          MSG = 'Name this %<subject>s: an unused value still means something, and `_` hides what. ' \
+                'Name it after what it stands for in the domain (`_previous_owner`), not after its ' \
+                'shape (`_value`, `_key`, `_item`) — that tells the next reader nothing.'
+
+          BLOCK_PARAMETER  = 'block parameter'
+          METHOD_PARAMETER = 'method parameter'
+          DISCARDED_VALUE  = 'discarded value'
+          RESCUED_ERROR    = 'rescued error'
+
+          ANONYMOUS_NAME_PATTERN = /\A_+\z/
+
+          NAMED_ARGUMENT_TYPES = %i[arg optarg restarg kwarg kwoptarg kwrestarg blockarg shadowarg].freeze
+          DEFAULT_VALUE_ARGUMENT_TYPES = %i[optarg kwoptarg].freeze
+
+          # Numbered (`_1`) and implicit (`it`) block parameters are never
+          # declared, so they carry no name to check — both node types answer
+          # `arguments` with an empty list.
+          def on_block(node)
+            check_arguments(node.arguments, BLOCK_PARAMETER)
+          end
+          alias on_numblock on_block
+          alias on_itblock on_block
+
+          def on_def(node)
+            check_arguments(node.arguments, METHOD_PARAMETER)
+          end
+          alias on_defs on_def
+
+          def on_masgn(node)
+            node.lhs.assignments.each do |assignment|
+              next unless assignment.respond_to?(:lvasgn_type?) && assignment.lvasgn_type?
+
+              register_offense(assignment, DISCARDED_VALUE) if anonymous_name?(assignment.children.first)
+            end
+          end
+
+          def on_resbody(node)
+            error = node.exception_variable
+            return if error.nil?
+
+            register_offense(error, RESCUED_ERROR) if anonymous_name?(error.children.first)
+          end
+
+          private
+
+          def check_arguments(arguments, subject)
+            arguments.each do |argument|
+              if argument.mlhs_type?
+                check_arguments(argument.children, subject)
+              elsif anonymous_argument?(argument)
+                register_offense(argument_range(argument), subject)
+              end
+            end
+          end
+
+          # An anonymous forwarding parameter (`*`, `**`, `&`) carries no name
+          # child at all, and `...` is a `forward_arg`, outside the listed types.
+          # Both fall through as allowed.
+          def anonymous_argument?(argument)
+            NAMED_ARGUMENT_TYPES.include?(argument.type) && anonymous_name?(argument.children.first)
+          end
+
+          # An argument carrying a default value spans the whole expression, so
+          # only its name is highlighted; every other form is short enough that
+          # showing it whole (`*_`, `**_`, `&_`) tells the reader more.
+          def argument_range(argument)
+            return argument.loc.name if DEFAULT_VALUE_ARGUMENT_TYPES.include?(argument.type)
+
+            argument.source_range
+          end
+
+          def anonymous_name?(name)
+            !name.nil? && ANONYMOUS_NAME_PATTERN.match?(name.to_s)
+          end
+
+          def register_offense(node, subject)
+            add_offense(node, message: format(MSG, subject: subject))
+          end
+        end
+      end
+    end
+  end
+end