roodi 2.0.1 → 2.1.0

data/History.txt

@@ -1,3 +1,9 @@
+= 2.1.0
+
+* Ruby 1.9 compatible.
+* New framework support to allow start and end file events.
+* Added MissingForeignKeyIndexCheck.  Still experimental for now.
+
 = 2.0.1
 
 * Fixed a bug where roodi.yml was not being loaded.  Patch supplied by Rob Mitchell.

data/Manifest.txt

@@ -22,6 +22,7 @@ lib/roodi/checks/for_loop_check.rb
 lib/roodi/checks/line_count_check.rb
 lib/roodi/checks/method_line_count_check.rb
 lib/roodi/checks/method_name_check.rb
+lib/roodi/checks/missing_foreign_key_index_check.rb
 lib/roodi/checks/module_line_count_check.rb
 lib/roodi/checks/module_name_check.rb
 lib/roodi/checks/name_check.rb
@@ -49,8 +50,11 @@ 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/missing_foreign_key_index_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/roodi/core/runner_spec.rb
+spec/roodi/roodi.yml
 spec/spec_helper.rb

data/lib/roodi.rb

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

data/lib/roodi/checks.rb

@@ -11,6 +11,7 @@ require 'roodi/checks/empty_rescue_body_check'
 require 'roodi/checks/for_loop_check'
 require 'roodi/checks/method_line_count_check'
 require 'roodi/checks/method_name_check'
+require 'roodi/checks/missing_foreign_key_index_check'
 require 'roodi/checks/module_line_count_check'
 require 'roodi/checks/module_name_check'
 require 'roodi/checks/npath_complexity_method_check'

data/lib/roodi/checks/check.rb

@@ -12,13 +12,19 @@ module Roodi
       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)
+        define_method(start_node_method) { |node| return } unless self.respond_to?(start_node_method)
+        define_method(end_node_method) { |node| return } unless self.respond_to?(end_node_method)
       end
 
       def position(offset = 0)
         "#{@line[2]}:#{@line[1] + offset}"
       end
+
+      def start_file(filename)
+      end
+      
+      def end_file(filename)
+      end
       
       def evaluate_start(node)
       end
@@ -42,8 +48,9 @@ module Roodi
         evaluate_end(node)
       end
   
-      def add_error(error)
-        @errors << Roodi::Core::Error.new("#{@node.file}", "#{@node.line}", error)
+      def add_error(error, filename = @node.file, line = @node.line)
+        @errors ||= []
+        @errors << Roodi::Core::Error.new("#{filename}", "#{line}", error)
       end
   
       def errors

data/lib/roodi/checks/cyclomatic_complexity_check.rb

@@ -13,7 +13,7 @@ module Roodi
       end
       
       COMPLEXITY_NODE_TYPES.each do |type|
-        define_method "evaluate_start_#{type}" do
+        define_method "evaluate_start_#{type}" do |node|
           @count = @count + 1 if counting?
         end
       end

data/lib/roodi/checks/empty_rescue_body_check.rb

@@ -7,7 +7,7 @@ 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, :lasgn]
+      STATEMENT_NODES = [:fcall, :return, :attrasgn, :vcall, :nil, :call, :lasgn, :true, :false]
       
       def interesting_nodes
         [:resbody]

data/lib/roodi/checks/missing_foreign_key_index_check.rb

@@ -0,0 +1,98 @@
+require 'roodi/checks/check'
+require 'pathname'
+
+module Roodi
+  module Checks
+    # Checks to make sure for loops are not being used..
+    #
+    # Using a for loop is not idiomatic use of Ruby, and is usually a sign that someone with
+    # more experience in a different programming language is trying out Ruby.  Use
+    # Enumerable.each with a block instead.
+    class MissingForeignKeyIndexCheck < Check
+      def initialize
+        @foreign_keys = {}
+        @indexes = {}
+      end
+
+      def interesting_nodes
+        [:call]
+      end
+
+      def evaluate_start_call(node)
+        if analyzing_schema(node)
+          if creating_table(node)
+            @current_table = create_table_name(node)
+          end
+
+          if creating_foreign_key(node)
+            @foreign_keys[@current_table] ||= []
+            @foreign_keys[@current_table] << foreign_key_column_name(node)
+          end
+
+          if adding_index(node)
+            @indexes[index_table_name(node)] ||= []
+            @indexes[index_table_name(node)] << index_column_name(node)
+          end
+        end
+      end
+      
+      def evaluate_end_call(node)
+        #ignored
+      end
+
+      def analyzing_schema(node)
+        pathname = Pathname.new(node.file)
+        @analyzing_schema ||= ("schema.rb" == pathname.basename.to_s)
+      end
+
+      def creating_table(node)
+        :create_table == node[2]
+      end
+
+      def create_table_name(node)
+        # Get table name out of this:
+        # s(:call, nil, :create_table, s(:arglist, s(:str, "duplicate_blocks"), s(:hash, s(:lit, :force), s(:true))))
+        node[3][1][1]
+      end
+
+      def creating_foreign_key(node)
+        #s(:call, s(:lvar, :t), :integer, s(:arglist, s(:str, "duplicate_set_id"), s(:hash, s(:lit, :null), s(:false))))
+        column_type = node[2]
+        column_name = node[3][1][1]
+        :integer == column_type && "_id" == column_name[-3,3]
+      end
+
+      def foreign_key_column_name(node)
+        #s(:call, s(:lvar, :t), :integer, s(:arglist, s(:str, "duplicate_set_id"), s(:hash, s(:lit, :null), s(:false))))
+        column_name = node[3][1][1]
+      end
+
+      def adding_index(node)
+        :add_index == node[2]
+      end
+
+      def index_table_name(node)
+        # Get table name out of this:
+        # s(:call, nil, :add_index, s(:arglist, s(:str, "duplicate_blocks"), s(:array, s(:str, "duplicate_set_id")), s(:hash, s(:lit, :name), s(:str, "index_duplicate_blocks_on_duplicate_set_id"))))
+        node[3][1][1]
+      end
+
+      def index_column_name(node)
+        # Get index column name out of this:
+        # s(:call, nil, :add_index, s(:arglist, s(:str, "duplicate_blocks"), s(:array, s(:str, "duplicate_set_id")), s(:hash, s(:lit, :name), s(:str, "index_duplicate_blocks_on_duplicate_set_id"))))
+        node[3][2][1][1]
+      end
+
+      def end_file(filename)
+        @foreign_keys.keys.each do |table|
+          foreign_keys = @foreign_keys[table] || []
+          indexes = @indexes[table] || []
+          missing_indexes = foreign_keys - indexes
+          missing_indexes.each do |fkey| 
+            add_error("Table '#{table}' is missing an index on the foreign key '#{fkey}'", filename, 1)
+          end
+        end
+      end
+    end
+  end
+end

data/lib/roodi/core/checking_visitor.rb

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

data/lib/roodi/core/runner.rb

@@ -21,12 +21,14 @@ module Roodi
       def check(filename, content)
         @checks ||= load_checks
         @checker ||= CheckingVisitor.new(@checks)
+        @checks.each {|check| check.start_file(filename)}
         node = parse(filename, content)
         node.accept(@checker) if node
+        @checks.each {|check| check.end_file(filename)}
       end
 
-      def check_content(content)
-        check("dummy-file.rb", content)
+      def check_content(content, filename = "dummy-file.rb")
+        check(filename, content)
       end
   
       def check_file(filename)

data/roodi.yml

@@ -9,6 +9,7 @@ EmptyRescueBodyCheck:            { }
 ForLoopCheck:                    { }
 MethodLineCountCheck:            { line_count: 20 }
 MethodNameCheck:                 { pattern: !ruby/regexp /^[_a-z<>=\[|+-\/\*`]+[_a-z0-9_<>=~@\[\]]*[=!\?]?$/ }
+# MissingForeignKeyIndexCheck:     { }
 ModuleLineCountCheck:            { line_count: 300 }
 ModuleNameCheck:                 { pattern: !ruby/regexp /^[A-Z][a-zA-Z0-9]*$/ }
 ParameterNumberCheck:            { parameter_count: 5 }

data/spec/roodi/checks/empty_rescue_body_check_spec.rb

@@ -111,4 +111,30 @@ describe Roodi::Checks::EmptyRescueBodyCheck do
     errors.should_not be_empty
     errors[0].to_s.should match(/dummy-file.rb:[3-4] - Rescue block should not be empty./)
   end
+
+  it "should accept a rescue block that returns true" do
+    content = <<-END
+    begin
+      call_method
+    rescue Exception => e
+      true
+    end
+    END
+    @roodi.check_content(content)
+    errors = @roodi.errors
+    errors.should be_empty
+  end
+
+  it "should accept a rescue block that returns false" do
+    content = <<-END
+    begin
+      call_method
+    rescue Exception => e
+      false
+    end
+    END
+    @roodi.check_content(content)
+    errors = @roodi.errors
+    errors.should be_empty
+  end
 end

data/spec/roodi/checks/missing_foreign_key_index_check_spec.rb

@@ -0,0 +1,33 @@
+require File.expand_path(File.dirname(__FILE__) + '/../../spec_helper')
+
+describe Roodi::Checks::MissingForeignKeyIndexCheck do
+  before(:each) do
+    @roodi = Roodi::Core::Runner.new(Roodi::Checks::MissingForeignKeyIndexCheck.new)
+  end
+
+  it "should warn about a missing foreign key" do
+    content = <<-END
+ActiveRecord::Schema.define(:version => 20091215233604) do
+  create_table "projects", :force => true do |t|
+    t.string   "name"
+  end
+
+  create_table "revisions", :force => true do |t|
+    t.integer  "project_id"
+    t.string   "key"
+  end
+
+  add_index "revisions", ["project_id"], :name => "index_revisions_on_project_id"
+
+  create_table "source_files", :force => true do |t|
+    t.integer "revision_id"
+    t.string  "filename"
+  end
+end
+    END
+    @roodi.check_content(content, "schema.rb")
+    errors = @roodi.errors
+    errors.should_not be_empty
+    errors[0].to_s.should eql("schema.rb:1 - Table 'source_files' is missing an index on the foreign key 'revision_id'")
+  end
+end

data/spec/roodi/core/runner_spec.rb

@@ -0,0 +1,25 @@
+require File.expand_path(File.dirname(__FILE__) + '/../../spec_helper')
+
+describe Roodi::Core::Runner do
+  
+  describe "given a custom config file" do
+    before do
+      @runner = Roodi::Core::Runner.new
+      @runner.config= File.expand_path(File.dirname(__FILE__) + '/../roodi.yml')
+    end
+    
+    it "uses check from it" do
+      # @runner.check_file(File.expand_path(File.dirname(__FILE__) + '/../fixtures/test_class.rb'))
+      content = <<-RUBY
+        class TestClass
+
+          def METHOD
+
+          end
+        end
+      RUBY
+      @runner.check_content(content)
+      @runner.errors.should be_empty
+    end
+  end
+end

data/spec/roodi/roodi.yml

@@ -0,0 +1 @@
+MethodNameCheck:                 { pattern: !ruby/regexp /^[A-Z]+$/ }

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification 
 name: roodi
 version: !ruby/object:Gem::Version 
-  version: 2.0.1
+  version: 2.1.0
 platform: ruby
 authors: 
 - Marty Andrews
@@ -9,7 +9,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2009-10-26 00:00:00 +11:00
+date: 2009-12-28 00:00:00 +11:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency 
@@ -30,7 +30,7 @@ dependencies:
     requirements: 
     - - ">="
       - !ruby/object:Gem::Version 
-        version: 1.11.0
+        version: 2.3.3
     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: 
@@ -69,6 +69,7 @@ files:
 - lib/roodi/checks/line_count_check.rb
 - lib/roodi/checks/method_line_count_check.rb
 - lib/roodi/checks/method_name_check.rb
+- lib/roodi/checks/missing_foreign_key_index_check.rb
 - lib/roodi/checks/module_line_count_check.rb
 - lib/roodi/checks/module_name_check.rb
 - lib/roodi/checks/name_check.rb
@@ -96,10 +97,13 @@ files:
 - 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/missing_foreign_key_index_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/roodi/core/runner_spec.rb
+- spec/roodi/roodi.yml
 - spec/spec_helper.rb
 has_rdoc: true
 homepage: http://roodi.rubyforge.org