reek 1.3.8 → 1.4.0

data/lib/reek/source/source_file.rb

@@ -2,24 +2,22 @@ require 'reek/source/source_code'
 
 module Reek
   module Source
-
     #
     # Represents a file of Ruby source, whose contents will be examined
     # for code smells.
     #
     class SourceFile < SourceCode
-
       def initialize(path)
         @path = path
         super(IO.readlines(@path).join, @path)
       end
 
-      def configure(sniffer)
+      def relevant_config_files
         path = File.expand_path(File.dirname(@path))
-        all_config_files(path).each { |cf| ConfigFile.new(cf).configure(sniffer) }
+        all_config_files(path)
       end
 
-    private
+      private
 
       def all_config_files(path)
         return [] unless File.exist?(path)

data/lib/reek/source/source_locator.rb

@@ -2,24 +2,23 @@ require 'reek/source/core_extras'
 
 module Reek
   module Source
-
     #
     # Finds Ruby source files in a filesystem.
     #
     class SourceLocator
       def initialize(paths)
-        @paths = paths.map {|path| path.chomp('/') }
+        @paths = paths.map { |path| path.chomp('/') }
       end
 
       def all_sources
-        valid_paths.map {|path| File.new(path).to_reek_source }
+        valid_paths.map { |path| File.new(path).to_reek_source }
       end
 
-    private
+      private
 
       def all_ruby_source_files(paths)
         paths.map do |path|
-          if test ?d, path
+          if test 'd', path
             all_ruby_source_files(Dir["#{path}/**/*.rb"])
           else
             path
@@ -29,7 +28,7 @@ module Reek
 
       def valid_paths
         all_ruby_source_files(@paths).select do |path|
-          if test ?f, path
+          if test 'f', path
             true
           else
             $stderr.puts "Error: No such file - #{path}"

data/lib/reek/source/source_repository.rb

@@ -10,7 +10,7 @@ module Reek
     # single unit of Ruby source code.
     #
     class SourceRepository
-      def self.parse source
+      def self.parse(source)
         case source
         when Array
           new 'dir', Source::SourceLocator.new(source).all_sources
@@ -25,12 +25,12 @@ module Reek
       include Enumerable
       attr_reader :description
 
-      def initialize description, sources
+      def initialize(description, sources)
         @description = description
         @sources = sources
       end
 
-      def each &block
+      def each(&block)
         @sources.each(&block)
       end
     end

data/lib/reek/source/tree_dresser.rb

@@ -33,12 +33,12 @@ module Reek
 
       def extension_map
         @extension_map ||= begin
-                             assoc = @extensions_module.constants.map { |const|
+                             assoc = @extensions_module.constants.map do |const|
                                [
                                  const.to_s.sub(/Node$/, '').downcase.to_sym,
                                  @extensions_module.const_get(const)
                                ]
-                             }
+                             end
                              Hash[assoc]
                            end
       end

data/lib/reek/spec.rb

@@ -3,7 +3,6 @@ require 'reek/spec/should_reek_of'
 require 'reek/spec/should_reek_only_of'
 
 module Reek
-
   #
   # Provides matchers for Rspec, making it easy to check code quality.
   #
@@ -34,7 +33,7 @@ module Reek
   #  'def equals(other) other.thing == self.thing end'.should_not reek
   #
   # To check for specific smells, use something like this:
-  # 
+  #
   #   ruby = 'def double_thing() @other.thing.foo + @other.thing.foo end'
   #   ruby.should reek_of(:Duplication, /@other.thing[^\.]/)
   #   ruby.should reek_of(:Duplication, /@other.thing.foo/)

data/lib/reek/spec/should_reek.rb

@@ -1,9 +1,10 @@
 require 'reek/examiner'
-require 'reek/cli/report'
+require 'reek/cli/report/report'
+require 'reek/cli/report/formatter'
+require 'reek/cli/report/strategy'
 
 module Reek
   module Spec
-
     #
     # An rspec matcher that matches when the +actual+ has code smells.
     #
@@ -12,11 +13,13 @@ module Reek
         @examiner = Examiner.new(actual)
         @examiner.smelly?
       end
-      def failure_message_for_should
+
+      def failure_message
         "Expected #{@examiner.description} to reek, but it didn't"
       end
-      def failure_message_for_should_not
-        rpt = Cli::ReportFormatter.format_list(@examiner.smells)
+
+      def failure_message_when_negated
+        rpt = Cli::Report::Formatter.format_list(@examiner.smells)
         "Expected no smells, but got:\n#{rpt}"
       end
     end

data/lib/reek/spec/should_reek_of.rb

@@ -2,7 +2,6 @@ require 'reek/examiner'
 
 module Reek
   module Spec
-
     #
     # An rspec matcher that matches when the +actual+ has the specified
     # code smell.
@@ -12,15 +11,18 @@ module Reek
         @klass = klass
         @patterns = patterns
       end
+
       def matches?(actual)
         @examiner = Examiner.new(actual)
         @all_smells = @examiner.smells
-        @all_smells.any? {|warning| warning.matches?(@klass, @patterns)}
+        @all_smells.any? { |warning| warning.matches?(@klass, @patterns) }
       end
-      def failure_message_for_should
+
+      def failure_message
         "Expected #{@examiner.description} to reek of #{@klass}, but it didn't"
       end
-      def failure_message_for_should_not
+
+      def failure_message_when_negated
         "Expected #{@examiner.description} not to reek of #{@klass}, but it did"
       end
     end

data/lib/reek/spec/should_reek_only_of.rb

@@ -1,9 +1,10 @@
 require 'reek/examiner'
-require 'reek/cli/report'
+require 'reek/cli/report/report'
+require 'reek/cli/report/formatter'
+require 'reek/cli/report/strategy'
 
 module Reek
   module Spec
-
     #
     # An rspec matcher that matches when the +actual+ has the specified
     # code smell and no others.
@@ -12,16 +13,19 @@ module Reek
       def matches?(actual)
         matches_examiner?(Examiner.new(actual))
       end
+
       def matches_examiner?(examiner)
         @examiner = examiner
         @warnings = @examiner.smells
-        @warnings.length == 1 and @warnings[0].matches?(@klass, @patterns)
+        @warnings.length == 1 && @warnings[0].matches?(@klass, @patterns)
       end
-      def failure_message_for_should
-        rpt = Cli::ReportFormatter.format_list(@warnings)
+
+      def failure_message
+        rpt = Cli::Report::Formatter.format_list(@warnings)
         "Expected #{@examiner.description} to reek only of #{@klass}, but got:\n#{rpt}"
       end
-      def failure_message_for_should_not
+
+      def failure_message_when_negated
         "Expected #{@examiner.description} not to reek only of #{@klass}, but it did"
       end
     end

data/lib/reek/version.rb

@@ -1,3 +1,3 @@
 module Reek
-  VERSION = '1.3.8'
+  VERSION = '1.4.0'
 end

data/reek.gemspec

@@ -1,40 +1,44 @@
 # -*- encoding: utf-8 -*-
-$:.push File.join(File.dirname(__FILE__), "lib")
+$LOAD_PATH.push File.join(File.dirname(__FILE__), 'lib')
 require 'reek/version'
 
 Gem::Specification.new do |s|
-  s.name = %q{reek}
+  s.name = 'reek'
   s.version = Reek::VERSION
 
   s.authors = ['Kevin Rutherford', 'Timo Roessner', 'Matijs van Zuijlen']
-  s.default_executable = %q{reek}
-  s.description = %q{Reek is a tool that examines Ruby classes, modules and methods
-and reports any code smells it finds.
-}
-  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", "bin/reek", "config/defaults.reek",
-                "{features,lib,spec,tasks}/**/*",
-                "reek.gemspec" ] & `git ls-files -z`.split("\0")
-  s.homepage = %q{http://wiki.github.com/troessner/reek}
-  s.post_install_message = %q{Thank you for downloading Reek. For info see the reek wiki http://wiki.github.com/troessner/reek}
-  s.rdoc_options = ["--main", "README.md"]
-  s.require_paths = ["lib"]
-  s.rubyforge_project = %q{reek}
-  s.rubygems_version = %q{1.3.6}
-  s.summary = %q{Code smell detector for Ruby}
+  s.default_executable = 'reek'
+  s.description = <<-DESC
+    Reek is a tool that examines Ruby classes, modules and methods and reports
+    any code smells it finds.
+  DESC
 
-  s.add_runtime_dependency(%q<ruby_parser>, ["~> 3.3"])
-  s.add_runtime_dependency(%q<sexp_processor>)
-  s.add_runtime_dependency(%q<ruby2ruby>, [">= 2.0.8", "< 3.0"])
-  s.add_runtime_dependency(%q<rainbow>, [">= 1.99", "< 3.0"])
+  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 = 'http://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.required_ruby_version = '>= 1.9.2'
+  s.summary = 'Code smell detector for Ruby'
 
-  s.add_development_dependency(%q<bundler>, ["~> 1.1"])
-  s.add_development_dependency(%q<rake>)
-  s.add_development_dependency(%q<cucumber>)
-  s.add_development_dependency(%q<rspec>, ["~> 2.12"])
-  s.add_development_dependency(%q<flay>)
-  s.add_development_dependency(%q<yard>)
+  s.add_runtime_dependency('ruby_parser', ['>= 3.5.0', '< 4.0'])
+  s.add_runtime_dependency('sexp_processor', ['~> 4.4'])
+  s.add_runtime_dependency('ruby2ruby', ['>= 2.0.8', '< 3.0'])
+  s.add_runtime_dependency('rainbow', ['>= 1.99', '< 3.0'])
+
+  s.add_development_dependency('bundler', ['~> 1.1'])
+  s.add_development_dependency('rake', ['~> 10.0'])
+  s.add_development_dependency('cucumber', ['~> 1.3'])
+  s.add_development_dependency('rspec', ['~> 3.0'])
+  s.add_development_dependency('flay', ['~> 2.4'])
+  s.add_development_dependency('yard', ['>= 0.8.7', '< 0.9'])
 end

data/spec/gem/updates_spec.rb

@@ -2,7 +2,7 @@ require 'spec_helper'
 require 'find'
 
 release_timestamp_file = 'build/.last-release'
-if test(?f, release_timestamp_file)
+if test('f', release_timestamp_file)
   describe 'updates' do
     before :each do
       @release_time = File.stat(release_timestamp_file).mtime
@@ -11,16 +11,15 @@ if test(?f, release_timestamp_file)
     context 'version file' do
       it 'has been updated since the last release' do
         version_time = File.stat('lib/reek.rb').mtime
-        (version_time > @release_time).should be_true
+        expect(version_time).to be > @release_time
       end
     end
 
     context 'history file' do
       it 'has been updated since the last release' do
         history_time = File.stat('History.txt').mtime
-        (history_time > @release_time).should be_true
+        expect(history_time).to be > @release_time
       end
     end
   end
 end
-

data/spec/gem/yard_spec.rb

@@ -9,7 +9,6 @@ describe 'yardoc' do
     @stderr = IO.read(stderr_file.path)
   end
   it 'raises no warnings' do
-    @stderr.should == ''
+    expect(@stderr).to eq('')
   end
 end
-

data/spec/matchers/smell_of_matcher.rb

@@ -6,11 +6,11 @@ module SmellOfMatcher
       @config = {}
     end
 
-    def failure_message_for_should
+    def failure_message
       "Expected #{@source.desc} to smell of #{@klass}, but it didn't: #{@reason}"
     end
 
-    def failure_message_for_should_not
+    def failure_message_when_negated
       "Expected #{@source.desc} not to smell of #{@klass}, but it did"
     end
 
@@ -41,19 +41,17 @@ module SmellOfMatcher
     end
 
     def no_smells_found?
-      if @actual_smells.empty?
-        @reason = 'no smells found by detector'
-        return true
-      end
+      return false if @actual_smells.any?
+      @reason = 'no smells found by detector'
+      true
     end
 
     def wrong_number_of_smells_found?
       return false if @expected_smells.empty?
+      return false if expected_number_of_smells == actual_number_of_smells
 
-      if expected_number_of_smells != actual_number_of_smells
-        @reason = "expected #{expected_number_of_smells} smell(s), found #{actual_number_of_smells}"
-        true
-      end
+      @reason = "expected #{expected_number_of_smells} smell(s), found #{actual_number_of_smells}"
+      true
     end
 
     def expected_number_of_smells
@@ -68,10 +66,10 @@ module SmellOfMatcher
       @expected_smells.zip(@actual_smells).each do |expected_smell, actual_smell|
         expected_smell.each do |key, value|
           actual_value = actual_smell.smell[key]
-          if actual_value != value
-            @reason = "expected #{key} to be #{value}, was #{actual_value}"
-            return true
-          end
+          next if actual_value == value
+
+          @reason = "expected #{key} to be #{value}, was #{actual_value}"
+          return true
         end
       end
       false

data/spec/quality/reek_source_spec.rb

@@ -0,0 +1,42 @@
+require 'spec_helper'
+require 'flay'
+
+RSpec::Matchers.define :flay do |threshold|
+  match do |dirs_and_files|
+    @threshold = threshold
+    @flay = Flay.new(fuzzy: false, verbose: false, mass: @threshold)
+    @flay.process(*Flay.expand_dirs_to_files(dirs_and_files))
+    @flay.total > 0
+  end
+
+  failure_message_for_should do
+    "Expected source to contain duplication, but it didn't"
+  end
+
+  failure_message_for_should_not do
+    "Expected source not to contain duplication, but got:\n#{report}"
+  end
+
+  def report
+    lines = ["Total mass = #{@flay.total} (threshold = #{@threshold})"]
+    @flay.masses.each do |hash, mass|
+      nodes = @flay.hashes[hash]
+      match = @flay.identical[hash] ? 'IDENTICAL' : 'Similar'
+      lines << format('%s code found in %p (%d)', match, nodes.first.first, mass)
+      nodes.each { |x| lines << "  #{x.file}:#{x.line}" }
+    end
+    lines.join("\n")
+  end
+end
+
+describe 'Reek source code' do
+  it 'has no smells' do
+    Dir['lib/**/*.rb'].should_not reek
+  end
+  it 'has no structural duplication' do
+    ['lib'].should_not flay(16)
+  end
+  it 'has no structural duplication in the tests' do
+    ['spec/reek'].should_not flay(25)
+  end
+end

data/spec/reek/cli/help_command_spec.rb

@@ -5,19 +5,21 @@ include Reek::Cli
 
 describe HelpCommand do
   before :each do
-    @text = 'Piece of interesting text'
-    @cmd = HelpCommand.new(@text)
+    @help_text = 'Piece of interesting text'
+    @parser = double('parser')
+    allow(@parser).to receive(:help_text).and_return @help_text
+    @cmd = HelpCommand.new(@parser)
     @view = double('view').as_null_object
-    @view.should_not_receive(:report_smells)
   end
 
   it 'displays the correct text on the view' do
-    @view.should_receive(:output).with(@text)
+    expect(@view).to receive(:output).with(@help_text)
     @cmd.execute(@view)
   end
 
   it 'tells the view it succeeded' do
-    @view.should_receive(:report_success)
+    expect(@view).not_to receive(:report_smells)
+    expect(@view).to receive(:report_success)
     @cmd.execute(@view)
   end
 end