simplabs-excellent 1.0.0

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::Core::ParseTreeRunner.new(Simplabs::Excellent::Checks::ForLoopCheck.new)
+  end
+
+  describe '#evaluate' do
+
+    it 'should accept iterators' do
+      content = <<-END
+        [:sym1, :sym2].each do |sym|
+        end
+      END
+      @excellent.check_content(content)
+      errors = @excellent.errors
+
+      errors.should be_empty
+    end
+
+    it 'should reject for loops on ranges' do
+      content = <<-END
+        for i in 1..2
+        end
+      END
+
+      verify_error_found(content)
+    end
+
+    it 'should reject for loops on enumerations' do
+      content = <<-END
+        for symbol in [:sym1, :sym2]
+        end
+      END
+
+      verify_error_found(content)
+    end
+
+  end
+
+  def verify_error_found(content)
+    @excellent.check_content(content)
+    errors = @excellent.errors
+
+    errors.should_not be_empty
+    errors[0].info.should        == {}
+    errors[0].line_number.should == 1
+    errors[0].message.should     == 'For loop used.'
+  end
+
+end

data/spec/checks/method_line_count_check_spec.rb

@@ -0,0 +1,50 @@
+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 }))
+  end
+
+  describe '#evaluate' do
+
+    it 'should accept methods with less lines than the threshold' do
+      content = <<-END
+        def zero_line_method
+        end
+      END
+      @excellent.check_content(content)
+
+      @excellent.errors.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
+        end
+      END
+      @excellent.check_content(content)
+
+      @excellent.errors.should be_empty
+    end
+
+    it 'should reject methods with more lines than the threshold' do
+      content = <<-END
+        def two_line_method
+          puts 1
+          puts 2
+        end
+      END
+      @excellent.check_content(content)
+      errors = @excellent.errors
+
+      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.'
+    end
+
+  end
+
+end

data/spec/checks/method_name_check_spec.rb

@@ -0,0 +1,91 @@
+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)
+  end
+
+  describe '#evaluate' do
+
+    it 'should accept method names with underscores' do
+      content = <<-END
+        def good_method_name
+        end
+      END
+      @excellent.check_content(content)
+
+      @excellent.errors.should be_empty
+    end
+
+    it 'should accept method names with numbers' do
+      content = <<-END
+        def good_method_name_1
+        end
+      END
+      @excellent.check_content(content)
+
+      @excellent.errors.should be_empty
+    end
+
+    it 'should accept method names ending with a question mark' do
+      content = <<-END
+        def good_method_name?
+        end
+      END
+      @excellent.check_content(content)
+
+      @excellent.errors.should be_empty
+    end
+
+    it 'should accept method names ending with an exclamation mark' do
+      content = <<-END
+        def good_method_name!
+        end
+      END
+      @excellent.check_content(content)
+
+      @excellent.errors.should be_empty
+    end
+
+    it 'should accept method names ending an equals sign' do
+      content = <<-END
+        def good_method_name=
+        end
+      END
+      @excellent.check_content(content)
+
+      @excellent.errors.should be_empty
+    end
+
+    ['<<', '>>', '==', '=', '<', '<=', '>', '>=', '[]', '[]=', '+', '-', '*', '~', '/', '%', '&', '^' '|'].each do |operator|
+
+      it "should accept #{operator} as a method name" do
+        content = <<-END
+          def #{operator}
+          end
+        END
+        @excellent.check_content(content)
+
+        @excellent.errors.should be_empty
+      end
+
+    end
+
+  end
+
+  it 'should reject camel cased method names' do
+    content = <<-END
+      def badMethodName
+      end
+    END
+    @excellent.check_content(content)
+    errors = @excellent.errors
+
+    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.'
+  end
+
+end

data/spec/checks/module_line_count_check_spec.rb

@@ -0,0 +1,49 @@
+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 }))
+  end
+
+  describe '#evaluate' do
+
+    it 'should accept modules with less lines than the threshold' do
+      content = <<-END
+        module ZeroLineModule; end
+      END
+      @excellent.check_content(content)
+
+      @excellent.errors.should be_empty
+    end
+
+    it 'should accept modules with the same number of lines as the threshold' do
+      content = <<-END
+        module OneLineModule
+          @foo = 1
+        end
+      END
+      @excellent.check_content(content)
+
+      @excellent.errors.should be_empty
+    end
+
+    it 'should reject modules with more lines than the threshold' do
+      content = <<-END
+        module TwoLineModule
+          @foo = 1
+          @bar = 2
+        end
+      END
+      @excellent.check_content(content)
+      errors = @excellent.errors
+
+      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.'
+    end
+
+  end
+
+end

data/spec/checks/module_name_check_spec.rb

@@ -0,0 +1,37 @@
+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)
+  end
+
+  describe '#evaluate' do
+
+    it 'should accept camel case module names starting in capitals' do
+      content = <<-END
+        module GoodModuleName 
+        end
+      END
+      @excellent.check_content(content)
+
+      @excellent.errors.should be_empty
+    end
+
+    it 'should reject module names with underscores' do
+      content = <<-END
+        module Bad_ModuleName 
+        end
+      END
+      @excellent.check_content(content)
+      errors = @excellent.errors
+
+      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.'
+    end
+
+  end
+
+end

data/spec/checks/parameter_number_check_spec.rb

@@ -0,0 +1,61 @@
+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 }))
+  end
+
+  describe '#evaluate' do
+
+    it 'should accept methods with less parameters than the threshold' do
+      content = <<-END
+        def zero_parameter_method
+        end
+      END
+      @excellent.check_content(content)
+
+      @excellent.errors.should be_empty
+    end
+
+    it 'should accept methods with the same number of parameters as the threshold' do
+      content = <<-END
+        def one_parameter_method(first_parameter)
+        end
+      END
+      @excellent.check_content(content)
+
+      @excellent.errors.should be_empty
+    end
+
+    it 'should reject methods with more parameters than the threshold' do
+      content = <<-END
+        def two_parameter_method(first_parameter, second_parameter)
+        end
+      END
+
+      verify_error_found(content)
+    end
+
+    it 'should cope with default values on parameters' do
+      content = <<-END
+        def two_parameter_method(first_parameter = 1, second_parameter = 2)
+        end
+      END
+
+      verify_error_found(content)
+    end
+
+  end
+
+  def verify_error_found(content)
+    @excellent.check_content(content)
+    errors = @excellent.errors
+
+    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.'
+  end
+
+end

data/spec/core/extensions/underscore_spec.rb

@@ -0,0 +1,13 @@
+require File.expand_path(File.dirname(__FILE__) + '/../../spec_helper')
+
+describe String do
+
+  describe '#underscore' do
+
+    it 'should correctly add underscores to "AbcMetricMethodCheck"' do
+      'AbcMetricMethodCheck'.underscore.should == 'abc_metric_method_check'
+    end
+
+  end
+
+end

data/spec/spec_helper.rb

@@ -0,0 +1,11 @@
+$LOAD_PATH.unshift(File.expand_path(File.dirname(__FILE__) + "/../lib"))
+require 'simplabs/excellent'
+require 'spec'
+
+begin
+  require 'ruby-debug'
+  Debugger.start
+  Debugger.settings[:autoeval] = true if Debugger.respond_to?(:settings)
+rescue LoadError
+  # ruby-debug wasn't available so neither can the debugging be
+end

metadata

@@ -0,0 +1,115 @@
+--- !ruby/object:Gem::Specification 
+name: simplabs-excellent
+version: !ruby/object:Gem::Version 
+  version: 1.0.0
+platform: ruby
+authors: 
+- Marty Andrews
+- Marco Otte-Witte
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2009-05-06 00:00:00 -07:00
+default_executable: 
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: ruby_parser
+  type: :runtime
+  version_requirement: 
+  version_requirements: !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        version: "2.0"
+    version: 
+description: 
+email: marco.otte-witte@simplabs.com
+executables: 
+- excellent
+extensions: []
+
+extra_rdoc_files: []
+
+files: 
+- History.txt
+- README.markdown
+- VERSION.yml
+- bin/excellent
+- lib/simplabs/excellent/checks/abc_metric_method_check.rb
+- lib/simplabs/excellent/checks/assignment_in_conditional_check.rb
+- lib/simplabs/excellent/checks/base.rb
+- lib/simplabs/excellent/checks/case_missing_else_check.rb
+- lib/simplabs/excellent/checks/class_line_count_check.rb
+- lib/simplabs/excellent/checks/class_name_check.rb
+- lib/simplabs/excellent/checks/class_variable_check.rb
+- lib/simplabs/excellent/checks/control_coupling_check.rb
+- lib/simplabs/excellent/checks/cyclomatic_complexity_block_check.rb
+- lib/simplabs/excellent/checks/cyclomatic_complexity_check.rb
+- lib/simplabs/excellent/checks/cyclomatic_complexity_method_check.rb
+- lib/simplabs/excellent/checks/empty_rescue_body_check.rb
+- lib/simplabs/excellent/checks/for_loop_check.rb
+- lib/simplabs/excellent/checks/line_count_check.rb
+- lib/simplabs/excellent/checks/method_line_count_check.rb
+- lib/simplabs/excellent/checks/method_name_check.rb
+- lib/simplabs/excellent/checks/module_line_count_check.rb
+- lib/simplabs/excellent/checks/module_name_check.rb
+- lib/simplabs/excellent/checks/name_check.rb
+- lib/simplabs/excellent/checks/parameter_number_check.rb
+- lib/simplabs/excellent/checks.rb
+- lib/simplabs/excellent/core/checking_visitor.rb
+- lib/simplabs/excellent/core/error.rb
+- lib/simplabs/excellent/core/extensions/underscore.rb
+- lib/simplabs/excellent/core/iterator_visitor.rb
+- lib/simplabs/excellent/core/parse_tree_runner.rb
+- lib/simplabs/excellent/core/parser.rb
+- lib/simplabs/excellent/core/visitable_sexp.rb
+- lib/simplabs/excellent/core.rb
+- lib/simplabs/excellent.rb
+- spec/checks/abc_metric_method_check_spec.rb
+- spec/checks/assignment_in_conditional_check_spec.rb
+- spec/checks/case_missing_else_check_spec.rb
+- spec/checks/class_line_count_check_spec.rb
+- spec/checks/class_name_check_spec.rb
+- spec/checks/class_variable_check_spec.rb
+- spec/checks/control_coupling_check_spec.rb
+- spec/checks/cyclomatic_complexity_block_check_spec.rb
+- spec/checks/cyclomatic_complexity_method_check_spec.rb
+- spec/checks/empty_rescue_body_check_spec.rb
+- spec/checks/for_loop_check_spec.rb
+- spec/checks/method_line_count_check_spec.rb
+- spec/checks/method_name_check_spec.rb
+- spec/checks/module_line_count_check_spec.rb
+- spec/checks/module_name_check_spec.rb
+- spec/checks/parameter_number_check_spec.rb
+- spec/core/extensions/underscore_spec.rb
+- spec/spec_helper.rb
+has_rdoc: true
+homepage: http://github.com/simplabs/excellent
+post_install_message: 
+rdoc_options: 
+- --inline-source
+- --charset=UTF-8
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      version: "0"
+  version: 
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      version: "0"
+  version: 
+requirements: []
+
+rubyforge_project: 
+rubygems_version: 1.2.0
+signing_key: 
+specification_version: 2
+summary: Source code analysis gem
+test_files: []
+