Module: CopHelper

Extended by:
RSpec::SharedContext
Defined in:
lib/rubocop/rspec/cop_helper.rb

Overview

This module provides methods that make it easier to test Cops.

Instance Method Summary collapse

Instance Method Details

#_investigate(cop, processed_source) ⇒ Object 



67
68
69
70
71
72
73
74
75
76
77
 
# File 'lib/rubocop/rspec/cop_helper.rb', line 67

def _investigate(cop, processed_source)
  forces = RuboCop::Cop::Force.all.each_with_object([]) do |klass, instances|
    next unless cop.join_force?(klass)
    instances << klass.new([cop])
  end

  commissioner =
    RuboCop::Cop::Commissioner.new([cop], forces, raise_error: true)
  commissioner.investigate(processed_source)
  commissioner
end

#autocorrect_source(cop, source, file = nil) ⇒ Object 



48
49
50
51
52
53
54
55
56
 
# File 'lib/rubocop/rspec/cop_helper.rb', line 48

def autocorrect_source(cop, source, file = nil)
  cop.instance_variable_get(:@options)[:auto_correct] = true
  processed_source = parse_source(source, file)
  _investigate(cop, processed_source)

  corrector =
    RuboCop::Cop::Corrector.new(processed_source.buffer, cop.corrections)
  corrector.rewrite
end

#autocorrect_source_file(cop, source) ⇒ Object 



44
45
46
 
# File 'lib/rubocop/rspec/cop_helper.rb', line 44

def autocorrect_source_file(cop, source)
  Tempfile.open('tmp') { |f| autocorrect_source(cop, source, f) }
end

#autocorrect_source_with_loop(cop, source, file = nil) ⇒ Object 



58
59
60
61
62
63
64
65
 
# File 'lib/rubocop/rspec/cop_helper.rb', line 58

def autocorrect_source_with_loop(cop, source, file = nil)
  loop do
    cop.instance_variable_set(:@corrections, [])
    new_source = autocorrect_source(cop, source, file)
    return new_source if new_source == source
    source = new_source
  end
end

#inspect_gemfile(cop, source) ⇒ Object 



17
18
19
 
# File 'lib/rubocop/rspec/cop_helper.rb', line 17

def inspect_gemfile(cop, source)
  inspect_source(cop, source, 'Gemfile')
end

#inspect_source(cop, source, file = nil) ⇒ Object 



21
22
23
24
25
26
27
28
29
30
 
# File 'lib/rubocop/rspec/cop_helper.rb', line 21

def inspect_source(cop, source, file = nil)
  if source.is_a?(Array) && source.size == 1
    raise "Don't use an array for a single line of code: #{source}"
  end
  RuboCop::Formatter::DisabledConfigFormatter.config_to_allow_offenses = {}
  RuboCop::Formatter::DisabledConfigFormatter.detected_styles = {}
  processed_source = parse_source(source, file)
  raise 'Error parsing example code' unless processed_source.valid_syntax?
  _investigate(cop, processed_source)
end

#inspect_source_file(cop, source) ⇒ Object 



13
14
15
 
# File 'lib/rubocop/rspec/cop_helper.rb', line 13

def inspect_source_file(cop, source)
  Tempfile.open('tmp') { |f| inspect_source(cop, source, f) }
end

#parse_source(source, file = nil) ⇒ Object 



32
33
34
35
36
37
38
39
40
41
42
 
# File 'lib/rubocop/rspec/cop_helper.rb', line 32

def parse_source(source, file = nil)
  source = source.join($RS) if source.is_a?(Array)

  if file && file.respond_to?(:write)
    file.write(source)
    file.rewind
    file = file.path
  end

  RuboCop::ProcessedSource.new(source, ruby_version, file)
end