reek 2.0.4 → 2.1.0

data/reek.gemspec

@@ -1,6 +1,5 @@
 # -*- encoding: utf-8 -*-
-$LOAD_PATH.push File.join(File.dirname(__FILE__), 'lib')
-require 'reek/version'
+require File.join(File.dirname(__FILE__), 'lib/reek/version')
 
 Gem::Specification.new do |s|
   s.name = 'reek'
@@ -15,31 +14,26 @@ Gem::Specification.new do |s|
 
   s.license = 'MIT'
   s.email = ['timo.roessner@googlemail.com']
-  s.executables = ['reek']
   s.extra_rdoc_files = ['CHANGELOG', 'License.txt']
-  s.files = Dir['.yardopts', 'CHANGELOG', 'License.txt', 'README.md',
-                'Rakefile', 'assets/html_output.html.erb', 'bin/reek',
-                'config/defaults.reek', '{features,lib,spec,tasks}/**/*',
-                'reek.gemspec'] & `git ls-files -z`.split("\0")
-  s.homepage = 'https://wiki.github.com/troessner/reek'
-  s.rdoc_options = ['--main', 'README.md',
-                    '-x', 'assets/|bin/|config/|features/|spec/|tasks/']
-  s.require_paths = ['lib']
-  s.rubyforge_project = 'reek'
-  s.rubygems_version = '1.3.6'
+  s.files = `git ls-files -z`.split("\0")
+  s.executables = s.files.grep(%r{^bin/}).map { |path| File.basename(path) }
+  s.homepage = 'https://github.com/troessner/reek/wiki'
+  s.rdoc_options = %w(--main README.md -x assets/|bin/|config/|features/|spec/|tasks/)
   s.required_ruby_version = '>= 1.9.3'
   s.summary = 'Code smell detector for Ruby'
 
-  s.add_runtime_dependency('parser', ['~> 2.2'])
-  s.add_runtime_dependency('unparser', ['~> 0.2.2'])
-  s.add_runtime_dependency('rainbow', ['~> 2.0'])
-  s.add_runtime_dependency('require_all', ['~> 1.3'])
+  s.add_runtime_dependency 'parser',      '~> 2.2'
+  s.add_runtime_dependency 'rainbow',     '~> 2.0'
+  s.add_runtime_dependency 'require_all', '~> 1.3'
+  s.add_runtime_dependency 'unparser',    '~> 0.2.2'
 
-  s.add_development_dependency('bundler', ['~> 1.1'])
-  s.add_development_dependency('rake', ['~> 10.0'])
-  s.add_development_dependency('cucumber', ['~> 1.3', '>= 1.3.18'])
-  s.add_development_dependency('rspec', ['~> 3.0'])
-  s.add_development_dependency('yard', ['>= 0.8.7', '< 0.9'])
-  s.add_development_dependency('factory_girl', ['~> 4.0'])
-  s.add_development_dependency('rubocop', ['~> 0.29.0'])
+  s.add_development_dependency 'activesupport', '~> 4.2'
+  s.add_development_dependency 'aruba',         '~> 0.6.2'
+  s.add_development_dependency 'bundler',       '~> 1.1'
+  s.add_development_dependency 'cucumber',      '~> 2.0'
+  s.add_development_dependency 'factory_girl',  '~> 4.0'
+  s.add_development_dependency 'rake',          '~> 10.0'
+  s.add_development_dependency 'rspec',         '~> 3.0'
+  s.add_development_dependency 'rubocop',       '~> 0.30.0'
+  s.add_development_dependency 'yard',          '~> 0.8.7'
 end

data/spec/factories/factories.rb

@@ -1,4 +1,4 @@
-require 'reek/smells'
+require_relative '../../lib/reek/smells'
 
 FactoryGirl.define do
   factory :smell_detector, class: Reek::Smells::SmellDetector do

data/spec/gem/updates_spec.rb

@@ -1,4 +1,4 @@
-require 'spec_helper'
+require_relative '../spec_helper'
 require 'find'
 
 release_timestamp_file = 'build/.last-release'

data/spec/gem/yard_spec.rb

@@ -1,4 +1,4 @@
-require 'spec_helper'
+require_relative '../spec_helper'
 require 'tempfile'
 
 describe 'yardoc' do

data/spec/quality/reek_source_spec.rb

@@ -1,4 +1,4 @@
-require 'spec_helper'
+require_relative '../spec_helper'
 
 describe 'Reek source code' do
   it 'has no smells' do

data/spec/reek/cli/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/cli/report/report'
 
-include Reek
-include Reek::Cli
-
-describe Report::HtmlReport do
-  let(:instance) { Report::HtmlReport.new }
+describe Reek::CLI::Report::HTMLReport do
+  let(:instance) { Reek::CLI::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/cli/json_report_spec.rb

@@ -1,10 +1,10 @@
-require 'spec_helper'
-require 'reek/examiner'
-require 'reek/cli/report/report'
-require 'reek/cli/report/formatter'
+require_relative '../../spec_helper'
+require_relative '../../../lib/reek/examiner'
+require_relative '../../../lib/reek/cli/report/report'
+require_relative '../../../lib/reek/cli/report/formatter'
 
-describe Reek::Cli::Report::JsonReport do
-  let(:instance) { Reek::Cli::Report::JsonReport.new }
+describe Reek::CLI::Report::JSONReport do
+  let(:instance) { Reek::CLI::Report::JSONReport.new }
 
   context 'empty source' do
     let(:examiner) { Reek::Examiner.new('') }

data/spec/reek/cli/option_interperter_spec.rb

@@ -1,14 +1,14 @@
-require 'spec_helper'
+require_relative '../../spec_helper'
 
-require 'reek/cli/options'
+require_relative '../../../lib/reek/cli/options'
 
-describe Reek::Cli::OptionInterpreter do
+describe Reek::CLI::OptionInterpreter do
   let(:options) { OpenStruct.new }
-  let(:instance) { Reek::Cli::OptionInterpreter.new(options) }
+  let(:instance) { Reek::CLI::OptionInterpreter.new(options) }
 
   describe '#reporter' do
     it 'returns a Report::TextReport instance by default' do
-      expect(instance.reporter).to be_instance_of Reek::Cli::Report::TextReport
+      expect(instance.reporter).to be_instance_of Reek::CLI::Report::TextReport
     end
   end
 end

data/spec/reek/cli/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/cli/report/report'
+require_relative '../../../lib/reek/cli/report/formatter'
+require_relative '../../../lib/reek/cli/report/heading_formatter'
 require 'rainbow'
 
-include Reek
-include Reek::Cli
-
-describe Report::TextReport do
+describe Reek::CLI::Report::TextReport do
   let(:report_options) do
     {
-      warning_formatter: Report::SimpleWarningFormatter.new,
-      report_formatter: Report::Formatter,
-      heading_formatter: Report::HeadingFormatter::Quiet
+      warning_formatter: Reek::CLI::Report::SimpleWarningFormatter.new,
+      report_formatter: Reek::CLI::Report::Formatter,
+      heading_formatter: Reek::CLI::Report::HeadingFormatter::Quiet
     }
   end
-  let(:instance) { Report::TextReport.new report_options }
+  let(:instance) { Reek::CLI::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/cli/yaml_report_spec.rb

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

data/spec/reek/configuration/app_configuration_spec.rb

@@ -1,11 +1,8 @@
-require 'spec_helper'
-require 'reek/configuration/app_configuration'
-require 'reek/core/smell_repository'
+require_relative '../../spec_helper'
+require_relative '../../../lib/reek/configuration/app_configuration'
+require_relative '../../../lib/reek/core/smell_repository'
 
-include Reek::Configuration
-include Reek::Core
-
-describe AppConfiguration do
+describe Reek::Configuration::AppConfiguration do
   let(:sample_configuration_path) { 'spec/samples/simple_configuration.reek' }
   let(:sample_configuration_loaded) do
     {
@@ -15,31 +12,32 @@ describe AppConfiguration do
   end
   let(:default_configuration) { Hash.new }
 
-  after(:each) { AppConfiguration.reset }
+  after(:each) { Reek::Configuration::AppConfiguration.reset }
 
   describe '.initialize_with' do
     it 'loads a configuration file if it can find one' do
-      allow(ConfigurationFileFinder).to receive(:find).and_return sample_configuration_path
-      expect(AppConfiguration.configuration).to eq(default_configuration)
+      finder = Reek::Configuration::ConfigurationFileFinder
+      allow(finder).to receive(:find).and_return sample_configuration_path
+      expect(Reek::Configuration::AppConfiguration.configuration).to eq(default_configuration)
 
-      AppConfiguration.initialize_with(nil)
-      expect(AppConfiguration.configuration).to eq(sample_configuration_loaded)
+      Reek::Configuration::AppConfiguration.initialize_with(nil)
+      expect(Reek::Configuration::AppConfiguration.configuration).to eq(sample_configuration_loaded)
     end
 
     it 'leaves the default configuration untouched if it can\'t find one' do
-      allow(ConfigurationFileFinder).to receive(:find).and_return nil
-      expect(AppConfiguration.configuration).to eq(default_configuration)
+      allow(Reek::Configuration::ConfigurationFileFinder).to receive(:find).and_return nil
+      expect(Reek::Configuration::AppConfiguration.configuration).to eq(default_configuration)
 
-      AppConfiguration.initialize_with(nil)
-      expect(AppConfiguration.configuration).to eq(default_configuration)
+      Reek::Configuration::AppConfiguration.initialize_with(nil)
+      expect(Reek::Configuration::AppConfiguration.configuration).to eq(default_configuration)
     end
   end
 
   describe '.configure_smell_repository' do
     it 'should configure a given smell_repository' do
-      AppConfiguration.load_from_file(sample_configuration_path)
-      smell_repository = SmellRepository.new('def m; end')
-      AppConfiguration.configure_smell_repository smell_repository
+      Reek::Configuration::AppConfiguration.load_from_file(sample_configuration_path)
+      smell_repository = Reek::Core::SmellRepository.new('def m; end')
+      Reek::Configuration::AppConfiguration.configure_smell_repository smell_repository
 
       expect(smell_repository.detectors[Reek::Smells::DataClump]).to be_enabled
       expect(smell_repository.detectors[Reek::Smells::UncommunicativeVariableName]).
@@ -50,18 +48,18 @@ describe AppConfiguration do
 
   describe '.load_from_file' do
     it 'loads the configuration from given file' do
-      AppConfiguration.load_from_file(sample_configuration_path)
-      expect(AppConfiguration.configuration).to eq(sample_configuration_loaded)
+      Reek::Configuration::AppConfiguration.load_from_file(sample_configuration_path)
+      expect(Reek::Configuration::AppConfiguration.configuration).to eq(sample_configuration_loaded)
     end
   end
 
   describe '.reset' do
     it 'resets the configuration' do
-      AppConfiguration.load_from_file(sample_configuration_path)
+      Reek::Configuration::AppConfiguration.load_from_file(sample_configuration_path)
 
-      expect(AppConfiguration.configuration).to eq(sample_configuration_loaded)
-      AppConfiguration.reset
-      expect(AppConfiguration.configuration).to eq(default_configuration)
+      expect(Reek::Configuration::AppConfiguration.configuration).to eq(sample_configuration_loaded)
+      Reek::Configuration::AppConfiguration.reset
+      expect(Reek::Configuration::AppConfiguration.configuration).to eq(default_configuration)
     end
   end
 end

data/spec/reek/configuration/configuration_file_finder_spec.rb

@@ -1,34 +1,59 @@
-require 'spec_helper'
-require 'reek/cli/application'
+# encoding: UTF-8
 
-include Reek::Cli
-include Reek::Configuration
+require 'pathname'
+require 'tmpdir'
+require_relative '../../spec_helper'
 
-describe ConfigurationFileFinder do
+describe Reek::Configuration::ConfigurationFileFinder do
   describe '.find' do
-    let(:sample_config_path) { Pathname.new('spec/samples/simple_configuration.reek') }
-    let(:config_path_same_level) { Pathname.new('spec/samples/simple_configuration.reek') }
-    let(:options_with_config_file) { double(config_file: sample_config_path) }
-    let(:options_without_config_file) { double(config_file: nil) }
+    it 'returns the config_file if it’s set' do
+      config_file = double
+      options = double(config_file: config_file)
+      found = described_class.find(options: options)
+      expect(found).to eq(config_file)
+    end
 
-    it 'should return the config file we passed as cli option if given' do
-      expect(ConfigurationFileFinder.find(options_with_config_file)).to eq(sample_config_path)
+    it 'returns the file in current dir if config_file is nil' do
+      options = double(config_file: nil)
+      current = Pathname.new('spec/samples')
+      found = described_class.find(options: options, current: current)
+      expect(found).to eq(Pathname.new('spec/samples/exceptions.reek'))
     end
 
-    it 'should return the first configuration file it can find in the current directory' do
-      allow(ConfigurationFileFinder).to receive(:detect_or_traverse_up).
-        and_return config_path_same_level
+    it 'returns the file in current dir if options is nil' do
+      current = Pathname.new('spec/samples')
+      found = described_class.find(current: current)
+      expect(found).to eq(Pathname.new('spec/samples/exceptions.reek'))
+    end
 
-      expect(ConfigurationFileFinder.find(options_without_config_file)).
-        to eq(config_path_same_level)
+    it 'returns the file in a parent dir if none in current dir' do
+      current = Pathname.new('spec/samples/no_config_file')
+      found = described_class.find(current: current)
+      expect(found).to eq(Pathname.new('spec/samples/exceptions.reek'))
     end
 
-    it 'should look in the HOME directory lastly' do
-      allow(ConfigurationFileFinder).to receive(:configuration_by_cli).and_return nil
-      allow(ConfigurationFileFinder).to receive(:configuration_in_file_system).and_return nil
-      expect(ConfigurationFileFinder).to receive(:configuration_in_home_directory).once
+    it 'returns the file even if it’s just ‘.reek’' do
+      current = Pathname.new('spec/samples/masked_by_dotfile')
+      found = described_class.find(current: current)
+      expect(found).to eq(Pathname.new('spec/samples/masked_by_dotfile/.reek'))
+    end
+
+    it 'returns the file in home if traversing from the current dir fails' do
+      Dir.mktmpdir do |tempdir|
+        current = Pathname.new(tempdir)
+        home    = Pathname.new('spec/samples')
+        found = described_class.find(current: current, home: home)
+        expect(found).to eq(Pathname.new('spec/samples/exceptions.reek'))
+      end
+    end
 
-      ConfigurationFileFinder.find nil
+    it 'returns nil when there are no files to find' do
+      Dir.mktmpdir do |tempdir|
+        current = Pathname.new(tempdir)
+        home    = Pathname.new(tempdir)
+        found = described_class.find(current: current, home: home)
+        expect(found).to be_nil
+      end
     end
   end
 end

data/spec/reek/core/code_context_spec.rb

@@ -1,11 +1,9 @@
-require 'spec_helper'
-require 'reek/core/method_context'
-require 'reek/core/module_context'
-require 'reek/core/stop_context'
+require_relative '../../spec_helper'
+require_relative '../../../lib/reek/core/method_context'
+require_relative '../../../lib/reek/core/module_context'
+require_relative '../../../lib/reek/core/stop_context'
 
-include Reek::Core
-
-describe CodeContext do
+describe Reek::Core::CodeContext do
   context 'name recognition' do
     before :each do
       @exp_name = 'random_name'    # SMELL: could use a String.random here
@@ -14,7 +12,7 @@ describe CodeContext do
       allow(@exp).to receive(:name).and_return(@exp_name)
       allow(@exp).to receive(:full_name).and_return(@full_name)
       allow(@exp).to receive(:comments).and_return('')
-      @ctx = CodeContext.new(nil, @exp)
+      @ctx = Reek::Core::CodeContext.new(nil, @exp)
     end
     it 'gets its short name from the exp' do
       expect(@ctx.name).to eq(@exp_name)
@@ -44,7 +42,7 @@ describe CodeContext do
         @outer_name = 'another_random sting'
         allow(outer).to receive(:full_name).at_least(:once).and_return(@outer_name)
         allow(outer).to receive(:config).and_return({})
-        @ctx = CodeContext.new(outer, @exp)
+        @ctx = Reek::Core::CodeContext.new(outer, @exp)
       end
       it 'creates the correct full name' do
         expect(@ctx.full_name).to eq("#{@full_name}")
@@ -60,10 +58,10 @@ describe CodeContext do
 
   context 'generics' do
     it 'should pass unknown method calls down the stack' do
-      stop = StopContext.new
+      stop = Reek::Core::StopContext.new
       def stop.bananas(arg1, arg2) arg1 + arg2 + 43 end
-      element = ModuleContext.new(stop, s(:module, :mod, nil))
-      element = MethodContext.new(element, s(:def, :bad, s(:args), nil))
+      element = Reek::Core::ModuleContext.new(stop, s(:module, :mod, nil))
+      element = Reek::Core::MethodContext.new(element, s(:def, :bad, s(:args), nil))
       expect(element.bananas(17, -5)).to eq(55)
     end
   end
@@ -73,8 +71,8 @@ describe CodeContext do
       before :each do
         @module_name = 'Emptiness'
         src = "module #{@module_name}; end"
-        ast = src.to_reek_source.syntax_tree
-        @ctx = CodeContext.new(nil, ast)
+        ast = Reek::Source::SourceCode.from(src).syntax_tree
+        @ctx = Reek::Core::CodeContext.new(nil, ast)
       end
 
       it 'yields no calls' do
@@ -105,8 +103,8 @@ describe CodeContext do
         @module_name = 'Loneliness'
         @method_name = 'calloo'
         src = "module #{@module_name}; def #{@method_name}; puts('hello') end; end"
-        ast = src.to_reek_source.syntax_tree
-        @ctx = CodeContext.new(nil, ast)
+        ast = Reek::Source::SourceCode.from(src).syntax_tree
+        @ctx = Reek::Core::CodeContext.new(nil, ast)
       end
       it 'yields no ifs' do
         @ctx.each_node(:if, []) { |exp| raise "#{exp} yielded by empty module!" }
@@ -157,8 +155,8 @@ class Scrunch
 end
 EOS
 
-      ast = src.to_reek_source.syntax_tree
-      ctx = CodeContext.new(nil, ast)
+      ast = Reek::Source::SourceCode.from(src).syntax_tree
+      ctx = Reek::Core::CodeContext.new(nil, ast)
       expect(ctx.each_node(:if, []).length).to eq(3)
     end
   end
@@ -166,7 +164,7 @@ EOS
   describe '#config_for' do
     let(:expression) { double('exp') }
     let(:outer) { nil }
-    let(:context) { CodeContext.new(outer, expression) }
+    let(:context) { Reek::Core::CodeContext.new(outer, expression) }
     let(:sniffer) { double('sniffer') }
 
     before :each do