reek 4.6.0 → 5.0.0

data/spec/reek/cli/application_spec.rb

@@ -15,13 +15,11 @@ RSpec.describe Reek::CLI::Application do
     end
   end
 
-  let(:path_excluded_in_configuration) do
-    SAMPLES_PATH.join('source_with_exclude_paths/ignore_me/uncommunicative_method_name.rb')
-  end
-
-  let(:configuration) { test_configuration_for(CONFIG_PATH.join('with_excluded_paths.reek')) }
-
   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 [] }
 
@@ -34,57 +32,69 @@ RSpec.describe Reek::CLI::Application do
       expect(app.execute).to eq 'foo'
     end
 
-    context 'when no source files given' do
-      context 'and input was piped' do
-        before do
-          allow_any_instance_of(IO).to receive(:tty?).and_return(false)
-        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 form pipe' do
-          app.execute
-          expect(Reek::CLI::Command::ReportCommand).to have_received(:new).
-            with(sources: [$stdin],
-                 configuration: Reek::Configuration::AppConfiguration,
-                 options: Reek::CLI::Options)
-        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 'and input was not piped' do
-        before do
-          allow_any_instance_of(IO).to receive(:tty?).and_return(true)
-        end
+      context 'when a stdin filename is provided' do
+        let(:app) { described_class.new ['--stdin-filename', 'foo.rb'] }
 
-        it 'uses working directory as source' do
-          expected_sources = Reek::Source::SourceLocator.new(['.']).sources
+        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 source files are excluded through configuration' do
-          let(:app) { described_class.new ['--config', 'some_file.reek'] }
+    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
 
-          before do
-            allow(Reek::Configuration::AppConfiguration).
-              to receive(:from_path).
-              with(Pathname.new('some_file.reek')).
-              and_return configuration
-          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
 
-          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)
+      context 'when source files are excluded through configuration' do
+        let(:app) { described_class.new ['--config', 'some_file.reek'] }
 
-            app.execute
+        before do
+          allow(Reek::Configuration::AppConfiguration).
+            to receive(:from_path).
+            with(Pathname.new('some_file.reek')).
+            and_return configuration
+        end
 
-            expect(Reek::CLI::Command::ReportCommand).to have_received(:new).
-              with(sources: expected_sources,
-                   configuration: configuration,
-                   options: Reek::CLI::Options)
-          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

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

@@ -1,6 +1,7 @@
 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(:nil_check) { build :smell_detector, smell_type: :NilCheck }
@@ -21,7 +22,7 @@ RSpec.describe Reek::CLI::Command::TodoListCommand do
       allow(File).to receive(:write).with(described_class::FILE_NAME, String)
     end
 
-    context 'smells found' do
+    context 'when smells are found' do
       let(:source_file) { SMELLY_FILE }
 
       it 'shows a proper message' do
@@ -37,14 +38,15 @@ RSpec.describe Reek::CLI::Command::TodoListCommand do
       it 'writes a todo file with exclusions for each smell' do
         Reek::CLI::Silencer.silently { command.execute }
         expected_yaml = {
-          'UncommunicativeMethodName' => { 'exclude' => ['Smelly#x'] },
-          'UncommunicativeVariableName' => { 'exclude' => ['Smelly#x'] }
+          Reek::Configuration::AppConfiguration::DETECTORS_KEY =>
+          { 'UncommunicativeMethodName' => { 'exclude' => ['Smelly#x'] },
+            'UncommunicativeVariableName' => { 'exclude' => ['Smelly#x'] } }
         }.to_yaml
         expect(File).to have_received(:write).with(described_class::FILE_NAME, expected_yaml)
       end
     end
 
-    context 'no smells found' do
+    context 'when no smells re found' do
       let(:source_file) { CLEAN_FILE }
 
       it 'shows a proper message' do

data/spec/reek/cli/silencer_spec.rb

@@ -0,0 +1,28 @@
+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

@@ -3,7 +3,7 @@ require_lib 'reek/code_comment'
 
 RSpec.describe Reek::CodeComment do
   context 'with an empty comment' do
-    let(:comment) { FactoryGirl.build(:code_comment, comment: '') }
+    let(:comment) { build(:code_comment, comment: '') }
 
     it 'is not descriptive' do
       expect(comment).not_to be_descriptive
@@ -14,33 +14,33 @@ RSpec.describe Reek::CodeComment do
     end
   end
 
-  context 'comment checks' do
+  describe '#descriptive' do
     it 'rejects an empty comment' do
-      comment = FactoryGirl.build(:code_comment, comment: '#')
+      comment = build(:code_comment, comment: '#')
       expect(comment).not_to be_descriptive
     end
 
     it 'rejects a 1-word comment' do
-      comment = FactoryGirl.build(:code_comment, comment: "# alpha\n#  ")
+      comment = build(:code_comment, comment: "# alpha\n#  ")
       expect(comment).not_to be_descriptive
     end
 
     it 'accepts a 2-word comment' do
-      comment = FactoryGirl.build(:code_comment, comment: '# alpha bravo  ')
+      comment = build(:code_comment, comment: '# alpha bravo  ')
       expect(comment).to be_descriptive
     end
 
     it 'accepts a multi-word comment' do
-      comment = FactoryGirl.build(:code_comment, comment: "# alpha bravo \n# charlie \n   # delta ")
+      comment = build(:code_comment, comment: "# alpha bravo \n# charlie \n   # delta ")
       expect(comment).to be_descriptive
     end
   end
 
-  context 'good comment config' do
+  describe 'good comment config' do
     it 'parses hashed options' do
       comment = '# :reek:DuplicateMethodCall { enabled: false }'
-      config = FactoryGirl.build(:code_comment,
-                                 comment: comment).config
+      config = build(:code_comment,
+                     comment: comment).config
 
       expect(config).to include('DuplicateMethodCall')
       expect(config['DuplicateMethodCall']).to include('enabled')
@@ -49,8 +49,8 @@ RSpec.describe Reek::CodeComment do
 
     it "supports hashed options with the legacy separator ':' after the smell detector" do
       comment = '# :reek:DuplicateMethodCall: { enabled: false }'
-      config = FactoryGirl.build(:code_comment,
-                                 comment: comment).config
+      config = build(:code_comment,
+                     comment: comment).config
 
       expect(config).to include('DuplicateMethodCall')
       expect(config['DuplicateMethodCall']).to include('enabled')
@@ -62,7 +62,7 @@ RSpec.describe Reek::CodeComment do
         # :reek:DuplicateMethodCall { enabled: false }
         # :reek:NestedIterators { enabled: true }
       EOF
-      config = FactoryGirl.build(:code_comment, comment: comment).config
+      config = build(:code_comment, comment: comment).config
 
       expect(config).to include('DuplicateMethodCall', 'NestedIterators')
       expect(config['DuplicateMethodCall']).to include('enabled')
@@ -75,7 +75,7 @@ RSpec.describe Reek::CodeComment do
       comment = <<-EOF
         #:reek:DuplicateMethodCall { enabled: false } and :reek:NestedIterators { enabled: true }
       EOF
-      config = FactoryGirl.build(:code_comment, comment: comment).config
+      config = build(:code_comment, comment: comment).config
 
       expect(config).to include('DuplicateMethodCall', 'NestedIterators')
       expect(config['DuplicateMethodCall']).to include('enabled')
@@ -86,7 +86,7 @@ RSpec.describe Reek::CodeComment do
 
     it 'parses multiple unhashed options on the same line' do
       comment = '# :reek:DuplicateMethodCall and :reek:NestedIterators'
-      config = FactoryGirl.build(:code_comment, comment: comment).config
+      config = build(:code_comment, comment: comment).config
 
       expect(config).to include('DuplicateMethodCall', 'NestedIterators')
       expect(config['DuplicateMethodCall']).to include('enabled')
@@ -97,7 +97,7 @@ RSpec.describe Reek::CodeComment do
 
     it 'disables the smell if no options are specifed' do
       comment = '# :reek:DuplicateMethodCall'
-      config = FactoryGirl.build(:code_comment, comment: comment).config
+      config = build(:code_comment, comment: comment).config
 
       expect(config).to include('DuplicateMethodCall')
       expect(config['DuplicateMethodCall']).to include('enabled')
@@ -105,8 +105,8 @@ RSpec.describe Reek::CodeComment do
     end
 
     it 'ignores smells after a space' do
-      config = FactoryGirl.build(:code_comment,
-                                 comment: '# :reek: DuplicateMethodCall').config
+      config = build(:code_comment,
+                     comment: '# :reek: DuplicateMethodCall').config
       expect(config).not_to include('DuplicateMethodCall')
     end
 
@@ -117,7 +117,7 @@ RSpec.describe Reek::CodeComment do
         # :reek:NestedIterators { enabled: true }
         # comment
       EOF
-      comment = FactoryGirl.build(:code_comment, comment: original_comment)
+      comment = build(:code_comment, comment: original_comment)
 
       expect(comment.send(:sanitized_comment)).to eq('Actual comment')
     end
@@ -125,66 +125,59 @@ RSpec.describe Reek::CodeComment do
 end
 
 RSpec.describe Reek::CodeComment::CodeCommentValidator do
-  context 'bad detector' do
+  context 'when the comment contains an unknown detector name' do
     it 'raises BadDetectorInCommentError' do
       expect do
-        FactoryGirl.build(:code_comment,
-                          comment: '# :reek:DoesNotExist')
+        build(:code_comment,
+              comment: '# :reek:DoesNotExist')
       end.to raise_error(Reek::Errors::BadDetectorInCommentError)
     end
   end
 
-  context 'unparsable detector configuration' do
+  context 'when the comment contains an unparsable detector configuration' do
     it 'raises GarbageDetectorConfigurationInCommentError' do
       expect do
         comment = '# :reek:UncommunicativeMethodName { thats: a: bad: config }'
-        FactoryGirl.build(:code_comment, comment: comment)
+        build(:code_comment, comment: comment)
       end.to raise_error(Reek::Errors::GarbageDetectorConfigurationInCommentError)
     end
   end
 
   describe 'validating configuration keys' do
-    context 'basic options mispelled' 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 }'
-          FactoryGirl.build(:code_comment, comment: comment)
+          build(:code_comment, comment: comment)
         end.to raise_error(Reek::Errors::BadDetectorConfigurationKeyInCommentError)
       end
     end
 
-    context 'basic options not mispelled' do
+    context 'when basic options are not mispelled' do
       it 'does not raise' do
         expect do
           comment = '# :reek:UncommunicativeMethodName { exclude: alfa, enabled: true }'
-          FactoryGirl.build(:code_comment, comment: comment)
-        end.not_to raise_error
-      end
-
-      it 'does not raise on regexps' do
-        expect do
-          comment = '# :reek:UncommunicativeMethodName { exclude: !ruby/regexp /alfa/ }'
-          FactoryGirl.build(:code_comment, comment: comment)
+          build(:code_comment, comment: comment)
         end.not_to raise_error
       end
     end
 
-    context 'unknown custom options' do
+    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 }'
-          FactoryGirl.build(:code_comment, comment: comment)
+          build(:code_comment, comment: comment)
         end.to raise_error(Reek::Errors::BadDetectorConfigurationKeyInCommentError)
       end
     end
 
-    context 'valid custom options' do
+    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 }'
-          FactoryGirl.build(:code_comment, comment: comment)
+          build(:code_comment, comment: comment)
         end.not_to raise_error
       end
     end

data/spec/reek/configuration/app_configuration_spec.rb

@@ -8,8 +8,8 @@ require_lib 'reek/configuration/excluded_paths'
 RSpec.describe Reek::Configuration::AppConfiguration do
   describe 'factory methods' do
     let(:expected_excluded_paths) do
-      [SAMPLES_PATH.join('two_smelly_files'),
-       SAMPLES_PATH.join('source_with_non_ruby_files')]
+      [SAMPLES_DIR.join('two_smelly_files'),
+       SAMPLES_DIR.join('source_with_non_ruby_files')]
     end
 
     let(:expected_default_directive) do
@@ -17,32 +17,35 @@ RSpec.describe Reek::Configuration::AppConfiguration do
     end
 
     let(:expected_directory_directives) do
-      { SAMPLES_PATH.join('three_clean_files') =>
+      { SAMPLES_DIR.join('three_clean_files') =>
         { Reek::SmellDetectors::UtilityFunction => { 'enabled' => false } } }
     end
 
     let(:default_directive_value) do
-      { 'IrresponsibleModule' => { 'enabled' => false } }
+      { described_class::DETECTORS_KEY =>
+        { 'IrresponsibleModule' => { 'enabled' => false } } }
     end
 
     let(:directory_directives_value) do
-      { 'samples/three_clean_files' =>
-        { 'UtilityFunction' => { 'enabled' => false } } }
+      { described_class::DIRECTORIES_KEY =>
+        { 'samples/three_clean_files' =>
+          { 'UtilityFunction' => { 'enabled' => false } } } }
     end
 
     let(:exclude_paths_value) do
-      ['samples/two_smelly_files',
-       'samples/source_with_non_ruby_files']
+      { described_class::EXCLUDE_PATHS_KEY =>
+        ['samples/two_smelly_files',
+         'samples/source_with_non_ruby_files'] }
     end
 
     let(:combined_value) do
       directory_directives_value.
         merge(default_directive_value).
-        merge('exclude_paths' => exclude_paths_value)
+        merge(exclude_paths_value)
     end
 
     describe '#from_path' do
-      let(:full_configuration_path) { CONFIG_PATH.join('full_configuration.reek') }
+      let(:full_configuration_path) { CONFIGURATION_DIR.join('full_configuration.reek') }
 
       it 'properly loads configuration and processes it' do
         config = described_class.from_path full_configuration_path
@@ -75,36 +78,40 @@ RSpec.describe Reek::Configuration::AppConfiguration do
   end
 
   describe '#directive_for' do
-    context 'multiple directory directives and no default directive present' do
+    context 'with multiple directory directives and no default directive present' do
       let(:source_via) { 'samples/three_clean_files/dummy.rb' }
-      let(:baz_config)  { { Reek::SmellDetectors::IrresponsibleModule => { enabled: false } } }
-      let(:bang_config) { { Reek::SmellDetectors::Attribute => { enabled: true } } }
+      let(:baz_config)  { { IrresponsibleModule: { enabled: false } } }
+      let(:bang_config) { { Attribute: { enabled: true } } }
+      let(:expected_result) { { Reek::SmellDetectors::Attribute => { enabled: true } } }
 
       let(:directory_directives) do
-        {
-          'samples/two_smelly_files' => baz_config,
-          'samples/three_clean_files' => bang_config
-        }
+        { described_class::DIRECTORIES_KEY =>
+          {
+            'samples/two_smelly_files' => baz_config,
+            'samples/three_clean_files' => bang_config
+          } }
       end
 
       it 'returns the corresponding directive' do
         configuration = described_class.from_hash directory_directives
-        expect(configuration.directive_for(source_via)).to eq(bang_config)
+        expect(configuration.directive_for(source_via)).to eq expected_result
       end
     end
 
-    context 'directory directive and default directive present' do
+    context 'with directory directive and default directive present' do
       let(:directory) { 'spec/samples/two_smelly_files/' }
-      let(:directory_config) { { Reek::SmellDetectors::TooManyStatements => { max_statements: 8 } } }
-      let(:directory_directives) { { directory => directory_config } }
-      let(:default_directive) do
+      let(:source_via) { "#{directory}/dummy.rb" }
+
+      let(:configuration_as_hash) do
         {
-          Reek::SmellDetectors::IrresponsibleModule => { enabled: false },
-          Reek::SmellDetectors::TooManyStatements => { max_statements: 15 }
+          described_class::DIRECTORIES_KEY =>
+            { directory => { TooManyStatements: { max_statements: 8 } } },
+          described_class::DETECTORS_KEY => {
+            IrresponsibleModule: { enabled: false },
+            TooManyStatements: { max_statements: 15 }
+          }
         }
       end
-      let(:source_via) { "#{directory}/dummy.rb" }
-      let(:configuration_as_hash) { directory_directives.merge(default_directive) }
 
       it 'returns the directory directive with the default directive reverse-merged' do
         configuration = described_class.from_hash configuration_as_hash
@@ -116,18 +123,24 @@ RSpec.describe Reek::Configuration::AppConfiguration do
       end
     end
 
-    context 'no directory directive but a default directive present' do
+    context 'with a path not covered by a directory directive but a default directive present' do
       let(:source_via) { 'spec/samples/three_clean_files/dummy.rb' }
-      let(:default_directive) { { Reek::SmellDetectors::IrresponsibleModule => { enabled: false } } }
-      let(:attribute_config) { { Reek::SmellDetectors::Attribute => { enabled: false } } }
-      let(:directory_directives) do
-        { 'spec/samples/two_smelly_files' => attribute_config }
+
+      let(:configuration_as_hash) do
+        {
+          described_class::DETECTORS_KEY => {
+            IrresponsibleModule: { enabled: false }
+          },
+          described_class::DIRECTORIES_KEY =>
+            { 'spec/samples/two_smelly_files' => { Attribute: { enabled: false } } }
+        }
       end
-      let(:configuration_as_hash) { directory_directives.merge(default_directive) }
+
+      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(default_directive)
+        expect(configuration.directive_for(source_via)).to eq expected_result
       end
     end
   end