Cut 1.68

bbatsov · bbatsov · commit 7d35ef752b62 · 2024-10-31T09:38:17.000+02:00
diff --git a/.github/ISSUE_TEMPLATE/bug_report.md b/.github/ISSUE_TEMPLATE/bug_report.md
@@ -38,7 +38,7 @@ output by `rubocop -V`, include them as well. Here's an example:
 
 ```
 $ [bundle exec] rubocop -V
-1.67.0 (using Parser 3.3.5.0, rubocop-ast 1.32.3, analyzing as Ruby 3.3, running on ruby 3.3.5) [x86_64-linux]
+1.68.0 (using Parser 3.3.5.0, rubocop-ast 1.32.3, analyzing as Ruby 3.3, running on ruby 3.3.5) [x86_64-linux]
   - rubocop-performance 1.22.1
   - rubocop-rspec 3.1.0
 ```
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -11,6 +11,8 @@
 
 ## master (unreleased)
 
+## 1.68.0 (2024-10-31)
+
 ### New features
 
 * [#13050](https://github.com/rubocop/rubocop/issues/13050): Add new `Style/BitwisePredicate` cop. ([@koic][])
diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md
@@ -17,7 +17,7 @@ do so.
 
 ```console
 $ rubocop -V
-1.67.0 (using Parser 3.3.5.0, rubocop-ast 1.32.3, analyzing as Ruby 3.3, running on ruby 3.3.5) [x86_64-linux]
+1.68.0 (using Parser 3.3.5.0, rubocop-ast 1.32.3, analyzing as Ruby 3.3, running on ruby 3.3.5) [x86_64-linux]
   - rubocop-performance 1.22.1
   - rubocop-rspec 3.1.0
 ```
diff --git a/README.md b/README.md
@@ -52,7 +52,7 @@ To prevent an unwanted RuboCop update you might want to use a conservative versi
 in your `Gemfile`:
 
 ```rb
-gem 'rubocop', '~> 1.67', require: false
+gem 'rubocop', '~> 1.68', require: false
 ```
 
 See [our versioning policy](https://docs.rubocop.org/rubocop/versioning.html) for further details.
diff --git a/config/default.yml b/config/default.yml
@@ -2460,7 +2460,7 @@ Lint/UnderscorePrefixedVariableName:
 Lint/UnescapedBracketInRegexp:
   Description: 'Checks for unescaped literal `]` in Regexp.'
   Enabled: pending
-  VersionAdded: '<<next>>'
+  VersionAdded: '1.68'
 
 Lint/UnexpectedBlockArity:
   Description: 'Looks for blocks that have fewer arguments that the calling method expects.'
@@ -3154,7 +3154,7 @@ Style/AmbiguousEndlessMethodDefinition:
   Description: 'Checks for endless methods inside operators of lower precedence.'
   StyleGuide: '#ambiguous-endless-method-defintions'
   Enabled: pending
-  VersionAdded: '<<next>>'
+  VersionAdded: '1.68'
 
 Style/AndOr:
   Description: 'Use &&/|| instead of and/or.'
@@ -3268,7 +3268,7 @@ Style/BitwisePredicate:
   StyleGuide: '#bitwise-predicate-methods'
   Enabled: pending
   Safe: false
-  VersionAdded: '<<next>>'
+  VersionAdded: '1.68'
 
 Style/BlockComments:
   Description: 'Do not use block comments.'
@@ -3556,7 +3556,7 @@ Style/ColonMethodDefinition:
 Style/CombinableDefined:
   Description: 'Checks successive `defined?` calls that can be combined into a single call.'
   Enabled: pending
-  VersionAdded: '<<next>>'
+  VersionAdded: '1.68'
 
 Style/CombinableLoops:
   Description: >-
@@ -4287,7 +4287,7 @@ Style/KeywordArgumentsMerging:
                  directly rather than using `merge`.
   StyleGuide: '#merging-keyword-arguments'
   Enabled: pending
-  VersionAdded: '<<next>>'
+  VersionAdded: '1.68'
 
 Style/KeywordParametersOrder:
   Description: 'Enforces that optional keyword parameters are placed at the end of the parameters list.'
@@ -5278,7 +5278,7 @@ Style/SafeNavigationChainLength:
   Description: 'Enforces safe navigation chains length to not exceed the configured maximum.'
   StyleGuide: '#safe-navigation'
   Enabled: pending
-  VersionAdded: '<<next>>'
+  VersionAdded: '1.68'
   Max: 2
 
 Style/Sample:
diff --git a/docs/antora.yml b/docs/antora.yml
@@ -2,6 +2,6 @@ name: rubocop
 title: RuboCop
 # We always provide version without patch here (e.g. 1.1),
 # as patch versions should not appear in the docs.
-version: ~
+version: '1.68'
 nav:
   - modules/ROOT/nav.adoc
diff --git a/docs/modules/ROOT/pages/cops.adoc b/docs/modules/ROOT/pages/cops.adoc
@@ -320,6 +320,7 @@ In the following section you find all available cops:
 * xref:cops_lint.adoc#linttrailingcommainattributedeclaration[Lint/TrailingCommaInAttributeDeclaration]
 * xref:cops_lint.adoc#linttriplequotes[Lint/TripleQuotes]
 * xref:cops_lint.adoc#lintunderscoreprefixedvariablename[Lint/UnderscorePrefixedVariableName]
+* xref:cops_lint.adoc#lintunescapedbracketinregexp[Lint/UnescapedBracketInRegexp]
 * xref:cops_lint.adoc#lintunexpectedblockarity[Lint/UnexpectedBlockArity]
 * xref:cops_lint.adoc#lintunifiedinteger[Lint/UnifiedInteger]
 * xref:cops_lint.adoc#lintunmodifiedreduceaccumulator[Lint/UnmodifiedReduceAccumulator]
@@ -393,6 +394,7 @@ In the following section you find all available cops:
 * xref:cops_style.adoc#styleaccessmodifierdeclarations[Style/AccessModifierDeclarations]
 * xref:cops_style.adoc#styleaccessorgrouping[Style/AccessorGrouping]
 * xref:cops_style.adoc#stylealias[Style/Alias]
+* xref:cops_style.adoc#styleambiguousendlessmethoddefinition[Style/AmbiguousEndlessMethodDefinition]
 * xref:cops_style.adoc#styleandor[Style/AndOr]
 * xref:cops_style.adoc#styleargumentsforwarding[Style/ArgumentsForwarding]
 * xref:cops_style.adoc#stylearraycoercion[Style/ArrayCoercion]
@@ -405,6 +407,7 @@ In the following section you find all available cops:
 * xref:cops_style.adoc#stylebarepercentliterals[Style/BarePercentLiterals]
 * xref:cops_style.adoc#stylebeginblock[Style/BeginBlock]
 * xref:cops_style.adoc#stylebisectedattraccessor[Style/BisectedAttrAccessor]
+* xref:cops_style.adoc#stylebitwisepredicate[Style/BitwisePredicate]
 * xref:cops_style.adoc#styleblockcomments[Style/BlockComments]
 * xref:cops_style.adoc#styleblockdelimiters[Style/BlockDelimiters]
 * xref:cops_style.adoc#stylecaseequality[Style/CaseEquality]
@@ -420,6 +423,7 @@ In the following section you find all available cops:
 * xref:cops_style.adoc#stylecollectionmethods[Style/CollectionMethods]
 * xref:cops_style.adoc#stylecolonmethodcall[Style/ColonMethodCall]
 * xref:cops_style.adoc#stylecolonmethoddefinition[Style/ColonMethodDefinition]
+* xref:cops_style.adoc#stylecombinabledefined[Style/CombinableDefined]
 * xref:cops_style.adoc#stylecombinableloops[Style/CombinableLoops]
 * xref:cops_style.adoc#stylecommandliteral[Style/CommandLiteral]
 * xref:cops_style.adoc#stylecommentannotation[Style/CommentAnnotation]
@@ -492,6 +496,7 @@ In the following section you find all available cops:
 * xref:cops_style.adoc#styleinversemethods[Style/InverseMethods]
 * xref:cops_style.adoc#styleinvertibleunlesscondition[Style/InvertibleUnlessCondition]
 * xref:cops_style.adoc#styleipaddresses[Style/IpAddresses]
+* xref:cops_style.adoc#stylekeywordargumentsmerging[Style/KeywordArgumentsMerging]
 * xref:cops_style.adoc#stylekeywordparametersorder[Style/KeywordParametersOrder]
 * xref:cops_style.adoc#stylelambda[Style/Lambda]
 * xref:cops_style.adoc#stylelambdacall[Style/LambdaCall]
@@ -599,6 +604,7 @@ In the following section you find all available cops:
 * xref:cops_style.adoc#stylereturnnil[Style/ReturnNil]
 * xref:cops_style.adoc#stylereturnnilinpredicatemethoddefinition[Style/ReturnNilInPredicateMethodDefinition]
 * xref:cops_style.adoc#stylesafenavigation[Style/SafeNavigation]
+* xref:cops_style.adoc#stylesafenavigationchainlength[Style/SafeNavigationChainLength]
 * xref:cops_style.adoc#stylesample[Style/Sample]
 * xref:cops_style.adoc#styleselectbyregexp[Style/SelectByRegexp]
 * xref:cops_style.adoc#styleselfassignment[Style/SelfAssignment]
diff --git a/docs/modules/ROOT/pages/cops_layout.adoc b/docs/modules/ROOT/pages/cops_layout.adoc
@@ -4452,6 +4452,33 @@ attr_reader :name #: String
 attr_reader :age  #: Integer?
 ----
 
+[#allowsteepannotation_-false-_default_-layoutleadingcommentspace]
+==== AllowSteepAnnotation: false (default)
+
+[source,ruby]
+----
+# bad
+[1, 2, 3].each_with_object([]) do |n, list| #$ Array[Integer]
+  list << n
+end
+
+name = 'John'      #: String
+----
+
+[#allowsteepannotation_-true-layoutleadingcommentspace]
+==== AllowSteepAnnotation: true
+
+[source,ruby]
+----
+# good
+
+[1, 2, 3].each_with_object([]) do |n, list| #$ Array[Integer]
+  list << n
+end
+
+name = 'John'      #: String
+----
+
 [#configurable-attributes-layoutleadingcommentspace]
 === Configurable attributes
 
@@ -4469,6 +4496,10 @@ attr_reader :age  #: Integer?
 | AllowRBSInlineAnnotation
 | `false`
 | Boolean
+
+| AllowSteepAnnotation
+| `false`
+| Boolean
 |===
 
 [#references-layoutleadingcommentspace]
diff --git a/docs/modules/ROOT/pages/cops_lint.adoc b/docs/modules/ROOT/pages/cops_lint.adoc
@@ -1183,6 +1183,9 @@ the above basic literal values.
 With `IgnoreConstantBranches: true`, branches are not registered
 as offenses if they return a constant value.
 
+With `IgnoreDuplicateElseBranch: true`, in conditionals with multiple branches,
+duplicate 'else' branches are not registered as offenses.
+
 [#examples-lintduplicatebranch]
 === Examples
 
@@ -1266,6 +1269,21 @@ else MEDIUM_SIZE
 end
 ----
 
+[#ignoreduplicateelsebranch_-true-lintduplicatebranch]
+==== IgnoreDuplicateElseBranch: true
+
+[source,ruby]
+----
+# good
+if foo
+  do_foo
+elsif bar
+  do_bar
+else
+  do_foo
+end
+----
+
 [#configurable-attributes-lintduplicatebranch]
 === Configurable attributes
 
@@ -1279,6 +1297,10 @@ end
 | IgnoreConstantBranches
 | `false`
 | Boolean
+
+| IgnoreDuplicateElseBranch
+| `false`
+| Boolean
 |===
 
 [#lintduplicatecasecondition]
@@ -6629,6 +6651,48 @@ end
 | Boolean
 |===
 
+[#lintunescapedbracketinregexp]
+== Lint/UnescapedBracketInRegexp
+
+|===
+| Enabled by default | Safe | Supports autocorrection | Version Added | Version Changed
+
+| Pending
+| Yes
+| Always
+| 1.68
+| -
+|===
+
+Checks for Regexpes (both literals and via `Regexp.new` / `Regexp.compile`)
+that contain unescaped `]` characters.
+
+It emulates the following Ruby warning:
+
+[source,ruby]
+----
+$ ruby -e '/abc]123/'
+-e:1: warning: regular expression has ']' without escape: /abc]123/
+----
+
+[#examples-lintunescapedbracketinregexp]
+=== Examples
+
+[source,ruby]
+----
+# bad
+/abc]123/
+%r{abc]123}
+Regexp.new('abc]123')
+Regexp.compile('abc]123')
+
+# good
+/abc\]123/
+%r{abc\]123}
+Regexp.new('abc\]123')
+Regexp.compile('abc\]123')
+----
+
 [#lintunexpectedblockarity]
 == Lint/UnexpectedBlockArity
 
diff --git a/docs/modules/ROOT/pages/cops_metrics.adoc b/docs/modules/ROOT/pages/cops_metrics.adoc
@@ -394,21 +394,28 @@ operator (or keyword and) can be converted to a nested if statement,
 and ||/or is shorthand for a sequence of ifs, so they also add one.
 Loops can be said to have an exit condition, so they add one.
 Blocks that are calls to builtin iteration methods
-(e.g. `ary.map{...}) also add one, others are ignored.
+(e.g. `ary.map{...}`) also add one, others are ignored.
 
-  def each_child_node(*types)               # count begins: 1
-    unless block_given?                     # unless: +1
-      return to_enum(__method__, *types)
+[#examples-metricscyclomaticcomplexity]
+=== Examples
+
+[source,ruby]
+----
+def each_child_node(*types)               # count begins: 1
+  unless block_given?                     # unless: +1
+    return to_enum(__method__, *types)
+  end
 
-    children.each do |child|                # each{}: +1
-      next unless child.is_a?(Node)         # unless: +1
+  children.each do |child|                # each{}: +1
+    next unless child.is_a?(Node)         # unless: +1
 
-      yield child if types.empty? ||        # if: +1, ||: +1
-                     types.include?(child.type)
-    end
+    yield child if types.empty? ||        # if: +1, ||: +1
+                   types.include?(child.type)
+  end
 
-    self
-  end                                       # total: 6
+  self
+end                                       # total: 6
+----
 
 [#configurable-attributes-metricscyclomaticcomplexity]
 === Configurable attributes
diff --git a/docs/modules/ROOT/pages/cops_style.adoc b/docs/modules/ROOT/pages/cops_style.adoc
diff --git a/docs/modules/ROOT/pages/installation.adoc b/docs/modules/ROOT/pages/installation.adoc
diff --git a/lib/rubocop/version.rb b/lib/rubocop/version.rb
diff --git a/relnotes/v1.68.0.md b/relnotes/v1.68.0.md
