rubocop-github 0.27.0 → 0.29.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 9a3a81bf68f02c64d5924878583ac15ab2d074fd04dc99af95c18835b46151e7
-  data.tar.gz: 1a2bcbbb6d51b61809b2f98af2e62386b0c3bb23ddf8588ea39425dcec6f91b5
+  metadata.gz: f4ed4792206528abdf7eb36c3ee2e0bcea95fd7172c307ed4dbb28a9cf4fbd75
+  data.tar.gz: 02ff8ef3e2d538c0e3e546711d12645ea8f4cd539cb1ee287367750031c393a7
 SHA512:
-  metadata.gz: a929980cceae594cffb775cdacb830d4387237a97be920b06005a4a193cc6630797ddca7cb361ce0db75e1ce8062400f65b13344a4ac04ee31ab3ccefa25d0a1
-  data.tar.gz: 88851741cb4a060455f013d972b6bec989c0d1ae073afd8b64c4db977635be69b8d8403fec7c6abc93a7ba8738963b6ce2815d8eaca12dbab8c42ff89f67d358
+  metadata.gz: 5c7cc10a156d2ba06b2dd0c648675bad5e7f94bc9b2d65be8ebfe98c4c2da6143f1271ea28c013029c49e90db0f737b8f29f6cd8cb47171bdea2aff3392c59ac
+  data.tar.gz: 1da1d655ea26ad723324724610405ffa7ef81bc36babf96fe5f823723c29397cd519ab8c06432869deb017cb71c9eb1db3d5fec6aefbc20974a022c29ae4bebd

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