simplabs-excellent 1.0.1 → 1.2.1

data/spec/checks/method_name_check_spec.rb

@@ -3,7 +3,7 @@ require File.expand_path(File.dirname(__FILE__) + '/../spec_helper')
 describe Simplabs::Excellent::Checks::MethodNameCheck do
 
   before do
-    @excellent = Simplabs::Excellent::Core::ParseTreeRunner.new(Simplabs::Excellent::Checks::MethodNameCheck.new)
+    @excellent = Simplabs::Excellent::Runner.new(Simplabs::Excellent::Checks::MethodNameCheck.new)
   end
 
   describe '#evaluate' do
@@ -15,7 +15,7 @@ describe Simplabs::Excellent::Checks::MethodNameCheck do
       END
       @excellent.check_content(content)
 
-      @excellent.errors.should be_empty
+      @excellent.warnings.should be_empty
     end
 
     it 'should accept method names with numbers' do
@@ -25,7 +25,7 @@ describe Simplabs::Excellent::Checks::MethodNameCheck do
       END
       @excellent.check_content(content)
 
-      @excellent.errors.should be_empty
+      @excellent.warnings.should be_empty
     end
 
     it 'should accept method names ending with a question mark' do
@@ -35,7 +35,7 @@ describe Simplabs::Excellent::Checks::MethodNameCheck do
       END
       @excellent.check_content(content)
 
-      @excellent.errors.should be_empty
+      @excellent.warnings.should be_empty
     end
 
     it 'should accept method names ending with an exclamation mark' do
@@ -45,7 +45,7 @@ describe Simplabs::Excellent::Checks::MethodNameCheck do
       END
       @excellent.check_content(content)
 
-      @excellent.errors.should be_empty
+      @excellent.warnings.should be_empty
     end
 
     it 'should accept method names ending an equals sign' do
@@ -55,10 +55,10 @@ describe Simplabs::Excellent::Checks::MethodNameCheck do
       END
       @excellent.check_content(content)
 
-      @excellent.errors.should be_empty
+      @excellent.warnings.should be_empty
     end
 
-    ['<<', '>>', '==', '=', '<', '<=', '>', '>=', '[]', '[]=', '+', '-', '*', '~', '/', '%', '&', '^' '|'].each do |operator|
+    ['<<', '>>', '==', '<', '<=', '>', '>=', '[]', '[]=', '+', '-', '*', '~', '/', '%', '&', '^', '|'].each do |operator|
 
       it "should accept #{operator} as a method name" do
         content = <<-END
@@ -67,7 +67,7 @@ describe Simplabs::Excellent::Checks::MethodNameCheck do
         END
         @excellent.check_content(content)
 
-        @excellent.errors.should be_empty
+        @excellent.warnings.should be_empty
       end
 
     end
@@ -80,12 +80,33 @@ describe Simplabs::Excellent::Checks::MethodNameCheck do
       end
     END
     @excellent.check_content(content)
-    errors = @excellent.errors
+    warnings = @excellent.warnings
 
-    errors.should_not be_empty
-    errors[0].info.should        == { :method => :badMethodName }
-    errors[0].line_number.should == 1
-    errors[0].message.should     == 'Bad method name badMethodName.'
+    warnings.should_not be_empty
+    warnings[0].info.should        == { :method => 'badMethodName' }
+    warnings[0].line_number.should == 1
+    warnings[0].message.should     == 'Bad method name badMethodName.'
+  end
+
+  it "should correctly return the method's full name" do
+    content = <<-END
+      class Class
+        def badMethodName
+        end
+        def self.badMethodName2
+        end
+      end
+    END
+    @excellent.check_content(content)
+    warnings = @excellent.warnings
+
+    warnings.should_not be_empty
+    warnings[0].info.should        == { :method => 'Class#badMethodName' }
+    warnings[0].line_number.should == 2
+    warnings[0].message.should     == 'Bad method name Class#badMethodName.'
+    warnings[1].info.should        == { :method => 'Class.badMethodName2' }
+    warnings[1].line_number.should == 4
+    warnings[1].message.should     == 'Bad method name Class.badMethodName2.'
   end
 
 end

data/spec/checks/module_line_count_check_spec.rb

@@ -3,45 +3,44 @@ require File.expand_path(File.dirname(__FILE__) + '/../spec_helper')
 describe Simplabs::Excellent::Checks::ModuleLineCountCheck do
 
   before do
-    @excellent = Simplabs::Excellent::Core::ParseTreeRunner.new(Simplabs::Excellent::Checks::ModuleLineCountCheck.new({ :threshold => 1 }))
+    @excellent = Simplabs::Excellent::Runner.new(Simplabs::Excellent::Checks::ModuleLineCountCheck.new({ :threshold => 2 }))
   end
 
   describe '#evaluate' do
 
     it 'should accept modules with less lines than the threshold' do
       content = <<-END
-        module ZeroLineModule; end
+        module OneLineModule; end
       END
       @excellent.check_content(content)
 
-      @excellent.errors.should be_empty
+      @excellent.warnings.should be_empty
     end
 
     it 'should accept modules with the same number of lines as the threshold' do
       content = <<-END
-        module OneLineModule
-          @foo = 1
+        module TwoLinesModule
         end
       END
       @excellent.check_content(content)
 
-      @excellent.errors.should be_empty
+      @excellent.warnings.should be_empty
     end
 
     it 'should reject modules with more lines than the threshold' do
       content = <<-END
-        module TwoLineModule
+        module FourLinesModule
           @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        == { :module => :TwoLineModule, :count => 2 }
-      errors[0].line_number.should == 1
-      errors[0].message.should     == 'Module TwoLineModule has 2 lines.'
+      warnings.should_not be_empty
+      warnings[0].info.should        == { :module => 'FourLinesModule', :count => 4 }
+      warnings[0].line_number.should == 1
+      warnings[0].message.should     == 'FourLinesModule has 4 lines.'
     end
 
   end

data/spec/checks/module_name_check_spec.rb

@@ -3,7 +3,7 @@ require File.expand_path(File.dirname(__FILE__) + '/../spec_helper')
 describe Simplabs::Excellent::Checks::ModuleNameCheck do
 
   before do
-    @excellent = Simplabs::Excellent::Core::ParseTreeRunner.new(Simplabs::Excellent::Checks::ModuleNameCheck.new)
+    @excellent = Simplabs::Excellent::Runner.new(Simplabs::Excellent::Checks::ModuleNameCheck.new)
   end
 
   describe '#evaluate' do
@@ -15,7 +15,17 @@ describe Simplabs::Excellent::Checks::ModuleNameCheck do
       END
       @excellent.check_content(content)
 
-      @excellent.errors.should be_empty
+      @excellent.warnings.should be_empty
+    end
+
+    it 'should accept namespaced modules' do
+      content = <<-END
+        module Outer::Inner::GoodModuleName 
+        end
+      END
+      @excellent.check_content(content)
+
+      @excellent.warnings.should be_empty
     end
 
     it 'should reject module names with underscores' do
@@ -24,12 +34,26 @@ describe Simplabs::Excellent::Checks::ModuleNameCheck do
         end
       END
       @excellent.check_content(content)
-      errors = @excellent.errors
+      warnings = @excellent.warnings
+
+      warnings.should_not be_empty
+      warnings[0].info.should        == { :module => 'Bad_ModuleName' }
+      warnings[0].line_number.should == 1
+      warnings[0].message.should     == 'Bad module name Bad_ModuleName.'
+    end
+
+    it 'should correctly report bad names of namespaced modules' do
+      content = <<-END
+        module Outer::Inner::Bad_ModuleName
+        end
+      END
+      @excellent.check_content(content)
+      warnings = @excellent.warnings
 
-      errors.should_not be_empty
-      errors[0].info.should        == { :module => :Bad_ModuleName }
-      errors[0].line_number.should == 1
-      errors[0].message.should     == 'Bad module name Bad_ModuleName.'
+      warnings.should_not be_empty
+      warnings[0].info.should        == { :module => 'Outer::Inner::Bad_ModuleName' }
+      warnings[0].line_number.should == 1
+      warnings[0].message.should     == 'Bad module name Outer::Inner::Bad_ModuleName.'
     end
 
   end

data/spec/checks/nested_iterators_check_spec.rb

@@ -0,0 +1,44 @@
+require File.expand_path(File.dirname(__FILE__) + '/../spec_helper')
+
+describe Simplabs::Excellent::Checks::NestedIteratorsCheck do
+
+  before do
+    @excellent = Simplabs::Excellent::Runner.new(Simplabs::Excellent::Checks::NestedIteratorsCheck.new)
+  end
+
+  describe '#evaluate' do
+
+    it 'should reject a block inside a block' do
+      content = <<-END
+        method1 do
+          method2 do
+          end
+        end
+      END
+      @excellent.check_content(content)
+      warnings = @excellent.warnings
+
+      warnings.should_not be_empty
+      warnings[0].info.should        == { :block => 'block', :parent => 'block' }
+      warnings[0].line_number.should == 2
+      warnings[0].message.should     == 'block inside of block.'
+    end
+
+    it 'should accept 2 blocks inside a method that are not nested' do
+      content = <<-END
+        def method
+          method1 do
+          end
+          method2 do
+          end
+        end
+      END
+      @excellent.check_content(content)
+      warnings = @excellent.warnings
+
+      warnings.should be_empty
+    end
+
+  end
+
+end

data/spec/checks/parameter_number_check_spec.rb

@@ -3,7 +3,7 @@ require File.expand_path(File.dirname(__FILE__) + '/../spec_helper')
 describe Simplabs::Excellent::Checks::ParameterNumberCheck do
 
   before(:each) do
-    @excellent = Simplabs::Excellent::Core::ParseTreeRunner.new(Simplabs::Excellent::Checks::ParameterNumberCheck.new({ :threshold => 1 }))
+    @excellent = Simplabs::Excellent::Runner.new(Simplabs::Excellent::Checks::ParameterNumberCheck.new({ :threshold => 1 }))
   end
 
   describe '#evaluate' do
@@ -15,7 +15,7 @@ describe Simplabs::Excellent::Checks::ParameterNumberCheck do
       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 parameters as the threshold' do
@@ -25,7 +25,7 @@ describe Simplabs::Excellent::Checks::ParameterNumberCheck do
       END
       @excellent.check_content(content)
 
-      @excellent.errors.should be_empty
+      @excellent.warnings.should be_empty
     end
 
     it 'should reject methods with more parameters than the threshold' do
@@ -34,28 +34,64 @@ describe Simplabs::Excellent::Checks::ParameterNumberCheck do
         end
       END
 
-      verify_error_found(content)
+      verify_warning_found(content, 'two_parameter_method')
     end
 
-    it 'should cope with default values on parameters' do
+    it 'should work with default values on parameters' do
       content = <<-END
         def two_parameter_method(first_parameter = 1, second_parameter = 2)
         end
       END
 
-      verify_error_found(content)
+      verify_warning_found(content, 'two_parameter_method')
+    end
+
+    it 'should work with methods defined on objects' do
+      content = <<-END
+        def object.two_parameter_method(first_parameter = 1, second_parameter = 2)
+        end
+      END
+
+      verify_warning_found(content, 'object.two_parameter_method')
+    end
+
+    it 'should work with methods defined directly on classes' do
+      content = <<-END
+        def Class.two_parameter_method(first_parameter = 1, second_parameter = 2)
+        end
+      END
+
+      verify_warning_found(content, 'Class.two_parameter_method')
+    end
+
+    it 'should reject yield calls with more parameters than the threshold' do
+      content = <<-END
+        two_parameter_method do |first_parameter, second_parameter|
+        end
+      END
+
+      verify_warning_found(content, 'block')
+    end
+
+    it 'should reject yield calls on a receiver with more parameters than the threshold' do
+      content = <<-END
+        receiver.two_parameter_method do |first_parameter, second_parameter|
+        end
+      END
+
+      verify_warning_found(content, 'block')
     end
 
   end
 
-  def verify_error_found(content)
+  def verify_warning_found(content, name)
     @excellent.check_content(content)
-    errors = @excellent.errors
+    warnings = @excellent.warnings
 
-    errors.should_not be_empty
-    errors[0].info.should        == { :method => :two_parameter_method, :parameter_count => 2 }
-    errors[0].line_number.should == 1
-    errors[0].message.should     == 'Method two_parameter_method has 2 parameters.'
+    warnings.should_not be_empty
+    warnings[0].info.should        == { :method => name, :parameters => 2 }
+    warnings[0].line_number.should == 1
+    warnings[0].message.should     == "#{name} has 2 parameters."
   end
 
 end

data/spec/checks/rails/attr_accessible_check_spec.rb

@@ -0,0 +1,79 @@
+require File.expand_path(File.dirname(__FILE__) + '/../../spec_helper')
+
+describe Simplabs::Excellent::Checks::Rails::AttrAccessibleCheck do
+
+  before do
+    @excellent = Simplabs::Excellent::Runner.new(Simplabs::Excellent::Checks::Rails::AttrAccessibleCheck.new)
+  end
+
+  describe '#evaluate' do
+
+    it 'should ignore classes that are not active record models' do
+      content = <<-END
+        class Test
+        end
+      END
+      @excellent.check_content(content)
+      warnings = @excellent.warnings
+
+      warnings.should be_empty
+    end
+
+    it 'should reject an active record model that does not specify attr_accessible' do
+      content = <<-END
+        class User < ActiveRecord::Base
+        end
+      END
+      @excellent.check_content(content)
+      warnings = @excellent.warnings
+
+      warnings.should_not be_empty
+      warnings[0].info.should        == { :class => 'User' }
+      warnings[0].line_number.should == 1
+      warnings[0].message.should     == 'User does not specify attr_accessible.'
+    end
+
+    it 'should reject an active record model that does specify attr_protected' do
+      content = <<-END
+        class User < ActiveRecord::Base
+          attr_protected :first_name
+        end
+      END
+      @excellent.check_content(content)
+      warnings = @excellent.warnings
+
+      warnings.should_not be_empty
+      warnings[0].info.should        == { :class => 'User' }
+      warnings[0].line_number.should == 1
+      warnings[0].message.should     == 'User does not specify attr_accessible.'
+    end
+
+    it 'should accept an active record model that does specify attr_accessible' do
+      content = <<-END
+        class User < ActiveRecord::Base
+          attr_accessible :first_name
+        end
+      END
+      @excellent.check_content(content)
+      warnings = @excellent.warnings
+
+      warnings.should be_empty
+    end
+
+    it 'should also work with namespaced models' do
+      content = <<-END
+        class Backend::User < ActiveRecord::Base
+        end
+      END
+      @excellent.check_content(content)
+      warnings = @excellent.warnings
+
+      warnings.should_not be_empty
+      warnings[0].info.should        == { :class => 'Backend::User' }
+      warnings[0].line_number.should == 1
+      warnings[0].message.should     == 'Backend::User does not specify attr_accessible.'
+    end
+
+  end
+
+end

data/spec/checks/rails/attr_protected_check_spec.rb

@@ -0,0 +1,77 @@
+require File.expand_path(File.dirname(__FILE__) + '/../../spec_helper')
+
+describe Simplabs::Excellent::Checks::Rails::AttrProtectedCheck do
+
+  before do
+    @excellent = Simplabs::Excellent::Runner.new(Simplabs::Excellent::Checks::Rails::AttrProtectedCheck.new)
+  end
+
+  describe '#evaluate' do
+
+    it 'should ignore classes that are not active record models' do
+      content = <<-END
+        class Test
+        end
+      END
+      @excellent.check_content(content)
+      warnings = @excellent.warnings
+
+      warnings.should be_empty
+    end
+
+    it 'should reject an active record model that does specify attr_protected' do
+      content = <<-END
+        class User < ActiveRecord::Base
+          attr_protected :first_name
+        end
+      END
+      @excellent.check_content(content)
+      warnings = @excellent.warnings
+
+      warnings.should_not be_empty
+      warnings[0].info.should        == { :class => 'User' }
+      warnings[0].line_number.should == 1
+      warnings[0].message.should     == 'User specifies attr_protected.'
+    end
+
+    it 'should accept an active record model that does specify attr_accessible' do
+      content = <<-END
+        class User < ActiveRecord::Base
+          attr_accessible :first_name
+        end
+      END
+      @excellent.check_content(content)
+      warnings = @excellent.warnings
+
+      warnings.should be_empty
+    end
+
+    it 'should accept an active record model that specifies neither attr_accessible not attr_protected' do
+      content = <<-END
+        class User < ActiveRecord::Base
+        end
+      END
+      @excellent.check_content(content)
+      warnings = @excellent.warnings
+
+      warnings.should be_empty
+    end
+
+    it 'should also work with namespaced models' do
+      content = <<-END
+        class Backend::User < ActiveRecord::Base
+          attr_protected :first_name
+        end
+      END
+      @excellent.check_content(content)
+      warnings = @excellent.warnings
+
+      warnings.should_not be_empty
+      warnings[0].info.should        == { :class => 'Backend::User' }
+      warnings[0].line_number.should == 1
+      warnings[0].message.should     == 'Backend::User specifies attr_protected.'
+    end
+
+  end
+
+end