kevinrutherford-reek 1.0.1 → 1.1.1

data/History.txt

@@ -1,44 +1,64 @@
-== 1.0.0 2009-04-05
+== 1.1.1 2009-05-08
+
+=== Minor enhancements
+* LargeClass now also warns about any class with > 9 instance variables (#6)
+* Now depends on ruby2ruby, to display code better
+* Duplication notices more repeated method calls
+* Smells within blocks are now reported better
+
+== 1.1.0 2009-04-10
+
+=== Minor enhancements
+* Now possible to write 'MyClass.should_not reek' (#33)
+
+=== Fixes
+* Now counts attr assignments ([]= etc) in feature envy calculations
+* Doesn't attempt to find *.reek files when reading code from stdin
+
+== 1.0.1 2009-04-06
+
+=== Fixes
+* Dir[...].to_source now creates a Report that can be browsed (#36)
 
-=== Major enhancements:
+== 1.0.0 2009-04-05
 
+=== Major enhancements
 * Use *.reek files in source tree to configure Reek's behaviour
 * Added -f option to configure report format
 * --sort_order replaced by -f, -c and -s
 * Matchers provided for rspec; eg. foo.should_not reek
 
-=== Minor enhancements:
-
+=== Minor enhancements
 * Smells in singleton methods are now analysed
 * Uncommunicative parameter names in blocks now reported
 * Modules and blocks now reflected in scope of smell reports
 
-=== Fixes:
-
+=== Fixes
 * Corrected false reports of long arg lists to yield
 * A method can now be a UtilityFunction only when it includes a call
 
 == 0.3.1 2008-11-17
 
-* Minor enhancements:
-  * Uncommunicative Name now checks instance variables more thoroughly
-  * Uncommunicative Name now warns about names of the form 'x2'
-  * Added check for duplicated calls within a method
-  * Reduced scope of Feature Envy warnings to cover only overuse of lvars
-  * Added rdoc comments explaining what each smell is about
-  * Chained iterators are no longer mis-reported as nested
+=== Minor enhancements
+* Uncommunicative Name now checks instance variables more thoroughly
+* Uncommunicative Name now warns about names of the form 'x2'
+* Added check for duplicated calls within a method
+* Reduced scope of Feature Envy warnings to cover only overuse of lvars
+* Added rdoc comments explaining what each smell is about
+* Chained iterators are no longer mis-reported as nested
 
 == 0.3.0 2008-11-02
 
-* Minor enhancements:
-  * New smell: first naive checks for Control Couple
-  * reek now only checks sources passed on the command line
-  * Code snippets can be supplied on the commandline
-  * Added headings and warnings count when smells in multiple files
-  * Added Reek::RakeTask to run reek from rakefiles
-* Tweaks:
-  * Fixed: Returns exit status 2 when smells are reported
-  * Fixed: no longer claims an empty method is a Utility Function
+=== Minor enhancements
+* New smell: first naive checks for Control Couple
+* reek now only checks sources passed on the command line
+* Code snippets can be supplied on the commandline
+* Added headings and warnings count when smells in multiple files
+* Added Reek::RakeTask to run reek from rakefiles
+
+=== Fixes
+* Fixed: Returns exit status 2 when smells are reported
+* Fixed: no longer claims an empty method is a Utility Function
 
 == 0.2.3 2008-09-22
 

data/config/defaults.reek

@@ -7,6 +7,7 @@ LargeClass:
   - Module
   - String
   enabled: true
+  max_instance_variables: 9
 LongParameterList: 
   max_params: 3
   exclude: []

data/lib/reek.rb

@@ -1,5 +1,5 @@
 $:.unshift File.dirname(__FILE__)
 
 module Reek # :doc:
-  VERSION = '1.0.1'
+  VERSION = '1.1.1'
 end

data/lib/reek/block_context.rb

@@ -1,13 +1,35 @@
+require 'set'
 require 'reek/code_context'
 
 module Reek
+
+  module ParameterSet
+    def names
+      return @names if @names
+      return (@names = []) if empty?
+      arg = slice(1)
+      case slice(0)
+      when :masgn
+        @names = arg[1..-1].map {|lasgn| Name.new(lasgn[1]) }
+      when :lasgn
+        @names = [Name.new(arg)]
+      end
+    end
+
+    def include?(name)
+      names.include?(name)
+    end
+  end
+
   class BlockContext < CodeContext
 
     def initialize(outer, exp)
       super
-      @parameters = []
-      @local_variables = []
       @name = Name.new('block')
+      @parameters = exp[0] if exp
+      @parameters ||= []
+      @parameters.extend(ParameterSet)
+      @local_variables = Set.new
     end
 
     def inside_a_block?
@@ -22,8 +44,8 @@ module Reek
       @outer.inside_a_block?
     end
     
-    def record_parameter(sym)
-      @parameters << Name.new(sym)
+    def record_local_variable(sym)
+      @local_variables << Name.new(sym)
     end
 
     def outer_name
@@ -31,7 +53,7 @@ module Reek
     end
     
     def variable_names
-      @parameters + @local_variables
+      @parameters.names + @local_variables.to_a
     end
   end
 end

data/lib/reek/class_context.rb

@@ -1,3 +1,4 @@
+require 'set'
 require 'reek/code_context'
 
 class Class
@@ -23,7 +24,7 @@ module Reek
       @name = name
       @superclass = superclass
       @parsed_methods = []
-      @instance_variables = []
+      @instance_variables = Set.new
     end
 
     def myself
@@ -33,12 +34,12 @@ module Reek
     def find_module(modname)
       sym = modname.to_s
       return nil unless myself
-      myself.const_defined?(sym) ? myself.const_get(sym) : nil
+      @myself.const_defined?(sym) ? @myself.const_get(sym) : nil
     end
 
     def is_overriding_method?(name)
       return false unless myself
-      myself.is_overriding_method?(name.to_s)
+      @myself.is_overriding_method?(name.to_s)
     end
     
     def is_struct?
@@ -46,7 +47,7 @@ module Reek
     end
 
     def num_methods
-      meths = myself ? myself.non_inherited_methods : @parsed_methods
+      meths = myself ? @myself.non_inherited_methods : @parsed_methods
       meths.length
     end
 

data/lib/reek/code_parser.rb

@@ -14,8 +14,16 @@ module Reek
 
   class CodeParser < SexpProcessor
 
+    def self.unify(sexp)   # :nodoc:
+      unifier = Unifier.new
+      unifier.processors.each do |proc|
+        proc.unsupported.delete :cfunc # HACK
+      end
+      return unifier.process(sexp[0])
+    end
+
     def self.parse_tree_for(code)   # :nodoc:
-      ParseTree.new.parse_tree_for_string(code)
+      unify(ParseTree.new.parse_tree_for_string(code))
     end
 
     # Creates a new Ruby code checker. Any smells discovered by
@@ -41,11 +49,12 @@ module Reek
     # Any smells found are saved in the +Report+ object that
     # was passed to this object's constructor.
     def check_object(obj)
-      check_parse_tree(ParseTree.new.parse_tree(obj))
+      sexp = CodeParser.unify(ParseTree.new.parse_tree(obj))
+      check_parse_tree(sexp)
     end
 
     def process_default(exp)
-      exp[1..-1].each { |sub| process(sub) if Array === sub }
+      exp[0..-1].each { |sub| process(sub) if Array === sub }
       s(exp)
     end
 
@@ -91,7 +100,7 @@ module Reek
 
     def process_iter(exp)
       process(exp[1])
-      handle_context(BlockContext, :iter, exp[1..-1])
+      handle_context(BlockContext, :iter, exp[2..-1])
     end
     
     def process_dasgn_curr(exp)
@@ -114,8 +123,7 @@ module Reek
     end
 
     def process_fcall(exp)
-      @element.record_depends_on_self
-      @element.refs.record_reference_to_self
+      @element.record_use_of_self
       process_default(exp)
     end
 
@@ -125,11 +133,18 @@ module Reek
     end
 
     def process_vcall(exp)
-      @element.record_depends_on_self
-      @element.refs.record_reference_to_self
+      @element.record_use_of_self
       s(exp)
     end
 
+    def process_attrasgn(exp)
+      process_call(exp)
+    end
+
+    def process_op_asgn1(exp)
+      process_call(exp)
+    end
+
     def process_if(exp)
       handle_context(IfContext, :if, exp)
     end
@@ -155,8 +170,6 @@ module Reek
       s(exp)
     end
 
-  private
-
     def self.count_statements(exp)
       stmts = exp[1..-1]
       ignore = 0
@@ -165,6 +178,8 @@ module Reek
       stmts.length - ignore
     end
 
+  private
+
     def self.is_expr?(exp, type)
       Array === exp and exp[0] == type
     end
@@ -198,7 +213,7 @@ module Reek
     end
 
     def check_parse_tree(sexp)  # :nodoc:
-      sexp.each { |exp| process(exp) }
+      process(sexp)
     end
   end
 end

data/lib/reek/method_context.rb

@@ -32,22 +32,28 @@ module Reek
     def has_parameter(sym)
       @parameters.include?(sym.to_s)
     end
-    
+
     def record_call_to(exp)
       @calls[exp] += 1
       receiver, meth = exp[1..2]
-      if receiver.nil?
-        record_depends_on_self
-      else
-        case receiver[0]
-        when :lvar
-          @refs.record_ref(receiver) unless meth == :new
-        when :ivar
-          record_depends_on_self
-          @refs.record_reference_to_self
-        end
+      receiver ||= [:self]
+      case receiver[0]
+      when :lvar
+        @refs.record_ref(receiver) unless meth == :new
+      when :self
+        record_use_of_self
       end
     end
+
+    def record_use_of_self
+      record_depends_on_self
+      @refs.record_reference_to_self
+    end
+
+    def record_instance_variable(sym)
+      record_use_of_self
+      @outer.record_instance_variable(sym)
+    end
     
     def record_depends_on_self
       @depends_on_self = true
@@ -58,7 +64,7 @@ module Reek
     end
 
     def self.is_block_arg?(param)
-      Array === param and param[0] == :block
+      (Array === param and param[0] == :block) or (param.to_s =~ /^\&/)
     end
 
     def record_parameter(param)

data/lib/reek/module_context.rb

@@ -20,7 +20,7 @@ module Reek
     def find_module(modname)
       return nil unless myself
       sym = modname.to_s
-      myself.const_defined?(sym) ? myself.const_get(sym) : nil
+      @myself.const_defined?(sym) ? @myself.const_get(sym) : nil
     end
 
     def outer_name

data/lib/reek/name.rb

@@ -3,7 +3,9 @@ module Reek
     include Comparable
 
     def self.resolve(exp, context)
-      return [context, new(exp)] unless Array === exp
+      unless Array === exp
+        return resolve_string(exp.to_s, context)
+      end
       name = exp[1]
       case exp[0]
       when :colon2
@@ -17,6 +19,11 @@ module Reek
       end
     end
 
+    def self.resolve_string(str, context)
+      return [context, new(str)] unless str =~ /::/
+      resolve(ParseTree.new.parse_tree_for_string(str)[0], context)
+    end
+
     def initialize(sym)
       @name = sym.to_s
     end

data/lib/reek/object_refs.rb

@@ -6,7 +6,6 @@ module Reek
   class ObjectRefs  # :nodoc:
     def initialize
       @refs = Hash.new(0)
-      record_reference_to_self
     end
     
     def record_reference_to_self
@@ -34,8 +33,8 @@ module Reek
     end
 
     # 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
+    # Should be moved to Hash
+    #
     def max_keys
       max = max_refs
       @refs.reject {|key,val| val != max}.keys

data/lib/reek/report.rb

@@ -35,6 +35,12 @@ module Reek
       @report.to_a[index]
     end
 
+    # Creates a formatted report of all the +Smells::SmellWarning+ objects recorded in
+    # this report, with a heading.
+    def full_report(desc)
+      "\"#{desc}\" -- #{length} warnings:\n#{to_s}\n"
+    end
+
     # Creates a formatted report of all the +Smells::SmellWarning+ objects recorded in
     # this report.
     def to_s
@@ -64,11 +70,12 @@ module Reek
       @sources.inject(0) {|sum, src| sum + src.report.length }
     end
 
+    def smelly_sources
+      @sources.select {|src| src.smelly? }
+    end
+
     def to_s
-      @sources.select {|src| src.smelly? }.map do |src|
-        warnings = src.report
-        "\"#{src}\" -- #{warnings.length} warnings:\n#{warnings.to_s}\n"
-      end.join("\n")
+      smelly_sources.map { |src| src.full_report }.join("\n")
     end
   end
 end

data/lib/reek/sexp_formatter.rb

@@ -1,52 +1,10 @@
+require 'ruby2ruby'
+
 module Reek
   class SexpFormatter
     def self.format(sexp)
-      return sexp.to_s unless Array === sexp
-      first = sexp[1]
-      case sexp[0]
-      when :array
-        format_all(sexp, ', ')
-      when :call
-        meth, args = sexp[2..3]
-        result = format(first)
-        if meth.to_s == '[]'
-          result += (args.nil? ? '[]' : "[#{format(args)}]")
-        else
-          result += ".#{meth}" + (args ? "(#{format(args)})" : '')
-        end
-        result
-      when :colon2
-        format_all(sexp, '::')
-      when :const, :cvar, :dvar
-        format(first)
-      when :dot2
-        format_all(sexp, '..')
-      when :dstr
-        '"' + format_all(sexp, '') + '"'
-      when :evstr
-        "\#\{#{format(first)}\}"
-      when :fcall, :vcall
-        args = sexp[2]
-        result = first.to_s
-        result += "(#{format(args)})" if args
-        result
-      when :iter
-        'block'
-      when :lasgn
-        format_all(sexp, '=')
-      when :nth_ref
-        "$#{first}"
-      when :str
-        first
-      when :xstr
-        "`#{first}`"
-      else
-        sexp[-1].to_s
-      end
-    end
-    
-    def self.format_all(sexp, glue)
-      sexp[1..-1].map {|arg| format(arg)}.join(glue)
+      sexp = YAML::load(YAML::dump(sexp))
+      Ruby2Ruby.new.process(sexp)
     end
   end
 end