reek 2.1.0 → 2.2.0

data/spec/reek/core/module_context_spec.rb

@@ -2,7 +2,7 @@ require_relative '../../spec_helper'
 require_relative '../../../lib/reek/core/module_context'
 require_relative '../../../lib/reek/core/stop_context'
 
-describe Reek::Core::ModuleContext do
+RSpec.describe Reek::Core::ModuleContext do
   it 'should report module name for smell in method' do
     expect('
       module Fred
@@ -19,7 +19,7 @@ module Fred
   end
 end
 
-describe Reek::Core::ModuleContext do
+RSpec.describe Reek::Core::ModuleContext do
   it 'should recognise global constant' do
     expect('# module for test
 module ::Global

data/spec/reek/core/object_refs_spec.rb

@@ -1,7 +1,7 @@
 require_relative '../../spec_helper'
 require_relative '../../../lib/reek/core/object_refs'
 
-describe Reek::Core::ObjectRefs do
+RSpec.describe Reek::Core::ObjectRefs do
   before(:each) do
     @refs = Reek::Core::ObjectRefs.new
   end

data/spec/reek/{source → core}/object_source_spec.rb

@@ -1,6 +1,6 @@
 require_relative '../../spec_helper'
 
-describe Dir do
+RSpec.describe Dir do
   it 'reports correct smells via the Dir matcher' do
     files = Dir['spec/samples/two_smelly_files/*.rb']
     expect(files).to reek

data/spec/reek/{source → core}/reference_collector_spec.rb

@@ -1,50 +1,59 @@
 require_relative '../../spec_helper'
-require_relative '../../../lib/reek/source/reference_collector'
+require_relative '../../../lib/reek/core/reference_collector'
 
-describe Reek::Source::ReferenceCollector do
+RSpec.describe Reek::Core::ReferenceCollector do
   context 'counting refs to self' do
     def refs_to_self(src)
       syntax_tree = Reek::Source::SourceCode.from(src).syntax_tree
-      Reek::Source::ReferenceCollector.new(syntax_tree).num_refs_to_self
+      described_class.new(syntax_tree).num_refs_to_self
     end
+
     it 'with no refs to self' do
       expect(refs_to_self('def no_envy(arga) arga.barg end')).to eq(0)
     end
+
     it 'counts a call to super' do
       expect(refs_to_self('def simple() super; end')).to eq(1)
     end
+
     it 'counts a local call' do
       expect(refs_to_self('def simple() to_s; end')).to eq(1)
     end
+
     it 'counts a use of self' do
       expect(refs_to_self('def simple() lv = self; end')).to eq(1)
     end
+
     it 'counts a call with self as receiver' do
       expect(refs_to_self('def simple() self.to_s; end')).to eq(1)
     end
+
     it 'counts uses of an ivar' do
       expect(refs_to_self('def no_envy() @item.to_a; @item = 4; @item end')).to eq(3)
     end
+
     it 'counts an ivar passed to a method' do
       expect(refs_to_self('def no_envy(arga) arga.barg(@item); arga end')).to eq(1)
     end
+
     it 'ignores global variables' do
       expect(refs_to_self('def no_envy(arga) $s2.to_a; $s2[arga] end')).to eq(0)
     end
+
     it 'ignores global variables' do
-      src = <<EOS
-    def accept(t, pat = /.*/nm, &block)
-      if pat
-        pat.respond_to?(:match) or raise TypeError, "has no `match'"
-      else
-        pat = t if t.respond_to?(:match)
-      end
-      unless block
-        block = pat.method(:convert).to_proc if pat.respond_to?(:convert)
-      end
-      @atype[t] = [pat, block]
-    end
-EOS
+      src = <<-EOS
+        def accept(t, pat = /.*/nm, &block)
+          if pat
+            pat.respond_to?(:match) or raise TypeError, "has no `match'"
+          else
+            pat = t if t.respond_to?(:match)
+          end
+          unless block
+            block = pat.method(:convert).to_proc if pat.respond_to?(:convert)
+          end
+          @atype[t] = [pat, block]
+        end
+      EOS
       expect(refs_to_self(src)).to eq(2)
     end
   end

data/spec/reek/core/singleton_method_context_spec.rb

@@ -1,7 +1,17 @@
 require_relative '../../spec_helper'
-require_relative '../../../lib/reek/core/module_context'
 require_relative '../../../lib/reek/core/singleton_method_context'
 require_relative '../../../lib/reek/core/stop_context'
 
-describe Reek::Core::SingletonMethodContext do
+RSpec.describe Reek::Core::SingletonMethodContext do
+  let(:smc) do
+    sexp = s(:def, :foo, s(:args, s(:arg, :bar)), nil)
+    Reek::Core::SingletonMethodContext.new(Reek::Core::StopContext.new, sexp)
+  end
+
+  describe '#envious_receivers' do
+    it 'should not record envious calls' do
+      smc.record_call_to s(:send, s(:lvar, :bar), :baz)
+      expect(smc.envious_receivers).to be_empty
+    end
+  end
 end

data/spec/reek/core/smell_configuration_spec.rb

@@ -1,7 +1,7 @@
 require_relative '../../spec_helper'
 require_relative '../../../lib/reek/core/smell_configuration'
 
-describe Reek::Core::SmellConfiguration do
+RSpec.describe Reek::Core::SmellConfiguration do
   it 'returns the default value when key not found' do
     cf = Reek::Core::SmellConfiguration.new({})
     expect(cf.value('fred', nil, 27)).to eq(27)

data/spec/reek/core/smell_repository_spec.rb

@@ -1,7 +1,7 @@
 require_relative '../../spec_helper'
 require_relative '../../../lib/reek/core/smell_repository'
 
-describe Reek::Core::SmellRepository do
+RSpec.describe Reek::Core::SmellRepository do
   describe '.smell_types' do
     let(:smell_types) { Reek::Core::SmellRepository.smell_types }
 
@@ -13,5 +13,16 @@ describe Reek::Core::SmellRepository do
     it 'should exclude certain smell_types' do
       expect(smell_types).to_not include(Reek::Smells::SmellDetector)
     end
+
+    it 'should return the smell types in alphabetic order' do
+      expect(smell_types).to eq(smell_types.sort_by(&:name))
+    end
+
+    it "should raise an ArgumentError if smell to configure doesn't exist" do
+      repository = Reek::Core::SmellRepository.new
+      expect { repository.configure('SomethingNonExistant', {}) }.
+        to raise_error ArgumentError,
+                       'Unknown smell type SomethingNonExistant found in configuration'
+    end
   end
 end

data/spec/reek/core/stop_context_spec.rb

@@ -1,7 +1,7 @@
 require_relative '../../spec_helper'
 require_relative '../../../lib/reek/core/stop_context'
 
-describe Reek::Core::StopContext do
+RSpec.describe Reek::Core::StopContext do
   before :each do
     @stop = Reek::Core::StopContext.new
   end

data/spec/reek/core/tree_dresser_spec.rb

@@ -0,0 +1,16 @@
+require_relative '../../spec_helper'
+require_relative '../../../lib/reek/core/tree_dresser'
+
+RSpec.describe Reek::Core::TreeDresser do
+  let(:ifnode) { Parser::AST::Node.new(:if) }
+  let(:sendnode) { Parser::AST::Node.new(:send) }
+  let(:dresser) { described_class.new }
+
+  it 'dresses :if sexp with IfNode' do
+    expect(dresser.dress(ifnode, {})).to be_a Reek::Sexp::SexpExtensions::IfNode
+  end
+
+  it 'dresses :send sexp with SendNode' do
+    expect(dresser.dress(sendnode, {})).to be_a Reek::Sexp::SexpExtensions::SendNode
+  end
+end

data/spec/reek/core/tree_walker_spec.rb

@@ -1,7 +1,7 @@
 require_relative '../../spec_helper'
 require_relative '../../../lib/reek/core/tree_walker'
 
-describe Reek::Core::TreeWalker, 'with no method definitions' do
+RSpec.describe Reek::Core::TreeWalker, 'with no method definitions' do
   it 'reports no problems for empty source code' do
     expect('').not_to reek
   end
@@ -11,14 +11,14 @@ class Fred; end').not_to reek
   end
 end
 
-describe Reek::Core::TreeWalker, 'with a global method definition' do
+RSpec.describe Reek::Core::TreeWalker, 'with a global method definition' do
   it 'reports no problems for simple method' do
     src = 'def Outermost::fred() true; end'
     expect(src).not_to reek
   end
 end
 
-describe Reek::Core::TreeWalker, 'when a yield is the receiver' do
+RSpec.describe Reek::Core::TreeWalker, 'when a yield is the receiver' do
   it 'reports no problems' do
     src = <<EOS
 def values(*args)

data/spec/reek/core/warning_collector_spec.rb

@@ -1,8 +1,8 @@
 require_relative '../../spec_helper'
 require_relative '../../../lib/reek/core/warning_collector'
-require_relative '../../../lib/reek/smell_warning'
+require_relative '../../../lib/reek/smells/smell_warning'
 
-describe Reek::Core::WarningCollector do
+RSpec.describe Reek::Core::WarningCollector do
   before(:each) do
     @collector = Reek::Core::WarningCollector.new
   end
@@ -15,10 +15,10 @@ describe Reek::Core::WarningCollector do
 
   context 'with one warning' do
     before :each do
-      @warning = Reek::SmellWarning.new(Reek::Smells::FeatureEnvy.new(''),
-                                        context: 'fred',
-                                        lines:   [1, 2, 3],
-                                        message: 'hello')
+      @warning = Reek::Smells::SmellWarning.new(Reek::Smells::FeatureEnvy.new(''),
+                                                context: 'fred',
+                                                lines:   [1, 2, 3],
+                                                message: 'hello')
       @collector.found_smell(@warning)
     end
     it 'reports that warning' do

data/spec/reek/{source → sexp}/sexp_extensions_spec.rb

@@ -1,7 +1,7 @@
 require_relative '../../spec_helper'
-require_relative '../../../lib/reek/source/sexp_extensions'
+require_relative '../../../lib/reek/sexp/sexp_extensions'
 
-describe Reek::Source::SexpExtensions::DefNode do
+RSpec.describe Reek::Sexp::SexpExtensions::DefNode do
   context 'with no parameters' do
     before :each do
       @node = s(:def, :hello, s(:args))
@@ -110,7 +110,7 @@ describe Reek::Source::SexpExtensions::DefNode do
 
     it 'has a body extended with SexpNode' do
       b = @node.body
-      expect(b.class.included_modules.first).to eq Reek::Source::SexpNode
+      expect(b.class.included_modules.first).to eq Reek::Sexp::SexpNode
     end
 
     it 'finds nodes in the body with #body_nodes' do
@@ -133,7 +133,7 @@ describe Reek::Source::SexpExtensions::DefNode do
   end
 end
 
-describe Reek::Source::SexpExtensions::DefsNode do
+RSpec.describe Reek::Sexp::SexpExtensions::DefsNode do
   context 'with no parameters' do
     before :each do
       @node = s(:defs, s(:lvar, :obj), :hello, s(:args))
@@ -242,12 +242,12 @@ describe Reek::Source::SexpExtensions::DefsNode do
 
     it 'has a body extended with SexpNode' do
       b = @node.body
-      expect(b.class.included_modules.first).to eq Reek::Source::SexpNode
+      expect(b.class.included_modules.first).to eq Reek::Sexp::SexpNode
     end
   end
 end
 
-describe Reek::Source::SexpExtensions::SendNode do
+RSpec.describe Reek::Sexp::SexpExtensions::SendNode do
   context 'with no parameters' do
     before :each do
       @node = s(:send, nil, :hello)
@@ -279,7 +279,7 @@ describe Reek::Source::SexpExtensions::SendNode do
   end
 end
 
-describe Reek::Source::SexpExtensions::BlockNode do
+RSpec.describe Reek::Sexp::SexpExtensions::BlockNode do
   context 'with no parameters' do
     before :each do
       @node = s(:block, s(:send, nil, :map), s(:args), nil)
@@ -311,7 +311,7 @@ describe Reek::Source::SexpExtensions::BlockNode do
   end
 end
 
-describe Reek::Source::SexpExtensions::ModuleNode do
+RSpec.describe Reek::Sexp::SexpExtensions::ModuleNode do
   context 'with a simple name' do
     subject do
       mod = ast(:module, :Fred, nil)

data/spec/reek/{source → sexp}/sexp_formatter_spec.rb

@@ -1,16 +1,16 @@
 require_relative '../../spec_helper'
-require_relative '../../../lib/reek/source/sexp_formatter'
+require_relative '../../../lib/reek/sexp/sexp_formatter'
 
-describe Reek::Source::SexpFormatter do
+RSpec.describe Reek::Sexp::SexpFormatter do
   describe '::format' do
     it 'formats a simple s-expression' do
-      result = Reek::Source::SexpFormatter.format s(:lvar, :foo)
+      result = described_class.format s(:lvar, :foo)
       expect(result).to eq('foo')
     end
 
     it 'formats a more complex s-expression' do
       ast = s(:send, nil, :foo, s(:lvar, :bar))
-      result = Reek::Source::SexpFormatter.format(ast)
+      result = described_class.format(ast)
       expect(result).to eq('foo(bar)')
     end
 
@@ -21,9 +21,15 @@ describe Reek::Source::SexpFormatter do
               s(:begin,
                 s(:send, nil, :baz),
                 s(:send, nil, :qux)))
-      result = Reek::Source::SexpFormatter.format ast
+      result = described_class.format ast
 
       expect(result).to eq 'if foo ... end'
     end
+
+    it "doesn't reduce two-line ASTs" do
+      ast = s(:def, 'my_method', s(:args))
+      result = described_class.format ast
+      expect(result).to eq 'def my_method; end'
+    end
   end
 end

data/spec/reek/{source → sexp}/sexp_node_spec.rb

@@ -1,11 +1,11 @@
 require_relative '../../spec_helper'
-require_relative '../../../lib/reek/source/sexp_node'
+require_relative '../../../lib/reek/sexp/sexp_node'
 
-describe Reek::Source::SexpNode do
+RSpec.describe Reek::Sexp::SexpNode do
   context 'format' do
     it 'formats self' do
       @node = s(:self)
-      expect(@node.format_ruby).to eq('self')
+      expect(@node.format_to_ruby).to eq('self')
     end
   end
 

data/spec/reek/smells/attribute_spec.rb

@@ -1,118 +1,122 @@
 require_relative '../../spec_helper'
 require_relative '../../../lib/reek/smells/attribute'
-require_relative '../../../lib/reek/core/module_context'
 require_relative 'smell_detector_shared'
 
-describe Reek::Smells::Attribute do
-  before :each do
+RSpec.describe Reek::Smells::Attribute do
+  let(:config) do
+    {
+      Attribute: { Reek::Core::SmellConfiguration::ENABLED_KEY => true }
+    }
+  end
+
+  before(:each) do
     @source_name = 'dummy_source'
     @detector = build(:smell_detector, smell_type: :Attribute, source: @source_name)
   end
 
+  around(:each) do |example|
+    with_test_config(config) do
+      example.run
+    end
+  end
+
   it_should_behave_like 'SmellDetector'
 
   context 'with no attributes' do
-    it 'records nothing in the module' do
-      src = 'module Fred; end'
-      ctx = Reek::Core::CodeContext.new(nil, Reek::Source::SourceCode.from(src).syntax_tree)
-      expect(@detector.examine_context(ctx)).to be_empty
+    it 'records nothing' do
+      expect('
+        class Klass
+        end
+      ').to_not reek_of(:Attribute)
     end
   end
 
-  context 'with one attribute' do
-    before :each do
-      @attr_name = 'super_thing'
-    end
-
-    shared_examples_for 'one attribute found' do
-      before :each do
-        ctx = Reek::Core::CodeContext.new(nil, Reek::Source::SourceCode.from(@src).syntax_tree)
-        @smells = @detector.examine_context(ctx)
-      end
-
-      it 'records only that attribute' do
-        expect(@smells.length).to eq(1)
-      end
-
-      it 'reports the attribute name' do
-        expect(@smells[0].parameters[:name]).to eq(@attr_name)
-      end
-
-      it 'reports the declaration line number' do
-        expect(@smells[0].lines).to eq([1])
-      end
-
-      it 'reports the correct smell class' do
-        expect(@smells[0].smell_category).to eq(described_class.smell_category)
-      end
-
-      it 'reports the context fq name' do
-        expect(@smells[0].context).to eq('Fred')
-      end
+  context 'with attributes' do
+    it 'records nothing' do
+      expect('
+        class Klass
+          attr :super_private, :super_private2
+          private :super_private, :super_private2
+          private
+          attr :super_thing
+          public
+          attr :super_thing2
+          private
+          attr :super_thing2
+        end
+      ').to_not reek_of(:Attribute)
     end
 
-    context 'declared in a class' do
-      before :each do
-        @src = "class Fred; attr :#{@attr_name}; end"
-      end
-
-      it_should_behave_like 'one attribute found'
+    it 'records attr attribute in a module' do
+      expect('
+        module Mod
+          attr :my_attr
+        end
+      ').to reek_of(:Attribute, name: 'my_attr')
     end
 
-    context 'reader in a class' do
-      before :each do
-        @src = "class Fred; attr_reader :#{@attr_name}; end"
-      end
-
-      it_should_behave_like 'one attribute found'
+    it 'records attr attribute' do
+      expect('
+        class Klass
+          attr :my_attr
+        end
+      ').to reek_of(:Attribute, name: 'my_attr')
     end
 
-    context 'writer in a class' do
-      before :each do
-        @src = "class Fred; attr_writer :#{@attr_name}; end"
-      end
-
-      it_should_behave_like 'one attribute found'
+    it 'records reader attribute' do
+      expect('
+        class Klass
+          attr_reader :my_attr
+        end
+      ').to reek_of(:Attribute, name: 'my_attr')
     end
 
-    context 'accessor in a class' do
-      before :each do
-        @src = "class Fred; attr_accessor :#{@attr_name}; end"
-      end
-
-      it_should_behave_like 'one attribute found'
+    it 'records writer attribute' do
+      expect('
+        class Klass
+          attr_writer :my_attr
+        end
+      ').to reek_of(:Attribute, name: 'my_attr')
     end
 
-    context 'declared in a module' do
-      before :each do
-        @src = "module Fred; attr :#{@attr_name}; end"
-      end
-
-      it_should_behave_like 'one attribute found'
+    it 'records accessor attribute' do
+      expect('
+        class Klass
+          attr_accessor :my_attr
+        end
+      ').to reek_of(:Attribute, name: 'my_attr')
     end
 
-    context 'reader in a module' do
-      before :each do
-        @src = "module Fred; attr_reader :#{@attr_name}; end"
-      end
-
-      it_should_behave_like 'one attribute found'
+    it 'records attr attribute after switching visbility' do
+      expect('
+        class Klass
+          private
+          attr :my_attr
+          public :my_attr
+          private :my_attr
+          public :my_attr
+        end
+      ').to reek_of(:Attribute, name: 'my_attr')
     end
 
-    context 'writer in a module' do
-      before :each do
-        @src = "module Fred; attr_writer :#{@attr_name}; end"
-      end
-
-      it_should_behave_like 'one attribute found'
+    it "doesn't record protected attributes" do
+      src = '
+        class Klass
+          protected
+          attr :iam_protected
+        end
+      '
+      expect(src).to_not reek_of(:Attribute, name: 'iam_protected')
     end
 
-    context 'accessor in a module' do
-      before :each do
-        @src = "module Fred; attr_accessor :#{@attr_name}; end"
-      end
-
-      it_should_behave_like 'one attribute found'
+    it "doesn't record private attributes" do
+      src = '
+        class Klass
+          private
+          attr :iam_private
+        end
+      '
+      expect(src).to_not reek_of(:Attribute, name: 'iam_private')
     end
   end
 end