gitlab-org--gitlab-foss/rubocop/cop/rspec/be_success_matcher.rb
2019-08-28 08:43:47 +02:00

58 lines
1.5 KiB
Ruby

# frozen_string_literal: true
require_relative '../../spec_helpers'
module RuboCop
module Cop
module RSpec
# This cop checks for `be_success` usage in controller specs
#
# @example
#
# # bad
# it "responds with success" do
# expect(response).to be_success
# end
#
# it { is_expected.to be_success }
#
# # good
# it "responds with success" do
# expect(response).to be_successful
# end
#
# it { is_expected.to be_successful }
#
class BeSuccessMatcher < RuboCop::Cop::Cop
include SpecHelpers
MESSAGE = "Don't use deprecated `success?` method, use `successful?` instead.".freeze
def_node_search :expect_to_be_success?, <<~PATTERN
(send (send nil? :expect (send nil? ...)) :to (send nil? :be_success))
PATTERN
def_node_search :is_expected_to_be_success?, <<~PATTERN
(send (send nil? :is_expected) :to (send nil? :be_success))
PATTERN
def be_success_usage?(node)
expect_to_be_success?(node) || is_expected_to_be_success?(node)
end
def on_send(node)
return unless in_controller_spec?(node)
return unless be_success_usage?(node)
add_offense(node, location: :expression, message: MESSAGE)
end
def autocorrect(node)
lambda do |corrector|
corrector.insert_after(node.loc.expression, "ful")
end
end
end
end
end
end