reek 3.4.0 → 3.4.1

data/spec/reek/examiner_spec.rb

@@ -1,5 +1,5 @@
 require_relative '../spec_helper'
-require_relative '../../lib/reek/examiner'
+require_lib 'reek/examiner'
 
 RSpec.shared_examples_for 'no smells found' do
   it 'is not smelly' do

data/spec/reek/report/html_report_spec.rb

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

data/spec/reek/report/json_report_spec.rb

@@ -1,7 +1,7 @@
 require_relative '../../spec_helper'
-require_relative '../../../lib/reek/examiner'
-require_relative '../../../lib/reek/report/report'
-require_relative '../../../lib/reek/report/formatter'
+require_lib 'reek/examiner'
+require_lib 'reek/report/report'
+require_lib 'reek/report/formatter'
 
 require 'json'
 require 'stringio'

data/spec/reek/report/location_formatter_spec.rb

@@ -0,0 +1,30 @@
+require_relative '../../spec_helper'
+require_lib 'reek/report/formatter'
+
+RSpec.describe 'location formatters' do
+  let(:warning) { build(:smell_warning, lines: [11, 9, 250, 100]) }
+
+  describe Reek::Report::BlankLocationFormatter do
+    describe '.format' do
+      it 'returns a blank String regardless of the warning' do
+        expect(described_class.format(warning)).to eq('')
+      end
+    end
+  end
+
+  describe Reek::Report::DefaultLocationFormatter do
+    describe '.format' do
+      it 'returns a prefix with sorted line numbers' do
+        expect(described_class.format(warning)).to eq('[9, 11, 100, 250]:')
+      end
+    end
+  end
+
+  describe Reek::Report::SingleLineLocationFormatter do
+    describe '.format' do
+      it 'returns the first line where the smell was found' do
+        expect(described_class.format(warning)).to eq('dummy_file:9: ')
+      end
+    end
+  end
+end

data/spec/reek/report/text_report_spec.rb

@@ -1,8 +1,8 @@
 require_relative '../../spec_helper'
-require_relative '../../../lib/reek/examiner'
-require_relative '../../../lib/reek/report/report'
-require_relative '../../../lib/reek/report/formatter'
-require_relative '../../../lib/reek/report/heading_formatter'
+require_lib 'reek/examiner'
+require_lib 'reek/report/report'
+require_lib 'reek/report/formatter'
+require_lib 'reek/report/heading_formatter'
 require 'rainbow'
 
 RSpec.describe Reek::Report::TextReport do

data/spec/reek/report/xml_report_spec.rb

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

data/spec/reek/report/yaml_report_spec.rb

@@ -1,7 +1,7 @@
 require_relative '../../spec_helper'
-require_relative '../../../lib/reek/examiner'
-require_relative '../../../lib/reek/report/report'
-require_relative '../../../lib/reek/report/formatter'
+require_lib 'reek/examiner'
+require_lib 'reek/report/report'
+require_lib 'reek/report/formatter'
 
 require 'yaml'
 require 'stringio'

data/spec/reek/smells/attribute_spec.rb

@@ -1,5 +1,5 @@
 require_relative '../../spec_helper'
-require_relative '../../../lib/reek/smells/attribute'
+require_lib 'reek/smells/attribute'
 require_relative 'smell_detector_shared'
 
 RSpec.describe Reek::Smells::Attribute do

data/spec/reek/smells/boolean_parameter_spec.rb

@@ -1,5 +1,5 @@
 require_relative '../../spec_helper'
-require_relative '../../../lib/reek/smells/boolean_parameter'
+require_lib 'reek/smells/boolean_parameter'
 require_relative 'smell_detector_shared'
 
 RSpec.describe Reek::Smells::BooleanParameter do

data/spec/reek/smells/class_variable_spec.rb

@@ -1,6 +1,6 @@
 require_relative '../../spec_helper'
-require_relative '../../../lib/reek/smells/class_variable'
-require_relative '../../../lib/reek/context/module_context'
+require_lib 'reek/smells/class_variable'
+require_lib 'reek/context/module_context'
 require_relative 'smell_detector_shared'
 
 RSpec.describe Reek::Smells::ClassVariable do

data/spec/reek/smells/control_parameter_spec.rb

@@ -1,5 +1,5 @@
 require_relative '../../spec_helper'
-require_relative '../../../lib/reek/smells/control_parameter'
+require_lib 'reek/smells/control_parameter'
 require_relative 'smell_detector_shared'
 
 RSpec.describe Reek::Smells::ControlParameter do

data/spec/reek/smells/data_clump_spec.rb

@@ -1,5 +1,5 @@
 require_relative '../../spec_helper'
-require_relative '../../../lib/reek/smells/data_clump'
+require_lib 'reek/smells/data_clump'
 require_relative 'smell_detector_shared'
 
 RSpec.shared_examples_for 'a data clump detector' do

data/spec/reek/smells/duplicate_method_call_spec.rb

@@ -1,7 +1,7 @@
 require_relative '../../spec_helper'
-require_relative '../../../lib/reek/smells/duplicate_method_call'
-require_relative '../../../lib/reek/context/code_context'
-require_relative '../../../lib/reek/tree_walker'
+require_lib 'reek/smells/duplicate_method_call'
+require_lib 'reek/context/code_context'
+require_lib 'reek/tree_walker'
 require_relative 'smell_detector_shared'
 
 RSpec.describe Reek::Smells::DuplicateMethodCall do

data/spec/reek/smells/feature_envy_spec.rb

@@ -1,6 +1,6 @@
 require_relative '../../spec_helper'
-require_relative '../../../lib/reek/smells/feature_envy'
-require_relative '../../../lib/reek/examiner'
+require_lib 'reek/smells/feature_envy'
+require_lib 'reek/examiner'
 require_relative 'smell_detector_shared'
 
 # TODO: Bring specs in line with specs for other detectors

data/spec/reek/smells/irresponsible_module_spec.rb

@@ -1,6 +1,6 @@
 require_relative '../../spec_helper'
-require_relative '../../../lib/reek/context/code_context'
-require_relative '../../../lib/reek/smells/irresponsible_module'
+require_lib 'reek/context/code_context'
+require_lib 'reek/smells/irresponsible_module'
 require_relative 'smell_detector_shared'
 
 RSpec.describe Reek::Smells::IrresponsibleModule do

data/spec/reek/smells/long_parameter_list_spec.rb

@@ -1,6 +1,6 @@
 require_relative '../../spec_helper'
-require_relative '../../../lib/reek/context/code_context'
-require_relative '../../../lib/reek/smells/long_parameter_list'
+require_lib 'reek/context/code_context'
+require_lib 'reek/smells/long_parameter_list'
 require_relative 'smell_detector_shared'
 
 RSpec.describe Reek::Smells::LongParameterList do

data/spec/reek/smells/long_yield_list_spec.rb

@@ -1,6 +1,6 @@
 require_relative '../../spec_helper'
-require_relative '../../../lib/reek/context/code_context'
-require_relative '../../../lib/reek/smells/long_yield_list'
+require_lib 'reek/context/code_context'
+require_lib 'reek/smells/long_yield_list'
 require_relative 'smell_detector_shared'
 
 RSpec.describe Reek::Smells::LongYieldList do

data/spec/reek/smells/module_initialize_spec.rb

@@ -1,5 +1,5 @@
 require_relative '../../spec_helper'
-require_relative '../../../lib/reek/smells/module_initialize'
+require_lib 'reek/smells/module_initialize'
 require_relative 'smell_detector_shared'
 
 RSpec.describe Reek::Smells::ModuleInitialize do

data/spec/reek/smells/nested_iterators_spec.rb

@@ -1,5 +1,5 @@
 require_relative '../../spec_helper'
-require_relative '../../../lib/reek/smells/nested_iterators'
+require_lib 'reek/smells/nested_iterators'
 require_relative 'smell_detector_shared'
 
 RSpec.describe Reek::Smells::NestedIterators do

data/spec/reek/smells/nil_check_spec.rb

@@ -1,6 +1,6 @@
 require_relative '../../spec_helper'
-require_relative '../../../lib/reek/context/code_context'
-require_relative '../../../lib/reek/smells/nil_check'
+require_lib 'reek/context/code_context'
+require_lib 'reek/smells/nil_check'
 require_relative 'smell_detector_shared'
 
 RSpec.describe Reek::Smells::NilCheck do

data/spec/reek/smells/prima_donna_method_spec.rb

@@ -1,5 +1,5 @@
 require_relative '../../spec_helper'
-require_relative '../../../lib/reek/context/module_context'
+require_lib 'reek/context/module_context'
 require_relative 'smell_detector_shared'
 
 RSpec.describe Reek::Smells::PrimaDonnaMethod do

data/spec/reek/smells/repeated_conditional_spec.rb

@@ -1,8 +1,8 @@
 require_relative '../../spec_helper'
-require_relative '../../../lib/reek/smells/repeated_conditional'
-require_relative '../../../lib/reek/context/code_context'
+require_lib 'reek/smells/repeated_conditional'
+require_lib 'reek/context/code_context'
 require_relative 'smell_detector_shared'
-require_relative '../../../lib/reek/source/source_code'
+require_lib 'reek/source/source_code'
 
 RSpec.describe Reek::Smells::RepeatedConditional do
   let(:detector) { build(:smell_detector, smell_type: :RepeatedConditional, source: source_name) }

data/spec/reek/smells/smell_configuration_spec.rb

@@ -1,5 +1,5 @@
 require_relative '../../spec_helper'
-require_relative '../../../lib/reek/smells/smell_configuration'
+require_lib 'reek/smells/smell_configuration'
 
 RSpec.describe Reek::Smells::SmellConfiguration do
   it 'returns the default value when key not found' do

data/spec/reek/smells/smell_repository_spec.rb

@@ -1,6 +1,6 @@
 require_relative '../../spec_helper'
-require_relative '../../../lib/reek/smells/smell_detector'
-require_relative '../../../lib/reek/smells/smell_repository'
+require_lib 'reek/smells/smell_detector'
+require_lib 'reek/smells/smell_repository'
 
 RSpec.describe Reek::Smells::SmellRepository do
   describe '.smell_types' do

data/spec/reek/smells/smell_warning_spec.rb

@@ -1,5 +1,5 @@
 require_relative '../../spec_helper'
-require_relative '../../../lib/reek/smells/smell_warning'
+require_lib 'reek/smells/smell_warning'
 
 RSpec.describe Reek::Smells::SmellWarning do
   let(:duplication_detector)  { build(:smell_detector, smell_type: 'DuplicateMethodCall') }

data/spec/reek/smells/too_many_instance_variables_spec.rb

@@ -1,5 +1,5 @@
 require_relative '../../spec_helper'
-require_relative '../../../lib/reek/smells/too_many_instance_variables'
+require_lib 'reek/smells/too_many_instance_variables'
 require_relative 'smell_detector_shared'
 
 RSpec.describe Reek::Smells::TooManyInstanceVariables do

data/spec/reek/smells/too_many_methods_spec.rb

@@ -1,5 +1,5 @@
 require_relative '../../spec_helper'
-require_relative '../../../lib/reek/smells/too_many_methods'
+require_lib 'reek/smells/too_many_methods'
 require_relative 'smell_detector_shared'
 
 RSpec.describe Reek::Smells::TooManyMethods do

data/spec/reek/smells/too_many_statements_spec.rb

@@ -1,5 +1,5 @@
 require_relative '../../spec_helper'
-require_relative '../../../lib/reek/smells/too_many_statements'
+require_lib 'reek/smells/too_many_statements'
 require_relative 'smell_detector_shared'
 
 RSpec.describe Reek::Smells::TooManyStatements do

data/spec/reek/smells/uncommunicative_method_name_spec.rb

@@ -1,5 +1,5 @@
 require_relative '../../spec_helper'
-require_relative '../../../lib/reek/smells/uncommunicative_method_name'
+require_lib 'reek/smells/uncommunicative_method_name'
 require_relative 'smell_detector_shared'
 
 RSpec.describe Reek::Smells::UncommunicativeMethodName do
@@ -12,7 +12,7 @@ RSpec.describe Reek::Smells::UncommunicativeMethodName do
 
   ['help', '+', '-', '/', '*'].each do |method_name|
     it "accepts the method name '#{method_name}'" do
-      src = "def #{method_name}(fred) basics(17) end"
+      src = "def #{method_name}(arg) basics(17) end"
       expect(src).not_to reek_of(:UncommunicativeMethodName)
     end
   end

data/spec/reek/smells/uncommunicative_module_name_spec.rb

@@ -1,7 +1,7 @@
 require_relative '../../spec_helper'
-require_relative '../../../lib/reek/smells/uncommunicative_module_name'
+require_lib 'reek/smells/uncommunicative_module_name'
 require_relative 'smell_detector_shared'
-require_relative '../../../lib/reek/context/code_context'
+require_lib 'reek/context/code_context'
 
 RSpec.describe Reek::Smells::UncommunicativeModuleName do
   let(:source_name) { 'string' }

data/spec/reek/smells/uncommunicative_parameter_name_spec.rb

@@ -1,7 +1,7 @@
 require_relative '../../spec_helper'
-require_relative '../../../lib/reek/smells/uncommunicative_parameter_name'
+require_lib 'reek/smells/uncommunicative_parameter_name'
 require_relative 'smell_detector_shared'
-require_relative '../../../lib/reek/context/method_context'
+require_lib 'reek/context/method_context'
 
 RSpec.describe Reek::Smells::UncommunicativeParameterName do
   let(:detector) do

data/spec/reek/smells/uncommunicative_variable_name_spec.rb

@@ -1,5 +1,5 @@
 require_relative '../../spec_helper'
-require_relative '../../../lib/reek/smells/uncommunicative_variable_name'
+require_lib 'reek/smells/uncommunicative_variable_name'
 require_relative 'smell_detector_shared'
 
 RSpec.describe Reek::Smells::UncommunicativeVariableName do

data/spec/reek/smells/unused_parameters_spec.rb

@@ -1,5 +1,5 @@
 require_relative '../../spec_helper'
-require_relative '../../../lib/reek/smells/unused_parameters'
+require_lib 'reek/smells/unused_parameters'
 require_relative 'smell_detector_shared'
 
 RSpec.describe Reek::Smells::UnusedParameters do

data/spec/reek/smells/utility_function_spec.rb

@@ -1,6 +1,6 @@
 require_relative '../../spec_helper'
-require_relative '../../../lib/reek/smells/utility_function'
-require_relative '../../../lib/reek/examiner'
+require_lib 'reek/smells/utility_function'
+require_lib 'reek/examiner'
 require_relative 'smell_detector_shared'
 
 # TODO: Bring specs in line with specs for other detectors

data/spec/reek/source/source_code_spec.rb

@@ -1,6 +1,6 @@
 require_relative '../../spec_helper'
 require 'stringio'
-require_relative '../../../lib/reek/source/source_code'
+require_lib 'reek/source/source_code'
 
 RSpec.describe Reek::Source::SourceCode do
   describe '#syntax_tree' do

data/spec/reek/source/source_locator_spec.rb

@@ -1,7 +1,7 @@
 require 'pathname'
 require_relative '../../spec_helper'
-require_relative '../../../lib/reek/configuration/app_configuration'
-require_relative '../../../lib/reek/source/source_locator'
+require_lib 'reek/configuration/app_configuration'
+require_lib 'reek/source/source_locator'
 
 RSpec.describe Reek::Source::SourceLocator do
   describe '#sources' do

data/spec/reek/spec/should_reek_of_spec.rb

@@ -1,63 +1,116 @@
 require 'pathname'
 require_relative '../../spec_helper'
-require_relative '../../../lib/reek/spec'
+require_lib 'reek/spec'
 
 RSpec.describe Reek::Spec::ShouldReekOf do
-  context 'rdoc demo example' do
-    let(:ruby) { 'def double_thing() @other.thing.foo + @other.thing.foo end' }
+  describe 'smell type check' do
+    let(:src) { 'def double_thing() @other.thing.foo + @other.thing.foo end' }
 
-    it 'reports duplicate calls to @other.thing' do
-      expect(ruby).to reek_of(:Duplication, name: '@other.thing')
+    it 'reports duplicate calls' do
+      expect(src).to reek_of(:Duplication)
     end
 
-    it 'reports duplicate calls to @other.thing.foo' do
-      expect(ruby).to reek_of(:Duplication, name: '@other.thing.foo')
-    end
-
-    it 'does not report any feature envy' do
-      expect(ruby).not_to reek_of(:FeatureEnvy)
+    it 'does not report any other smell types' do
+      expect(src).not_to reek_of(:FeatureEnvy)
     end
   end
 
-  context 'checking code in a string' do
-    let(:clean_code) { 'def good() true; end' }
-    let(:matcher) { Reek::Spec::ShouldReekOf.new(:UncommunicativeVariableName, name: 'y') }
-    let(:smelly_code) { 'def x() y = 4; end' }
+  describe 'different sources of input' do
+    context 'checking code in a string' do
+      let(:clean_code) { 'def good() true; end' }
+      let(:matcher) { Reek::Spec::ShouldReekOf.new(:UncommunicativeVariableName, name: 'y') }
+      let(:smelly_code) { 'def x() y = 4; end' }
 
-    it 'matches a smelly String' do
-      expect(matcher.matches?(smelly_code)).to be_truthy
-    end
+      it 'matches a smelly String' do
+        expect(matcher.matches?(smelly_code)).to be_truthy
+      end
 
-    it 'doesnt match a fragrant String' do
-      expect(matcher.matches?(clean_code)).to be_falsey
+      it 'doesnt match a fragrant String' do
+        expect(matcher.matches?(clean_code)).to be_falsey
+      end
     end
 
-    it 'reports the smells when should_not fails' do
-      expect(matcher.matches?(smelly_code)).to be_truthy
-      expect(matcher.failure_message_when_negated).to match('UncommunicativeVariableName')
+    context 'checking code in a File' do
+      let(:clean_file) { Pathname.glob("#{SAMPLES_PATH}/three_clean_files/*.rb").first }
+      let(:matcher) { Reek::Spec::ShouldReekOf.new(:UncommunicativeVariableName, name: '@s') }
+      let(:smelly_file) { Pathname.glob("#{SAMPLES_PATH}/two_smelly_files/*.rb").first }
+
+      it 'matches a smelly file' do
+        expect(matcher.matches?(smelly_file)).to be_truthy
+      end
+
+      it 'doesnt match a fragrant file' do
+        expect(matcher.matches?(clean_file)).to be_falsey
+      end
     end
   end
 
-  context 'passing in smell_details with unknown parameter name' do
-    let(:matcher) { Reek::Spec::ShouldReekOf.new(:UncommunicativeVariableName, foo: 'y') }
-    let(:smelly_code) { 'def x() y = 4; end' }
+  describe 'smell types and smell details' do
+    context 'passing in smell_details with unknown parameter name' do
+      let(:matcher) { Reek::Spec::ShouldReekOf.new(:UncommunicativeVariableName, foo: 'y') }
+      let(:smelly_code) { 'def x() y = 4; end' }
 
-    it 'raises ArgumentError' do
-      expect { matcher.matches?(smelly_code) }.to raise_error(ArgumentError)
+      it 'raises ArgumentError' do
+        expect { matcher.matches?(smelly_code) }.to raise_error(ArgumentError)
+      end
+    end
+
+    context 'both are matching' do
+      let(:smelly_code) { 'def x() y = 4; end' }
+      let(:matcher) { Reek::Spec::ShouldReekOf.new(:UncommunicativeVariableName, name: 'y') }
+
+      it 'is truthy' do
+        expect(matcher.matches?(smelly_code)).to be_truthy
+      end
     end
-  end
 
-  context 'checking code in a File' do
-    let(:clean_file) { Pathname.glob("#{SAMPLES_PATH}/three_clean_files/*.rb").first }
-    let(:matcher) { Reek::Spec::ShouldReekOf.new(:UncommunicativeVariableName, name: '@s') }
-    let(:smelly_file) { Pathname.glob("#{SAMPLES_PATH}/two_smelly_files/*.rb").first }
+    context 'no smell_type is matching' do
+      let(:smelly_code) { 'def dummy() y = 4; end' }
+      let(:falsey_matcher) { Reek::Spec::ShouldReekOf.new(:FeatureEnvy, name: 'y') }
+      let(:truthy_matcher) { Reek::Spec::ShouldReekOf.new(:UncommunicativeVariableName, name: 'y') }
 
-    it 'matches a smelly String' do
-      expect(matcher.matches?(smelly_file)).to be_truthy
+      it 'is falsey' do
+        expect(falsey_matcher.matches?(smelly_code)).to be_falsey
+      end
+
+      it 'sets the proper error message' do
+        falsey_matcher.matches?(smelly_code)
+
+        expect(falsey_matcher.failure_message).to\
+          match('Expected string to reek of FeatureEnvy, but it didn\'t')
+      end
+
+      it 'sets the proper error message when negated' do
+        truthy_matcher.matches?(smelly_code)
+
+        expect(truthy_matcher.failure_message_when_negated).to\
+          match('Expected string not to reek of UncommunicativeVariableName, but it did')
+      end
     end
 
-    it 'doesnt match a fragrant String' do
-      expect(matcher.matches?(clean_file)).to be_falsey
+    context 'smell type is matching but smell details are not' do
+      let(:smelly_code) { 'def dummy() y = 4; end' }
+      let(:matcher) { Reek::Spec::ShouldReekOf.new(:UncommunicativeVariableName, name: 'x') }
+
+      it 'is falsey' do
+        expect(matcher.matches?(smelly_code)).to be_falsey
+      end
+
+      it 'sets the proper error message' do
+        matcher.matches?(smelly_code)
+
+        expect(matcher.failure_message).to\
+          match('Expected string to reek of UncommunicativeVariableName (which it did) with '\
+                  'smell details {:name=>"x"}, which it didn\'t')
+      end
+
+      it 'sets the proper error message when negated' do
+        matcher.matches?(smelly_code)
+
+        expect(matcher.failure_message_when_negated).to\
+          match('Expected string not to reek of UncommunicativeVariableName with smell '\
+                  'details {:name=>"x"}, but it did')
+      end
     end
   end
 end