reek 1.0.0 → 1.1.3

data/History.txt

@@ -1,44 +1,78 @@
-== 1.0.0 2009-04-05
+== 1.1.3 2009-05-19
+
+=== Minor Changes
+* No longer depends directly on the sexp_processor gem
+
+=== Fixes
+* LargeClass now relies only on the given source code (#26)
+
+== 1.1.2 2009-05-18
+
+=== Major Enhancements
+* Switched from ParseTree to ruby_parser for source code parsing
+* 'MyClass.should_not reek' now only possible if ParseTree gem installed
+
+== 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
 
-=== Major enhancements:
+== 1.0.1 2009-04-06
 
+=== Fixes
+* Dir[...].to_source now creates a Report that can be browsed (#36)
+
+== 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

@@ -1,12 +1,10 @@
 --- 
 LargeClass: 
   max_methods: 25
-  exclude: 
-  - Array
-  - Hash
-  - Module
-  - String
+  exclude: []
+
   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.0'
+  VERSION = '1.1.3'
 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,10 +1,7 @@
+require 'set'
 require 'reek/code_context'
 
 class Class
-  def non_inherited_methods
-    instance_methods(false) + private_instance_methods(false)
-  end
-
   def is_overriding_method?(sym)
     instance_methods(false).include?(sym) and superclass.instance_methods(true).include?(sym)
   end
@@ -23,7 +20,7 @@ module Reek
       @name = name
       @superclass = superclass
       @parsed_methods = []
-      @instance_variables = []
+      @instance_variables = Set.new
     end
 
     def myself
@@ -33,12 +30,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,8 +43,7 @@ module Reek
     end
 
     def num_methods
-      meths = myself ? myself.non_inherited_methods : @parsed_methods
-      meths.length
+      @parsed_methods.length
     end
 
     def record_instance_variable(sym)

data/lib/reek/code_parser.rb

@@ -1,6 +1,5 @@
 require 'rubygems'
-require 'parse_tree'
-require 'sexp_processor'
+require 'sexp'
 require 'reek/block_context'
 require 'reek/class_context'
 require 'reek/module_context'
@@ -12,41 +11,24 @@ require 'reek/yield_call_context'
 
 module Reek
 
-  class CodeParser < SexpProcessor
+  class CodeParser
 
-    def self.parse_tree_for(code)   # :nodoc:
-      ParseTree.new.parse_tree_for_string(code)
-    end
-
-    # Creates a new Ruby code checker. Any smells discovered by
-    # +check_source+ or +check_object+ will be stored in +report+.
+    # Creates a new Ruby code checker. Any smells discovered
+    # will be stored in +report+.
     def initialize(report, smells, ctx = StopContext.new)
-      super()
       @report = report
       @smells = smells
       @element = ctx
-      @unsupported -= [:cfunc]
-      @default_method = :process_default
-      @require_empty = @warn_on_default = false
     end
 
-    # Analyses the given Ruby source +code+ looking for smells.
-    # Any smells found are saved in the +Report+ object that
-    # was passed to this object's constructor.
-    def check_source(code)
-      check_parse_tree(CodeParser.parse_tree_for(code))
-    end
-
-    # Analyses the given Ruby object +obj+ looking for smells.
-    # 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))
+    def process(exp)
+      meth = "process_#{exp[0]}"
+      meth = :process_default unless self.respond_to?(meth)
+      self.send(meth, exp)
     end
 
     def process_default(exp)
-      exp[1..-1].each { |sub| process(sub) if Array === sub }
-      s(exp)
+      exp[0..-1].each { |sub| process(sub) if Array === sub }
     end
 
     def process_module(exp)
@@ -54,7 +36,6 @@ module Reek
         process_default(exp)
         check_smells(:module)
       end
-      s(exp)
     end
 
     def process_class(exp)
@@ -62,7 +43,6 @@ module Reek
         process_default(exp) unless @element.is_struct?
         check_smells(:class)
       end
-      s(exp)
     end
 
     def process_defn(exp)
@@ -75,23 +55,20 @@ module Reek
 
     def process_args(exp)
       exp[1..-1].each {|sym| @element.record_parameter(sym) }
-      s(exp)
     end
 
     def process_attrset(exp)
       @element.record_depends_on_self if /^@/ === exp[1].to_s
-      s(exp)
     end
 
     def process_lit(exp)
       val = exp[1]
       @element.record_depends_on_self if val == :self
-      s(exp)
     end
 
     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,20 +91,24 @@ 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
 
     def process_cfunc(exp)
       @element.record_depends_on_self
-      s(exp)
     end
 
     def process_vcall(exp)
-      @element.record_depends_on_self
-      @element.refs.record_reference_to_self
-      s(exp)
+      @element.record_use_of_self
+    end
+
+    def process_attrasgn(exp)
+      process_call(exp)
+    end
+
+    def process_op_asgn1(exp)
+      process_call(exp)
     end
 
     def process_if(exp)
@@ -140,8 +121,7 @@ module Reek
 
     def process_lasgn(exp)
       @element.record_local_variable(exp[1])
-      process(exp[2])
-      s(exp)
+      process_default(exp)
     end
 
     def process_iasgn(exp)
@@ -152,11 +132,8 @@ module Reek
 
     def process_self(exp)
       @element.record_depends_on_self
-      s(exp)
     end
 
-  private
-
     def self.count_statements(exp)
       stmts = exp[1..-1]
       ignore = 0
@@ -165,6 +142,8 @@ module Reek
       stmts.length - ignore
     end
 
+  private
+
     def self.is_expr?(exp, type)
       Array === exp and exp[0] == type
     end
@@ -178,7 +157,6 @@ module Reek
         process_default(exp)
         check_smells(type)
       end
-      s(exp)
     end
 
     def check_smells(type)
@@ -194,11 +172,6 @@ module Reek
     
     def pop(exp)
       @element = @element.outer
-      s(exp)
-    end
-
-    def check_parse_tree(sexp)  # :nodoc:
-      sexp.each { |exp| process(exp) }
     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)