rubocop-rspec 2.30.0 → 3.0.0.pre

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

@@ -1,179 +0,0 @@
-# frozen_string_literal: true
-
-module RuboCop
-  module Cop
-    module RSpec
-      # Checks that spec file paths are consistent and well-formed.
-      #
-      # This cop is deprecated.
-      # We plan to remove it in the next major version update to 3.0.
-      # The migration targets are `RSpec/SpecFilePathSuffix`
-      # and `RSpec/SpecFilePathFormat`.
-      # If you are using this cop, please plan for migration.
-      #
-      # By default, this checks that spec file paths are consistent with the
-      # test subject and enforces that it reflects the described
-      # class/module and its optionally called out method.
-      #
-      # With the configuration option `IgnoreMethods` the called out method will
-      # be ignored when determining the enforced path.
-      #
-      # With the configuration option `CustomTransform` modules or classes can
-      # be specified that should not as usual be transformed from CamelCase to
-      # snake_case (e.g. 'RuboCop' => 'rubocop' ).
-      #
-      # With the configuration option `SpecSuffixOnly` test files will only
-      # be checked to ensure they end in '_spec.rb'. This option disables
-      # checking for consistency in the test subject or test methods.
-      #
-      # @example
-      #   # bad
-      #   whatever_spec.rb         # describe MyClass
-      #
-      #   # bad
-      #   my_class_spec.rb         # describe MyClass, '#method'
-      #
-      #   # good
-      #   my_class_spec.rb         # describe MyClass
-      #
-      #   # good
-      #   my_class_method_spec.rb  # describe MyClass, '#method'
-      #
-      #   # good
-      #   my_class/method_spec.rb  # describe MyClass, '#method'
-      #
-      # @example when configuration is `IgnoreMethods: true`
-      #   # bad
-      #   whatever_spec.rb         # describe MyClass
-      #
-      #   # good
-      #   my_class_spec.rb         # describe MyClass
-      #
-      #   # good
-      #   my_class_spec.rb         # describe MyClass, '#method'
-      #
-      # @example when configuration is `SpecSuffixOnly: true`
-      #   # good
-      #   whatever_spec.rb         # describe MyClass
-      #
-      #   # good
-      #   my_class_spec.rb         # describe MyClass
-      #
-      #   # good
-      #   my_class_spec.rb         # describe MyClass, '#method'
-      #
-      class FilePath < Base
-        include TopLevelGroup
-        include Namespace
-
-        MSG = 'Spec path should end with `%<suffix>s`.'
-
-        # @!method example_group(node)
-        def_node_matcher :example_group, <<~PATTERN
-          (block
-            $(send #rspec? _example_group $_ $...) ...
-          )
-        PATTERN
-
-        # @!method routing_metadata?(node)
-        def_node_search :routing_metadata?, '(pair (sym :type) (sym :routing))'
-
-        def on_top_level_example_group(node)
-          return unless top_level_groups.one?
-
-          example_group(node) do |send_node, example_group, arguments|
-            ensure_correct_file_path(send_node, example_group, arguments)
-          end
-        end
-
-        private
-
-        def ensure_correct_file_path(send_node, example_group, arguments)
-          pattern = pattern_for(example_group, arguments)
-          return if filename_ends_with?(pattern)
-
-          # For the suffix shown in the offense message, modify the regular
-          # expression pattern to resemble a glob pattern for clearer error
-          # messages.
-          offense_suffix = pattern.gsub('.*', '*').sub('[^/]', '')
-            .sub('\.', '.')
-          add_offense(send_node, message: format(MSG, suffix: offense_suffix))
-        end
-
-        def routing_spec?(args)
-          args.any?(&method(:routing_metadata?)) || routing_spec_path?
-        end
-
-        def pattern_for(example_group, arguments)
-          method_name = arguments.first
-          if spec_suffix_only? || !example_group.const_type? ||
-              routing_spec?(arguments)
-            return pattern_for_spec_suffix_only
-          end
-
-          [
-            expected_path(example_group),
-            name_pattern(method_name),
-            '[^/]*_spec\.rb'
-          ].join
-        end
-
-        def pattern_for_spec_suffix_only
-          '.*_spec\.rb'
-        end
-
-        def name_pattern(method_name)
-          return unless method_name&.str_type?
-          return if ignore_methods?
-
-          ".*#{method_name.str_content.gsub(/\s/, '_').gsub(/\W/, '')}"
-        end
-
-        def expected_path(constant)
-          constants = namespace(constant) + constant.const_name.split('::')
-
-          File.join(
-            constants.map do |name|
-              custom_transform.fetch(name) { camel_to_snake_case(name) }
-            end
-          )
-        end
-
-        def camel_to_snake_case(string)
-          string
-            .gsub(/([^A-Z])([A-Z]+)/, '\1_\2')
-            .gsub(/([A-Z])([A-Z][^A-Z\d]+)/, '\1_\2')
-            .downcase
-        end
-
-        def custom_transform
-          cop_config.fetch('CustomTransform', {})
-        end
-
-        def ignore_methods?
-          cop_config['IgnoreMethods']
-        end
-
-        def filename_ends_with?(pattern)
-          expanded_file_path.match?("#{pattern}$")
-        end
-
-        def relevant_rubocop_rspec_file?(_file)
-          true
-        end
-
-        def spec_suffix_only?
-          cop_config['SpecSuffixOnly']
-        end
-
-        def routing_spec_path?
-          expanded_file_path.include?('spec/routing/')
-        end
-
-        def expanded_file_path
-          File.expand_path(processed_source.file_path)
-        end
-      end
-    end
-  end
-end

data/lib/rubocop/cop/rspec/rails/avoid_setup_hook.rb

@@ -1,27 +0,0 @@
-# frozen_string_literal: true
-
-module RuboCop
-  module Cop
-    module RSpec
-      module Rails
-        # @!parse
-        #   # Checks that tests use RSpec `before` hook over Rails `setup`
-        #   # method.
-        #   #
-        #   # @example
-        #   #   # bad
-        #   #   setup do
-        #   #     allow(foo).to receive(:bar)
-        #   #   end
-        #   #
-        #   #   # good
-        #   #   before do
-        #   #     allow(foo).to receive(:bar)
-        #   #   end
-        #   #
-        #   class AvoidSetupHook < RuboCop::Cop::RSpec::Base; end
-        AvoidSetupHook = ::RuboCop::Cop::RSpecRails::AvoidSetupHook
-      end
-    end
-  end
-end

data/lib/rubocop/cop/rspec/rails/have_http_status.rb

@@ -1,35 +0,0 @@
-# frozen_string_literal: true
-
-module RuboCop
-  module Cop
-    module RSpec
-      module Rails
-        # @!parse
-        #   # Checks that tests use `have_http_status` instead of equality matchers.
-        #   #
-        #   # @example ResponseMethods: ['response', 'last_response'] (default)
-        #   #   # bad
-        #   #   expect(response.status).to be(200)
-        #   #   expect(last_response.code).to eq("200")
-        #   #
-        #   #   # good
-        #   #   expect(response).to have_http_status(200)
-        #   #   expect(last_response).to have_http_status(200)
-        #   #
-        #   # @example ResponseMethods: ['foo_response']
-        #   #   # bad
-        #   #   expect(foo_response.status).to be(200)
-        #   #
-        #   #   # good
-        #   #   expect(foo_response).to have_http_status(200)
-        #   #
-        #   #   # also good
-        #   #   expect(response).to have_http_status(200)
-        #   #   expect(last_response).to have_http_status(200)
-        #   #
-        #   class HaveHttpStatus < ::RuboCop::Cop::Base; end
-        HaveHttpStatus = ::RuboCop::Cop::RSpecRails::HaveHttpStatus
-      end
-    end
-  end
-end

data/lib/rubocop/cop/rspec/rails/http_status.rb

@@ -1,61 +0,0 @@
-# frozen_string_literal: true
-
-module RuboCop
-  module Cop
-    module RSpec
-      module Rails
-        # @!parse
-        #   # Enforces use of symbolic or numeric value to describe HTTP status.
-        #   #
-        #   # This cop inspects only `have_http_status` calls.
-        #   # So, this cop does not check if a method starting with `be_*` is
-        #   # used when setting for `EnforcedStyle: symbolic` or
-        #   # `EnforcedStyle: numeric`.
-        #   #
-        #   # @example `EnforcedStyle: symbolic` (default)
-        #   #   # bad
-        #   #   it { is_expected.to have_http_status 200 }
-        #   #   it { is_expected.to have_http_status 404 }
-        #   #   it { is_expected.to have_http_status "403" }
-        #   #
-        #   #   # good
-        #   #   it { is_expected.to have_http_status :ok }
-        #   #   it { is_expected.to have_http_status :not_found }
-        #   #   it { is_expected.to have_http_status :forbidden }
-        #   #   it { is_expected.to have_http_status :success }
-        #   #   it { is_expected.to have_http_status :error }
-        #   #
-        #   # @example `EnforcedStyle: numeric`
-        #   #   # bad
-        #   #   it { is_expected.to have_http_status :ok }
-        #   #   it { is_expected.to have_http_status :not_found }
-        #   #   it { is_expected.to have_http_status "forbidden" }
-        #   #
-        #   #   # good
-        #   #   it { is_expected.to have_http_status 200 }
-        #   #   it { is_expected.to have_http_status 404 }
-        #   #   it { is_expected.to have_http_status 403 }
-        #   #   it { is_expected.to have_http_status :success }
-        #   #   it { is_expected.to have_http_status :error }
-        #   #
-        #   # @example `EnforcedStyle: be_status`
-        #   #   # bad
-        #   #   it { is_expected.to have_http_status :ok }
-        #   #   it { is_expected.to have_http_status :not_found }
-        #   #   it { is_expected.to have_http_status "forbidden" }
-        #   #   it { is_expected.to have_http_status 200 }
-        #   #   it { is_expected.to have_http_status 404 }
-        #   #   it { is_expected.to have_http_status "403" }
-        #   #
-        #   #   # good
-        #   #   it { is_expected.to be_ok }
-        #   #   it { is_expected.to be_not_found }
-        #   #   it { is_expected.to have_http_status :success }
-        #   #   it { is_expected.to have_http_status :error }
-        #   #
-        #   class HttpStatus < RuboCop::Cop::RSpec::Base; end
-        HttpStatus = ::RuboCop::Cop::RSpecRails::HttpStatus
-      end
-    end
-  end
-end

data/lib/rubocop/cop/rspec/rails/inferred_spec_type.rb

@@ -1,62 +0,0 @@
-# frozen_string_literal: true
-
-module RuboCop
-  module Cop
-    module RSpec
-      module Rails
-        # @!parse
-        #   # Identifies redundant spec type.
-        #   #
-        #   # After setting up rspec-rails, you will have enabled
-        #   # `config.infer_spec_type_from_file_location!` by default in
-        #   # spec/rails_helper.rb. This cop works in conjunction with
-        #   # this config.
-        #   # If you disable this config, disable this cop as well.
-        #   #
-        #   # @safety
-        #   #   This cop is marked as unsafe because
-        #   #   `config.infer_spec_type_from_file_location!` may not be enabled.
-        #   #
-        #   # @example
-        #   #   # bad
-        #   #   # spec/models/user_spec.rb
-        #   #   RSpec.describe User, type: :model do
-        #   #   end
-        #   #
-        #   #   # good
-        #   #   # spec/models/user_spec.rb
-        #   #   RSpec.describe User do
-        #   #   end
-        #   #
-        #   #   # good
-        #   #   # spec/models/user_spec.rb
-        #   #   RSpec.describe User, type: :common do
-        #   #   end
-        #   #
-        #   # @example `Inferences` configuration
-        #   #   # .rubocop.yml
-        #   #   # RSpec/Rails/InferredSpecType:
-        #   #   #   Inferences:
-        #   #   #     services: service
-        #   #
-        #   #   # bad
-        #   #   # spec/services/user_spec.rb
-        #   #   RSpec.describe User, type: :service do
-        #   #   end
-        #   #
-        #   #   # good
-        #   #   # spec/services/user_spec.rb
-        #   #   RSpec.describe User do
-        #   #   end
-        #   #
-        #   #   # good
-        #   #   # spec/services/user_spec.rb
-        #   #   RSpec.describe User, type: :common do
-        #   #   end
-        #   #
-        #   class InferredSpecType < RuboCop::Cop::RSpec::Base; end
-        InferredSpecType = ::RuboCop::Cop::RSpecRails::InferredSpecType
-      end
-    end
-  end
-end

data/lib/rubocop/cop/rspec/rails/minitest_assertions.rb

@@ -1,39 +0,0 @@
-# frozen_string_literal: true
-
-module RuboCop
-  module Cop
-    module RSpec
-      module Rails
-        # @!parse
-        #   # Check if using Minitest-like matchers.
-        #   #
-        #   # Check the use of minitest-like matchers
-        #   # starting with `assert_` or `refute_`.
-        #   #
-        #   # @example
-        #   #   # bad
-        #   #   assert_equal(a, b)
-        #   #   assert_equal a, b, "must be equal"
-        #   #   assert_not_includes a, b
-        #   #   refute_equal(a, b)
-        #   #   assert_nil a
-        #   #   refute_empty(b)
-        #   #   assert_true(a)
-        #   #   assert_false(a)
-        #   #
-        #   #   # good
-        #   #   expect(b).to eq(a)
-        #   #   expect(b).to(eq(a), "must be equal")
-        #   #   expect(a).not_to include(b)
-        #   #   expect(b).not_to eq(a)
-        #   #   expect(a).to eq(nil)
-        #   #   expect(a).not_to be_empty
-        #   #   expect(a).to be(true)
-        #   #   expect(a).to be(false)
-        #   #
-        #   class MinitestAssertions < RuboCop::Cop::RSpec::Base; end
-        MinitestAssertions = ::RuboCop::Cop::RSpecRails::MinitestAssertions
-      end
-    end
-  end
-end

data/lib/rubocop/cop/rspec/rails/negation_be_valid.rb

@@ -1,39 +0,0 @@
-# frozen_string_literal: true
-
-module RuboCop
-  module Cop
-    module RSpec
-      module Rails
-        # @!parse
-        #   # Enforces use of `be_invalid` or `not_to` for negated be_valid.
-        #   #
-        #   # @safety
-        #   #   This cop is unsafe because it cannot guarantee that
-        #   #   the test target is an instance of `ActiveModel::Validations``.
-        #   #
-        #   # @example EnforcedStyle: not_to (default)
-        #   #   # bad
-        #   #   expect(foo).to be_invalid
-        #   #
-        #   #   # good
-        #   #   expect(foo).not_to be_valid
-        #   #
-        #   #   # good (with method chain)
-        #   #   expect(foo).to be_invalid.and be_odd
-        #   #
-        #   # @example EnforcedStyle: be_invalid
-        #   #   # bad
-        #   #   expect(foo).not_to be_valid
-        #   #
-        #   #   # good
-        #   #   expect(foo).to be_invalid
-        #   #
-        #   #   # good (with method chain)
-        #   #   expect(foo).to be_invalid.or be_even
-        #   #
-        #   class NegationBeValid < RuboCop::Cop::RSpec::Base; end
-        NegationBeValid = ::RuboCop::Cop::RSpecRails::NegationBeValid
-      end
-    end
-  end
-end

data/lib/rubocop/cop/rspec/rails/travel_around.rb

@@ -1,34 +0,0 @@
-# frozen_string_literal: true
-
-module RuboCop
-  module Cop
-    module RSpec
-      module Rails
-        # @!parse
-        #   # Prefer to travel in `before` rather than `around`.
-        #   #
-        #   # @safety
-        #   #   This cop is unsafe because the automatic `travel_back` is only
-        #   #   run on test cases that are considered as Rails related.
-        #   #
-        #   #   And also, this cop's autocorrection is unsafe because the order
-        #   #   of execution will change if other steps exist before traveling
-        #   #   in `around`.
-        #   #
-        #   # @example
-        #   #   # bad
-        #   #   around do |example|
-        #   #     freeze_time do
-        #   #       example.run
-        #   #     end
-        #   #   end
-        #   #
-        #   #   # good
-        #   #   before { freeze_time }
-        #   #
-        #   class TravelAround < RuboCop::Cop::RSpec::Base; end
-        TravelAround = ::RuboCop::Cop::RSpecRails::TravelAround
-      end
-    end
-  end
-end

data/lib/rubocop/rspec/language/node_pattern.rb

@@ -1,48 +0,0 @@
-# frozen_string_literal: true
-
-module RuboCop
-  module RSpec
-    module Language
-      # Helper methods to detect RSpec DSL used with send and block
-      # @deprecated Prefer using Node Pattern directly
-      #   Use `'(block (send nil? #Example.all ...) ...)'` instead of
-      #   `block_pattern('#Example.all')`
-      module NodePattern
-        # @deprecated Prefer using Node Pattern directly
-        def send_pattern(string)
-          deprecation_warning __method__
-          "(send #rspec? #{string} ...)"
-        end
-
-        # @deprecated Prefer using Node Pattern directly
-        def block_pattern(string)
-          deprecation_warning __method__
-          "(block #{send_pattern(string)} ...)"
-        end
-
-        # @deprecated Prefer using Node Pattern directly
-        def numblock_pattern(string)
-          deprecation_warning __method__
-          "(numblock #{send_pattern(string)} ...)"
-        end
-
-        # @deprecated Prefer using Node Pattern directly
-        def block_or_numblock_pattern(string)
-          deprecation_warning __method__
-          "{#{block_pattern(string)} #{numblock_pattern(string)}}"
-        end
-
-        private
-
-        def deprecation_warning(method)
-          # Only warn in derived extensions' specs
-          return unless defined?(::RSpec)
-
-          Kernel.warn <<~MESSAGE, uplevel: 2
-            Usage of #{method} is deprecated. Use node pattern explicitly.
-          MESSAGE
-        end
-      end
-    end
-  end
-end