reek 0.2.0 → 0.2.1

data/History.txt

@@ -1,3 +1,9 @@
+== 0.2.1 2008-09-14
+
+* Tweaks:
+  * Now works from the source code, instead of requiring each named file
+  * Added integration tests that run reek on a couple of gems
+
 == 0.2.0 2008-09-10
 
 * Minor enhancements:

data/bin/reek

@@ -3,31 +3,8 @@
 #  Created on 2008-2-17.
 #  Copyright (c) 2008 Kevin Rutherford, Rutherford Software Ltd. All rights reserved.
 
-begin
-  require 'rubygems'
-rescue LoadError
-  # no rubygems to load, so we fail silently
-end
-
 require 'reek'
 require 'reek/options'
-require 'reek/version'
-
-def classes_currently_loaded
-  result = []
-  ObjectSpace.each_object(Module) { |klass| result << klass }
-  result
-end
-
-Reek::Options.parse(ARGV)
 
-old_classes = classes_currently_loaded
-files = ARGV
-files = Dir['**/*.rb'] if files.empty?
-files.each { |name| require name }
-new_classes = classes_currently_loaded - old_classes
-if new_classes.empty?
-  puts 'Nothing to analyse!'
-else
-  puts Reek.analyse(*new_classes).to_s
-end
+files = Reek::Options.parse(ARGV)
+puts Reek.analyse(*files).to_s

data/lib/reek.rb

@@ -1,18 +1,19 @@
 $:.unshift File.dirname(__FILE__)
 
-require 'reek/class_checker'
+require 'reek/file_checker'
 require 'reek/report'
 
 module Reek # :doc:
 
     #
-    # Analyse the given instances of class Class, looking for code smells.
+    # Analyse the given source files, looking for code smells.
     # Returns a +Report+ listing the smells found.
     #
-    def self.analyse(*klasses)  # :doc:
+    def self.analyse(*files)  # :doc:
       report = Report.new
-      klasses.each do |klass|
-        ClassChecker.new(report).check_object(klass)
+      files.each do |file|
+        source = IO.readlines(file).join
+        FileChecker.new(report).check_source(source)
       end
       report
     end    

data/lib/reek/class_checker.rb

@@ -21,8 +21,7 @@ module Reek
     end
 
     def process_defn(exp)  # :nodoc:
-      bc = Reek::MethodChecker.new(@smells, @description)
-      bc.process(exp)
+      Reek::MethodChecker.new(@smells, @description).process(exp)
       s(exp)
     end  
   end

data/lib/reek/file_checker.rb

@@ -0,0 +1,26 @@
+$:.unshift File.dirname(__FILE__)
+
+require 'reek/checker'
+require 'reek/class_checker'
+require 'reek/method_checker'
+
+module Reek
+
+  class FileChecker < Checker
+
+    def initialize(report)
+      super(report)
+      @description = ''
+    end
+
+    def process_class(exp)  # :nodoc:
+      Reek::ClassChecker.new(@smells).process(exp)
+      s(exp)
+    end
+
+    def process_defn(exp)  # :nodoc:
+      Reek::MethodChecker.new(@smells, @description).process(exp)
+      s(exp)
+    end  
+  end
+end

data/lib/reek/method_checker.rb

@@ -10,22 +10,17 @@ module Reek
 
     def initialize(smells, klass_name)
       super(smells)
-      @class_name = klass_name
-      @description = klass_name
+      @class_name = @description = klass_name
       @calls = Hash.new(0)
       @lvars = Set.new
-      @inside_an_iter = false
+      @num_statements = 0
     end
 
     def process_defn(exp)
-      @num_statements = 0
       @description = "#{@class_name}##{exp[1]}"
       UncommunicativeName.check(exp[1], self, 'method')
       process(exp[2])
-      @lvars.each {|lvar| UncommunicativeName.check(lvar, self, 'local variable') }
-      UtilityFunction.check(@calls, self)
-      FeatureEnvy.check(@calls, self)
-      LongMethod.check(@num_statements, self)
+      check_method_properties
       s(exp)
     end
 
@@ -49,7 +44,7 @@ module Reek
     end
 
     def process_block(exp)
-      @num_statements += count_statements(exp)
+      @num_statements += MethodChecker.count_statements(exp)
       exp[1..-1].each { |s| process(s) }
       s(exp)
     end
@@ -61,12 +56,8 @@ module Reek
     end
 
     def process_call(exp)
-      receiver = process(exp[1])
-      receiver = receiver[0] if Array === receiver and Array === receiver[0] and receiver.length == 1
-      if receiver[0] != :gvar
-        receiver = :self if receiver == s(:self)
-        @calls[receiver] += 1
-      end
+      record_receiver(exp[1])
+      process_actual_parameters(exp[3])
       process(exp[3]) if exp.length > 3
       s(exp)
     end
@@ -107,11 +98,58 @@ module Reek
     end
 
   private
-    
-    def count_statements(exp)
+
+    def self.count_statements(exp)
       result = exp.length - 1
       result -= 1 if Array === exp[1] and exp[1][0] == :args
       result
     end
+
+    def self.is_global_variable?(exp)
+      Array === exp and exp[0] == :gvar
+    end
+
+    def record_receiver(exp)
+      receiver = MethodChecker.unpack_array(process(exp))
+      @calls[receiver] += 1 unless MethodChecker.is_global_variable?(receiver)
+    end
+
+    def self.unpack_array(receiver)
+      receiver = receiver[0] if Array === receiver and Array === receiver[0] and receiver.length == 1
+      receiver = :self if receiver == s(:self)
+      receiver
+    end
+
+    def is_override?
+      begin
+        klass = Object.const_get(@class_name)
+      rescue
+        return false
+      end
+      klass.superclass.instance_methods.include?(@description.to_s.split('#')[1])
+    end
+
+    def check_method_properties
+      @lvars.each {|lvar| UncommunicativeName.check(lvar, self, 'local variable') }
+      @calls[:self] += 1 if is_override?
+      UtilityFunction.check(@calls, self)
+      FeatureEnvy.check(@calls, self)
+      LongMethod.check(@num_statements, self)
+    end
+
+    def process_actual_parameters(exp)
+      return unless Array === exp and exp[0] == :array
+      exp[1..-1].each do |param|
+        if Array === param
+          if param.length == 1
+            @calls[:self] += 1 if param[0] == :self
+          else
+            @calls[param] += 1
+          end
+        else
+          @calls[:self] += 1 if param == :self
+        end
+      end
+    end
   end
 end

data/lib/reek/options.rb

@@ -48,13 +48,21 @@ module Reek
       result
     end
     
+    def self.fatal_error(e) # :nodoc:
+      puts "Error: #{e}"
+      puts "Use '-h' for help."
+      exit(1)
+    end
+
     def self.parse(args)
       begin
         @@opts = parse_args(args)
+        files = ARGV
+        files = Dir['**/*.rb'] if files.empty?
+        fatal_error('no source files specified') if files.empty?
+        files
       rescue OptionParser::ParseError => e
-        puts "Error: #{e}"
-        puts "Use '-h' for help."
-        exit(1)
+        fatal_error(e)
       end
     end
   end

data/lib/reek/printer.rb

@@ -19,6 +19,7 @@ module Reek
 
     def print(sexp)
       @report = sexp.inspect
+      return @report unless Array === sexp
       begin
         process(sexp)
       rescue

data/lib/reek/report.rb

@@ -5,13 +5,13 @@ require 'set'
 module Reek
 
   class SortByContext
-    def compare(smell1, smell2)
+    def self.compare(smell1, smell2)
       smell1.detailed_report <=> smell2.detailed_report
     end
   end
 
   class SortBySmell
-    def compare(smell1, smell2)
+    def self.compare(smell1, smell2)
       smell1.report <=> smell2.report
     end
   end
@@ -19,8 +19,8 @@ module Reek
   class Report
 
     SORT_ORDERS = {
-      :context => SortByContext.new,
-      :smell => SortBySmell.new
+      :context => SortByContext,
+      :smell => SortBySmell
     }
 
     def initialize  # :nodoc:
@@ -39,8 +39,8 @@ module Reek
       @smells.length
     end
 
-    def [](i)  # :nodoc:
-      @smells.to_a[i]
+    def [](index)  # :nodoc:
+      @smells.to_a[index]
     end
 
     # Creates a formatted report of all the smells recorded in

data/lib/reek/smells.rb

@@ -18,7 +18,16 @@ module Reek
 
     def self.check(exp, context, arg=nil)
       smell = new(context, arg)
-      context.report(smell) if smell.recognise?(exp)
+      if smell.recognise?(exp)
+        context.report(smell)
+        true
+      else
+        false
+      end
+    end
+    
+    def recognise?(stuff)
+      @context != nil
     end
 
     def hash  # :nodoc:
@@ -39,6 +48,8 @@ module Reek
       "[#{name}] #{detailed_report}"
     end
 
+    alias inspect report
+
     def to_s
       report
     end
@@ -47,28 +58,30 @@ module Reek
   class LongParameterList < Smell
     MAX_ALLOWED = 3
 
-    def count_parameters(exp)
+    def self.count_parameters(exp)
       result = exp.length - 1
       result -= 1 if Array === exp[-1] and exp[-1][0] == :block
       result
     end
 
     def recognise?(args)
-      count_parameters(args) > MAX_ALLOWED
+      @num_params = LongParameterList.count_parameters(args)
+      @num_params > MAX_ALLOWED
     end
 
     def detailed_report
-      "#{@context.to_s} has > #{MAX_ALLOWED} parameters"
+      "#{@context.to_s} has #{@num_params} parameters"
     end
   end
 
   class LongYieldList < LongParameterList
     def recognise?(args)
-      Array === args and args.length > MAX_ALLOWED
+      @num_params = args.length
+      Array === args and @num_params > MAX_ALLOWED
     end
 
     def detailed_report
-      "#{@context} yields > #{MAX_ALLOWED} parameters"
+      "#{@context} yields #{@num_params} parameters"
     end
   end
 
@@ -86,21 +99,28 @@ module Reek
   end
 
   class FeatureEnvy < Smell
-    def initialize(context, receiver)
-      super
-      @receiver = receiver
+    
+    # TODO
+    # Should be moved to Hash; but Hash has 58 methods, and there's currently
+    # no way to turn off that report; which would therefore make the tests fail
+    def self.max_keys(calls)
+      max = calls.values.max or return [:self]
+      calls.keys.select { |key| calls[key] == max }
+    end
+
+    def initialize(context, *receivers)
+      super(context)
+      @receivers = receivers
     end
 
     def recognise?(calls)
-      max = calls.empty? ? 0 : calls.values.max
-      return false unless max > calls[:self]
-      receivers = calls.keys.select { |key| calls[key] == max }
-      @receiver = receivers.map {|r| Printer.print(r)}.sort.join(' and ')
-      return true
+      @receivers = FeatureEnvy.max_keys(calls)
+      return !(@receivers.include?(:self))
     end
 
     def detailed_report
-      "#{@context} uses #{@receiver} more than self"
+      receiver = @receivers.map {|r| Printer.print(r)}.sort.join(' and ')
+      "#{@context} uses #{receiver} more than self"
     end
   end
 
@@ -118,13 +138,13 @@ module Reek
     MAX_ALLOWED = 25
 
     def recognise?(name)
-      kl = Object.const_get(name) rescue return
-      num_methods = kl.instance_methods.length - kl.superclass.instance_methods.length
-      num_methods > MAX_ALLOWED
+      klass = Object.const_get(name) rescue return
+      @num_methods = klass.instance_methods.length - klass.superclass.instance_methods.length
+      @num_methods > MAX_ALLOWED
     end
 
     def detailed_report
-      "#{@context} has > #{MAX_ALLOWED} methods"
+      "#{@context} has #{@num_methods} methods"
     end
   end
 

data/lib/reek/version.rb

@@ -2,7 +2,7 @@ module Reek #:nodoc:
   module VERSION #:nodoc:
     MAJOR = 0
     MINOR = 2
-    TINY  = 0
+    TINY  = 1
 
     STRING = [MAJOR, MINOR, TINY].join('.')
   end

data/spec/integration_spec.rb

@@ -0,0 +1,38 @@
+require File.dirname(__FILE__) + '/spec_helper.rb'
+
+describe 'Integration test:' do
+  Dir['spec/samples/*.rb'].each do |source|
+    describe source do
+      before :each do
+        @expected = IO.readlines(source.sub(/\.rb/, '.reek'))
+        @expected.each {|line| line.chomp!}
+      end
+
+      it 'should report the correct smells' do
+        actual = `ruby -Ilib bin/reek #{source} 2>/dev/null`.split(/\n/)
+        @expected.zip(actual).each do |p|
+          actual = p[1] ? p[1].chomp : p[1]
+          actual.should == p[0]
+        end
+      end
+
+      it 'should report the correct smells in smell order' do
+        actual = `ruby -Ilib bin/reek --sort smell #{source} 2>/dev/null`.split(/\n/)
+        @expected.sort.zip(actual).each do |p|
+          actual = p[1] ? p[1].chomp : p[1]
+          actual.should == p[0]
+        end
+      end
+    end
+  end
+end
+
+describe 'Reek source code:' do
+  Dir['lib/**/*.rb'].each do |source|
+    describe source do
+      it 'should report no smells' do
+        `ruby -Ilib bin/reek #{source}`.should == "\n"
+      end
+    end
+  end
+end