kevinrutherford-reek 1.0.1 → 1.1.1

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,6 +31,7 @@ module Reek
       def self.default_config
         super.adopt(
           MAX_ALLOWED_METHODS_KEY => 25,
+          MAX_ALLOWED_IVARS_KEY => 9,
           EXCLUDE_KEY => ['Array', 'Hash', 'Module', 'String']
           )
       end
@@ -33,17 +39,30 @@ module Reek
       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

@@ -12,6 +12,14 @@ module Reek
   #
   class Source
 
+    #
+    # Factory method: creates a +Source+ from obj.
+    # The code is not parsed until +report+ is called.
+    #
+    def self.from_object(obj)
+      return ObjectSource.new(obj, obj.to_s)
+    end
+
     #
     # Factory method: creates a +Source+ object by reading Ruby code from
     # the +IO+ stream. The stream is consumed upto end-of-file, but the
@@ -57,10 +65,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 check(parser) # :nodoc:
+      parser.check_source(@source)
     end
 
     #
@@ -71,8 +84,7 @@ module Reek
     def report
       unless @report
         @report = Report.new
-        smells = SmellConfig.new.load_local(@dir).smell_listeners
-        CodeParser.new(@report, smells).check_source(@source)
+        check(CodeParser.new(@report, @cf.smell_listeners))
       end
       @report
     end
@@ -89,6 +101,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
@@ -110,4 +128,13 @@ module Reek
       ReportList.new(@sources)
     end
   end
+
+  #
+  # Represents an in-memory object that will be checked for smells.
+  #
+  class ObjectSource < Source
+    def check(parser) # :nodoc:
+      parser.check_object(@source)
+    end
+  end
 end

data/lib/reek/spec.rb

@@ -113,6 +113,12 @@ module Reek
   end
 end
 
+class Object
+  def to_source
+    Reek::Source.from_object(self)
+  end
+end
+
 class File
   def to_source
     Reek::Source.from_f(self)

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,17 +2,17 @@
 
 Gem::Specification.new do |s|
   s.name = %q{reek}
-  s.version = "1.0.1"
+  s.version = "1.1.1"
 
   s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
   s.authors = ["Kevin Rutherford"]
-  s.date = %q{2009-04-06}
+  s.date = %q{2009-05-08}
   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/reek/source_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.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/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/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/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.has_rdoc = true
   s.homepage = %q{http://wiki.github.com/kevinrutherford/reek}
   s.post_install_message = %q{
@@ -21,22 +21,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.2}
   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<ruby2ruby>, ["~> 1.2"])
       s.add_runtime_dependency(%q<sexp_processor>, ["~> 3.0"])
     else
       s.add_dependency(%q<ParseTree>, ["~> 3.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<ruby2ruby>, ["~> 1.2"])
     s.add_dependency(%q<sexp_processor>, ["~> 3.0"])
   end
 end

data/spec/reek/block_context_spec.rb

@@ -0,0 +1,40 @@
+require File.dirname(__FILE__) + '/../spec_helper.rb'
+
+require 'reek/block_context'
+require 'reek/method_context'
+
+include Reek
+
+describe BlockContext do
+
+  it "should record single parameter" do
+    element = StopContext.new
+    element = BlockContext.new(element, s(s(:lasgn, :x), nil))
+    element.variable_names.should == [Name.new(:x)]
+  end
+
+  it "should record single parameter within a method" do
+    element = StopContext.new
+    element = MethodContext.new(element, s(:defn, :help))
+    element = BlockContext.new(element, s(s(:lasgn, :x), nil))
+    element.variable_names.should == [Name.new(:x)]
+  end
+
+  it "records multiple parameters" do
+    element = StopContext.new
+    element = BlockContext.new(element, s(s(:masgn, s(:array, s(:lasgn, :x), s(:lasgn, :y))), nil))
+    element.variable_names.should == [Name.new(:x), Name.new(:y)]
+  end
+
+  it "should not pass parameters upward" do
+    mc = MethodContext.new(StopContext.new, s(:defn, :help))
+    element = BlockContext.new(mc, s(s(:lasgn, :x)))
+    mc.variable_names.should be_empty
+  end
+
+  it 'records local variables' do
+    bctx = BlockContext.new(StopContext.new, nil)
+    bctx.record_local_variable(:q2)
+    bctx.variable_names.should include(Name.new(:q2))
+  end
+end

data/spec/reek/class_context_spec.rb

@@ -196,3 +196,14 @@ describe CodeContext, 'find class' do
     end
   end
 end
+
+describe ClassContext do
+  it 'should not report empty class in another module' do
+    'class Treetop::Runtime::SyntaxNode; end'.should_not reek
+  end
+
+  it 'should deal with :: scoped names' do
+    element = ClassContext.create(StopContext.new, [:colon2, [:colon2, [:const, :Treetop], :Runtime], :SyntaxNode])
+    element.num_methods.should == 0
+  end
+end

data/spec/reek/code_context_spec.rb

@@ -45,7 +45,8 @@ describe CodeContext, 'instance variables' do
     element = MethodContext.new(class_element, [0, :bad])
     element = BlockContext.new(element, nil)
     element.record_instance_variable(:fred)
-    class_element.variable_names.should == [Name.new(:fred)]
+    class_element.variable_names.size.should == 1
+    class_element.variable_names.should include(Name.new(:fred))
   end
 end
 

data/spec/reek/code_parser_spec.rb

@@ -20,16 +20,6 @@ describe CodeParser, 'with a global method definition' do
   end
 end
 
-describe CodeParser, 'when given a C extension' do
-  before(:each) do
-    @cchk = CodeParser.new(Report.new, SmellConfig.new.smell_listeners)
-  end
-
-  it 'should ignore :cfunc' do
-    @cchk.check_object(Enumerable)
-  end
-end
-
 describe CodeParser, 'when a yield is the receiver' do
   it 'should report no problems' do
     source = 'def values(*args)

data/spec/reek/config_spec.rb

@@ -17,7 +17,7 @@ describe 'Config' do
     other = Hash.new {|hash,key| hash[key] = {} }
     other['one']['gunk'] = 45
     other['two']['four'] = false
-    @first.value_merge!(other).to_yaml
+    other.push_keys(@first)
     @first['two']['four'].should == false
     @first['one'].keys.length.should == 3
   end
@@ -36,7 +36,7 @@ describe Config, 'merging arrays' do
   it 'should merge array values' do
     first = {'key' => {'one' => [1,2,3]}}
     second = {'key' => {'one' => [4,5]}}
-    first.value_merge!(second)
+    second.push_keys(first)
     first['key']['one'].should == [1,2,3,4,5]
   end
 end

data/spec/reek/method_context_spec.rb

@@ -49,4 +49,18 @@ describe MethodContext do
     mctx.record_call_to([:call, [:ivar, :@cow], :feed_to])
     mctx.envious_receivers.should == []
   end
+
+  it 'should count calls to self' do
+    mctx = MethodContext.new(StopContext.new, [:defn, :equals])
+    mctx.refs.record_ref([:lvar, :other])
+    mctx.record_call_to([:call, [:self], :thing])
+    mctx.envious_receivers.should be_empty
+  end
+
+  it 'should recognise a call on self' do
+    mc = MethodContext.new(StopContext.new, s(:defn, :deep))
+    mc.record_call_to(s(:call, s(:lvar, :text), :each, s(:arglist)))
+    mc.record_call_to(s(:call, nil, :shelve, s(:arglist)))
+    mc.envious_receivers.should be_empty
+  end
 end

data/spec/reek/name_spec.rb

@@ -0,0 +1,13 @@
+require File.dirname(__FILE__) + '/../spec_helper.rb'
+require 'reek/name'
+
+include Reek
+
+describe Name, 'resolving symbols' do
+  it 'finds fq loaded class' do
+    exp = [:class, :"Reek::Smells::LargeClass", nil]
+    ctx = StopContext.new
+    res = Name.resolve(exp[1], ctx)
+    res[1].should == "LargeClass"
+  end
+end

data/spec/reek/object_refs_spec.rb

@@ -9,8 +9,8 @@ describe ObjectRefs, 'when empty' do
     @refs = ObjectRefs.new
   end
 
-  it 'should report one ref to self' do
-    @refs.refs_to_self.should == 1
+  it 'should report no refs to self' do
+    @refs.refs_to_self.should == 0
   end
 end
 
@@ -23,7 +23,7 @@ describe ObjectRefs, 'with no refs to self' do
   end
 
   it 'should report no refs to self' do
-    @refs.refs_to_self.should == 1
+    @refs.refs_to_self.should == 0
   end
 
   it 'should report :a as the max' do
@@ -45,16 +45,16 @@ describe ObjectRefs, 'with one ref to self' do
   end
 
   it 'should report 1 ref to self' do
-    @refs.refs_to_self.should == 2
+    @refs.refs_to_self.should == 1
   end
 
-  it 'should report self among the max' do
+  it 'should not report self among the max' do
     @refs.max_keys.should be_include('a')
-    @refs.max_keys.should be_include(Sexp.from_array([:lit, :self]))
+    @refs.max_keys.should_not include(Sexp.from_array([:lit, :self]))
   end
 
-  it 'should report self as the max' do
-    @refs.self_is_max?.should == true
+  it 'should not report self as the max' do
+    @refs.self_is_max?.should == false
   end
 end
 
@@ -62,6 +62,7 @@ describe ObjectRefs, 'with many refs to self' do
   before(:each) do
     @refs = ObjectRefs.new
     @refs.record_reference_to_self
+    @refs.record_reference_to_self
     @refs.record_ref('a')
     @refs.record_reference_to_self
     @refs.record_ref('b')
@@ -87,6 +88,7 @@ describe ObjectRefs, 'when self is not the only max' do
     @refs = ObjectRefs.new
     @refs.record_ref('a')
     @refs.record_reference_to_self
+    @refs.record_reference_to_self
     @refs.record_ref('b')
     @refs.record_ref('a')
   end
@@ -115,7 +117,7 @@ describe ObjectRefs, 'when self is not among the max' do
   end
 
   it 'should report all refs to self' do
-    @refs.refs_to_self.should == 1
+    @refs.refs_to_self.should == 0
   end
 
   it 'should not report self among the max' do