roodi 1.1.1 → 1.2.0

data/History.txt

@@ -1,3 +1,10 @@
+= 1.2.0
+
+* added module name check.
+* added parameter number check.
+* added module line count check.
+* added class line count check.
+
 = 1.1.1
 
 * I'd initially published to Rubyforge under a 1.0.0 gem, and I've since tried to retrospectively fix up the version number system.  It turns out that Rubyforge caches old gems permanently, so I have to re-start at a larger number again.

data/Manifest.txt

@@ -7,6 +7,7 @@ bin/roodi-describe
 lib/roodi.rb
 lib/roodi/checks.rb
 lib/roodi/checks/check.rb
+lib/roodi/checks/class_line_count_check.rb
 lib/roodi/checks/class_name_check.rb
 lib/roodi/checks/cyclomatic_complexity_block_check.rb
 lib/roodi/checks/cyclomatic_complexity_check.rb
@@ -15,6 +16,9 @@ lib/roodi/checks/empty_rescue_body_check.rb
 lib/roodi/checks/for_loop_check.rb
 lib/roodi/checks/method_line_count_check.rb
 lib/roodi/checks/method_name_check.rb
+lib/roodi/checks/module_line_count_check.rb
+lib/roodi/checks/module_name_check.rb
+lib/roodi/checks/parameter_number_check.rb
 lib/roodi/core.rb
 lib/roodi/core/checking_visitor.rb
 lib/roodi/core/iterator_visitor.rb
@@ -22,11 +26,15 @@ lib/roodi/core/parse_tree_runner.rb
 lib/roodi/core/parser.rb
 lib/roodi/core/visitable_sexp.rb
 roodi.yml
-spec/checks/class_name_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/roodi/checks/class_line_count_check_spec.rb
+spec/roodi/checks/class_name_check_spec.rb
+spec/roodi/checks/cyclomatic_complexity_block_check_spec.rb
+spec/roodi/checks/cyclomatic_complexity_method_check_spec.rb
+spec/roodi/checks/empty_rescue_body_check_spec.rb
+spec/roodi/checks/for_loop_check_spec.rb
+spec/roodi/checks/method_line_count_check_spec.rb
+spec/roodi/checks/method_name_check_spec.rb
+spec/roodi/checks/module_line_count_check_spec.rb
+spec/roodi/checks/module_name_check_spec.rb
+spec/roodi/checks/parameter_number_check_spec.rb
 spec/spec_helper.rb

data/README.txt

@@ -39,6 +39,8 @@ If you're writing a check, it is useful to see the structure of a file the way t
 * ForLoopCheck - Check that for loops aren't used (Use Enumerable.each instead)
 * MethodNameCheck - Check that method names match convention.
 * MethodLineCountCheck - Check that the number of lines in a method is below the threshold.
+* ModuleNameCheck - Check that module names match convention.
+* ParameterNumberCheck - Check that the number of parameters on a method is below the threshold.
 
 == LICENSE:
 

data/lib/roodi.rb

@@ -2,5 +2,5 @@ require 'roodi/checks'
 require 'roodi/core'
 
 module Roodi
-  VERSION = '1.1.1'
+  VERSION = '1.2.0'
 end

data/lib/roodi/checks.rb

@@ -1,7 +1,11 @@
+require 'roodi/checks/class_line_count_check'
 require 'roodi/checks/class_name_check'
 require 'roodi/checks/cyclomatic_complexity_block_check'
 require 'roodi/checks/cyclomatic_complexity_method_check'
 require 'roodi/checks/empty_rescue_body_check'
 require 'roodi/checks/for_loop_check'
-require 'roodi/checks/method_name_check'
 require 'roodi/checks/method_line_count_check'
+require 'roodi/checks/method_name_check'
+require 'roodi/checks/module_line_count_check'
+require 'roodi/checks/module_name_check'
+require 'roodi/checks/parameter_number_check'

data/lib/roodi/checks/class_line_count_check.rb

@@ -0,0 +1,30 @@
+require 'roodi/checks/check'
+
+module Roodi
+  module Checks
+    class ClassLineCountCheck < Check
+      def initialize(line_count = 300)
+        super()
+        @line_count = line_count
+      end
+      
+      def interesting_nodes
+        [:class]
+      end
+
+      def evaluate(node)
+        line_count = count_lines(node)
+        add_error "Class \"#{node[1]}\" has #{line_count} lines.  It should have #{@line_count} or less." unless line_count <= @line_count
+      end
+  
+      private
+  
+      def count_lines(node)
+        count = 0
+        count = count + 1 if node.node_type == :newline
+        node.children.each {|node| count += count_lines(node)}
+        count
+      end
+    end
+  end
+end

data/lib/roodi/checks/module_line_count_check.rb

@@ -0,0 +1,30 @@
+require 'roodi/checks/check'
+
+module Roodi
+  module Checks
+    class ModuleLineCountCheck < Check
+      def initialize(line_count = 300)
+        super()
+        @line_count = line_count
+      end
+      
+      def interesting_nodes
+        [:module]
+      end
+
+      def evaluate(node)
+        line_count = count_lines(node)
+        add_error "Module \"#{node[1]}\" has #{line_count} lines.  It should have #{@line_count} or less." unless line_count <= @line_count
+      end
+  
+      private
+  
+      def count_lines(node)
+        count = 0
+        count = count + 1 if node.node_type == :newline
+        node.children.each {|node| count += count_lines(node)}
+        count
+      end
+    end
+  end
+end

data/lib/roodi/checks/module_name_check.rb

@@ -0,0 +1,17 @@
+require 'roodi/checks/check'
+
+module Roodi
+  module Checks
+    class ModuleNameCheck < Check
+      def interesting_nodes
+        [:module]
+      end
+  
+      def evaluate(node)
+        class_name = node[1].class == Symbol ? node[1] : node[1].last
+        pattern = /^[A-Z][a-zA-Z0-9]*$/
+        add_error "Module name \"#{node[1]}\" should match pattern #{pattern.inspect}" unless class_name.to_s =~ pattern
+      end
+    end
+  end
+end

data/lib/roodi/checks/parameter_number_check.rb

@@ -0,0 +1,23 @@
+require 'roodi/checks/check'
+
+module Roodi
+  module Checks
+    class ParameterNumberCheck < Check
+      def initialize(parameter_count = 5)
+        super()
+        @parameter_count = parameter_count
+      end
+      
+      def interesting_nodes
+        [:defn]
+      end
+
+      def evaluate(node)
+        method_name = node[1]
+        arguments = node[2][1][1]
+        parameter_count = arguments.inject(-1) { |count, each| count = count + (each.class == Symbol ? 1 : 0) }
+        add_error "Method name \"#{method_name}\" has #{parameter_count} parameters.  It should have #{@parameter_count} or less." unless parameter_count <= @parameter_count
+      end
+    end
+  end
+end

data/lib/roodi/core/parse_tree_runner.rb

@@ -19,13 +19,8 @@ module Roodi
       
       def check(filename, content)
         @checks ||= load_checks
-        begin
-          node = @parser.parse(content, filename)
-          node.accept(IteratorVisitor.new(CheckingVisitor.new(@checks)))
-        rescue Exception => e
-          # puts e
-          puts "#{filename} looks like it's not a valid Ruby file.  Skipping..."
-        end
+        node = parse(filename, content)
+        node.accept(IteratorVisitor.new(CheckingVisitor.new(@checks))) if node
       end
 
       def check_content(content)
@@ -57,6 +52,15 @@ module Roodi
       
       private
       
+      def parse(filename, content)
+        begin
+          @parser.parse(content, filename)
+        rescue Exception => e
+          puts "#{filename} looks like it's not a valid Ruby file.  Skipping..." if ENV["ROODI_DEBUG"]
+          nil
+        end
+      end
+
       def load_checks
         check_objects = []
         check_config = YAML.load_file @config

data/roodi.yml

@@ -1,9 +1,13 @@
 checks:
+- { name: ClassLineCountCheck }
 - { name: ClassNameCheck }
-- { name: CyclomaticComplexityBlockCheck, complexity: 2 }
-- { name: CyclomaticComplexityMethodCheck, complexity: 5 }
+- { name: CyclomaticComplexityBlockCheck }
+- { name: CyclomaticComplexityMethodCheck }
 - { name: EmptyRescueBodyCheck }
 - { name: ForLoopCheck }
 - { name: MethodLineCountCheck }
 - { name: MethodNameCheck }
+- { name: ModuleLineCountCheck }
+- { name: ModuleNameCheck }
+- { name: ParameterNumberCheck }
 

data/spec/roodi/checks/class_line_count_check_spec.rb

@@ -0,0 +1,39 @@
+require File.expand_path(File.dirname(__FILE__) + '/../../spec_helper')
+
+describe Roodi::Checks::ClassLineCountCheck do
+  before(:each) do
+    @roodi = Roodi::Core::ParseTreeRunner.new(Roodi::Checks::ClassLineCountCheck.new(1))
+  end
+  
+  it "should accept classes with less lines than the threshold" do
+    content = <<-END
+    class ZeroLineClass
+    end
+    END
+    @roodi.check_content(content)
+    @roodi.errors.should be_empty
+  end
+
+  it "should accept classes with the same number of lines as the threshold" do
+    content = <<-END
+    Class OneLineClass
+      @foo = 1
+    end
+    END
+    @roodi.check_content(content)
+    @roodi.errors.should be_empty
+  end
+
+  it "should reject classes with more lines than the threshold" do
+    content = <<-END
+    class TwoLineClass
+      @foo = 1
+      @bar = 2
+    end
+    END
+    @roodi.check_content(content)
+    errors = @roodi.errors
+    errors.should_not be_empty
+    errors[0].should eql("dummy-file.rb:1 - Class \"TwoLineClass\" has 2 lines.  It should have 1 or less.")
+  end
+end

data/spec/{checks → roodi/checks}/class_name_check_spec.rb

@@ -1,4 +1,4 @@
-require File.expand_path(File.dirname(__FILE__) + '/../spec_helper')
+require File.expand_path(File.dirname(__FILE__) + '/../../spec_helper')
 
 describe Roodi::Checks::ClassNameCheck do
   before(:each) do

data/spec/{checks → roodi/checks}/cyclomatic_complexity_block_check_spec.rb

@@ -1,4 +1,4 @@
-require File.expand_path(File.dirname(__FILE__) + '/../spec_helper')
+require File.expand_path(File.dirname(__FILE__) + '/../../spec_helper')
 
 describe Roodi::Checks::CyclomaticComplexityBlockCheck do
   before(:each) do

data/spec/{checks → roodi/checks}/cyclomatic_complexity_method_check_spec.rb

@@ -1,4 +1,4 @@
-require File.expand_path(File.dirname(__FILE__) + '/../spec_helper')
+require File.expand_path(File.dirname(__FILE__) + '/../../spec_helper')
 
 describe Roodi::Checks::CyclomaticComplexityMethodCheck do
   before(:each) do

data/spec/{checks → roodi/checks}/empty_rescue_body_check_spec.rb

@@ -1,4 +1,4 @@
-require File.expand_path(File.dirname(__FILE__) + '/../spec_helper')
+require File.expand_path(File.dirname(__FILE__) + '/../../spec_helper')
 
 describe Roodi::Checks::EmptyRescueBodyCheck do
   before(:each) do

data/spec/{checks → roodi/checks}/for_loop_check_spec.rb

@@ -1,4 +1,4 @@
-require File.expand_path(File.dirname(__FILE__) + '/../spec_helper')
+require File.expand_path(File.dirname(__FILE__) + '/../../spec_helper')
 
 describe Roodi::Checks::ForLoopCheck do
   before(:each) do

data/spec/{checks → roodi/checks}/method_line_count_check_spec.rb

@@ -1,4 +1,4 @@
-require File.expand_path(File.dirname(__FILE__) + '/../spec_helper')
+require File.expand_path(File.dirname(__FILE__) + '/../../spec_helper')
 
 describe Roodi::Checks::MethodLineCountCheck do
   before(:each) do

data/spec/{checks → roodi/checks}/method_name_check_spec.rb

@@ -1,4 +1,4 @@
-require File.expand_path(File.dirname(__FILE__) + '/../spec_helper')
+require File.expand_path(File.dirname(__FILE__) + '/../../spec_helper')
 
 describe Roodi::Checks::MethodNameCheck do
   before(:each) do

data/spec/roodi/checks/module_line_count_check_spec.rb

@@ -0,0 +1,39 @@
+require File.expand_path(File.dirname(__FILE__) + '/../../spec_helper')
+
+describe Roodi::Checks::ModuleLineCountCheck do
+  before(:each) do
+    @roodi = Roodi::Core::ParseTreeRunner.new(Roodi::Checks::ModuleLineCountCheck.new(1))
+  end
+  
+  it "should accept modules with less lines than the threshold" do
+    content = <<-END
+    module ZeroLineModule
+    end
+    END
+    @roodi.check_content(content)
+    @roodi.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
+    @roodi.check_content(content)
+    @roodi.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
+    @roodi.check_content(content)
+    errors = @roodi.errors
+    errors.should_not be_empty
+    errors[0].should eql("dummy-file.rb:1 - Module \"TwoLineModule\" has 2 lines.  It should have 1 or less.")
+  end
+end

data/spec/roodi/checks/module_name_check_spec.rb

@@ -0,0 +1,27 @@
+require File.expand_path(File.dirname(__FILE__) + '/../../spec_helper')
+
+describe Roodi::Checks::ModuleNameCheck do
+  before(:each) do
+    @roodi = Roodi::Core::ParseTreeRunner.new(Roodi::Checks::ModuleNameCheck.new)
+  end
+  
+  it "should accept camel case module names starting in capitals" do
+    content = <<-END
+    module GoodModuleName 
+    end
+    END
+    @roodi.check_content(content)
+    @roodi.errors.should be_empty
+  end
+
+  it "should reject module names with underscores" do
+    content = <<-END
+    module Bad_ModuleName 
+    end
+    END
+    @roodi.check_content(content)
+    errors = @roodi.errors
+    errors.should_not be_empty
+    errors[0].should eql("dummy-file.rb:1 - Module name \"Bad_ModuleName\" should match pattern /^[A-Z][a-zA-Z0-9]*$/")
+  end
+end

data/spec/roodi/checks/parameter_number_check_spec.rb

@@ -0,0 +1,47 @@
+require File.expand_path(File.dirname(__FILE__) + '/../../spec_helper')
+
+describe Roodi::Checks::ParameterNumberCheck do
+  before(:each) do
+    @roodi = Roodi::Core::ParseTreeRunner.new(Roodi::Checks::ParameterNumberCheck.new(1))
+  end
+  
+  it "should accept methods with less lines than the threshold" do
+    content = <<-END
+    def zero_parameter_method
+    end
+    END
+    @roodi.check_content(content)
+    @roodi.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
+    @roodi.check_content(content)
+    @roodi.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
+    @roodi.check_content(content)
+    errors = @roodi.errors
+    errors.should_not be_empty
+    errors[0].should eql("dummy-file.rb:1 - Method name \"two_parameter_method\" has 2 parameters.  It should have 1 or less.")
+  end
+
+  it "should cope with default values on parameters" do
+    content = <<-END
+    def two_parameter_method(first_parameter = 1, second_parameter = 2)
+    end
+    END
+    @roodi.check_content(content)
+    errors = @roodi.errors
+    errors.should_not be_empty
+    errors[0].should eql("dummy-file.rb:1 - Method name \"two_parameter_method\" has 2 parameters.  It should have 1 or less.")
+  end
+end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification 
 name: roodi
 version: !ruby/object:Gem::Version 
-  version: 1.1.1
+  version: 1.2.0
 platform: ruby
 authors: 
 - Marty Andrews
@@ -64,6 +64,7 @@ files:
 - lib/roodi.rb
 - lib/roodi/checks.rb
 - lib/roodi/checks/check.rb
+- lib/roodi/checks/class_line_count_check.rb
 - lib/roodi/checks/class_name_check.rb
 - lib/roodi/checks/cyclomatic_complexity_block_check.rb
 - lib/roodi/checks/cyclomatic_complexity_check.rb
@@ -72,6 +73,9 @@ files:
 - lib/roodi/checks/for_loop_check.rb
 - lib/roodi/checks/method_line_count_check.rb
 - lib/roodi/checks/method_name_check.rb
+- lib/roodi/checks/module_line_count_check.rb
+- lib/roodi/checks/module_name_check.rb
+- lib/roodi/checks/parameter_number_check.rb
 - lib/roodi/core.rb
 - lib/roodi/core/checking_visitor.rb
 - lib/roodi/core/iterator_visitor.rb
@@ -79,13 +83,17 @@ files:
 - lib/roodi/core/parser.rb
 - lib/roodi/core/visitable_sexp.rb
 - roodi.yml
-- spec/checks/class_name_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/roodi/checks/class_line_count_check_spec.rb
+- spec/roodi/checks/class_name_check_spec.rb
+- spec/roodi/checks/cyclomatic_complexity_block_check_spec.rb
+- spec/roodi/checks/cyclomatic_complexity_method_check_spec.rb
+- spec/roodi/checks/empty_rescue_body_check_spec.rb
+- spec/roodi/checks/for_loop_check_spec.rb
+- spec/roodi/checks/method_line_count_check_spec.rb
+- spec/roodi/checks/method_name_check_spec.rb
+- spec/roodi/checks/module_line_count_check_spec.rb
+- spec/roodi/checks/module_name_check_spec.rb
+- spec/roodi/checks/parameter_number_check_spec.rb
 - spec/spec_helper.rb
 has_rdoc: true
 homepage: http://roodi.rubyforge.org