reek 1.0.0 → 1.1.3

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(RubyParser.new.parse(str), 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/object_source.rb

@@ -0,0 +1,53 @@
+module Reek
+  class Source
+    #
+    # Factory method: creates a +Source+ from obj.
+    # The code is not parsed until +report+ is called.
+    # (This feature is only enabled if you have the ParseTree gem installed.)
+    #
+    def self.from_object(obj)
+      return ObjectSource.new(obj, obj.to_s)
+    end
+  end
+
+  class ObjectSource < Source   # :nodoc:
+
+    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 can_parse_objects?
+      return true if Object.const_defined?(:ParseTree)
+      begin
+        require 'parse_tree'
+        true
+      rescue LoadError
+        false
+      end
+    end
+
+    def generate_syntax_tree
+      if can_parse_objects?
+        ObjectSource.unify(ParseTree.new.parse_tree(@source))
+      else
+        throw ArgumentError.new('You must install the ParseTree gem to use this feature')
+      end
+    end
+  end
+end
+
+class Object
+  #
+  # Constructs a Source representing this object; the source can then be used
+  # to generate an abstract syntax tree for the object, which can in turn then
+  # be examined for code smells.
+  # (This feature is only enabled if you have the ParseTree gem installed.)
+  #
+  def to_source
+    Reek::Source.from_object(self)
+  end
+end

data/lib/reek/report.rb

@@ -9,6 +9,9 @@ module Reek
       @report = SortedSet.new
     end
 
+    #
+    # Yields, in turn, each SmellWarning in this report.
+    #
     def each
       @report.each { |smell| yield smell }
     end
@@ -18,11 +21,11 @@ module Reek
       true
     end
     
-    def empty?  # :nodoc:
+    def empty?
       @report.empty?
     end
 
-    def length  # :nodoc:
+    def length
       @report.length
     end
     
@@ -32,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
@@ -39,4 +48,34 @@ module Reek
     end
   end
 
+  class ReportList
+    include Enumerable
+
+    def initialize(sources)
+      @sources = sources
+    end
+
+    #
+    # Yields, in turn, each SmellWarning in every report in this report.
+    #
+    def each(&blk)
+      @sources.each {|src| src.report.each(&blk) }
+    end
+
+    def empty?
+      length == 0
+    end
+
+    def length
+      @sources.inject(0) {|sum, src| sum + src.report.length }
+    end
+
+    def smelly_sources
+      @sources.select {|src| src.smelly? }
+    end
+
+    def to_s
+      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

data/lib/reek/smells/large_class.rb

@@ -9,8 +9,9 @@ module Reek
     # instance variables, methods or lines of code.
     # 
     # Currently +LargeClass+ only reports classes having more than a
-    # configurable number of methods. This includes public, protected and
-    # private methods, but excludes methods inherited from superclasses or
+    # configurable number of methods or instance variables. The method count
+    # includes public, protected and
+    # private methods, and excludes methods inherited from superclasses or
     # included modules.
     #
     class LargeClass < SmellDetector
@@ -19,6 +20,10 @@ module Reek
       # permitted in a class.
       MAX_ALLOWED_METHODS_KEY = 'max_methods'
 
+      # The name of the config field that sets the maximum number of instance
+      # variables permitted in a class.
+      MAX_ALLOWED_IVARS_KEY = 'max_instance_variables'
+
       def self.contexts      # :nodoc:
         [:class]
       end
@@ -26,24 +31,38 @@ module Reek
       def self.default_config
         super.adopt(
           MAX_ALLOWED_METHODS_KEY => 25,
-          EXCLUDE_KEY => ['Array', 'Hash', 'Module', 'String']
+          MAX_ALLOWED_IVARS_KEY => 9,
+          EXCLUDE_KEY => []
           )
       end
 
       def initialize(config = LargeClass.default_config)
         super
         @max_methods = config[MAX_ALLOWED_METHODS_KEY]
+        @max_instance_variables = config[MAX_ALLOWED_IVARS_KEY]
+      end
+
+      def check_num_methods(klass, report)  # :nodoc:
+        count = klass.num_methods
+        return if count <= @max_methods
+        report << SmellWarning.new(self, klass,
+                    "has at least #{count} methods")
+      end
+
+      def check_num_ivars(klass, report)  # :nodoc:
+        count = klass.variable_names.length
+        return if count <= @max_instance_variables
+        report << SmellWarning.new(self, klass,
+                    "has at least #{count} instance variables")
       end
 
       #
-      # Checks the length of the given +klass+.
+      # Checks +klass+ for too many methods or too many instance variables.
       # Any smells found are added to the +report+.
       #
       def examine_context(klass, report)
-        num_methods = klass.num_methods
-        return false if num_methods <= @max_methods
-        report << SmellWarning.new(self, klass,
-                    "has at least #{num_methods} methods")
+        check_num_methods(klass, report)
+        check_num_ivars(klass, report)
       end
     end
   end

data/lib/reek/smells/long_parameter_list.rb

@@ -27,7 +27,7 @@ module Reek
         @max_params = config['max_params']
         @action = 'has'
       end
-      
+
       #
       # Checks the number of parameters in the given scope.
       # Any smells found are added to the +report+.

data/lib/reek/smells/smells.rb

@@ -11,13 +11,10 @@ require 'reek/smells/utility_function'
 require 'yaml'
 
 class Hash
-  def value_merge!(other)
-    other.keys.each do |key|
-      self[key].adopt!(other[key])
-    end
-    self
+  def push_keys(hash)
+    keys.each {|key| hash[key].adopt!(self[key]) }
   end
-  
+
   def adopt!(other)
     other.keys.each do |key|
       ov = other[key]
@@ -69,8 +66,7 @@ module Reek
     def load_local(file)
       path = File.expand_path(file)
       all_reekfiles(path).each do |rfile|
-        cf = YAML.load_file(rfile)
-        @config.value_merge!(cf)
+        YAML.load_file(rfile).push_keys(@config)
       end
       self
     end

data/lib/reek/source.rb

@@ -1,6 +1,7 @@
 require 'reek/code_parser'
 require 'reek/report'
 require 'reek/smells/smells'
+require 'ruby_parser'
 
 module Reek
 
@@ -57,10 +58,15 @@ module Reek
       SourceList.new(sources)
     end
 
-    def initialize(code, desc, dir = '.')     # :nodoc:
+    def initialize(code, desc, dir = nil)     # :nodoc:
       @source = code
-      @dir = dir
       @desc = desc
+      @cf = SmellConfig.new
+      @cf = @cf.load_local(dir) if dir
+    end
+
+    def generate_syntax_tree
+      RubyParser.new.parse(@source, @desc) || s()
     end
 
     #
@@ -71,8 +77,8 @@ module Reek
     def report
       unless @report
         @report = Report.new
-        smells = SmellConfig.new.load_local(@dir).smell_listeners
-        CodeParser.new(@report, smells).check_source(@source)
+        parser = CodeParser.new(@report, @cf.smell_listeners)
+        parser.process(generate_syntax_tree)
       end
       @report
     end
@@ -89,6 +95,12 @@ module Reek
       report.any? { |smell| smell.matches?(smell_class, patterns) }
     end
 
+    # Creates a formatted report of all the +Smells::SmellWarning+ objects recorded in
+    # this report, with a heading.
+    def full_report
+      report.full_report(@desc)
+    end
+
     def to_s
       @desc
     end
@@ -107,10 +119,9 @@ module Reek
     end
 
     def report
-      @sources.select {|src| src.smelly? }.map do |src|
-        warnings = src.report
-        "\"#{src}\" -- #{warnings.length} warnings:\n#{warnings.to_s}\n"
-      end.join("\n")
+      ReportList.new(@sources)
     end
   end
 end
+
+require 'reek/object_source'

data/lib/reek/stop_context.rb

@@ -5,6 +5,10 @@ module Reek
       @refs = ObjectRefs.new
       @myself = Object
     end
+    def method_missing(method, *args)
+      nil
+    end
+
 
     def count_statements(num)
       0
@@ -39,22 +43,6 @@ module Reek
       false
     end
     
-    def record_call_to(exp)
-      nil
-    end
-
-    def record_method(name)
-    end
-
-    def record_parameter(sym)
-    end
-
-    def record_instance_variable(sym)
-    end
-
-    def record_local_variable(sym)
-    end
-    
     def outer_name
       ''
     end

data/lib/reek/yield_call_context.rb

@@ -6,9 +6,7 @@ module Reek
 
     def initialize(outer, exp)
       super
-      @parameters = []
-      args = exp[1]
-      @parameters = args[0...-1] if args
+      @parameters = exp[1..-1]
     end
   end
 end

data/reek.gemspec

@@ -2,18 +2,17 @@
 
 Gem::Specification.new do |s|
   s.name = %q{reek}
-  s.version = "0.3.1.6"
+  s.version = "1.1.3"
 
   s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
   s.authors = ["Kevin Rutherford"]
-  s.date = %q{2009-04-03}
+  s.date = %q{2009-05-19}
   s.default_executable = %q{reek}
   s.description = %q{Code smell detector for Ruby}
   s.email = ["kevin@rutherford-software.com"]
   s.executables = ["reek"]
   s.extra_rdoc_files = ["History.txt", "README.txt"]
-  s.files = ["History.txt", "README.txt", "Rakefile", "bin/reek", "config/defaults.reek", "lib/reek.rb", "lib/reek/block_context.rb", "lib/reek/class_context.rb", "lib/reek/code_context.rb", "lib/reek/code_parser.rb", "lib/reek/exceptions.reek", "lib/reek/if_context.rb", "lib/reek/method_context.rb", "lib/reek/module_context.rb", "lib/reek/name.rb", "lib/reek/object_refs.rb", "lib/reek/options.rb", "lib/reek/rake_task.rb", "lib/reek/report.rb", "lib/reek/sexp_formatter.rb", "lib/reek/singleton_method_context.rb", "lib/reek/smell_warning.rb", "lib/reek/smells/control_couple.rb", "lib/reek/smells/duplication.rb", "lib/reek/smells/feature_envy.rb", "lib/reek/smells/large_class.rb", "lib/reek/smells/long_method.rb", "lib/reek/smells/long_parameter_list.rb", "lib/reek/smells/long_yield_list.rb", "lib/reek/smells/nested_iterators.rb", "lib/reek/smells/smell_detector.rb", "lib/reek/smells/smells.rb", "lib/reek/smells/uncommunicative_name.rb", "lib/reek/smells/utility_function.rb", "lib/reek/source.rb", "lib/reek/spec.rb", "lib/reek/stop_context.rb", "lib/reek/yield_call_context.rb", "reek.gemspec", "spec/integration/reek_source_spec.rb", "spec/integration/script_spec.rb", "spec/reek/class_context_spec.rb", "spec/reek/code_context_spec.rb", "spec/reek/code_parser_spec.rb", "spec/reek/config_spec.rb", "spec/reek/if_context_spec.rb", "spec/reek/method_context_spec.rb", "spec/reek/module_context_spec.rb", "spec/reek/object_refs_spec.rb", "spec/reek/options_spec.rb", "spec/reek/report_spec.rb", "spec/reek/sexp_formatter_spec.rb", "spec/reek/singleton_method_context_spec.rb", "spec/reek/smells/control_couple_spec.rb", "spec/reek/smells/duplication_spec.rb", "spec/reek/smells/feature_envy_spec.rb", "spec/reek/smells/large_class_spec.rb", "spec/reek/smells/long_method_spec.rb", "spec/reek/smells/long_parameter_list_spec.rb", "spec/reek/smells/nested_iterators_spec.rb", "spec/reek/smells/smell_spec.rb", "spec/reek/smells/uncommunicative_name_spec.rb", "spec/reek/smells/utility_function_spec.rb", "spec/samples/inline.rb", "spec/samples/inline_spec.rb", "spec/samples/optparse.rb", "spec/samples/optparse_spec.rb", "spec/samples/redcloth.rb", "spec/samples/redcloth_spec.rb", "spec/spec.opts", "spec/spec_helper.rb", "tasks/reek.rake", "tasks/rspec.rake"]
-  s.has_rdoc = true
+  s.files = ["History.txt", "README.txt", "Rakefile", "bin/reek", "config/defaults.reek", "lib/reek.rb", "lib/reek/block_context.rb", "lib/reek/class_context.rb", "lib/reek/code_context.rb", "lib/reek/code_parser.rb", "lib/reek/exceptions.reek", "lib/reek/if_context.rb", "lib/reek/method_context.rb", "lib/reek/module_context.rb", "lib/reek/name.rb", "lib/reek/object_refs.rb", "lib/reek/object_source.rb", "lib/reek/options.rb", "lib/reek/rake_task.rb", "lib/reek/report.rb", "lib/reek/sexp_formatter.rb", "lib/reek/singleton_method_context.rb", "lib/reek/smell_warning.rb", "lib/reek/smells/control_couple.rb", "lib/reek/smells/duplication.rb", "lib/reek/smells/feature_envy.rb", "lib/reek/smells/large_class.rb", "lib/reek/smells/long_method.rb", "lib/reek/smells/long_parameter_list.rb", "lib/reek/smells/long_yield_list.rb", "lib/reek/smells/nested_iterators.rb", "lib/reek/smells/smell_detector.rb", "lib/reek/smells/smells.rb", "lib/reek/smells/uncommunicative_name.rb", "lib/reek/smells/utility_function.rb", "lib/reek/source.rb", "lib/reek/spec.rb", "lib/reek/stop_context.rb", "lib/reek/yield_call_context.rb", "reek.gemspec", "spec/reek/block_context_spec.rb", "spec/reek/class_context_spec.rb", "spec/reek/code_context_spec.rb", "spec/reek/code_parser_spec.rb", "spec/reek/config_spec.rb", "spec/reek/if_context_spec.rb", "spec/reek/method_context_spec.rb", "spec/reek/module_context_spec.rb", "spec/reek/name_spec.rb", "spec/reek/object_refs_spec.rb", "spec/reek/options_spec.rb", "spec/reek/report_spec.rb", "spec/reek/singleton_method_context_spec.rb", "spec/reek/smells/control_couple_spec.rb", "spec/reek/smells/duplication_spec.rb", "spec/reek/smells/feature_envy_spec.rb", "spec/reek/smells/large_class_spec.rb", "spec/reek/smells/long_method_spec.rb", "spec/reek/smells/long_parameter_list_spec.rb", "spec/reek/smells/nested_iterators_spec.rb", "spec/reek/smells/smell_spec.rb", "spec/reek/smells/uncommunicative_name_spec.rb", "spec/reek/smells/utility_function_spec.rb", "spec/slow/inline_spec.rb", "spec/slow/optparse_spec.rb", "spec/slow/redcloth_spec.rb", "spec/slow/reek_source_spec.rb", "spec/slow/samples/inline.rb", "spec/slow/samples/optparse.rb", "spec/slow/samples/redcloth.rb", "spec/slow/script_spec.rb", "spec/slow/source_list_spec.rb", "spec/spec.opts", "spec/spec_helper.rb", "tasks/reek.rake", "tasks/rspec.rake"]
   s.homepage = %q{http://wiki.github.com/kevinrutherford/reek}
   s.post_install_message = %q{
 For more information on reek, see http://wiki.github.com/kevinrutherford/reek
@@ -21,22 +20,25 @@ For more information on reek, see http://wiki.github.com/kevinrutherford/reek
   s.rdoc_options = ["--main", "README.txt"]
   s.require_paths = ["lib"]
   s.rubyforge_project = %q{reek}
-  s.rubygems_version = %q{1.3.1}
+  s.rubygems_version = %q{1.3.3}
   s.summary = %q{Code smell detector for Ruby}
 
   if s.respond_to? :specification_version then
     current_version = Gem::Specification::CURRENT_SPECIFICATION_VERSION
-    s.specification_version = 2
+    s.specification_version = 3
 
     if Gem::Version.new(Gem::RubyGemsVersion) >= Gem::Version.new('1.2.0') then
-      s.add_runtime_dependency(%q<ParseTree>, ["~> 3.0"])
+      s.add_runtime_dependency(%q<ruby_parser>, ["~> 2.0"])
+      s.add_runtime_dependency(%q<ruby2ruby>, ["~> 1.2"])
       s.add_runtime_dependency(%q<sexp_processor>, ["~> 3.0"])
     else
-      s.add_dependency(%q<ParseTree>, ["~> 3.0"])
+      s.add_dependency(%q<ruby_parser>, ["~> 2.0"])
+      s.add_dependency(%q<ruby2ruby>, ["~> 1.2"])
       s.add_dependency(%q<sexp_processor>, ["~> 3.0"])
     end
   else
-    s.add_dependency(%q<ParseTree>, ["~> 3.0"])
+    s.add_dependency(%q<ruby_parser>, ["~> 2.0"])
+    s.add_dependency(%q<ruby2ruby>, ["~> 1.2"])
     s.add_dependency(%q<sexp_processor>, ["~> 3.0"])
   end
 end