roodi 1.3.0 → 1.3.2

data/History.txt

@@ -1,3 +1,7 @@
+= 1.3.1
+
+* wrapped errors in an object to become more usable as an API.
+
 = 1.3.0
 
 * added case missing else check.

data/Manifest.txt

@@ -6,11 +6,14 @@ bin/roodi
 bin/roodi-describe
 lib/roodi.rb
 lib/roodi/checks.rb
+lib/roodi/checks/abc_metric_method_check.rb
 lib/roodi/checks/assignment_in_conditional_check.rb
 lib/roodi/checks/case_missing_else_check.rb
 lib/roodi/checks/check.rb
 lib/roodi/checks/class_line_count_check.rb
 lib/roodi/checks/class_name_check.rb
+lib/roodi/checks/class_variable_check.rb
+lib/roodi/checks/control_coupling_check.rb
 lib/roodi/checks/cyclomatic_complexity_block_check.rb
 lib/roodi/checks/cyclomatic_complexity_check.rb
 lib/roodi/checks/cyclomatic_complexity_method_check.rb
@@ -25,15 +28,19 @@ lib/roodi/checks/name_check.rb
 lib/roodi/checks/parameter_number_check.rb
 lib/roodi/core.rb
 lib/roodi/core/checking_visitor.rb
+lib/roodi/core/error.rb
 lib/roodi/core/iterator_visitor.rb
 lib/roodi/core/parse_tree_runner.rb
 lib/roodi/core/parser.rb
 lib/roodi/core/visitable_sexp.rb
 roodi.yml
+spec/roodi/checks/abc_metric_method_check_spec.rb
 spec/roodi/checks/assignment_in_conditional_check_spec.rb
 spec/roodi/checks/case_missing_else_check_spec.rb
 spec/roodi/checks/class_line_count_check_spec.rb
 spec/roodi/checks/class_name_check_spec.rb
+spec/roodi/checks/class_variable_check_spec.rb
+spec/roodi/checks/control_coupling_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

data/Rakefile

@@ -30,3 +30,4 @@ task :roodi do
   roodi(Dir.glob(pattern))
 end
 
+task :default => :spec

data/lib/roodi.rb

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

data/lib/roodi/checks.rb

@@ -1,7 +1,10 @@
+require 'roodi/checks/abc_metric_method_check'
 require 'roodi/checks/assignment_in_conditional_check'
 require 'roodi/checks/case_missing_else_check'
 require 'roodi/checks/class_line_count_check'
 require 'roodi/checks/class_name_check'
+require 'roodi/checks/class_variable_check'
+require 'roodi/checks/control_coupling_check'
 require 'roodi/checks/cyclomatic_complexity_block_check'
 require 'roodi/checks/cyclomatic_complexity_method_check'
 require 'roodi/checks/empty_rescue_body_check'

data/lib/roodi/checks/abc_metric_method_check.rb

@@ -0,0 +1,77 @@
+require 'roodi/checks/check'
+
+module Roodi
+  module Checks
+    # TODO:  Add summary
+    # 
+    # TODO:  Add detail
+    class AbcMetricMethodCheck < Check
+      # ASSIGNMENTS = [:attrasgn, :attrset, :dasgn_curr, :iasgn, :lasgn, :masgn]
+      ASSIGNMENTS = [:lasgn]
+      # BRANCHES = [:if, :else, :while, :until, :for, :rescue, :case, :when, :and, :or]
+      BRANCHES = [:vcall, :call]
+      # CONDITIONS = [:and, :or]
+      CONDITIONS = [:==, :<=, :>=, :<, :>]
+      #  =  *=  /=  %=  +=  <<=  >>=  &=  |=  ^=
+      OPERATORS = [:*, :/, :%, :+, :<<, :>>, :&, :|, :^]
+      DEFAULT_SCORE = 10
+      
+      def initialize(options = {})
+        super()
+        @score = options['score'] || DEFAULT_SCORE
+      end
+      
+      def interesting_nodes
+        [:defn]
+      end
+
+      def evaluate(node)
+        method_name = node[1]
+        a = count_assignments(node)
+        b = count_branches(node)
+        c = count_conditionals(node)
+        score = Math.sqrt(a*a + b*b + c*c)
+        add_error "Method name \"#{method_name}\" has an ABC metric score of <#{a},#{b},#{c}> = #{score}.  It should be #{@score} or less." unless score <= @score
+      end
+      
+      private
+
+      def count_assignments(node)
+        count = 0
+        count = count + 1 if assignment?(node)
+        node.children.each {|node| count += count_assignments(node)}
+        count
+      end
+      
+      def count_branches(node)
+        count = 0
+        count = count + 1 if branch?(node)
+        node.children.each {|node| count += count_branches(node)}
+        count
+      end
+
+      def count_conditionals(node)
+        count = 0
+        count = count + 1 if conditional?(node)
+        node.children.each {|node| count += count_conditionals(node)}
+        count
+      end
+      
+      def assignment?(node)
+        ASSIGNMENTS.include?(node.node_type)
+      end
+      
+      def branch?(node)
+        BRANCHES.include?(node.node_type) && !conditional?(node) && !operator?(node)
+      end
+      
+      def conditional?(node)
+        (:call == node.node_type) && CONDITIONS.include?(node[2]) 
+      end
+      
+      def operator?(node)
+        (:call == node.node_type) && OPERATORS.include?(node[2]) 
+      end      
+    end
+  end
+end

data/lib/roodi/checks/check.rb

@@ -1,3 +1,5 @@
+require 'roodi/core/error'
+
 module Roodi
   module Checks
     class Check
@@ -11,11 +13,13 @@ module Roodi
   
       def evaluate_node_at_line(node, line)
         @line = line
-        evaluate(node)
+        eval_method = "evaluate_#{node.node_type}"
+        self.send(eval_method, node) if self.respond_to? eval_method
+        evaluate(node) if self.respond_to? :evaluate
       end
   
       def add_error(error, offset = 0)
-        @errors << "#{position(offset)} - #{error}"
+        @errors << Roodi::Core::Error.new("#{@line[2]}", "#{@line[1] + offset}", error)
       end
   
       def errors

data/lib/roodi/checks/class_name_check.rb

@@ -4,7 +4,7 @@ module Roodi
   module Checks
     # Checks a class name to make sure it matches the specified pattern.
     # 
-    # Keeping to a consistent nameing convention makes your code easier to read.
+    # Keeping to a consistent naming convention makes your code easier to read.
     class ClassNameCheck < NameCheck
       DEFAULT_PATTERN = /^[A-Z][a-zA-Z0-9]*$/
       

data/lib/roodi/checks/class_variable_check.rb

@@ -0,0 +1,24 @@
+require 'roodi/checks/check'
+
+module Roodi
+  module Checks
+    # Checks to make sure class variables are not being used..
+    # 
+    # Class variables in Ruby have a complicated inheritance policy, and their use 
+    # can lead to mistakes.  Often an alternate design can be used to solve the 
+    # problem instead.
+    #
+    # This check is looking for a code smell rather than a definite error.  If you're 
+    # sure that you're doing the right thing, try turning this check off in your 
+    # config file.
+    class ClassVariableCheck < Check
+      def interesting_nodes
+        [:cvar]
+      end
+
+      def evaluate(node)
+        add_error "Don't use class variables. You might want to try a different design."
+      end
+    end
+  end
+end

data/lib/roodi/checks/control_coupling_check.rb

@@ -0,0 +1,21 @@
+require 'roodi/checks/check'
+
+module Roodi
+  module Checks
+    class ControlCouplingCheck < Check
+      def interesting_nodes
+        [:defn, :lvar]
+      end
+
+      def evaluate_defn(node)
+        @method_name = node[1]
+        @arguments = node[2][1][1]
+        @arguments.delete_at 0
+      end
+        
+      def evaluate_lvar(node)
+        add_error "Method \"#{@method_name}\" uses the argument \"#{node[1]}\" for internal control." if @arguments.detect {|each| each == node[1]}
+      end
+    end
+  end
+end

data/lib/roodi/checks/cyclomatic_complexity_check.rb

@@ -3,6 +3,8 @@ require 'roodi/checks/check'
 module Roodi
   module Checks
     class CyclomaticComplexityCheck < Check
+      COMPLEXITY_NODE_TYPES = [:if, :while, :until, :for, :rescue, :case, :when, :and, :or]
+
       def initialize(complexity)
         super()
         @complexity = complexity
@@ -17,10 +19,8 @@ module Roodi
       private
 
       def count_branches(node)
-        complexity_node_types = [:if, :while, :until, :for, :rescue, :case, :when, :and, :or]
-        
         count = 0
-        count = count + 1 if complexity_node_types.include? node.node_type
+        count = count + 1 if COMPLEXITY_NODE_TYPES.include? node.node_type
         node.children.each {|node| count += count_branches(node)}
         count
       end

data/lib/roodi/checks/cyclomatic_complexity_method_check.rb

@@ -25,7 +25,7 @@ module Roodi
 
       def evaluate(node)
         complexity = count_complexity(node)
-        add_error "Method name \"#{node[1]}\" has a cyclomatic complexity is #{complexity}.  It should be #{@complexity} or less." unless complexity <= @complexity
+        add_error "Method name \"#{node[1]}\" cyclomatic complexity is #{complexity}.  It should be #{@complexity} or less." unless complexity <= @complexity
       end
     end
   end

data/lib/roodi/checks/empty_rescue_body_check.rb

@@ -7,6 +7,8 @@ module Roodi
     # When the body of a rescue block is empty, exceptions can get caught and swallowed without
     # any feedback to the user.
     class EmptyRescueBodyCheck < Check
+      STATEMENT_NODES = [:fcall, :return, :attrasgn, :vcall]
+      
       def interesting_nodes
         [:resbody]
       end
@@ -18,10 +20,13 @@ module Roodi
       private
   
       def has_statement?(node)
-        found_statement = false
-        found_statement = found_statement || node.node_type == :fcall
-        node.children.each { |child| found_statement = found_statement || has_statement?(child) }
-        found_statement
+        return true if STATEMENT_NODES.include?(node.node_type)
+        return true if assigning_other_than_exception_to_local_variable?(node) 
+        return true if node.children.any? { |child| has_statement?(child) }
+      end
+
+      def assigning_other_than_exception_to_local_variable?(node)
+        node.node_type == :lasgn && node[2].to_a != [:gvar, :$!]
       end
     end
   end

data/lib/roodi/checks/method_name_check.rb

@@ -6,7 +6,7 @@ module Roodi
     # 
     # Keeping to a consistent nameing convention makes your code easier to read.
     class MethodNameCheck < NameCheck
-      DEFAULT_PATTERN = /^[_a-z<>=\[\]|+-\/\*`]+[_a-z0-9_<>=~@\[\]]*[=!\?]?$/
+      DEFAULT_PATTERN = /^[_a-z<>=\[|+-\/\*`]+[_a-z0-9_<>=~@\[\]]*[=!\?]?$/
       
       def initialize(options = {})
         pattern = options['pattern'] || DEFAULT_PATTERN

data/lib/roodi/core/error.rb

@@ -0,0 +1,17 @@
+module Roodi
+  module Core
+    class Error
+      attr_reader :filename, :line_number, :message
+      
+      def initialize(filename, line_number, message)
+        @filename = filename
+        @line_number = line_number
+        @message = message
+      end
+      
+      def to_s
+        "#{@filename}:#{@line_number} - #{@message}"
+      end
+    end
+  end
+end

data/roodi.yml

@@ -2,12 +2,13 @@ AssignmentInConditionalCheck:    { }
 CaseMissingElseCheck:            { }
 ClassLineCountCheck:             { line_count: 300 }
 ClassNameCheck:                  { pattern: !ruby/regexp /^[A-Z][a-zA-Z0-9]*$/ }
+ClassVariableCheck:              { }
 CyclomaticComplexityBlockCheck:  { complexity: 4 }
 CyclomaticComplexityMethodCheck: { complexity: 8 }
 EmptyRescueBodyCheck:            { }
 ForLoopCheck:                    { }
 MethodLineCountCheck:            { line_count: 20 }
-MethodNameCheck:                 { pattern: !ruby/regexp /^[_a-z<>=\[\]|+-\/\*`]+[_a-z0-9_<>=~@\[\]]*[=!\?]?$/ }
+MethodNameCheck:                 { pattern: !ruby/regexp /^[_a-z<>=\[|+-\/\*`]+[_a-z0-9_<>=~@\[\]]*[=!\?]?$/ }
 ModuleLineCountCheck:            { line_count: 300 }
 ModuleNameCheck:                 { pattern: !ruby/regexp /^[A-Z][a-zA-Z0-9]*$/ }
 ParameterNumberCheck:            { parameter_count: 5 }

data/spec/roodi/checks/abc_metric_method_check_spec.rb

@@ -0,0 +1,89 @@
+require File.expand_path(File.dirname(__FILE__) + '/../../spec_helper')
+
+describe Roodi::Checks::AbcMetricMethodCheck do
+  before(:each) do
+    @roodi = Roodi::Core::ParseTreeRunner.new(Roodi::Checks::AbcMetricMethodCheck.new({'score' => 0}))
+  end
+
+  def verify_content_score(content, a, b, c)
+    score = Math.sqrt(a*a + b*b + c*c)
+    @roodi.check_content(content)
+    errors = @roodi.errors
+    errors.should_not be_empty
+    errors[0].to_s.should eql("dummy-file.rb:1 - Method name \"method_name\" has an ABC metric score of <#{a},#{b},#{c}> = #{score}.  It should be 0 or less.")
+  end
+  
+  # 1. Add one to the assignment count for each occurrence of an assignment 
+  #  operator, excluding constant declarations: 
+  #  
+  #  =  *=  /=  %=  +=  <<=  >>=  &=  |=  ^=
+  describe "when processing assignments" do
+    ['=', '*=', '/=', '%=', '+=', '<<=', '>>=', '&=', '|=', '^='].each do |each|
+      it "should find #{each}" do
+        content = <<-END
+        def method_name
+          foo #{each} 1
+        end
+        END
+        verify_content_score(content, 1, 0, 0)
+      end
+    end
+  end
+  
+  # 3. Add one to the branch count for each function call or class method 
+  #  call. 
+  #  
+  # 4. Add one to the branch count for each occurrence of the new operator. 
+  describe "when processing branches" do
+    it "should find a virtual method call" do
+      content = <<-END
+      def method_name
+        call_foo
+      end
+      END
+      verify_content_score(content, 0, 1, 0)
+    end
+
+    it "should find an explicit method call" do
+      content = <<-END
+      def method_name
+        @object.call_foo
+      end
+      END
+      verify_content_score(content, 0, 1, 0)
+    end
+
+    it "should exclude a condition" do
+      content = <<-END
+      def method_name
+        @object.call_foo < 10
+      end
+      END
+      verify_content_score(content, 0, 1, 1)
+    end
+  end
+  
+  # 5. Add one to the condition count for each use of a conditional operator: 
+  #  
+  #   ==  !=  <=  >=  <  > 
+  #  
+  # 6. Add one to the condition count for each use of the following 
+  #  keywords: 
+  #  
+  #   else  case  default  try  catch  ? 
+  #  
+  # 7. Add one to the condition count for each unary conditional 
+  #  expression. 
+  describe "when processing conditions" do
+    ['==', '!=', '<=', '>=', '<', '>'].each do |each|
+      it "should find #{each}" do
+        content = <<-END
+        def method_name
+          2 #{each} 1
+        end
+        END
+        verify_content_score(content, 0, 0, 1)
+      end
+    end 
+  end
+end

data/spec/roodi/checks/assignment_in_conditional_check_spec.rb

@@ -21,7 +21,7 @@ describe Roodi::Checks::AssignmentInConditionalCheck do
     @roodi.check_content(content)
     errors = @roodi.errors
     errors.should_not be_empty
-    errors[0].should eql("dummy-file.rb:1 - Found = in conditional.  It should probably be an ==")
+    errors[0].to_s.should eql("dummy-file.rb:1 - Found = in conditional.  It should probably be an ==")
   end
 
   it "should reject an assignment inside an unless clause" do
@@ -31,7 +31,7 @@ describe Roodi::Checks::AssignmentInConditionalCheck do
     @roodi.check_content(content)
     errors = @roodi.errors
     errors.should_not be_empty
-    errors[0].should eql("dummy-file.rb:1 - Found = in conditional.  It should probably be an ==")
+    errors[0].to_s.should eql("dummy-file.rb:1 - Found = in conditional.  It should probably be an ==")
   end
 
   it "should reject an assignment inside a while clause" do
@@ -41,7 +41,7 @@ describe Roodi::Checks::AssignmentInConditionalCheck do
     @roodi.check_content(content)
     errors = @roodi.errors
     errors.should_not be_empty
-    errors[0].should eql("dummy-file.rb:1 - Found = in conditional.  It should probably be an ==")
+    errors[0].to_s.should eql("dummy-file.rb:1 - Found = in conditional.  It should probably be an ==")
   end
 
   it "should reject an assignment inside an unless clause" do
@@ -51,7 +51,7 @@ describe Roodi::Checks::AssignmentInConditionalCheck do
     @roodi.check_content(content)
     errors = @roodi.errors
     errors.should_not be_empty
-    errors[0].should eql("dummy-file.rb:1 - Found = in conditional.  It should probably be an ==")
+    errors[0].to_s.should eql("dummy-file.rb:1 - Found = in conditional.  It should probably be an ==")
   end
 
   it "should reject an assignment inside a a ternary operator check clause" do
@@ -61,6 +61,6 @@ describe Roodi::Checks::AssignmentInConditionalCheck do
     @roodi.check_content(content)
     errors = @roodi.errors
     errors.should_not be_empty
-    errors[0].should eql("dummy-file.rb:1 - Found = in conditional.  It should probably be an ==")
+    errors[0].to_s.should eql("dummy-file.rb:1 - Found = in conditional.  It should probably be an ==")
   end
 end

data/spec/roodi/checks/case_missing_else_check_spec.rb

@@ -27,6 +27,6 @@ describe Roodi::Checks::CaseMissingElseCheck do
     @roodi.check_content(content)
     errors = @roodi.errors
     errors.should_not be_empty
-    errors[0].should eql("dummy-file.rb:1 - Case statement is missing an else clause.")
+    errors[0].to_s.should eql("dummy-file.rb:1 - Case statement is missing an else clause.")
   end
 end

data/spec/roodi/checks/class_line_count_check_spec.rb

@@ -34,6 +34,6 @@ describe Roodi::Checks::ClassLineCountCheck do
     @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.")
+    errors[0].to_s.should eql("dummy-file.rb:1 - Class \"TwoLineClass\" has 2 lines.  It should have 1 or less.")
   end
 end

data/spec/roodi/checks/class_name_check_spec.rb

@@ -34,6 +34,6 @@ describe Roodi::Checks::ClassNameCheck do
     @roodi.check_content(content)
     errors = @roodi.errors
     errors.should_not be_empty
-    errors[0].should eql("dummy-file.rb:1 - Class name \"Bad_ClassName\" should match pattern /^[A-Z][a-zA-Z0-9]*$/")
+    errors[0].to_s.should eql("dummy-file.rb:1 - Class name \"Bad_ClassName\" should match pattern /^[A-Z][a-zA-Z0-9]*$/")
   end
 end

data/spec/roodi/checks/class_variable_check_spec.rb

@@ -0,0 +1,17 @@
+require File.expand_path(File.dirname(__FILE__) + '/../../spec_helper')
+
+describe Roodi::Checks::ClassVariableCheck do
+  before(:each) do
+    @roodi = Roodi::Core::ParseTreeRunner.new(Roodi::Checks::ClassVariableCheck.new)
+  end
+  
+  it "should reject class variables" do
+    content = <<-END
+    @@foo
+    END
+    @roodi.check_content(content)
+    errors = @roodi.errors
+    errors.should_not be_empty
+    errors[0].to_s.should eql("dummy-file.rb:1 - Don't use class variables. You might want to try a different design.")
+  end
+end

data/spec/roodi/checks/control_coupling_check_spec.rb

@@ -0,0 +1,23 @@
+require File.expand_path(File.dirname(__FILE__) + '/../../spec_helper')
+
+describe Roodi::Checks::ControlCouplingCheck do
+  before(:each) do
+    @roodi = Roodi::Core::ParseTreeRunner.new(Roodi::Checks::ControlCouplingCheck.new)
+  end
+  
+  it "should reject methods with if checks using a parameter" do
+    content = <<-END
+    def write(quoted, foo)
+     if quoted
+       write_quoted(@value)
+     else
+       puts @value
+      end
+    end
+    END
+    @roodi.check_content(content)
+    errors = @roodi.errors
+    errors.should_not be_empty
+    errors[0].to_s.should eql("dummy-file.rb:2 - Method \"write\" uses the argument \"quoted\" for internal control.")
+  end
+end

data/spec/roodi/checks/cyclomatic_complexity_block_check_spec.rb

@@ -9,7 +9,7 @@ describe Roodi::Checks::CyclomaticComplexityBlockCheck do
     @roodi.check_content(content)
     errors = @roodi.errors
     errors.should_not be_empty
-    errors[0].should eql("dummy-file.rb:2 - Block cyclomatic complexity is #{complexity}.  It should be 0 or less.")
+    errors[0].to_s.should eql("dummy-file.rb:2 - Block cyclomatic complexity is #{complexity}.  It should be 0 or less.")
   end
   
   it "should find a simple block" do

data/spec/roodi/checks/cyclomatic_complexity_method_check_spec.rb

@@ -9,7 +9,7 @@ describe Roodi::Checks::CyclomaticComplexityMethodCheck do
     @roodi.check_content(content)
     errors = @roodi.errors
     errors.should_not be_empty
-    errors[0].should eql("dummy-file.rb:1 - Method name \"method_name\" has a cyclomatic complexity is #{complexity}.  It should be 0 or less.")
+    errors[0].to_s.should eql("dummy-file.rb:1 - Method name \"method_name\" cyclomatic complexity is #{complexity}.  It should be 0 or less.")
   end
   
   it "should find an if block" do

data/spec/roodi/checks/empty_rescue_body_check_spec.rb

@@ -17,6 +17,30 @@ describe Roodi::Checks::EmptyRescueBodyCheck do
     @roodi.errors.should be_empty
   end
 
+  it "should accept a rescue body with a return" do
+    content = <<-END
+    begin
+      call_method
+    rescue
+      return true
+    end
+    END
+    @roodi.check_content(content)
+    @roodi.errors.should be_empty
+  end
+
+  it "should accept a method call that Ruby won't tell apart from a variable (a vcall)" do
+    content = <<-END
+    begin
+      call_method
+    rescue
+      show_error
+    end
+    END
+    @roodi.check_content(content)
+    @roodi.errors.should be_empty
+  end
+
   it "should accept a rescue body with content and a parameter" do
     content = <<-END
     begin
@@ -29,6 +53,30 @@ describe Roodi::Checks::EmptyRescueBodyCheck do
     @roodi.errors.should be_empty
   end
 
+  it "should accept a rescue body with an assignment" do
+    content = <<-END
+    begin
+      call_method
+    rescue Exception => e
+      my_var = 1
+    end
+    END
+    @roodi.check_content(content)
+    @roodi.errors.should be_empty
+  end
+
+  it "should accept a rescue body with an attribute assignment" do
+    content = <<-END
+    begin
+      call_method
+    rescue Exception => e
+      self.var = 1
+    end
+    END
+    @roodi.check_content(content)
+    @roodi.errors.should be_empty
+  end
+
   it "should reject an empty rescue block with no parameter" do
     content = <<-END
     begin
@@ -39,7 +87,7 @@ describe Roodi::Checks::EmptyRescueBodyCheck do
     @roodi.check_content(content)
     errors = @roodi.errors
     errors.should_not be_empty
-    errors[0].should eql("dummy-file.rb:3 - Rescue block should not be empty.")
+    errors[0].to_s.should eql("dummy-file.rb:3 - Rescue block should not be empty.")
   end
 
   it "should reject an empty rescue block with a parameter" do
@@ -52,6 +100,6 @@ describe Roodi::Checks::EmptyRescueBodyCheck do
     @roodi.check_content(content)
     errors = @roodi.errors
     errors.should_not be_empty
-    errors[0].should eql("dummy-file.rb:3 - Rescue block should not be empty.")
+    errors[0].to_s.should eql("dummy-file.rb:3 - Rescue block should not be empty.")
   end
 end

data/spec/roodi/checks/for_loop_check_spec.rb

@@ -13,6 +13,6 @@ describe Roodi::Checks::ForLoopCheck do
     @roodi.check_content(content)
     errors = @roodi.errors
     errors.should_not be_empty
-    errors[0].should eql("dummy-file.rb:1 - Don't use 'for' loops. Use Enumerable.each instead.")
+    errors[0].to_s.should eql("dummy-file.rb:1 - Don't use 'for' loops. Use Enumerable.each instead.")
   end
 end

data/spec/roodi/checks/method_line_count_check_spec.rb

@@ -34,6 +34,6 @@ describe Roodi::Checks::MethodLineCountCheck do
     @roodi.check_content(content)
     errors = @roodi.errors
     errors.should_not be_empty
-    errors[0].should eql("dummy-file.rb:1 - Method \"two_line_method\" has 2 lines.  It should have 1 or less.")
+    errors[0].to_s.should eql("dummy-file.rb:1 - Method \"two_line_method\" has 2 lines.  It should have 1 or less.")
   end
 end

data/spec/roodi/checks/method_name_check_spec.rb

@@ -40,7 +40,7 @@ describe Roodi::Checks::MethodNameCheck do
     @roodi.check_content(content)
     @roodi.errors.should be_empty
   end
-
+  
   it "should accept method names ending an equals sign" do
     content = <<-END
     def good_method_name=
@@ -50,94 +50,17 @@ describe Roodi::Checks::MethodNameCheck do
     @roodi.errors.should be_empty
   end
 
-  it "should accept << as a method name" do
-    content = <<-END
-    def <<
-    end
-    END
-    @roodi.check_content(content)
-    @roodi.errors.should be_empty
-  end
-
-  it "should accept >> as a method name" do
-    content = <<-END
-    def >>
+  describe "when processing non-text based method names" do
+    ['<<', '>>', '==', '=', '<', '<=', '>', '>=', '[]', '[]='].each do |each|
+      it "should accept #{each} as a method name" do
+        content = <<-END
+        def #{each}
+        end
+        END
+        @roodi.check_content(content)
+        @roodi.errors.should be_empty
+      end
     end
-    END
-    @roodi.check_content(content)
-    @roodi.errors.should be_empty
-  end
-
-  it "should accept == as a method name" do
-    content = <<-END
-    def ==
-    end
-    END
-    @roodi.check_content(content)
-    @roodi.errors.should be_empty
-  end
-
-  it "should accept === as a method name" do
-    content = <<-END
-    def ===
-    end
-    END
-    @roodi.check_content(content)
-    @roodi.errors.should be_empty
-  end
-
-  it "should accept < as a method name" do
-    content = <<-END
-    def <
-    end
-    END
-    @roodi.check_content(content)
-    @roodi.errors.should be_empty
-  end
-
-  it "should accept <= as a method name" do
-    content = <<-END
-    def <=
-    end
-    END
-    @roodi.check_content(content)
-    @roodi.errors.should be_empty
-  end
-
-  it "should accept > as a method name" do
-    content = <<-END
-    def >
-    end
-    END
-    @roodi.check_content(content)
-    @roodi.errors.should be_empty
-  end
-
-  it "should accept >= as a method name" do
-    content = <<-END
-    def >=
-    end
-    END
-    @roodi.check_content(content)
-    @roodi.errors.should be_empty
-  end
-
-  it "should accept [] as a method name" do
-    content = <<-END
-    def []
-    end
-    END
-    @roodi.check_content(content)
-    @roodi.errors.should be_empty
-  end
-
-  it "should accept []= as a method name" do
-    content = <<-END
-    def []=
-    end
-    END
-    @roodi.check_content(content)
-    @roodi.errors.should be_empty
   end
 
   it "should reject camel case method names" do
@@ -148,6 +71,6 @@ describe Roodi::Checks::MethodNameCheck do
     @roodi.check_content(content)
     errors = @roodi.errors
     errors.should_not be_empty
-    errors[0].should eql("dummy-file.rb:1 - Method name \"badMethodName\" should match pattern /^[_a-z<>=\\[\\]|+-\\/\\*`]+[_a-z0-9_<>=~@\\[\\]]*[=!\\?]?$/")
+    errors[0].to_s.should eql("dummy-file.rb:1 - Method name \"badMethodName\" should match pattern /^[_a-z<>=\\[|+-\\/\\*`]+[_a-z0-9_<>=~@\\[\\]]*[=!\\?]?$/")
   end
 end

data/spec/roodi/checks/module_line_count_check_spec.rb

@@ -34,6 +34,6 @@ describe Roodi::Checks::ModuleLineCountCheck do
     @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.")
+    errors[0].to_s.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

@@ -22,6 +22,6 @@ describe Roodi::Checks::ModuleNameCheck do
     @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]*$/")
+    errors[0].to_s.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

@@ -31,7 +31,7 @@ describe Roodi::Checks::ParameterNumberCheck do
     @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.")
+    errors[0].to_s.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
@@ -42,6 +42,6 @@ describe Roodi::Checks::ParameterNumberCheck do
     @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.")
+    errors[0].to_s.should eql("dummy-file.rb:1 - Method name \"two_parameter_method\" has 2 parameters.  It should have 1 or less.")
   end
 end

data/spec/spec_helper.rb

@@ -1,2 +1,3 @@
 $LOAD_PATH.unshift(File.expand_path(File.dirname(__FILE__) + "/../lib"))
 require 'roodi'
+require 'spec'

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification 
 name: roodi
 version: !ruby/object:Gem::Version 
-  version: 1.3.0
+  version: 1.3.2
 platform: ruby
 authors: 
 - Marty Andrews
@@ -9,7 +9,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2008-09-19 00:00:00 +10:00
+date: 2009-03-07 00:00:00 +11:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency 
@@ -40,7 +40,7 @@ dependencies:
     requirements: 
     - - ">="
       - !ruby/object:Gem::Version 
-        version: 1.7.0
+        version: 1.8.2
     version: 
 description: Roodi stands for Ruby Object Oriented Design Inferometer.  It parses your Ruby code and warns you about design issues you have based on the checks that is has configured.
 email: 
@@ -63,11 +63,14 @@ files:
 - bin/roodi-describe
 - lib/roodi.rb
 - lib/roodi/checks.rb
+- lib/roodi/checks/abc_metric_method_check.rb
 - lib/roodi/checks/assignment_in_conditional_check.rb
 - lib/roodi/checks/case_missing_else_check.rb
 - lib/roodi/checks/check.rb
 - lib/roodi/checks/class_line_count_check.rb
 - lib/roodi/checks/class_name_check.rb
+- lib/roodi/checks/class_variable_check.rb
+- lib/roodi/checks/control_coupling_check.rb
 - lib/roodi/checks/cyclomatic_complexity_block_check.rb
 - lib/roodi/checks/cyclomatic_complexity_check.rb
 - lib/roodi/checks/cyclomatic_complexity_method_check.rb
@@ -82,15 +85,19 @@ files:
 - lib/roodi/checks/parameter_number_check.rb
 - lib/roodi/core.rb
 - lib/roodi/core/checking_visitor.rb
+- lib/roodi/core/error.rb
 - lib/roodi/core/iterator_visitor.rb
 - lib/roodi/core/parse_tree_runner.rb
 - lib/roodi/core/parser.rb
 - lib/roodi/core/visitable_sexp.rb
 - roodi.yml
+- spec/roodi/checks/abc_metric_method_check_spec.rb
 - spec/roodi/checks/assignment_in_conditional_check_spec.rb
 - spec/roodi/checks/case_missing_else_check_spec.rb
 - spec/roodi/checks/class_line_count_check_spec.rb
 - spec/roodi/checks/class_name_check_spec.rb
+- spec/roodi/checks/class_variable_check_spec.rb
+- spec/roodi/checks/control_coupling_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