Update rubocop to 1.22.2 (#302)

- Update tests as well.
- Update docs, including formatting for new safety sections.
- Make rubocop pass on docs.rake.

[Fixes #301]

Author: BrianHawley

Gemfile

@@ -6,7 +6,7 @@ gem "activesupport", require: false
 gem "mry", require: false
 gem "parser"
 gem "pry", require: false
-gem "rubocop", "1.20.0", require: false
+gem "rubocop", "1.22.2", require: false
 gem "rubocop-i18n", require: false
 gem "rubocop-graphql", require: false
 gem "rubocop-minitest", require: false

Gemfile.lock

@@ -1,7 +1,7 @@
 GEM
   remote: https://rubygems.org/
   specs:
-    activesupport (6.1.4)
+    activesupport (6.1.4.1)
       concurrent-ruby (~> 1.0, >= 1.0.2)
       i18n (>= 1.6, < 2)
       minitest (>= 5.1)
@@ -17,15 +17,15 @@ GEM
     minitest (5.14.4)
     mry (0.78.0.0)
       rubocop (>= 0.41.0)
-    parallel (1.20.1)
+    parallel (1.21.0)
     parser (3.0.2.0)
       ast (~> 2.4.1)
     pry (0.14.1)
       coderay (~> 1.1)
       method_source (~> 1.0)
     rack (2.2.3)
     rainbow (3.0.0)
-    rake (13.0.4)
+    rake (13.0.6)
     regexp_parser (2.1.1)
     rexml (3.2.5)
     rspec (3.10.0)
@@ -41,48 +41,47 @@ GEM
       diff-lcs (>= 1.2.0, < 2.0)
       rspec-support (~> 3.10.0)
     rspec-support (3.10.2)
-    rubocop (1.20.0)
+    rubocop (1.22.2)
       parallel (~> 1.10)
       parser (>= 3.0.0.0)
       rainbow (>= 2.2.2, < 4.0)
       regexp_parser (>= 1.8, < 3.0)
       rexml
-      rubocop-ast (>= 1.9.1, < 2.0)
+      rubocop-ast (>= 1.12.0, < 2.0)
       ruby-progressbar (~> 1.7)
       unicode-display_width (>= 1.4.0, < 3.0)
-    rubocop-ast (1.11.0)
+    rubocop-ast (1.12.0)
       parser (>= 3.0.1.1)
-    rubocop-graphql (0.9.0)
+    rubocop-graphql (0.10.2)
       rubocop (>= 0.87, < 2)
     rubocop-i18n (3.0.0)
       rubocop (~> 1.0)
-    rubocop-minitest (0.14.0)
+    rubocop-minitest (0.15.2)
       rubocop (>= 0.90, < 2.0)
-    rubocop-performance (1.11.3)
+    rubocop-performance (1.12.0)
       rubocop (>= 1.7.0, < 2.0)
       rubocop-ast (>= 0.4.0)
-    rubocop-rails (2.11.2)
+    rubocop-rails (2.12.4)
       activesupport (>= 4.2.0)
       rack (>= 1.1)
       rubocop (>= 1.7.0, < 2.0)
     rubocop-rake (0.6.0)
       rubocop (~> 1.0)
-    rubocop-rspec (2.4.0)
-      rubocop (~> 1.0)
-      rubocop-ast (>= 1.1.0)
-    rubocop-sequel (0.2.0)
+    rubocop-rspec (2.5.0)
+      rubocop (~> 1.19)
+    rubocop-sequel (0.3.3)
       rubocop (~> 1.0)
     rubocop-sorbet (0.6.2)
       rubocop
-    rubocop-thread_safety (0.4.2)
+    rubocop-thread_safety (0.4.4)
       rubocop (>= 0.53.0)
     ruby-progressbar (1.11.0)
     safe_yaml (1.0.5)
-    test-prof (1.0.6)
+    test-prof (1.0.7)
     tzinfo (2.0.4)
       concurrent-ruby (~> 1.0)
-    unicode-display_width (2.0.0)
-    zeitwerk (2.4.2)
+    unicode-display_width (2.1.0)
+    zeitwerk (2.5.1)
 
 PLATFORMS
   ruby
@@ -94,7 +93,7 @@ DEPENDENCIES
   pry
   rake
   rspec
-  rubocop (= 1.20.0)
+  rubocop (= 1.22.2)
   rubocop-graphql
   rubocop-i18n
   rubocop-minitest

config/contents/bundler/insecure_protocol_source.md

@@ -1,15 +1,18 @@
-The symbol argument `:gemcutter`, `:rubygems`, and `:rubyforge`
-are deprecated. So please change your source to URL string that
-'https://rubygems.org' if possible, or 'http://rubygems.org' if not.
+Passing symbol arguments to `source` (e.g. `source :rubygems`) is
+deprecated because they default to using HTTP requests. Instead, specify
+`'https://rubygems.org'` if possible, or `'http://rubygems.org'` if not.
 
-This autocorrect will replace these symbols with 'https://rubygems.org'.
-Because it is secure, HTTPS request is strongly recommended. And in
-most use cases HTTPS will be fine.
+When autocorrecting, this cop will replace symbol arguments with
+`'https://rubygems.org'`.
 
-However, it don't replace all `sources` of `http://` with `https://`.
-For example, when specifying an internal gem server using HTTP on the
-intranet, a use case where HTTPS cannot be specified was considered.
-Consider using HTTP only if you cannot use HTTPS.
+This cop will not replace existing sources that use `http://`. This may
+be necessary where HTTPS is not available. For example, where using an
+internal gem server via an intranet, or where HTTPS is prohibited.
+However, you should strongly prefer `https://` where possible, as it is
+more secure.
+
+If you don't allow `http://`, please set `false` to `AllowHttpProtocol`.
+This option is `true` by default for safe autocorrection.
 
 ### Example:
     # bad
@@ -19,4 +22,13 @@ Consider using HTTP only if you cannot use HTTPS.
 
     # good
     source 'https://rubygems.org' # strongly recommended
-    source 'http://rubygems.org'
+
+### Example: AllowHttpProtocol: true (default)
+
+    # good
+    source 'http://rubygems.org' # use only if HTTPS is unavailable
+
+### Example: AllowHttpProtocol: false
+
+    # bad
+    source 'http://rubygems.org'

config/contents/gemspec/required_ruby_version.md

@@ -1,7 +1,8 @@
-Checks that `required_ruby_version` of gemspec is specified and
-equal to `TargetRubyVersion` of .rubocop.yml.
-Thereby, RuboCop to perform static analysis working on the version
-required by gemspec.
+Checks that `required_ruby_version` in a gemspec file is set to a valid
+value (non-blank) and matches `TargetRubyVersion` as set in RuboCop's
+configuration for the gem.
+
+This ensures that RuboCop is using the same Ruby version as the gem.
 
 ### Example:
     # When `TargetRubyVersion` of .rubocop.yml is `2.5`.
@@ -21,6 +22,11 @@ required by gemspec.
       spec.required_ruby_version = '>= 2.6.0'
     end
 
+    # bad
+    Gem::Specification.new do |spec|
+      spec.required_ruby_version = ''
+    end
+
     # good
     Gem::Specification.new do |spec|
       spec.required_ruby_version = '>= 2.5.0'
@@ -37,7 +43,7 @@ required by gemspec.
     end
 
     # accepted but not recommended, since
-    # Ruby does not really follow semantic versionning
+    # Ruby does not really follow semantic versioning
     Gem::Specification.new do |spec|
       spec.required_ruby_version = '~> 2.5'
     end

config/contents/layout/class_structure.md

@@ -19,49 +19,47 @@ Consider an example of code style that covers the following order:
 
 You can configure the following order:
 
-[source,yaml]
-----
+```yaml
  Layout/ClassStructure:
-     ExpectedOrder:
-       - module_inclusion
-       - constants
-       - association
-       - public_attribute_macros
-       - public_delegate
-       - macros
-       - public_class_methods
-       - initializer
-       - public_methods
-       - protected_attribute_macros
-       - protected_methods
-       - private_attribute_macros
-       - private_delegate
-       - private_methods
-----
+   ExpectedOrder:
+     - module_inclusion
+     - constants
+     - association
+     - public_attribute_macros
+     - public_delegate
+     - macros
+     - public_class_methods
+     - initializer
+     - public_methods
+     - protected_attribute_macros
+     - protected_methods
+     - private_attribute_macros
+     - private_delegate
+     - private_methods
+```
 
 Instead of putting all literals in the expected order, is also
 possible to group categories of macros. Visibility levels are handled
 automatically.
 
-[source,yaml]
-----
+```yaml
  Layout/ClassStructure:
-     Categories:
-       association:
-         - has_many
-         - has_one
-       attribute_macros:
-         - attr_accessor
-         - attr_reader
-         - attr_writer
-       macros:
-         - validates
-         - validate
-       module_inclusion:
-         - include
-         - prepend
-         - extend
-----
+   Categories:
+     association:
+       - has_many
+       - has_one
+     attribute_macros:
+       - attr_accessor
+       - attr_reader
+       - attr_writer
+     macros:
+       - validates
+       - validate
+     module_inclusion:
+       - include
+       - prepend
+       - extend
+```
 
 ### Example:
     # bad

config/contents/layout/space_inside_parens.md

@@ -27,3 +27,24 @@ Checks for spaces inside ordinary round parentheses.
     f( 3 )
     g = ( a + 3 )
     y()
+
+### Example: EnforcedStyle: compact
+    # The `compact` style enforces that parentheses have a space at the
+    # beginning with the exception that successive parentheses are allowed.
+    # Note: Empty parentheses should not have spaces.
+
+    # bad
+    f(3)
+    g = (a + 3)
+    y( )
+    g( f( x ) )
+    g( f( x( 3 ) ), 5 )
+    g( ( ( 3 + 5 ) * f) ** x, 5 )
+
+    # good
+    f( 3 )
+    g = ( a + 3 )
+    y()
+    g( f( x ))
+    g( f( x( 3 )), 5 )
+    g((( 3 + 5 ) * f ) ** x, 5 )

config/contents/lint/ambiguous_operator_precedence.md

@@ -0,0 +1,24 @@
+This cop looks for expressions containing multiple binary operators
+where precedence is ambiguous due to lack of parentheses. For example,
+in `1 + 2 * 3`, the multiplication will happen before the addition, but
+lexically it appears that the addition will happen first.
+
+The cop does not consider unary operators (ie. `!a` or `-b`) or comparison
+operators (ie. `a =~ b`) because those are not ambiguous.
+
+NOTE: Ranges are handled by `Lint/AmbiguousRange`.
+
+### Example:
+    # bad
+    a + b * c
+    a || b && c
+    a ** b + c
+
+    # good (different precedence)
+    a + (b * c)
+    a || (b && c)
+    (a ** b) + c
+
+    # good (same precedence)
+    a + b + c
+    a * b / c % d

config/contents/lint/ambiguous_range.md

@@ -5,19 +5,21 @@ using a range with other operators. This cop avoids that by making ranges
 explicit by requiring parenthesis around complex range boundaries (anything
 that is not a basic literal: numerics, strings, symbols, etc.).
 
-NOTE: The cop auto-corrects by wrapping the entire boundary in parentheses, which
-makes the outcome more explicit but is possible to not be the intention of the
-programmer. For this reason, this cop's auto-correct is marked as unsafe (it
-will not change the behaviour of the code, but will not necessarily match the
-intent of the program).
-
 This cop can be configured with `RequireParenthesesForMethodChains` in order to
 specify whether method chains (including `self.foo`) should be wrapped in parens
 by this cop.
 
 NOTE: Regardless of this configuration, if a method receiver is a basic literal
 value, it will be wrapped in order to prevent the ambiguity of `1..2.to_a`.
 
+### Safety:
+
+The cop auto-corrects by wrapping the entire boundary in parentheses, which
+makes the outcome more explicit but is possible to not be the intention of the
+programmer. For this reason, this cop's auto-correct is unsafe (it will not
+change the behaviour of the code, but will not necessarily match the
+intent of the program).
+
 ### Example:
     # bad
     x || 1..2
@@ -49,4 +51,4 @@ value, it will be wrapped in order to prevent the ambiguity of `1..2.to_a`.
     a.foo..b.bar
 
     # good
-    (a.foo)..(b.bar)
+    (a.foo)..(b.bar)

config/contents/lint/binary_operator_with_identical_operands.md

@@ -1,14 +1,27 @@
 This cop checks for places where binary operator has identical operands.
 
-It covers arithmetic operators: `+`, `-`, `*`, `/`, `%`, `**`;
+It covers arithmetic operators: `-`, `/`, `%`;
 comparison operators: `==`, `===`, `=~`, `>`, `>=`, `<`, `<=`;
-bitwise operators: `|`, `^`, `&`, `<<`, `>>`;
+bitwise operators: `|`, `^`, `&`;
 boolean operators: `&&`, `||`
 and "spaceship" operator - `<=>`.
 
-This cop is marked as unsafe as it does not consider side effects when calling methods
-and thus can generate false positives:
-    if wr.take_char == '\0' && wr.take_char == '\0'
+Simple arithmetic operations are allowed by this cop: `+`, `*`, `**`, `<<` and `>>`.
+Although these can be rewritten in a different way, it should not be necessary to
+do so. This does not include operations such as `-` or `/` where the result will
+always be the same (`x - x` will always be 0; `x / x` will always be 1), and
+thus are legitimate offenses.
+
+### Safety:
+
+This cop is unsafe as it does not consider side effects when calling methods
+and thus can generate false positives, for example:
+
+```ruby
+if wr.take_char == '\0' && wr.take_char == '\0'
+  # ...
+end
+```
 
 ### Example:
     # bad
@@ -19,7 +32,7 @@ and thus can generate false positives:
       do_something
     end
 
-    def childs?
+    def child?
       left_child || left_child
     end