rubocop-rspec 1.5.2 → 1.5.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 41d29a68e96541d0d09976b9cdc582f4c468a447
-  data.tar.gz: d38ae28874032c3035a8fd78e6865dfece308fe6
+  metadata.gz: 7a5f78eba0374bbe357f1de4227be9e3b6282116
+  data.tar.gz: 20fa1701861557f4c615613a9f3fe3300a758ac1
 SHA512:
-  metadata.gz: 109b7e39672639b8aeb325439b0501dcec5d9e96eecde7b014cbe5647403bc5d8715a6499bfe9a5ea86bd8ec05f94f17cd75a0c59d9f1882031b3463961fe92b
-  data.tar.gz: 3bb0205007875394a79cc08782dd82ce7186238e155ec18b7078a59aef9572ff8804cc252027f6c2977415fe200605f0741688011a6845ec0eb276e163a3e37d
+  metadata.gz: 098e42022cd531df17726bc09d7d392b990d08b63c22e59a4b71e28f7a7cc23613688d93fc1f5edc97cb9e97cea1bab92d6a03ddaa0405f74e822e74e02c7744
+  data.tar.gz: 2461baf4ad9f1eadff4264a786bdeff878a50c164ac6576558ebabdd2b2e7870a5cc05996d419a499e9c97d7f7b32be67fd645e16f0a6c233fccb53adb0a1b15

data/CHANGELOG.md

@@ -2,6 +2,10 @@
 
 ## Master (unreleased)
 
+## 1.5.3 (2016-08-02)
+
+* Add `RSpec/NamedSubject` cop. ([@backus][])
+
 ## 1.5.2 (2016-08-01)
 
 * Drop support for ruby `2.0.0` and `2.1.0`. ([@backus][])

data/config/default.yml

@@ -60,3 +60,7 @@ RSpec/ExampleLength:
   Description: 'Checks for long example'
   Enabled: true
   Max: 5
+
+RSpec/NamedSubject:
+  Description: 'Name your RSpec subject if you reference it explicitly'
+  Enabled: true

data/lib/rubocop-rspec.rb

@@ -19,5 +19,6 @@ require 'rubocop/cop/rspec/focus'
 require 'rubocop/cop/rspec/instance_variable'
 require 'rubocop/cop/rspec/example_length'
 require 'rubocop/cop/rspec/multiple_describes'
+require 'rubocop/cop/rspec/named_subject'
 require 'rubocop/cop/rspec/not_to_not'
 require 'rubocop/cop/rspec/verified_doubles'

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

@@ -0,0 +1,67 @@
+# frozen_string_literal: true
+
+module RuboCop
+  module Cop
+    module RSpec
+      # Give `subject` a descriptive name if you reference it directly
+      #
+      # @example
+      #   # bad
+      #   RSpec.describe User do
+      #     subject { described_class.new }
+      #
+      #     it 'is valid' do
+      #       expect(subject.valid?).to be(true)
+      #     end
+      #   end
+      #
+      #   # good
+      #   RSpec.describe Foo do
+      #     subject(:user) { described_class.new }
+      #
+      #     it 'is valid' do
+      #       expect(user.valid?).to be(true)
+      #     end
+      #   end
+      #
+      #   # also good
+      #   RSpec.describe Foo do
+      #     subject(:user) { described_class.new }
+      #
+      #     it { should be_valid }
+      #   end
+      class NamedSubject < Cop
+        MSG = 'Name your test subject if '\
+              'you need to reference it explicitly.'.freeze
+
+        def_node_matcher :rspec_block?, <<-PATTERN
+          (block
+            (send nil {:it :specify :before :after :around} ...)
+            ...)
+        PATTERN
+
+        def_node_matcher :unnamed_subject, '$(send nil :subject)'
+
+        def on_block(node)
+          return unless rspec_block?(node)
+
+          subject_usage(node) do |subject_node|
+            add_offense(subject_node, :selector)
+          end
+        end
+
+        private
+
+        def subject_usage(node, &block)
+          return unless node.instance_of?(Node)
+
+          unnamed_subject(node, &block)
+
+          node.children.each do |child|
+            subject_usage(child, &block)
+          end
+        end
+      end
+    end
+  end
+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.5.2'.freeze
+      STRING = '1.5.3'.freeze
     end
   end
 end

data/rubocop-rspec.gemspec

@@ -35,4 +35,7 @@ Gem::Specification.new do |spec|
   spec.add_development_dependency 'rake'
   spec.add_development_dependency 'rspec', '>= 3.4'
   spec.add_development_dependency 'simplecov'
+  spec.add_development_dependency 'anima'
+  spec.add_development_dependency 'concord'
+  spec.add_development_dependency 'adamantium'
 end

data/spec/expect_violation/expectation_spec.rb

@@ -0,0 +1,85 @@
+# frozen_string_literal: true
+
+RSpec.describe ExpectViolation::Expectation do
+  subject(:expectation) { described_class.new(string) }
+
+  context 'when given a single assertion on class end' do
+    let(:string) do
+      <<-SRC
+      class Foo
+      end
+      ^^^ The end of `Foo` should be annotated.
+      SRC
+    end
+
+    let(:assertion) { expectation.assertions.first }
+
+    it 'has one assertion' do
+      expect(expectation.assertions.size).to be(1)
+    end
+
+    it 'has an assertion on line 2' do
+      expect(assertion.line_number).to be(2)
+    end
+
+    it 'has an assertion on column range 1-3' do
+      expect(assertion.column_range).to eql(6...9)
+    end
+
+    it 'has an assertion with correct violation message' do
+      expect(assertion.message).to eql('The end of `Foo` should be annotated.')
+    end
+
+    it 'recreates source' do
+      expect(expectation.source).to eql(<<-RUBY)
+      class Foo
+      end
+      RUBY
+    end
+  end
+
+  context 'when given many assertions on two lines' do
+    let(:string) do
+      <<-SRC
+      foo bar
+          ^ Charlie
+         ^^ Charlie
+          ^^ Bronco
+          ^^ Alpha
+      baz
+      ^ Delta
+      SRC
+    end
+
+    let(:assertions) { expectation.assertions.sort }
+
+    it 'has two assertions' do
+      expect(expectation.assertions.size).to be(5)
+    end
+
+    it 'has assertions on lines 1 and 2' do
+      expect(assertions.map(&:line_number)).to eql(
+        [1, 1, 1, 1, 2]
+      )
+    end
+
+    it 'has assertions on column range 1-3' do
+      expect(assertions.map(&:column_range)).to eql(
+        [9...11, 10...11, 10...12, 10...12, 6...7]
+      )
+    end
+
+    it 'has an assertion with correct violation message' do
+      expect(assertions.map(&:message)).to eql(
+        %w(Charlie Charlie Alpha Bronco Delta)
+      )
+    end
+
+    it 'recreates source' do
+      expect(expectation.source).to eql(<<-RUBY)
+      foo bar
+      baz
+      RUBY
+    end
+  end
+end

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

@@ -2,47 +2,29 @@ describe RuboCop::Cop::RSpec::AnyInstance do
   subject(:cop) { described_class.new }
 
   it 'finds `allow_any_instance_of` instead of an instance double' do
-    inspect_source(
-      cop,
-      [
-        'before do',
-        '  allow_any_instance_of(Object).to receive(:foo)',
-        'end'
-      ]
-    )
-    expect(cop.messages)
-      .to eq(['Avoid stubbing using `allow_any_instance_of`'])
-    expect(cop.highlights).to eq(['allow_any_instance_of(Object)'])
-    expect(cop.offenses.map(&:line).sort).to eq([2])
+    expect_violation(<<-RUBY)
+      before do
+        allow_any_instance_of(Object).to receive(:foo)
+        ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ Avoid stubbing using `allow_any_instance_of`
+      end
+    RUBY
   end
 
   it 'finds `expect_any_instance_of` instead of an instance double' do
-    inspect_source(
-      cop,
-      [
-        'before do',
-        '  expect_any_instance_of(Object).to receive(:foo)',
-        'end'
-      ]
-    )
-    expect(cop.messages)
-      .to eq(['Avoid stubbing using `expect_any_instance_of`'])
-    expect(cop.highlights).to eq(['expect_any_instance_of(Object)'])
-    expect(cop.offenses.map(&:line).sort).to eq([2])
+    expect_violation(<<-RUBY)
+      before do
+        expect_any_instance_of(Object).to receive(:foo)
+        ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ Avoid stubbing using `expect_any_instance_of`
+      end
+    RUBY
   end
 
   it 'finds old `any_instance` syntax instead of an instance double' do
-    inspect_source(
-      cop,
-      [
-        'before do',
-        '  Object.any_instance.should_receive(:foo)',
-        'end'
-      ]
-    )
-    expect(cop.messages)
-      .to eq(['Avoid stubbing using `any_instance`'])
-    expect(cop.highlights).to eq(['Object.any_instance'])
-    expect(cop.offenses.map(&:line).sort).to eq([2])
+    expect_violation(<<-RUBY)
+      before do
+        Object.any_instance.should_receive(:foo)
+        ^^^^^^^^^^^^^^^^^^^ Avoid stubbing using `any_instance`
+      end
+    RUBY
   end
 end

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

@@ -2,109 +2,112 @@ describe RuboCop::Cop::RSpec::DescribeClass do
   subject(:cop) { described_class.new }
 
   it 'checks first-line describe statements' do
-    inspect_source(cop, 'describe "bad describe" do; end')
-    expect(cop.offenses.size).to eq(1)
-    expect(cop.offenses.map(&:line).sort).to eq([1])
-    expect(cop.messages).to eq(['The first argument to describe should be ' \
-                                'the class or module being tested.'])
+    expect_violation(<<-RUBY)
+      describe "bad describe" do
+               ^^^^^^^^^^^^^^ The first argument to describe should be the class or module being tested.
+      end
+    RUBY
   end
 
   it 'supports RSpec.describe' do
-    inspect_source(cop, 'RSpec.describe Foo do; end')
-    expect(cop.offenses).to be_empty
+    expect_no_violations(<<-RUBY)
+      RSpec.describe Foo do
+      end
+    RUBY
   end
 
   it 'checks describe statements after a require' do
-    inspect_source(
-      cop,
-      [
-        "require 'spec_helper'",
-        'describe "bad describe" do; end'
-      ]
-    )
-    expect(cop.offenses.size).to eq(1)
-    expect(cop.offenses.map(&:line).sort).to eq([2])
-    expect(cop.messages).to eq(['The first argument to describe should be ' \
-                                'the class or module being tested.'])
+    expect_violation(<<-RUBY)
+      require 'spec_helper'
+      describe "bad describe" do
+               ^^^^^^^^^^^^^^ The first argument to describe should be the class or module being tested.
+      end
+    RUBY
   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)
+    expect_violation(<<-RUBY)
+      describe "bad describe", "blah blah" do
+               ^^^^^^^^^^^^^^ The first argument to describe should be the class or module being tested.
+      end
+    RUBY
   end
 
   it 'ignores nested describe statements' do
-    inspect_source(
-      cop,
-      [
-        'describe Some::Class do',
-        '  describe "bad describe" do; end',
-        'end'
-      ]
-    )
-    expect(cop.offenses).to be_empty
+    expect_no_violations(<<-RUBY)
+      describe Some::Class do
+        describe "bad describe" do
+        end
+      end
+    RUBY
   end
 
   it 'ignores request specs' do
-    inspect_source(cop, "describe 'my new feature', type: :request do; end")
-    expect(cop.offenses).to be_empty
+    expect_no_violations(<<-RUBY)
+      describe 'my new feature', type: :request do
+      end
+    RUBY
   end
 
   it 'ignores feature specs' do
-    inspect_source(cop, "describe 'my new feature', type: :feature do; end")
-    expect(cop.offenses).to be_empty
+    expect_no_violations(<<-RUBY)
+      describe 'my new feature', type: :feature do
+      end
+    RUBY
   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
+    expect_no_violations(<<-RUBY)
+      RSpec.describe 'my new feature', type: :feature do
+      end
+    RUBY
   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.'])
+    expect_violation(<<-RUBY)
+      describe 'my new feature', foo: :feature do
+               ^^^^^^^^^^^^^^^^ The first argument to describe should be the class or module being tested.
+      end
+    RUBY
   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.'])
+    expect_violation(<<-RUBY)
+      describe 'my new feature', blah, type: :wow do
+               ^^^^^^^^^^^^^^^^ The first argument to describe should be the class or module being tested.
+      end
+    RUBY
   end
 
   it 'ignores feature specs - also with complex options' do
-    inspect_source(
-      cop,
-      [
-        "describe 'my new feature',",
-        '  :test, :type => :feature, :foo => :bar do;',
-        'end'
-      ]
-    )
-    expect(cop.offenses).to be_empty
+    expect_no_violations(<<-RUBY)
+      describe 'my new feature', :test, :type => :feature, :foo => :bar do
+      end
+    RUBY
   end
 
   it 'ignores an empty describe' do
-    inspect_source(cop, 'describe do; end')
-    expect(cop.offenses).to be_empty
+    expect_no_violations(<<-RUBY)
+      describe do
+      end
+    RUBY
   end
 
   it 'ignores routing specs' do
-    inspect_source(cop, "describe 'my new route', type: :routing do; end")
-    expect(cop.offenses).to be_empty
+    expect_no_violations(<<-RUBY)
+      describe 'my new route', type: :routing do
+      end
+    RUBY
   end
 
   it 'ignores view specs' do
-    inspect_source(cop, "describe 'widgets/index', type: :view do; end")
-    expect(cop.offenses).to be_empty
+    expect_no_violations(<<-RUBY)
+      describe 'widgets/index', type: :view do
+      end
+    RUBY
   end
 
   it "doesn't blow up on single-line describes" do
-    inspect_source(cop, 'describe Some::Class')
-    expect(cop.offenses).to be_empty
+    expect_no_violations('describe Some::Class')
   end
 end