disabled_lines_formatter_spec.rb

# frozen_string_literal: true

RSpec.describe RuboCop::Formatter::DisabledLinesFormatter do
  subject(:formatter) { described_class.new(output) }

  let(:output) { StringIO.new }

  let(:files) do
    %w[lib/rubocop.rb spec/spec_helper.rb exe/rubocop].map do |path|
      File.expand_path(path)
    end
  end

  let(:file_started) do
    formatter.file_started(files.first, cop_disabled_line_ranges)
  end

  describe '#file_started' do
    before { formatter.started(files) }

    context 'when no disable cop comments are detected' do
      let(:cop_disabled_line_ranges) { {} }

      it 'does not add to cop_disabled_line_ranges' do
        expect { file_started }.not_to(
          change(formatter, :cop_disabled_line_ranges)
        )
      end
    end

    context 'when any disable cop comments are detected' do
      let(:cop_disabled_line_ranges) do
        { cop_disabled_line_ranges: { 'LineLength' => [1..1] } }
      end

      it 'merges the changes into cop_disabled_line_ranges' do
        expect { file_started }.to(
          change(formatter, :cop_disabled_line_ranges)
        )
      end
    end
  end

  describe '#finished' do
    context 'when there disabled cops detected' do
      let(:cop_disabled_line_ranges) do
        {
          cop_disabled_line_ranges: {
            'LineLength' => [1..1],
            'ClassLength' => [1..Float::INFINITY]
          }
        }
      end
      let(:offenses) do
        [
          RuboCop::Cop::Offense.new(:convention, location, 'Class too long.',
                                    'ClassLength', :disabled),
          RuboCop::Cop::Offense.new(:convention, location, 'Line too long.',
                                    'LineLength', :uncorrected)
        ]
      end
      let(:location) { OpenStruct.new(line: 3) }

      before do
        formatter.started(files)
        formatter.file_started('lib/rubocop.rb', cop_disabled_line_ranges)
        formatter.file_finished('lib/rubocop.rb', offenses)
      end

      it 'lists disabled cops by file' do
        formatter.finished(files)
        expect(output.string)
          .to eq(<<~OUTPUT)

            Cops disabled line ranges:

            lib/rubocop.rb:1..1: LineLength
            lib/rubocop.rb:1..Infinity: ClassLength
          OUTPUT
      end
    end
  end
end