excellent 1.5.4

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
+      code = <<-END
+        class User < ActiveRecord::Base
+          has_many :projects
+        end
+      END
+      @excellent.check_code(code)
+      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
+      code = <<-END
+        def method_name
+          puts 'test'
+        end
+      END
+
+      verify_code_score(code, 1)
+    end
+
+    it 'should calculate the score that uses special metaprogramming methods correctly' do
+      code = <<-END
+        def method_name
+          @instance.instance_eval do
+            def some_method
+            end
+          end
+        end
+      END
+
+      verify_code_score(code, 6)
+    end
+
+  end
+
+  def verify_code_score(code, score)
+    @excellent.check_code(code)
+    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

@@ -0,0 +1,52 @@
+require File.expand_path(File.dirname(__FILE__) + '/../spec_helper')
+
+describe Simplabs::Excellent::Checks::ForLoopCheck do
+
+  before do
+    @excellent = Simplabs::Excellent::Runner.new(Simplabs::Excellent::Checks::ForLoopCheck.new)
+  end
+
+  describe '#evaluate' do
+
+    it 'should accept iterators' do
+      code = <<-END
+        [:sym1, :sym2].each do |sym|
+        end
+      END
+      @excellent.check_code(code)
+      warnings = @excellent.warnings
+
+      warnings.should be_empty
+    end
+
+    it 'should reject for loops on ranges' do
+      code = <<-END
+        for i in 1..2
+        end
+      END
+
+      verify_warning_found(code)
+    end
+
+    it 'should reject for loops on enumerations' do
+      code = <<-END
+        for symbol in [:sym1, :sym2]
+        end
+      END
+
+      verify_warning_found(code)
+    end
+
+  end
+
+  def verify_warning_found(code)
+    @excellent.check_code(code)
+    warnings = @excellent.warnings
+
+    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/global_variable_check_spec.rb

@@ -0,0 +1,66 @@
+require File.expand_path(File.dirname(__FILE__) + '/../spec_helper')
+
+describe Simplabs::Excellent::Checks::GlobalVariableCheck do
+
+  before(:each) do
+    @excellent = Simplabs::Excellent::Runner.new(Simplabs::Excellent::Checks::GlobalVariableCheck.new)
+  end
+
+  describe '#evaluate' do
+
+    it 'should reject global variables' do
+      code = <<-END
+        $foo = 'bar'
+      END
+      @excellent.check_code(code)
+      warnings = @excellent.warnings
+
+      warnings.should_not be_empty
+      warnings[0].info.should        == { :variable => 'foo' }
+      warnings[0].line_number.should == 1
+      warnings[0].message.should     == 'Global variable foo used.'
+    end
+
+    it 'should also work in modules' do
+      code = <<-END
+        module Outer
+          module Inner
+            class Class
+              $foo = 'bar'
+            end
+          end
+        end
+      END
+      @excellent.check_code(code)
+      warnings = @excellent.warnings
+
+      warnings.should_not be_empty
+      warnings[0].info.should        == { :variable => 'foo' }
+      warnings[0].line_number.should == 4
+      warnings[0].message.should     == 'Global variable foo used.'
+    end
+
+    it 'should also work for global variables that occur within methods' do
+      code = <<-END
+        module Outer
+          module Inner
+            class Class
+              def method
+                $foo == 'bar'
+              end
+            end
+          end
+        end
+      END
+      @excellent.check_code(code)
+      warnings = @excellent.warnings
+
+      warnings.should_not be_empty
+      warnings[0].info.should        == { :variable => 'foo' }
+      warnings[0].line_number.should == 5
+      warnings[0].message.should     == 'Global variable foo used.'
+    end
+
+  end
+
+end

data/spec/checks/method_line_count_check_spec.rb

@@ -0,0 +1,49 @@
+require File.expand_path(File.dirname(__FILE__) + '/../spec_helper')
+
+describe Simplabs::Excellent::Checks::MethodLineCountCheck do
+
+  before do
+    @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
+      code = <<-END
+        def one_line_method
+        end
+      END
+      @excellent.check_code(code)
+
+      @excellent.warnings.should be_empty
+    end
+
+    it 'should accept methods with the same number of lines as the threshold' do
+      code = <<-END
+        def two_line_method
+        end
+      END
+      @excellent.check_code(code)
+
+      @excellent.warnings.should be_empty
+    end
+
+    it 'should reject methods with more lines than the threshold' do
+      code = <<-END
+        def four_line_method
+          puts 1
+          puts 2
+        end
+      END
+      @excellent.check_code(code)
+      warnings = @excellent.warnings
+
+      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
+
+end

data/spec/checks/method_name_check_spec.rb

@@ -0,0 +1,112 @@
+require File.expand_path(File.dirname(__FILE__) + '/../spec_helper')
+
+describe Simplabs::Excellent::Checks::MethodNameCheck do
+
+  before do
+    @excellent = Simplabs::Excellent::Runner.new(Simplabs::Excellent::Checks::MethodNameCheck.new)
+  end
+
+  describe '#evaluate' do
+
+    it 'should accept method names with underscores' do
+      code = <<-END
+        def good_method_name
+        end
+      END
+      @excellent.check_code(code)
+
+      @excellent.warnings.should be_empty
+    end
+
+    it 'should accept method names with numbers' do
+      code = <<-END
+        def good_method_name_1
+        end
+      END
+      @excellent.check_code(code)
+
+      @excellent.warnings.should be_empty
+    end
+
+    it 'should accept method names ending with a question mark' do
+      code = <<-END
+        def good_method_name?
+        end
+      END
+      @excellent.check_code(code)
+
+      @excellent.warnings.should be_empty
+    end
+
+    it 'should accept method names ending with an exclamation mark' do
+      code = <<-END
+        def good_method_name!
+        end
+      END
+      @excellent.check_code(code)
+
+      @excellent.warnings.should be_empty
+    end
+
+    it 'should accept method names ending an equals sign' do
+      code = <<-END
+        def good_method_name=
+        end
+      END
+      @excellent.check_code(code)
+
+      @excellent.warnings.should be_empty
+    end
+
+    ['<<', '>>', '==', '<', '<=', '>', '>=', '[]', '[]=', '+', '-', '*', '~', '/', '%', '&', '^', '|'].each do |operator|
+
+      it "should accept #{operator} as a method name" do
+        code = <<-END
+          def #{operator}
+          end
+        END
+        @excellent.check_code(code)
+
+        @excellent.warnings.should be_empty
+      end
+
+    end
+
+  end
+
+  it 'should reject camel cased method names' do
+    code = <<-END
+      def badMethodName
+      end
+    END
+    @excellent.check_code(code)
+    warnings = @excellent.warnings
+
+    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
+    code = <<-END
+      class Class
+        def badMethodName
+        end
+        def self.badMethodName2
+        end
+      end
+    END
+    @excellent.check_code(code)
+    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

@@ -0,0 +1,48 @@
+require File.expand_path(File.dirname(__FILE__) + '/../spec_helper')
+
+describe Simplabs::Excellent::Checks::ModuleLineCountCheck do
+
+  before do
+    @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
+      code = <<-END
+        module OneLineModule; end
+      END
+      @excellent.check_code(code)
+
+      @excellent.warnings.should be_empty
+    end
+
+    it 'should accept modules with the same number of lines as the threshold' do
+      code = <<-END
+        module TwoLinesModule
+        end
+      END
+      @excellent.check_code(code)
+
+      @excellent.warnings.should be_empty
+    end
+
+    it 'should reject modules with more lines than the threshold' do
+      code = <<-END
+        module FourLinesModule
+          @foo = 1
+          @bar = 2
+        end
+      END
+      @excellent.check_code(code)
+      warnings = @excellent.warnings
+
+      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
+
+end

data/spec/checks/module_name_check_spec.rb

@@ -0,0 +1,61 @@
+require File.expand_path(File.dirname(__FILE__) + '/../spec_helper')
+
+describe Simplabs::Excellent::Checks::ModuleNameCheck do
+
+  before do
+    @excellent = Simplabs::Excellent::Runner.new(Simplabs::Excellent::Checks::ModuleNameCheck.new)
+  end
+
+  describe '#evaluate' do
+
+    it 'should accept camel case module names starting in capitals' do
+      code = <<-END
+        module GoodModuleName 
+        end
+      END
+      @excellent.check_code(code)
+
+      @excellent.warnings.should be_empty
+    end
+
+    it 'should accept namespaced modules' do
+      code = <<-END
+        module Outer::Inner::GoodModuleName 
+        end
+      END
+      @excellent.check_code(code)
+
+      @excellent.warnings.should be_empty
+    end
+
+    it 'should reject module names with underscores' do
+      code = <<-END
+        module Bad_ModuleName 
+        end
+      END
+      @excellent.check_code(code)
+      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
+      code = <<-END
+        module Outer::Inner::Bad_ModuleName
+        end
+      END
+      @excellent.check_code(code)
+      warnings = @excellent.warnings
+
+      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
+
+end