Updated channel and documentation to Rubocop v0.90.0 (#256)

DanielWright · web-flow · commit cdf2b9cbdc06 · 2020-09-10T09:54:32.000-03:00
* Bumps 'rubocop' Dependency to 0.90.0

* Updates Scraped Documentation

* Fixes Broken ConfigUpgrader Spec

* Fixes Broken CC::Engine::Rubocop Spec

Look upon my metaprogramming, ye mighty, and despair.
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", "0.89.1", require: false
+gem "rubocop", "0.90.0", require: false
 gem "rubocop-i18n", require: false
 gem "rubocop-migrations", require: false
 gem "rubocop-minitest", require: false
diff --git a/Gemfile.lock b/Gemfile.lock
@@ -41,7 +41,7 @@ GEM
       diff-lcs (>= 1.2.0, < 2.0)
       rspec-support (~> 3.9.0)
     rspec-support (3.9.3)
-    rubocop (0.89.1)
+    rubocop (0.90.0)
       parallel (~> 1.10)
       parser (>= 2.7.1.1)
       rainbow (>= 2.2.2, < 4.0)
@@ -91,7 +91,7 @@ DEPENDENCIES
   pry
   rake
   rspec
-  rubocop (= 0.89.1)
+  rubocop (= 0.90.0)
   rubocop-i18n
   rubocop-migrations
   rubocop-minitest
diff --git a/config/contents/layout/empty_line_after_multiline_condition.md b/config/contents/layout/empty_line_after_multiline_condition.md
@@ -0,0 +1,47 @@
+This cop enforces empty line after multiline condition.
+
+### Example:
+    # bad
+    if multiline &&
+      condition
+      do_something
+    end
+
+    # good
+    if multiline &&
+      condition
+
+      do_something
+    end
+
+    # bad
+    case x
+    when foo,
+      bar
+      do_something
+    end
+
+    # good
+    case x
+    when foo,
+      bar
+
+      do_something
+    end
+
+    # bad
+    begin
+      do_something
+    rescue FooError,
+      BarError
+      handle_error
+    end
+
+    # good
+    begin
+      do_something
+    rescue FooError,
+      BarError
+
+      handle_error
+    end
diff --git a/config/contents/layout/heredoc_indentation.md b/config/contents/layout/heredoc_indentation.md
@@ -15,4 +15,3 @@ Note: When ``Layout/LineLength``'s `AllowHeredoc` is false (not default),
     <<~RUBY
       something
     RUBY
-
diff --git a/config/contents/layout/space_before_comma.md b/config/contents/layout/space_before_comma.md
@@ -9,4 +9,4 @@ Checks for comma (,) preceded by space.
     # good
     [1, 2, 3]
     a(1, 2)
-    each { |a, b| }
+    each { |a, b| }
diff --git a/config/contents/lint/duplicate_require.md b/config/contents/lint/duplicate_require.md
@@ -0,0 +1,11 @@
+This cop checks for duplicate `require`s and `require_relative`s.
+
+### Example:
+    # bad
+    require 'foo'
+    require 'bar'
+    require 'foo'
+
+    # good
+    require 'foo'
+    require 'bar'
diff --git a/config/contents/lint/empty_file.md b/config/contents/lint/empty_file.md
@@ -0,0 +1,16 @@
+This cop enforces that Ruby source files are not empty.
+
+### Example:
+    # bad
+    # Empty file
+
+    # good
+    # File containing non commented source lines
+
+### Example: AllowComments: true (default)
+    # good
+    # File consisting only of comments
+
+### Example: AllowComments: false
+    # bad
+    # File consisting only of comments
diff --git a/config/contents/lint/shadowing_outer_local_variable.md b/config/contents/lint/shadowing_outer_local_variable.md
@@ -1,7 +1,7 @@
-This cop looks for use of the same name as outer local variables
-for block arguments or block local variables.
-This is a mimic of the warning
-"shadowing outer local variable - foo" from `ruby -cw`.
+This cop checks for the use of local variable names from an outer scope
+in block arguments or block-local variables. This mirrors the warning
+given by `ruby -cw` prior to Ruby 2.6:
+"shadowing outer local variable - foo".
 
 ### Example:
 
diff --git a/config/contents/lint/trailing_comma_in_attribute_declaration.md b/config/contents/lint/trailing_comma_in_attribute_declaration.md
@@ -0,0 +1,23 @@
+This cop checks for trailing commas in attribute declarations, such as
+`#attr_reader`. Leaving a trailing comma will nullify the next method
+definition by overriding it with a getter method.
+
+### Example:
+
+    # bad
+    class Foo
+      attr_reader :foo,
+
+      def bar
+        puts "Unreachable."
+      end
+    end
+
+    # good
+    class Foo
+      attr_reader :foo
+
+      def bar
+        puts "No problem!"
+      end
+    end
diff --git a/config/contents/lint/useless_method_definition.md b/config/contents/lint/useless_method_definition.md
@@ -0,0 +1,36 @@
+This cop checks for useless method definitions, specifically: empty constructors
+and methods just delegating to `super`.
+
+This cop is marked as unsafe as it can trigger false positives for cases when
+an empty constructor just overrides the parent constructor, which is bad anyway.
+
+### Example:
+    # bad
+    def initialize
+    end
+
+    def method
+      super
+    end
+
+    # good
+    def initialize
+      initialize_internals
+    end
+
+    def method
+      super
+      do_something_else
+    end
+
+### Example: AllowComments: true (default)
+    # good
+    def initialize
+      # Comment.
+    end
+
+### Example: AllowComments: false
+    # bad
+    def initialize
+      # Comment.
+    end
diff --git a/config/contents/style/case_equality.md b/config/contents/style/case_equality.md
@@ -9,7 +9,7 @@ This cop checks for uses of the case equality operator(===).
     # good
     something.is_a?(Array)
     (1..100).include?(7)
-    some_string =~ /something/
+    /something/.match?(some_string)
 
 ### Example: AllowOnConstant
     # Style/CaseEquality:
@@ -22,4 +22,4 @@ This cop checks for uses of the case equality operator(===).
     # good
     Array === something
     (1..100).include?(7)
-    some_string =~ /something/
+    /something/.match?(some_string)
diff --git a/config/contents/style/class_methods_definitions.md b/config/contents/style/class_methods_definitions.md
@@ -0,0 +1,54 @@
+This cop enforces using `def self.method_name` or `class << self` to define class methods.
+
+### Example: EnforcedStyle: def_self (default)
+    # bad
+    class SomeClass
+      class << self
+        attr_accessor :class_accessor
+
+        def class_method
+          # ...
+        end
+      end
+    end
+
+    # good
+    class SomeClass
+      def self.class_method
+        # ...
+      end
+
+      class << self
+        attr_accessor :class_accessor
+      end
+    end
+
+    # good - contains private method
+    class SomeClass
+      class << self
+        attr_accessor :class_accessor
+
+        private
+
+        def private_class_method
+          # ...
+        end
+      end
+    end
+
+### Example: EnforcedStyle: self_class
+    # bad
+    class SomeClass
+      def self.class_method
+        # ...
+      end
+    end
+
+    # good
+    class SomeClass
+      class << self
+        def class_method
+          # ...
+        end
+      end
+    end
diff --git a/config/contents/style/combinable_loops.md b/config/contents/style/combinable_loops.md
@@ -0,0 +1,45 @@
+This cop checks for places where multiple consecutive loops over the same data
+can be combined into a single loop. It is very likely that combining them
+will make the code more efficient and more concise.
+
+It is marked as unsafe, because the first loop might modify
+a state that the second loop depends on; these two aren't combinable.
+
+### Example:
+    # bad
+    def method
+      items.each do |item|
+        do_something(item)
+      end
+
+      items.each do |item|
+        do_something_else(item)
+      end
+    end
+
+    # good
+    def method
+      items.each do |item|
+        do_something(item)
+        do_something_else(item)
+      end
+    end
+
+    # bad
+    def method
+      for item in items do
+        do_something(item)
+      end
+
+      for item in items do
+        do_something_else(item)
+      end
+    end
+
+    # good
+    def method
+      for item in items do
+        do_something(item)
+        do_something_else(item)
+      end
+    end
diff --git a/config/contents/style/guard_clause.md b/config/contents/style/guard_clause.md
@@ -12,6 +12,7 @@ expression
     # good
     def test
       return unless something
+
       work
     end
 
diff --git a/config/contents/style/hash_transform_keys.md b/config/contents/style/hash_transform_keys.md
@@ -13,7 +13,9 @@ This cop should only be enabled on Ruby version 2.5 or newer
 ### Example:
     # bad
     {a: 1, b: 2}.each_with_object({}) { |(k, v), h| h[foo(k)] = v }
-    {a: 1, b: 2}.map { |k, v| [k.to_s, v] }
+    Hash[{a: 1, b: 2}.collect { |k, v| [foo(k), v] }]
+    {a: 1, b: 2}.map { |k, v| [k.to_s, v] }.to_h
+    {a: 1, b: 2}.to_h { |k, v| [k.to_s, v] }
 
     # good
     {a: 1, b: 2}.transform_keys { |k| foo(k) }
diff --git a/config/contents/style/hash_transform_values.md b/config/contents/style/hash_transform_values.md
@@ -13,7 +13,9 @@ This cop should only be enabled on Ruby version 2.4 or newer
 ### Example:
     # bad
     {a: 1, b: 2}.each_with_object({}) { |(k, v), h| h[k] = foo(v) }
-    {a: 1, b: 2}.map { |k, v| [k, v * v] }
+    Hash[{a: 1, b: 2}.collect { |k, v| [k, foo(v)] }]
+    {a: 1, b: 2}.map { |k, v| [k, v * v] }.to_h
+    {a: 1, b: 2}.to_h { |k, v| [k, v * v] }
 
     # good
     {a: 1, b: 2}.transform_values { |v| foo(v) }
diff --git a/config/contents/style/keyword_parameters_order.md b/config/contents/style/keyword_parameters_order.md
@@ -0,0 +1,17 @@
+This cop enforces that optional keyword parameters are placed at the
+end of the parameters list.
+
+This improves readability, because when looking through the source,
+it is expected to find required parameters at the beginning of parameters list
+and optional parameters at the end.
+
+### Example:
+    # bad
+    def some_method(first: false, second:, third: 10)
+      # body omitted
+    end
+
+    # good
+    def some_method(second:, first: false, third: 10)
+      # body omitted
+    end
diff --git a/config/contents/style/method_called_on_do_end_block.md b/config/contents/style/method_called_on_do_end_block.md
@@ -3,7 +3,16 @@ this check is that it's easy to miss the call tacked on to the block
 when reading code.
 
 ### Example:
-
+    # bad
     a do
       b
-    end.c
+    end.c
+
+    # good
+    a { b }.c
+
+    # good
+    foo = a do
+      b
+    end
+    foo.c
diff --git a/config/contents/style/one_line_conditional.md b/config/contents/style/one_line_conditional.md
diff --git a/config/contents/style/redundant_self_assignment.md b/config/contents/style/redundant_self_assignment.md
diff --git a/config/contents/style/sole_nested_conditional.md b/config/contents/style/sole_nested_conditional.md
diff --git a/spec/cc/engine/rubocop_spec.rb b/spec/cc/engine/rubocop_spec.rb
diff --git a/spec/support/config_upgrader_rubocop.yml b/spec/support/config_upgrader_rubocop.yml

-Original file line number
+Diff line change
     <<~RUBY
       something
     RUBY
+-