kevinrutherford-reek 1.1.3.1 → 1.1.3.2

data/History.txt

@@ -3,6 +3,7 @@
 === Minor Changes
 * LongMethod now counts statements deeper into each method (#25)
 * LongMethod no longer counts control structures, only their contained stmts
+* LargeClass is disabled when checking in-memory classes
 
 == 1.1.3 2009-05-19
 

data/lib/reek/code_parser.rb

@@ -54,10 +54,12 @@ module Reek
     end
 
     def process_class(exp)
-      push(ClassContext.create(@element, exp)) do
+      scope = ClassContext.create(@element, exp)
+      push(scope) do
         process_default(exp) unless @element.is_struct?
         check_smells(:class)
       end
+      scope
     end
 
     def process_defn(exp)

data/lib/reek/object_source.rb

@@ -20,6 +20,11 @@ module Reek
       return unifier.process(sexp[0])
     end
 
+    def initialize(code, desc)     # :nodoc:
+      super
+      @cf.disable('LargeClass')
+    end
+
     def can_parse_objects?
       return true if Object.const_defined?(:ParseTree)
       begin

data/lib/reek/smells/smells.rb

@@ -77,5 +77,9 @@ module Reek
       return [] if path == parent
       all_reekfiles(parent) + Dir["#{path}/*.reek"]
     end
+
+    def disable(smell)
+      @config[smell].adopt!({'enabled' => false})
+    end
   end
 end

data/lib/reek.rb

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

data/reek.gemspec

@@ -2,11 +2,11 @@
 
 Gem::Specification.new do |s|
   s.name = %q{reek}
-  s.version = "1.1.3.1"
+  s.version = "1.1.3.2"
 
   s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
   s.authors = ["Kevin Rutherford"]
-  s.date = %q{2009-06-04}
+  s.date = %q{2009-06-13}
   s.default_executable = %q{reek}
   s.description = %q{Code smell detector for Ruby}
   s.email = ["kevin@rutherford-software.com"]

data/spec/reek/smells/large_class_spec.rb

@@ -6,9 +6,9 @@ require 'reek/smells/large_class'
 include Reek
 include Reek::Smells
 
-describe LargeClass do
+describe LargeClass, 'checking Class objects' do
 
-  it 'should report large class' do
+  it 'should not report class with 26 methods' do
     class BigOne
       26.times do |i|
         define_method "method#{i}".to_sym do
@@ -16,11 +16,8 @@ describe LargeClass do
         end
       end
     end
-    BigOne.should reek_only_of(:LargeClass, /BigOne/)
+    BigOne.should_not reek
   end
-end
-
-describe LargeClass do
 
   it 'should not report short class' do
     class ShortClass
@@ -33,6 +30,26 @@ describe LargeClass do
     end
     ShortClass.should_not reek
   end
+
+  describe LargeClass, 'counting instance variables' do
+    it 'should not report class with 10 ivars' do
+      class ManyIvars
+        def method
+          @vara = @varb = @varc = @vard = @vare
+          @varf = @varg = @varh = @vari = @varj
+        end
+      end
+      ManyIvars.should_not reek
+    end
+
+    it 'ignores class with only a couple of ivars' do
+      LargeClass.should_not reek_of(:LargeClass)
+    end
+
+    it 'ignores fq class with only a couple of ivars' do
+      Reek::Smells::LargeClass.should_not reek_of(:LargeClass)
+    end
+  end
 end
 
 describe LargeClass, 'when exceptions are listed' do
@@ -66,22 +83,81 @@ describe LargeClass, 'when exceptions are listed' do
   end
 end
 
-describe LargeClass, 'counting instance variables' do
-  it 'warns about class with 10 ivars' do
-    class ManyIvars
-      def method
-        @vara = @varb = @varc = @vard = @vare
-        @varf = @varg = @varh = @vari = @varj
-      end
-    end
-    ManyIvars.should reek_of(:LargeClass, /10/)
+describe LargeClass, 'checking source code' do
+
+  def process_class(src)
+    source = Source.from_s(src)
+    CodeParser.new(nil, {}).process_class(source.generate_syntax_tree)
   end
 
-  it 'ignores class with only a couple of ivars' do
-    LargeClass.should_not reek_of(:LargeClass)
+  describe 'counting instance variables' do
+    it 'should not report empty class' do
+      process_class('class Empty;end').variable_names.length.should == 0
+    end
+
+    it 'should count ivars in one method' do
+      process_class('class Empty;def ivars() @aa=@ab=@ac=@ad; end;end').variable_names.length.should == 4
+    end
+
+    it 'should count ivars in 2 methods' do
+      process_class('class Empty;def iv1() @aa=@ab; end;def iv2() @aa=@ac; end;end').variable_names.length.should == 3
+    end
+
+    it 'should not report 9 ivars' do
+      'class Empty;def ivars() @aa=@ab=@ac=@ad=@ae=@af=@ag=@ah=@ai; end;end'.should_not reek
+    end
+
+    it 'should report 10 ivars' do
+      'class Empty;def ivars() @aa=@ab=@ac=@ad=@ae=@af=@ag=@ah=@ai=@aj; end;end'.should reek_of(:LargeClass)
+    end
+
+    it 'should not report 10 ivars in 2 extensions' do
+      src = <<EOS
+class Full;def ivars1() @aa=@ab=@ac=@ad=@ae; end;end
+class Full;def ivars2() @af=@ag=@ah=@ai=@aj; end;end
+EOS
+      src.should_not reek
+    end
   end
 
-  it 'ignores fq class with only a couple of ivars' do
-    Reek::Smells::LargeClass.should_not reek_of(:LargeClass)
+  describe 'counting methods' do
+    it 'should not report empty class' do
+      process_class('class Empty;end').num_methods.should == 0
+    end
+
+    it 'should count 1 method' do
+      process_class('class Empty;def ivars() @aa=@ab; end;end').num_methods.should == 1
+    end
+
+    it 'should count 2 methods' do
+      process_class('class Empty;def meth1() @aa=@ab;end;def meth2() @aa=@ab;end;end').num_methods.should == 2
+    end
+
+    it 'should not report 25 methods' do
+      src = <<EOS
+class Full
+  def me01()3 end;def me02()3 end;def me03()3 end;def me04()3 end;def me05()3 end
+  def me11()3 end;def me12()3 end;def me13()3 end;def me14()3 end;def me15()3 end
+  def me21()3 end;def me22()3 end;def me23()3 end;def me24()3 end;def me25()3 end
+  def me31()3 end;def me32()3 end;def me33()3 end;def me34()3 end;def me35()3 end
+  def me41()3 end;def me42()3 end;def me43()3 end;def me44()3 end;def me45()3 end
+end
+EOS
+      src.should_not reek
+    end
+
+    it 'should report 26 methods' do
+      src = <<EOS
+class Full
+  def me01()3 end;def me02()3 end;def me03()3 end;def me04()3 end;def me05()3 end
+  def me11()3 end;def me12()3 end;def me13()3 end;def me14()3 end;def me15()3 end
+  def me21()3 end;def me22()3 end;def me23()3 end;def me24()3 end;def me25()3 end
+  def me31()3 end;def me32()3 end;def me33()3 end;def me34()3 end;def me35()3 end
+  def me41()3 end;def me42()3 end;def me43()3 end;def me44()3 end;def me45()3 end
+  def me51()3 end
+end
+EOS
+      src.should reek_of(:LargeClass)
+    end
   end
 end

data/spec/reek/smells/long_method_spec.rb

@@ -7,6 +7,11 @@ require 'reek/smells/long_method'
 include Reek
 include Reek::Smells
 
+def process_method(src)
+  source = Source.from_s(src)
+  CodeParser.new(nil, {}).process_defn(source.generate_syntax_tree)
+end
+
 describe LongMethod do
   it 'should not report short methods' do
     'def short(arga) alf = f(1);@bet = 2;@cut = 3;@dit = 4; @emp = 5;end'.should_not reek
@@ -62,151 +67,109 @@ end
 
 describe LongMethod do
   it 'counts 1 assignment' do
-    src = 'def one() val = 4; end'
-    source = Source.from_s(src)
-    method = CodeParser.new(nil, {}).process_defn(source.generate_syntax_tree)
+    method = process_method('def one() val = 4; end')
     method.num_statements.should == 1
   end
 
   it 'counts 3 assignments' do
-    src = 'def one() val = 4; val = 4; val = 4; end'
-    source = Source.from_s(src)
-    method = CodeParser.new(nil, {}).process_defn(source.generate_syntax_tree)
+    method = process_method('def one() val = 4; val = 4; val = 4; end')
     method.num_statements.should == 3
   end
 
   it 'counts 1 attr assignment' do
-    src = 'def one() val[0] = 4; end'
-    source = Source.from_s(src)
-    method = CodeParser.new(nil, {}).process_defn(source.generate_syntax_tree)
+    method = process_method('def one() val[0] = 4; end')
     method.num_statements.should == 1
   end
 
   it 'counts 1 increment assignment' do
-    src = 'def one() val += 4; end'
-    source = Source.from_s(src)
-    method = CodeParser.new(nil, {}).process_defn(source.generate_syntax_tree)
+    method = process_method('def one() val += 4; end')
     method.num_statements.should == 1
   end
 
   it 'counts 1 increment attr assignment' do
-    src = 'def one() val[0] += 4; end'
-    source = Source.from_s(src)
-    method = CodeParser.new(nil, {}).process_defn(source.generate_syntax_tree)
+    method = process_method('def one() val[0] += 4; end')
     method.num_statements.should == 1
   end
 
   it 'counts 1 nested assignment' do
-    src = 'def one() val = fred = 4; end'
-    source = Source.from_s(src)
-    method = CodeParser.new(nil, {}).process_defn(source.generate_syntax_tree)
+    method = process_method('def one() val = fred = 4; end')
     method.num_statements.should == 1
   end
 
   it 'counts returns' do
-    src = 'def one() val = 4; true; end'
-    source = Source.from_s(src)
-    method = CodeParser.new(nil, {}).process_defn(source.generate_syntax_tree)
+    method = process_method('def one() val = 4; true; end')
     method.num_statements.should == 2
   end
 end
 
 describe LongMethod, 'does not count control statements' do
   it 'counts 1 statement in a conditional expression' do
-    src = 'def one() if val == 4; callee(); end; end'
-    source = Source.from_s(src)
-    method = CodeParser.new(nil, {}).process_defn(source.generate_syntax_tree)
+    method = process_method('def one() if val == 4; callee(); end; end')
     method.num_statements.should == 1
   end
 
   it 'counts 3 statements in a conditional expression' do
-    src = 'def one() if val == 4; callee(); callee(); callee(); end; end'
-    source = Source.from_s(src)
-    method = CodeParser.new(nil, {}).process_defn(source.generate_syntax_tree)
+    method = process_method('def one() if val == 4; callee(); callee(); callee(); end; end')
     method.num_statements.should == 3
   end
 
   it 'does not count empty conditional expression' do
-    src = 'def one() if val == 4; ; end; end'
-    source = Source.from_s(src)
-    method = CodeParser.new(nil, {}).process_defn(source.generate_syntax_tree)
+    method = process_method('def one() if val == 4; ; end; end')
     method.num_statements.should == 0
   end
 
   it 'counts 1 statement in a while loop' do
-    src = 'def one() while val < 4; callee(); end; end'
-    source = Source.from_s(src)
-    method = CodeParser.new(nil, {}).process_defn(source.generate_syntax_tree)
+    method = process_method('def one() while val < 4; callee(); end; end')
     method.num_statements.should == 1
   end
 
   it 'counts 3 statements in a while loop' do
-    src = 'def one() while val < 4; callee(); callee(); callee(); end; end'
-    source = Source.from_s(src)
-    method = CodeParser.new(nil, {}).process_defn(source.generate_syntax_tree)
+    method = process_method('def one() while val < 4; callee(); callee(); callee(); end; end')
     method.num_statements.should == 3
   end
 
   it 'counts 1 statement in a until loop' do
-    src = 'def one() until val < 4; callee(); end; end'
-    source = Source.from_s(src)
-    method = CodeParser.new(nil, {}).process_defn(source.generate_syntax_tree)
+    method = process_method('def one() until val < 4; callee(); end; end')
     method.num_statements.should == 1
   end
 
   it 'counts 3 statements in a until loop' do
-    src = 'def one() until val < 4; callee(); callee(); callee(); end; end'
-    source = Source.from_s(src)
-    method = CodeParser.new(nil, {}).process_defn(source.generate_syntax_tree)
+    method = process_method('def one() until val < 4; callee(); callee(); callee(); end; end')
     method.num_statements.should == 3
   end
 
   it 'counts 1 statement in a for loop' do
-    src = 'def one() for i in 0..4; callee(); end; end'
-    source = Source.from_s(src)
-    method = CodeParser.new(nil, {}).process_defn(source.generate_syntax_tree)
+    method = process_method('def one() for i in 0..4; callee(); end; end')
     method.num_statements.should == 1
   end
 
   it 'counts 3 statements in a for loop' do
-    src = 'def one() for i in 0..4; callee(); callee(); callee(); end; end'
-    source = Source.from_s(src)
-    method = CodeParser.new(nil, {}).process_defn(source.generate_syntax_tree)
+    method = process_method('def one() for i in 0..4; callee(); callee(); callee(); end; end')
     method.num_statements.should == 3
   end
 
   it 'counts 1 statement in a rescue' do
-    src = 'def one() begin; callee(); rescue; callee(); end; end'
-    source = Source.from_s(src)
-    method = CodeParser.new(nil, {}).process_defn(source.generate_syntax_tree)
+    method = process_method('def one() begin; callee(); rescue; callee(); end; end')
     method.num_statements.should == 2
   end
 
   it 'counts 3 statements in a rescue' do
-    src = 'def one() begin; callee(); callee(); callee(); rescue; callee(); callee(); callee(); end; end'
-    source = Source.from_s(src)
-    method = CodeParser.new(nil, {}).process_defn(source.generate_syntax_tree)
+    method = process_method('def one() begin; callee(); callee(); callee(); rescue; callee(); callee(); callee(); end; end')
     method.num_statements.should == 6
   end
 
   it 'counts 1 statement in a when' do
-    src = 'def one() case fred; when "hi"; callee(); end; end'
-    source = Source.from_s(src)
-    method = CodeParser.new(nil, {}).process_defn(source.generate_syntax_tree)
+    method = process_method('def one() case fred; when "hi"; callee(); end; end')
     method.num_statements.should == 1
   end
 
   it 'counts 3 statements in a when' do
-    src = 'def one() case fred; when "hi"; callee(); callee(); when "lo"; callee(); end; end'
-    source = Source.from_s(src)
-    method = CodeParser.new(nil, {}).process_defn(source.generate_syntax_tree)
+    method = process_method('def one() case fred; when "hi"; callee(); callee(); when "lo"; callee(); end; end')
     method.num_statements.should == 3
   end
 
   it 'does not count empty case' do
-    src = 'def one() case fred; when "hi"; ; when "lo"; ; end; end'
-    source = Source.from_s(src)
-    method = CodeParser.new(nil, {}).process_defn(source.generate_syntax_tree)
+    method = process_method('def one() case fred; when "hi"; ; when "lo"; ; end; end')
     method.num_statements.should == 0
   end
 
@@ -226,8 +189,7 @@ def parse(arg, argv, &error)
   val
 end
 EOS
-    source = Source.from_s(src)
-    method = CodeParser.new(nil, {}).process_defn(source.generate_syntax_tree)
+    method = process_method(src)
     method.num_statements.should == 6
   end
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification 
 name: kevinrutherford-reek
 version: !ruby/object:Gem::Version 
-  version: 1.1.3.1
+  version: 1.1.3.2
 platform: ruby
 authors: 
 - Kevin Rutherford
@@ -9,7 +9,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2009-06-04 00:00:00 -07:00
+date: 2009-06-13 00:00:00 -07:00
 default_executable: reek
 dependencies: 
 - !ruby/object:Gem::Dependency