reek 2.0.4 → 3.0.0

data/spec/reek/examiner_spec.rb

@@ -1,9 +1,7 @@
-require 'spec_helper'
-require 'reek/examiner'
+require_relative '../spec_helper'
+require_relative '../../lib/reek/examiner'
 
-include Reek
-
-shared_examples_for 'no smells found' do
+RSpec.shared_examples_for 'no smells found' do
   it 'is not smelly' do
     expect(@examiner).not_to be_smelly
   end
@@ -12,7 +10,7 @@ shared_examples_for 'no smells found' do
   end
 end
 
-shared_examples_for 'one smell found' do
+RSpec.shared_examples_for 'one smell found' do
   it 'is smelly' do
     expect(@examiner).to be_smelly
   end
@@ -24,14 +22,14 @@ shared_examples_for 'one smell found' do
   end
 end
 
-describe Examiner do
+RSpec.describe Reek::Examiner do
   before :each do
     @expected_first_smell = 'NestedIterators'
   end
 
   context 'with a fragrant String' do
     before :each do
-      @examiner = Examiner.new('def good() true; end')
+      @examiner = described_class.new('def good() true; end')
     end
 
     it_should_behave_like 'no smells found'
@@ -39,52 +37,13 @@ describe Examiner do
 
   context 'with a smelly String' do
     before :each do
-      @examiner = Examiner.new('def fine() y = 4; end')
+      @examiner = described_class.new('def fine() y = 4; end')
       @expected_first_smell = 'UncommunicativeName'
     end
 
     it_should_behave_like 'one smell found'
   end
 
-  context 'with a partially masked smelly Dir' do
-    around(:each) do |example|
-      with_test_config('spec/samples/all_but_one_masked/masked.reek') do
-        example.run
-      end
-    end
-
-    before :each do
-      smelly_dir = Dir['spec/samples/all_but_one_masked/*.rb']
-      @examiner = Examiner.new(smelly_dir)
-    end
-
-    it_should_behave_like 'one smell found'
-  end
-
-  context 'with a fragrant Dir' do
-    before :each do
-      clean_dir = Dir['spec/samples/three_clean_files/*.rb']
-      @examiner = Examiner.new(clean_dir)
-    end
-
-    it_should_behave_like 'no smells found'
-  end
-
-  context 'with a smelly Dir masked by a dotfile' do
-    around(:each) do |example|
-      with_test_config('spec/samples/masked_by_dotfile/.reek') do
-        example.run
-      end
-    end
-
-    before :each do
-      smelly_dir = Dir['spec/samples/masked_by_dotfile/*.rb']
-      @examiner = Examiner.new(smelly_dir)
-    end
-
-    it_should_behave_like 'one smell found'
-  end
-
   context 'with a partially masked smelly File' do
     around(:each) do |example|
       with_test_config('spec/samples/all_but_one_masked/masked.reek') do
@@ -94,7 +53,7 @@ describe Examiner do
 
     before :each do
       smelly_file = File.new(Dir['spec/samples/all_but_one_masked/d*.rb'][0])
-      @examiner = Examiner.new(smelly_file)
+      @examiner = described_class.new(smelly_file)
     end
 
     it_should_behave_like 'one smell found'
@@ -103,7 +62,7 @@ describe Examiner do
   context 'with a fragrant File' do
     before :each do
       clean_file = File.new(Dir['spec/samples/three_clean_files/*.rb'][0])
-      @examiner = Examiner.new(clean_file)
+      @examiner = described_class.new(clean_file)
     end
 
     it_should_behave_like 'no smells found'

data/spec/reek/{cli → report}/html_report_spec.rb

@@ -1,15 +1,12 @@
-require 'spec_helper'
-require 'reek/examiner'
-require 'reek/cli/report/report'
+require_relative '../../spec_helper'
+require_relative '../../../lib/reek/examiner'
+require_relative '../../../lib/reek/report/report'
 
-include Reek
-include Reek::Cli
-
-describe Report::HtmlReport do
-  let(:instance) { Report::HtmlReport.new }
+RSpec.describe Reek::Report::HTMLReport do
+  let(:instance) { Reek::Report::HTMLReport.new }
 
   context 'with an empty source' do
-    let(:examiner) { Examiner.new('') }
+    let(:examiner) { Reek::Examiner.new('') }
 
     before do
       instance.add_examiner examiner

data/spec/reek/report/json_report_spec.rb

@@ -0,0 +1,20 @@
+require_relative '../../spec_helper'
+require_relative '../../../lib/reek/examiner'
+require_relative '../../../lib/reek/report/report'
+require_relative '../../../lib/reek/report/formatter'
+
+RSpec.describe Reek::Report::JSONReport do
+  let(:instance) { Reek::Report::JSONReport.new }
+
+  context 'empty source' do
+    let(:examiner) { Reek::Examiner.new('') }
+
+    before do
+      instance.add_examiner examiner
+    end
+
+    it 'prints empty json' do
+      expect { instance.show }.to output(/^\[\]$/).to_stdout
+    end
+  end
+end

data/spec/reek/{cli → report}/text_report_spec.rb

@@ -1,26 +1,23 @@
-require 'spec_helper'
-require 'reek/examiner'
-require 'reek/cli/report/report'
-require 'reek/cli/report/formatter'
-require 'reek/cli/report/heading_formatter'
+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 'rainbow'
 
-include Reek
-include Reek::Cli
-
-describe Report::TextReport do
+RSpec.describe Reek::Report::TextReport do
   let(:report_options) do
     {
-      warning_formatter: Report::SimpleWarningFormatter.new,
-      report_formatter: Report::Formatter,
-      heading_formatter: Report::HeadingFormatter::Quiet
+      warning_formatter: Reek::Report::SimpleWarningFormatter.new,
+      report_formatter: Reek::Report::Formatter,
+      heading_formatter: Reek::Report::HeadingFormatter::Quiet
     }
   end
-  let(:instance) { Report::TextReport.new report_options }
+  let(:instance) { Reek::Report::TextReport.new report_options }
 
   context 'with a single empty source' do
     before do
-      instance.add_examiner Examiner.new('')
+      instance.add_examiner Reek::Examiner.new('')
     end
 
     it 'has an empty quiet_report' do
@@ -30,8 +27,8 @@ describe Report::TextReport do
 
   context 'with non smelly files' do
     before do
-      instance.add_examiner(Examiner.new('def simple() puts "a" end'))
-      instance.add_examiner(Examiner.new('def simple() puts "a" end'))
+      instance.add_examiner(Reek::Examiner.new('def simple() puts "a" end'))
+      instance.add_examiner(Reek::Examiner.new('def simple() puts "a" end'))
     end
 
     context 'with colors disabled' do
@@ -57,8 +54,8 @@ describe Report::TextReport do
 
   context 'with a couple of smells' do
     before do
-      instance.add_examiner(Examiner.new('def simple(a) a[3] end'))
-      instance.add_examiner(Examiner.new('def simple(a) a[3] end'))
+      instance.add_examiner(Reek::Examiner.new('def simple(a) a[3] end'))
+      instance.add_examiner(Reek::Examiner.new('def simple(a) a[3] end'))
     end
 
     context 'with colors disabled' do
@@ -72,7 +69,7 @@ describe Report::TextReport do
 
       it 'should mention every smell name' do
         expect { instance.show }.to output(/UncommunicativeParameterName/).to_stdout
-        expect { instance.show }.to output(/FeatureEnvy/).to_stdout
+        expect { instance.show }.to output(/UtilityFunction/).to_stdout
       end
     end
 

data/spec/reek/report/xml_report_spec.rb

@@ -0,0 +1,34 @@
+require_relative '../../spec_helper'
+require_relative '../../../lib/reek/examiner'
+require_relative '../../../lib/reek/report/report'
+require_relative '../../../lib/reek/report/formatter'
+
+RSpec.describe Reek::Report::XMLReport do
+  let(:instance) { Reek::Report::XMLReport.new }
+
+  context 'empty source' do
+    let(:examiner) { Reek::Examiner.new('') }
+
+    before do
+      instance.add_examiner examiner
+    end
+
+    it 'prints empty checkstyle xml' do
+      expect { instance.show }.to output("<?xml version='1.0'?>\n<checkstyle/>\n").to_stdout
+    end
+  end
+
+  context 'source with voliations' do
+    let(:examiner) { Reek::Examiner.new('def simple(a) a[0] end') }
+
+    before do
+      allow(File).to receive(:realpath).and_return('/some/path')
+      instance.add_examiner examiner
+    end
+
+    it 'prints non-empty checkstyle xml' do
+      sample_path = File.expand_path 'checkstyle.xml', 'spec/samples'
+      expect { instance.show }.to output(File.read(sample_path)).to_stdout
+    end
+  end
+end

data/spec/reek/report/yaml_report_spec.rb

@@ -0,0 +1,20 @@
+require_relative '../../spec_helper'
+require_relative '../../../lib/reek/examiner'
+require_relative '../../../lib/reek/report/report'
+require_relative '../../../lib/reek/report/formatter'
+
+RSpec.describe Reek::Report::YAMLReport do
+  let(:instance) { Reek::Report::YAMLReport.new }
+
+  context 'empty source' do
+    let(:examiner) { Reek::Examiner.new('') }
+
+    before do
+      instance.add_examiner examiner
+    end
+
+    it 'prints empty yaml' do
+      expect { instance.show }.to output(/^--- \[\]\n.*$/).to_stdout
+    end
+  end
+end

data/spec/reek/smells/attribute_spec.rb

@@ -1,118 +1,123 @@
-require 'spec_helper'
-require 'reek/smells/attribute'
-require 'reek/core/module_context'
-require 'reek/smells/smell_detector_shared'
+require_relative '../../spec_helper'
+require_relative '../../../lib/reek/smells/attribute'
+require_relative '../../../lib/reek/smells/smell_configuration'
+require_relative 'smell_detector_shared'
+
+RSpec.describe Reek::Smells::Attribute do
+  let(:config) do
+    {
+      Attribute: { Reek::Smells::SmellConfiguration::ENABLED_KEY => true }
+    }
+  end
 
-describe Reek::Smells::Attribute do
-  before :each do
+  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, src.to_reek_source.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'
+  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
 
-    shared_examples_for 'one attribute found' do
-      before :each do
-        ctx = Reek::Core::CodeContext.new(nil, @src.to_reek_source.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
+    it 'records attr attribute in a module' do
+      expect('
+        module Mod
+          attr :my_attr
+        end
+      ').to reek_of(:Attribute, name: 'my_attr')
     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' do
+      expect('
+        class Klass
+          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 reader attribute' do
+      expect('
+        class Klass
+          attr_reader :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 writer attribute' do
+      expect('
+        class Klass
+          attr_writer :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 accessor attribute' do
+      expect('
+        class Klass
+          attr_accessor :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 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 '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 "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 'writer in a module' do
-      before :each do
-        @src = "module Fred; attr_writer :#{@attr_name}; end"
-      end
-
-      it_should_behave_like 'one attribute found'
-    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

data/spec/reek/smells/behaves_like_variable_detector.rb

@@ -1,4 +1,4 @@
-shared_examples_for 'a variable detector' do
+RSpec.shared_examples_for 'a variable detector' do
   context 'with no variables' do
     it "doesn't record a smell" do
       @detector.examine_context(@ctx)

data/spec/reek/smells/boolean_parameter_spec.rb

@@ -1,8 +1,8 @@
-require 'spec_helper'
-require 'reek/smells/boolean_parameter'
-require 'reek/smells/smell_detector_shared'
+require_relative '../../spec_helper'
+require_relative '../../../lib/reek/smells/boolean_parameter'
+require_relative 'smell_detector_shared'
 
-describe Reek::Smells::BooleanParameter do
+RSpec.describe Reek::Smells::BooleanParameter do
   context 'parameter defaulted with boolean' do
     context 'in a method' do
       it 'reports a parameter defaulted to true' do
@@ -20,6 +20,32 @@ describe Reek::Smells::BooleanParameter do
         expect(src).to reek_of(:BooleanParameter, name: 'arga')
         expect(src).to reek_of(:BooleanParameter, name: 'argb')
       end
+
+      it 'reports keyword parameters defaulted to booleans' do
+        src = 'def cc(arga: true, argb: false) end'
+        expect(src).to reek_of(:BooleanParameter, name: 'arga')
+        expect(src).to reek_of(:BooleanParameter, name: 'argb')
+      end
+
+      it 'does not report regular parameters' do
+        src = 'def cc(a, b) end'
+        expect(src).not_to reek_of(:BooleanParameter)
+      end
+
+      it 'does not report array decomposition parameters' do
+        src = 'def cc((a, b)) end'
+        expect(src).not_to reek_of(:BooleanParameter)
+      end
+
+      it 'does not report keyword parameters with no default' do
+        src = 'def cc(a:, b:) end'
+        expect(src).not_to reek_of(:BooleanParameter)
+      end
+
+      it 'does not report keyword parameters with non-boolean default' do
+        src = 'def cc(a: 42, b: "32") end'
+        expect(src).not_to reek_of(:BooleanParameter)
+      end
     end
 
     context 'in a singleton method' do
@@ -49,7 +75,7 @@ describe Reek::Smells::BooleanParameter do
 
     it 'reports the fields correctly' do
       src = 'def cc(arga = true) end'
-      ctx = Reek::Core::MethodContext.new(nil, src.to_reek_source.syntax_tree)
+      ctx = Reek::Context::MethodContext.new(nil, Reek::Source::SourceCode.from(src).syntax_tree)
       @detector.examine(ctx)
       smells = @detector.smells_found.to_a
       expect(smells.length).to eq(1)

data/spec/reek/smells/class_variable_spec.rb

@@ -1,9 +1,9 @@
-require 'spec_helper'
-require 'reek/smells/class_variable'
-require 'reek/core/module_context'
-require 'reek/smells/smell_detector_shared'
+require_relative '../../spec_helper'
+require_relative '../../../lib/reek/smells/class_variable'
+require_relative '../../../lib/reek/context/module_context'
+require_relative 'smell_detector_shared'
 
-describe Reek::Smells::ClassVariable do
+RSpec.describe Reek::Smells::ClassVariable do
   before :each do
     @source_name = 'dummy_source'
     @detector = build(:smell_detector, smell_type: :ClassVariable, source: @source_name)
@@ -15,20 +15,20 @@ describe Reek::Smells::ClassVariable do
   context 'with no class variables' do
     it 'records nothing in the class' do
       exp = ast(:class, :Fred)
-      expect(@detector.examine_context(Reek::Core::CodeContext.new(nil, exp))).to be_empty
+      expect(@detector.examine_context(Reek::Context::CodeContext.new(nil, exp))).to be_empty
     end
 
     it 'records nothing in the module' do
       exp = ast(:module, :Fred)
-      expect(@detector.examine_context(Reek::Core::CodeContext.new(nil, exp))).to be_empty
+      expect(@detector.examine_context(Reek::Context::CodeContext.new(nil, exp))).to be_empty
     end
   end
 
   context 'with one class variable' do
     shared_examples_for 'one variable found' do
       before :each do
-        ast = @src.to_reek_source.syntax_tree
-        @smells = @detector.examine_context(Reek::Core::CodeContext.new(nil, ast))
+        ast = Reek::Source::SourceCode.from(@src).syntax_tree
+        @smells = @detector.examine_context(Reek::Context::CodeContext.new(nil, ast))
       end
 
       it 'records only that class variable' do
@@ -99,7 +99,7 @@ describe Reek::Smells::ClassVariable do
         #{@class_variable} = {}
       end
     EOS
-    ctx = Reek::Core::CodeContext.new(nil, src.to_reek_source.syntax_tree)
+    ctx = Reek::Context::CodeContext.new(nil, Reek::Source::SourceCode.from(src).syntax_tree)
     @warning = @detector.examine_context(ctx)[0]
     expect(@warning.source).to eq(@source_name)
     expect(@warning.smell_category).to eq(described_class.smell_category)

data/spec/reek/smells/control_parameter_spec.rb

@@ -1,8 +1,8 @@
-require 'spec_helper'
-require 'reek/smells/control_parameter'
-require 'reek/smells/smell_detector_shared'
+require_relative '../../spec_helper'
+require_relative '../../../lib/reek/smells/control_parameter'
+require_relative 'smell_detector_shared'
 
-describe Reek::Smells::ControlParameter do
+RSpec.describe Reek::Smells::ControlParameter do
   before(:each) do
     @source_name = 'dummy_source'
     @detector = build(:smell_detector, smell_type: :ControlParameter, source: @source_name)
@@ -272,7 +272,7 @@ describe Reek::Smells::ControlParameter do
           puts "hello" if arg
         end
       EOS
-      ctx = Reek::Core::MethodContext.new(nil, src.to_reek_source.syntax_tree)
+      ctx = Reek::Context::MethodContext.new(nil, Reek::Source::SourceCode.from(src).syntax_tree)
       smells = @detector.examine(ctx)
       expect(smells.length).to eq(1)
       @warning = smells[0]

data/spec/reek/smells/data_clump_spec.rb

@@ -1,8 +1,8 @@
-require 'spec_helper'
-require 'reek/smells/data_clump'
-require 'reek/smells/smell_detector_shared'
+require_relative '../../spec_helper'
+require_relative '../../../lib/reek/smells/data_clump'
+require_relative 'smell_detector_shared'
 
-shared_examples_for 'a data clump detector' do
+RSpec.shared_examples_for 'a data clump detector' do
   it 'does not report small parameter sets' do
     src = <<-EOS
       # test module
@@ -25,7 +25,7 @@ shared_examples_for 'a data clump detector' do
           def third(pa, pb) pa - pb + @fred; end
         end
       EOS
-      ctx = Reek::Core::ModuleContext.new(nil, @src.to_reek_source.syntax_tree)
+      ctx = Reek::Context::ModuleContext.new(nil, Reek::Source::SourceCode.from(@src).syntax_tree)
       detector = build(:smell_detector, smell_type: :DataClump)
       @smells = detector.examine_context(ctx)
     end
@@ -160,7 +160,7 @@ shared_examples_for 'a data clump detector' do
   end
 end
 
-describe Reek::Smells::DataClump do
+RSpec.describe Reek::Smells::DataClump do
   before(:each) do
     @detector = build(:smell_detector, smell_type: :DataClump)
   end