Rubocop 0.51.0

* Updated docs
* Added more docs

Author: pointlessone

Gemfile

@@ -5,7 +5,7 @@ source 'https://rubygems.org'
 gem "activesupport", require: false
 gem "parser", "~> 2.4.0"
 gem "pry", require: false
-gem "rubocop", "~> 0.50.0", require: false
+gem "rubocop", "~> 0.51.0", require: false
 gem "rubocop-migrations", require: false
 gem "rubocop-rspec", require: false
 gem "safe_yaml"

Gemfile.lock

@@ -10,33 +10,34 @@ GEM
     coderay (1.1.2)
     concurrent-ruby (1.0.5)
     diff-lcs (1.3)
-    i18n (0.8.6)
+    i18n (0.9.0)
+      concurrent-ruby (~> 1.0)
     method_source (0.9.0)
     minitest (5.10.3)
     parallel (1.12.0)
     parser (2.4.0.0)
       ast (~> 2.2)
     powerpack (0.1.1)
-    pry (0.11.1)
+    pry (0.11.2)
       coderay (~> 1.1.0)
       method_source (~> 0.9.0)
     rainbow (2.2.2)
       rake
     rake (12.1.0)
-    rspec (3.6.0)
-      rspec-core (~> 3.6.0)
-      rspec-expectations (~> 3.6.0)
-      rspec-mocks (~> 3.6.0)
-    rspec-core (3.6.0)
-      rspec-support (~> 3.6.0)
-    rspec-expectations (3.6.0)
+    rspec (3.7.0)
+      rspec-core (~> 3.7.0)
+      rspec-expectations (~> 3.7.0)
+      rspec-mocks (~> 3.7.0)
+    rspec-core (3.7.0)
+      rspec-support (~> 3.7.0)
+    rspec-expectations (3.7.0)
       diff-lcs (>= 1.2.0, < 2.0)
-      rspec-support (~> 3.6.0)
-    rspec-mocks (3.6.0)
+      rspec-support (~> 3.7.0)
+    rspec-mocks (3.7.0)
       diff-lcs (>= 1.2.0, < 2.0)
-      rspec-support (~> 3.6.0)
-    rspec-support (3.6.0)
-    rubocop (0.50.0)
+      rspec-support (~> 3.7.0)
+    rspec-support (3.7.0)
+    rubocop (0.51.0)
       parallel (~> 1.10)
       parser (>= 2.3.3.1, < 3.0)
       powerpack (~> 0.1)
@@ -45,8 +46,8 @@ GEM
       unicode-display_width (~> 1.0, >= 1.0.1)
     rubocop-migrations (0.1.2)
       rubocop (~> 0.41)
-    rubocop-rspec (1.18.0)
-      rubocop (>= 0.50.0)
+    rubocop-rspec (1.19.0)
+      rubocop (>= 0.51.0)
     ruby-progressbar (1.9.0)
     safe_yaml (1.0.4)
     thread_safe (0.3.6)
@@ -63,7 +64,7 @@ DEPENDENCIES
   pry
   rake
   rspec
-  rubocop (~> 0.50.0)
+  rubocop (~> 0.51.0)
   rubocop-migrations
   rubocop-rspec
   safe_yaml

config/contents/gemspec/ordered_dependencies.md

@@ -0,0 +1,47 @@
+Dependencies in the gemspec should be alphabetically sorted.
+
+### Example:
+    # bad
+    spec.add_dependency 'rubocop'
+    spec.add_dependency 'rspec'
+
+    # good
+    spec.add_dependency 'rspec'
+    spec.add_dependency 'rubocop'
+
+    # good
+    spec.add_dependency 'rubocop'
+
+    spec.add_dependency 'rspec'
+
+    # bad
+    spec.add_development_dependency 'rubocop'
+    spec.add_development_dependency 'rspec'
+
+    # good
+    spec.add_development_dependency 'rspec'
+    spec.add_development_dependency 'rubocop'
+
+    # good
+    spec.add_development_dependency 'rubocop'
+
+    spec.add_development_dependency 'rspec'
+
+    # bad
+    spec.add_runtime_dependency 'rubocop'
+    spec.add_runtime_dependency 'rspec'
+
+    # good
+    spec.add_runtime_dependency 'rspec'
+    spec.add_runtime_dependency 'rubocop'
+
+    # good
+    spec.add_runtime_dependency 'rubocop'
+
+    spec.add_runtime_dependency 'rspec'
+
+    # good only if TreatCommentsAsGroupSeparators is true
+    # For code quality
+    spec.add_dependency 'rubocop'
+    # For tests
+    spec.add_dependency 'rspec'

config/contents/layout/access_modifier_indentation.md

@@ -0,0 +1,31 @@
+Modifiers should be indented as deep as method definitions, or as deep
+as the class/module keyword, depending on configuration.
+
+### Example:
+    # EnforcedStyle: indent (default)
+
+    # bad
+    class Plumbus
+    private
+      def smooth; end
+    end
+
+    # good
+    class Plumbus
+      private
+      def smooth; end
+    end
+
+    # EnforcedStyle: outdent
+
+    # bad
+    class Plumbus
+      private
+      def smooth; end
+    end
+
+    # good
+    class Plumbus
+    private
+      def smooth; end
+    end

config/contents/layout/align_array.md

@@ -0,0 +1,17 @@
+Here we check if the elements of a multi-line array literal are
+aligned.
+
+### Example:
+    # bad
+    a = [1, 2, 3,
+      4, 5, 6]
+    array = ['run',
+         'forrest',
+         'run']
+
+    # good
+    a = [1, 2, 3,
+         4, 5, 6]
+    a = ['run',
+         'forrest',
+         'run']

config/contents/layout/align_hash.md

@@ -0,0 +1,94 @@
+Check that the keys, separators, and values of a multi-line hash
+literal are aligned according to configuration. The configuration
+options are:
+
+    - key (left align keys)
+    - separator (align hash rockets and colons, right align keys)
+    - table (left align keys, hash rockets, and values)
+
+The treatment of hashes passed as the last argument to a method call
+can also be configured. The options are:
+
+    - always_inspect
+    - always_ignore
+    - ignore_implicit (without curly braces)
+    - ignore_explicit (with curly braces)
+
+### Example:
+
+    # EnforcedHashRocketStyle: key (default)
+    # EnforcedColonStyle: key (default)
+
+    # good
+    {
+      foo: bar,
+      ba: baz
+    }
+    {
+      :foo => bar,
+      :ba => baz
+    }
+
+    # bad
+    {
+      foo: bar,
+       ba: baz
+    }
+    {
+      :foo => bar,
+       :ba => baz
+    }
+
+### Example:
+
+    # EnforcedHashRocketStyle: separator
+    # EnforcedColonStyle: separator
+
+    #good
+    {
+      foo: bar,
+       ba: baz
+    }
+    {
+      :foo => bar,
+       :ba => baz
+    }
+
+    #bad
+    {
+      foo: bar,
+      ba: baz
+    }
+    {
+      :foo => bar,
+      :ba => baz
+    }
+    {
+      :foo => bar,
+      :ba  => baz
+    }
+
+### Example:
+
+    # EnforcedHashRocketStyle: table
+    # EnforcedColonStyle: table
+
+    #good
+    {
+      foo: bar,
+      ba:  baz
+    }
+    {
+      :foo => bar,
+      :ba  => baz
+    }
+
+    #bad
+    {
+      foo: bar,
+      ba: baz
+    }
+    {
+      :foo => bar,
+       :ba => baz
+    }

config/contents/layout/align_parameters.md

@@ -0,0 +1,30 @@
+Here we check if the parameters on a multi-line method call or
+definition are aligned.
+
+### Example:
+
+    # EnforcedStyle: with_first_parameter
+
+    # good
+
+    foo :bar,
+        :baz
+
+    # bad
+
+    foo :bar,
+      :baz
+
+### Example:
+
+    # EnforcedStyle: with_fixed_indentation
+
+    # good
+
+    foo :bar,
+      :baz
+
+    # bad
+
+    foo :bar,
+        :baz

config/contents/layout/block_end_newline.md

@@ -0,0 +1,21 @@
+This cop checks whether the end statement of a do..end block
+is on its own line.
+
+### Example:
+    # bad
+    blah do |i|
+      foo(i) end
+
+    # good
+    blah do |i|
+      foo(i)
+    end
+
+    # bad
+    blah { |i|
+      foo(i) }
+
+    # good
+    blah { |i|
+      foo(i)
+    }

config/contents/layout/case_indentation.md

@@ -0,0 +1,67 @@
+This cop checks how the *when*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*.
+
+### Example:
+    # If Layout/EndAlignment is set to keyword style (default)
+    # *case* and *end* should always be aligned to same depth,
+    # and therefore *when* should always be aligned to both -
+    # regardless of configuration.
+
+    # bad for all styles
+    case n
+      when 0
+        x * 2
+      else
+        y / 3
+    end
+
+    # good for all styles
+    case n
+    when 0
+      x * 2
+    else
+      y / 3
+    end
+
+### Example:
+    # if EndAlignment is set to other style such as
+    # start_of_line (as shown below), then *when* alignment
+    # configuration does have an effect.
+
+    # EnforcedStyle: case (default)
+
+    # bad
+    a = case n
+    when 0
+      x * 2
+    else
+      y / 3
+    end
+
+    # good
+    a = case n
+        when 0
+          x * 2
+        else
+          y / 3
+    end
+
+    # EnforcedStyle: end
+
+    # bad
+    a = case n
+        when 0
+          x * 2
+        else
+          y / 3
+    end
+
+    # good
+    a = case n
+    when 0
+      x * 2
+    else
+      y / 3
+    end