reek 2.1.0 → 2.2.0

data/spec/reek/cli/json_report_spec.rb

@@ -1,13 +1,13 @@
 require_relative '../../spec_helper'
-require_relative '../../../lib/reek/examiner'
+require_relative '../../../lib/reek/core/examiner'
 require_relative '../../../lib/reek/cli/report/report'
 require_relative '../../../lib/reek/cli/report/formatter'
 
-describe Reek::CLI::Report::JSONReport do
+RSpec.describe Reek::CLI::Report::JSONReport do
   let(:instance) { Reek::CLI::Report::JSONReport.new }
 
   context 'empty source' do
-    let(:examiner) { Reek::Examiner.new('') }
+    let(:examiner) { Reek::Core::Examiner.new('') }
 
     before do
       instance.add_examiner examiner

data/spec/reek/cli/{option_interperter_spec.rb → option_interpreter_spec.rb}

@@ -2,7 +2,7 @@ require_relative '../../spec_helper'
 
 require_relative '../../../lib/reek/cli/options'
 
-describe Reek::CLI::OptionInterpreter do
+RSpec.describe Reek::CLI::OptionInterpreter do
   let(:options) { OpenStruct.new }
   let(:instance) { Reek::CLI::OptionInterpreter.new(options) }
 

data/spec/reek/cli/options_spec.rb

@@ -0,0 +1,19 @@
+require_relative '../../spec_helper'
+
+require_relative '../../../lib/reek/cli/options'
+
+RSpec.describe Reek::CLI::Options do
+  describe '#initialize' do
+    it 'should enable colors when stdout is a TTY' do
+      allow($stdout).to receive_messages(tty?: false)
+      options = Reek::CLI::Options.new.parse
+      expect(options.colored).to be false
+    end
+
+    it 'should not enable colors when stdout is not a TTY' do
+      allow($stdout).to receive_messages(tty?: true)
+      options = Reek::CLI::Options.new.parse
+      expect(options.colored).to be true
+    end
+  end
+end

data/spec/reek/cli/text_report_spec.rb

@@ -1,11 +1,11 @@
 require_relative '../../spec_helper'
-require_relative '../../../lib/reek/examiner'
+require_relative '../../../lib/reek/core/examiner'
 require_relative '../../../lib/reek/cli/report/report'
 require_relative '../../../lib/reek/cli/report/formatter'
 require_relative '../../../lib/reek/cli/report/heading_formatter'
 require 'rainbow'
 
-describe Reek::CLI::Report::TextReport do
+RSpec.describe Reek::CLI::Report::TextReport do
   let(:report_options) do
     {
       warning_formatter: Reek::CLI::Report::SimpleWarningFormatter.new,
@@ -17,7 +17,7 @@ describe Reek::CLI::Report::TextReport do
 
   context 'with a single empty source' do
     before do
-      instance.add_examiner Reek::Examiner.new('')
+      instance.add_examiner Reek::Core::Examiner.new('')
     end
 
     it 'has an empty quiet_report' do
@@ -27,8 +27,8 @@ describe Reek::CLI::Report::TextReport do
 
   context 'with non smelly files' do
     before do
-      instance.add_examiner(Reek::Examiner.new('def simple() puts "a" end'))
-      instance.add_examiner(Reek::Examiner.new('def simple() puts "a" end'))
+      instance.add_examiner(Reek::Core::Examiner.new('def simple() puts "a" end'))
+      instance.add_examiner(Reek::Core::Examiner.new('def simple() puts "a" end'))
     end
 
     context 'with colors disabled' do
@@ -54,8 +54,8 @@ describe Reek::CLI::Report::TextReport do
 
   context 'with a couple of smells' do
     before do
-      instance.add_examiner(Reek::Examiner.new('def simple(a) a[3] end'))
-      instance.add_examiner(Reek::Examiner.new('def simple(a) a[3] end'))
+      instance.add_examiner(Reek::Core::Examiner.new('def simple(a) a[3] end'))
+      instance.add_examiner(Reek::Core::Examiner.new('def simple(a) a[3] end'))
     end
 
     context 'with colors disabled' do

data/spec/reek/cli/xml_report_spec.rb

@@ -0,0 +1,34 @@
+require_relative '../../spec_helper'
+require_relative '../../../lib/reek/core/examiner'
+require_relative '../../../lib/reek/cli/report/report'
+require_relative '../../../lib/reek/cli/report/formatter'
+
+RSpec.describe Reek::CLI::Report::XMLReport do
+  let(:instance) { Reek::CLI::Report::XMLReport.new }
+
+  context 'empty source' do
+    let(:examiner) { Reek::Core::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::Core::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/cli/yaml_report_spec.rb

@@ -1,13 +1,13 @@
 require_relative '../../spec_helper'
-require_relative '../../../lib/reek/examiner'
+require_relative '../../../lib/reek/core/examiner'
 require_relative '../../../lib/reek/cli/report/report'
 require_relative '../../../lib/reek/cli/report/formatter'
 
-describe Reek::CLI::Report::YAMLReport do
+RSpec.describe Reek::CLI::Report::YAMLReport do
   let(:instance) { Reek::CLI::Report::YAMLReport.new }
 
   context 'empty source' do
-    let(:examiner) { Reek::Examiner.new('') }
+    let(:examiner) { Reek::Core::Examiner.new('') }
 
     before do
       instance.add_examiner examiner

data/spec/reek/configuration/app_configuration_spec.rb

@@ -2,7 +2,7 @@ require_relative '../../spec_helper'
 require_relative '../../../lib/reek/configuration/app_configuration'
 require_relative '../../../lib/reek/core/smell_repository'
 
-describe Reek::Configuration::AppConfiguration do
+RSpec.describe Reek::Configuration::AppConfiguration do
   let(:sample_configuration_path) { 'spec/samples/simple_configuration.reek' }
   let(:sample_configuration_loaded) do
     {

data/spec/reek/configuration/configuration_file_finder_spec.rb

@@ -1,10 +1,11 @@
 # encoding: UTF-8
 
+require 'fileutils'
 require 'pathname'
 require 'tmpdir'
 require_relative '../../spec_helper'
 
-describe Reek::Configuration::ConfigurationFileFinder do
+RSpec.describe Reek::Configuration::ConfigurationFileFinder do
   describe '.find' do
     it 'returns the config_file if it’s set' do
       config_file = double
@@ -39,6 +40,7 @@ describe Reek::Configuration::ConfigurationFileFinder do
     end
 
     it 'returns the file in home if traversing from the current dir fails' do
+      skip_if_a_config_in_tempdir
       Dir.mktmpdir do |tempdir|
         current = Pathname.new(tempdir)
         home    = Pathname.new('spec/samples')
@@ -48,6 +50,7 @@ describe Reek::Configuration::ConfigurationFileFinder do
     end
 
     it 'returns nil when there are no files to find' do
+      skip_if_a_config_in_tempdir
       Dir.mktmpdir do |tempdir|
         current = Pathname.new(tempdir)
         home    = Pathname.new(tempdir)
@@ -55,5 +58,23 @@ describe Reek::Configuration::ConfigurationFileFinder do
         expect(found).to be_nil
       end
     end
+
+    it 'works with paths that need escaping' do
+      Dir.mktmpdir("ma\ngic d*r") do |tempdir|
+        config = Pathname.new("#{tempdir}/ma\ngic f*le.reek")
+        subdir = Pathname.new("#{tempdir}/ma\ngic subd*r")
+        FileUtils.touch config
+        FileUtils.mkdir subdir
+        found = described_class.find(current: subdir)
+        expect(found).to eq(config)
+      end
+    end
+
+    private
+
+    def skip_if_a_config_in_tempdir
+      found = described_class.find(current: Pathname.new(Dir.tmpdir))
+      skip "skipped: #{found} exists and would fail this test" if found
+    end
   end
 end

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

@@ -1,10 +1,10 @@
 require_relative '../../spec_helper'
-require_relative '../../../lib/reek/source/code_comment'
+require_relative '../../../lib/reek/core/code_comment'
 
-describe Reek::Source::CodeComment do
+RSpec.describe Reek::Core::CodeComment do
   context 'with an empty comment' do
     before :each do
-      @comment = Reek::Source::CodeComment.new('')
+      @comment = described_class.new('')
     end
     it 'is not descriptive' do
       expect(@comment).not_to be_descriptive
@@ -16,37 +16,37 @@ describe Reek::Source::CodeComment do
 
   context 'comment checks' do
     it 'rejects an empty comment' do
-      expect(Reek::Source::CodeComment.new('#')).not_to be_descriptive
+      expect(described_class.new('#')).not_to be_descriptive
     end
     it 'rejects a 1-word comment' do
-      expect(Reek::Source::CodeComment.new("# fred\n#  ")).not_to be_descriptive
+      expect(described_class.new("# fred\n#  ")).not_to be_descriptive
     end
     it 'accepts a 2-word comment' do
-      expect(Reek::Source::CodeComment.new('# fred here  ')).to be_descriptive
+      expect(described_class.new('# fred here  ')).to be_descriptive
     end
     it 'accepts a multi-word comment' do
       comment = "# fred here \n# with \n   # biscuits "
-      expect(Reek::Source::CodeComment.new(comment)).to be_descriptive
+      expect(described_class.new(comment)).to be_descriptive
     end
   end
 
   context 'comment config' do
     it 'parses hashed options' do
       comment = '# :reek:Duplication: { enabled: false }'
-      config = Reek::Source::CodeComment.new(comment).config
+      config = described_class.new(comment).config
       expect(config).to include('Duplication')
       expect(config['Duplication']).to include('enabled')
       expect(config['Duplication']['enabled']).to be_falsey
     end
     it 'parses hashed options with ruby names' do
       comment = '# :reek:nested_iterators: { enabled: true }'
-      config = Reek::Source::CodeComment.new(comment).config
+      config = described_class.new(comment).config
       expect(config).to include('NestedIterators')
       expect(config['NestedIterators']).to include('enabled')
       expect(config['NestedIterators']['enabled']).to be_truthy
     end
     it 'parses multiple hashed options' do
-      config = Reek::Source::CodeComment.new('
+      config = described_class.new('
         # :reek:Duplication: { enabled: false }
         :reek:nested_iterators: { enabled: true }
       ').config
@@ -57,7 +57,7 @@ describe Reek::Source::CodeComment do
       expect(config['NestedIterators']['enabled']).to be_truthy
     end
     it 'parses multiple hashed options on the same line' do
-      config = Reek::Source::CodeComment.new('
+      config = described_class.new('
         #:reek:Duplication: { enabled: false } and :reek:nested_iterators: { enabled: true }
       ').config
       expect(config).to include('Duplication', 'NestedIterators')
@@ -68,7 +68,7 @@ describe Reek::Source::CodeComment do
     end
     it 'parses multiple unhashed options on the same line' do
       comment = '# :reek:Duplication and :reek:nested_iterators'
-      config = Reek::Source::CodeComment.new(comment).config
+      config = described_class.new(comment).config
       expect(config).to include('Duplication', 'NestedIterators')
       expect(config['Duplication']).to include('enabled')
       expect(config['Duplication']['enabled']).to be_falsey
@@ -76,13 +76,13 @@ describe Reek::Source::CodeComment do
       expect(config['NestedIterators']['enabled']).to be_falsey
     end
     it 'disables the smell if no options are specifed' do
-      config = Reek::Source::CodeComment.new('# :reek:Duplication').config
+      config = described_class.new('# :reek:Duplication').config
       expect(config).to include('Duplication')
       expect(config['Duplication']).to include('enabled')
       expect(config['Duplication']['enabled']).to be_falsey
     end
     it 'ignores smells after a space' do
-      config = Reek::Source::CodeComment.new('# :reek: Duplication').config
+      config = described_class.new('# :reek: Duplication').config
       expect(config).not_to include('Duplication')
     end
   end

data/spec/reek/core/code_context_spec.rb

@@ -3,7 +3,7 @@ require_relative '../../../lib/reek/core/method_context'
 require_relative '../../../lib/reek/core/module_context'
 require_relative '../../../lib/reek/core/stop_context'
 
-describe Reek::Core::CodeContext do
+RSpec.describe Reek::Core::CodeContext do
   context 'name recognition' do
     before :each do
       @exp_name = 'random_name'    # SMELL: could use a String.random here

data/spec/reek/{examiner_spec.rb → core/examiner_spec.rb}

@@ -1,7 +1,7 @@
-require_relative '../spec_helper'
-require_relative '../../lib/reek/examiner'
+require_relative '../../spec_helper'
+require_relative '../../../lib/reek/core/examiner'
 
-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
@@ -10,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
@@ -22,14 +22,14 @@ shared_examples_for 'one smell found' do
   end
 end
 
-describe Reek::Examiner do
+RSpec.describe Reek::Core::Examiner do
   before :each do
     @expected_first_smell = 'NestedIterators'
   end
 
   context 'with a fragrant String' do
     before :each do
-      @examiner = Reek::Examiner.new('def good() true; end')
+      @examiner = described_class.new('def good() true; end')
     end
 
     it_should_behave_like 'no smells found'
@@ -37,7 +37,7 @@ describe Reek::Examiner do
 
   context 'with a smelly String' do
     before :each do
-      @examiner = Reek::Examiner.new('def fine() y = 4; end')
+      @examiner = described_class.new('def fine() y = 4; end')
       @expected_first_smell = 'UncommunicativeName'
     end
 
@@ -53,7 +53,7 @@ describe Reek::Examiner do
 
     before :each do
       smelly_dir = Dir['spec/samples/all_but_one_masked/*.rb']
-      @examiner = Reek::Examiner.new(smelly_dir)
+      @examiner = described_class.new(smelly_dir)
     end
 
     it_should_behave_like 'one smell found'
@@ -62,7 +62,7 @@ describe Reek::Examiner do
   context 'with a fragrant Dir' do
     before :each do
       clean_dir = Dir['spec/samples/three_clean_files/*.rb']
-      @examiner = Reek::Examiner.new(clean_dir)
+      @examiner = described_class.new(clean_dir)
     end
 
     it_should_behave_like 'no smells found'
@@ -77,7 +77,7 @@ describe Reek::Examiner do
 
     before :each do
       smelly_dir = Dir['spec/samples/masked_by_dotfile/*.rb']
-      @examiner = Reek::Examiner.new(smelly_dir)
+      @examiner = described_class.new(smelly_dir)
     end
 
     it_should_behave_like 'one smell found'
@@ -92,7 +92,7 @@ describe Reek::Examiner do
 
     before :each do
       smelly_file = File.new(Dir['spec/samples/all_but_one_masked/d*.rb'][0])
-      @examiner = Reek::Examiner.new(smelly_file)
+      @examiner = described_class.new(smelly_file)
     end
 
     it_should_behave_like 'one smell found'
@@ -101,7 +101,7 @@ describe Reek::Examiner do
   context 'with a fragrant File' do
     before :each do
       clean_file = File.new(Dir['spec/samples/three_clean_files/*.rb'][0])
-      @examiner = Reek::Examiner.new(clean_file)
+      @examiner = described_class.new(clean_file)
     end
 
     it_should_behave_like 'no smells found'

data/spec/reek/core/method_context_spec.rb

@@ -2,7 +2,7 @@ require_relative '../../spec_helper'
 require_relative '../../../lib/reek/core/method_context'
 require_relative '../../../lib/reek/core/stop_context'
 
-describe Reek::Core::MethodContext, 'matching' do
+RSpec.describe Reek::Core::MethodContext, 'matching' do
   before :each do
     exp = double('exp').as_null_object
     expect(exp).to receive(:full_name).at_least(:once).and_return('mod')
@@ -20,33 +20,38 @@ describe Reek::Core::MethodContext, 'matching' do
   end
 end
 
-describe Reek::Core::MethodContext do
-  it 'should record ivars as refs to self' do
-    sexp = s(:def, :feed, s(:args), nil)
-    mctx = Reek::Core::MethodContext.new(Reek::Core::StopContext.new, sexp)
-    expect(mctx.envious_receivers).to eq([])
-    mctx.record_call_to(s(:send, s(:ivar, :@cow), :feed_to))
-    expect(mctx.envious_receivers).to eq([])
+RSpec.describe Reek::Core::MethodContext do
+  let(:mc) do
+    sexp = s(:def, :foo, s(:args, s(:arg, :bar)), nil)
+    Reek::Core::MethodContext.new(Reek::Core::StopContext.new, sexp)
   end
 
-  it 'should count calls to self' do
-    sexp = s(:def, :equals, s(:args), nil)
-    mctx = Reek::Core::MethodContext.new(Reek::Core::StopContext.new, sexp)
-    mctx.refs.record_reference_to([:lvar, :other])
-    mctx.record_call_to(s(:send, s(:self), :thing))
-    expect(mctx.envious_receivers).to be_empty
-  end
+  describe '#envious_receivers' do
+    it 'should ignore ivars as refs to self' do
+      mc.record_call_to s(:send, s(:ivar, :@cow), :feed_to)
+      expect(mc.envious_receivers).to be_empty
+    end
+
+    it 'should ignore explicit calls to self' do
+      mc.refs.record_reference_to [:lvar, :other]
+      mc.record_call_to s(:send, s(:self), :thing)
+      expect(mc.envious_receivers).to be_empty
+    end
 
-  it 'should recognise a call on self' do
-    sexp = s(:def, :deep, s(:args), nil)
-    mc = Reek::Core::MethodContext.new(Reek::Core::StopContext.new, sexp)
-    mc.record_call_to(s(:send, s(:lvar, :text), :each, s(:arglist)))
-    mc.record_call_to(s(:send, nil, :shelve, s(:arglist)))
-    expect(mc.envious_receivers).to be_empty
+    it 'should ignore implicit calls to self' do
+      mc.record_call_to s(:send, s(:lvar, :text), :each, s(:arglist))
+      mc.record_call_to s(:send, nil, :shelve, s(:arglist))
+      expect(mc.envious_receivers).to be_empty
+    end
+
+    it 'should record envious calls' do
+      mc.record_call_to s(:send, s(:lvar, :bar), :baz)
+      expect(mc.envious_receivers).to eq(bar: 1)
+    end
   end
 end
 
-describe Reek::Core::MethodParameters, 'default assignments' do
+RSpec.describe Reek::Core::MethodParameters, 'default assignments' do
   def assignments_from(src)
     exp = Reek::Source::SourceCode.from(src).syntax_tree
     ctx = Reek::Core::MethodContext.new(Reek::Core::StopContext.new, exp)