rubocop-rspec 1.5.1 → 1.5.2

data/lib/rubocop/cop/rspec/instance_variable.rb

@@ -1,4 +1,3 @@
-# encoding: utf-8
 # frozen_string_literal: true
 
 module RuboCop

data/lib/rubocop/cop/rspec/multiple_describes.rb

@@ -1,4 +1,3 @@
-# encoding: utf-8
 # frozen_string_literal: true
 
 module RuboCop
@@ -29,9 +28,9 @@ module RuboCop
 
         def on_top_level_describe(node, _args)
           return if single_top_level_describe?
-          return unless top_level_nodes.first == node
+          return unless top_level_nodes.first.equal?(node)
 
-          add_offense(node, :expression, MSG)
+          add_offense(node, :expression)
         end
       end
     end

data/lib/rubocop/cop/rspec/not_to_not.rb

@@ -1,5 +1,3 @@
-# encoding: utf-8
-
 module RuboCop
   module Cop
     module RSpec
@@ -28,14 +26,14 @@ module RuboCop
 
           return unless METHOD_NAMES.include?(method_name)
 
-          return if style == method_name
+          return if style.equal?(method_name)
           add_offense(node, :expression)
         end
 
         def message(node)
           _receiver, method_name, *_args = *node
 
-          if method_name == :not_to
+          if method_name.equal?(:not_to)
             format(MSG, 'to_not', 'not_to')
           else
             format(MSG, 'not_to', 'to_not')
@@ -46,7 +44,7 @@ module RuboCop
           _receiver, method_name, *_args = *node
           lambda do |corrector|
             corrector.replace(node.loc.selector,
-                              method_name == :not_to ? 'to_not' : 'not_to')
+                              method_name.equal?(:not_to) ? 'to_not' : 'not_to')
           end
         end
       end

data/lib/rubocop/cop/rspec/verified_doubles.rb

@@ -1,4 +1,3 @@
-# encoding: utf-8
 # frozen_string_literal: true
 
 module RuboCop
@@ -19,23 +18,16 @@ module RuboCop
       #   end
       class VerifiedDoubles < Cop
         MSG = 'Prefer using verifying doubles over normal doubles.'.freeze
-        DOUBLE_TYPES = [:double, :spy].freeze
 
-        def on_send(node)
-          _receiver, method_name, *args = *node
-          name, *_stubs = *args
-          return unless DOUBLE_TYPES.include?(method_name)
-          return if name.nil?
-          return if name_is_symbol?(name) && cop_config['IgnoreSymbolicNames']
-          add_offense(node,
-                      :expression,
-                      format(MSG, node.loc.expression.source))
-        end
+        def_node_matcher :unverified_double, <<-PATTERN
+          {(send nil {:double :spy} $_ ...) }
+        PATTERN
 
-        private
+        def on_send(node)
+          return unless (name = unverified_double(node))
+          return if name.type.equal?(:sym) && cop_config['IgnoreSymbolicNames']
 
-        def name_is_symbol?(name)
-          name.children.first.is_a? Symbol
+          add_offense(node, :expression)
         end
       end
     end

data/lib/rubocop/rspec/inject.rb

@@ -1,4 +1,3 @@
-# encoding: utf-8
 module RuboCop
   module RSpec
     # Because RuboCop doesn't yet support plugins, we have to monkey patch in a

data/lib/rubocop/rspec/top_level_describe.rb

@@ -1,5 +1,3 @@
-# encoding: utf-8
-
 module RuboCop
   module RSpec
     # Helper methods for top level describe cops

data/lib/rubocop/rspec/util.rb

@@ -0,0 +1,19 @@
+# frozen_string_literal: true
+
+module RuboCop
+  module RSpec
+    # Utility methods
+    module Util
+      # Error raised by `Util.one` if size is less than zero or greater than one
+      SizeError = Class.new(IndexError)
+
+      # Return only element in array if it contains exactly one member
+      def one(array)
+        return array.first if array.one?
+
+        raise SizeError,
+              "expected size to be exactly 1 but size was #{array.size}"
+      end
+    end
+  end
+end

data/lib/rubocop/rspec/version.rb

@@ -1,11 +1,10 @@
-# encoding: utf-8
 # frozen_string_literal: true
 
 module RuboCop
   module RSpec
     # Version information for the RSpec RuboCop plugin.
     module Version
-      STRING = '1.5.1'.freeze
+      STRING = '1.5.2'.freeze
     end
   end
 end

data/lib/rubocop/rspec/wording.rb

@@ -0,0 +1,47 @@
+# frozen_string_literal: true
+
+module RuboCop
+  module RSpec
+    # RSpec example wording rewriter
+    class Wording
+      def initialize(text, ignore:, replace:)
+        @text         = text
+        @ignores      = ignore
+        @replacements = replace
+      end
+
+      def rewrite
+        text.split.tap do |words|
+          first_word = words.shift
+          words.unshift('not') if first_word.eql?("shouldn't")
+
+          words.each_with_index do |value, key|
+            next if ignores.include?(value)
+            words[key] = simple_present(words.fetch(key))
+            break
+          end
+        end.join(' ')
+      end
+
+      private
+
+      attr_reader :text, :ignores, :replacements
+
+      def simple_present(word)
+        return replacements.fetch(word) if replacements.key?(word)
+
+        # ends with o s x ch sh or ss
+        if %w(o s x ch sh).any?(&word.public_method(:end_with?))
+          return "#{word}es"
+        end
+
+        # ends with y
+        if word.end_with?('y') && !%w(a u o e).include?(word[-2])
+          return "#{word[0..-2]}ies"
+        end
+
+        "#{word}s"
+      end
+    end
+  end
+end

data/rubocop-rspec.gemspec

@@ -17,7 +17,7 @@ Gem::Specification.new do |spec|
 
   spec.version = RuboCop::RSpec::Version::STRING
   spec.platform = Gem::Platform::RUBY
-  spec.required_ruby_version = '>= 2.0.0'
+  spec.required_ruby_version = '>= 2.2.0'
 
   spec.require_paths = ['lib']
   spec.files = Dir[
@@ -30,7 +30,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.41.2'
+  spec.add_runtime_dependency 'rubocop', '>= 0.42.0'
 
   spec.add_development_dependency 'rake'
   spec.add_development_dependency 'rspec', '>= 3.4'

data/spec/project_spec.rb

@@ -1,5 +1,3 @@
-# encoding: utf-8
-
 describe 'RuboCop Project' do # rubocop:disable RSpec/DescribeClass
   describe 'default configuration file' do
     let(:cop_names) do

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

@@ -1,5 +1,3 @@
-# encoding: utf-8
-
 describe RuboCop::Cop::RSpec::AnyInstance do
   subject(:cop) { described_class.new }
 

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

@@ -1,5 +1,3 @@
-# encoding: utf-8
-
 describe RuboCop::Cop::RSpec::DescribeClass do
   subject(:cop) { described_class.new }
 
@@ -11,6 +9,11 @@ describe RuboCop::Cop::RSpec::DescribeClass do
                                 'the class or module being tested.'])
   end
 
+  it 'supports RSpec.describe' do
+    inspect_source(cop, 'RSpec.describe Foo do; end')
+    expect(cop.offenses).to be_empty
+  end
+
   it 'checks describe statements after a require' do
     inspect_source(
       cop,
@@ -25,6 +28,11 @@ describe RuboCop::Cop::RSpec::DescribeClass do
                                 'the class or module being tested.'])
   end
 
+  it 'checks highlights the first argument of a describe' do
+    inspect_source(cop, 'describe "bad describe", "blah blah" do; end')
+    expect(cop.offenses.first.location.column_range).to eq(9...23)
+  end
+
   it 'ignores nested describe statements' do
     inspect_source(
       cop,
@@ -47,6 +55,27 @@ describe RuboCop::Cop::RSpec::DescribeClass do
     expect(cop.offenses).to be_empty
   end
 
+  it 'ignores feature specs when RSpec.describe is used' do
+    inspect_source(
+      cop,
+      "RSpec.describe 'my new feature', type: :feature do; end"
+    )
+
+    expect(cop.offenses).to be_empty
+  end
+
+  it 'flags specs with non :type metadata' do
+    inspect_source(cop, "describe 'my new feature', foo: :feature do; end")
+    expect(cop.messages).to eq(['The first argument to describe should be ' \
+                                'the class or module being tested.'])
+  end
+
+  it 'flags normal metadata in describe' do
+    inspect_source(cop, "describe 'my new feature', blah, type: :wow do; end")
+    expect(cop.messages).to eq(['The first argument to describe should be ' \
+                                'the class or module being tested.'])
+  end
+
   it 'ignores feature specs - also with complex options' do
     inspect_source(
       cop,
@@ -59,6 +88,11 @@ describe RuboCop::Cop::RSpec::DescribeClass do
     expect(cop.offenses).to be_empty
   end
 
+  it 'ignores an empty describe' do
+    inspect_source(cop, 'describe do; end')
+    expect(cop.offenses).to be_empty
+  end
+
   it 'ignores routing specs' do
     inspect_source(cop, "describe 'my new route', type: :routing do; end")
     expect(cop.offenses).to be_empty

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

@@ -1,10 +1,17 @@
-# encoding: utf-8
-
 describe RuboCop::Cop::RSpec::DescribeMethod do
   subject(:cop) { described_class.new }
 
+  it 'ignores describes with only a class' do
+    inspect_source(cop, 'describe Some::Class do; end')
+    expect(cop.offenses.empty?).to be(true)
+  end
+
   it 'enforces non-method names' do
-    inspect_source(cop, "describe Some::Class, 'nope' do; end")
+    inspect_source(
+      cop,
+      "describe Some::Class, 'nope', '.incorrect_usage' do; end"
+    )
+
     expect(cop.offenses.size).to eq(1)
     expect(cop.offenses.map(&:line).sort).to eq([1])
     expect(cop.messages)

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

@@ -1,5 +1,3 @@
-# encoding: utf-8
-
 describe RuboCop::Cop::RSpec::DescribedClass do
   subject(:cop) { described_class.new }
 
@@ -125,6 +123,38 @@ describe RuboCop::Cop::RSpec::DescribedClass do
     expect(cop.highlights).to eq(['MyNamespace::MyClass'])
   end
 
+  it 'does not flag violations within a scope change' do
+    inspect_source(
+      cop,
+      [
+        'describe MyNamespace::MyClass do',
+        '  before do',
+        '    class Foo',
+        '      thing = MyNamespace::MyClass.new',
+        '    end',
+        '  end',
+        'end'
+      ]
+    )
+
+    expect(cop.offenses).to be_empty
+  end
+
+  it 'does not flag violations within a scope change' do
+    inspect_source(
+      cop,
+      [
+        'describe do',
+        '  before do',
+        '    MyNamespace::MyClass.new',
+        '  end',
+        'end'
+      ]
+    )
+
+    expect(cop.offenses).to be_empty
+  end
+
   it 'checks for the use of described class with module' do
     skip
     inspect_source(

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

@@ -1,9 +1,23 @@
-# encoding: utf-8
-
 describe RuboCop::Cop::RSpec::ExampleLength, :config do
   subject(:cop) { described_class.new(config) }
   let(:cop_config) { { 'Max' => 3 } }
 
+  it 'ignores non-spec blocks' do
+    inspect_source(
+      cop,
+      [
+        'foo do',
+        '  line 1',
+        '  line 2',
+        '  line 3',
+        '  line 4',
+        'end'
+      ]
+    )
+
+    expect(cop.offenses).to be_empty
+  end
+
   it 'allows an empty example' do
     inspect_source(
       cop,
@@ -29,7 +43,7 @@ describe RuboCop::Cop::RSpec::ExampleLength, :config do
     expect(cop.offenses).to be_empty
   end
 
-  it 'doesn\t allow a long example' do
+  it "doesn't allow a long example" do
     inspect_source(
       cop,
       [

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

@@ -1,74 +1,73 @@
-# encoding: utf-8
-
 describe RuboCop::Cop::RSpec::ExampleWording, :config do
   subject(:cop) { described_class.new(config) }
-  let(:cop_config) do
-    {
-      'CustomTransform' => { 'have' => 'has', 'not' => 'does not' },
-      'IgnoredWords' => %w(only really)
-    }
-  end
 
-  it 'finds description with `should` at the beginning' do
-    inspect_source(cop, ["it 'should do something' do", 'end'])
-    expect(cop.offenses.size).to eq(1)
-    expect(cop.offenses.map(&:line).sort).to eq([1])
-    expect(cop.messages)
-      .to eq(['Do not use should when describing your tests.'])
-    expect(cop.highlights).to eq(['should do something'])
-  end
+  context 'with configuration' do
+    let(:cop_config) do
+      {
+        'CustomTransform' => { 'have' => 'has', 'not' => 'does not' },
+        'IgnoredWords' => %w(only really)
+      }
+    end
 
-  it 'finds description with `Should` at the beginning' do
-    inspect_source(cop, ["it 'Should do something' do", 'end'])
-    expect(cop.offenses.size).to eq(1)
-    expect(cop.offenses.map(&:line).sort).to eq([1])
-    expect(cop.messages)
-      .to eq(['Do not use should when describing your tests.'])
-    expect(cop.highlights).to eq(['Should do something'])
-  end
+    it 'ignores non-example blocks' do
+      inspect_source(cop, 'foo "should do something" do; end')
+      expect(cop.offenses).to be_empty
+    end
 
-  it 'finds description with `shouldn\'t` at the beginning' do
-    inspect_source(cop, ['it "shouldn\'t do something" do', 'end'])
-    expect(cop.offenses.size).to eq(1)
-    expect(cop.offenses.map(&:line).sort).to eq([1])
-    expect(cop.messages)
-      .to eq(['Do not use should when describing your tests.'])
-    expect(cop.highlights).to eq(['shouldn\'t do something'])
-  end
+    it 'finds description with `should` at the beginning' do
+      inspect_source(cop, ["it 'should do something' do", 'end'])
+      expect(cop.offenses.size).to eq(1)
+      expect(cop.offenses.map(&:line).sort).to eq([1])
+      expect(cop.messages)
+        .to eq(['Do not use should when describing your tests.'])
+      expect(cop.highlights).to eq(['should do something'])
+    end
 
-  it 'skips descriptions without `should` at the beginning' do
-    inspect_source(
-      cop,
-      [
-        "it 'finds no should ' \\",
-        "   'here' do",
-        'end'
-      ]
-    )
-    expect(cop.offenses).to be_empty
-  end
+    it 'finds description with `Should` at the beginning' do
+      inspect_source(cop, ["it 'Should do something' do", 'end'])
+      expect(cop.offenses.size).to eq(1)
+      expect(cop.offenses.map(&:line).sort).to eq([1])
+      expect(cop.messages)
+        .to eq(['Do not use should when describing your tests.'])
+      expect(cop.highlights).to eq(['Should do something'])
+    end
+
+    it 'finds description with `shouldn\'t` at the beginning' do
+      inspect_source(cop, ['it "shouldn\'t do something" do', 'end'])
+      expect(cop.offenses.size).to eq(1)
+      expect(cop.offenses.map(&:line).sort).to eq([1])
+      expect(cop.messages)
+        .to eq(['Do not use should when describing your tests.'])
+      expect(cop.highlights).to eq(['shouldn\'t do something'])
+    end
+
+    it 'skips descriptions without `should` at the beginning' do
+      inspect_source(
+        cop,
+        [
+          "it 'finds no should ' \\",
+          "   'here' do",
+          'end'
+        ]
+      )
+      expect(cop.offenses).to be_empty
+    end
 
-  {
-    'should return something' => 'returns something',
-    'should not return something' => 'does not return something',
-    'should do nothing' => 'does nothing',
-    'should have sweets' => 'has sweets',
-    'should worry about the future' => 'worries about the future',
-    'should pay for pizza' => 'pays for pizza',
-    'should miss me' => 'misses me',
-    'should really only return one item' => 'really only returns one item'
-  }.each do |old, new|
-    it 'autocorrects an offenses' do
-      new_source = autocorrect_source(cop, ["it '#{old}' do", 'end'])
-      expect(new_source).to eq("it '#{new}' do\nend")
+    it 'corrects `it "should only have"` to it "only has"' do
+      corrected = autocorrect_source(cop, 'it "should only have trait" do end')
+      expect(corrected).to eql('it "only has trait" do end')
     end
   end
 
-  it "autocorrects shouldn't" do
-    new_source = autocorrect_source(
-      cop,
-      'it "shouldn\'t return something" do; end'
-    )
-    expect(new_source).to eq('it "does not return something" do; end')
+  context 'when configuration is empty' do
+    it 'only does not correct "have"' do
+      corrected = autocorrect_source(cop, 'it "should have trait" do end')
+      expect(corrected).to eql('it "haves trait" do end')
+    end
+
+    it 'only does not make an exception for the word "only"' do
+      corrected = autocorrect_source(cop, 'it "should only fail" do end')
+      expect(corrected).to eql('it "onlies fail" do end')
+    end
   end
 end