simplabs-excellent 1.0.1 → 1.2.1

data/spec/checks/assignment_in_conditional_check_spec.rb

@@ -3,18 +3,35 @@ require File.expand_path(File.dirname(__FILE__) + '/../spec_helper')
 describe Simplabs::Excellent::Checks::AssignmentInConditionalCheck do
 
   before do
-    @excellent = Simplabs::Excellent::Core::ParseTreeRunner.new(Simplabs::Excellent::Checks::AssignmentInConditionalCheck.new)
+    @excellent = Simplabs::Excellent::Runner.new(Simplabs::Excellent::Checks::AssignmentInConditionalCheck.new)
   end
 
   describe '#evaluate' do
 
     it 'should accept an assignment before an if clause' do
       content = <<-END
-        count = count += 1 if some_condition
+        count = count += 1 if @some_condition
       END
       @excellent.check_content(content)
 
-      @excellent.errors.should be_empty
+      @excellent.warnings.should be_empty
+    end
+
+    it 'should accept block parameters in an if clause' do
+      content = <<-END
+        return true if exp.children.any? { |child| contains_statements?(child) }
+      END
+      @excellent.check_content(content)
+
+      @excellent.warnings.should be_empty
+    end
+
+    it 'should reject assignments of results of blocks in an if clause' do
+      content = <<-END
+        return true if value = exp.children.find { |child| contains_statements?(child) }
+      END
+
+      verify_warning_found(content)
     end
 
     it 'should reject an assignment inside an if clause' do
@@ -22,7 +39,7 @@ describe Simplabs::Excellent::Checks::AssignmentInConditionalCheck do
         call_foo if bar = bam
       END
 
-      verify_error_found(content)
+      verify_warning_found(content)
     end
 
     it 'should reject an assignment inside an unless clause' do
@@ -30,7 +47,7 @@ describe Simplabs::Excellent::Checks::AssignmentInConditionalCheck do
         call_foo unless bar = bam
       END
 
-      verify_error_found(content)
+      verify_warning_found(content)
     end
 
     it 'should reject an assignment inside a while clause' do
@@ -38,7 +55,7 @@ describe Simplabs::Excellent::Checks::AssignmentInConditionalCheck do
         call_foo while bar = bam
       END
 
-      verify_error_found(content)
+      verify_warning_found(content)
     end
 
     it 'should reject an assignment inside an until clause' do
@@ -46,7 +63,7 @@ describe Simplabs::Excellent::Checks::AssignmentInConditionalCheck do
         call_foo until bar = bam
       END
 
-      verify_error_found(content)
+      verify_warning_found(content)
     end
 
     it 'should reject an assignment inside a ternary operator check clause' do
@@ -55,19 +72,19 @@ describe Simplabs::Excellent::Checks::AssignmentInConditionalCheck do
       END
 
       #RubyParser sets line number 2 here
-      verify_error_found(content, 2)
+      verify_warning_found(content, 2)
     end
 
   end
 
-  def verify_error_found(content, line_number = nil)
+  def verify_warning_found(content, line_number = nil)
     @excellent.check_content(content)
-    errors = @excellent.errors
+    warnings = @excellent.warnings
 
-    errors.should_not be_empty
-    errors[0].info.should        == {}
-    errors[0].line_number.should == (line_number || 1)
-    errors[0].message.should     == 'Assignment in condition.'
+    warnings.should_not be_empty
+    warnings[0].info.should        == {}
+    warnings[0].line_number.should == (line_number || 1)
+    warnings[0].message.should     == 'Assignment in condition.'
   end
 
 end

data/spec/checks/case_missing_else_check_spec.rb

@@ -3,7 +3,7 @@ require File.expand_path(File.dirname(__FILE__) + '/../spec_helper')
 describe Simplabs::Excellent::Checks::CaseMissingElseCheck do
 
   before do
-    @excellent = Simplabs::Excellent::Core::ParseTreeRunner.new(Simplabs::Excellent::Checks::CaseMissingElseCheck.new)
+    @excellent = Simplabs::Excellent::Runner.new(Simplabs::Excellent::Checks::CaseMissingElseCheck.new)
   end
 
   describe '#evaluate' do
@@ -16,9 +16,9 @@ describe Simplabs::Excellent::Checks::CaseMissingElseCheck do
           end
       END
       @excellent.check_content(content)
-      errors = @excellent.errors
+      warnings = @excellent.warnings
 
-      errors.should be_empty
+      warnings.should be_empty
     end
 
     it 'should reject case statements that do not have an else clause' do
@@ -29,12 +29,12 @@ describe Simplabs::Excellent::Checks::CaseMissingElseCheck do
           end
       END
       @excellent.check_content(content)
-      errors = @excellent.errors
+      warnings = @excellent.warnings
 
-      errors.should_not be_empty
-      errors[0].info.should        == {}
-      errors[0].line_number.should == 2
-      errors[0].message.should     == 'Case statement is missing else clause.'
+      warnings.should_not be_empty
+      warnings[0].info.should        == {}
+      warnings[0].line_number.should == 2
+      warnings[0].message.should     == 'Case statement is missing else clause.'
     end
 
   end

data/spec/checks/class_line_count_check_spec.rb

@@ -3,45 +3,58 @@ require File.expand_path(File.dirname(__FILE__) + '/../spec_helper')
 describe Simplabs::Excellent::Checks::ClassLineCountCheck do
 
   before do
-    @excellent = Simplabs::Excellent::Core::ParseTreeRunner.new(Simplabs::Excellent::Checks::ClassLineCountCheck.new({ :threshold => 1 }))
+    @excellent = Simplabs::Excellent::Runner.new(Simplabs::Excellent::Checks::ClassLineCountCheck.new({ :threshold => 3 }))
   end
 
   describe '#evaluate' do
 
     it 'should accept classes with less lines than the threshold' do
       content = <<-END
-        class ZeroLineClass; end
+        class OneLineClass; end
       END
       @excellent.check_content(content)
 
-      @excellent.errors.should be_empty
+      @excellent.warnings.should be_empty
     end
 
     it 'should accept classes with the same number of lines as the threshold' do
       content = <<-END
-        Class OneLineClass
+        class ThreeLineClass
           @foo = 1
         end
       END
       @excellent.check_content(content)
 
-      @excellent.errors.should be_empty
+      @excellent.warnings.should be_empty
+    end
+
+    it 'should not count blank lines' do
+      content = <<-END
+        class ThreeLineClass
+
+          @foo = 1
+
+        end
+      END
+      @excellent.check_content(content)
+
+      @excellent.warnings.should be_empty
     end
 
     it 'should reject classes with more lines than the threshold' do
       content = <<-END
-        class TwoLineClass
+        class FourLineClass
           @foo = 1
           @bar = 2
         end
       END
       @excellent.check_content(content)
-      errors = @excellent.errors
+      warnings = @excellent.warnings
 
-      errors.should_not be_empty
-      errors[0].info.should        == { :class => :TwoLineClass, :count => 2 }
-      errors[0].line_number.should == 1
-      errors[0].message.should     == 'Class TwoLineClass has 2 lines.'
+      warnings.should_not be_empty
+      warnings[0].info.should        == { :class => 'FourLineClass', :count => 4 }
+      warnings[0].line_number.should == 1
+      warnings[0].message.should     == 'FourLineClass has 4 lines.'
     end
 
   end

data/spec/checks/class_name_check_spec.rb

@@ -3,7 +3,7 @@ require File.expand_path(File.dirname(__FILE__) + '/../spec_helper')
 describe Simplabs::Excellent::Checks::ClassNameCheck do
 
   before(:each) do
-    @excellent = Simplabs::Excellent::Core::ParseTreeRunner.new(Simplabs::Excellent::Checks::ClassNameCheck.new)
+    @excellent = Simplabs::Excellent::Runner.new(Simplabs::Excellent::Checks::ClassNameCheck.new)
   end
 
   describe '#evaluate' do
@@ -14,19 +14,19 @@ describe Simplabs::Excellent::Checks::ClassNameCheck do
       END
       @excellent.check_content(content)
 
-      @excellent.errors.should be_empty
+      @excellent.warnings.should be_empty
     end
 
     it 'should be able to parse scoped class names' do
       content = <<-END
-        class MyScope::GoodClassName 
+        class Outer::Inner::GoodClassName 
           def method
           end
         end
       END
       @excellent.check_content(content)
 
-      @excellent.errors.should be_empty
+      @excellent.warnings.should be_empty
     end
 
     it 'should reject class names with underscores' do
@@ -35,12 +35,12 @@ describe Simplabs::Excellent::Checks::ClassNameCheck do
         end
       END
       @excellent.check_content(content)
-      errors = @excellent.errors
+      warnings = @excellent.warnings
 
-      errors.should_not be_empty
-      errors[0].info.should        == { :class => :Bad_ClassName }
-      errors[0].line_number.should == 1
-      errors[0].message.should     == 'Bad class name Bad_ClassName.'
+      warnings.should_not be_empty
+      warnings[0].info.should        == { :class => 'Bad_ClassName' }
+      warnings[0].line_number.should == 1
+      warnings[0].message.should     == 'Bad class name Bad_ClassName.'
     end
 
   end

data/spec/checks/control_coupling_check_spec.rb

@@ -3,30 +3,101 @@ require File.expand_path(File.dirname(__FILE__) + '/../spec_helper')
 describe Simplabs::Excellent::Checks::ControlCouplingCheck do
 
   before(:each) do
-    @excellent = Simplabs::Excellent::Core::ParseTreeRunner.new(Simplabs::Excellent::Checks::ControlCouplingCheck.new)
+    @excellent = Simplabs::Excellent::Runner.new(Simplabs::Excellent::Checks::ControlCouplingCheck.new)
   end
 
   describe '#evaluate' do
 
-    it 'should reject methods with if checks using a parameter' do
+    it 'should accept methods that just print out the parameter' do
       content = <<-END
-        def write(quoted, foo)
-          if quoted
-            write_quoted(@value)
-          else
-            puts @value
-          end
+        def write(quoted)
+          pp quoted
+        end
+      END
+      @excellent.check_content(content)
+      warnings = @excellent.warnings
+
+      warnings.should be_empty
+    end
+
+    it 'should accept methods with ternary operators using an instance variable' do
+      content = <<-END
+        def write(quoted)
+          @quoted ? write_quoted('1') : write_quoted('2')
+        end
+      END
+
+      @excellent.check_content(content)
+      warnings = @excellent.warnings
+
+      warnings.should be_empty
+    end
+
+    it 'should accept methods with ternary operators using a local variable' do
+      content = <<-END
+        def write(quoted)
+          test = false
+          test ? write_quoted('1') : write_quoted('2')
         end
       END
+
       @excellent.check_content(content)
-      errors = @excellent.errors
+      warnings = @excellent.warnings
 
-      errors.should_not be_empty
-      errors[0].info.should        == { :method => :write, :argument => :quoted }
-      errors[0].line_number.should == 2
-      errors[0].message.should     == 'Control of write is coupled to quoted.'
+      warnings.should be_empty
     end
 
+    %w(if unless).each do |conditional|
+
+      it "should reject methods with #{conditional} checks using a parameter" do
+        content = <<-END
+          def write(quoted)
+            #{conditional} quoted
+              write_quoted('test')
+            end
+          end
+        END
+
+        verify_warning_found(content)
+      end
+
+    end
+
+    it 'should reject methods with ternary operators using a parameter' do
+      content = <<-END
+        def write(quoted)
+          quoted ? write_quoted('1') : write_quoted('2')
+        end
+      END
+
+      verify_warning_found(content)
+    end
+
+    it "should reject methods with case statements using a parameter" do
+      content = <<-END
+        def write(quoted)
+          case quoted
+            when 1
+              write_quoted('1')
+            when 2
+              write_quoted('2')
+          end
+        end
+      END
+
+      verify_warning_found(content)
+    end
+
+  end
+
+  def verify_warning_found(content)
+    @excellent.check_content(content)
+    warnings = @excellent.warnings
+
+    warnings.should_not be_empty
+    warnings[0].info.should        == { :method => 'write', :argument => 'quoted' }
+    warnings[0].line_number.should == 1
+    warnings[0].message.should     == 'write is coupled to quoted.'
   end
 
 end

data/spec/checks/cyclomatic_complexity_block_check_spec.rb

@@ -3,17 +3,15 @@ require File.expand_path(File.dirname(__FILE__) + '/../spec_helper')
 describe Simplabs::Excellent::Checks::CyclomaticComplexityBlockCheck do
 
   before(:each) do
-    @excellent = Simplabs::Excellent::Core::ParseTreeRunner.new(Simplabs::Excellent::Checks::CyclomaticComplexityBlockCheck.new({ :threshold => 0 }))
+    @excellent = Simplabs::Excellent::Runner.new(Simplabs::Excellent::Checks::CyclomaticComplexityBlockCheck.new({ :threshold => 0 }))
   end
 
   describe '#evaluate' do
 
     it 'should find a simple block' do
       content = <<-END
-        def method_name
-          it 'should be a simple block' do
-            call_foo
-          end
+        it 'should be a simple block' do
+          call_foo
         end
       END
 
@@ -22,13 +20,11 @@ describe Simplabs::Excellent::Checks::CyclomaticComplexityBlockCheck do
 
     it 'should find a block with multiple paths' do
       content = <<-END
-        def method_name
-          it 'should be a complex block' do
-            if some_condition
-              call_foo
-            else
-              call_bar
-            end
+        it 'should be a complex block' do
+          if some_condition
+            call_foo
+          else
+            call_bar
           end
         end
       END
@@ -40,12 +36,12 @@ describe Simplabs::Excellent::Checks::CyclomaticComplexityBlockCheck do
 
   def verify_content_complexity(content, score)
     @excellent.check_content(content)
-    errors = @excellent.errors
+    warnings = @excellent.warnings
 
-    errors.should_not be_empty
-    errors[0].info.should        == { :score => score }
-    errors[0].line_number.should == 2
-    errors[0].message.should     == "Block has cyclomatic complexity of #{score}."
+    warnings.should_not be_empty
+    warnings[0].info.should        == { :block => 'block', :score => score }
+    warnings[0].line_number.should == 1
+    warnings[0].message.should     == "block has cyclomatic complexity of #{score}."
   end
 
 end

data/spec/checks/cyclomatic_complexity_method_check_spec.rb

@@ -3,7 +3,7 @@ require File.expand_path(File.dirname(__FILE__) + '/../spec_helper')
 describe Simplabs::Excellent::Checks::CyclomaticComplexityMethodCheck do
 
   before do
-    @excellent = Simplabs::Excellent::Core::ParseTreeRunner.new(Simplabs::Excellent::Checks::CyclomaticComplexityMethodCheck.new({ :threshold => 0 }))
+    @excellent = Simplabs::Excellent::Runner.new(Simplabs::Excellent::Checks::CyclomaticComplexityMethodCheck.new({ :threshold => 0 }))
   end
 
   describe '#evaluate' do
@@ -169,16 +169,42 @@ describe Simplabs::Excellent::Checks::CyclomaticComplexityMethodCheck do
       verify_content_complexity(content, 5)
     end
 
+    it 'should also work on singleton methods' do
+      content = <<-END
+        class Class
+          def self.method_name
+            if first_condition then
+              call_foo
+            else
+              if second_condition then
+                call_bar
+              else
+                call_bam if third_condition
+              end
+              call_baz if fourth_condition
+            end
+          end
+        end
+      END
+      @excellent.check_content(content)
+      warnings = @excellent.warnings
+
+      warnings.should_not be_empty
+      warnings[0].info.should        == { :method => 'Class.method_name', :score => 5 }
+      warnings[0].line_number.should == 2
+      warnings[0].message.should     == "Class.method_name has cyclomatic complexity of 5."
+    end
+
   end
 
   def verify_content_complexity(content, score)
     @excellent.check_content(content)
-    errors = @excellent.errors
+    warnings = @excellent.warnings
 
-    errors.should_not be_empty
-    errors[0].info.should        == { :method => :method_name, :score => score }
-    errors[0].line_number.should == 1
-    errors[0].message.should     == "Method method_name has cyclomatic complexity of #{score}."
+    warnings.should_not be_empty
+    warnings[0].info.should        == { :method => 'method_name', :score => score }
+    warnings[0].line_number.should == 1
+    warnings[0].message.should     == "method_name has cyclomatic complexity of #{score}."
   end
 
 end