class RuboCop::Cop::RSpec::ExampleWording
Checks for common mistakes in example descriptions.
This cop will correct docstrings that begin with 'should' and 'it'.
The autocorrect is experimental - use with care! It can be configured with CustomTransform (e.g. have => has) and IgnoredWords (e.g. only).
@example
# bad it 'should find nothing' do end # good it 'finds nothing' do end
@example
# bad it 'it does things' do end # good it 'does things' do end
Constants
- IT_PREFIX
- MSG_IT
- MSG_SHOULD
- SHOULD_PREFIX
Public Instance Methods
on_block(node)
click to toggle source
# File lib/rubocop/cop/rspec/example_wording.rb, line 49 def on_block(node) it_description(node) do |description_node, message| if message.match?(SHOULD_PREFIX) add_wording_offense(description_node, MSG_SHOULD) elsif message.match?(IT_PREFIX) add_wording_offense(description_node, MSG_IT) end end end
Private Instance Methods
add_wording_offense(node, message)
click to toggle source
# File lib/rubocop/cop/rspec/example_wording.rb, line 61 def add_wording_offense(node, message) docstring = docstring(node) add_offense(docstring, message: message) do |corrector| next if node.heredoc? corrector.replace(docstring, replacement_text(node)) end end
custom_transform()
click to toggle source
# File lib/rubocop/cop/rspec/example_wording.rb, line 108 def custom_transform cop_config.fetch('CustomTransform', {}) end
docstring(node)
click to toggle source
# File lib/rubocop/cop/rspec/example_wording.rb, line 71 def docstring(node) expr = node.loc.expression Parser::Source::Range.new( expr.source_buffer, expr.begin_pos + 1, expr.end_pos - 1 ) end
ignored_words()
click to toggle source
# File lib/rubocop/cop/rspec/example_wording.rb, line 112 def ignored_words cop_config.fetch('IgnoredWords', []) end
replacement_text(node)
click to toggle source
# File lib/rubocop/cop/rspec/example_wording.rb, line 81 def replacement_text(node) text = text(node) if text.match?(SHOULD_PREFIX) RuboCop::RSpec::Wording.new( text, ignore: ignored_words, replace: custom_transform ).rewrite else text.sub(IT_PREFIX, '') end end
text(node)
click to toggle source
Recursive processing is required to process nested dstr nodes that is the case for -separated multiline strings with interpolation.
# File lib/rubocop/cop/rspec/example_wording.rb, line 97 def text(node) case node.type when :dstr node.node_parts.map { |child_node| text(child_node) }.join when :str node.value when :begin node.source end end