roodi 1.4.0 → 2.0.0

data/History.txt

@@ -1,3 +1,11 @@
+= 2.0.0
+
+* Changed internal structure to use a more pure visitor like pattern.
+* Got *much* faster as a result of the change.
+* Design change fixed 'feature' where nested blocks would all get listed if the inner one exceeded complexity.
+* Outline for NPath complexity check is now possible.  Not working yet though.
+* Removed dependency on facets library.
+
 = 1.4.0
 
 * Upgraded from ParseTree to ruby_parser.

data/Manifest.txt

@@ -25,11 +25,12 @@ 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/name_check.rb
+lib/roodi/checks/npath_complexity_check.rb
+lib/roodi/checks/npath_complexity_method_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/parser.rb
 lib/roodi/core/runner.rb
 lib/roodi/core/visitable_sexp.rb
@@ -50,5 +51,6 @@ 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/npath_complexity_method_check_spec.rb
 spec/roodi/checks/parameter_number_check_spec.rb
 spec/spec_helper.rb

data/Rakefile

@@ -8,12 +8,12 @@ require 'roodi'
 
 Hoe.new('roodi', Roodi::VERSION) do |p|
   p.developer('Marty Andrews', 'marty@cogentconsulting.com.au')
-  p.extra_deps = ['ruby_parser', 'facets']
+  p.extra_deps = ['ruby_parser']
   p.remote_rdoc_dir = ''
 end
 
 def roodi(ruby_files)
-  roodi = Roodi::Core::ParseTreeRunner.new
+  roodi = Roodi::Core::Runner.new
   ruby_files.each { |file| roodi.check_file(file) }
   roodi.errors.each {|error| puts error}
   puts "\nFound #{roodi.errors.size} errors."

data/lib/roodi.rb

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

data/lib/roodi/checks.rb

@@ -13,4 +13,5 @@ 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/npath_complexity_method_check'
 require 'roodi/checks/parameter_number_check'

data/lib/roodi/checks/abc_metric_method_check.rb

@@ -25,7 +25,7 @@ module Roodi
         [:defn]
       end
 
-      def evaluate(node)
+      def evaluate_start(node)
         method_name = node[1]
         a = count_assignments(node)
         b = count_branches(node)

data/lib/roodi/checks/assignment_in_conditional_check.rb

@@ -15,7 +15,7 @@ module Roodi
         [:if, :while]
       end
 
-      def evaluate(node)
+      def evaluate_start(node)
         add_error("Found = in conditional.  It should probably be an ==") if has_assignment?(node[1])
       end
       
@@ -24,7 +24,9 @@ module Roodi
       def has_assignment?(node)
         found_assignment = false
         found_assignment = found_assignment || node.node_type == :lasgn
-        node.children.each { |child| found_assignment = found_assignment || has_assignment?(child) }
+        if (node.node_type == :and or node.node_type == :or)
+          node.children.each { |child| found_assignment = found_assignment || has_assignment?(child) }
+        end
         found_assignment
       end
     end

data/lib/roodi/checks/case_missing_else_check.rb

@@ -12,7 +12,7 @@ module Roodi
         [:case]
       end
   
-      def evaluate(node)
+      def evaluate_start(node)
         add_error "Case statement is missing an else clause." unless node.last
       end
     end

data/lib/roodi/checks/check.rb

@@ -3,19 +3,43 @@ require 'roodi/core/error'
 module Roodi
   module Checks
     class Check
+      NODE_TYPES = [:defn, :module, :resbody, :lvar, :cvar, :class, :if, :while, :until, :for, :rescue, :case, :when, :and, :or]
+
       def initialize
         @errors = []
       end
   
+      NODE_TYPES.each do |node|
+        start_node_method = "evaluate_start_#{node}"
+        end_node_method = "evaluate_end_#{node}"
+        define_method(start_node_method) { } unless self.respond_to?(start_node_method)
+        define_method(end_node_method) { } unless self.respond_to?(end_node_method)
+      end
+
       def position(offset = 0)
         "#{@line[2]}:#{@line[1] + offset}"
       end
+      
+      def evaluate_start(node)
+      end
+
+      def evaluate_end(node)
+      end
 
-      def evaluate_node(node)
+      def evaluate_node(position, node)
         @node = 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
+        eval_method = "evaluate_#{position}_#{node.node_type}"
+        self.send(eval_method, node)
+      end
+
+      def evaluate_node_start(node)
+        evaluate_node(:start, node)
+        evaluate_start(node)
+      end
+  
+      def evaluate_node_end(node)
+        evaluate_node(:end, node)
+        evaluate_end(node)
       end
   
       def add_error(error)

data/lib/roodi/checks/class_variable_check.rb

@@ -16,7 +16,7 @@ module Roodi
         [:cvar]
       end
 
-      def evaluate(node)
+      def evaluate_start(node)
         add_error "Don't use class variables. You might want to try a different design."
       end
     end

data/lib/roodi/checks/control_coupling_check.rb

@@ -7,12 +7,12 @@ module Roodi
         [:defn, :lvar]
       end
 
-      def evaluate_defn(node)
+      def evaluate_start_defn(node)
         @method_name = node[1]
         @arguments = node[2][1..-1]
       end
         
-      def evaluate_lvar(node)
+      def evaluate_start_lvar(node)
         add_error "Method \"#{@method_name}\" uses the argument \"#{node[1]}\" for internal control." if @arguments.detect {|each| each == node[1]}
       end
     end

data/lib/roodi/checks/cyclomatic_complexity_block_check.rb

@@ -20,12 +20,19 @@ module Roodi
       end
       
       def interesting_nodes
-        [:iter]
+        [:iter] + COMPLEXITY_NODE_TYPES
       end
 
-      def evaluate(node)
-        complexity = count_complexity(node)
-        add_error "Block cyclomatic complexity is #{complexity}.  It should be #{@complexity} or less." unless complexity <= @complexity
+      def evaluate_start_iter(node)
+        increase_depth
+      end
+
+      def evaluate_end_iter(node)
+        decrease_depth
+      end
+      
+      def evaluate_matching_end
+        add_error "Block cyclomatic complexity is #{@count}.  It should be #{@complexity} or less." unless @count <= @complexity
       end
     end
   end

data/lib/roodi/checks/cyclomatic_complexity_check.rb

@@ -8,6 +8,14 @@ module Roodi
       def initialize(complexity)
         super()
         @complexity = complexity
+        @count = 0
+        @counting = 0
+      end
+      
+      COMPLEXITY_NODE_TYPES.each do |type|
+        define_method "evaluate_start_#{type}" do
+          @count = @count + 1 if counting?
+        end
       end
       
       protected
@@ -15,14 +23,24 @@ module Roodi
       def count_complexity(node)
         count_branches(node) + 1
       end
+      
+      def increase_depth
+        @count = 1 unless counting?
+        @counting = @counting + 1
+      end
 
+      def decrease_depth
+        @counting = @counting - 1
+        if @counting <= 0
+          @counting = 0
+          evaluate_matching_end
+        end
+      end
+      
       private
-
-      def count_branches(node)
-        count = 0
-        count = count + 1 if COMPLEXITY_NODE_TYPES.include? node.node_type
-        node.children.each {|node| count += count_branches(node)}
-        count
+      
+      def counting?
+        @counting > 0
       end
     end
   end

data/lib/roodi/checks/cyclomatic_complexity_method_check.rb

@@ -20,12 +20,20 @@ module Roodi
       end
       
       def interesting_nodes
-        [:defn]
+        [:defn] + COMPLEXITY_NODE_TYPES
       end
 
-      def evaluate(node)
-        complexity = count_complexity(node)
-        add_error "Method name \"#{node[1]}\" cyclomatic complexity is #{complexity}.  It should be #{@complexity} or less." unless complexity <= @complexity
+      def evaluate_start_defn(node)
+        @method_name = @node[1]
+        increase_depth
+      end
+
+      def evaluate_end_defn(node)
+        decrease_depth
+      end
+      
+      def evaluate_matching_end
+        add_error "Method name \"#{@method_name}\" cyclomatic complexity is #{@count}.  It should be #{@complexity} or less." unless @count <= @complexity
       end
     end
   end

data/lib/roodi/checks/empty_rescue_body_check.rb

@@ -7,26 +7,25 @@ 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, :nil, :call]
+      STATEMENT_NODES = [:fcall, :return, :attrasgn, :vcall, :nil, :call, :lasgn]
       
       def interesting_nodes
         [:resbody]
       end
 
-      def evaluate(node)
-        add_error("Rescue block should not be empty.") unless has_statement?(node)
+      def evaluate_start(node)
+        add_error("Rescue block should not be empty.") unless has_statement?(node.children[1])
       end
   
       private
   
       def has_statement?(node)
-        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) }
+        false unless node
+        has_local_statement?(node) or node.children.any? { |child| has_statement?(child) } if node
       end
 
-      def assigning_other_than_exception_to_local_variable?(node)
-        node.node_type == :lasgn && node[2].to_a != [:gvar, :$!]
+      def has_local_statement?(node)
+        STATEMENT_NODES.include?(node.node_type)
       end
     end
   end

data/lib/roodi/checks/for_loop_check.rb

@@ -12,7 +12,7 @@ module Roodi
         [:for]
       end
 
-      def evaluate(node)
+      def evaluate_start(node)
         add_error "Don't use 'for' loops. Use Enumerable.each instead."
       end
     end

data/lib/roodi/checks/line_count_check.rb

@@ -14,7 +14,7 @@ module Roodi
         @interesting_nodes
       end
 
-      def evaluate(node)
+      def evaluate_start(node)
         line_count = count_lines(node)
         add_error "#{@message_prefix} \"#{node[1]}\" has #{line_count} lines.  It should have #{@line_count} or less." unless line_count <= @line_count
       end

data/lib/roodi/checks/name_check.rb

@@ -14,7 +14,7 @@ module Roodi
         @interesting_nodes
       end
 
-      def evaluate(node)
+      def evaluate_start(node)
         name = find_name(node)
         add_error "#{@message_prefix} name \"#{name}\" should match pattern #{@pattern.inspect}" unless name.to_s =~ @pattern
       end

data/lib/roodi/checks/npath_complexity_check.rb

@@ -0,0 +1,73 @@
+require 'roodi/checks/check'
+
+module Roodi
+  module Checks
+    class NpathComplexityCheck < Check
+      # , :when, :and, :or
+      MULTIPLYING_NODE_TYPES = [:if, :while, :until, :for, :case]
+      ADDING_NODE_TYPES = [:rescue]
+      COMPLEXITY_NODE_TYPES = MULTIPLYING_NODE_TYPES + ADDING_NODE_TYPES
+
+      def initialize(complexity)
+        super()
+        @complexity = complexity
+        @value_stack = []
+        @current_value = 1
+      end
+      
+      def evalute_start_if(node)
+        push_value
+      end
+      
+      def evalute_start_while(node)
+        push_value
+      end
+
+      def evalute_start_until(node)
+        push_value
+      end
+
+      def evalute_start_for(node)
+        push_value
+      end
+
+      def evalute_start_case(node)
+        push_value
+      end
+
+      def evalute_start_rescue(node)
+        push_value
+      end
+      
+      MULTIPLYING_NODE_TYPES.each do |type|
+        define_method "evaluate_end_#{type}" do |node|
+          leave_multiplying_conditional
+        end
+      end
+
+      ADDING_NODE_TYPES.each do |type|
+        define_method "evaluate_end_#{type}" do |node|
+          leave_multiplying_conditional
+        end
+      end
+      
+      protected
+      
+      def push_value
+        @value_stack.push @current_value
+        @current_value = 1
+      end
+
+      def leave_multiplying_conditional
+        pop = @value_stack.pop
+        @current_value = (@current_value + 1) * pop
+      end
+      
+      def leave_adding_conditional
+        pop = @value_stack.pop
+        puts "#{type}, so adding #{pop}"
+        @current_value = @current_value - 1 + pop
+      end
+    end
+  end
+end

data/lib/roodi/checks/npath_complexity_method_check.rb

@@ -0,0 +1,28 @@
+require 'roodi/checks/npath_complexity_check'
+
+module Roodi
+  module Checks
+    # Checks Npath complexity of a method against a specified limit. 
+    class NpathComplexityMethodCheck < NpathComplexityCheck
+      DEFAULT_COMPLEXITY = 8
+      
+      def initialize(options = {})
+        complexity = options['complexity'] || DEFAULT_COMPLEXITY
+        super(complexity)
+      end
+      
+      def interesting_nodes
+        [:defn] + COMPLEXITY_NODE_TYPES
+      end
+
+      def evaluate_start_defn(node)
+        @method_name = @node[1]
+        push_value
+      end
+
+      def evaluate_end_defn(node)
+        add_error "Method name \"#{@method_name}\" n-path complexity is #{@current_value}.  It should be #{@complexity} or less." unless @current_value <= @complexity
+      end
+    end
+  end
+end

data/lib/roodi/checks/parameter_number_check.rb

@@ -19,7 +19,7 @@ module Roodi
         [:defn]
       end
 
-      def evaluate(node)
+      def evaluate_start(node)
         method_name = node[1]
         arguments = node[2]
         parameter_count = arguments.inject(-1) { |count, each| count = count + (each.class == Symbol ? 1 : 0) }

data/lib/roodi/core/checking_visitor.rb

@@ -13,11 +13,14 @@ module Roodi
         end
       end
 
-      def visit(node)
+    	def visit(node)
         checks = @checks[node.node_type]
-        checks.each {|check| check.evaluate_node(node)} unless checks.nil?
-        nil
-      end
+        checks.each {|check| check.evaluate_node_start(node)} unless checks.nil?
+
+    		node.visitable_children.each {|sexp| sexp.accept(self)}
+
+        checks.each {|check| check.evaluate_node_end(node)} unless checks.nil?
+    	end
     end
   end
 end

data/lib/roodi/core/parser.rb

@@ -1,7 +1,5 @@
 require 'rubygems'
 require 'ruby_parser'
-require 'facets'
-
 
 module Roodi
   module Core
@@ -14,6 +12,15 @@ module Roodi
       
       private
       
+      def silence_stream(stream)
+        old_stream = stream.dup
+        stream.reopen(RUBY_PLATFORM =~ /mswin/ ? 'NUL:' : '/dev/null')
+        stream.sync = true
+        yield
+      ensure
+        stream.reopen(old_stream)
+      end
+      
       def silent_parse(content, filename)
         @parser ||= RubyParser.new
         @parser.parse(content, filename)

data/lib/roodi/core/runner.rb

@@ -2,7 +2,6 @@ require 'pp'
 require 'yaml'
 
 require 'roodi/core/checking_visitor'
-require 'roodi/core/iterator_visitor'
 require 'roodi/core/parser'
 require 'roodi/core/visitable_sexp'
 
@@ -16,13 +15,14 @@ module Roodi
       def initialize(*checks)
         @config = DEFAULT_CONFIG
         @checks = checks unless checks.empty?
+        @checks ||= load_checks
+        @checker ||= CheckingVisitor.new(@checks)
         @parser = Parser.new
       end
       
       def check(filename, content)
-        @checks ||= load_checks
         node = parse(filename, content)
-        node.accept(IteratorVisitor.new(CheckingVisitor.new(@checks))) if node
+        node.accept(@checker) if node
       end
 
       def check_content(content)

data/lib/roodi/core/visitable_sexp.rb

@@ -13,8 +13,13 @@ class Sexp
   def children
     find_all { | sexp | Sexp === sexp }
   end
-
+  
   def is_language_node?
     first.class == Symbol
   end
+  
+  def visitable_children
+    parent = is_language_node? ? sexp_body : self
+    parent.children
+  end
 end

data/spec/roodi/checks/assignment_in_conditional_check_spec.rb

@@ -61,4 +61,45 @@ describe Roodi::Checks::AssignmentInConditionalCheck do
     errors.should_not be_empty
     errors[0].to_s.should eql("dummy-file.rb:1 - Found = in conditional.  It should probably be an ==")
   end
+
+  it "should reject an assignment after an 'and'" do
+    content = <<-END
+      call_foo if bar and bam = baz
+    END
+    @roodi.check_content(content)
+    errors = @roodi.errors
+    errors.should_not be_empty
+    errors[0].to_s.should eql("dummy-file.rb:1 - Found = in conditional.  It should probably be an ==")
+  end
+
+
+  it "should reject an assignment after an 'or'" do
+    content = <<-END
+      call_foo if bar or bam = baz
+    END
+    @roodi.check_content(content)
+    errors = @roodi.errors
+    errors.should_not be_empty
+    errors[0].to_s.should eql("dummy-file.rb:1 - Found = in conditional.  It should probably be an ==")
+  end
+
+  it "should reject an assignment after an '&&'" do
+    content = <<-END
+      call_foo if bar && bam = baz
+    END
+    @roodi.check_content(content)
+    errors = @roodi.errors
+    errors.should_not be_empty
+    errors[0].to_s.should eql("dummy-file.rb:1 - Found = in conditional.  It should probably be an ==")
+  end
+
+  it "should reject an assignment after an '||'" do
+    content = <<-END
+      call_foo if bar || bam = baz
+    END
+    @roodi.check_content(content)
+    errors = @roodi.errors
+    errors.should_not be_empty
+    errors[0].to_s.should eql("dummy-file.rb:1 - Found = in conditional.  It should probably be an ==")
+  end
 end

data/spec/roodi/checks/cyclomatic_complexity_block_check_spec.rb

@@ -33,4 +33,35 @@ describe Roodi::Checks::CyclomaticComplexityBlockCheck do
     END
     verify_content_complexity(content, 2)
   end
+  
+  it "should evaluate real example 1 correctly" do
+    content = <<-END
+    def method_name
+      UNIXMbox.lock(@filename) {|f|
+          begin
+            f.each do |line|
+              if /\AFrom / === line
+                w.close if w
+                File.utime time, time, port.filename if time
+
+                port = @real.new_port
+                w = port.wopen
+                time = fromline2time(line)
+              else
+                w.print line if w
+              end
+            end
+          ensure
+            if w and not w.closed?
+              w.close
+              File.utime time, time, port.filename if time
+            end
+          end
+          f.truncate(0) unless @readonly
+          @updated = Time.now
+      }
+    end
+    END
+    verify_content_complexity(content, 9)
+  end
 end

data/spec/roodi/checks/cyclomatic_complexity_method_check_spec.rb

@@ -180,4 +180,21 @@ describe Roodi::Checks::CyclomaticComplexityMethodCheck do
     verify_content_complexity(content, 5)
   end
 
+  it "should count only a single method" do
+    content = <<-END
+    def method_name_1
+      call_foo if some_condition
+    end
+    def method_name_2
+      call_foo if some_condition
+    end
+    END
+    
+    @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_1\" cyclomatic complexity is 2.  It should be 0 or less.")
+    errors[1].to_s.should eql("dummy-file.rb:4 - Method name \"method_name_2\" cyclomatic complexity is 2.  It should be 0 or less.")
+  end
+
 end

data/spec/roodi/checks/npath_complexity_method_check_spec.rb

@@ -0,0 +1,53 @@
+require File.expand_path(File.dirname(__FILE__) + '/../../spec_helper')
+
+describe Roodi::Checks::NpathComplexityMethodCheck do
+  before(:each) do
+    @roodi = Roodi::Core::Runner.new(Roodi::Checks::NpathComplexityMethodCheck.new({'complexity' => 0}))
+  end
+
+  def verify_content_complexity(content, complexity)
+    @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\" n-path complexity is #{complexity}.  It should be 0 or less.")
+  end
+  
+  it "should default to 1" do
+    content = <<-END
+    def method_name
+    end
+    END
+    verify_content_complexity(content, 1)
+  end
+  
+  it "should find an if block" do
+    content = <<-END
+    def method_name
+      call_foo if some_condition
+    end
+    END
+    verify_content_complexity(content, 2)
+  end
+  
+  it "should find nested if block" do
+    pending "NPath Complexity implementation that can support 'else' blocks"
+    content = <<-END
+    def method_name
+      if (value1)
+        foo
+      else
+        bar
+      end
+      if (value2)
+        bam
+      else
+        baz
+      end
+      if (value3)
+        one
+      end
+    end
+    END
+    verify_content_complexity(content, 8)
+  end
+end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification 
 name: roodi
 version: !ruby/object:Gem::Version 
-  version: 1.4.0
+  version: 2.0.0
 platform: ruby
 authors: 
 - Marty Andrews
@@ -9,7 +9,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2009-05-08 00:00:00 +10:00
+date: 2009-08-23 00:00:00 +10:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency 
@@ -22,16 +22,6 @@ dependencies:
       - !ruby/object:Gem::Version 
         version: "0"
     version: 
-- !ruby/object:Gem::Dependency 
-  name: facets
-  type: :runtime
-  version_requirement: 
-  version_requirements: !ruby/object:Gem::Requirement 
-    requirements: 
-    - - ">="
-      - !ruby/object:Gem::Version 
-        version: "0"
-    version: 
 - !ruby/object:Gem::Dependency 
   name: hoe
   type: :development
@@ -82,11 +72,12 @@ files:
 - lib/roodi/checks/module_line_count_check.rb
 - lib/roodi/checks/module_name_check.rb
 - lib/roodi/checks/name_check.rb
+- lib/roodi/checks/npath_complexity_check.rb
+- lib/roodi/checks/npath_complexity_method_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/parser.rb
 - lib/roodi/core/runner.rb
 - lib/roodi/core/visitable_sexp.rb
@@ -107,6 +98,7 @@ files:
 - 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/npath_complexity_method_check_spec.rb
 - spec/roodi/checks/parameter_number_check_spec.rb
 - spec/spec_helper.rb
 has_rdoc: true

data/lib/roodi/core/iterator_visitor.rb

@@ -1,19 +0,0 @@
-module Roodi
-  module Core
-    class IteratorVisitor
-    	def initialize(payload)
-      	@payload = payload
-    	end
-	
-    	def visit(visited)
-    		visited.accept(@payload)
-    		visitable_nodes = visited.is_language_node? ? visited.sexp_body : visited
-    		visitable_nodes.each do |child| 
-    		  if child.class == Sexp then
-      		  child.accept(self)
-    		  end
-  		  end
-    	end
-    end
-  end
-end