reek 6.0.1 → 6.0.5

data/spec/reek/cli/application_spec.rb

@@ -1,168 +0,0 @@
-require_relative '../../spec_helper'
-require_lib 'reek/cli/application'
-
-RSpec.describe Reek::CLI::Application do
-  describe '#initialize' do
-    it 'exits with default error code on invalid options' do
-      call = lambda do
-        Reek::CLI::Silencer.silently do
-          described_class.new ['--foo']
-        end
-      end
-      expect(&call).to raise_error(SystemExit) do |error|
-        expect(error.status).to eq Reek::CLI::Status::DEFAULT_ERROR_EXIT_CODE
-      end
-    end
-  end
-
-  describe '#execute' do
-    let(:path_excluded_in_configuration) do
-      SAMPLES_DIR.join('source_with_exclude_paths/ignore_me/uncommunicative_method_name.rb')
-    end
-    let(:configuration) { test_configuration_for(CONFIGURATION_DIR.join('with_excluded_paths.reek')) }
-    let(:command) { instance_double 'Reek::CLI::Command::ReportCommand' }
-    let(:app) { described_class.new [] }
-
-    before do
-      allow(Reek::CLI::Command::ReportCommand).to receive(:new).and_return command
-      allow(command).to receive(:execute).and_return 'foo'
-    end
-
-    it "returns the command's result code" do
-      expect(app.execute).to eq 'foo'
-    end
-
-    context 'when no source files given and input was piped' do
-      before do
-        allow_any_instance_of(IO).to receive(:tty?).and_return(false)
-      end
-
-      it 'uses source from pipe' do
-        expected_sources = a_collection_containing_exactly(have_attributes(origin: 'STDIN'))
-        app.execute
-        expect(Reek::CLI::Command::ReportCommand).to have_received(:new).
-          with(sources: expected_sources,
-               configuration: Reek::Configuration::AppConfiguration,
-               options: Reek::CLI::Options)
-      end
-
-      context 'when a stdin filename is provided' do
-        let(:app) { described_class.new ['--stdin-filename', 'foo.rb'] }
-
-        it 'assumes that filename' do
-          expected_sources = a_collection_containing_exactly(have_attributes(origin: 'foo.rb'))
-          app.execute
-          expect(Reek::CLI::Command::ReportCommand).to have_received(:new).
-            with(sources: expected_sources,
-                 configuration: Reek::Configuration::AppConfiguration,
-                 options: Reek::CLI::Options)
-        end
-      end
-    end
-
-    context 'when no source files given and no input was piped' do
-      before do
-        allow_any_instance_of(IO).to receive(:tty?).and_return(true)
-      end
-
-      it 'uses working directory as source' do
-        expected_sources = Reek::Source::SourceLocator.new(['.']).sources
-        app.execute
-        expect(Reek::CLI::Command::ReportCommand).to have_received(:new).
-          with(sources: expected_sources,
-               configuration: Reek::Configuration::AppConfiguration,
-               options: Reek::CLI::Options)
-      end
-
-      context 'when source files are excluded through configuration' do
-        let(:app) { described_class.new ['--config', 'some_file.reek'] }
-
-        before do
-          allow(Reek::Configuration::AppConfiguration).
-            to receive(:from_path).
-            with(Pathname.new('some_file.reek')).
-            and_return configuration
-        end
-
-        it 'uses configuration for excluded paths' do
-          expected_sources = Reek::Source::SourceLocator.
-            new(['.'], configuration: configuration).sources
-          expect(expected_sources).not_to include(path_excluded_in_configuration)
-
-          app.execute
-
-          expect(Reek::CLI::Command::ReportCommand).to have_received(:new).
-            with(sources: expected_sources,
-                 configuration: configuration,
-                 options: Reek::CLI::Options)
-        end
-      end
-    end
-
-    context 'when source files given' do
-      let(:app) { described_class.new ['.'] }
-
-      it 'uses sources from argv' do
-        expected_sources = Reek::Source::SourceLocator.new(['.']).sources
-        app.execute
-        expect(Reek::CLI::Command::ReportCommand).to have_received(:new).
-          with(sources: expected_sources,
-               configuration: Reek::Configuration::AppConfiguration,
-               options: Reek::CLI::Options)
-      end
-
-      context 'when source files are excluded through configuration' do
-        let(:app) { described_class.new ['--config', 'some_file.reek', '.'] }
-
-        before do
-          allow(Reek::Configuration::AppConfiguration).
-            to receive(:from_path).
-            with(Pathname.new('some_file.reek')).
-            and_return configuration
-        end
-
-        it 'uses configuration for excluded paths' do
-          expected_sources = Reek::Source::SourceLocator.
-            new(['.'], configuration: configuration).sources
-          expect(expected_sources).not_to include(path_excluded_in_configuration)
-
-          app.execute
-
-          expect(Reek::CLI::Command::ReportCommand).to have_received(:new).
-            with(sources: expected_sources,
-                 configuration: configuration,
-                 options: Reek::CLI::Options)
-        end
-      end
-    end
-  end
-
-  describe 'show configuration path' do
-    let(:app) { described_class.new ['--show-configuration-path', '.'] }
-
-    around do |example|
-      Dir.mktmpdir do |tmp|
-        Dir.chdir(tmp) do
-          example.run
-        end
-      end
-    end
-
-    context 'when not using any configuration file' do
-      it 'prints that we are not using any configuration file' do
-        expect do
-          app.execute
-        end.to output("Not using any configuration file.\n").to_stdout
-      end
-    end
-
-    context 'with a default configuration file' do
-      it 'prints that we are using the default configuration file' do
-        FileUtils.touch '.reek.yml'
-        expect do
-          app.execute
-        end.to output("Using '.reek.yml' as configuration file.\n").to_stdout
-      end
-    end
-  end
-end

data/spec/reek/cli/command/report_command_spec.rb

@@ -1,44 +0,0 @@
-require_relative '../../../spec_helper'
-require_lib 'reek/cli/command/report_command'
-require_lib 'reek/cli/options'
-
-RSpec.describe Reek::CLI::Command::ReportCommand do
-  describe '#execute' do
-    let(:options) { Reek::CLI::Options.new [] }
-
-    let(:configuration) { instance_double 'Reek::Configuration::AppConfiguration' }
-    let(:sources) { [source_file] }
-
-    let(:command) do
-      described_class.new(options: options,
-                          sources: sources,
-                          configuration: configuration)
-    end
-
-    before do
-      allow(configuration).to receive(:directive_for).and_return({})
-    end
-
-    context 'when no smells are found' do
-      let(:source_file) { CLEAN_FILE }
-
-      it 'returns a success code' do
-        result = Reek::CLI::Silencer.silently do
-          command.execute
-        end
-        expect(result).to eq Reek::CLI::Status::DEFAULT_SUCCESS_EXIT_CODE
-      end
-    end
-
-    context 'when smells are found' do
-      let(:source_file) { SMELLY_FILE }
-
-      it 'returns a failure code' do
-        result = Reek::CLI::Silencer.silently do
-          command.execute
-        end
-        expect(result).to eq Reek::CLI::Status::DEFAULT_FAILURE_EXIT_CODE
-      end
-    end
-  end
-end

data/spec/reek/cli/command/todo_list_command_spec.rb

@@ -1,86 +0,0 @@
-require_relative '../../../spec_helper'
-require_lib 'reek/cli/command/todo_list_command'
-require_lib 'reek/cli/options'
-require_lib 'reek/configuration/app_configuration'
-
-RSpec.describe Reek::CLI::Command::TodoListCommand do
-  let(:existing_configuration) do
-    <<~YAML
-      ---
-      detectors:
-        UncommunicativeMethodName:
-          exclude:
-          - Smelly#x
-    YAML
-  end
-
-  let(:smelly_file) do
-    <<~RUBY
-      # Smelly class
-      class Smelly
-        # This will reek of UncommunicativeMethodName
-        def x
-          y = 10 # This will reek of UncommunicativeVariableName
-        end
-      end
-    RUBY
-  end
-
-  let(:new_configuration_file) do
-    <<~YAML
-      # Auto generated by Reeks --todo flag
-      ---
-      detectors:
-        UncommunicativeMethodName:
-          exclude:
-          - Smelly#x
-        UncommunicativeVariableName:
-          exclude:
-          - Smelly#x
-    YAML
-  end
-
-  describe '#execute on smelly source' do
-    around do |example|
-      Dir.mktmpdir do |tmp|
-        Dir.chdir(tmp) do
-          File.write SMELLY_FILE.basename, smelly_file
-          example.run
-        end
-      end
-    end
-
-    context 'with default configuration file' do
-      let(:default_configuration_file_name) { Reek::DEFAULT_CONFIGURATION_FILE_NAME }
-
-      context 'when does not exist yet' do
-        it 'creates it' do
-          Reek::CLI::Silencer.silently { todo_command.execute }
-
-          actual_content = File.read(default_configuration_file_name)
-          expect(actual_content).to match(new_configuration_file)
-        end
-      end
-
-      context 'when exists already' do
-        it 'does not update the configuration' do
-          File.write default_configuration_file_name, existing_configuration
-          command = todo_command
-
-          Reek::CLI::Silencer.silently { command.execute }
-
-          actual_content = File.read(default_configuration_file_name)
-          expect(actual_content).to match(existing_configuration)
-        end
-      end
-    end
-
-    def todo_command(options: Reek::CLI::Options.new([]),
-                     sources: [Pathname.new(SMELLY_FILE.basename.to_s)],
-                     configuration: Reek::Configuration::AppConfiguration.default)
-      described_class.new options: options,
-                          sources: sources,
-                          configuration: configuration
-    end
-  end
-end

data/spec/reek/cli/options_spec.rb

@@ -1,51 +0,0 @@
-require_relative '../../spec_helper'
-require_lib 'reek/cli/options'
-
-RSpec.describe Reek::CLI::Options do
-  let(:options) { described_class.new }
-
-  describe '#initialize' do
-    it 'sets a valid default value for report_format' do
-      expect(options.report_format).to eq :text
-    end
-
-    it 'sets a valid default value for location_format' do
-      expect(options.location_format).to eq :numbers
-    end
-
-    it 'enables colors when stdout is a TTY' do
-      allow($stdout).to receive_messages(tty?: true)
-      expect(options.colored).to be true
-    end
-
-    it 'does not enable colors when stdout is not a TTY' do
-      allow($stdout).to receive_messages(tty?: false)
-      expect(options.colored).to be false
-    end
-
-    it 'enables progress when stdout is a TTY' do
-      allow($stdout).to receive_messages(tty?: true)
-      expect(options.progress_format).to eq :dots
-    end
-
-    it 'does not enable progress when stdout is not a TTY' do
-      allow($stdout).to receive_messages(tty?: false)
-      expect(options.progress_format).to eq :quiet
-    end
-
-    it 'sets force_exclusion to false by default' do
-      expect(options.force_exclusion?).to be false
-    end
-  end
-
-  describe 'parse' do
-    it 'raises on invalid argument in ARGV' do
-      options = described_class.new ['-z']
-      expect { options.parse }.to raise_error(OptionParser::InvalidOption)
-    end
-
-    it 'returns self' do
-      expect(options.parse).to be_a(described_class)
-    end
-  end
-end

data/spec/reek/cli/silencer_spec.rb

@@ -1,28 +0,0 @@
-require_relative '../../spec_helper'
-require_lib 'reek/cli/silencer'
-
-RSpec.describe Reek::CLI::Silencer do
-  describe '.silently' do
-    it 'blocks output from the block on $stdout' do
-      expect { described_class.silently { puts 'Hi!' } }.not_to output.to_stdout
-    end
-
-    it 'blocks output from the block on $stderr' do
-      expect { described_class.silently { warn 'Hi!' } }.not_to output.to_stderr
-    end
-
-    it 'restores output on $stdout after the block' do
-      expect do
-        described_class.silently { puts 'Hi!' }
-        puts 'there!'
-      end.to output("there!\n").to_stdout
-    end
-
-    it 'restores output on $stderr after the block' do
-      expect do
-        described_class.silently { warn 'Hi!' }
-        warn 'there!'
-      end.to output("there!\n").to_stderr
-    end
-  end
-end

data/spec/reek/code_comment_spec.rb

@@ -1,184 +0,0 @@
-require_relative '../spec_helper'
-require_lib 'reek/code_comment'
-
-RSpec.describe Reek::CodeComment do
-  context 'with an empty comment' do
-    let(:comment) { build_code_comment(comment: '') }
-
-    it 'is not descriptive' do
-      expect(comment).not_to be_descriptive
-    end
-
-    it 'has an empty config' do
-      expect(comment.config).to be_empty
-    end
-  end
-
-  describe '#descriptive' do
-    it 'rejects an empty comment' do
-      comment = build_code_comment(comment: '#')
-      expect(comment).not_to be_descriptive
-    end
-
-    it 'rejects a 1-word comment' do
-      comment = build_code_comment(comment: "# alpha\n#  ")
-      expect(comment).not_to be_descriptive
-    end
-
-    it 'accepts a 2-word comment' do
-      comment = build_code_comment(comment: '# alpha bravo  ')
-      expect(comment).to be_descriptive
-    end
-
-    it 'accepts a multi-word comment' do
-      comment = build_code_comment(comment: "# alpha bravo \n# charlie \n   # delta ")
-      expect(comment).to be_descriptive
-    end
-  end
-
-  describe 'good comment config' do
-    it 'parses hashed options' do
-      comment = '# :reek:DuplicateMethodCall { max_calls: 3 }'
-      config = build_code_comment(comment: comment).config
-
-      expect(config).to include('DuplicateMethodCall')
-      expect(config['DuplicateMethodCall']).to have_key 'max_calls'
-      expect(config['DuplicateMethodCall']['max_calls']).to eq 3
-    end
-
-    it 'parses multiple hashed options' do
-      comment = <<-RUBY
-        # :reek:DuplicateMethodCall { max_calls: 3 }
-        # :reek:NestedIterators { enabled: true }
-      RUBY
-      config = build_code_comment(comment: comment).config
-
-      expect(config).to include('DuplicateMethodCall', 'NestedIterators')
-      expect(config['DuplicateMethodCall']['max_calls']).to eq 3
-      expect(config['NestedIterators']['enabled']).to be_truthy
-    end
-
-    it 'parses multiple hashed options on the same line' do
-      comment = <<-RUBY
-        #:reek:DuplicateMethodCall { max_calls: 3 } and :reek:NestedIterators { enabled: true }
-      RUBY
-      config = build_code_comment(comment: comment).config
-
-      expect(config).to include('DuplicateMethodCall', 'NestedIterators')
-      expect(config['DuplicateMethodCall']['max_calls']).to eq 3
-      expect(config['NestedIterators']).to include('enabled')
-      expect(config['NestedIterators']['enabled']).to be_truthy
-    end
-
-    it 'parses multiple unhashed options on the same line' do
-      comment = '# :reek:DuplicateMethodCall and :reek:NestedIterators'
-      config = build_code_comment(comment: comment).config
-
-      expect(config).to include('DuplicateMethodCall', 'NestedIterators')
-      expect(config['DuplicateMethodCall']).to include('enabled')
-      expect(config['DuplicateMethodCall']['enabled']).to be_falsey
-      expect(config['NestedIterators']).to include('enabled')
-      expect(config['NestedIterators']['enabled']).to be_falsey
-    end
-
-    it 'disables the smell if no options are specifed' do
-      comment = '# :reek:DuplicateMethodCall'
-      config = build_code_comment(comment: comment).config
-
-      expect(config).to include('DuplicateMethodCall')
-      expect(config['DuplicateMethodCall']).to include('enabled')
-      expect(config['DuplicateMethodCall']['enabled']).to be_falsey
-    end
-
-    it 'does not disable the smell if options are specifed' do
-      comment = '# :reek:DuplicateMethodCall { max_calls: 3 }'
-      config = build_code_comment(comment: comment).config
-
-      expect(config['DuplicateMethodCall']).not_to include('enabled')
-    end
-
-    it 'ignores smells after a space' do
-      config = build_code_comment(comment: '# :reek: DuplicateMethodCall').config
-      expect(config).not_to include('DuplicateMethodCall')
-    end
-
-    it 'removes the configuration options from the comment' do
-      original_comment = <<-RUBY
-        # Actual
-        # :reek:DuplicateMethodCall { max_calls: 3 }
-        # :reek:NestedIterators { enabled: true }
-        # comment
-      RUBY
-      comment = build_code_comment(comment: original_comment)
-
-      expect(comment.send(:sanitized_comment)).to eq('Actual comment')
-    end
-  end
-end
-
-RSpec.describe Reek::CodeComment::CodeCommentValidator do
-  context 'when the comment contains an unknown detector name' do
-    it 'raises BadDetectorInCommentError' do
-      expect do
-        build_code_comment(comment: '# :reek:DoesNotExist')
-      end.to raise_error(Reek::Errors::BadDetectorInCommentError)
-    end
-  end
-
-  context 'when the comment contains an unparsable detector configuration' do
-    it 'raises GarbageDetectorConfigurationInCommentError' do
-      expect do
-        comment = '# :reek:UncommunicativeMethodName { thats: a: bad: config }'
-        build_code_comment(comment: comment)
-      end.to raise_error(Reek::Errors::GarbageDetectorConfigurationInCommentError)
-    end
-  end
-
-  context 'when the legacy comment format was used' do
-    it 'raises LegacyCommentSeparatorError' do
-      comment = '# :reek:DuplicateMethodCall:'
-      expect { build_code_comment(comment: comment) }.
-        to raise_error Reek::Errors::LegacyCommentSeparatorError
-    end
-  end
-
-  describe 'validating configuration keys' do
-    context 'when basic options are mispelled' do
-      it 'raises BadDetectorConfigurationKeyInCommentError' do
-        expect do
-          # exclude -> exlude and enabled -> nabled
-          comment = '# :reek:UncommunicativeMethodName { exlude: alfa, nabled: true }'
-          build_code_comment(comment: comment)
-        end.to raise_error(Reek::Errors::BadDetectorConfigurationKeyInCommentError)
-      end
-    end
-
-    context 'when basic options are not mispelled' do
-      it 'does not raise' do
-        expect do
-          comment = '# :reek:UncommunicativeMethodName { exclude: alfa, enabled: true }'
-          build_code_comment(comment: comment)
-        end.not_to raise_error
-      end
-    end
-
-    context 'when unknown custom options are specified' do
-      it 'raises BadDetectorConfigurationKeyInCommentError' do
-        expect do
-          # max_copies -> mx_copies and min_clump_size -> mn_clump_size
-          comment = '# :reek:DataClump { mx_copies: 4, mn_clump_size: 3 }'
-          build_code_comment(comment: comment)
-        end.to raise_error(Reek::Errors::BadDetectorConfigurationKeyInCommentError)
-      end
-    end
-
-    context 'when valid custom options are specified' do
-      it 'does not raise' do
-        expect do
-          comment = '# :reek:DataClump { max_copies: 4, min_clump_size: 3 }'
-          build_code_comment(comment: comment)
-        end.not_to raise_error
-      end
-    end
-  end
-end