reek 5.0.2 → 5.1.0

data/spec/factories/factories.rb

@@ -7,7 +7,7 @@ FactoryBot.define do
   factory :smell_detector, class: Reek::SmellDetectors::BaseDetector do
     skip_create
     transient do
-      smell_type 'FeatureEnvy'
+      smell_type { 'FeatureEnvy' }
     end
 
     initialize_with do
@@ -18,11 +18,12 @@ FactoryBot.define do
   factory :smell_warning, class: Reek::SmellWarning do
     skip_create
     smell_detector
-    context 'self'
-    source 'dummy_file'
-    lines [42]
-    message 'smell warning message'
-    parameters({})
+    context { 'self' }
+
+    source { 'dummy_file' }
+    lines { [42] }
+    message { 'smell warning message' }
+    parameters { {} }
 
     initialize_with do
       new(smell_detector,
@@ -35,9 +36,9 @@ FactoryBot.define do
   end
 
   factory :code_comment, class: Reek::CodeComment do
-    comment ''
-    line 1
-    source 'string'
+    comment { '' }
+    line { 1 }
+    source { 'string' }
     initialize_with do
       new comment: comment,
           line: line,

data/spec/performance/reek/smell_detectors/runtime_speed_spec.rb

@@ -0,0 +1,17 @@
+require_relative '../../../spec_helper'
+require_lib 'reek/examiner'
+
+RSpec.describe 'Runtime speed' do
+  let(:source_directory) { SAMPLES_DIR.join('smelly_source') }
+
+  it 'runs on our smelly sources in less than 5 seconds' do
+    expect do
+      source_directory.each_entry do |entry|
+        next if %w(. ..).include?(entry.to_s)
+
+        examiner = Reek::Examiner.new entry.to_path
+        examiner.smells.size
+      end
+    end.to perform_under(5).sec
+  end
+end

data/spec/quality/documentation_spec.rb

@@ -0,0 +1,40 @@
+require_relative '../spec_helper'
+require 'kramdown'
+
+RSpec.describe 'Documentation' do
+  root = File.expand_path('../..', __dir__)
+  files = Dir.glob(File.join(root, '*.md')) + Dir.glob(File.join(root, 'docs', '*.md'))
+
+  files.each do |file|
+    describe "from #{file}" do
+      text = File.read(file)
+      doc = Kramdown::Document.new(text, input: 'GFM')
+      blocks = doc.root.children
+
+      blocks.each do |block|
+        # Only consider code blocks with language 'ruby'.
+        next unless [:codeblock, :codespan].include?(block.type)
+        next unless block.attr['class'] == 'language-ruby'
+
+        it "has a valid sample at #{block.options[:location] + 1}" do
+          code = block.value.strip
+
+          # Replace lines of the form `<expression> # => <result>` with
+          # assertions.
+          #
+          # For example,
+          #
+          #   2 + 2 # => 4
+          #
+          # will be replaced by
+          #
+          #   assert_equal(4, 2 + 2)
+          #
+          spec_code = code.gsub(/(^.+) # ?=> (.+$)/, 'assert_equal(\2, \1)')
+
+          eval spec_code # rubocop:disable Security/Eval
+        end
+      end
+    end
+  end
+end

data/spec/reek/ast/sexp_extensions_spec.rb

@@ -25,15 +25,15 @@ RSpec.describe Reek::AST::SexpExtensions::DefNode do
   context 'with 1 parameter' do
     let(:node) do
       sexp(:def, :hello,
-           sexp(:args, sexp(:arg, :param)))
+           sexp(:args, sexp(:arg, :parameter)))
     end
 
     it 'has 1 arg name' do
-      expect(node.arg_names).to eq [:param]
+      expect(node.arg_names).to eq [:parameter]
     end
 
     it 'has 1 parameter name' do
-      expect(node.parameter_names).to eq [:param]
+      expect(node.parameter_names).to eq [:parameter]
     end
 
     it 'includes outer scope in its full name' do
@@ -49,16 +49,16 @@ RSpec.describe Reek::AST::SexpExtensions::DefNode do
     let(:node) do
       sexp(:def, :hello,
            sexp(:args,
-                sexp(:arg, :param),
+                sexp(:arg, :parameter),
                 sexp(:blockarg, :blk)))
     end
 
     it 'has 1 arg name' do
-      expect(node.arg_names).to eq [:param]
+      expect(node.arg_names).to eq [:parameter]
     end
 
     it 'has 2 parameter names' do
-      expect(node.parameter_names).to eq [:param, :blk]
+      expect(node.parameter_names).to eq [:parameter, :blk]
     end
 
     it 'includes outer scope in its full name' do
@@ -74,15 +74,15 @@ RSpec.describe Reek::AST::SexpExtensions::DefNode do
     let(:node) do
       sexp(:def, :hello,
            sexp(:args,
-                sexp(:optarg, :param, sexp(:array))))
+                sexp(:optarg, :parameter, sexp(:array))))
     end
 
     it 'has 1 arg name' do
-      expect(node.arg_names).to eq [:param]
+      expect(node.arg_names).to eq [:parameter]
     end
 
     it 'has 1 parameter name' do
-      expect(node.parameter_names).to eq [:param]
+      expect(node.parameter_names).to eq [:parameter]
     end
 
     it 'includes outer scope in its full name' do
@@ -168,15 +168,15 @@ RSpec.describe Reek::AST::SexpExtensions::DefsNode do
   context 'with 1 parameter' do
     let(:node) do
       sexp(:defs, sexp(:lvar, :obj), :hello,
-           sexp(:args, sexp(:arg, :param)))
+           sexp(:args, sexp(:arg, :parameter)))
     end
 
     it 'has 1 arg name' do
-      expect(node.arg_names).to eq [:param]
+      expect(node.arg_names).to eq [:parameter]
     end
 
     it 'has 1 parameter name' do
-      expect(node.parameter_names).to eq [:param]
+      expect(node.parameter_names).to eq [:parameter]
     end
 
     it 'includes outer scope in its full name' do
@@ -192,16 +192,16 @@ RSpec.describe Reek::AST::SexpExtensions::DefsNode do
     let(:node) do
       sexp(:defs, sexp(:lvar, :obj), :hello,
            sexp(:args,
-                sexp(:arg, :param),
+                sexp(:arg, :parameter),
                 sexp(:blockarg, :blk)))
     end
 
     it 'has 1 arg name' do
-      expect(node.arg_names).to eq [:param]
+      expect(node.arg_names).to eq [:parameter]
     end
 
     it 'has 2 parameter names' do
-      expect(node.parameter_names).to eq [:param, :blk]
+      expect(node.parameter_names).to eq [:parameter, :blk]
     end
 
     it 'includes outer scope in its full name' do
@@ -217,15 +217,15 @@ RSpec.describe Reek::AST::SexpExtensions::DefsNode do
     let(:node) do
       sexp(:defs, sexp(:lvar, :obj), :hello,
            sexp(:args,
-                sexp(:optarg, :param, sexp(:array))))
+                sexp(:optarg, :parameter, sexp(:array))))
     end
 
     it 'has 1 arg name' do
-      expect(node.arg_names).to eq [:param]
+      expect(node.arg_names).to eq [:parameter]
     end
 
     it 'has 1 parameter name' do
-      expect(node.parameter_names).to eq [:param]
+      expect(node.parameter_names).to eq [:parameter]
     end
 
     it 'includes outer scope in its full name' do
@@ -355,10 +355,10 @@ RSpec.describe Reek::AST::SexpExtensions::BlockNode do
   end
 
   context 'with 1 parameter' do
-    let(:node) { sexp(:block, sexp(:send, nil, :map), sexp(:args, :param), nil) }
+    let(:node) { sexp(:block, sexp(:send, nil, :map), sexp(:args, :parameter), nil) }
 
     it 'has 1 parameter name' do
-      expect(node.parameter_names).to eq [:param]
+      expect(node.parameter_names).to eq [:parameter]
     end
   end
 

data/spec/reek/cli/application_spec.rb

@@ -136,4 +136,33 @@ RSpec.describe Reek::CLI::Application do
       end
     end
   end
+
+  describe 'show configuration path' do
+    let(:app) { described_class.new ['--show-configuration-path', '.'] }
+
+    around do |example|
+      Dir.mktmpdir('/tmp') 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/todo_list_command_spec.rb

@@ -4,65 +4,83 @@ 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 }
-  let(:nested_iterators) { build :smell_detector, smell_type: :NestedIterators }
+  let(:existing_configuration) do
+    <<-EOS.strip_heredoc
+    ---
+    detectors:
+      UncommunicativeMethodName:
+        exclude:
+        - Smelly#x
+    EOS
+  end
 
-  describe '#execute' do
-    let(:options) { Reek::CLI::Options.new [] }
-    let(:configuration) { instance_double 'Reek::Configuration::AppConfiguration' }
-    let(:sources) { [source_file] }
+  let(:smelly_file) do
+    <<-EOS
+      # Smelly class
+      class Smelly
+        # This will reek of UncommunicativeMethodName
+        def x
+          y = 10 # This will reek of UncommunicativeVariableName
+        end
+      end
+    EOS
+  end
 
-    let(:command) do
-      described_class.new(options: options,
-                          sources: sources,
-                          configuration: configuration)
-    end
+  let(:new_configuration_file) do
+    <<-EOS.strip_heredoc
+    # Auto generated by Reeks --todo flag
+    ---
+    detectors:
+      UncommunicativeMethodName:
+        exclude:
+        - Smelly#x
+      UncommunicativeVariableName:
+        exclude:
+        - Smelly#x
+    EOS
+  end
 
-    before do
-      allow(File).to receive(:write).with(described_class::FILE_NAME, String)
+  describe '#execute on smelly source' do
+    around do |example|
+      Dir.mktmpdir('/tmp') do |tmp|
+        Dir.chdir(tmp) do
+          File.write SMELLY_FILE.basename, smelly_file
+          example.run
+        end
+      end
     end
 
-    context 'when smells are found' do
-      let(:source_file) { SMELLY_FILE }
+    context 'with default configuration file' do
+      let(:default_configuration_file_name) { Reek::DEFAULT_CONFIGURATION_FILE_NAME }
 
-      it 'shows a proper message' do
-        expected = "\n'.todo.reek' generated! You can now use this as a starting point for your configuration.\n"
-        expect { command.execute }.to output(expected).to_stdout
-      end
+      context 'when does not exist yet' do
+        it 'creates it' do
+          Reek::CLI::Silencer.silently { todo_command.execute }
 
-      it 'returns a success code' do
-        result = Reek::CLI::Silencer.silently { command.execute }
-        expect(result).to eq(Reek::CLI::Status::DEFAULT_SUCCESS_EXIT_CODE)
+          actual_content = File.read(default_configuration_file_name)
+          expect(actual_content).to match(new_configuration_file)
+        end
       end
 
-      it 'writes a todo file with exclusions for each smell' do
-        Reek::CLI::Silencer.silently { command.execute }
-        expected_yaml = {
-          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 'when exists already' do
+        it 'does not update the configuration' do
+          File.write default_configuration_file_name, existing_configuration
+          command = todo_command
 
-    context 'when no smells re found' do
-      let(:source_file) { CLEAN_FILE }
-
-      it 'shows a proper message' do
-        expected = "\n'.todo.reek' not generated because there were no smells found!\n"
-        expect { command.execute }.to output(expected).to_stdout
-      end
+          Reek::CLI::Silencer.silently { command.execute }
 
-      it 'returns a success code' do
-        result = Reek::CLI::Silencer.silently { command.execute }
-        expect(result).to eq Reek::CLI::Status::DEFAULT_SUCCESS_EXIT_CODE
+          actual_content = File.read(default_configuration_file_name)
+          expect(actual_content).to match(existing_configuration)
+        end
       end
+    end
 
-      it 'does not write a todo file' do
-        Reek::CLI::Silencer.silently { command.execute }
-        expect(File).not_to have_received(:write)
-      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/configuration/app_configuration_spec.rb

@@ -22,18 +22,18 @@ RSpec.describe Reek::Configuration::AppConfiguration do
     end
 
     let(:default_directive_value) do
-      { described_class::DETECTORS_KEY =>
+      { Reek::DETECTORS_KEY =>
         { 'IrresponsibleModule' => { 'enabled' => false } } }
     end
 
     let(:directory_directives_value) do
-      { described_class::DIRECTORIES_KEY =>
+      { Reek::DIRECTORIES_KEY =>
         { 'samples/three_clean_files' =>
           { 'UtilityFunction' => { 'enabled' => false } } } }
     end
 
     let(:exclude_paths_value) do
-      { described_class::EXCLUDE_PATHS_KEY =>
+      { Reek::EXCLUDE_PATHS_KEY =>
         ['samples/two_smelly_files',
          'samples/source_with_non_ruby_files'] }
     end
@@ -85,7 +85,7 @@ RSpec.describe Reek::Configuration::AppConfiguration do
       let(:expected_result) { { Reek::SmellDetectors::Attribute => { enabled: true } } }
 
       let(:directory_directives) do
-        { described_class::DIRECTORIES_KEY =>
+        { Reek::DIRECTORIES_KEY =>
           {
             'samples/two_smelly_files' => baz_config,
             'samples/three_clean_files' => bang_config
@@ -104,9 +104,9 @@ RSpec.describe Reek::Configuration::AppConfiguration do
 
       let(:configuration_as_hash) do
         {
-          described_class::DIRECTORIES_KEY =>
+          Reek::DIRECTORIES_KEY =>
             { directory => { TooManyStatements: { max_statements: 8 } } },
-          described_class::DETECTORS_KEY => {
+          Reek::DETECTORS_KEY => {
             IrresponsibleModule: { enabled: false },
             TooManyStatements: { max_statements: 15 }
           }
@@ -128,10 +128,10 @@ RSpec.describe Reek::Configuration::AppConfiguration do
 
       let(:configuration_as_hash) do
         {
-          described_class::DETECTORS_KEY => {
+          Reek::DETECTORS_KEY => {
             IrresponsibleModule: { enabled: false }
           },
-          described_class::DIRECTORIES_KEY =>
+          Reek::DIRECTORIES_KEY =>
             { 'spec/samples/two_smelly_files' => { Attribute: { enabled: false } } }
         }
       end

data/spec/reek/configuration/configuration_file_finder_spec.rb

@@ -98,7 +98,7 @@ RSpec.describe Reek::Configuration::ConfigurationFileFinder do
   describe '.load_from_file' do
     let(:sample_configuration_loaded) do
       {
-        Reek::Configuration::AppConfiguration::DETECTORS_KEY => {
+        Reek::DETECTORS_KEY => {
           'UncommunicativeVariableName' => { 'enabled' => false },
           'UncommunicativeMethodName'   => { 'enabled' => false }
         }
@@ -123,7 +123,7 @@ RSpec.describe Reek::Configuration::ConfigurationFileFinder do
         let(:configuration) do
           described_class.
             load_from_file(CONFIGURATION_DIR.join('accepts_rejects_and_excludes_for_detectors.reek.yml')).
-            fetch(Reek::Configuration::AppConfiguration::DETECTORS_KEY)
+            fetch(Reek::DETECTORS_KEY)
         end
 
         let(:expected) do
@@ -166,7 +166,7 @@ RSpec.describe Reek::Configuration::ConfigurationFileFinder do
         let(:configuration) do
           described_class.
             load_from_file(CONFIGURATION_DIR.join('accepts_rejects_and_excludes_for_directory_directives.reek.yml')).
-            fetch(Reek::Configuration::AppConfiguration::DIRECTORIES_KEY)
+            fetch(Reek::DIRECTORIES_KEY)
         end
 
         let(:expected) do