rubocop-rspec 1.8.0 → 1.9.0

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

@@ -0,0 +1,76 @@
+# frozen_string_literal: true
+
+describe RuboCop::Cop::RSpec::RepeatedDescription do
+  subject(:cop) { described_class.new }
+
+  it 'registers an offense for repeated descriptions' do
+    expect_violation(<<-RUBY)
+      describe 'doing x' do
+        it "does x" do
+        ^^^^^^^^^^^ Don't repeat descriptions within an example group.
+        end
+
+        it "does x" do
+        ^^^^^^^^^^^ Don't repeat descriptions within an example group.
+        end
+      end
+    RUBY
+  end
+
+  it 'registers offense for repeated descriptions separated by a context' do
+    expect_violation(<<-RUBY)
+      describe 'doing x' do
+        it "does x" do
+        ^^^^^^^^^^^ Don't repeat descriptions within an example group.
+        end
+
+        context 'during some use case' do
+          it "does x" do
+            # this should be fine
+          end
+        end
+
+        it "does x" do
+        ^^^^^^^^^^^ Don't repeat descriptions within an example group.
+        end
+      end
+    RUBY
+  end
+
+  it 'ignores descriptions repeated in a shared context' do
+    expect_no_violations(<<-RUBY)
+      describe 'doing x' do
+        it "does x" do
+        end
+
+        shared_context 'shared behavior' do
+          it "does x" do
+          end
+        end
+      end
+    RUBY
+  end
+
+  it 'ignores repeated descriptions in a nested context' do
+    expect_no_violations(<<-RUBY)
+      describe 'doing x' do
+        it "does x" do
+        end
+
+        context 'in a certain use case' do
+          it "does x" do
+          end
+        end
+      end
+    RUBY
+  end
+
+  it 'does not flag tests which do not contain description strings' do
+    expect_no_violations(<<-RUBY)
+      describe 'doing x' do
+        it { foo }
+        it { bar }
+      end
+    RUBY
+  end
+end

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

@@ -0,0 +1,75 @@
+describe RuboCop::Cop::RSpec::SingleArgumentMessageChain do
+  subject(:cop) { described_class.new }
+
+  describe 'receive_message_chain' do
+    it 'reports single-argument calls' do
+      expect_violation(<<-RUBY)
+        before do
+          allow(foo).to receive_message_chain(:one) { :two }
+                        ^^^^^^^^^^^^^^^^^^^^^ Use `receive` instead of calling `receive_message_chain` with a single argument
+        end
+      RUBY
+    end
+
+    it 'accepts multi-argument calls' do
+      expect_no_violations(<<-RUBY)
+        before do
+          allow(foo).to receive_message_chain(:one, :two) { :three }
+        end
+      RUBY
+    end
+
+    it 'reports single-argument string calls' do
+      expect_violation(<<-RUBY)
+        before do
+          allow(foo).to receive_message_chain("one") { :two }
+                        ^^^^^^^^^^^^^^^^^^^^^ Use `receive` instead of calling `receive_message_chain` with a single argument
+        end
+      RUBY
+    end
+
+    it 'accepts multi-argument string calls' do
+      expect_no_violations(<<-RUBY)
+        before do
+          allow(foo).to receive_message_chain("one.two") { :three }
+        end
+      RUBY
+    end
+  end
+
+  describe 'stub_chain' do
+    it 'reports single-argument calls' do
+      expect_violation(<<-RUBY)
+        before do
+          foo.stub_chain(:one) { :two }
+              ^^^^^^^^^^ Use `stub` instead of calling `stub_chain` with a single argument
+        end
+      RUBY
+    end
+
+    it 'accepts multi-argument calls' do
+      expect_no_violations(<<-RUBY)
+        before do
+          foo.stub_chain(:one, :two) { :three }
+        end
+      RUBY
+    end
+
+    it 'reports single-argument string calls' do
+      expect_violation(<<-RUBY)
+        before do
+          allow(foo).to stub_chain("one") { :two }
+                        ^^^^^^^^^^ Use `stub` instead of calling `stub_chain` with a single argument
+        end
+      RUBY
+    end
+
+    it 'accepts multi-argument string calls' do
+      expect_no_violations(<<-RUBY)
+        before do
+          allow(foo).to stub_chain("one.two") { :three }
+        end
+      RUBY
+    end
+  end
+end

data/spec/rubocop/rspec/description_extractor_spec.rb

@@ -4,32 +4,54 @@ require 'rubocop/rspec/description_extractor'
 
 RSpec.describe RuboCop::RSpec::DescriptionExtractor do
   let(:yardocs) do
-    [
-      instance_double(
-        YARD::CodeObjects::MethodObject,
-        docstring: "Checks foo\n\nLong description",
-        to_s: 'RuboCop::Cop::RSpec::Foo',
-        type: :class,
-        name: 'Foo'
-      ),
-      instance_double(
-        YARD::CodeObjects::MethodObject,
-        docstring: 'Hi',
-        to_s: 'RuboCop::Cop::RSpec::Foo#bar',
-        type: :method,
-        name: 'Foo#bar'
-      ),
-      instance_double(
-        YARD::CodeObjects::MethodObject,
-        docstring: 'This is not a cop',
-        to_s: 'RuboCop::Cop::Mixin::Sneaky',
-        type: :class
-      )
-    ]
+    YARD.parse_string(<<-RUBY)
+    # This is not a cop
+    class RuboCop::Cop::Mixin::Sneaky
+    end
+
+    # This is not a concrete cop
+    #
+    # @abstract
+    class RuboCop::Cop::RSpec::Cop
+    end
+
+    # Checks foo
+    #
+    # Some description
+    #
+    # @note only works with foo
+    class RuboCop::Cop::RSpec::Foo
+      # Hello
+      def bar
+      end
+    end
+
+    class RuboCop::Cop::RSpec::Undocumented
+      # Hello
+      def bar
+      end
+    end
+    RUBY
+
+    YARD::Registry.all
+  end
+
+  def stub_cop_const(name)
+    stub_const(
+      "RuboCop::Cop::RSpec::#{name}",
+      Class.new(RuboCop::Cop::Cop)
+    )
+  end
+
+  before do
+    stub_cop_const('Foo')
+    stub_cop_const('Undocumented')
   end
 
   it 'builds a hash of descriptions' do
-    expect(described_class.new(yardocs).to_h)
-      .to eql('RSpec/Foo' => { 'Description' => 'Checks foo' })
+    expect(described_class.new(yardocs).to_h).to eql(
+      'RSpec/Foo'          => { 'Description' => 'Checks foo' },
+      'RSpec/Undocumented' => { 'Description' => ''           }
+    )
   end
 end

data/spec/rubocop/rspec/example_group_spec.rb

@@ -0,0 +1,44 @@
+# frozen_string_literal: true
+
+RSpec.describe RuboCop::RSpec::ExampleGroup do
+  include RuboCop::Sexp
+
+  subject(:group) { described_class.new(parse_source(source).ast) }
+
+  let(:source) do
+    <<-RUBY
+    RSpec.describe Foo do
+      it 'does x' do
+        x
+      end
+
+      it 'does y' do
+        y
+      end
+
+      context 'nested' do
+        it 'does z' do
+          z
+        end
+      end
+    end
+    RUBY
+  end
+
+  let(:example_nodes) do
+    [
+      s(:block,
+        s(:send, nil, :it,
+          s(:str, 'does x')),
+        s(:args), s(:send, nil, :x)),
+      s(:block,
+        s(:send, nil, :it,
+          s(:str, 'does y')),
+        s(:args), s(:send, nil, :y))
+    ].map { |node| RuboCop::RSpec::Example.new(node) }
+  end
+
+  it 'exposes examples in scope' do
+    expect(group.examples).to eql(example_nodes)
+  end
+end

data/spec/rubocop/rspec/example_spec.rb

@@ -0,0 +1,62 @@
+# frozen_string_literal: true
+
+RSpec.describe RuboCop::RSpec::Example do
+  include RuboCop::Sexp
+
+  def example(source)
+    described_class.new(parse_source(source).ast)
+  end
+
+  it 'extracts doc string' do
+    expect(example("it('does x') { foo }").doc_string)
+      .to eql(s(:str, 'does x'))
+  end
+
+  it 'extracts doc string for unimplemented examples' do
+    expect(example("it('does x')").doc_string)
+      .to eql(s(:str, 'does x'))
+  end
+
+  it 'returns nil for examples without doc strings' do
+    expect(example('it { foo }').doc_string).to be(nil)
+  end
+
+  it 'extracts keywords' do
+    expect(example("it('foo', :bar, baz: :qux) { a }").metadata)
+      .to eql([s(:sym, :bar), s(:hash, s(:pair, s(:sym, :baz), s(:sym, :qux)))])
+  end
+
+  it 'extracts implementation' do
+    expect(example('it("foo") { bar; baz }').implementation)
+      .to eql(s(:begin, s(:send, nil, :bar), s(:send, nil, :baz)))
+  end
+
+  it 'returns node' do
+    node = s(:sym, :node)
+    expect(described_class.new(node).to_node).to be(node)
+  end
+
+  context 'value object semantics' do
+    it 'compares by value' do # rubocop:disable RSpec/MultipleExpectations
+      aggregate_failures 'equality semantics' do
+        expect(example('it("foo")')).to eq(example('it("foo")'))
+        expect(example('it("foo")')).not_to eq(example('it("bar")'))
+      end
+    end
+
+    it 'can be used as a key in a hash' do
+      hash = {}
+
+      hash[example('it("foo")')] = 123
+
+      expect(hash[example('it("foo")')]).to be(123)
+    end
+
+    it 'computes #hash based on class and node' do
+      node = s(:node)
+
+      expect(described_class.new(node).hash)
+        .to eql([described_class, node].hash)
+    end
+  end
+end

data/spec/rubocop/rspec/language/selector_set_spec.rb

@@ -21,9 +21,29 @@ describe RuboCop::RSpec::Language::SelectorSet do
     end
   end
 
-  context '#to_node_pattern' do
+  context '#node_pattern' do
     it 'builds a node pattern' do
-      expect(selector_set.to_node_pattern).to eql(':foo :bar')
+      expect(selector_set.node_pattern).to eql(':foo :bar')
+    end
+  end
+
+  context '#node_pattern_union' do
+    it 'builds a node pattern union' do
+      expect(selector_set.node_pattern_union).to eql('{:foo :bar}')
+    end
+  end
+
+  context '#send_pattern' do
+    it 'builds a send matching pattern' do
+      expect(selector_set.send_pattern).to eql('(send _ {:foo :bar} ...)')
+    end
+  end
+
+  context '#block_pattern' do
+    it 'builds a block matching pattern' do
+      expect(selector_set.block_pattern).to eql(
+        '(block (send _ {:foo :bar} ...) ...)'
+      )
     end
   end
 end

data/spec/spec_helper.rb

@@ -3,8 +3,8 @@ require 'rubocop'
 require 'rubocop/rspec/support'
 
 if ENV['CI']
-  require 'codeclimate-test-reporter'
-  CodeClimate::TestReporter.start
+  require 'simplecov'
+  SimpleCov.start
 end
 
 module SpecHelper
@@ -17,13 +17,6 @@ Dir.glob(spec_helper_glob).map(&method(:require))
 RSpec.configure do |config|
   config.order = :random
 
-  # Define spec metadata for all rspec cop spec files
-  cop_specs = 'spec/rubocop/cop/rspec/'
-  config.define_derived_metadata(file_path: /\b#{cop_specs}/) do |metadata|
-    # Attach metadata that signals the specified code is for an RSpec only cop
-    metadata[:rspec_cop] = true
-  end
-
   config.expect_with :rspec do |expectations|
     expectations.syntax = :expect # Disable `should`
   end

data/spec/support/expect_violation.rb

@@ -29,10 +29,12 @@ module ExpectViolation
   private
 
   def to_assertion(offense)
+    highlight = offense.highlighted_area
+
     Expectation::Assertion.new(
       message:      offense.message,
-      line_number:  offense.location.line,
-      column_range: offense.location.column_range
+      line_number:  offense.location.first_line,
+      column_range: highlight.begin_pos...highlight.end_pos
     )
   end
 

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: rubocop-rspec
 version: !ruby/object:Gem::Version
-  version: 1.8.0
+  version: 1.9.0
 platform: ruby
 authors:
 - John Backus
@@ -10,7 +10,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2016-10-27 00:00:00.000000000 Z
+date: 2016-12-29 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rubocop
@@ -146,6 +146,7 @@ files:
 - lib/rubocop-rspec.rb
 - lib/rubocop/cop/rspec/any_instance.rb
 - lib/rubocop/cop/rspec/be_eql.rb
+- lib/rubocop/cop/rspec/cop.rb
 - lib/rubocop/cop/rspec/describe_class.rb
 - lib/rubocop/cop/rspec/describe_method.rb
 - lib/rubocop/cop/rspec/described_class.rb
@@ -162,20 +163,24 @@ files:
 - lib/rubocop/cop/rspec/let_setup.rb
 - lib/rubocop/cop/rspec/message_chain.rb
 - lib/rubocop/cop/rspec/message_expectation.rb
+- lib/rubocop/cop/rspec/message_spies.rb
 - lib/rubocop/cop/rspec/multiple_describes.rb
 - lib/rubocop/cop/rspec/multiple_expectations.rb
 - lib/rubocop/cop/rspec/named_subject.rb
 - lib/rubocop/cop/rspec/nested_groups.rb
 - lib/rubocop/cop/rspec/not_to_not.rb
+- lib/rubocop/cop/rspec/repeated_description.rb
+- lib/rubocop/cop/rspec/single_argument_message_chain.rb
 - lib/rubocop/cop/rspec/subject_stub.rb
 - lib/rubocop/cop/rspec/verified_doubles.rb
 - lib/rubocop/rspec.rb
 - lib/rubocop/rspec/config_formatter.rb
 - lib/rubocop/rspec/description_extractor.rb
+- lib/rubocop/rspec/example.rb
+- lib/rubocop/rspec/example_group.rb
 - lib/rubocop/rspec/inject.rb
 - lib/rubocop/rspec/language.rb
 - lib/rubocop/rspec/language/node_pattern.rb
-- lib/rubocop/rspec/spec_only.rb
 - lib/rubocop/rspec/top_level_describe.rb
 - lib/rubocop/rspec/util.rb
 - lib/rubocop/rspec/version.rb
@@ -187,6 +192,7 @@ files:
 - spec/project/project_requires_spec.rb
 - spec/rubocop/cop/rspec/any_instance_spec.rb
 - spec/rubocop/cop/rspec/be_eql_spec.rb
+- spec/rubocop/cop/rspec/cop_spec.rb
 - spec/rubocop/cop/rspec/describe_class_spec.rb
 - spec/rubocop/cop/rspec/describe_method_spec.rb
 - spec/rubocop/cop/rspec/described_class_spec.rb
@@ -203,22 +209,25 @@ files:
 - spec/rubocop/cop/rspec/let_setup_spec.rb
 - spec/rubocop/cop/rspec/message_chain_spec.rb
 - spec/rubocop/cop/rspec/message_expectation_spec.rb
+- spec/rubocop/cop/rspec/message_spies_spec.rb
 - spec/rubocop/cop/rspec/multiple_describes_spec.rb
 - spec/rubocop/cop/rspec/multiple_expectations_spec.rb
 - spec/rubocop/cop/rspec/named_subject_spec.rb
 - spec/rubocop/cop/rspec/nested_groups_spec.rb
 - spec/rubocop/cop/rspec/not_to_not_spec.rb
+- spec/rubocop/cop/rspec/repeated_description_spec.rb
+- spec/rubocop/cop/rspec/single_argument_message_chain_spec.rb
 - spec/rubocop/cop/rspec/subject_stub_spec.rb
 - spec/rubocop/cop/rspec/verified_doubles_spec.rb
 - spec/rubocop/rspec/config_formatter_spec.rb
 - spec/rubocop/rspec/description_extractor_spec.rb
+- spec/rubocop/rspec/example_group_spec.rb
+- spec/rubocop/rspec/example_spec.rb
 - spec/rubocop/rspec/language/selector_set_spec.rb
-- spec/rubocop/rspec/spec_only_spec.rb
 - spec/rubocop/rspec/util/one_spec.rb
 - spec/rubocop/rspec/wording_spec.rb
 - spec/shared/autocorrect_behavior.rb
 - spec/shared/detects_style_behavior.rb
-- spec/shared/rspec_only_cop_behavior.rb
 - spec/spec_helper.rb
 - spec/support/expect_violation.rb
 homepage: http://github.com/backus/rubocop-rspec
@@ -241,7 +250,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.6.6
+rubygems_version: 2.5.2
 signing_key: 
 specification_version: 4
 summary: Code style checking for RSpec files
@@ -252,6 +261,7 @@ test_files:
 - spec/project/project_requires_spec.rb
 - spec/rubocop/cop/rspec/any_instance_spec.rb
 - spec/rubocop/cop/rspec/be_eql_spec.rb
+- spec/rubocop/cop/rspec/cop_spec.rb
 - spec/rubocop/cop/rspec/describe_class_spec.rb
 - spec/rubocop/cop/rspec/describe_method_spec.rb
 - spec/rubocop/cop/rspec/described_class_spec.rb
@@ -268,21 +278,24 @@ test_files:
 - spec/rubocop/cop/rspec/let_setup_spec.rb
 - spec/rubocop/cop/rspec/message_chain_spec.rb
 - spec/rubocop/cop/rspec/message_expectation_spec.rb
+- spec/rubocop/cop/rspec/message_spies_spec.rb
 - spec/rubocop/cop/rspec/multiple_describes_spec.rb
 - spec/rubocop/cop/rspec/multiple_expectations_spec.rb
 - spec/rubocop/cop/rspec/named_subject_spec.rb
 - spec/rubocop/cop/rspec/nested_groups_spec.rb
 - spec/rubocop/cop/rspec/not_to_not_spec.rb
+- spec/rubocop/cop/rspec/repeated_description_spec.rb
+- spec/rubocop/cop/rspec/single_argument_message_chain_spec.rb
 - spec/rubocop/cop/rspec/subject_stub_spec.rb
 - spec/rubocop/cop/rspec/verified_doubles_spec.rb
 - spec/rubocop/rspec/config_formatter_spec.rb
 - spec/rubocop/rspec/description_extractor_spec.rb
+- spec/rubocop/rspec/example_group_spec.rb
+- spec/rubocop/rspec/example_spec.rb
 - spec/rubocop/rspec/language/selector_set_spec.rb
-- spec/rubocop/rspec/spec_only_spec.rb
 - spec/rubocop/rspec/util/one_spec.rb
 - spec/rubocop/rspec/wording_spec.rb
 - spec/shared/autocorrect_behavior.rb
 - spec/shared/detects_style_behavior.rb
-- spec/shared/rspec_only_cop_behavior.rb
 - spec/spec_helper.rb
 - spec/support/expect_violation.rb