Add channel/rubocop-1-18-3 (#290)

* Update rubocop to v1.13.0

* Update scraped documentation

* Update rubocop to v1.14.0

* Update scraped documentation

* Update rubocop to v1.15.0

* Update scraped documentation

* Update rubocop to v1.16.0

* Update scraped documentation

* Update spec/support/config_upgrader_rubocop.yml

* Update rubocop to v1.16.1

* Update rubocop to v1.17.0

* Update scraped documentation

* Update rubocop to v1.18.2

* Update scraped documentation

* Update spec/support/config_upgrader_rubocop.yml

* Update rubocop to v1.18.3

* Update scraped documentation

Author: timlkelly

Gemfile

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

Gemfile.lock

@@ -41,13 +41,13 @@ GEM
       diff-lcs (>= 1.2.0, < 2.0)
       rspec-support (~> 3.9.0)
     rspec-support (3.9.3)
-    rubocop (1.12.1)
+    rubocop (1.18.3)
       parallel (~> 1.10)
       parser (>= 3.0.0.0)
       rainbow (>= 2.2.2, < 4.0)
       regexp_parser (>= 1.8, < 3.0)
       rexml
-      rubocop-ast (>= 1.2.0, < 2.0)
+      rubocop-ast (>= 1.7.0, < 2.0)
       ruby-progressbar (~> 1.7)
       unicode-display_width (>= 1.4.0, < 3.0)
     rubocop-ast (1.7.0)
@@ -93,7 +93,7 @@ DEPENDENCIES
   pry
   rake
   rspec
-  rubocop (= 1.12.1)
+  rubocop (= 1.18.3)
   rubocop-graphql
   rubocop-i18n
   rubocop-minitest

config/contents/bundler/gem_comment.md

@@ -1,12 +1,21 @@
-Add a comment describing each gem in your Gemfile.
+Each gem in the Gemfile should have a comment explaining
+its purpose in the project, or the reason for its version
+or source.
 
-Optionally, the "OnlyFor" configuration
+The optional "OnlyFor" configuration array
 can be used to only register offenses when the gems
 use certain options or have version specifiers.
-Add "version_specifiers" and/or the gem option names
-you want to check.
 
-A useful use-case is to enforce a comment when using
+When "version_specifiers" is included, a comment
+will be enforced if the gem has any version specifier.
+
+When "restrictive_version_specifiers" is included, a comment
+will be enforced if the gem has a version specifier that
+holds back the version of the gem.
+
+For any other value in the array, a comment will be enforced for
+a gem if an option by the same name is present.
+A useful use case is to enforce a comment when using
 options that change the source of a gem:
 
 - `bitbucket`
@@ -16,7 +25,8 @@ options that change the source of a gem:
 - `source`
 
 For a full list of options supported by bundler,
-you can check the https://bundler.io/man/gemfile.5.html[official documentation].
+see https://bundler.io/man/gemfile.5.html
+.
 
 ### Example: OnlyFor: [] (default)
     # bad
@@ -38,6 +48,18 @@ you can check the https://bundler.io/man/gemfile.5.html[official documentation].
     # Version 2.1 introduces breaking change baz
     gem 'foo', '< 2.1'
 
+### Example: OnlyFor: ['restrictive_version_specifiers']
+    # bad
+
+    gem 'foo', '< 2.1'
+
+    # good
+
+    gem 'foo', '>= 1.0'
+
+    # Version 2.1 introduces breaking change baz
+    gem 'foo', '< 2.1'
+
 ### Example: OnlyFor: ['version_specifiers', 'github']
     # bad
 

config/contents/bundler/gem_version.md

@@ -0,0 +1,46 @@
+Enforce that Gem version specifications or a commit reference (branch,
+ref, or tag) are either required or forbidden.
+
+### Example: EnforcedStyle: required (default)
+ # bad
+ gem 'rubocop'
+
+ # good
+ gem 'rubocop', '~> 1.12'
+
+ # good
+ gem 'rubocop', '>= 1.10.0'
+
+ # good
+ gem 'rubocop', '>= 1.5.0', '< 1.10.0'
+
+ # good
+ gem 'rubocop', branch: 'feature-branch'
+
+ # good
+ gem 'rubocop', ref: '74b5bfbb2c4b6fd6cdbbc7254bd7084b36e0c85b'
+
+ # good
+ gem 'rubocop', tag: 'v1.17.0'
+
+### Example: EnforcedStyle: forbidden
+ # good
+ gem 'rubocop'
+
+ # bad
+ gem 'rubocop', '~> 1.12'
+
+ # bad
+ gem 'rubocop', '>= 1.10.0'
+
+ # bad
+ gem 'rubocop', '>= 1.5.0', '< 1.10.0'
+
+ # bad
+ gem 'rubocop', branch: 'feature-branch'
+
+ # bad
+ gem 'rubocop', ref: '74b5bfbb2c4b6fd6cdbbc7254bd7084b36e0c85b'
+
+ # bad
+ gem 'rubocop', tag: 'v1.17.0'

config/contents/layout/argument_alignment.md

@@ -5,30 +5,36 @@ definition are aligned.
     # good
 
     foo :bar,
-        :baz
+        :baz,
+        key: value
 
     foo(
       :bar,
-      :baz
+      :baz,
+      key: value
     )
 
     # bad
 
     foo :bar,
-      :baz
+      :baz,
+      key: value
 
     foo(
       :bar,
-        :baz
+        :baz,
+        key: value
     )
 
 ### Example: EnforcedStyle: with_fixed_indentation
     # good
 
     foo :bar,
-      :baz
+      :baz,
+      key: value
 
     # bad
 
     foo :bar,
-        :baz
+        :baz,
+        key: value

config/contents/layout/case_indentation.md

@@ -1,7 +1,7 @@
-This cop checks how the ``when``s of a `case` expression
+This cop checks how the `when` and `in`s of a `case` expression
 are indented in relation to its `case` or `end` keyword.
 
-It will register a separate offense for each misaligned `when`.
+It will register a separate offense for each misaligned `when` and `in`.
 
 ### Example:
     # If Layout/EndAlignment is set to keyword style (default)
@@ -17,6 +17,13 @@ It will register a separate offense for each misaligned `when`.
         y / 3
     end
 
+    case n
+      in pattern
+        x * 2
+      else
+        y / 3
+    end
+
     # good for all styles
     case n
     when 0
@@ -25,6 +32,13 @@ It will register a separate offense for each misaligned `when`.
       y / 3
     end
 
+    case n
+    in pattern
+      x * 2
+    else
+      y / 3
+    end
+
 ### Example: EnforcedStyle: case (default)
     # if EndAlignment is set to other style such as
     # start_of_line (as shown below), then *when* alignment
@@ -38,6 +52,13 @@ It will register a separate offense for each misaligned `when`.
       y / 3
     end
 
+    a = case n
+    in pattern
+      x * 2
+    else
+      y / 3
+    end
+
     # good
     a = case n
         when 0
@@ -46,6 +67,13 @@ It will register a separate offense for each misaligned `when`.
           y / 3
     end
 
+    a = case n
+        in pattern
+          x * 2
+        else
+          y / 3
+    end
+
 ### Example: EnforcedStyle: end
     # bad
     a = case n
@@ -55,10 +83,24 @@ It will register a separate offense for each misaligned `when`.
           y / 3
     end
 
+    a = case n
+        in pattern
+          x * 2
+        else
+          y / 3
+    end
+
     # good
     a = case n
     when 0
       x * 2
     else
       y / 3
+    end
+
+    a = case n
+    in pattern
+      x * 2
+    else
+      y / 3
     end

config/contents/layout/line_end_string_concatenation_indentation.md

@@ -0,0 +1,53 @@
+This cop checks the indentation of the next line after a line that ends with a string
+literal and a backslash.
+
+If `EnforcedStyle: aligned` is set, the concatenated string parts shall be aligned with the
+first part. There are some exceptions, such as implicit return values, where the
+concatenated string parts shall be indented regardless of `EnforcedStyle` configuration.
+
+If `EnforcedStyle: indented` is set, it's the second line that shall be indented one step
+more than the first line. Lines 3 and forward shall be aligned with line 2. Here too there
+are exceptions. Values in a hash literal are always aligned.
+
+### Example:
+    # bad
+    def some_method
+      'x' \
+      'y' \
+      'z'
+    end
+
+    my_hash = {
+      first: 'a message' \
+        'in two parts'
+    }
+
+    # good
+    def some_method
+      'x' \
+        'y' \
+        'z'
+    end
+
+    my_hash = {
+      first: 'a message' \
+             'in two parts'
+    }
+
+### Example: EnforcedStyle: aligned (default)
+    # bad
+    puts 'x' \
+      'y'
+
+    # good
+    puts 'x' \
+         'y'
+
+### Example: EnforcedStyle: indented
+    # bad
+    result = 'x' \
+             'y'
+
+    # good
+    result = 'x' \
+      'y'

config/contents/layout/redundant_line_break.md

@@ -0,0 +1,38 @@
+This cop checks whether certain expressions, e.g. method calls, that could fit
+completely on a single line, are broken up into multiple lines unnecessarily.
+
+### Example: any configuration
+    # bad
+    foo(
+      a,
+      b
+    )
+
+    puts 'string that fits on ' \
+         'a single line'
+
+    things
+      .select { |thing| thing.cond? }
+      .join('-')
+
+    # good
+    foo(a, b)
+
+    puts 'string that fits on a single line'
+
+    things.select { |thing| thing.cond? }.join('-')
+
+### Example: InspectBlocks: false (default)
+    # good
+    foo(a) do |x|
+      puts x
+    end
+
+### Example: InspectBlocks: true
+    # bad
+    foo(a) do |x|
+      puts x
+    end
+
+    # good
+    foo(a) { |x| puts x }

config/contents/layout/single_line_block_chain.md

@@ -0,0 +1,15 @@
+This cop checks if method calls are chained onto single line blocks. It considers that a
+line break before the dot improves the readability of the code.
+
+### Example:
+    # bad
+    example.select { |item| item.cond? }.join('-')
+
+    # good
+    example.select { |item| item.cond? }
+           .join('-')
+
+    # good (not a concern for this cop)
+    example.select do |item|
+      item.cond?
+    end.join('-')