reek 4.2.3 → 4.2.4

data/spec/reek/smells/prima_donna_method_spec.rb

@@ -3,6 +3,14 @@ require_lib 'reek/context/module_context'
 require_relative 'smell_detector_shared'
 
 RSpec.describe Reek::Smells::PrimaDonnaMethod do
+  it 'reports the right values' do
+    src = 'class C; def m!; end; end'
+    expect(src).to reek_of :PrimaDonnaMethod,
+                           lines: [1],
+                           message: 'has prima donna method `m!`',
+                           name: :m!
+  end
+
   it 'should report nothing when method and bang counterpart exist' do
     expect('class C; def m; end; def m!; end; end').not_to reek_of(:PrimaDonnaMethod)
   end
@@ -20,7 +28,7 @@ RSpec.describe Reek::Smells::PrimaDonnaMethod do
     end
 
     it 'should be reported' do
-      smells = detector.inspect(ctx)
+      smells = detector.sniff(ctx)
       warning = smells[0]
 
       expect(warning.smell_type).to eq('PrimaDonnaMethod')

data/spec/reek/smells/too_many_instance_variables_spec.rb

@@ -85,7 +85,7 @@ RSpec.describe Reek::Smells::TooManyInstanceVariables do
         end
       EOS
       ctx = Reek::Context::CodeContext.new(nil, Reek::Source::SourceCode.from(src).syntax_tree)
-      detector.inspect(ctx).first
+      detector.sniff(ctx).first
     end
 
     it_should_behave_like 'common fields set correctly'

data/spec/reek/smells/too_many_methods_spec.rb

@@ -18,7 +18,7 @@ RSpec.describe Reek::Smells::TooManyMethods do
       EOS
       syntax_tree = Reek::Source::SourceCode.from(src).syntax_tree
       ctx = Reek::Context::ModuleContext.new(nil, syntax_tree)
-      expect(detector.inspect(ctx)).to be_empty
+      expect(detector.sniff(ctx)).to be_empty
     end
 
     it 'should report if we exceed max_methods' do
@@ -31,7 +31,7 @@ RSpec.describe Reek::Smells::TooManyMethods do
       EOS
       syntax_tree = Reek::Source::SourceCode.from(src).syntax_tree
       ctx = Reek::Context::ModuleContext.new(nil, syntax_tree)
-      smells = detector.inspect(ctx)
+      smells = detector.sniff(ctx)
       expect(smells.length).to eq(1)
       expect(smells[0].smell_type).to eq(described_class.smell_type)
       expect(smells[0].parameters[:count]).to eq(3)
@@ -54,7 +54,7 @@ RSpec.describe Reek::Smells::TooManyMethods do
       EOS
       syntax_tree = Reek::Source::SourceCode.from(src).syntax_tree
       ctx = Reek::Context::ModuleContext.new(nil, syntax_tree)
-      expect(detector.inspect(ctx)).to be_empty
+      expect(detector.sniff(ctx)).to be_empty
     end
   end
 
@@ -69,7 +69,7 @@ RSpec.describe Reek::Smells::TooManyMethods do
 
     syntax_tree = Reek::Source::SourceCode.from(src).syntax_tree
     ctx = Reek::Context::ModuleContext.new(nil, syntax_tree)
-    warning = detector.inspect(ctx)[0]
+    warning = detector.sniff(ctx)[0]
     expect(warning.source).to eq(source_name)
     expect(warning.smell_type).to eq(described_class.smell_type)
     expect(warning.parameters[:count]).to eq(3)

data/spec/reek/smells/too_many_statements_spec.rb

@@ -51,7 +51,7 @@ RSpec.describe Reek::Smells::TooManyStatements do
       ctx = double('method_context').as_null_object
       expect(ctx).to receive(:number_of_statements).and_return(number_of_statements)
       expect(ctx).to receive(:config_for).with(described_class).and_return({})
-      detector.inspect(ctx)
+      detector.sniff(ctx)
     end
 
     it 'reports only 1 smell' do

data/spec/reek/smells/uncommunicative_method_name_spec.rb

@@ -26,19 +26,19 @@ RSpec.describe Reek::Smells::UncommunicativeMethodName do
     end
   end
 
-  describe 'inspect' do
+  describe 'sniff' do
     let(:source) { 'def x; end' }
     let(:context) { code_context(source) }
     let(:detector) { build(:smell_detector, smell_type: :UncommunicativeMethodName) }
 
     it 'returns an array of smell warnings' do
-      smells = detector.inspect(context)
+      smells = detector.sniff(context)
       expect(smells.length).to eq(1)
       expect(smells[0]).to be_a_kind_of(Reek::Smells::SmellWarning)
     end
 
     it 'contains proper smell warnings' do
-      smells = detector.inspect(context)
+      smells = detector.sniff(context)
       warning = smells[0]
 
       expect(warning.smell_type).to eq(Reek::Smells::UncommunicativeMethodName.smell_type)

data/spec/reek/smells/uncommunicative_module_name_spec.rb

@@ -27,19 +27,19 @@ RSpec.describe Reek::Smells::UncommunicativeModuleName do
     end
   end
 
-  describe 'inspect' do
+  describe 'sniff' do
     let(:source) { 'class Foo::X; end' }
     let(:context) { code_context(source) }
     let(:detector) { build(:smell_detector, smell_type: :UncommunicativeModuleName) }
 
     it 'returns an array of smell warnings' do
-      smells = detector.inspect(context)
+      smells = detector.sniff(context)
       expect(smells.length).to eq(1)
       expect(smells[0]).to be_a_kind_of(Reek::Smells::SmellWarning)
     end
 
     it 'contains proper smell warnings' do
-      smells = detector.inspect(context)
+      smells = detector.sniff(context)
       warning = smells[0]
 
       expect(warning.smell_type).to eq(Reek::Smells::UncommunicativeModuleName.smell_type)

data/spec/reek/smells/uncommunicative_parameter_name_spec.rb

@@ -72,19 +72,19 @@ RSpec.describe Reek::Smells::UncommunicativeParameterName do
     end
   end
 
-  describe 'inspect' do
+  describe 'sniff' do
     let(:source) { 'def foo(bar2); baz(bar2); end' }
     let(:context) { method_context(source) }
     let(:detector) { build(:smell_detector, smell_type: :UncommunicativeParameterName) }
 
     it 'returns an array of smell warnings' do
-      smells = detector.inspect(context)
+      smells = detector.sniff(context)
       expect(smells.length).to eq(1)
       expect(smells[0]).to be_a_kind_of(Reek::Smells::SmellWarning)
     end
 
     it 'contains proper smell warnings' do
-      smells = detector.inspect(context)
+      smells = detector.sniff(context)
       warning = smells[0]
 
       expect(warning.smell_type).to eq(Reek::Smells::UncommunicativeParameterName.smell_type)

data/spec/reek/smells/uncommunicative_variable_name_spec.rb

@@ -51,7 +51,7 @@ RSpec.describe Reek::Smells::UncommunicativeVariableName do
       src = 'def simple(fred) x = jim(45); x = y end'
       syntax_tree = Reek::Source::SourceCode.from(src).syntax_tree
       ctx = Reek::Context::CodeContext.new(nil, syntax_tree)
-      smells = detector.inspect(ctx)
+      smells = detector.sniff(ctx)
       expect(smells.length).to eq(1)
       expect(smells[0].smell_type).to eq(described_class.smell_type)
       expect(smells[0].parameters[:name]).to eq('x')
@@ -164,7 +164,7 @@ RSpec.describe Reek::Smells::UncommunicativeVariableName do
       EOS
       syntax_tree = Reek::Source::SourceCode.from(src).syntax_tree
       ctx = Reek::Context::CodeContext.new(nil, syntax_tree)
-      detector.inspect(ctx).first
+      detector.sniff(ctx).first
     end
 
     it_should_behave_like 'common fields set correctly'
@@ -180,7 +180,7 @@ RSpec.describe Reek::Smells::UncommunicativeVariableName do
       src = 'def self.bad() x2 = 4; end'
       syntax_tree = Reek::Source::SourceCode.from(src).syntax_tree
       ctx = Reek::Context::CodeContext.new(nil, syntax_tree)
-      detector.inspect(ctx).first
+      detector.sniff(ctx).first
     end
 
     it_should_behave_like 'common fields set correctly'

data/spec/reek/smells/utility_function_spec.rb

@@ -24,6 +24,10 @@ RSpec.describe Reek::Smells::UtilityFunction do
       it 'reports the line number of the method' do
         expect(warning.lines).to eq([1])
       end
+
+      it 'has the right message' do
+        expect(warning.message).to eq("doesn't depend on instance state (maybe move it to another class?)")
+      end
     end
   end
 
@@ -92,7 +96,7 @@ RSpec.describe Reek::Smells::UtilityFunction do
             def simple(a) a.to_s; end
           end
         EOF
-        expect(src).to reek_of(:UtilityFunction)
+        expect(src).to reek_of(:UtilityFunction, context: 'M#simple')
       end
 
       it 'does not report when module_function is called in separate scope' do
@@ -153,18 +157,18 @@ RSpec.describe Reek::Smells::UtilityFunction do
 
   context 'with only one call' do
     it 'reports a call to a parameter' do
-      expect('def simple(arga) arga.to_s end').to reek_of(:UtilityFunction, name: 'simple')
+      expect('def simple(arga) arga.to_s end').to reek_of(:UtilityFunction, context: 'simple')
     end
 
     it 'reports a call to a constant' do
-      expect('def simple(arga) FIELDS[arga] end').to reek_of(:UtilityFunction)
+      expect('def simple(arga) FIELDS[arga] end').to reek_of(:UtilityFunction, context: 'simple')
     end
   end
 
   context 'with two or more calls' do
     it 'reports two calls' do
       src = 'def simple(arga) arga.to_s + arga.to_i end'
-      expect(src).to reek_of(:UtilityFunction, name: 'simple')
+      expect(src).to reek_of(:UtilityFunction, context: 'simple')
       expect(src).not_to reek_of(:FeatureEnvy)
     end
 
@@ -189,7 +193,7 @@ RSpec.describe Reek::Smells::UtilityFunction do
 
     it 'should report message chain' do
       src = 'def simple(arga) arga.b.c end'
-      expect(src).to reek_of(:UtilityFunction, name: 'simple')
+      expect(src).to reek_of(:UtilityFunction, context: 'simple')
       expect(src).not_to reek_of(:FeatureEnvy)
     end
 
@@ -225,7 +229,7 @@ RSpec.describe Reek::Smells::UtilityFunction do
             def m1(a) a.to_s; end
           end
       EOS
-      expect(src).to reek_of(:UtilityFunction)
+      expect(src).to reek_of(:UtilityFunction, context: 'C#m1')
     end
 
     it 'reports protected methods' do
@@ -235,7 +239,7 @@ RSpec.describe Reek::Smells::UtilityFunction do
             def m1(a) a.to_s; end
           end
       EOS
-      expect(src).to reek_of(:UtilityFunction)
+      expect(src).to reek_of(:UtilityFunction, context: 'C#m1')
     end
   end
 
@@ -251,7 +255,7 @@ RSpec.describe Reek::Smells::UtilityFunction do
             def m1(a) a.to_s; end
           end
         EOS
-        expect(src).to reek_of(:UtilityFunction, name: 'C#m1').with_config(config)
+        expect(src).to reek_of(:UtilityFunction, context: 'C#m1').with_config(config)
       end
     end
 

data/spec/reek/source/source_locator_spec.rb

@@ -7,9 +7,11 @@ RSpec.describe Reek::Source::SourceLocator do
   describe '#sources' do
     context 'applied to hidden directories' do
       let(:path) { SAMPLES_PATH.join('source_with_hidden_directories') }
+
       let(:expected_paths) do
         [SAMPLES_PATH.join('source_with_hidden_directories/uncommunicative_parameter_name.rb')]
       end
+
       let(:paths_that_are_expected_to_be_ignored) do
         [SAMPLES_PATH.join('source_with_hidden_directories/.hidden/\
           uncommunicative_parameter_nameicative_method_name.rb')]
@@ -25,9 +27,11 @@ RSpec.describe Reek::Source::SourceLocator do
 
     context 'exclude paths' do
       let(:configuration) do
-        test_configuration_for(SAMPLES_PATH.join('configuration/with_excluded_paths.reek'))
+        test_configuration_for(CONFIG_PATH.join('with_excluded_paths.reek'))
       end
+
       let(:path) { SAMPLES_PATH.join('source_with_exclude_paths') }
+
       let(:paths_that_are_expected_to_be_ignored) do
         [
           SAMPLES_PATH.join('source_with_exclude_paths/ignore_me/uncommunicative_method_name.rb'),

data/spec/reek/spec/should_reek_of_spec.rb

@@ -1,6 +1,8 @@
 require 'pathname'
 require_relative '../../spec_helper'
 require_lib 'reek/spec'
+require 'active_support/core_ext/string/strip'
+require 'active_support/core_ext/hash/except'
 
 RSpec.describe Reek::Spec::ShouldReekOf do
   describe 'smell type selection' do
@@ -40,16 +42,14 @@ RSpec.describe Reek::Spec::ShouldReekOf do
     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 }
+      let(:matcher) { Reek::Spec::ShouldReekOf.new(:UncommunicativeMethodName, name: 'x') }
 
       it 'matches a smelly file' do
-        expect(matcher.matches?(smelly_file)).to be_truthy
+        expect(matcher.matches?(SMELLY_FILE)).to be_truthy
       end
 
       it 'doesnt match a fragrant file' do
-        expect(matcher.matches?(clean_file)).to be_falsey
+        expect(matcher.matches?(CLEAN_FILE)).to be_falsey
       end
     end
   end
@@ -65,8 +65,8 @@ RSpec.describe Reek::Spec::ShouldReekOf do
     end
 
     context 'both are matching' do
-      let(:smelly_code) { 'def x() y = 4; end' }
       let(:matcher) { Reek::Spec::ShouldReekOf.new(:UncommunicativeVariableName, name: 'y') }
+      let(:smelly_code) { 'def x() y = 4; end' }
 
       it 'is truthy' do
         expect(matcher.matches?(smelly_code)).to be_truthy
@@ -99,8 +99,8 @@ RSpec.describe Reek::Spec::ShouldReekOf do
     end
 
     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') }
+      let(:smelly_code) { 'def double_thing() @other.thing.foo + @other.thing.foo end' }
+      let(:matcher) { Reek::Spec::ShouldReekOf.new(:DuplicateMethodCall, name: 'foo', count: 15) }
 
       it 'is falsey' do
         expect(matcher.matches?(smelly_code)).to be_falsey
@@ -108,17 +108,24 @@ RSpec.describe Reek::Spec::ShouldReekOf do
 
       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')
+        expected = <<-EOS.strip_heredoc
+          Expected string to reek of DuplicateMethodCall (which it did) with smell details {:name=>"foo", :count=>15}, which it didn't.
+          The number of smell details I had to compare with the given one was 2 and here they are:
+          1.)
+          {"context"=>"double_thing", "lines"=>[1, 1], "message"=>"calls @other.thing 2 times", "source"=>"string", "name"=>"@other.thing", "count"=>2}
+          2.)
+          {"context"=>"double_thing", "lines"=>[1, 1], "message"=>"calls @other.thing.foo 2 times", "source"=>"string", "name"=>"@other.thing.foo", "count"=>2}
+        EOS
+
+        expect(matcher.failure_message).to eq(expected)
       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')
+          match('Expected string not to reek of DuplicateMethodCall with smell '\
+                  'details {:name=>"foo", :count=>15}, but it did')
       end
     end
   end

data/spec/reek/spec/should_reek_spec.rb

@@ -22,35 +22,30 @@ RSpec.describe Reek::Spec::ShouldReek do
   end
 
   describe 'checking code in a File' do
-    let(:clean_file) { SAMPLES_PATH.join('three_clean_files/clean_one.rb') }
-    let(:smelly_file) { SAMPLES_PATH.join('two_smelly_files/dirty_one.rb') }
-    let(:masked_file) { SAMPLES_PATH.join('clean_due_to_masking/dirty_one.rb') }
-
     context 'matcher without masking' do
       let(:matcher) { Reek::Spec::ShouldReek.new }
 
       it 'matches a smelly File' do
-        expect(matcher.matches?(smelly_file)).to be_truthy
+        expect(matcher.matches?(SMELLY_FILE)).to be_truthy
       end
 
       it 'doesnt match a fragrant File' do
-        expect(matcher.matches?(clean_file)).to be_falsey
+        expect(matcher.matches?(CLEAN_FILE)).to be_falsey
       end
 
       it 'reports the smells when should_not fails' do
-        matcher.matches?(smelly_file)
-        expect(matcher.failure_message_when_negated).to match('UncommunicativeVariableName')
+        matcher.matches?(SMELLY_FILE)
+        expect(matcher.failure_message_when_negated).to match('UncommunicativeMethodName')
       end
     end
 
     context 'matcher without masking' do
-      let(:path) { SAMPLES_PATH.join('clean_due_to_masking/masked.reek') }
+      let(:path) { CONFIG_PATH.join('full_mask.reek') }
       let(:configuration) { test_configuration_for(path) }
       let(:matcher) { Reek::Spec::ShouldReek.new(configuration: configuration) }
-      let(:masked_file) { SAMPLES_PATH.join('clean_due_to_masking/dirty_one.rb') }
 
       it 'masks smells using the relevant configuration' do
-        expect(matcher.matches?(masked_file)).to be_falsey
+        expect(matcher.matches?(SMELLY_FILE)).to be_falsey
       end
     end
   end

data/spec/spec_helper.rb

@@ -4,6 +4,8 @@ require_relative '../lib/reek/spec'
 require_relative '../lib/reek/ast/ast_node_class_map'
 require_relative '../lib/reek/configuration/app_configuration'
 
+require_relative '../samples/paths'
+
 Reek::CLI::Silencer.silently do
   begin
     require 'pry-byebug'
@@ -14,8 +16,6 @@ end
 require 'factory_girl'
 FactoryGirl.find_definitions
 
-SAMPLES_PATH = Pathname.new("#{__dir__}/samples").relative_path_from(Pathname.pwd)
-
 # Simple helpers for our specs.
 module Helpers
   def test_configuration_for(config)

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: reek
 version: !ruby/object:Gem::Version
-  version: 4.2.3
+  version: 4.2.4
 platform: ruby
 authors:
 - Kevin Rutherford
@@ -11,7 +11,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2016-08-05 00:00:00.000000000 Z
+date: 2016-08-17 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: codeclimate-engine-rb
@@ -275,6 +275,32 @@ files:
 - logo/reek.text.png
 - logo/reek.text.svg
 - reek.gemspec
+- samples/checkstyle.xml
+- samples/clean.rb
+- samples/configuration/.reek
+- samples/configuration/corrupt.reek
+- samples/configuration/empty.reek
+- samples/configuration/full_configuration.reek
+- samples/configuration/full_mask.reek
+- samples/configuration/non_public_modifiers_mask.reek
+- samples/configuration/partial_mask.reek
+- samples/configuration/with_excluded_paths.reek
+- samples/exceptions.reek
+- samples/inline.rb
+- samples/optparse.rb
+- samples/paths.rb
+- samples/redcloth.rb
+- samples/smelly.rb
+- samples/smelly_with_inline_mask.rb
+- samples/smelly_with_modifiers.rb
+- samples/source_with_exclude_paths/ignore_me/uncommunicative_method_name.rb
+- samples/source_with_exclude_paths/nested/ignore_me_as_well/irresponsible_module.rb
+- samples/source_with_exclude_paths/nested/uncommunicative_parameter_name.rb
+- samples/source_with_hidden_directories/.hidden/uncommunicative_method_name.rb
+- samples/source_with_hidden_directories/uncommunicative_parameter_name.rb
+- samples/source_with_non_ruby_files/gibberish
+- samples/source_with_non_ruby_files/python_source.py
+- samples/source_with_non_ruby_files/uncommunicative_parameter_name.rb
 - spec/factories/factories.rb
 - spec/quality/reek_source_spec.rb
 - spec/reek/ast/node_spec.rb
@@ -349,39 +375,6 @@ files:
 - spec/reek/spec/should_reek_spec.rb
 - spec/reek/spec/smell_matcher_spec.rb
 - spec/reek/tree_dresser_spec.rb
-- spec/samples/all_but_one_masked/clean_one.rb
-- spec/samples/all_but_one_masked/dirty.rb
-- spec/samples/all_but_one_masked/masked.reek
-- spec/samples/checkstyle.xml
-- spec/samples/clean_due_to_masking/clean_one.rb
-- spec/samples/clean_due_to_masking/clean_three.rb
-- spec/samples/clean_due_to_masking/clean_two.rb
-- spec/samples/clean_due_to_masking/dirty_one.rb
-- spec/samples/clean_due_to_masking/dirty_two.rb
-- spec/samples/clean_due_to_masking/masked.reek
-- spec/samples/configuration/full_configuration.reek
-- spec/samples/configuration/simple_configuration.reek
-- spec/samples/configuration/with_excluded_paths.reek
-- spec/samples/exceptions.reek
-- spec/samples/inline.rb
-- spec/samples/masked_by_dotfile/.reek
-- spec/samples/masked_by_dotfile/dirty.rb
-- spec/samples/no_config_file/dirty.rb
-- spec/samples/optparse.rb
-- spec/samples/redcloth.rb
-- spec/samples/source_with_exclude_paths/ignore_me/uncommunicative_method_name.rb
-- spec/samples/source_with_exclude_paths/nested/ignore_me_as_well/irresponsible_module.rb
-- spec/samples/source_with_exclude_paths/nested/uncommunicative_parameter_name.rb
-- spec/samples/source_with_hidden_directories/.hidden/uncommunicative_method_name.rb
-- spec/samples/source_with_hidden_directories/uncommunicative_parameter_name.rb
-- spec/samples/source_with_non_ruby_files/gibberish
-- spec/samples/source_with_non_ruby_files/python_source.py
-- spec/samples/source_with_non_ruby_files/uncommunicative_parameter_name.rb
-- spec/samples/three_clean_files/clean_one.rb
-- spec/samples/three_clean_files/clean_three.rb
-- spec/samples/three_clean_files/clean_two.rb
-- spec/samples/two_smelly_files/dirty_one.rb
-- spec/samples/two_smelly_files/dirty_two.rb
 - spec/spec_helper.rb
 - tasks/ataru.rake
 - tasks/configuration.rake
@@ -419,4 +412,3 @@ signing_key:
 specification_version: 4
 summary: Code smell detector for Ruby
 test_files: []
-has_rdoc: