simplabs-excellent 1.0.1 → 1.2.1

data/spec/checks/duplication_check_spec.rb

@@ -0,0 +1,139 @@
+require File.expand_path(File.dirname(__FILE__) + '/../spec_helper')
+
+describe Simplabs::Excellent::Checks::DuplicationCheck do
+
+  before do
+    @excellent = Simplabs::Excellent::Runner.new(Simplabs::Excellent::Checks::DuplicationCheck.new({ :threshold => 1 }))
+  end
+
+  describe '#evaluate' do
+
+    it 'should accept multiple calls to new' do
+      content = <<-END
+        def double_thing
+          @thing.new + @thing.new
+        end
+      END
+      @excellent.check_content(content)
+      warnings = @excellent.warnings
+
+      warnings.should be_empty
+    end
+
+    it 'should reject multiple calls to the same method and receiver' do
+      content = <<-END
+        def double_thing
+          @other.thing + @other.thing
+        end
+      END
+
+      verify_warning_found(content, '@other.thing')
+    end
+
+    it 'should reject multiple calls to the same lvar' do
+      content = <<-END
+        def double_thing
+          thing[1] + thing[2]
+        end
+      END
+
+      verify_warning_found(content, 'thing.[]')
+    end
+
+    it 'should reject multiple calls to the same singleton method' do
+      content = <<-END
+        def double_thing
+          Class.thing[1] + Class.thing[2]
+        end
+      END
+
+      verify_warning_found(content, 'Class.thing')
+    end
+
+    it 'should reject multiple calls to the same method without a receiver' do
+      content = <<-END
+        def double_thing
+          thing + thing
+        end
+      END
+
+      verify_warning_found(content, 'thing')
+    end
+
+    it 'should reject multiple calls to the same method with the same parameters' do
+      content = <<-END
+        def double_thing
+          thing(1) + thing(1)
+        end
+      END
+
+      verify_warning_found(content, 'thing')
+    end
+
+    it 'should reject multiple calls to the same method with different parameters' do
+      content = <<-END
+        def double_thing
+          thing(1) + thing(2)
+        end
+      END
+
+      verify_warning_found(content, 'thing')
+    end
+
+    it 'should work with singleton methods on objects' do
+      content = <<-END
+        def object.double_thing
+          thing(1) + thing(2)
+        end
+      END
+
+      verify_warning_found(content, 'thing', 'object.double_thing')
+    end
+
+    it 'should work with singleton methods on classes' do
+      content = <<-END
+        def Class.double_thing
+          thing(1) + thing(2)
+        end
+      END
+
+      verify_warning_found(content, 'thing', 'Class.double_thing')
+    end
+
+    it 'should work with singleton methods on classes' do
+      content = <<-END
+        class Class
+          def self.double_thing
+            thing(1) + thing(2)
+          end
+        end
+      END
+
+      verify_warning_found(content, 'thing', 'Class.double_thing', 2)
+    end
+
+    it 'should also work with blocks' do
+      content = <<-END
+        def method
+          double_thing do
+            thing(1) + thing(2)
+          end
+        end
+      END
+
+      verify_warning_found(content, 'thing', 'block', 2)
+    end
+
+  end
+
+  def verify_warning_found(content, statement, method = 'double_thing', line = 1)
+    @excellent.check_content(content)
+    warnings = @excellent.warnings
+
+    warnings.should_not be_empty
+    warnings[0].info.should        == { :method => method, :statement => statement, :duplication_number => 2 }
+    warnings[0].line_number.should == line
+    warnings[0].message.should     == "#{method} calls #{statement} 2 times."
+  end
+
+end

data/spec/checks/empty_rescue_body_check_spec.rb

@@ -3,7 +3,7 @@ require File.expand_path(File.dirname(__FILE__) + '/../spec_helper')
 describe Simplabs::Excellent::Checks::EmptyRescueBodyCheck do
 
   before do
-    @excellent = Simplabs::Excellent::Core::ParseTreeRunner.new(Simplabs::Excellent::Checks::EmptyRescueBodyCheck.new)
+    @excellent = Simplabs::Excellent::Runner.new(Simplabs::Excellent::Checks::EmptyRescueBodyCheck.new)
   end
 
   describe '#evaluate' do
@@ -18,7 +18,7 @@ describe Simplabs::Excellent::Checks::EmptyRescueBodyCheck do
       END
       @excellent.check_content(content)
 
-      @excellent.errors.should be_empty
+      @excellent.warnings.should be_empty
     end
 
     it 'should accept a rescue body with a return' do
@@ -31,7 +31,7 @@ describe Simplabs::Excellent::Checks::EmptyRescueBodyCheck do
       END
       @excellent.check_content(content)
 
-      @excellent.errors.should be_empty
+      @excellent.warnings.should be_empty
     end
 
     it "should accept a virtual method call" do
@@ -44,7 +44,7 @@ describe Simplabs::Excellent::Checks::EmptyRescueBodyCheck do
       END
       @excellent.check_content(content)
 
-      @excellent.errors.should be_empty
+      @excellent.warnings.should be_empty
     end
 
     it 'should accept a rescue body with content and a parameter' do
@@ -57,7 +57,7 @@ describe Simplabs::Excellent::Checks::EmptyRescueBodyCheck do
       END
       @excellent.check_content(content)
 
-      @excellent.errors.should be_empty
+      @excellent.warnings.should be_empty
     end
 
     it 'should accept a rescue body with an assignment' do
@@ -70,7 +70,7 @@ describe Simplabs::Excellent::Checks::EmptyRescueBodyCheck do
       END
       @excellent.check_content(content)
 
-      @excellent.errors.should be_empty
+      @excellent.warnings.should be_empty
     end
 
     it 'should accept a rescue body with an attribute assignment' do
@@ -83,7 +83,7 @@ describe Simplabs::Excellent::Checks::EmptyRescueBodyCheck do
       END
       @excellent.check_content(content)
 
-      @excellent.errors.should be_empty
+      @excellent.warnings.should be_empty
     end
 
     it 'should accept an inline rescue statement' do
@@ -92,7 +92,45 @@ describe Simplabs::Excellent::Checks::EmptyRescueBodyCheck do
       END
       @excellent.check_content(content)
 
-      @excellent.errors.should be_empty
+      @excellent.warnings.should be_empty
+    end
+
+    it 'should accept an empty array as a statement' do
+      content = <<-END
+        value = call_method rescue []
+      END
+
+      @excellent.check_content(content)
+
+      @excellent.warnings.should be_empty
+    end
+
+    it 'should accept an empty hash as a statement' do
+      content = <<-END
+        value = call_method rescue {}
+      END
+
+      @excellent.check_content(content)
+
+      @excellent.warnings.should be_empty
+    end
+
+    it 'should accept a boolean as a statement' do
+      content = <<-END
+        value = call_method rescue false
+      END
+      @excellent.check_content(content)
+
+      @excellent.warnings.should be_empty
+    end
+
+    it 'should accept nil as a statement' do
+      content = <<-END
+        value = call_method rescue nil
+      END
+      @excellent.check_content(content)
+
+      @excellent.warnings.should be_empty
     end
 
     it 'should reject an empty rescue block with no parameter' do
@@ -103,7 +141,7 @@ describe Simplabs::Excellent::Checks::EmptyRescueBodyCheck do
         end
       END
 
-      verify_error_found(content)
+      verify_warning_found(content)
     end
 
     it 'should reject an empty rescue block with a parameter' do
@@ -114,19 +152,19 @@ describe Simplabs::Excellent::Checks::EmptyRescueBodyCheck do
         end
       END
 
-      verify_error_found(content)
+      verify_warning_found(content)
     end
 
   end
 
-  def verify_error_found(content)
+  def verify_warning_found(content)
     @excellent.check_content(content)
-    errors = @excellent.errors
+    warnings = @excellent.warnings
 
-    errors.should_not be_empty
-    errors[0].info.should        == {}
-    errors[0].line_number.should == 3
-    errors[0].message.should     == 'Rescue block is empty.'
+    warnings.should_not be_empty
+    warnings[0].info.should        == {}
+    warnings[0].line_number.should == 3
+    warnings[0].message.should     == 'Rescue block is empty.'
   end
 
 end

data/spec/checks/flog_block_check_spec.rb

@@ -0,0 +1,28 @@
+require File.expand_path(File.dirname(__FILE__) + '/../spec_helper')
+
+describe Simplabs::Excellent::Checks::FlogBlockCheck do
+
+  before do
+    @excellent = Simplabs::Excellent::Runner.new(Simplabs::Excellent::Checks::FlogBlockCheck.new({ :threshold => 0 }))
+  end
+
+  describe '#evaluate' do
+
+    it 'should calculate the score correctly' do
+      content = <<-END
+        method_name do
+          puts 'test'
+        end
+      END
+      @excellent.check_content(content)
+      warnings = @excellent.warnings
+
+      warnings.should_not be_empty
+      warnings[0].info.should        == { :block => 'block', :score => 3 }
+      warnings[0].line_number.should == 1
+      warnings[0].message.should     == "block has flog score of 3."
+    end
+
+  end
+
+end

data/spec/checks/flog_class_check_spec.rb

@@ -0,0 +1,28 @@
+require File.expand_path(File.dirname(__FILE__) + '/../spec_helper')
+
+describe Simplabs::Excellent::Checks::FlogClassCheck do
+
+  before do
+    @excellent = Simplabs::Excellent::Runner.new(Simplabs::Excellent::Checks::FlogClassCheck.new({ :threshold => 0 }))
+  end
+
+  describe '#evaluate' do
+
+    it 'should calculate the score correctly' do
+      content = <<-END
+        class User < ActiveRecord::Base
+          has_many :projects
+        end
+      END
+      @excellent.check_content(content)
+      warnings = @excellent.warnings
+
+      warnings.should_not be_empty
+      warnings[0].info.should        == { :class => 'User', :score => 1 }
+      warnings[0].line_number.should == 1
+      warnings[0].message.should     == "User has flog score of 1."
+    end
+
+  end
+
+end

data/spec/checks/flog_method_check_spec.rb

@@ -0,0 +1,46 @@
+require File.expand_path(File.dirname(__FILE__) + '/../spec_helper')
+
+describe Simplabs::Excellent::Checks::FlogMethodCheck do
+
+  before do
+    @excellent = Simplabs::Excellent::Runner.new(Simplabs::Excellent::Checks::FlogMethodCheck.new({ :threshold => 0 }))
+  end
+
+  describe '#evaluate' do
+
+    it 'should calculate the score correctly' do
+      content = <<-END
+        def method_name
+          puts 'test'
+        end
+      END
+
+      verify_content_score(content, 1)
+    end
+
+    it 'should calculate the score that uses special metaprogramming methods correctly' do
+      content = <<-END
+        def method_name
+          @instance.instance_eval do
+            def some_method
+            end
+          end
+        end
+      END
+
+      verify_content_score(content, 6)
+    end
+
+  end
+
+  def verify_content_score(content, score)
+    @excellent.check_content(content)
+    warnings = @excellent.warnings
+
+    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 flog score of #{score}."
+  end
+
+end

data/spec/checks/for_loop_check_spec.rb

@@ -3,7 +3,7 @@ require File.expand_path(File.dirname(__FILE__) + '/../spec_helper')
 describe Simplabs::Excellent::Checks::ForLoopCheck do
 
   before do
-    @excellent = Simplabs::Excellent::Core::ParseTreeRunner.new(Simplabs::Excellent::Checks::ForLoopCheck.new)
+    @excellent = Simplabs::Excellent::Runner.new(Simplabs::Excellent::Checks::ForLoopCheck.new)
   end
 
   describe '#evaluate' do
@@ -14,9 +14,9 @@ describe Simplabs::Excellent::Checks::ForLoopCheck 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 for loops on ranges' do
@@ -25,7 +25,7 @@ describe Simplabs::Excellent::Checks::ForLoopCheck do
         end
       END
 
-      verify_error_found(content)
+      verify_warning_found(content)
     end
 
     it 'should reject for loops on enumerations' do
@@ -34,19 +34,19 @@ describe Simplabs::Excellent::Checks::ForLoopCheck do
         end
       END
 
-      verify_error_found(content)
+      verify_warning_found(content)
     end
 
   end
 
-  def verify_error_found(content)
+  def verify_warning_found(content)
     @excellent.check_content(content)
-    errors = @excellent.errors
+    warnings = @excellent.warnings
 
-    errors.should_not be_empty
-    errors[0].info.should        == {}
-    errors[0].line_number.should == 1
-    errors[0].message.should     == 'For loop used.'
+    warnings.should_not be_empty
+    warnings[0].info.should        == {}
+    warnings[0].line_number.should == 1
+    warnings[0].message.should     == 'For loop used.'
   end
 
 end

data/spec/checks/method_line_count_check_spec.rb

@@ -3,46 +3,45 @@ require File.expand_path(File.dirname(__FILE__) + '/../spec_helper')
 describe Simplabs::Excellent::Checks::MethodLineCountCheck do
 
   before do
-    @excellent = Simplabs::Excellent::Core::ParseTreeRunner.new(Simplabs::Excellent::Checks::MethodLineCountCheck.new({ :threshold => 1 }))
+    @excellent = Simplabs::Excellent::Runner.new(Simplabs::Excellent::Checks::MethodLineCountCheck.new({ :threshold => 2 }))
   end
 
   describe '#evaluate' do
 
     it 'should accept methods with less lines than the threshold' do
       content = <<-END
-        def zero_line_method
+        def one_line_method
         end
       END
       @excellent.check_content(content)
 
-      @excellent.errors.should be_empty
+      @excellent.warnings.should be_empty
     end
 
     it 'should accept methods with the same number of lines as the threshold' do
       content = <<-END
-        def one_line_method
-          1
+        def two_line_method
         end
       END
       @excellent.check_content(content)
 
-      @excellent.errors.should be_empty
+      @excellent.warnings.should be_empty
     end
 
     it 'should reject methods with more lines than the threshold' do
       content = <<-END
-        def two_line_method
+        def four_line_method
           puts 1
           puts 2
         end
       END
       @excellent.check_content(content)
-      errors = @excellent.errors
+      warnings = @excellent.warnings
 
-      errors.should_not be_empty
-      errors[0].info.should        == { :method => :two_line_method, :count => 2 }
-      errors[0].line_number.should == 1
-      errors[0].message.should     == 'Method two_line_method has 2 lines.'
+      warnings.should_not be_empty
+      warnings[0].info.should        == { :method => 'four_line_method', :count => 4 }
+      warnings[0].line_number.should == 1
+      warnings[0].message.should     == 'four_line_method has 4 lines.'
     end
 
   end