diff options
Diffstat (limited to 'spec/rubocop/formatter/todo_formatter_spec.rb')
| -rw-r--r-- | spec/rubocop/formatter/todo_formatter_spec.rb | 284 |
1 files changed, 284 insertions, 0 deletions
diff --git a/spec/rubocop/formatter/todo_formatter_spec.rb b/spec/rubocop/formatter/todo_formatter_spec.rb new file mode 100644 index 00000000000..e1b1de33bfe --- /dev/null +++ b/spec/rubocop/formatter/todo_formatter_spec.rb @@ -0,0 +1,284 @@ +# frozen_string_literal: true +# rubocop:disable RSpec/VerifiedDoubles + +require 'fast_spec_helper' +require 'stringio' +require 'fileutils' + +require_relative '../../../rubocop/formatter/todo_formatter' +require_relative '../../../rubocop/todo_dir' + +RSpec.describe RuboCop::Formatter::TodoFormatter do + let(:stdout) { StringIO.new } + let(:tmp_dir) { Dir.mktmpdir } + let(:real_tmp_dir) { File.join(tmp_dir, 'real') } + let(:symlink_tmp_dir) { File.join(tmp_dir, 'symlink') } + let(:rubocop_todo_dir) { "#{symlink_tmp_dir}/.rubocop_todo" } + let(:options) { { rubocop_todo_dir: rubocop_todo_dir } } + let(:todo_dir) { RuboCop::TodoDir.new(rubocop_todo_dir) } + + subject(:formatter) { described_class.new(stdout, options) } + + around do |example| + FileUtils.mkdir(real_tmp_dir) + FileUtils.symlink(real_tmp_dir, symlink_tmp_dir) + + Dir.chdir(symlink_tmp_dir) do + example.run + end + end + + after do + FileUtils.remove_entry(tmp_dir) + end + + context 'with offenses detected' do + let(:offense) { fake_offense('A/Offense') } + let(:offense_too_many) { fake_offense('B/TooManyOffenses') } + let(:offense_autocorrect) { fake_offense('B/AutoCorrect') } + + before do + stub_const("#{described_class}::MAX_OFFENSE_COUNT", 1) + + stub_rubocop_registry( + 'A/Offense' => { autocorrectable: false }, + 'B/AutoCorrect' => { autocorrectable: true } + ) + end + + def run_formatter + formatter.started(%w[a.rb b.rb c.rb d.rb]) + formatter.file_finished('c.rb', [offense_too_many]) + formatter.file_finished('a.rb', [offense_too_many, offense, offense_too_many]) + formatter.file_finished('b.rb', []) + formatter.file_finished('d.rb', [offense_autocorrect]) + formatter.finished(%w[a.rb b.rb c.rb d.rb]) + end + + it 'outputs its actions' do + run_formatter + + expect(stdout.string).to eq(<<~OUTPUT) + Written to .rubocop_todo/a/offense.yml + Written to .rubocop_todo/b/auto_correct.yml + Written to .rubocop_todo/b/too_many_offenses.yml + OUTPUT + end + + it 'creates YAML files', :aggregate_failures do + run_formatter + + expect(rubocop_todo_dir_listing).to contain_exactly( + 'a/offense.yml', 'b/auto_correct.yml', 'b/too_many_offenses.yml' + ) + + expect(todo_yml('A/Offense')).to eq(<<~YAML) + --- + A/Offense: + Exclude: + - 'a.rb' + YAML + + expect(todo_yml('B/AutoCorrect')).to eq(<<~YAML) + --- + # Cop supports --auto-correct. + B/AutoCorrect: + Exclude: + - 'd.rb' + YAML + + expect(todo_yml('B/TooManyOffenses')).to eq(<<~YAML) + --- + B/TooManyOffenses: + Exclude: + - 'a.rb' + - 'c.rb' + YAML + end + + context 'when cop previously not explicitly disabled' do + before do + todo_dir.write('B/TooManyOffenses', <<~YAML) + --- + B/TooManyOffenses: + Exclude: + - 'x.rb' + YAML + end + + it 'does not disable cop' do + run_formatter + + expect(todo_yml('B/TooManyOffenses')).to eq(<<~YAML) + --- + B/TooManyOffenses: + Exclude: + - 'a.rb' + - 'c.rb' + YAML + end + end + + context 'when cop previously explicitly disabled in rubocop_todo/' do + before do + todo_dir.write('B/TooManyOffenses', <<~YAML) + --- + B/TooManyOffenses: + Enabled: false + Exclude: + - 'x.rb' + YAML + + todo_dir.inspect_all + end + + it 'keeps cop disabled' do + run_formatter + + expect(todo_yml('B/TooManyOffenses')).to eq(<<~YAML) + --- + B/TooManyOffenses: + # Offense count: 3 + # Temporarily disabled due to too many offenses + Enabled: false + Exclude: + - 'a.rb' + - 'c.rb' + YAML + end + end + + context 'when cop previously explicitly disabled in rubocop_todo.yml' do + before do + File.write('.rubocop_todo.yml', <<~YAML) + --- + B/TooManyOffenses: + Enabled: false + Exclude: + - 'x.rb' + YAML + end + + it 'keeps cop disabled' do + run_formatter + + expect(todo_yml('B/TooManyOffenses')).to eq(<<~YAML) + --- + B/TooManyOffenses: + # Offense count: 3 + # Temporarily disabled due to too many offenses + Enabled: false + Exclude: + - 'a.rb' + - 'c.rb' + YAML + end + end + + context 'with cop configuration in both .rubocop_todo/ and .rubocop_todo.yml' do + before do + todo_dir.write('B/TooManyOffenses', <<~YAML) + --- + B/TooManyOffenses: + Exclude: + - 'a.rb' + YAML + + todo_dir.write('A/Offense', <<~YAML) + --- + A/Offense: + Exclude: + - 'a.rb' + YAML + + todo_dir.inspect_all + + File.write('.rubocop_todo.yml', <<~YAML) + --- + B/TooManyOffenses: + Exclude: + - 'x.rb' + A/Offense: + Exclude: + - 'y.rb' + YAML + end + + it 'raises an error' do + expect { run_formatter }.to raise_error(RuntimeError, <<~TXT) + Multiple configurations found for cops: + - A/Offense + - B/TooManyOffenses + TXT + end + end + end + + context 'without offenses detected' do + before do + formatter.started(%w[a.rb b.rb]) + formatter.file_finished('a.rb', []) + formatter.file_finished('b.rb', []) + formatter.finished(%w[a.rb b.rb]) + end + + it 'does not output anything' do + expect(stdout.string).to eq('') + end + + it 'does not write any YAML files' do + expect(rubocop_todo_dir_listing).to be_empty + end + end + + context 'without files to inspect' do + before do + formatter.started([]) + formatter.finished([]) + end + + it 'does not output anything' do + expect(stdout.string).to eq('') + end + + it 'does not write any YAML files' do + expect(rubocop_todo_dir_listing).to be_empty + end + end + + private + + def rubocop_todo_dir_listing + Dir.glob("#{rubocop_todo_dir}/**/*") + .select { |path| File.file?(path) } + .map { |path| path.delete_prefix("#{rubocop_todo_dir}/") } + end + + def todo_yml(cop_name) + todo_dir.read(cop_name) + end + + def fake_offense(cop_name) + double(:offense, cop_name: cop_name) + end + + def stub_rubocop_registry(**cops) + rubocop_registry = double(:rubocop_registry) + + allow(RuboCop::Cop::Registry).to receive(:global).and_return(rubocop_registry) + + allow(rubocop_registry).to receive(:find_by_cop_name) + .with(String).and_return(nil) + + cops.each do |cop_name, attributes| + allow(rubocop_registry).to receive(:find_by_cop_name) + .with(cop_name).and_return(fake_cop(**attributes)) + end + end + + def fake_cop(autocorrectable:) + double(:cop, support_autocorrect?: autocorrectable) + end +end + +# rubocop:enable RSpec/VerifiedDoubles |