Add RSpec/EmptyLineAfterExample cop

Fixes #822

Author: pirj

CHANGELOG.md

@@ -6,6 +6,7 @@
 * Fix `RSpec/ExampleWording` autocorrect of multi-line docstrings. ([@pirj][])
 * Add `RSpec/ContextMethod` cop, to detect method names in `context`. ([@geniou][])
 * Update RuboCop dependency to 0.68.1 with support for children matching node pattern syntax. ([@pirj][])
+* Add `RSpec/EmptyLineAfterExample` cop to check that there is an empty line after example blocks. ([@pirj][])
 
 ## 1.35.0 (2019-08-02)
 

config/default.yml

@@ -100,6 +100,12 @@ RSpec/EmptyExampleGroup:
   CustomIncludeMethods: []
   StyleGuide: http://www.rubydoc.info/gems/rubocop-rspec/RuboCop/Cop/RSpec/EmptyExampleGroup
 
+RSpec/EmptyLineAfterExample:
+  Description: Checks if there is an empty line after example blocks.
+  Enabled: true
+  AllowConsecutiveOneLiners: true
+  StyleGuide: http://www.rubydoc.info/gems/rubocop-rspec/RuboCop/Cop/RSpec/EmptyLineAfterExample
+
 RSpec/EmptyLineAfterExampleGroup:
   Description: Checks if there is an empty line after example group blocks.
   Enabled: true

lib/rubocop/cop/rspec/empty_line_after_example.rb

@@ -0,0 +1,87 @@
+# frozen_string_literal: true
+
+module RuboCop
+  module Cop
+    module RSpec
+      # Checks if there is an empty line after example blocks.
+      #
+      # @example
+      #   # bad
+      #   RSpec.describe Foo do
+      #     it 'does this' do
+      #     end
+      #     it 'does that' do
+      #     end
+      #   end
+      #
+      #   # good
+      #   RSpec.describe Foo do
+      #     it 'does this' do
+      #     end
+      #
+      #     it 'does that' do
+      #     end
+      #   end
+      #
+      #   # fair - it's ok to have non-separated one-liners
+      #   RSpec.describe Foo do
+      #     it { one }
+      #     it { two }
+      #   end
+      #
+      # @example with AllowConsecutiveOneLiners configuration
+      #
+      #   # rubocop.yml
+      #   # RSpec/EmptyLineAfterExample:
+      #   #   AllowConsecutiveOneLiners: false
+      #
+      #   # bad
+      #   RSpec.describe Foo do
+      #     it { one }
+      #     it { two }
+      #   end
+      #
+      class EmptyLineAfterExample < Cop
+        include RuboCop::RSpec::BlankLineSeparation
+
+        MSG = 'Add an empty line after `%<example>s`.'
+
+        def on_block(node)
+          return unless example?(node)
+          return if last_child?(node)
+          return if allowed_one_liner?(node)
+
+          missing_separating_line(node) do |location|
+            add_offense(node,
+                        location: location,
+                        message: format(MSG, example: node.method_name))
+          end
+        end
+
+        def allowed_one_liner?(node)
+          consecutive_one_liner?(node) && allow_consecutive_one_liners?
+        end
+
+        def allow_consecutive_one_liners?
+          cop_config['AllowConsecutiveOneLiners']
+        end
+
+        def consecutive_one_liner?(node)
+          node.line_count == 1 && next_one_line_example?(node)
+        end
+
+        def next_one_line_example?(node)
+          next_sibling = next_sibling(node)
+          return unless next_sibling
+          return unless example?(next_sibling)
+
+          next_sibling.line_count == 1
+        end
+
+        def next_sibling(node)
+          node.parent.children[node.sibling_index + 1]
+        end
+      end
+    end
+  end
+end

lib/rubocop/cop/rspec_cops.rb

@@ -27,6 +27,7 @@
 require_relative 'rspec/described_class'
 require_relative 'rspec/dialect'
 require_relative 'rspec/empty_example_group'
+require_relative 'rspec/empty_line_after_example'
 require_relative 'rspec/empty_line_after_example_group'
 require_relative 'rspec/empty_line_after_final_let'
 require_relative 'rspec/empty_line_after_hook'

manual/cops.md

@@ -26,6 +26,7 @@
 * [RSpec/DescribedClass](cops_rspec.md#rspecdescribedclass)
 * [RSpec/Dialect](cops_rspec.md#rspecdialect)
 * [RSpec/EmptyExampleGroup](cops_rspec.md#rspecemptyexamplegroup)
+* [RSpec/EmptyLineAfterExample](cops_rspec.md#rspecemptylineafterexample)
 * [RSpec/EmptyLineAfterExampleGroup](cops_rspec.md#rspecemptylineafterexamplegroup)
 * [RSpec/EmptyLineAfterFinalLet](cops_rspec.md#rspecemptylineafterfinallet)
 * [RSpec/EmptyLineAfterHook](cops_rspec.md#rspecemptylineafterhook)

manual/cops_rspec.md

@@ -602,6 +602,64 @@ CustomIncludeMethods | `[]` | Array
 
 * [http://www.rubydoc.info/gems/rubocop-rspec/RuboCop/Cop/RSpec/EmptyExampleGroup](http://www.rubydoc.info/gems/rubocop-rspec/RuboCop/Cop/RSpec/EmptyExampleGroup)
 
+## RSpec/EmptyLineAfterExample
+
+Enabled by default | Supports autocorrection
+--- | ---
+Enabled | Yes
+
+Checks if there is an empty line after example blocks.
+
+### Examples
+
+```ruby
+# bad
+RSpec.describe Foo do
+  it 'does this' do
+  end
+  it 'does that' do
+  end
+end
+
+# good
+RSpec.describe Foo do
+  it 'does this' do
+  end
+
+  it 'does that' do
+  end
+end
+
+# fair - it's ok to have non-separated one-liners
+RSpec.describe Foo do
+  it { one }
+  it { two }
+end
+```
+#### with AllowConsecutiveOneLiners configuration
+
+```ruby
+# rubocop.yml
+# RSpec/EmptyLineAfterExample:
+#   AllowConsecutiveOneLiners: false
+
+# bad
+RSpec.describe Foo do
+  it { one }
+  it { two }
+end
+```
+
+### Configurable attributes
+
+Name | Default value | Configurable values
+--- | --- | ---
+AllowConsecutiveOneLiners | `true` | Boolean
+
+### References
+
+* [http://www.rubydoc.info/gems/rubocop-rspec/RuboCop/Cop/RSpec/EmptyLineAfterExample](http://www.rubydoc.info/gems/rubocop-rspec/RuboCop/Cop/RSpec/EmptyLineAfterExample)
+
 ## RSpec/EmptyLineAfterExampleGroup
 
 Enabled by default | Supports autocorrection

spec/rubocop/cop/rspec/empty_line_after_example_spec.rb

@@ -0,0 +1,121 @@
+# frozen_string_literal: true
+
+RSpec.describe RuboCop::Cop::RSpec::EmptyLineAfterExample, :config do
+  subject(:cop) { described_class.new(config) }
+
+  let(:cop_config) { { 'AllowConsecutiveOneLiners' => true } }
+
+  it 'flags a missing empty line after `it`' do
+    expect_offense(<<-RUBY)
+      RSpec.describe Foo do
+        it 'does this' do
+        end
+        ^^^ Add an empty line after `it`.
+        it 'does that' do
+        end
+      end
+    RUBY
+
+    expect_correction(<<-RUBY)
+      RSpec.describe Foo do
+        it 'does this' do
+        end
+
+        it 'does that' do
+        end
+      end
+    RUBY
+  end
+
+  it 'flags one-line examples' do
+    expect_offense(<<-RUBY)
+      RSpec.describe Foo do
+        it { }
+        ^^^^^^ Add an empty line after `it`.
+        it 'does that' do
+        end
+      end
+    RUBY
+
+    expect_correction(<<-RUBY)
+      RSpec.describe Foo do
+        it { }
+
+        it 'does that' do
+        end
+      end
+    RUBY
+  end
+
+  it 'flags a missing empty line after `specify`' do
+    expect_offense(<<-RUBY)
+      RSpec.context 'foo' do
+        specify do
+        end
+        ^^^ Add an empty line after `specify`.
+        specify 'something gets done' do
+        end
+      end
+    RUBY
+
+    expect_correction(<<-RUBY)
+      RSpec.context 'foo' do
+        specify do
+        end
+
+        specify 'something gets done' do
+        end
+      end
+    RUBY
+  end
+
+  it 'ignores when an empty line is present' do
+    expect_no_offenses(<<-RUBY)
+      RSpec.describe Foo do
+        it 'does this' do
+        end
+
+        it 'does that' do
+        end
+      end
+    RUBY
+  end
+
+  it 'ignores consecutive one-liners' do
+    expect_no_offenses(<<-RUBY)
+      RSpec.describe Foo do
+        it { one }
+        it { two }
+      end
+    RUBY
+  end
+
+  it 'flags mixed one-line and multi-line examples' do
+    expect_offense(<<-RUBY)
+      RSpec.context 'foo' do
+        it { }
+        it { }
+        ^^^^^^ Add an empty line after `it`.
+        it 'does this' do
+        end
+        ^^^ Add an empty line after `it`.
+        it { }
+        it { }
+      end
+    RUBY
+  end
+
+  context 'when AllowConsecutiveOneLiners is false' do
+    let(:cop_config) { { 'AllowConsecutiveOneLiners' => false } }
+
+    it 'ignores consecutive one-liners' do
+      expect_offense(<<-RUBY)
+        RSpec.describe Foo do
+          it { one }
+          ^^^^^^^^^^ Add an empty line after `it`.
+          it { two }
+        end
+      RUBY
+    end
+  end
+end