reek 4.4.2 → 4.5.0

data/spec/reek/report/{code_climate_formatter_spec.rb → code_climate/code_climate_formatter_spec.rb}

@@ -1,11 +1,11 @@
-require_relative '../../spec_helper'
+require_relative '../../../spec_helper'
 require_lib 'reek/report/code_climate/code_climate_formatter'
 
 RSpec.describe Reek::Report::CodeClimateFormatter do
   describe '#render' do
     let(:warning) do
       FactoryGirl.build(:smell_warning,
-                        smell_detector: Reek::Smells::UtilityFunction.new,
+                        smell_detector: Reek::SmellDetectors::UtilityFunction.new,
                         context:        'context foo',
                         message:        'message bar',
                         lines:          [1, 2],
@@ -43,5 +43,9 @@ RSpec.describe Reek::Report::CodeClimateFormatter do
     it 'sets remediation points based on the smell detector' do
       expect(json['remediation_points']).to eq 250_000
     end
+
+    it 'sets fingerprint based on warning context' do
+      expect(json['fingerprint']).to eq '70c530e45999af129d520f1f579f967f'
+    end
   end
 end

data/spec/reek/report/{code_climate_report_spec.rb → code_climate/code_climate_report_spec.rb}

@@ -1,7 +1,6 @@
-require_relative '../../spec_helper'
+require_relative '../../../spec_helper'
 require_lib 'reek/examiner'
-require_lib 'reek/report/report'
-require_lib 'reek/report/formatter'
+require_lib 'reek/report/code_climate'
 
 require 'json'
 require 'stringio'
@@ -38,7 +37,8 @@ RSpec.describe Reek::Report::CodeClimateReport do
  doesn't communicate its intent well enough.\\n\\nPoor names make it hard for the reader
  to build a mental picture of what's going on in the code. They can also be
  mis-interpreted; and they hurt the flow of reading, because the reader must slow down
- to interpret the names.\\n\"}}\u0000
+ to interpret the names.\\n\"},
+\"fingerprint\":\"09970037d92b5a628bf682a3e2bb126d\"}\u0000
 {\"type\":\"issue\",
 \"check_name\":\"UtilityFunction\",
 \"description\":\"simple doesn't depend on instance state (maybe move it to another class?)\",
@@ -46,8 +46,10 @@ RSpec.describe Reek::Report::CodeClimateReport do
 \"location\":{\"path\":\"string\",\"lines\":{\"begin\":1,\"end\":1}},
 \"remediation_points\":250000,
 \"content\":{\"body\":\"A _Utility Function_ is any instance method that has no
- dependency on the state of the instance.\\n\"}}\u0000
+ dependency on the state of the instance.\\n\"},
+\"fingerprint\":\"db456db7cb344bb5a98b8fc54a2f382e\"}\u0000
       EOS
+
       expect { instance.show }.to output(expected).to_stdout
     end
   end

data/spec/reek/report/{location_formatter_spec.rb → formatter/location_formatter_spec.rb}

@@ -1,7 +1,7 @@
-require_relative '../../spec_helper'
+require_relative '../../../spec_helper'
 require_lib 'reek/report/formatter'
 
-RSpec.describe Reek::Report::BlankLocationFormatter do
+RSpec.describe Reek::Report::Formatter::BlankLocationFormatter do
   let(:warning) { build(:smell_warning, lines: [11, 9, 250, 100]) }
 
   describe '.format' do
@@ -11,7 +11,7 @@ RSpec.describe Reek::Report::BlankLocationFormatter do
   end
 end
 
-RSpec.describe Reek::Report::DefaultLocationFormatter do
+RSpec.describe Reek::Report::Formatter::DefaultLocationFormatter do
   let(:warning) { build(:smell_warning, lines: [11, 9, 250, 100]) }
 
   describe '.format' do
@@ -21,7 +21,7 @@ RSpec.describe Reek::Report::DefaultLocationFormatter do
   end
 end
 
-RSpec.describe Reek::Report::SingleLineLocationFormatter do
+RSpec.describe Reek::Report::Formatter::SingleLineLocationFormatter do
   let(:warning) { build(:smell_warning, lines: [11, 9, 250, 100]) }
 
   describe '.format' do

data/spec/reek/report/formatter/progress_formatter_spec.rb

@@ -0,0 +1,68 @@
+require_relative '../../../spec_helper'
+require_lib 'reek/report/formatter/progress_formatter'
+
+RSpec.describe Reek::Report::Formatter::ProgressFormatter::Dots do
+  let(:sources_count) { 23 }
+  let(:formatter) { described_class.new(sources_count) }
+
+  describe '#header' do
+    it 'announces the number of files to be inspected' do
+      expect(formatter.header).to eq "Inspecting 23 file(s):\n"
+    end
+  end
+
+  describe '#progress' do
+    let(:clean_examiner) { instance_double(Reek::Examiner, smelly?: false) }
+    let(:smelly_examiner) { instance_double(Reek::Examiner, smelly?: true) }
+
+    context 'with colors disabled' do
+      before do
+        Rainbow.enabled = false
+      end
+
+      it 'returns a dot for clean files' do
+        expect(formatter.progress(clean_examiner)).to eq '.'
+      end
+
+      it 'returns an S for smelly files' do
+        expect(formatter.progress(smelly_examiner)).to eq 'S'
+      end
+    end
+  end
+
+  describe '#footer' do
+    it 'returns some blank lines to offset the output' do
+      expect(formatter.footer).to eq "\n\n"
+    end
+  end
+end
+
+RSpec.describe Reek::Report::Formatter::ProgressFormatter::Quiet do
+  let(:sources_count) { 23 }
+  let(:formatter) { described_class.new(sources_count) }
+
+  describe '#header' do
+    it 'is quiet' do
+      expect(formatter.header).to eq ''
+    end
+  end
+
+  describe '#progress' do
+    let(:clean_examiner) { instance_double(Reek::Examiner, smelly?: false) }
+    let(:smelly_examiner) { instance_double(Reek::Examiner, smelly?: true) }
+
+    it 'is quiet for clean files' do
+      expect(formatter.progress(clean_examiner)).to eq ''
+    end
+
+    it 'is quiet for smelly files' do
+      expect(formatter.progress(smelly_examiner)).to eq ''
+    end
+  end
+
+  describe '#footer' do
+    it 'is quiet' do
+      expect(formatter.footer).to eq ''
+    end
+  end
+end

data/spec/reek/report/html_report_spec.rb

@@ -1,6 +1,6 @@
 require_relative '../../spec_helper'
 require_lib 'reek/examiner'
-require_lib 'reek/report/report'
+require_lib 'reek/report/html_report'
 
 RSpec.describe Reek::Report::HTMLReport do
   let(:instance) { described_class.new }

data/spec/reek/report/json_report_spec.rb

@@ -1,6 +1,6 @@
 require_relative '../../spec_helper'
 require_lib 'reek/examiner'
-require_lib 'reek/report/report'
+require_lib 'reek/report/json_report'
 require_lib 'reek/report/formatter'
 
 require 'json'
@@ -55,7 +55,7 @@ RSpec.describe Reek::Report::JSONReport do
     end
 
     context 'with link formatter' do
-      let(:options) { { warning_formatter: Reek::Report::WikiLinkWarningFormatter.new } }
+      let(:options) { { warning_formatter: Reek::Report::Formatter::WikiLinkWarningFormatter.new } }
 
       it 'prints documentation links' do
         out = StringIO.new

data/spec/reek/report/text_report_spec.rb

@@ -1,16 +1,15 @@
 require_relative '../../spec_helper'
 require_lib 'reek/examiner'
-require_lib 'reek/report/report'
+require_lib 'reek/report/text_report'
 require_lib 'reek/report/formatter'
-require_lib 'reek/report/heading_formatter'
 require 'rainbow'
 
 RSpec.describe Reek::Report::TextReport do
   let(:report_options) do
     {
-      warning_formatter: Reek::Report::SimpleWarningFormatter.new,
+      warning_formatter: Reek::Report::Formatter::SimpleWarningFormatter.new,
       report_formatter: Reek::Report::Formatter,
-      heading_formatter: Reek::Report::HeadingFormatter::Quiet
+      heading_formatter: Reek::Report::Formatter::QuietHeadingFormatter
     }
   end
   let(:instance) { described_class.new report_options }

data/spec/reek/report/xml_report_spec.rb

@@ -1,6 +1,6 @@
 require_relative '../../spec_helper'
 require_lib 'reek/examiner'
-require_lib 'reek/report/report'
+require_lib 'reek/report/xml_report'
 
 RSpec.describe Reek::Report::XMLReport do
   let(:xml_report) { described_class.new }

data/spec/reek/report/yaml_report_spec.rb

@@ -1,6 +1,6 @@
 require_relative '../../spec_helper'
 require_lib 'reek/examiner'
-require_lib 'reek/report/report'
+require_lib 'reek/report/yaml_report'
 require_lib 'reek/report/formatter'
 
 require 'yaml'
@@ -51,7 +51,7 @@ RSpec.describe Reek::Report::YAMLReport do
       expect(result).to eq expected
     end
     context 'with link formatter' do
-      let(:options) { { warning_formatter: Reek::Report::WikiLinkWarningFormatter.new } }
+      let(:options) { { warning_formatter: Reek::Report::Formatter::WikiLinkWarningFormatter.new } }
 
       it 'prints documentation links' do
         out = StringIO.new

data/spec/reek/report_spec.rb

@@ -10,19 +10,19 @@ RSpec.describe Reek::Report do
 
   describe '.location_formatter' do
     it 'returns the correct class' do
-      expect(described_class.location_formatter(:plain)).to eq Reek::Report::BlankLocationFormatter
+      expect(described_class.location_formatter(:plain)).to eq Reek::Report::Formatter::BlankLocationFormatter
     end
   end
 
   describe '.heading_formatter' do
     it 'returns the correct class' do
-      expect(described_class.heading_formatter(:quiet)).to eq Reek::Report::HeadingFormatter::Quiet
+      expect(described_class.heading_formatter(:quiet)).to eq Reek::Report::Formatter::QuietHeadingFormatter
     end
   end
 
   describe '.warning_formatter_class' do
     it 'returns the correct class' do
-      expect(described_class.warning_formatter_class(:simple)).to eq Reek::Report::SimpleWarningFormatter
+      expect(described_class.warning_formatter_class(:simple)).to eq Reek::Report::Formatter::SimpleWarningFormatter
     end
   end
 end

data/spec/reek/{smells → smell_detectors}/attribute_spec.rb

@@ -1,7 +1,7 @@
 require_relative '../../spec_helper'
-require_lib 'reek/smells/attribute'
+require_lib 'reek/smell_detectors/attribute'
 
-RSpec.describe Reek::Smells::Attribute do
+RSpec.describe Reek::SmellDetectors::Attribute do
   it 'reports the right values' do
     src = <<-EOS
       class Alfa

data/spec/reek/{smells/smell_detector_spec.rb → smell_detectors/base_detector_spec.rb}

@@ -1,24 +1,24 @@
 require_relative '../../spec_helper'
-require_lib 'reek/smells/smell_detector'
+require_lib 'reek/smell_detectors/base_detector'
 
-RSpec.describe Reek::Smells::SmellDetector do
+RSpec.describe Reek::SmellDetectors::BaseDetector do
   describe '.todo_configuration_for' do
     it 'returns exclusion configuration for the given smells' do
       detector = described_class.new
       smell = create(:smell_warning, smell_detector: detector, context: 'Foo#bar')
       result = described_class.todo_configuration_for([smell])
-      expect(result).to eq('SmellDetector' => { 'exclude' => ['Foo#bar'] })
+      expect(result).to eq('BaseDetector' => { 'exclude' => ['Foo#bar'] })
     end
 
     it 'merges identical contexts' do
       detector = described_class.new
       smell = create(:smell_warning, smell_detector: detector, context: 'Foo#bar')
       result = described_class.todo_configuration_for([smell, smell])
-      expect(result).to eq('SmellDetector' => { 'exclude' => ['Foo#bar'] })
+      expect(result).to eq('BaseDetector' => { 'exclude' => ['Foo#bar'] })
     end
 
     context 'with default exclusions present' do
-      let(:subclass) { Reek::Smells::TooManyStatements }
+      let(:subclass) { Reek::SmellDetectors::TooManyStatements }
 
       before do
         expect(subclass.default_config['exclude']).to eq ['initialize']

data/spec/reek/{smells → smell_detectors}/boolean_parameter_spec.rb

@@ -1,7 +1,7 @@
 require_relative '../../spec_helper'
-require_lib 'reek/smells/boolean_parameter'
+require_lib 'reek/smell_detectors/boolean_parameter'
 
-RSpec.describe Reek::Smells::BooleanParameter do
+RSpec.describe Reek::SmellDetectors::BooleanParameter do
   it 'reports the right values' do
     src = <<-EOS
       def alfa(bravo = true)

data/spec/reek/{smells → smell_detectors}/class_variable_spec.rb

@@ -1,7 +1,7 @@
 require_relative '../../spec_helper'
-require_lib 'reek/smells/class_variable'
+require_lib 'reek/smell_detectors/class_variable'
 
-RSpec.describe Reek::Smells::ClassVariable do
+RSpec.describe Reek::SmellDetectors::ClassVariable do
   it 'reports the right values' do
     src = <<-EOS
       class Alfa

data/spec/reek/{smells → smell_detectors}/control_parameter_spec.rb

@@ -1,7 +1,7 @@
 require_relative '../../spec_helper'
-require_lib 'reek/smells/control_parameter'
+require_lib 'reek/smell_detectors/control_parameter'
 
-RSpec.describe Reek::Smells::ControlParameter do
+RSpec.describe Reek::SmellDetectors::ControlParameter do
   it 'reports the right values' do
     src = <<-EOS
       def alfa(bravo)

data/spec/reek/{smells → smell_detectors}/data_clump_spec.rb

@@ -1,7 +1,7 @@
 require_relative '../../spec_helper'
-require_lib 'reek/smells/data_clump'
+require_lib 'reek/smell_detectors/data_clump'
 
-RSpec.describe Reek::Smells::DataClump do
+RSpec.describe Reek::SmellDetectors::DataClump do
   it 'reports the right values' do
     src = <<-EOS
       class Alfa

data/spec/reek/smell_detectors/detector_repository_spec.rb

@@ -0,0 +1,22 @@
+require_relative '../../spec_helper'
+require_lib 'reek/smell_detectors/base_detector'
+require_lib 'reek/smell_detectors/detector_repository'
+
+RSpec.describe Reek::SmellDetectors::DetectorRepository do
+  describe '.smell_types' do
+    let(:smell_types) { described_class.smell_types }
+
+    it 'includes existing smell_types' do
+      expect(smell_types).to include(Reek::SmellDetectors::IrresponsibleModule).
+        and include(Reek::SmellDetectors::TooManyStatements)
+    end
+
+    it 'excludes the smell detector base class' do
+      expect(smell_types).not_to include(Reek::SmellDetectors::BaseDetector)
+    end
+
+    it 'returns the smell types in alphabetic order' do
+      expect(smell_types).to eq(smell_types.sort_by(&:name))
+    end
+  end
+end

data/spec/reek/{smells → smell_detectors}/duplicate_method_call_spec.rb

@@ -1,7 +1,7 @@
 require_relative '../../spec_helper'
-require_lib 'reek/smells/duplicate_method_call'
+require_lib 'reek/smell_detectors/duplicate_method_call'
 
-RSpec.describe Reek::Smells::DuplicateMethodCall do
+RSpec.describe Reek::SmellDetectors::DuplicateMethodCall do
   it 'reports the right values' do
     src = <<-EOS
       class Alfa
@@ -164,7 +164,7 @@ RSpec.describe Reek::Smells::DuplicateMethodCall do
 
   context 'allowing up to 3 calls' do
     let(:config) do
-      { Reek::Smells::DuplicateMethodCall::MAX_ALLOWED_CALLS_KEY => 3 }
+      { Reek::SmellDetectors::DuplicateMethodCall::MAX_ALLOWED_CALLS_KEY => 3 }
     end
 
     it 'does not report double calls' do
@@ -191,19 +191,19 @@ RSpec.describe Reek::Smells::DuplicateMethodCall do
 
   context 'allowing calls to some methods' do
     it 'does not report calls to some methods' do
-      config = { Reek::Smells::DuplicateMethodCall::ALLOW_CALLS_KEY => ['@bravo.charlie'] }
+      config = { Reek::SmellDetectors::DuplicateMethodCall::ALLOW_CALLS_KEY => ['@bravo.charlie'] }
       src = 'def alfa; @bravo.charlie + @bravo.charlie; end'
       expect(src).not_to reek_of(:DuplicateMethodCall).with_config(config)
     end
 
     it 'reports calls to other methods' do
-      config = { Reek::Smells::DuplicateMethodCall::ALLOW_CALLS_KEY => ['@delta.charlie'] }
+      config = { Reek::SmellDetectors::DuplicateMethodCall::ALLOW_CALLS_KEY => ['@delta.charlie'] }
       src = 'def alfa; @bravo.charlie + @bravo.charlie; end'
       expect(src).to reek_of(:DuplicateMethodCall, name: '@bravo.charlie').with_config(config)
     end
 
     it 'does not report calls to methods specifed with a regular expression' do
-      config = { Reek::Smells::DuplicateMethodCall::ALLOW_CALLS_KEY => [/charlie/] }
+      config = { Reek::SmellDetectors::DuplicateMethodCall::ALLOW_CALLS_KEY => [/charlie/] }
       src = 'def alfa; puts @bravo.charlie; puts @bravo.charlie; end'
       expect(src).not_to reek_of(:DuplicateMethodCall, name: '@bravo.charlie').with_config(config)
     end

data/spec/reek/{smells → smell_detectors}/feature_envy_spec.rb

@@ -1,7 +1,7 @@
 require_relative '../../spec_helper'
-require_lib 'reek/smells/feature_envy'
+require_lib 'reek/smell_detectors/feature_envy'
 
-RSpec.describe Reek::Smells::FeatureEnvy do
+RSpec.describe Reek::SmellDetectors::FeatureEnvy do
   it 'reports the right values' do
     src = <<-EOS
       class Alfa

data/spec/reek/{smells → smell_detectors}/instance_variable_assumption_spec.rb

@@ -1,8 +1,8 @@
 require_relative '../../spec_helper'
 
-require_lib 'reek/smells/instance_variable_assumption'
+require_lib 'reek/smell_detectors/instance_variable_assumption'
 
-RSpec.describe Reek::Smells::InstanceVariableAssumption do
+RSpec.describe Reek::SmellDetectors::InstanceVariableAssumption do
   it 'reports the right values' do
     src = <<-EOS
       class Alfa

data/spec/reek/{smells → smell_detectors}/irresponsible_module_spec.rb

@@ -1,7 +1,7 @@
 require_relative '../../spec_helper'
-require_lib 'reek/smells/irresponsible_module'
+require_lib 'reek/smell_detectors/irresponsible_module'
 
-RSpec.describe Reek::Smells::IrresponsibleModule do
+RSpec.describe Reek::SmellDetectors::IrresponsibleModule do
   it 'reports the right values' do
     src = <<-EOS
       class Alfa

data/spec/reek/{smells → smell_detectors}/long_parameter_list_spec.rb

@@ -1,7 +1,7 @@
 require_relative '../../spec_helper'
-require_lib 'reek/smells/long_parameter_list'
+require_lib 'reek/smell_detectors/long_parameter_list'
 
-RSpec.describe Reek::Smells::LongParameterList do
+RSpec.describe Reek::SmellDetectors::LongParameterList do
   it 'reports the right values' do
     src = <<-EOS
       class Alfa

data/spec/reek/{smells → smell_detectors}/long_yield_list_spec.rb

@@ -1,7 +1,7 @@
 require_relative '../../spec_helper'
-require_lib 'reek/smells/long_yield_list'
+require_lib 'reek/smell_detectors/long_yield_list'
 
-RSpec.describe Reek::Smells::LongYieldList do
+RSpec.describe Reek::SmellDetectors::LongYieldList do
   it 'reports the right values' do
     src = <<-EOS
       class Alfa