Update rubocop to 1.29.0 (#314)

BrianHawley · web-flow · commit 56d7d82e04d6 · 2022-05-09T14:13:45.000-03:00
- General bundle update.
- Update the docs too.
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.28.1", require: false
+gem "rubocop", "1.29.0", require: false
 gem "rubocop-i18n", require: false
 gem "rubocop-graphql", require: false
 gem "rubocop-minitest", require: false
diff --git a/Gemfile.lock b/Gemfile.lock
@@ -1,7 +1,7 @@
 GEM
   remote: https://rubygems.org/
   specs:
-    activesupport (7.0.2.3)
+    activesupport (7.0.3)
       concurrent-ruby (~> 1.0, >= 1.0.2)
       i18n (>= 1.6, < 2)
       minitest (>= 5.1)
@@ -25,7 +25,7 @@ GEM
     rack (2.2.3)
     rainbow (3.1.1)
     rake (13.0.6)
-    regexp_parser (2.3.0)
+    regexp_parser (2.3.1)
     rexml (3.2.5)
     rspec (3.11.0)
       rspec-core (~> 3.11.0)
@@ -40,12 +40,12 @@ GEM
       diff-lcs (>= 1.2.0, < 2.0)
       rspec-support (~> 3.11.0)
     rspec-support (3.11.0)
-    rubocop (1.28.1)
+    rubocop (1.29.0)
       parallel (~> 1.10)
       parser (>= 3.1.0.0)
       rainbow (>= 2.2.2, < 4.0)
       regexp_parser (>= 1.8, < 3.0)
-      rexml
+      rexml (>= 3.2.5, < 4.0)
       rubocop-ast (>= 1.17.0, < 2.0)
       ruby-progressbar (~> 1.7)
       unicode-display_width (>= 1.4.0, < 3.0)
@@ -72,13 +72,13 @@ GEM
       rubocop (~> 1.0)
     rubocop-shopify (2.5.0)
       rubocop (~> 1.25)
-    rubocop-sorbet (0.6.7)
+    rubocop-sorbet (0.6.8)
       rubocop (>= 0.90.0)
     rubocop-thread_safety (0.4.4)
       rubocop (>= 0.53.0)
     ruby-progressbar (1.11.0)
     safe_yaml (1.0.5)
-    test-prof (1.0.8)
+    test-prof (1.0.9)
     tzinfo (2.0.4)
       concurrent-ruby (~> 1.0)
     unicode-display_width (2.1.0)
@@ -93,7 +93,7 @@ DEPENDENCIES
   pry
   rake
   rspec
-  rubocop (= 1.28.1)
+  rubocop (= 1.29.0)
   rubocop-graphql
   rubocop-i18n
   rubocop-minitest
diff --git a/config/contents/gemspec/dependency_version.md b/config/contents/gemspec/dependency_version.md
@@ -0,0 +1,46 @@
+Enforce that gem dependency version specifications or a commit reference (branch,
+ref, or tag) are either required or forbidden.
+
+### Example: EnforcedStyle: required (default)
+
+    # bad
+    Gem::Specification.new do |spec|
+      spec.add_dependency 'parser'
+    end
+
+    # bad
+    Gem::Specification.new do |spec|
+      spec.add_development_dependency 'parser'
+    end
+
+    # good
+    Gem::Specification.new do |spec|
+      spec.add_dependency 'parser', '>= 2.3.3.1', '< 3.0'
+    end
+
+    # good
+    Gem::Specification.new do |spec|
+      spec.add_development_dependency 'parser', '>= 2.3.3.1', '< 3.0'
+    end
+
+### Example: EnforcedStyle: forbidden
+
+    # bad
+    Gem::Specification.new do |spec|
+      spec.add_dependency 'parser', '>= 2.3.3.1', '< 3.0'
+    end
+
+    # bad
+    Gem::Specification.new do |spec|
+      spec.add_development_dependency 'parser', '>= 2.3.3.1', '< 3.0'
+    end
+
+    # good
+    Gem::Specification.new do |spec|
+      spec.add_dependency 'parser'
+    end
+
+    # good
+    Gem::Specification.new do |spec|
+      spec.add_development_dependency 'parser'
+    end
diff --git a/config/contents/gemspec/ruby_version_globals_usage.md b/config/contents/gemspec/ruby_version_globals_usage.md
@@ -8,7 +8,7 @@ to execute `rake release` and not user's ruby version.
 
     # bad
     Gem::Specification.new do |spec|
-      if RUBY_VERSION >= '2.5'
+      if RUBY_VERSION >= '3.0'
         spec.add_runtime_dependency 'gem_a'
       else
         spec.add_runtime_dependency 'gem_b'
diff --git a/config/contents/lint/ambiguous_range.md b/config/contents/lint/ambiguous_range.md
@@ -1,6 +1,6 @@
 This cop checks for ambiguous ranges.
 
-Ranges have quite low precedence, which leads to unexpected behaviour when
+Ranges have quite low precedence, which leads to unexpected behavior when
 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 literal: numerics, strings, symbols, etc.).
@@ -17,7 +17,7 @@ value, it will be wrapped in order to prevent the ambiguity of `1..2.to_a`.
 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
+change the behavior of the code, but will not necessarily match the
 intent of the program).
 
 ### Example:
diff --git a/config/contents/lint/loop.md b/config/contents/lint/loop.md
@@ -2,7 +2,7 @@ This cop checks for uses of `begin...end while/until something`.
 
 ### Safety:
 
-The cop is unsafe because behaviour can change in some cases, including
+The cop is unsafe because behavior can change in some cases, including
 if a local variable inside the loop body is accessed outside of it, or if the
 loop body raises a `StopIteration` exception (which `Kernel#loop` rescues).
 
diff --git a/config/contents/lint/non_deterministic_require_order.md b/config/contents/lint/non_deterministic_require_order.md
@@ -14,7 +14,7 @@ NOTE: This cop will be deprecated and removed when supporting only Ruby 3.0 and
 ### Safety:
 
 This cop is unsafe in the case where sorting files changes existing
-expected behaviour.
+expected behavior.
 
 ### Example:
 
diff --git a/config/contents/lint/or_assignment_to_constant.md b/config/contents/lint/or_assignment_to_constant.md
@@ -7,7 +7,7 @@ locations, the result may vary depending on the order of `require`.
 ### Safety:
 
 This cop is unsafe because code that is already conditionally
-assigning a constant may have its behaviour changed by
+assigning a constant may have its behavior changed by
 auto-correction.
 
 ### Example:
diff --git a/config/contents/lint/raise_exception.md b/config/contents/lint/raise_exception.md
@@ -11,7 +11,7 @@ name with an explicit namespace.
 ### Safety:
 
 This cop is unsafe because it will change the exception class being
-raised, which is a change in behaviour.
+raised, which is a change in behavior.
 
 ### Example:
     # bad
diff --git a/config/contents/naming/variable_name.md b/config/contents/naming/variable_name.md
@@ -13,4 +13,8 @@ snake_case or camelCase, for their names.
     foo_bar = 1
 
     # good
-    fooBar = 1
+    fooBar = 1
+
+### Example: AllowedPatterns: ['_v\d+\z']
+    # good
+    :release_v1
diff --git a/config/contents/naming/variable_number.md b/config/contents/naming/variable_number.md
@@ -90,3 +90,7 @@ Both are enabled by default.
 ### Example: AllowedIdentifiers: [capture3]
     # good
     expect(Open3).to receive(:capture3)
+
+### Example: AllowedPatterns: ['_v\d+\z']
+    # good
+    :some_sym_v1
diff --git a/config/contents/security/yaml_load.md b/config/contents/security/yaml_load.md
@@ -6,7 +6,7 @@ NOTE: Ruby 3.1+ (Psych 4) uses `Psych.load` as `Psych.safe_load` by default.
 
 ### Safety:
 
-The behaviour of the code might change depending on what was
+The behavior of the code might change depending on what was
 in the YAML payload, since `YAML.safe_load` is more restrictive.
 
 ### Example:
diff --git a/config/contents/style/and_or.md b/config/contents/style/and_or.md
@@ -6,7 +6,7 @@ all contexts.
 
 Auto-correction is unsafe because there is a different operator precedence
 between logical operators (`&&` and `||`) and semantic operators (`and` and `or`),
-and that might change the behaviour.
+and that might change the behavior.
 
 ### Example: EnforcedStyle: always
     # bad
diff --git a/config/contents/style/case_like_if.md b/config/contents/style/case_like_if.md
@@ -5,7 +5,7 @@ can be replaced with `case-when`.
 
 This cop is unsafe. `case` statements use `===` for equality,
 so if the original conditional used a different equality operator, the
-behaviour may be different.
+behavior may be different.
 
 ### Example:
     # bad
diff --git a/config/contents/style/date_time.md b/config/contents/style/date_time.md
@@ -7,7 +7,7 @@ and/or DST.
 ### Safety:
 
 Autocorrection is not safe, because `DateTime` and `Time` do not have
-exactly the same behaviour, although in most cases the autocorrection
+exactly the same behavior, although in most cases the autocorrection
 will be fine.
 
 ### Example:
diff --git a/config/contents/style/double_negation.md b/config/contents/style/double_negation.md
@@ -32,8 +32,24 @@ of the expression will change.
       !!return_value
     end
 
+    define_method :foo? do
+      !!return_value
+    end
+
+    define_singleton_method :foo? do
+      !!return_value
+    end
+
 ### Example: EnforcedStyle: forbidden
     # bad
     def foo?
       !!return_value
+    end
+
+    define_method :foo? do
+      !!return_value
+    end
+
+    define_singleton_method :foo? do
+      !!return_value
     end
diff --git a/config/contents/style/env_home.md b/config/contents/style/env_home.md
@@ -0,0 +1,24 @@
+This cop checks for consistent usage of `ENV['HOME']`. If `nil` is used as
+the second argument of `ENV.fetch`, it is treated as a bad case like `ENV[]`.
+
+### Safety:
+
+The cop is unsafe because the result when `nil` is assigned to `ENV['HOME']` changes:
+
+```ruby
+ENV['HOME'] = nil
+ENV['HOME'] # => nil
+Dir.home    # => '/home/foo'
+```
+
+### Example:
+
+    # bad
+    ENV['HOME']
+    ENV.fetch('HOME', nil)
+
+    # good
+    Dir.home
+
+    # good
+    ENV.fetch('HOME', default)
diff --git a/config/contents/style/fetch_env_var.md b/config/contents/style/fetch_env_var.md
@@ -4,17 +4,32 @@ which may cause unexpected behaviors when the developer forgets to set it.
 On the other hand, `ENV.fetch` raises KeyError or returns the explicitly
 specified default value.
 
+When an `ENV[]` is the LHS of `||`, the autocorrect makes the RHS
+the default value of `ENV.fetch`.
+
 ### Example:
     # bad
     ENV['X']
-    ENV['X'] || z
+    ENV['X'] || 'string literal'
+    ENV['X'] || some_method
     x = ENV['X']
 
+    ENV['X'] || y.map do |a|
+      puts a * 2
+    end
+
     # good
     ENV.fetch('X')
-    ENV.fetch('X', nil) || z
+    ENV.fetch('X', 'string literal')
+    ENV.fetch('X') { some_method }
     x = ENV.fetch('X')
 
+    ENV.fetch('X') do
+      y.map do |a|
+        puts a * 2
+      end
+    end
+
     # also good
     !ENV['X']
     ENV['X'].some_method # (e.g. `.nil?`)
diff --git a/config/contents/style/identical_conditional_branches.md b/config/contents/style/identical_conditional_branches.md
@@ -9,7 +9,7 @@ in a future major RuboCop release.
 ### Safety:
 
 Auto-correction is unsafe because changing the order of method invocations
-may change the behaviour of the code. For example:
+may change the behavior of the code. For example:
 
 ```ruby
 if method_that_modifies_global_state # 1
@@ -22,7 +22,7 @@ end
 ```
 
 In this example, `method_that_relies_on_global_state` will be moved before
-`method_that_modifies_global_state`, which changes the behaviour of the program.
+`method_that_modifies_global_state`, which changes the behavior of the program.
 
 ### Example:
     # bad
diff --git a/config/contents/style/optional_arguments.md b/config/contents/style/optional_arguments.md
@@ -4,7 +4,7 @@ that do not come at the end of the argument list.
 ### Safety:
 
 This cop is unsafe because changing a method signature will
-implicitly change behaviour.
+implicitly change behavior.
 
 ### Example:
     # bad
diff --git a/config/contents/style/optional_boolean_parameter.md b/config/contents/style/optional_boolean_parameter.md
@@ -5,7 +5,7 @@ These are customizable with `AllowedMethods` option.
 ### Safety:
 
 This cop is unsafe because changing a method signature will
-implicitly change behaviour.
+implicitly change behavior.
 
 ### Example:
     # bad
diff --git a/config/contents/style/safe_navigation.md b/config/contents/style/safe_navigation.md
@@ -19,7 +19,7 @@ that exceed this option is set.
 ### Safety:
 
 Autocorrection is unsafe because if a value is `false`, the resulting
-code will have different behaviour or raise an error.
+code will have different behavior or raise an error.
 
 ```ruby
 x = false
diff --git a/config/contents/style/string_chars.md b/config/contents/style/string_chars.md
@@ -4,7 +4,7 @@ Checks for uses of `String#split` with empty string or regexp literal argument.
 
 This cop is unsafe because it cannot be guaranteed that the receiver
 is actually a string. If another class has a `split` method with
-different behaviour, it would be registered as a false positive.
+different behavior, it would be registered as a false positive.
 
 ### Example:
     # bad
diff --git a/spec/support/config_upgrader_rubocop.yml b/spec/support/config_upgrader_rubocop.yml
@@ -3,12 +3,16 @@ Style/AccessorMethodName:
 Style/FrozenStringLiteralComment:
   Enabled: false
 
+# 1.29
+Style/EnvHome:
+  Enabled: true
+
 # 1.28
 Security/CompoundHash:
   Enabled: true
 Style/FetchEnvVar:
   Enabled: true
-Style/ObjectThen: # new in 1.28
+Style/ObjectThen:
   Enabled: true
 
 # 1.27
