Sha256: f6a7abbfefcde3eaa641e7c46978973653ab3d7b9c31d6429ffe8b59bbc8770c
Contents?: true
Size: 2 KB
Versions: 12
Compression:
Stored size: 2 KB
Contents
# frozen_string_literal: true
module RuboCop
module Cop
module RSpec
# This cop enforces custom RSpec dialects.
#
# A dialect can be based on the following RSpec methods:
#
# - describe, context, feature, example_group
# - xdescribe, xcontext, xfeature
# - fdescribe, fcontext, ffeature
# - shared_examples, shared_examples_for, shared_context
# - it, specify, example, scenario, its
# - fit, fspecify, fexample, fscenario, focus
# - xit, xspecify, xexample, xscenario, skip
# - pending
# - prepend_before, before, append_before,
# - around
# - prepend_after, after, append_after
# - let, let!
# - subject, subject!
# - expect, is_expected, expect_any_instance_of
#
# By default all of the RSpec methods and aliases are allowed. By setting
# a config like:
#
# RSpec/Dialect:
# PreferredMethods:
# context: describe
#
# You can expect the following behavior:
#
# @example
# # bad
# context 'display name presence' do
# # ...
# end
#
# # good
# describe 'display name presence' do
# # ...
# end
class Dialect < Cop
include MethodPreference
MSG = 'Prefer `%<prefer>s` over `%<current>s`.'
def_node_matcher :rspec_method?, ALL.send_pattern
def on_send(node)
return unless rspec_method?(node)
return unless preferred_methods[node.method_name]
add_offense(node)
end
def autocorrect(node)
lambda do |corrector|
current = node.loc.selector
preferred = preferred_method(current.source)
corrector.replace(current, preferred)
end
end
private
def message(node)
format(MSG, prefer: preferred_method(node.method_name),
current: node.method_name)
end
end
end
end
end
Version data entries
12 entries across 12 versions & 1 rubygems