rubocop-rspec 1.21.0 → 1.22.0

data/lib/rubocop/rspec/description_extractor.rb

@@ -19,6 +19,7 @@ module RuboCop
 
       # Decorator of a YARD code object for working with documented rspec cops
       class CodeObject
+        COP_CLASS_NAMES = %w[RuboCop::Cop RuboCop::Cop::RSpec::Cop].freeze
         RSPEC_NAMESPACE = 'RuboCop::Cop::RSpec'.freeze
 
         def initialize(yardoc)
@@ -29,7 +30,10 @@ module RuboCop
         #
         # @return [Boolean]
         def rspec_cop?
-          class_documentation? && rspec_cop_namespace? && !abstract?
+          class_documentation? &&
+            rspec_cop_namespace? &&
+            cop_subclass? &&
+            !abstract?
         end
 
         # Configuration for the documented cop that would live in default.yml
@@ -61,6 +65,14 @@ module RuboCop
           yardoc.to_s
         end
 
+        def cop_subclass?
+          # YARD superclass resolution is a bit flaky: All classes loaded before
+          # RuboCop::Cop::WorkaroundCop are shown as having RuboCop::Cop as
+          # superclass, while all the following classes are listed as having
+          # RuboCop::Cop::RSpec::Cop as their superclass.
+          COP_CLASS_NAMES.include?(yardoc.superclass.path)
+        end
+
         def abstract?
           yardoc.tags.any? { |tag| tag.tag_name.eql?('abstract') }
         end

data/lib/rubocop/rspec/version.rb

@@ -4,7 +4,7 @@ module RuboCop
   module RSpec
     # Version information for the RSpec RuboCop plugin.
     module Version
-      STRING = '1.21.0'.freeze
+      STRING = '1.22.0'.freeze
     end
   end
 end

data/rubocop-rspec.gemspec

@@ -32,7 +32,7 @@ Gem::Specification.new do |spec|
   spec.test_files = spec.files.grep(%r{^spec/})
   spec.extra_rdoc_files = ['MIT-LICENSE.md', 'README.md']
 
-  spec.add_runtime_dependency 'rubocop', '>= 0.52.0'
+  spec.add_runtime_dependency 'rubocop', '>= 0.52.1'
 
   spec.add_development_dependency 'rake'
   spec.add_development_dependency 'rspec', '>= 3.4'

data/spec/rubocop/cop/rspec/describe_class_spec.rb

@@ -56,6 +56,13 @@ RSpec.describe RuboCop::Cop::RSpec::DescribeClass do
     RUBY
   end
 
+  it 'ignores system specs' do
+    expect_no_offenses(<<-RUBY)
+      describe 'my new system test', type: :system do
+      end
+    RUBY
+  end
+
   it 'ignores feature specs when RSpec.describe is used' do
     expect_no_offenses(<<-RUBY)
       RSpec.describe 'my new feature', type: :feature do

data/spec/rubocop/cop/rspec/example_without_description_spec.rb

@@ -0,0 +1,82 @@
+RSpec.describe RuboCop::Cop::RSpec::ExampleWithoutDescription, :config do
+  subject(:cop) { described_class.new(config) }
+
+  let(:cop_config) do
+    { 'EnforcedStyle' => enforced_style }
+  end
+
+  context 'with EnforcedStyle `always_allow`' do
+    let(:enforced_style) { 'always_allow' }
+
+    it 'flags empty strings for description' do
+      expect_offense(<<-RUBY)
+        it '' do
+           ^^ Omit the argument when you want to have auto-generated description.
+          expect(subject).to be_good
+        end
+      RUBY
+    end
+
+    it 'ignores `it` with a description' do
+      expect_no_offenses(<<-RUBY)
+        it 'is good' do
+          expect(subject).to be_good
+        end
+      RUBY
+    end
+
+    it 'ignores `it` without an argument' do
+      expect_no_offenses(<<-RUBY)
+        it do
+          expect(subject).to be_good
+        end
+      RUBY
+    end
+  end
+
+  context 'with EnforcedStyle `single_line_only`' do
+    let(:enforced_style) { 'single_line_only' }
+
+    it 'flags missing description in multi-line examples' do
+      expect_offense(<<-RUBY)
+        it do
+        ^^ Add a description.
+          expect(subject).to be_good
+        end
+      RUBY
+    end
+
+    it 'ignores missing description in single-line examples' do
+      expect_no_offenses(<<-RUBY)
+        it { expect(subject).to be_good }
+      RUBY
+    end
+
+    it 'flags example with an empty string for description' do
+      expect_offense(<<-RUBY)
+        it('') { expect(subject).to be_good }
+           ^^ Omit the argument when you want to have auto-generated description.
+      RUBY
+    end
+  end
+
+  context 'with EnforcedStyle `disallow`' do
+    let(:enforced_style) { 'disallow' }
+
+    it 'flags missing description in multi-line examples' do
+      expect_offense(<<-RUBY)
+        it do
+        ^^ Add a description.
+          expect(subject).to be_good
+        end
+      RUBY
+    end
+
+    it 'flags missing description in single-line examples' do
+      expect_offense(<<-RUBY)
+        it { expect(subject).to be_good }
+        ^^ Add a description.
+      RUBY
+    end
+  end
+end

data/spec/rubocop/cop/rspec/expect_change_spec.rb

@@ -0,0 +1,78 @@
+RSpec.describe RuboCop::Cop::RSpec::ExpectChange, :config do
+  subject(:cop) { described_class.new(config) }
+
+  let(:cop_config) do
+    { 'EnforcedStyle' => enforced_style }
+  end
+
+  context 'with EnforcedStyle `method_call`' do
+    let(:enforced_style) { 'method_call' }
+
+    it 'finds blocks that contain simple message sending' do
+      expect_offense(<<-RUBY)
+        it do
+          expect(run).to change { User.count }
+                         ^^^^^^^^^^^^^^^^^^^^^ Prefer `change(User, :count)`.
+        end
+      RUBY
+    end
+
+    it 'ignores blocks that cannot be converted to obj/attribute pair' do
+      expect_no_offenses(<<-RUBY)
+        it do
+          expect(run).to change { User.sum(:points) }
+        end
+      RUBY
+    end
+
+    it 'ignores change method of object that happens to receive a block' do
+      expect_no_offenses(<<-RUBY)
+        it do
+          Record.change { User.count }
+        end
+      RUBY
+    end
+
+    include_examples(
+      'autocorrect',
+      'expect(run).to change { User.count }.by(1)',
+      'expect(run).to change(User, :count).by(1)'
+    )
+  end
+
+  context 'with EnforcedStyle `block`' do
+    let(:enforced_style) { 'block' }
+
+    it 'finds change matcher without block' do
+      expect_offense(<<-RUBY)
+        it do
+          expect(run).to change(User, :count)
+                         ^^^^^^^^^^^^^^^^^^^^ Prefer `change { User.count }`.
+        end
+      RUBY
+    end
+
+    it 'finds change matcher when receiver is a variable' do
+      expect_offense(<<-RUBY)
+        it do
+          expect(run).to change(user, :count)
+                         ^^^^^^^^^^^^^^^^^^^^ Prefer `change { user.count }`.
+        end
+      RUBY
+    end
+
+    it 'ignores methods called change' do
+      expect_no_offenses(<<-RUBY)
+        it do
+          record.change(user, :count)
+        end
+      RUBY
+    end
+
+    include_examples(
+      'autocorrect',
+      'expect(run).to change(User, :count).by(1)',
+      'expect(run).to change { User.count }.by(1)'
+    )
+  end
+end

data/spec/rubocop/cop/rspec/instance_variable_spec.rb

@@ -36,6 +36,24 @@ RSpec.describe RuboCop::Cop::RSpec::InstanceVariable do
     RUBY
   end
 
+  it 'ignores an instance variable inside a dynamic class' do
+    expect_no_offenses(<<-RUBY)
+      describe MyClass do
+        let(:object) do
+          Class.new(OtherClass) do
+            def initialize(resource)
+              @resource = resource
+            end
+
+            def serialize
+              @resource.to_json
+            end
+          end
+        end
+      end
+    RUBY
+  end
+
   # Regression test for nevir/rubocop-rspec#115
   it 'ignores instance variables outside of specs' do
     expect_no_offenses(<<-RUBY, 'lib/source_code.rb')

data/spec/rubocop/cop/rspec/let_before_examples_spec.rb

@@ -90,4 +90,52 @@ RSpec.describe RuboCop::Cop::RSpec::LetBeforeExamples do
     expect { inspect_source('RSpec.describe(User) do end', 'a_spec.rb') }
       .not_to raise_error
   end
+
+  bad_code = <<-RUBY
+    RSpec.describe User do
+      include_examples('should be after let')
+      context 'another one' do
+        let(:foo) { baz }
+        include_examples('should be ok')
+      end
+
+      let(:foo) { bar }
+    end
+  RUBY
+
+  good_code = <<-RUBY
+    RSpec.describe User do
+      let(:foo) { bar }
+      include_examples('should be after let')
+      context 'another one' do
+        let(:foo) { baz }
+        include_examples('should be ok')
+      end
+
+    end
+  RUBY
+
+  include_examples 'autocorrect', bad_code, good_code
+
+  bad_code = <<-RUBY
+    RSpec.describe User do
+      include_examples('should be after let')
+
+      let(:foo) { (<<-SOURCE) }
+      some long text here
+      SOURCE
+    end
+  RUBY
+
+  good_code = <<-RUBY
+    RSpec.describe User do
+      let(:foo) { (<<-SOURCE) }
+      some long text here
+      SOURCE
+      include_examples('should be after let')
+
+    end
+  RUBY
+
+  include_examples 'autocorrect', bad_code, good_code
 end

data/spec/rubocop/cop/rspec/return_from_stub_spec.rb

@@ -115,6 +115,31 @@ RSpec.describe RuboCop::Cop::RSpec::ReturnFromStub, :config do
         end
       RUBY
     end
+
+    include_examples 'autocorrect',
+                     'allow(Foo).to receive(:bar) { 42 }',
+                     'allow(Foo).to receive(:bar).and_return(42)'
+
+    include_examples 'autocorrect',
+                     'allow(Foo).to receive(:bar) { { foo: 42 } }',
+                     'allow(Foo).to receive(:bar).and_return({ foo: 42 })'
+
+    include_examples 'autocorrect',
+                     'allow(Foo).to receive(:bar) {}',
+                     'allow(Foo).to receive(:bar).and_return(nil)'
+
+    original = <<-RUBY
+      allow(Foo).to receive(:bar) do
+        'You called ' \\
+        'me'
+      end
+    RUBY
+    corrected = <<-RUBY
+      allow(Foo).to receive(:bar).and_return('You called ' \\
+        'me')
+    RUBY
+
+    include_examples 'autocorrect', original, corrected
   end
 
   context 'with EnforcedStyle `block`' do
@@ -153,5 +178,45 @@ RSpec.describe RuboCop::Cop::RSpec::ReturnFromStub, :config do
         end
       RUBY
     end
+
+    include_examples 'autocorrect',
+                     'allow(Foo).to receive(:bar).and_return(42)',
+                     'allow(Foo).to receive(:bar) { 42 }'
+
+    include_examples 'autocorrect',
+                     'allow(Foo).to receive(:bar).and_return({ foo: 42 })',
+                     'allow(Foo).to receive(:bar) { { foo: 42 } }'
+
+    include_examples 'autocorrect',
+                     'allow(Foo).to receive(:bar).and_return(foo: 42)',
+                     'allow(Foo).to receive(:bar) { { foo: 42 } }'
+
+    original = <<-RUBY
+      allow(Foo).to receive(:bar).and_return(
+        a: 42,
+        b: 43
+      )
+    RUBY
+    corrected = <<-RUBY # Not perfect, but good enough.
+      allow(Foo).to receive(:bar) { { a: 42,
+        b: 43 } }
+    RUBY
+
+    include_examples 'autocorrect', original, corrected
+
+    include_examples 'autocorrect',
+                     'allow(Foo).to receive(:bar).and_return(nil)',
+                     'allow(Foo).to receive(:bar) { nil }'
+
+    original = <<-RUBY
+      allow(Foo).to receive(:bar).and_return('You called ' \\
+        'me')
+    RUBY
+    corrected = <<-RUBY
+      allow(Foo).to receive(:bar) { 'You called ' \\
+        'me' }
+    RUBY
+
+    include_examples 'autocorrect', original, corrected
   end
 end

data/spec/rubocop/rspec/description_extractor_spec.rb

@@ -20,13 +20,17 @@ RSpec.describe RuboCop::RSpec::DescriptionExtractor do
       # Some description
       #
       # @note only works with foo
-      class RuboCop::Cop::RSpec::Foo
+      class RuboCop::Cop::RSpec::Foo < RuboCop::Cop::RSpec::Cop
         # Hello
         def bar
         end
+
+        # :nodoc:
+        class HelperClassForFoo
+        end
       end
 
-      class RuboCop::Cop::RSpec::Undocumented
+      class RuboCop::Cop::RSpec::Undocumented < RuboCop::Cop::RSpec::Cop
         # Hello
         def bar
         end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: rubocop-rspec
 version: !ruby/object:Gem::Version
-  version: 1.21.0
+  version: 1.22.0
 platform: ruby
 authors:
 - John Backus
@@ -10,7 +10,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2017-12-13 00:00:00.000000000 Z
+date: 2018-01-10 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rubocop
@@ -18,14 +18,14 @@ dependencies:
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: 0.52.0
+        version: 0.52.1
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: 0.52.0
+        version: 0.52.1
 - !ruby/object:Gem::Dependency
   name: rake
   requirement: !ruby/object:Gem::Requirement
@@ -120,8 +120,10 @@ files:
 - lib/rubocop/cop/rspec/empty_line_after_final_let.rb
 - lib/rubocop/cop/rspec/empty_line_after_subject.rb
 - lib/rubocop/cop/rspec/example_length.rb
+- lib/rubocop/cop/rspec/example_without_description.rb
 - lib/rubocop/cop/rspec/example_wording.rb
 - lib/rubocop/cop/rspec/expect_actual.rb
+- lib/rubocop/cop/rspec/expect_change.rb
 - lib/rubocop/cop/rspec/expect_in_hook.rb
 - lib/rubocop/cop/rspec/expect_output.rb
 - lib/rubocop/cop/rspec/factory_bot/dynamic_attribute_defined_statically.rb
@@ -158,6 +160,7 @@ files:
 - lib/rubocop/cop/rspec/subject_stub.rb
 - lib/rubocop/cop/rspec/verified_doubles.rb
 - lib/rubocop/cop/rspec/void_expect.rb
+- lib/rubocop/cop/rspec_cops.rb
 - lib/rubocop/rspec.rb
 - lib/rubocop/rspec/align_let_brace.rb
 - lib/rubocop/rspec/capybara.rb
@@ -197,8 +200,10 @@ files:
 - spec/rubocop/cop/rspec/empty_line_after_final_let_spec.rb
 - spec/rubocop/cop/rspec/empty_line_after_subject_spec.rb
 - spec/rubocop/cop/rspec/example_length_spec.rb
+- spec/rubocop/cop/rspec/example_without_description_spec.rb
 - spec/rubocop/cop/rspec/example_wording_spec.rb
 - spec/rubocop/cop/rspec/expect_actual_spec.rb
+- spec/rubocop/cop/rspec/expect_change_spec.rb
 - spec/rubocop/cop/rspec/expect_in_hook_spec.rb
 - spec/rubocop/cop/rspec/expect_output_spec.rb
 - spec/rubocop/cop/rspec/factory_bot/dynamic_attribute_defined_statically_spec.rb
@@ -293,8 +298,10 @@ test_files:
 - spec/rubocop/cop/rspec/empty_line_after_final_let_spec.rb
 - spec/rubocop/cop/rspec/empty_line_after_subject_spec.rb
 - spec/rubocop/cop/rspec/example_length_spec.rb
+- spec/rubocop/cop/rspec/example_without_description_spec.rb
 - spec/rubocop/cop/rspec/example_wording_spec.rb
 - spec/rubocop/cop/rspec/expect_actual_spec.rb
+- spec/rubocop/cop/rspec/expect_change_spec.rb
 - spec/rubocop/cop/rspec/expect_in_hook_spec.rb
 - spec/rubocop/cop/rspec/expect_output_spec.rb
 - spec/rubocop/cop/rspec/factory_bot/dynamic_attribute_defined_statically_spec.rb