reek 6.0.3 → 6.1.0

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

data/spec/reek/configuration/app_configuration_spec.rb

@@ -1,195 +0,0 @@
-require 'pathname'
-require_relative '../../spec_helper'
-require_lib 'reek/configuration/app_configuration'
-require_lib 'reek/configuration/directory_directives'
-require_lib 'reek/configuration/default_directive'
-require_lib 'reek/configuration/excluded_paths'
-
-RSpec.describe Reek::Configuration::AppConfiguration do
-  describe 'factory methods' do
-    around do |example|
-      Dir.mktmpdir do |tmp|
-        Dir.chdir(tmp) do
-          example.run
-        end
-      end
-    end
-
-    let(:expected_exclude_file_names) do
-      %w(exclude_me.rb exclude_me_too.rb)
-    end
-
-    let(:expected_exclude_directories) do
-      %w(directory_with_trailing_slash/ directory_without_trailing_slash)
-    end
-
-    let(:expected_excluded_paths) do
-      (expected_exclude_file_names + expected_exclude_directories).map { |path| Pathname(path) }
-    end
-
-    let(:expected_default_directive) do
-      { Reek::SmellDetectors::IrresponsibleModule => { 'enabled' => false } }
-    end
-
-    let(:expected_directory_directives) do
-      { Pathname('directory_with_some_ruby_files') => {
-        Reek::SmellDetectors::UtilityFunction => { 'enabled' => false }
-      } }
-    end
-
-    describe '#from_path' do
-      let(:configuration_path) { 'config.reek' }
-      let(:configuration) do
-        <<~YAML
-          ---
-          detectors:
-            IrresponsibleModule:
-              enabled: false
-          directories:
-            "directory_with_some_ruby_files":
-              UtilityFunction:
-                enabled: false
-          exclude_paths:
-            - "exclude_me.rb"
-            - "exclude_me_too.rb"
-            - "directory_with_trailing_slash/"
-            - "directory_without_trailing_slash"
-        YAML
-      end
-
-      before do
-        File.write configuration_path, configuration
-        FileUtils.touch expected_exclude_file_names
-        FileUtils.mkdir expected_exclude_directories
-      end
-
-      it 'properly loads configuration and processes it' do
-        config = described_class.from_path configuration_path
-
-        expect(config.send(:excluded_paths)).to eq(expected_excluded_paths)
-        expect(config.send(:default_directive)).to eq(expected_default_directive)
-        expect(config.send(:directory_directives)).to eq(expected_directory_directives)
-      end
-    end
-
-    describe '#from_hash' do
-      before do
-        FileUtils.touch expected_exclude_file_names
-        FileUtils.mkdir expected_exclude_directories
-      end
-
-      let(:default_directive_value) do
-        { Reek::DETECTORS_KEY => {
-          'IrresponsibleModule' => { 'enabled' => false }
-        } }
-      end
-
-      let(:directory_directives_value) do
-        { Reek::DIRECTORIES_KEY => {
-          'directory_with_some_ruby_files' => {
-            'UtilityFunction' => { 'enabled' => false }
-          }
-        } }
-      end
-
-      let(:exclude_paths_value) do
-        { Reek::EXCLUDE_PATHS_KEY => (expected_exclude_file_names + expected_exclude_directories) }
-      end
-
-      let(:combined_value) do
-        directory_directives_value.
-          merge(default_directive_value).
-          merge(exclude_paths_value)
-      end
-
-      it 'sets the configuration a unified simple data structure' do
-        config = described_class.from_hash(combined_value)
-
-        expect(config.send(:excluded_paths)).to eq(expected_excluded_paths)
-        expect(config.send(:default_directive)).to eq(expected_default_directive)
-        expect(config.send(:directory_directives)).to eq(expected_directory_directives)
-      end
-    end
-  end
-
-  describe '#default' do
-    it 'returns a blank AppConfiguration' do
-      config = described_class.default
-      expect(config).to be_instance_of described_class
-      expect(config.send(:excluded_paths)).to eq([])
-      expect(config.send(:default_directive)).to eq({})
-      expect(config.send(:directory_directives)).to eq({})
-    end
-  end
-
-  describe '#directive_for' do
-    context 'with multiple directory directives and no default directive present' do
-      let(:source_via) { 'samples/some_files/dummy1.rb' }
-      let(:baz_config)  { { IrresponsibleModule: { enabled: false } } }
-      let(:bang_config) { { Attribute: { enabled: true } } }
-      let(:expected_result) { { Reek::SmellDetectors::Attribute => { enabled: true } } }
-
-      let(:directory_directives) do
-        {
-          Reek::DIRECTORIES_KEY => {
-            'samples/some_files'  => bang_config,
-            'samples/other_files' => baz_config
-          }
-        }
-      end
-
-      it 'returns the corresponding directive' do
-        configuration = described_class.from_hash directory_directives
-        expect(configuration.directive_for(source_via)).to eq expected_result
-      end
-    end
-
-    context 'with directory directive and default directive present' do
-      let(:directory) { 'spec/samples/two_smelly_files/' }
-      let(:source_via) { "#{directory}/dummy.rb" }
-
-      let(:configuration_as_hash) do
-        {
-          Reek::DIRECTORIES_KEY => {
-            directory => { TooManyStatements: { max_statements: 8 } }
-          },
-          Reek::DETECTORS_KEY   => {
-            IrresponsibleModule: { enabled: false },
-            TooManyStatements:   { max_statements: 15 }
-          }
-        }
-      end
-
-      it 'returns the directory directive with the default directive reverse-merged' do
-        configuration = described_class.from_hash configuration_as_hash
-        actual = configuration.directive_for(source_via)
-
-        expect(actual[Reek::SmellDetectors::IrresponsibleModule]).to be_truthy
-        expect(actual[Reek::SmellDetectors::TooManyStatements]).to be_truthy
-        expect(actual[Reek::SmellDetectors::TooManyStatements][:max_statements]).to eq(8)
-      end
-    end
-
-    context 'with a path not covered by a directory directive but a default directive present' do
-      let(:source_via) { 'samples/some_files/dummy.rb' }
-
-      let(:configuration_as_hash) do
-        {
-          Reek::DETECTORS_KEY   => {
-            IrresponsibleModule: { enabled: false }
-          },
-          Reek::DIRECTORIES_KEY => {
-            'samples/other_files' => { Attribute: { enabled: false } }
-          }
-        }
-      end
-
-      let(:expected_result) { { Reek::SmellDetectors::IrresponsibleModule => { enabled: false } } }
-
-      it 'returns the default directive' do
-        configuration = described_class.from_hash configuration_as_hash
-        expect(configuration.directive_for(source_via)).to eq expected_result
-      end
-    end
-  end
-end