rubocop-rspec 1.6.0 → 1.7.0

data/spec/rubocop/rspec/config_formatter_spec.rb

@@ -0,0 +1,48 @@
+require 'rubocop/rspec/config_formatter'
+
+RSpec.describe RuboCop::RSpec::ConfigFormatter do
+  let(:config) do
+    {
+      'AllCops' => {
+        'Setting' => 'fourty two'
+      },
+      'RSpec/Foo' => {
+        'Config'      => 2,
+        'Enabled'     => true
+      },
+      'RSpec/Bar' => {
+        'Enabled'     => true
+      }
+    }
+  end
+
+  let(:descriptions) do
+    {
+      'RSpec/Foo' => {
+        'Description' => 'Blah'
+      },
+      'RSpec/Bar' => {
+        'Description' => 'Wow'
+      }
+    }
+  end
+
+  it 'builds a YAML dump with spacing between cops' do
+    formatter = described_class.new(config, descriptions)
+
+    expect(formatter.dump).to eql(<<-YAML.gsub(/^\s+\|/, ''))
+    |---
+    |AllCops:
+    |  Setting: fourty two
+    |
+    |RSpec/Foo:
+    |  Config: 2
+    |  Enabled: true
+    |  Description: Blah
+    |
+    |RSpec/Bar:
+    |  Enabled: true
+    |  Description: Wow
+    YAML
+  end
+end

data/spec/rubocop/rspec/description_extractor_spec.rb

@@ -0,0 +1,35 @@
+require 'yard'
+
+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
+      )
+    ]
+  end
+
+  it 'builds a hash of descriptions' do
+    expect(described_class.new(yardocs).to_h)
+      .to eql('RSpec/Foo' => { 'Description' => 'Checks foo' })
+  end
+end

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

@@ -0,0 +1,29 @@
+describe RuboCop::RSpec::Language::SelectorSet do
+  subject(:selector_set) { described_class.new(%i(foo bar)) }
+
+  it 'composes sets' do
+    combined = selector_set + described_class.new(%i(baz))
+
+    expect(combined).to eq(described_class.new(%i(foo bar baz)))
+  end
+
+  it 'compares by value' do
+    expect(selector_set).not_to eq(described_class.new(%i(foo bar baz)))
+  end
+
+  context '#include?' do
+    it 'returns false for selectors not in the set' do
+      expect(selector_set.include?(:baz)).to be(false)
+    end
+
+    it 'returns true for selectors in the set' do
+      expect(selector_set.include?(:foo)).to be(true)
+    end
+  end
+
+  context '#to_node_pattern' do
+    it 'builds a node pattern' do
+      expect(selector_set.to_node_pattern).to eql(':foo :bar')
+    end
+  end
+end

data/spec/rubocop/rspec/spec_only_spec.rb

@@ -0,0 +1,97 @@
+# frozen_string_literal: true
+
+RSpec.describe RuboCop::RSpec::SpecOnly do
+  subject(:cop) { fake_cop.new(config) }
+
+  let(:config) do
+    rubocop_config =
+      {
+        'AllCops' => {
+          'RSpec' => {
+            'Patterns' => rspec_patterns
+          }
+        },
+        'RSpec/FakeCop' => {
+          'Exclude' => %w(bar_spec.rb)
+        }
+      }
+
+    RuboCop::Config.new(rubocop_config, 'fake_cop_config.yml')
+  end
+
+  let(:fake_cop) do
+    Class.new(RuboCop::Cop::Cop) do
+      include RuboCop::RSpec::SpecOnly
+
+      def self.name
+        'RuboCop::RSpec::FakeCop'
+      end
+
+      def on_send(node)
+        add_offense(node, :expression, 'I flag everything')
+      end
+    end
+  end
+
+  let(:rspec_patterns) { ['_spec.rb$', '(?:^|/)spec/'] }
+
+  context 'when the source path ends with `_spec.rb`' do
+    it 'registers an offense' do
+      expect_violation(<<-RUBY, filename: 'foo_spec.rb')
+        foo(1)
+        ^^^^^^ I flag everything
+      RUBY
+    end
+
+    it 'ignores the file if it is ignored' do
+      expect_no_violations(<<-RUBY, filename: 'bar_spec.rb')
+        foo(1)
+      RUBY
+    end
+  end
+
+  context 'when the source path contains `/spec/`' do
+    it 'registers an offense' do
+      expect_violation(<<-RUBY, filename: '/spec/support/thing.rb')
+        foo(1)
+        ^^^^^^ I flag everything
+      RUBY
+    end
+  end
+
+  context 'when the source path starts with `spec/`' do
+    it 'registers an offense' do
+      expect_violation(<<-RUBY, filename: 'spec/support/thing.rb')
+        foo(1)
+        ^^^^^^ I flag everything
+      RUBY
+    end
+  end
+
+  context 'when the file is a source file without "spec" in the name' do
+    it 'ignores the source when the path is not a spec file' do
+      expect_no_violations(<<-RUBY, filename: 'foo.rb')
+        foo(1)
+      RUBY
+    end
+
+    it 'ignores the source when the path is not a specified pattern' do
+      expect_no_violations(<<-RUBY, filename: 'foo_test.rb')
+        foo(1)
+      RUBY
+    end
+  end
+
+  context 'when custom patterns are specified' do
+    let(:rspec_patterns) do
+      ['_test\.rb$']
+    end
+
+    it 'registers offenses when the path matches a custom specified pattern' do
+      expect_violation(<<-RUBY, filename: 'foo_test.rb')
+        foo(1)
+        ^^^^^^ I flag everything
+      RUBY
+    end
+  end
+end

data/spec/shared/rspec_only_cop_behavior.rb

@@ -0,0 +1,68 @@
+module SpecHelper
+  # Provides a helper method for checking that `cop` works
+  #
+  # @note this is defined in a module so that the failure message can be
+  #   a constant without creating a bunch of warnings when the shared
+  #   context is included
+  #
+  module CheckCop
+    CURRENT_FILE = Pathname.new(__FILE__).relative_path_from(ROOT).freeze
+
+    FAILURE = <<-MSG.freeze
+      Attempting to access `cop` produced the following error:
+
+        %<exception>s
+
+      The shared context under #{CURRENT_FILE} is included for all RSpec
+      cops. This context expects you to define a subject named `cop` like so:
+
+        describe RuboCop::Cop::RSpec::SomeCheck do
+          subject(:cop) { described_class.new }
+
+          ...
+        end
+
+      or if your cop is configurable you should have something like:
+
+        describe RuboCop::Cop::RSpec::SomeConfigurableCheck, :config do
+          subject(:cop) { described_class.new(config) }
+
+          let(:cop_config) do
+            { 'EnforcedStyle' => 'fancy', 'WhateverElse' => 'YouNeed' }
+          end
+
+          ...
+        end
+
+      This error likely means that you either don't define `cop` at the top
+      level or you have dependent definitions (like `cop_config`) that are not
+      defined at the top level.
+    MSG
+
+    # This method exists to reduce confusion for contributors. It is important
+    # that these shared examples are automatically included for all cops but
+    # it is easy for these to fail if you don't realize that your top level
+    # describe needs to define a useable `cop` subject.
+    def check_cop_definition
+      cop
+    rescue => exception
+      raise format(FAILURE, exception: exception)
+    end
+  end
+end
+
+RSpec.shared_examples 'an rspec only cop', rspec_cop: true do
+  include SpecHelper::CheckCop
+
+  before do
+    check_cop_definition
+  end
+
+  it 'does not deem lib/feature/thing.rb to be a relevant file' do
+    expect(cop.relevant_file?('lib/feature/thing.rb')).to be_falsey
+  end
+
+  it 'deems spec/feature/thing_spec.rb to be a relevant file' do
+    expect(cop.relevant_file?('spec/feature/thing_spec.rb')).to be(true)
+  end
+end

data/spec/spec_helper.rb

@@ -7,11 +7,23 @@ if ENV['CI']
   CodeClimate::TestReporter.start
 end
 
-Dir.glob(File.expand_path('support/*.rb', __dir__)).map(&method(:require))
+module SpecHelper
+  ROOT = Pathname.new(__dir__).parent.freeze
+end
+
+spec_helper_glob = File.expand_path('{support,shared}/*.rb', __dir__)
+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

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: rubocop-rspec
 version: !ruby/object:Gem::Version
-  version: 1.6.0
+  version: 1.7.0
 platform: ruby
 authors:
 - Ian MacLeod
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2016-08-03 00:00:00.000000000 Z
+date: 2016-08-24 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rubocop
@@ -109,6 +109,20 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
+- !ruby/object:Gem::Dependency
+  name: yard
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
 description: |2
       Code style checking for RSpec files.
       A plugin for the RuboCop code style enforcing & linting tool.
@@ -129,41 +143,76 @@ files:
 - config/default.yml
 - lib/rubocop-rspec.rb
 - lib/rubocop/cop/rspec/any_instance.rb
+- lib/rubocop/cop/rspec/be_eql.rb
 - lib/rubocop/cop/rspec/describe_class.rb
 - lib/rubocop/cop/rspec/describe_method.rb
 - lib/rubocop/cop/rspec/described_class.rb
+- lib/rubocop/cop/rspec/empty_example_group.rb
 - lib/rubocop/cop/rspec/example_length.rb
 - lib/rubocop/cop/rspec/example_wording.rb
+- lib/rubocop/cop/rspec/expect_actual.rb
 - lib/rubocop/cop/rspec/file_path.rb
 - lib/rubocop/cop/rspec/focus.rb
+- lib/rubocop/cop/rspec/hook_argument.rb
 - lib/rubocop/cop/rspec/instance_variable.rb
+- lib/rubocop/cop/rspec/leading_subject.rb
+- 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/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/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/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
 - lib/rubocop/rspec/wording.rb
 - rubocop-rspec.gemspec
 - spec/expect_violation/expectation_spec.rb
-- spec/project_spec.rb
+- spec/project/changelog_spec.rb
+- spec/project/default_config_spec.rb
+- 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/describe_class_spec.rb
 - spec/rubocop/cop/rspec/describe_method_spec.rb
 - spec/rubocop/cop/rspec/described_class_spec.rb
+- spec/rubocop/cop/rspec/empty_example_group_spec.rb
 - spec/rubocop/cop/rspec/example_length_spec.rb
 - spec/rubocop/cop/rspec/example_wording_spec.rb
+- spec/rubocop/cop/rspec/expect_actual_spec.rb
 - spec/rubocop/cop/rspec/file_path_spec.rb
 - spec/rubocop/cop/rspec/focus_spec.rb
+- spec/rubocop/cop/rspec/hook_argument_spec.rb
 - spec/rubocop/cop/rspec/instance_variable_spec.rb
+- spec/rubocop/cop/rspec/leading_subject_spec.rb
+- 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/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/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/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/rspec_only_cop_behavior.rb
 - spec/spec_helper.rb
 - spec/support/expect_violation.rb
 homepage: http://github.com/nevir/rubocop-rspec
@@ -186,27 +235,45 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.6.3
+rubygems_version: 2.6.6
 signing_key: 
 specification_version: 4
 summary: Code style checking for RSpec files
 test_files:
 - spec/expect_violation/expectation_spec.rb
-- spec/project_spec.rb
+- spec/project/changelog_spec.rb
+- spec/project/default_config_spec.rb
+- 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/describe_class_spec.rb
 - spec/rubocop/cop/rspec/describe_method_spec.rb
 - spec/rubocop/cop/rspec/described_class_spec.rb
+- spec/rubocop/cop/rspec/empty_example_group_spec.rb
 - spec/rubocop/cop/rspec/example_length_spec.rb
 - spec/rubocop/cop/rspec/example_wording_spec.rb
+- spec/rubocop/cop/rspec/expect_actual_spec.rb
 - spec/rubocop/cop/rspec/file_path_spec.rb
 - spec/rubocop/cop/rspec/focus_spec.rb
+- spec/rubocop/cop/rspec/hook_argument_spec.rb
 - spec/rubocop/cop/rspec/instance_variable_spec.rb
+- spec/rubocop/cop/rspec/leading_subject_spec.rb
+- 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/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/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/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/rspec_only_cop_behavior.rb
 - spec/spec_helper.rb
 - spec/support/expect_violation.rb