rubocop-rspec 1.6.0 → 1.7.0

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.6.0'.freeze
+      STRING = '1.7.0'.freeze
     end
   end
 end

data/rubocop-rspec.gemspec

@@ -38,4 +38,5 @@ Gem::Specification.new do |spec|
   spec.add_development_dependency 'anima'
   spec.add_development_dependency 'concord'
   spec.add_development_dependency 'adamantium'
+  spec.add_development_dependency 'yard'
 end

data/spec/project/changelog_spec.rb

@@ -0,0 +1,81 @@
+describe 'CHANGELOG.md' do
+  subject(:changelog) { SpecHelper::ROOT.join('CHANGELOG.md').read }
+
+  it 'has link definitions for all implicit links' do
+    implicit_link_names = changelog.scan(/\[([^\]]+)\]\[\]/).flatten.uniq
+    implicit_link_names.each do |name|
+      expect(changelog).to include("[#{name}]: http")
+    end
+  end
+
+  describe 'entry' do
+    subject(:entries) { lines.grep(/^\*/).map(&:chomp) }
+    let(:lines) { changelog.each_line }
+
+    it 'has a whitespace between the * and the body' do
+      entries.each do |entry|
+        expect(entry).to match(/^\* \S/)
+      end
+    end
+
+    it 'has a link to the contributors at the end' do
+      entries.each do |entry|
+        expect(entry).to match(/\(\[@\S+\]\[\](?:, \[@\S+\]\[\])*\)$/)
+      end
+    end
+
+    describe 'link to related issue on github' do
+      let(:issues) do
+        entries.map do |entry|
+          entry.match(/\[(?<number>[#\d]+)\]\((?<url>[^\)]+)\)/)
+        end.compact
+      end
+
+      it 'has an issue number prefixed with #' do
+        issues.each do |issue|
+          expect(issue[:number]).to match(/^#\d+$/)
+        end
+      end
+
+      it 'has a valid URL' do
+        issues.each do |issue|
+          number = issue[:number].gsub(/\D/, '')
+          pattern = %r{^https://github\.com/.+/.+/(?:issues|pull)/#{number}$} # rubocop:disable LineLength
+          expect(issue[:url]).to match(pattern)
+        end
+      end
+
+      it 'has a colon and a whitespace at the end' do
+        entries_including_issue_link = entries.select do |entry|
+          entry.match(/^\*\s*\[/)
+        end
+
+        entries_including_issue_link.each do |entry|
+          expect(entry).to include('): ')
+        end
+      end
+    end
+
+    describe 'body' do
+      let(:bodies) do
+        entries.map do |entry|
+          entry
+            .sub(/^\*\s*(?:\[.+?\):\s*)?/, '')
+            .sub(/\s*\([^\)]+\)$/, '')
+        end
+      end
+
+      it 'does not start with a lower case' do
+        bodies.each do |body|
+          expect(body).not_to match(/^[a-z]/)
+        end
+      end
+
+      it 'ends with a punctuation' do
+        bodies.each do |body|
+          expect(body).to match(/[\.\!]$/)
+        end
+      end
+    end
+  end
+end

data/spec/project/default_config_spec.rb

@@ -0,0 +1,52 @@
+describe 'config/default.yml' do
+  subject(:default_config) do
+    RuboCop::ConfigLoader.load_file('config/default.yml')
+  end
+
+  let(:cop_names) do
+    glob = SpecHelper::ROOT.join('lib', 'rubocop', 'cop', 'rspec', '*.rb')
+
+    Pathname.glob(glob).map do |file|
+      file_name = file.basename('.rb').to_s
+      cop_name  = file_name.gsub(/(^|_)(.)/) { Regexp.last_match(2).upcase }
+
+      "RSpec/#{cop_name}"
+    end
+  end
+
+  let(:config_keys) do
+    cop_names + %w(AllCops)
+  end
+
+  def cop_configuration(config_key)
+    cop_names.map do |cop_name|
+      cop_config = default_config.fetch(cop_name)
+
+      cop_config.fetch(config_key) do
+        raise "Expected #{cop_name} to have #{config_key} configuration key"
+      end
+    end
+  end
+
+  it 'has configuration for all cops' do
+    expect(default_config.keys.sort).to eq(config_keys.sort)
+  end
+
+  it 'has descriptions for all cops' do
+    expect(cop_configuration('Description')).to all(be_a(String))
+  end
+
+  it 'does not have newlines in cop descriptions' do
+    cop_configuration('Description').each do |value|
+      expect(value).not_to include("\n")
+    end
+  end
+
+  it 'ends every description with a period' do
+    expect(cop_configuration('Description')).to all(end_with('.'))
+  end
+
+  it 'includes Enabled: true for every cop' do
+    expect(cop_configuration('Enabled')).to all(be(true))
+  end
+end

data/spec/project/project_requires_spec.rb

@@ -0,0 +1,8 @@
+describe 'Project requires' do
+  it 'alphabetizes cop requires' do
+    source   = SpecHelper::ROOT.join('lib', 'rubocop-rspec.rb').read
+    requires = source.split("\n").grep(%r{rubocop/cop})
+
+    expect(requires.join("\n")).to eql(requires.sort.join("\n"))
+  end
+end

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

@@ -0,0 +1,59 @@
+describe RuboCop::Cop::RSpec::BeEql do
+  subject(:cop) { described_class.new }
+
+  it 'registers an offense for `eql` when argument is a boolean' do
+    expect_violation(<<-RUBY)
+      it { expect(foo).to eql(true) }
+                          ^^^ Prefer `be` over `eql`
+      it { expect(foo).to eql(false) }
+                          ^^^ Prefer `be` over `eql`
+    RUBY
+  end
+
+  it 'registers an offense for `eql` when argument is an integer' do
+    expect_violation(<<-RUBY)
+      it { expect(foo).to eql(0) }
+                          ^^^ Prefer `be` over `eql`
+      it { expect(foo).to eql(123) }
+                          ^^^ Prefer `be` over `eql`
+    RUBY
+  end
+
+  it 'registers an offense for `eql` when argument is a float' do
+    expect_violation(<<-RUBY)
+      it { expect(foo).to eql(1.0) }
+                          ^^^ Prefer `be` over `eql`
+      it { expect(foo).to eql(1.23) }
+                          ^^^ Prefer `be` over `eql`
+    RUBY
+  end
+
+  it 'registers an offense for `eql` when argument is a symbol' do
+    expect_violation(<<-RUBY)
+      it { expect(foo).to eql(:foo) }
+                          ^^^ Prefer `be` over `eql`
+    RUBY
+  end
+
+  it 'does not register an offense for `eql` when argument is a string' do
+    expect_no_violations(<<-RUBY)
+      it { expect(foo).to eql('foo') }
+    RUBY
+  end
+
+  it 'does not register an offense for `eql` when expectation is negated' do
+    expect_no_violations(<<-RUBY)
+      it { expect(foo).to_not eql(1) }
+    RUBY
+  end
+
+  it 'autocorrects offense to use `be`' do
+    corrected =
+      autocorrect_source(
+        cop,
+        ['it { expect(foo).to eql(1) }'],
+        'spec/foo_spec.rb'
+      )
+    expect(corrected).to eq 'it { expect(foo).to be(1) }'
+  end
+end

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

@@ -92,7 +92,7 @@ describe RuboCop::Cop::RSpec::DescribedClass, :config do
     RUBY
   end
 
-  it 'ignores describe that do not referece to a class' do
+  it 'ignores describe that do not reference to a class' do
     expect_no_violations(<<-RUBY)
       describe "MyClass" do
         subject { "MyClass" }
@@ -204,7 +204,7 @@ describe RuboCop::Cop::RSpec::DescribedClass, :config do
         '  subject { MyClass.do_something }',
         '  before { MyClass.do_something }',
         'end'
-      ]
+      ], 'spec/foo_spec.rb'
     )
     expect(new_source).to eq(
       [

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

@@ -0,0 +1,79 @@
+# frozen_string_literal: true
+
+describe RuboCop::Cop::RSpec::EmptyExampleGroup, :config do
+  subject(:cop) { described_class.new(config) }
+
+  it 'flags an empty context' do
+    expect_violation(<<-RUBY)
+      describe Foo do
+        context 'when bar' do
+        ^^^^^^^^^^^^^^^^^^ Empty example group detected.
+
+          let(:foo) { bar }
+        end
+
+        describe '#thingy?' do
+          specify do
+            expect(whatever.thingy?).to be(true)
+          end
+        end
+
+        it { should be_true }
+      end
+    RUBY
+  end
+
+  it 'flags an empty top level describe' do
+    expect_violation(<<-RUBY)
+      describe Foo do
+      ^^^^^^^^^^^^ Empty example group detected.
+      end
+    RUBY
+  end
+
+  it 'does not flag include_examples' do
+    expect_no_violations(<<-RUBY)
+      describe Foo do
+        context "when something is true" do
+          include_examples "some expectations"
+        end
+
+        context "when something else is true" do
+          include_context "some expectations"
+        end
+
+        context "when a third thing is true" do
+          it_behaves_like "some thingy"
+        end
+      end
+    RUBY
+  end
+
+  it 'does not recognize custom include methods by default' do
+    expect_violation(<<-RUBY)
+      describe Foo do
+      ^^^^^^^^^^^^ Empty example group detected.
+        context "when I do something clever" do
+        ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ Empty example group detected.
+          it_has_special_behavior
+        end
+      end
+    RUBY
+  end
+
+  context 'when a custom include method is specified' do
+    let(:cop_config) do
+      { 'CustomIncludeMethods' => %w(it_has_special_behavior) }
+    end
+
+    it 'does not flag an otherwise empty example group' do
+      expect_no_violations(<<-RUBY)
+        describe Foo do
+          context "when I do something clever" do
+            it_has_special_behavior
+          end
+        end
+      RUBY
+    end
+  end
+end

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

@@ -1,5 +1,6 @@
 describe RuboCop::Cop::RSpec::ExampleLength, :config do
   subject(:cop) { described_class.new(config) }
+
   let(:cop_config) { { 'Max' => 3 } }
 
   it 'ignores non-spec blocks' do
@@ -12,7 +13,8 @@ describe RuboCop::Cop::RSpec::ExampleLength, :config do
         '  line 3',
         '  line 4',
         'end'
-      ]
+      ],
+      'foo_spec.rb'
     )
 
     expect(cop.offenses).to be_empty
@@ -24,7 +26,8 @@ describe RuboCop::Cop::RSpec::ExampleLength, :config do
       [
         'it do',
         'end'
-      ]
+      ],
+      'foo_spec.rb'
     )
     expect(cop.offenses).to be_empty
   end
@@ -38,60 +41,77 @@ describe RuboCop::Cop::RSpec::ExampleLength, :config do
         '  line 2',
         '  line 3',
         'end'
-      ]
+      ],
+      'spec/foo_spec.rb'
     )
     expect(cop.offenses).to be_empty
   end
 
-  it "doesn't allow a long example" do
+  it 'ignores comments' do
     inspect_source(
       cop,
       [
         'it do',
         '  line 1',
         '  line 2',
+        '  # comment',
         '  line 3',
-        '  line 4',
         'end'
-      ]
+      ],
+      'spec/foo_spec.rb'
     )
-    expect(cop.offenses.size).to eq(1)
-    expect(cop.offenses.map(&:line).sort).to eq([1])
-    expect(cop.messages).to eq(['Example has too many lines. [4/3]'])
+    expect(cop.offenses).to be_empty
   end
 
-  it 'ignores comments' do
-    inspect_source(
-      cop,
+  shared_examples 'large example violation' do
+    before do
+      inspect_source(cop, source, 'spec/foo_spec.rb')
+    end
+
+    it 'flags an offense' do
+      expect(cop.offenses.size).to eq(1)
+    end
+
+    it 'registers the offense on line 1' do
+      expect(cop.offenses.map(&:line)).to eq([1])
+    end
+
+    it 'adds a message saying the example has too many lines' do
+      expect(cop.messages).to eq(['Example has too many lines. [4/3]'])
+    end
+  end
+
+  context 'when inspecting large examples' do
+    let(:source) do
       [
         'it do',
         '  line 1',
         '  line 2',
-        '  # comment',
         '  line 3',
+        '  line 4',
         'end'
       ]
-    )
-    expect(cop.offenses).to be_empty
+    end
+
+    include_examples 'large example violation'
   end
 
   context 'with CountComments enabled' do
-    before { cop_config['CountComments'] = true }
+    let(:cop_config) do
+      { 'Max' => 3, 'CountComments' => true }
+    end
 
-    it 'counts comments' do
-      inspect_source(
-        cop, [
-          'it do',
-          '  line 1',
-          '  line 2',
-          '  # comment',
-          '  line 3',
-          'end'
-        ]
-      )
-      expect(cop.offenses.size).to eq(1)
-      expect(cop.offenses.map(&:line).sort).to eq([1])
-      expect(cop.messages).to eq(['Example has too many lines. [4/3]'])
+    let(:source) do
+      [
+        'it do',
+        '  line 1',
+        '  line 2',
+        '  # comment',
+        '  line 3',
+        'end'
+      ]
     end
+
+    include_examples 'large example violation'
   end
 end