Module: RuboCop::RSpec::ExpectOffense
- Defined in:
- lib/rubocop/rspec/expect_offense.rb
Overview
Mixin for ‘expect_offense` and `expect_no_offenses`
This mixin makes it easier to specify strict offense expectations in a declarative and visual fashion. Just type out the code that should generate an offense, annotate code by writing ‘^’s underneath each character that should be highlighted, and follow the carets with a string (separated by a space) that is the message of the offense. You can include multiple offenses in one code snippet.
Autocorrection can be tested using ‘expect_correction` after `expect_offense`.
If you do not want to specify an offense then use the companion method ‘expect_no_offenses`. This method is a much simpler assertion since it just inspects the source and checks that there were no offenses. The `expect_offense` method has to do more work by parsing out lines that contain carets.
If the code produces an offense that could not be autocorrected, you can use ‘expect_no_corrections` after `expect_offense`.
If your code has variables of different lengths, you can use the following markers to format your template by passing the variables as a keyword arguments:
-
‘%foo`: Interpolates `foo`
-
‘^foo`: Inserts `’^‘ * foo.size` for dynamic offense range length
-
‘_foo`: Inserts `’ ‘ * foo.size` for dynamic offense range indentation
You can also abbreviate offense messages with ‘[…]`.
%w[raise fail].each do |keyword|
expect_offense(<<~RUBY, keyword: keyword)
%{keyword}(RuntimeError, msg)
^{keyword}^^^^^^^^^^^^^^^^^^^ Redundant `RuntimeError` argument [...]
RUBY
%w[has_one has_many].each do |type|
expect_offense(<<~RUBY, type: type)
class Book
%{type} :chapter, foreign_key: 'book_id'
_{type} ^^^^^^^^^^^^^^^^^^^^^^ Specifying the default [...]
end
RUBY
end
If you need to specify an offense on a blank line, use the empty ‘^{}` marker:
Defined Under Namespace
Classes: AnnotatedSource
Instance Method Summary collapse
-
#expect_correction(correction, loop: true, source: nil) ⇒ Object
rubocop:disable Metrics/AbcSize, Metrics/MethodLength, Metrics/CyclomaticComplexity.
-
#expect_no_corrections ⇒ Object
rubocop:enable Metrics/AbcSize, Metrics/MethodLength, Metrics/CyclomaticComplexity.
- #expect_no_offenses(source, file = nil) ⇒ Object
-
#expect_offense(source, file = nil, severity: nil, chomp: false, **replacements) ⇒ Object
rubocop:disable Metrics/AbcSize.
- #format_offense(source, **replacements) ⇒ Object
- #parse_annotations(source, raise_error: true, **replacements) ⇒ Object
- #parse_processed_source(source, file = nil) ⇒ Object
- #set_formatter_options ⇒ Object
Instance Method Details
#expect_correction(correction, loop: true, source: nil) ⇒ Object
rubocop:disable Metrics/AbcSize, Metrics/MethodLength, Metrics/CyclomaticComplexity
144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 |
# File 'lib/rubocop/rspec/expect_offense.rb', line 144 def expect_correction(correction, loop: true, source: nil) if source expected_annotations = parse_annotations(source, raise_error: false) @processed_source = parse_processed_source(expected_annotations.plain_source) _investigate(cop, @processed_source) end raise '`expect_correction` must follow `expect_offense`' unless @processed_source source = @processed_source.raw_source raise 'Use `expect_no_corrections` if the code will not change' if correction == source iteration = 0 new_source = loop do iteration += 1 corrected_source = @last_corrector.rewrite break corrected_source unless loop break corrected_source if @last_corrector.empty? if iteration > RuboCop::Runner::MAX_ITERATIONS raise RuboCop::Runner::InfiniteCorrectionLoop.new(@processed_source.path, [@offenses]) end # Prepare for next loop @processed_source = parse_source(corrected_source, @processed_source.path) _investigate(cop, @processed_source) end raise 'Expected correction but no corrections were made' if new_source == source expect(new_source).to eq(correction) expect(@processed_source).to be_valid_syntax, 'Expected correction to be valid syntax' end |
#expect_no_corrections ⇒ Object
rubocop:enable Metrics/AbcSize, Metrics/MethodLength, Metrics/CyclomaticComplexity
182 183 184 185 186 187 188 189 190 191 192 193 194 |
# File 'lib/rubocop/rspec/expect_offense.rb', line 182 def expect_no_corrections raise '`expect_no_corrections` must follow `expect_offense`' unless @processed_source return if @last_corrector.empty? # This is just here for a pretty diff if the source actually got changed new_source = @last_corrector.rewrite expect(new_source).to eq(@processed_source.buffer.source) # There is an infinite loop if a corrector is present that did not make # any changes. It will cause the same offense/correction on the next loop. raise RuboCop::Runner::InfiniteCorrectionLoop.new(@processed_source.path, [@offenses]) end |
#expect_no_offenses(source, file = nil) ⇒ Object
196 197 198 199 200 201 202 203 204 205 |
# File 'lib/rubocop/rspec/expect_offense.rb', line 196 def expect_no_offenses(source, file = nil) offenses = inspect_source(source, file) # Since source given `expect_no_offenses` does not have annotations, we do not need to parse # for them, and can just build an `AnnotatedSource` object from the source lines. # This also prevents treating source lines that begin with a caret as an annotation. expected_annotations = AnnotatedSource.new(source.each_line.to_a, []) actual_annotations = expected_annotations.with_offense_annotations(offenses) expect(actual_annotations.to_s).to eq(source) end |
#expect_offense(source, file = nil, severity: nil, chomp: false, **replacements) ⇒ Object
rubocop:disable Metrics/AbcSize
121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 |
# File 'lib/rubocop/rspec/expect_offense.rb', line 121 def expect_offense(source, file = nil, severity: nil, chomp: false, **replacements) expected_annotations = parse_annotations(source, **replacements) source = expected_annotations.plain_source source = source.chomp if chomp @processed_source = parse_processed_source(source, file) @offenses = _investigate(cop, @processed_source) actual_annotations = expected_annotations.with_offense_annotations(@offenses) expect(actual_annotations).to eq(expected_annotations), '' expect(@offenses.map(&:severity).uniq).to eq([severity]) if severity # Validate that all offenses have a range that formatters can display expect do @offenses.each { |offense| offense.location.source_line } end.not_to raise_error, 'One of the offenses has a misconstructed range, for ' \ 'example if the offense is on line 1 and the source is empty' @offenses end |
#format_offense(source, **replacements) ⇒ Object
110 111 112 113 114 115 116 117 118 |
# File 'lib/rubocop/rspec/expect_offense.rb', line 110 def format_offense(source, **replacements) replacements.each do |keyword, value| value = value.to_s source = source.gsub("%{#{keyword}}", value) .gsub("^{#{keyword}}", '^' * value.size) .gsub("_{#{keyword}}", ' ' * value.size) end source end |
#parse_annotations(source, raise_error: true, **replacements) ⇒ Object
207 208 209 210 211 212 213 214 215 |
# File 'lib/rubocop/rspec/expect_offense.rb', line 207 def parse_annotations(source, raise_error: true, **replacements) source = format_offense(source, **replacements) annotations = AnnotatedSource.parse(source) return annotations unless raise_error && annotations.plain_source == source raise 'Use `expect_no_offenses` to assert that no offenses are found' end |
#parse_processed_source(source, file = nil) ⇒ Object
217 218 219 220 221 222 223 |
# File 'lib/rubocop/rspec/expect_offense.rb', line 217 def parse_processed_source(source, file = nil) processed_source = parse_source(source, file) return processed_source if processed_source.valid_syntax? raise 'Error parsing example code: ' \ "#{processed_source.diagnostics.map(&:render).join("\n")}" end |
#set_formatter_options ⇒ Object
225 226 227 228 229 |
# File 'lib/rubocop/rspec/expect_offense.rb', line 225 def RuboCop::Formatter::DisabledConfigFormatter.config_to_allow_offenses = {} RuboCop::Formatter::DisabledConfigFormatter.detected_styles = {} cop.instance_variable_get(:@options)[:autocorrect] = true end |