rubocop-rspec 1.8.0 → 1.9.0

data/lib/rubocop/rspec/spec_only.rb

@@ -1,61 +0,0 @@
-# frozen_string_literal: true
-
-module RuboCop
-  module RSpec
-    # Mixin for cops that skips non-spec files
-    #
-    # The criteria for whether rubocop-rspec analyzes a certain ruby file
-    # is configured via `AllCops/RSpec`. For example, if you want to
-    # customize your project to scan all files within a `test/` directory
-    # then you could add this to your configuration:
-    #
-    # @example configuring analyzed paths
-    #
-    #   AllCops:
-    #     RSpec:
-    #       Patterns:
-    #       - '_spec.rb$'
-    #       - '(?:^|/)spec/'
-    #
-    # @note this functionality is implemented via this mixin instead of
-    #   a subclass of `RuboCop::Cop::Cop` because the `Cop` class assumes
-    #   that it will be the direct superclass of all cops. For example,
-    #   if the ancestry of a cop looked like this:
-    #
-    #     class RuboCop::RSpec::Cop < RuboCop::Cop::Cop
-    #     end
-    #
-    #     class RuboCop::RSpec::SpecCop < RuboCop::RSpec::Cop
-    #     end
-    #
-    #   then `SpecCop` will fail to be registered on the class instance
-    #   variable of `Cop` which tracks all descendants via `.inherited`.
-    #
-    #   While we could match this behavior and provide a rubocop-rspec Cop
-    #   parent class, it would rely heavily on the implementation details
-    #   of RuboCop itself which is largly private API. This would be
-    #   irresponsible since any patch level release of rubocop could break
-    #   integrations for users of rubocop-rspec
-    #
-    module SpecOnly
-      DEFAULT_CONFIGURATION = CONFIG.fetch('AllCops').fetch('RSpec')
-
-      def relevant_file?(file)
-        rspec_pattern =~ file && super
-      end
-
-      private
-
-      def rspec_pattern
-        Regexp.union(rspec_pattern_config.map(&Regexp.public_method(:new)))
-      end
-
-      def rspec_pattern_config
-        config
-          .for_all_cops
-          .fetch('RSpec', DEFAULT_CONFIGURATION)
-          .fetch('Patterns')
-      end
-    end
-  end
-end

data/spec/shared/rspec_only_cop_behavior.rb

@@ -1,68 +0,0 @@
-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