Updated channel and documentation to Rubocop v1.9.1 (#273)

DanielWright · web-flow · commit 8f04181e2431 · 2021-02-05T10:00:14.000-08:00
Bumps the 'rubocop' dependency to v1.9.1, updates the scraped documentation, and fixes the config-upgrader spec by adding the new cops to the config-upgrader fixture.
diff --git a/Gemfile b/Gemfile
@@ -6,7 +6,7 @@ gem "activesupport", require: false
 gem "mry", require: false
 gem "parser"
 gem "pry", require: false
-gem "rubocop", "1.8.1", require: false
+gem "rubocop", "1.9.1", require: false
 gem "rubocop-i18n", require: false
 gem "rubocop-minitest", require: false
 gem "rubocop-performance", require: false
diff --git a/Gemfile.lock b/Gemfile.lock
@@ -7,7 +7,7 @@ GEM
       minitest (~> 5.1)
       tzinfo (~> 1.1)
       zeitwerk (~> 2.2, >= 2.2.2)
-    ast (2.4.1)
+    ast (2.4.2)
     coderay (1.1.3)
     concurrent-ruby (1.1.6)
     diff-lcs (1.4.4)
@@ -41,7 +41,7 @@ GEM
       diff-lcs (>= 1.2.0, < 2.0)
       rspec-support (~> 3.9.0)
     rspec-support (3.9.3)
-    rubocop (1.8.1)
+    rubocop (1.9.1)
       parallel (~> 1.10)
       parser (>= 3.0.0.0)
       rainbow (>= 2.2.2, < 4.0)
@@ -50,7 +50,7 @@ GEM
       rubocop-ast (>= 1.2.0, < 2.0)
       ruby-progressbar (~> 1.7)
       unicode-display_width (>= 1.4.0, < 3.0)
-    rubocop-ast (1.4.0)
+    rubocop-ast (1.4.1)
       parser (>= 2.7.1.5)
     rubocop-i18n (3.0.0)
       rubocop (~> 1.0)
@@ -91,7 +91,7 @@ DEPENDENCIES
   pry
   rake
   rspec
-  rubocop (= 1.8.1)
+  rubocop (= 1.9.1)
   rubocop-i18n
   rubocop-minitest
   rubocop-performance
diff --git a/config/contents/layout/first_argument_indentation.md b/config/contents/layout/first_argument_indentation.md
@@ -1,9 +1,12 @@
 This cop checks the indentation of the first argument in a method call.
-Arguments after the first one are checked by Layout/ArgumentAlignment,
+Arguments after the first one are checked by `Layout/ArgumentAlignment`,
 not by this cop.
 
 For indenting the first parameter of method _definitions_, check out
-Layout/FirstParameterIndentation.
+`Layout/FirstParameterIndentation`.
+
+This cop will respect `Layout/ArgumentAlignment` and will not work when
+`EnforcedStyle: with_fixed_indentation` is specified for `Layout/ArgumentAlignment`.
 
 ### Example:
 
diff --git a/config/contents/lint/number_conversion.md b/config/contents/lint/number_conversion.md
@@ -20,12 +20,18 @@ with `Integer()` and can be ignored with `IgnoredMethods`.
     '10'.to_i
     '10.2'.to_f
     '10'.to_c
+    ['1', '2', '3'].map(&:to_i)
+    foo.try(:to_f)
+    bar.send(:to_c)
 
     # good
 
     Integer('10', 10)
     Float('10.2')
     Complex('10')
+    ['1', '2', '3'].map { |i| Integer(i, 10) }
+    foo.try { |i| Float(i) }
+    bar.send { |i| Complex(i) }
 
 ### Example: IgnoredMethods: [minutes]
 
diff --git a/config/contents/lint/numbered_parameter_assignment.md b/config/contents/lint/numbered_parameter_assignment.md
@@ -0,0 +1,23 @@
+This cop checks for uses of numbered parameter assignment.
+It emulates the following warning in Ruby 2.7:
+
+    % ruby -ve '_1 = :value'
+    ruby 2.7.2p137 (2020-10-01 revision 5445e04352) [x86_64-darwin19]
+    -e:1: warning: `_1' is reserved for numbered parameter; consider another name
+
+Assiging to numbered parameter (from `_1` to `_9`) cause an error in Ruby 3.0.
+
+    % ruby -ve '_1 = :value'
+    ruby 3.0.0p0 (2020-12-25 revision 95aff21468) [x86_64-darwin19]
+    -e:1: _1 is reserved for numbered parameter
+
+NOTE: The parametered parameters are from `_1` to `_9`. This cop checks `_0`, and over `_10`
+as well to prevent confusion.
+
+### Example:
+
+    # bad
+    _1 = :value
+
+    # good
+    non_numbered_parameter_name = :value
diff --git a/config/contents/lint/or_assignment_to_constant.md b/config/contents/lint/or_assignment_to_constant.md
@@ -0,0 +1,16 @@
+This cop checks for unintended or-assignment to a constant.
+
+Constants should always be assigned in the same location. And its value
+should always be the same. If constants are assigned in multiple
+locations, the result may vary depending on the order of `require`.
+
+Also, if you already have such an implementation, auto-correction may
+change the result.
+
+### Example:
+
+    # bad
+    CONST ||= 1
+
+    # good
+    CONST = 1
diff --git a/config/contents/lint/symbol_conversion.md b/config/contents/lint/symbol_conversion.md
@@ -0,0 +1,17 @@
+This cop checks for uses of literal strings converted to
+a symbol where a literal symbol could be used instead.
+
+### Example:
+    # bad
+    'string'.to_sym
+    :symbol.to_sym
+    'underscored_string'.to_sym
+    :'underscored_symbol'
+    'hyphenated-string'.to_sym
+
+    # good
+    :string
+    :symbol
+    :underscored_string
+    :underscored_symbol
+    :'hyphenated-string'
diff --git a/config/contents/lint/triple_quotes.md b/config/contents/lint/triple_quotes.md
@@ -0,0 +1,36 @@
+This cop checks for "triple quotes" (strings delimted by any odd number
+of quotes greater than 1).
+
+Ruby allows multiple strings to be implicitly concatenated by just
+being adjacent in a statement (ie. `"foo""bar" == "foobar"`). This sometimes
+gives the impression that there is something special about triple quotes, but
+in fact it is just extra unnecessary quotes and produces the same string. Each
+pair of quotes produces an additional concatenated empty string, so the result
+is still only the "actual" string within the delimiters.
+
+NOTE: Although this cop is called triple quotes, the same behavior is present
+for strings delimited by 5, 7, etc. quotation marks.
+
+### Example:
+    # bad
+    """
+      A string
+    """
+
+    # bad
+    '''
+      A string
+    '''
+
+    # good
+    "
+      A string
+    "
+
+    # good
+    <<STRING
+      A string
+    STRING
+
+    # good (but not the same spacing as the bad case)
+    'A string'
diff --git a/config/contents/naming/variable_number.md b/config/contents/naming/variable_number.md
@@ -87,6 +87,6 @@ Both are enabled by default.
     # good
     :some_sym_1
 
-### Example: AllowedIdentifier: [capture3]
+### Example: AllowedIdentifiers: [capture3]
     # good
     expect(Open3).to receive(:capture3)
diff --git a/config/contents/style/ascii_comments.md b/config/contents/style/ascii_comments.md
@@ -1,6 +1,6 @@
 This cop checks for non-ascii (non-English) characters
 in comments. You could set an array of allowed non-ascii chars in
-AllowedChars attribute (empty by default).
+`AllowedChars` attribute (copyright notice "©" by default).
 
 ### Example:
     # bad
diff --git a/config/contents/style/disable_cops_within_source_code_directive.md b/config/contents/style/disable_cops_within_source_code_directive.md
@@ -2,13 +2,23 @@ Detects comments to enable/disable RuboCop.
 This is useful if want to make sure that every RuboCop error gets fixed
 and not quickly disabled with a comment.
 
+Specific cops can be allowed with the `AllowedCops` configuration. Note that
+if this configuration is set, `rubocop:disable all` is still disallowed.
+
 ### Example:
     # bad
     # rubocop:disable Metrics/AbcSize
-    def f
+    def foo
     end
     # rubocop:enable Metrics/AbcSize
 
     # good
-    def fixed_method_name_and_no_rubocop_comments
+    def foo
+    end
+
+### Example: AllowedCops: [Metrics/AbcSize]
+    # good
+    # rubocop:disable Metrics/AbcSize
+    def foo
     end
+    # rubocop:enable Metrics/AbcSize
diff --git a/config/contents/style/eval_with_location.md b/config/contents/style/eval_with_location.md
@@ -1,6 +1,11 @@
-This cop checks `eval` method usage. `eval` can receive source location
-metadata, that are filename and line number. The metadata is used by
-backtraces. This cop recommends to pass the metadata to `eval` method.
+This cop ensures that eval methods (`eval`, `instance_eval`, `class_eval`
+and `module_eval`) are given filename and line number values (`__FILE__`
+and `__LINE__`). This data is used to ensure that any errors raised
+within the evaluated code will be given the correct identification
+in a backtrace.
+
+The cop also checks that the line number given relative to `__LINE__` is
+correct.
 
 ### Example:
     # bad
diff --git a/config/contents/style/float_division.md b/config/contents/style/float_division.md
@@ -2,6 +2,9 @@ This cop checks for division with integers coerced to floats.
 It is recommended to either always use `fdiv` or coerce one side only.
 This cop also provides other options for code consistency.
 
+This cop is marked as unsafe, because if operand variable is a string object
+then `.to_f` will be removed and an error will occur.
+
 ### Example: EnforcedStyle: single_coerce (default)
     # bad
     a.to_f / b.to_f
diff --git a/config/contents/style/format_string_token.md b/config/contents/style/format_string_token.md
@@ -6,6 +6,8 @@ which are passed as arguments to those methods:
 The reason is that _unannotated_ format is very similar
 to encoded URLs or Date/Time formatting strings.
 
+This cop can be customized ignored methods with `IgnoredMethods`.
+
 ### Example: EnforcedStyle: annotated (default)
 
     # bad
@@ -52,4 +54,9 @@ if the number of them is less than or equals to
     format('%s %s.', 'Hello', 'world')
 
     # good
-    format('%06d', 10)
+    format('%06d', 10)
+
+### Example: IgnoredMethods: [redirect]
+
+    # good
+    redirect('foo/%{bar_id}')
diff --git a/config/contents/style/if_with_boolean_literal_branches.md b/config/contents/style/if_with_boolean_literal_branches.md
@@ -0,0 +1,23 @@
+This cop checks for redundant `if` with boolean literal branches.
+It checks only conditions to return boolean value (`true` or `false`) for safe detection.
+The conditions to be checked are comparison methods, predicate methods, and double negative.
+However, auto-correction is unsafe because there is no guarantee that all predicate methods
+will return boolean value. Those methods can be allowed with `AllowedMethods` config.
+
+### Example:
+    # bad
+    if foo == bar
+      true
+    else
+      false
+    end
+
+    # bad
+    foo == bar ? true : false
+
+    # good
+    foo == bar
+
+### Example: AllowedMethods: ['nonzero?']
+    # good
+    num.nonzero? ? true : false
diff --git a/config/contents/style/non_nil_check.md b/config/contents/style/non_nil_check.md
@@ -3,6 +3,9 @@ This cop checks for non-nil checks, which are usually redundant.
 With `IncludeSemanticChanges` set to `false` by default, this cop
 does not report offenses for `!x.nil?` and does no changes that might
 change behavior.
+Also `IncludeSemanticChanges` set to `false` with `EnforcedStyle: comparison` of
+`Style/NilComparison` cop, this cop does not report offenses for `x != nil` and
+does no changes to `!x.nil?` style.
 
 With `IncludeSemanticChanges` set to `true`, this cop reports offenses
 for `!x.nil?` and autocorrects that and `x != nil` to solely `x`, which
diff --git a/config/contents/style/numeric_predicate.md b/config/contents/style/numeric_predicate.md
@@ -3,7 +3,7 @@ This cop checks for usage of comparison operators (`==`,
 These can be replaced by their respective predicate methods.
 The cop can also be configured to do the reverse.
 
-The cop disregards `#nonzero?` as it its value is truthy or falsey,
+The cop disregards `#nonzero?` as its value is truthy or falsey,
 but not `true` and `false`, and thus not always interchangeable with
 `!= 0`.
 
diff --git a/config/contents/style/single_line_methods.md b/config/contents/style/single_line_methods.md
@@ -3,7 +3,7 @@ It will accept single-line methods with no body.
 
 Endless methods added in Ruby 3.0 are also accepted by this cop.
 
-If `Style/EndlessMethod` is enabled with `EnforcedStyle: allow` or
+If `Style/EndlessMethod` is enabled with `EnforcedStyle: allow_single_line` or
 `allow_always`, single-line methods will be auto-corrected to endless
 methods if there is only one statement in the body.
 
diff --git a/spec/support/config_upgrader_rubocop.yml b/spec/support/config_upgrader_rubocop.yml
@@ -3,6 +3,18 @@ Style/AccessorMethodName:
 Style/FrozenStringLiteralComment:
   Enabled: false
 
+# 1.9
+Lint/NumberedParameterAssignment: # (new in 1.9)
+  Enabled: true
+Lint/OrAssignmentToConstant: # (new in 1.9)
+  Enabled: true
+Lint/SymbolConversion: # (new in 1.9)
+  Enabled: true
+Lint/TripleQuotes: # (new in 1.9)
+  Enabled: true
+Style/IfWithBooleanLiteralBranches: # (new in 1.9)
+  Enabled: true
+
 # 1.8
 Lint/DeprecatedConstants: # (new in 1.8)
   Enabled: true
