rubocop-rspec 2.31.0 → 3.0.1

data/lib/rubocop/cop/rspec/capybara/match_style.rb

@@ -1,38 +0,0 @@
-# frozen_string_literal: true
-
-module RuboCop
-  module Cop
-    module RSpec
-      module Capybara
-        # @!parse
-        #   # Checks for usage of deprecated style methods.
-        #   #
-        #   # @example when using `assert_style`
-        #   #   # bad
-        #   #   page.find(:css, '#first').assert_style(display: 'block')
-        #   #
-        #   #   # good
-        #   #   page.find(:css, '#first').assert_matches_style(display: 'block')
-        #   #
-        #   # @example when using `has_style?`
-        #   #   # bad
-        #   #   expect(page.find(:css, 'first')
-        #   #     .has_style?(display: 'block')).to be true
-        #   #
-        #   #   # good
-        #   #   expect(page.find(:css, 'first')
-        #   #     .matches_style?(display: 'block')).to be true
-        #   #
-        #   # @example when using `have_style`
-        #   #   # bad
-        #   #   expect(page).to have_style(display: 'block')
-        #   #
-        #   #   # good
-        #   #   expect(page).to match_style(display: 'block')
-        #   #
-        #   class MatchStyle < ::RuboCop::Cop::Base; end
-        MatchStyle = ::RuboCop::Cop::Capybara::MatchStyle
-      end
-    end
-  end
-end

data/lib/rubocop/cop/rspec/capybara/negation_matcher.rb

@@ -1,33 +0,0 @@
-# frozen_string_literal: true
-
-module RuboCop
-  module Cop
-    module RSpec
-      module Capybara
-        # @!parse
-        #   # Enforces use of `have_no_*` or `not_to` for negated expectations.
-        #   #
-        #   # @example EnforcedStyle: not_to (default)
-        #   #   # bad
-        #   #   expect(page).to have_no_selector
-        #   #   expect(page).to have_no_css('a')
-        #   #
-        #   #   # good
-        #   #   expect(page).not_to have_selector
-        #   #   expect(page).not_to have_css('a')
-        #   #
-        #   # @example EnforcedStyle: have_no
-        #   #   # bad
-        #   #   expect(page).not_to have_selector
-        #   #   expect(page).not_to have_css('a')
-        #   #
-        #   #   # good
-        #   #   expect(page).to have_no_selector
-        #   #   expect(page).to have_no_css('a')
-        #   #
-        #   class NegationMatcher < ::RuboCop::Cop::Base; end
-        NegationMatcher = ::RuboCop::Cop::Capybara::NegationMatcher
-      end
-    end
-  end
-end

data/lib/rubocop/cop/rspec/capybara/specific_actions.rb

@@ -1,29 +0,0 @@
-# frozen_string_literal: true
-
-module RuboCop
-  module Cop
-    module RSpec
-      module Capybara
-        # @!parse
-        #   # Checks for there is a more specific actions offered by Capybara.
-        #   #
-        #   # @example
-        #   #
-        #   #   # bad
-        #   #   find('a').click
-        #   #   find('button.cls').click
-        #   #   find('a', exact_text: 'foo').click
-        #   #   find('div button').click
-        #   #
-        #   #   # good
-        #   #   click_link
-        #   #   click_button(class: 'cls')
-        #   #   click_link(exact_text: 'foo')
-        #   #   find('div').click_button
-        #   #
-        #   class SpecificActions < ::RuboCop::Cop::Base; end
-        SpecificActions = ::RuboCop::Cop::Capybara::SpecificActions
-      end
-    end
-  end
-end

data/lib/rubocop/cop/rspec/capybara/specific_finders.rb

@@ -1,24 +0,0 @@
-# frozen_string_literal: true
-
-module RuboCop
-  module Cop
-    module RSpec
-      module Capybara
-        # @!parse
-        #   # Checks if there is a more specific finder offered by Capybara.
-        #   #
-        #   # @example
-        #   #   # bad
-        #   #   find('#some-id')
-        #   #   find('[visible][id=some-id]')
-        #   #
-        #   #   # good
-        #   #   find_by_id('some-id')
-        #   #   find_by_id('some-id', visible: true)
-        #   #
-        #   class SpecificFinders < ::RuboCop::Cop::Base; end
-        SpecificFinders = ::RuboCop::Cop::Capybara::SpecificFinders
-      end
-    end
-  end
-end

data/lib/rubocop/cop/rspec/capybara/specific_matcher.rb

@@ -1,35 +0,0 @@
-# frozen_string_literal: true
-
-module RuboCop
-  module Cop
-    module RSpec
-      module Capybara
-        # @!parse
-        #   # Checks for there is a more specific matcher offered by Capybara.
-        #   #
-        #   # @example
-        #   #
-        #   #   # bad
-        #   #   expect(page).to have_selector('button')
-        #   #   expect(page).to have_no_selector('button.cls')
-        #   #   expect(page).to have_css('button')
-        #   #   expect(page).to have_no_css('a.cls', href: 'http://example.com')
-        #   #   expect(page).to have_css('table.cls')
-        #   #   expect(page).to have_css('select')
-        #   #   expect(page).to have_css('input', exact_text: 'foo')
-        #   #
-        #   #   # good
-        #   #   expect(page).to have_button
-        #   #   expect(page).to have_no_button(class: 'cls')
-        #   #   expect(page).to have_button
-        #   #   expect(page).to have_no_link('foo', class: 'cls', href: 'http://example.com')
-        #   #   expect(page).to have_table(class: 'cls')
-        #   #   expect(page).to have_select
-        #   #   expect(page).to have_field('foo')
-        #   #
-        #   class SpecificMatcher < ::RuboCop::Cop::Base; end
-        SpecificMatcher = ::RuboCop::Cop::Capybara::SpecificMatcher
-      end
-    end
-  end
-end

data/lib/rubocop/cop/rspec/capybara/visibility_matcher.rb

@@ -1,36 +0,0 @@
-# frozen_string_literal: true
-
-module RuboCop
-  module Cop
-    module RSpec
-      module Capybara
-        # @!parse
-        #   # Checks for boolean visibility in Capybara finders.
-        #   #
-        #   # Capybara lets you find elements that match a certain visibility
-        #   # using the `:visible` option. `:visible` accepts both boolean and
-        #   # symbols as values, however using booleans can have unwanted
-        #   # effects. `visible: false` does not find just invisible elements,
-        #   # but both visible and invisible elements. For expressiveness and
-        #   # clarity, use one of the # symbol values, `:all`, `:hidden` or
-        #   # `:visible`.
-        #   # Read more in
-        #   # https://www.rubydoc.info/gems/capybara/Capybara%2FNode%2FFinders:all[the documentation].
-        #   #
-        #   # @example
-        #   #   # bad
-        #   #   expect(page).to have_selector('.foo', visible: false)
-        #   #   expect(page).to have_css('.foo', visible: true)
-        #   #   expect(page).to have_link('my link', visible: false)
-        #   #
-        #   #   # good
-        #   #   expect(page).to have_selector('.foo', visible: :visible)
-        #   #   expect(page).to have_css('.foo', visible: :all)
-        #   #   expect(page).to have_link('my link', visible: :hidden)
-        #   #
-        #   class VisibilityMatcher < ::RuboCop::Cop::Base; end
-        VisibilityMatcher = ::RuboCop::Cop::Capybara::VisibilityMatcher
-      end
-    end
-  end
-end

data/lib/rubocop/cop/rspec/factory_bot/attribute_defined_statically.rb

@@ -1,35 +0,0 @@
-# frozen_string_literal: true
-
-module RuboCop
-  module Cop
-    module RSpec
-      module FactoryBot
-        # @!parse
-        #   # Always declare attribute values as blocks.
-        #   #
-        #   # @example
-        #   #   # bad
-        #   #   kind [:active, :rejected].sample
-        #   #
-        #   #   # good
-        #   #   kind { [:active, :rejected].sample }
-        #   #
-        #   #   # bad
-        #   #   closed_at 1.day.from_now
-        #   #
-        #   #   # good
-        #   #   closed_at { 1.day.from_now }
-        #   #
-        #   #   # bad
-        #   #   count 1
-        #   #
-        #   #   # good
-        #   #   count { 1 }
-        #   #
-        #   class AttributeDefinedStatically < ::RuboCop::Cop::Base; end
-        AttributeDefinedStatically =
-          ::RuboCop::Cop::FactoryBot::AttributeDefinedStatically
-      end
-    end
-  end
-end

data/lib/rubocop/cop/rspec/factory_bot/consistent_parentheses_style.rb

@@ -1,50 +0,0 @@
-# frozen_string_literal: true
-
-module RuboCop
-  module Cop
-    module RSpec
-      module FactoryBot
-        # @!parse
-        #   # Use a consistent style for parentheses in factory bot calls.
-        #   #
-        #   # @example
-        #   #
-        #   #   # bad
-        #   #   create :user
-        #   #   build(:user)
-        #   #   create(:login)
-        #   #   create :login
-        #   #
-        #   # @example `EnforcedStyle: require_parentheses` (default)
-        #   #
-        #   #   # good
-        #   #   create(:user)
-        #   #   create(:user)
-        #   #   create(:login)
-        #   #   build(:login)
-        #   #
-        #   # @example `EnforcedStyle: omit_parentheses`
-        #   #
-        #   #   # good
-        #   #   create :user
-        #   #   build :user
-        #   #   create :login
-        #   #   create :login
-        #   #
-        #   #   # also good
-        #   #   # when method name and first argument are not on same line
-        #   #   create(
-        #   #     :user
-        #   #   )
-        #   #   build(
-        #   #     :user,
-        #   #     name: 'foo'
-        #   #   )
-        #   #
-        #   class ConsistentParenthesesStyle < ::RuboCop::Cop::Base; end
-        ConsistentParenthesesStyle =
-          ::RuboCop::Cop::FactoryBot::ConsistentParenthesesStyle
-      end
-    end
-  end
-end

data/lib/rubocop/cop/rspec/factory_bot/create_list.rb

@@ -1,40 +0,0 @@
-# frozen_string_literal: true
-
-module RuboCop
-  module Cop
-    module RSpec
-      module FactoryBot
-        # @!parse
-        #   # Checks for create_list usage.
-        #   #
-        #   # This cop can be configured using the `EnforcedStyle` option
-        #   #
-        #   # @example `EnforcedStyle: create_list` (default)
-        #   #   # bad
-        #   #   3.times { create :user }
-        #   #
-        #   #   # good
-        #   #   create_list :user, 3
-        #   #
-        #   #   # bad
-        #   #   3.times { create :user, age: 18 }
-        #   #
-        #   #   # good - index is used to alter the created models attributes
-        #   #   3.times { |n| create :user, age: n }
-        #   #
-        #   #   # good - contains a method call, may return different values
-        #   #   3.times { create :user, age: rand }
-        #   #
-        #   # @example `EnforcedStyle: n_times`
-        #   #   # bad
-        #   #   create_list :user, 3
-        #   #
-        #   #   # good
-        #   #   3.times { create :user }
-        #   #
-        #   class CreateList < ::RuboCop::Cop::Base; end
-        CreateList = ::RuboCop::Cop::FactoryBot::CreateList
-      end
-    end
-  end
-end

data/lib/rubocop/cop/rspec/factory_bot/factory_class_name.rb

@@ -1,29 +0,0 @@
-# frozen_string_literal: true
-
-module RuboCop
-  module Cop
-    module RSpec
-      module FactoryBot
-        # @!parse
-        #   # Use string value when setting the class attribute explicitly.
-        #   #
-        #   # This cop would promote faster tests by lazy-loading of
-        #   # application files. Also, this could help you suppress potential
-        #   # bugs in combination with external libraries by avoiding a preload
-        #   # of application files from the factory files.
-        #   #
-        #   # @example
-        #   #   # bad
-        #   #   factory :foo, class: Foo do
-        #   #   end
-        #   #
-        #   #   # good
-        #   #   factory :foo, class: 'Foo' do
-        #   #   end
-        #   #
-        #   class FactoryClassName < ::RuboCop::Cop::Base; end
-        FactoryClassName = ::RuboCop::Cop::FactoryBot::FactoryClassName
-      end
-    end
-  end
-end

data/lib/rubocop/cop/rspec/factory_bot/factory_name_style.rb

@@ -1,33 +0,0 @@
-# frozen_string_literal: true
-
-module RuboCop
-  module Cop
-    module RSpec
-      module FactoryBot
-        # @!parse
-        #   # Checks for name style for argument of FactoryBot::Syntax::Methods.
-        #   #
-        #   # @example EnforcedStyle: symbol (default)
-        #   #   # bad
-        #   #   create('user')
-        #   #   build "user", username: "NAME"
-        #   #
-        #   #   # good
-        #   #   create(:user)
-        #   #   build :user, username: "NAME"
-        #   #
-        #   # @example EnforcedStyle: string
-        #   #   # bad
-        #   #   create(:user)
-        #   #   build :user, username: "NAME"
-        #   #
-        #   #   # good
-        #   #   create('user')
-        #   #   build "user", username: "NAME"
-        #   #
-        #   class FactoryNameStyle < ::RuboCop::Cop::Base; end
-        FactoryNameStyle = ::RuboCop::Cop::FactoryBot::FactoryNameStyle
-      end
-    end
-  end
-end

data/lib/rubocop/cop/rspec/factory_bot/syntax_methods.rb

@@ -1,55 +0,0 @@
-# frozen_string_literal: true
-
-module RuboCop
-  module Cop
-    module RSpec
-      module FactoryBot
-        # @!parse
-        #   # Use shorthands from `FactoryBot::Syntax::Methods` in your specs.
-        #   #
-        #   # @safety
-        #   #   The autocorrection is marked as unsafe because the cop
-        #   #   cannot verify whether you already include
-        #   #   `FactoryBot::Syntax::Methods` in your test suite.
-        #   #
-        #   #   If you're using Rails, add the following configuration to
-        #   #   `spec/support/factory_bot.rb` and be sure to require that file
-        #   #   in `rails_helper.rb`:
-        #   #
-        #   #   [source,ruby]
-        #   #   ----
-        #   #   RSpec.configure do |config|
-        #   #     config.include FactoryBot::Syntax::Methods
-        #   #   end
-        #   #   ----
-        #   #
-        #   #   If you're not using Rails:
-        #   #
-        #   #   [source,ruby]
-        #   #   ----
-        #   #   RSpec.configure do |config|
-        #   #     config.include FactoryBot::Syntax::Methods
-        #   #
-        #   #     config.before(:suite) do
-        #   #       FactoryBot.find_definitions
-        #   #     end
-        #   #   end
-        #   #   ----
-        #   #
-        #   # @example
-        #   #   # bad
-        #   #   FactoryBot.create(:bar)
-        #   #   FactoryBot.build(:bar)
-        #   #   FactoryBot.attributes_for(:bar)
-        #   #
-        #   #   # good
-        #   #   create(:bar)
-        #   #   build(:bar)
-        #   #   attributes_for(:bar)
-        #   #
-        #   class SyntaxMethods < ::RuboCop::Cop::Base; end
-        SyntaxMethods = ::RuboCop::Cop::FactoryBot::SyntaxMethods
-      end
-    end
-  end
-end

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