rubocop-github 0.27.0 → 0.28.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 9a3a81bf68f02c64d5924878583ac15ab2d074fd04dc99af95c18835b46151e7
-  data.tar.gz: 1a2bcbbb6d51b61809b2f98af2e62386b0c3bb23ddf8588ea39425dcec6f91b5
+  metadata.gz: 85257a3c793f7ca693d8ef2f85c669195d104754b3badbd4f7079ee2c1c1ddfa
+  data.tar.gz: 122d57805c2f7b00ef10d26d65cc8e2d2e9347d9079cc8505969739f3393ab44
 SHA512:
-  metadata.gz: a929980cceae594cffb775cdacb830d4387237a97be920b06005a4a193cc6630797ddca7cb361ce0db75e1ce8062400f65b13344a4ac04ee31ab3ccefa25d0a1
-  data.tar.gz: 88851741cb4a060455f013d972b6bec989c0d1ae073afd8b64c4db977635be69b8d8403fec7c6abc93a7ba8738963b6ce2815d8eaca12dbab8c42ff89f67d358
+  metadata.gz: 604bbfb3f9a7c1db7ff43263cfc5cb63a16887ebfaf9657edb1a92e3a8274846aeae09437285a11412395833ea9b3b9c120ee01c1f38e90f70832cd1ca0aef21
+  data.tar.gz: c31d203509da54b381c9d52f85980406620e711b13880dced839308fff4abd750b87e1a0e9d242c4c68f25521abd3d0d414b1c5caa0965e25d18f6cc61d6fb55

data/STYLEGUIDE.md

@@ -31,6 +31,8 @@ This is GitHub's Ruby Style Guide, inspired by [RuboCop's guide][rubocop-guide].
 18. [Rails](#rails)
     1. [content_for](#content_for)
     2. [Instance Variables in Views](#instance-variables-in-views)
+19. [Subclasses](#subclasses)
+    1. [Avoid Class#descendants and Class#subclasses](#avoid-classdescendants-and-classsubclasses)
 
 ## Layout
 
@@ -476,7 +478,7 @@ remove_member(user, skip_membership_check: true)
 
 * Use `snake_case` for methods and variables.
   <a name="snake-case-methods-vars"></a><sup>[[link](#snake-case-methods-vars)]</sup>
-  * <a href="https://docs.rubocop.org/rubocop/cops_naming.html#namingsnakecase">RuboCop rule: Naming/SnakeCase</a>
+  * <a href="https://docs.rubocop.org/rubocop/cops_naming.html#namingmethodname">RuboCop rule: Naming/MethodName</a>
   * <a href="https://docs.rubocop.org/rubocop/cops_naming.html#namingvariablename">RuboCop rule: Naming/VariableName</a>
 
 * Use `CamelCase` for classes and modules.  (Keep acronyms like HTTP,
@@ -491,7 +493,7 @@ remove_member(user, skip_membership_check: true)
 * The names of predicate methods (methods that return a boolean value)
   should end in a question mark. (i.e. `Array#empty?`).
   <a name="bool-methods-qmark"></a><sup>[[link](#bool-methods-qmark)]</sup>
-  * <a href="https://docs.rubocop.org/rubocop/cops_naming.html#namingpredicatename">RuboCop rule: Naming/PredicateName</a>
+  * <a href="https://docs.rubocop.org/rubocop/cops_naming.html#namingpredicateprefix">RuboCop rule: Naming/PredicatePrefix</a>
 
 * The names of potentially "dangerous" methods (i.e. methods that modify `self` or the
   arguments, `exit!`, etc.) should end with an exclamation mark. Bang methods
@@ -716,7 +718,7 @@ end
 * Favor modifier `if/unless` usage when you have a single-line
   body.
   <a name="favor-modifier-if-unless"></a><sup>[[link](#favor-modifier-if-unless)]</sup>
-  * <a href="https://docs.rubocop.org/rubocop/cops_style.html#stylemultilineternaryoperator">RuboCop rule: Style/MultilineTernaryOperator</a>
+  * <a href="https://docs.rubocop.org/rubocop/cops_style.html#styleifunlessmodifier">RuboCop rule: Style/IfUnlessModifier</a>
 
 ``` ruby
 # bad
@@ -786,7 +788,7 @@ end
   trivial. However, do use the ternary operator(`?:`) over `if/then/else/end` constructs
   for single line conditionals.
   <a name="trivial-ternary"></a><sup>[[link](#trivial-ternary)]</sup>
-  * <a href="https://docs.rubocop.org/rubocop/cops_style.html#stylemultilineternaryoperator">RuboCop rule: Style/MultilineTernaryOperator</a>
+  * <a href="https://docs.rubocop.org/rubocop/cops_style.html#styleonelineconditional">RuboCop rule: Style/OneLineConditional</a>
 
 ``` ruby
 # bad
@@ -840,11 +842,9 @@ end
 arr.each { |elem| puts elem }
 ```
 
-* Prefer `{...}` over `do...end` for single-line blocks.  Avoid using
-  `{...}` for multi-line blocks (multiline chaining is always
-  ugly). Always use `do...end` for "control flow" and "method
-  definitions" (e.g. in Rakefiles and certain DSLs).  Avoid `do...end`
-  when chaining.
+* Prefer `{...}` over `do...end` for single-line blocks. Avoid using
+  `{...}` for multi-line blocks. Always use `do...end` for "control flow" and "method
+  definitions" (e.g. in Rakefiles and certain DSLs).
   <a name="squiggly-braces"></a><sup>[[link](#squiggly-braces)]</sup>
   * <a href="https://docs.rubocop.org/rubocop/cops_style.html#styleblockdelimiters">RuboCop rule: Style/BlockDelimiters</a>
 
@@ -858,20 +858,8 @@ names.each { |name| puts name }
 names.each do |name|
   puts name
 end
-
-# good
-names.select { |name| name.start_with?("S") }.map { |name| name.upcase }
-
-# bad
-names.select do |name|
-  name.start_with?("S")
-end.map { |name| name.upcase }
 ```
 
-* Some will argue that multiline chaining would look OK with the use of `{...}`,
- but they should ask themselves: is this code really readable and can't the block's
- contents be extracted into nifty methods?
-
 * Avoid `return` where not required.
   <a name="avoid-return"></a><sup>[[link](#avoid-return)]</sup>
   * <a href="https://docs.rubocop.org/rubocop/cops_style.html#styleredundantreturn">RuboCop rule: Style/RedundantReturn</a>
@@ -890,7 +878,7 @@ end
 
 * Use spaces around the `=` operator when assigning default values to method parameters:
   <a name="spaces-around-equals"></a><sup>[[link](#spaces-around-equals)]</sup>
-  * <a href="https://docs.rubocop.org/rubocop/cops_style.html#stylespacearoundequalsinparameterdefault">RuboCop rule: Style/SpaceAroundEqualsInParameterDefault</a>
+  * <a href="https://docs.rubocop.org/rubocop/cops_layout.html#layoutspacearoundequalsinparameterdefault">RuboCop rule: Layout/SpaceAroundEqualsInParameterDefault</a>
 
 ``` ruby
 # bad
@@ -1096,4 +1084,43 @@ If you need to call a subview that expects an instance variable be set. If possi
 
 Unfortunately the only way to get data into a layout template is with instance variables. You can't explicitly pass locals to them.
 
+## Subclasses
+
+### Avoid `Class#descendants` and `Class#subclasses`
+
+Skip `Class#descendants` (ActiveSupport) and `Class#subclasses` (Ruby). They might lie to you in two ways:
+
+* If a class hasn't been autoloaded yet, they don't see it. So your answer depends on what the app happened to touch first.
+* GC can drop dynamically defined classes whenever it feels like it. Tests love this one.
+
+If you really, really need it, add a `rubocop:disable` on the line with a short note so that future-you isn't confused.
+
+* <a href="https://github.com/github/rubocop-github/blob/main/lib/rubocop/cop/github/unreliable_subclasses.rb">RuboCop rule: GitHub/UnreliableSubclasses</a>
+
+``` ruby
+class Person < ApplicationRecord
+end
+
+class Employee < Person
+end
+
+# bad
+Person.descendants # => maybe [Employee], maybe [], who knows? Not me! I never lost control.
+Person.subclasses  # => same problem
+
+# good. Keep an explicit registry
+class Person < ApplicationRecord
+  TYPES = []
+
+  def self.inherited(subclass)
+    super
+    TYPES << subclass
+  end
+end
+
+Person::TYPES # => [Employee, ...]
+```
+
+Other alternatives: eager load the dependency tree ([`Rails.application.eager_load!`](https://api.rubyonrails.org/classes/Rails/Application.html#method-i-eager_load-21) in tests, `config.eager_load = true` in prod) or use [`ActiveSupport::DescendantsTracker`](https://api.rubyonrails.org/classes/ActiveSupport/DescendantsTracker.html) directly if you really need the reflection.
+
 [rubocop-guide]: https://github.com/rubocop-hq/ruby-style-guide

data/config/default.yml

@@ -53,6 +53,10 @@ GitHub/AvoidObjectSendWithDynamicMethod:
 GitHub/InsecureHashAlgorithm:
   Enabled: true
 
+GitHub/UnreliableSubclasses:
+  Enabled: true
+  StyleGuide: https://github.com/github/rubocop-github/blob/main/STYLEGUIDE.md#avoid-classdescendants-and-classsubclasses
+
 Layout/AccessModifierIndentation:
   Enabled: false
   StyleGuide: https://github.com/github/rubocop-github/blob/main/STYLEGUIDE.md#user-content-access-modifier-indentation
@@ -283,6 +287,7 @@ Layout/SpaceAfterMethodName:
 
 Layout/SpaceAfterNot:
   Enabled: true
+  StyleGuide: https://github.com/github/rubocop-github/blob/main/STYLEGUIDE.md#no-spaces-bang
 
 Layout/SpaceAfterSemicolon:
   StyleGuide: https://github.com/github/rubocop-github/blob/main/STYLEGUIDE.md#spaces-operators
@@ -307,6 +312,7 @@ Layout/SpaceAroundOperators:
 
 Layout/SpaceBeforeBlockBraces:
   Enabled: true
+  StyleGuide: https://github.com/github/rubocop-github/blob/main/STYLEGUIDE.md#spaces-operators
 
 Layout/SpaceBeforeBrackets:
   Enabled: false
@@ -342,6 +348,7 @@ Layout/SpaceInsideHashLiteralBraces:
 
 Layout/SpaceInsideParens:
   Enabled: true
+  StyleGuide: https://github.com/github/rubocop-github/blob/main/STYLEGUIDE.md#no-spaces-braces
 
 Layout/SpaceInsidePercentLiteralDelimiters:
   Enabled: false
@@ -351,6 +358,7 @@ Layout/SpaceInsideRangeLiteral:
 
 Layout/SpaceInsideReferenceBrackets:
   Enabled: true
+  StyleGuide: https://github.com/github/rubocop-github/blob/main/STYLEGUIDE.md#no-spaces-braces
 
 Layout/SpaceInsideStringInterpolation:
   Enabled: false
@@ -404,6 +412,9 @@ Lint/ConstantOverwrittenInRescue:
 Lint/ConstantResolution:
   Enabled: false
 
+Lint/CopDirectiveSyntax:
+  Enabled: false
+
 Lint/Debugger:
   Enabled: true
 
@@ -821,12 +832,14 @@ Naming/MemoizedInstanceVariableName:
 
 Naming/MethodName:
   Enabled: true
+  StyleGuide: https://github.com/github/rubocop-github/blob/main/STYLEGUIDE.md#snake-case-methods-vars
 
 Naming/MethodParameterName:
   Enabled: false
 
 Naming/PredicatePrefix:
   Enabled: false
+  StyleGuide: https://github.com/github/rubocop-github/blob/main/STYLEGUIDE.md#bool-methods-qmark
 
 Naming/RescuedExceptionsVariableName:
   Enabled: false
@@ -1139,9 +1152,6 @@ Style/Documentation:
 Style/DocumentationMethod:
   Enabled: false
 
-Style/DoubleCopDisableDirective:
-  Enabled: false
-
 Style/DoubleNegation:
   Enabled: false
 
@@ -1265,6 +1275,7 @@ Style/IfInsideElse:
 
 Style/IfUnlessModifier:
   Enabled: false
+  StyleGuide: https://github.com/github/rubocop-github/blob/main/STYLEGUIDE.md#favor-modifier-if-unless
 
 Style/IfUnlessModifierOfIfUnless:
   Enabled: false
@@ -1365,6 +1376,7 @@ Style/MultilineMethodSignature:
 
 Style/MultilineTernaryOperator:
   Enabled: false
+  StyleGuide: https://github.com/github/rubocop-github/blob/main/STYLEGUIDE.md#no-multiline-ternary
 
 Style/MultilineWhenThen:
   Enabled: false
@@ -1438,6 +1450,7 @@ Style/ObjectThen:
 
 Style/OneLineConditional:
   Enabled: true
+  StyleGuide: https://github.com/github/rubocop-github/blob/main/STYLEGUIDE.md#trivial-ternary
 
 Style/OpenStructUse:
   Enabled: false
@@ -1450,6 +1463,7 @@ Style/OptionalArguments:
 
 Style/OptionalBooleanParameter:
   Enabled: false
+  StyleGuide: https://github.com/github/rubocop-github/blob/main/STYLEGUIDE.md#keyword-arguments
 
 Style/OrAssignment:
   Enabled: true
@@ -1462,6 +1476,7 @@ Style/ParallelAssignment:
 
 Style/ParenthesesAroundCondition:
   Enabled: false
+  StyleGuide: https://github.com/github/rubocop-github/blob/main/STYLEGUIDE.md#no-parens-if-unless-while
 
 Style/PercentLiteralDelimiters:
   Enabled: false
@@ -1624,6 +1639,7 @@ Style/StringChars:
 
 Style/StringConcatenation:
   Enabled: false
+  StyleGuide: https://github.com/github/rubocop-github/blob/main/STYLEGUIDE.md#string-interpolation
 
 Style/StringHashKeys:
   Enabled: false

data/config/default_cops.yml

@@ -1,3 +1,7 @@
 GitHub/InsecureHashAlgorithm:
   Description: 'Encourage usage of secure hash algorithms'
   Enabled: pending
+
+GitHub/UnreliableSubclasses:
+  Description: "Avoid `Class#subclasses` and `Class#descendants`; they miss not-yet-autoloaded classes and depend on GC timing."
+  Enabled: pending

data/config/default_pending.yml

@@ -112,5 +112,89 @@ Style/SendWithLiteralMethodName: # new in 1.64
   Enabled: false
 Style/SuperArguments: # new in 1.64
   Enabled: false
+Gemspec/AttributeAssignment: # new in 1.77
+  Enabled: true
+Layout/EmptyLinesAfterModuleInclusion: # new in 1.79
+  Enabled: true
+Lint/ArgumentMismatch: # new in 1.90
+  Enabled: true
+Lint/ArrayLiteralInRegexp: # new in 1.71
+  Enabled: true
+Lint/DataDefineOverride: # new in 1.85
+  Enabled: true
+Lint/DeprecatedReference: # new in 1.89
+  Enabled: true
+Lint/MisplacedMagicComment: # new in 1.91
+  Enabled: true
+Lint/NameTypo: # new in 1.89
+  Enabled: true
+Lint/RedundantTypeConversion: # new in 1.72
+  Enabled: true
+Lint/SuperArgumentMismatch: # new in 1.90
+  Enabled: true
+Lint/SuppressedExceptionInNumberConversion: # new in 1.72
+  Enabled: true
+Lint/UnreachablePatternBranch: # new in 1.85
+  Enabled: true
+Lint/UselessConstantScoping: # new in 1.72
+  Enabled: true
+Lint/UselessDefaultValueArgument: # new in 1.76
+  Enabled: true
+Lint/UselessOr: # new in 1.76
+  Enabled: true
+Naming/PredicateMethod: # new in 1.76
+  Enabled: true
+Style/ArrayIntersectWithSingleElement: # new in 1.81
+  Enabled: true
+Style/CollectionQuerying: # new in 1.77
+  Enabled: true
+Style/ComparableBetween: # new in 1.74
+  Enabled: true
+Style/DirectiveScope: # new in 1.90
+  Enabled: true
+Style/EmptyClassDefinition: # new in 1.84
+  Enabled: true
+Style/EmptyStringInsideInterpolation: # new in 1.76
+  Enabled: true
+Style/FileOpen: # new in 1.85
+  Enabled: true
+Style/HashFetchChain: # new in 1.75
+  Enabled: true
+Style/HashSlice: # new in 1.71
+  Enabled: true
+Style/ItBlockParameter: # new in 1.75
+  Enabled: true
+Style/MapJoin: # new in 1.85
+  Enabled: true
+Style/ModuleMemberExistenceCheck: # new in 1.82
+  Enabled: true
+Style/NegativeArrayIndex: # new in 1.84
+  Enabled: true
+Style/OneClassPerFile: # new in 1.85
+  Enabled: true
+Style/PartitionInsteadOfDoubleSelect: # new in 1.85
+  Enabled: true
+Style/PredicateWithKind: # new in 1.85
+  Enabled: true
+Style/ReduceToHash: # new in 1.85
+  Enabled: true
+Style/RedundantArrayFlatten: # new in 1.76
+  Enabled: true
+Style/RedundantFormat: # new in 1.72
+  Enabled: true
+Style/RedundantMinMaxBy: # new in 1.85
+  Enabled: true
+Style/ReverseFind: # new in 1.84
+  Enabled: true
+Style/SelectByKind: # new in 1.85
+  Enabled: true
+Style/SelectByRange: # new in 1.85
+  Enabled: true
+Style/TallyMethod: # new in 1.85
+  Enabled: true
+Style/TimeNow: # new in 1.90
+  Enabled: true
 Performance/StringBytesize: # new in 1.23
   Enabled: false
+Performance/ZipWithoutBlock: # new in 1.24
+  Enabled: true

data/config/rails_pending.yml

@@ -100,3 +100,15 @@ Rails/EnumSyntax: # new in 2.26
   Enabled: false
 Rails/WhereRange: # new in 2.25
   Enabled: false
+Rails/FindByOrAssignmentMemoization: # new in 2.33
+  Enabled: true
+Rails/HttpStatusNameConsistency: # new in 2.34
+  Enabled: true
+Rails/MultipleRoutePaths: # new in 2.29
+  Enabled: true
+Rails/OrderArguments: # new in 2.33
+  Enabled: true
+Rails/RedirectBackOrTo: # new in 2.34
+  Enabled: true
+Rails/StrongParametersExpect: # new in 2.29
+  Enabled: true

data/lib/rubocop/cop/github/rails_view_render_literal.rb

@@ -52,7 +52,10 @@ module RuboCop
             return
           end
 
+          # `many?` is an ActiveSupport extension, but this cop runs without ActiveSupport.
+          # rubocop:disable Style/CollectionQuerying
           if render_literal?(node) && node.arguments.count > 1
+            # rubocop:enable Style/CollectionQuerying
             locals = node.arguments[1]
           elsif option_pairs = render_with_options?(node)
             locals = option_pairs.map { |pair| locals_key?(pair) }.compact.first

data/lib/rubocop/cop/github/unreliable_subclasses.rb

@@ -0,0 +1,48 @@
+# frozen_string_literal: true
+
+require "rubocop"
+
+module RuboCop
+  module Cop
+    module GitHub
+      # Inform people when they reach for Class#subclasses (Ruby) or
+      # Class#descendants (ActiveSupport).
+      #
+      # two reasons these can be unreliable:
+      #   1. autoload hasn't run yet, so half the tree is invisible
+      #   2. GC may have eaten dynamically-defined classes (i.e. in test suites)
+      #
+      # If you really need it, add a rubocop:disable on the line with a note
+      # explaining why future-you won't be sad.
+      class UnreliableSubclasses < Base
+        MSG = "Avoid `%<method>s` here. It may miss not-yet-autoloaded classes and depends on GC timing. " \
+              "Prefer an explicit registry or eager loading."
+
+        RESTRICT_ON_SEND = %i[descendants subclasses].freeze
+
+        # matches Foo.descendants, Foo::Bar.subclasses, self.descendants
+        # receiver has to be a constant or `self`
+        def_node_matcher :unreliable_call?, <<~PATTERN
+          (send {const self} {:descendants :subclasses})
+        PATTERN
+
+        # the same thing but with safe navigation operator
+        def_node_matcher :unreliable_csend?, <<~PATTERN
+          (csend {const self} {:descendants :subclasses})
+        PATTERN
+
+        def on_send(node)
+          return unless unreliable_call?(node)
+
+          add_offense(node, message: format(MSG, method: node.method_name))
+        end
+
+        def on_csend(node)
+          return unless unreliable_csend?(node)
+
+          add_offense(node, message: format(MSG, method: node.method_name))
+        end
+      end
+    end
+  end
+end

data/lib/rubocop-github.rb

@@ -8,3 +8,4 @@ RuboCop::GitHub::Inject.default_defaults!
 
 require "rubocop/cop/github/avoid_object_send_with_dynamic_method"
 require "rubocop/cop/github/insecure_hash_algorithm"
+require "rubocop/cop/github/unreliable_subclasses"

data/lib/version.rb

@@ -1,3 +1,3 @@
 # frozen_string_literal: true
 
-VERSION = "0.27.0"
+VERSION = "0.28.0"

metadata

@@ -1,13 +1,13 @@
 --- !ruby/object:Gem::Specification
 name: rubocop-github
 version: !ruby/object:Gem::Version
-  version: 0.27.0
+  version: 0.28.0
 platform: ruby
 authors:
 - GitHub
 bindir: bin
 cert_chain: []
-date: 2026-03-13 00:00:00.000000000 Z
+date: 2026-09-30 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rubocop
@@ -15,14 +15,14 @@ dependencies:
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: '1.76'
+        version: '1.91'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: '1.76'
+        version: '1.91'
 - !ruby/object:Gem::Dependency
   name: rubocop-performance
   requirement: !ruby/object:Gem::Requirement
@@ -43,28 +43,28 @@ dependencies:
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: '2.23'
+        version: '2.34'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: '2.23'
+        version: '2.34'
 - !ruby/object:Gem::Dependency
   name: actionview
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 7.2.3
+        version: 8.1.3
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 7.2.3
+        version: 8.1.3
 - !ruby/object:Gem::Dependency
   name: minitest
   requirement: !ruby/object:Gem::Requirement
@@ -124,6 +124,7 @@ files:
 - lib/rubocop/cop/github/rails_view_render_paths_exist.rb
 - lib/rubocop/cop/github/rails_view_render_shorthand.rb
 - lib/rubocop/cop/github/render_literal_helpers.rb
+- lib/rubocop/cop/github/unreliable_subclasses.rb
 - lib/rubocop/github.rb
 - lib/rubocop/github/inject.rb
 - lib/version.rb
@@ -141,7 +142,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: 3.3.0
+      version: 3.4.2
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="