roodi1.9 2.0.1

data/spec/roodi/checks/cyclomatic_complexity_method_check_spec.rb

@@ -0,0 +1,200 @@
+require File.expand_path(File.dirname(__FILE__) + '/../../spec_helper')
+
+describe Roodi::Checks::CyclomaticComplexityMethodCheck do
+  before(:each) do
+    @roodi = Roodi::Core::Runner.new(Roodi::Checks::CyclomaticComplexityMethodCheck.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\" cyclomatic complexity is #{complexity}.  It should be 0 or less.")
+  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 an unless block" do
+    content = <<-END
+    def method_name
+      call_foo unless some_condition
+    end
+    END
+    verify_content_complexity(content, 2)
+  end
+
+  it "should find an elsif block" do
+    content = <<-END
+    def method_name
+      if first_condition then
+        call_foo
+      elsif second_condition then
+        call_bar
+      else
+        call_bam
+      end
+    end
+    END
+    verify_content_complexity(content, 3)
+  end
+
+  it "should find a ternary operator" do
+    content = <<-END
+    def method_name
+      value = some_condition ? 1 : 2
+    end
+    END
+    verify_content_complexity(content, 2)
+  end
+
+  it "should find a while loop" do
+    content = <<-END
+    def method_name
+      while some_condition do
+        call_foo
+      end
+    end
+    END
+    verify_content_complexity(content, 2)
+  end
+
+  it "should find an until loop" do
+    content = <<-END
+    def method_name
+      until some_condition do
+        call_foo
+      end
+    end
+    END
+    verify_content_complexity(content, 2)
+  end
+
+  it "should find a for loop" do
+    content = <<-END
+    def method_name
+      for i in 1..2 do
+        call_method
+      end
+    end
+    END
+    verify_content_complexity(content, 2)
+  end
+
+  it "should find a rescue block" do
+    content = <<-END
+    def method_name
+      begin
+        call_foo
+      rescue Exception
+        call_bar
+      end
+    end
+    END
+    verify_content_complexity(content, 2)
+  end
+
+  it "should find a case and when block" do
+    content = <<-END
+    def method_name
+      case value
+      when 1
+        call_foo
+      when 2
+        call_bar
+      end
+    end
+    END
+    verify_content_complexity(content, 4)
+  end
+
+  it "should find the && symbol" do
+    content = <<-END
+    def method_name
+      call_foo && call_bar
+    end
+    END
+    verify_content_complexity(content, 2)
+  end
+
+  it "should find the and symbol" do
+    content = <<-END
+    def method_name
+      call_foo and call_bar
+    end
+    END
+    verify_content_complexity(content, 2)
+  end
+
+  it "should find the || symbol" do
+    content = <<-END
+    def method_name
+      call_foo || call_bar
+    end
+    END
+    verify_content_complexity(content, 2)
+  end
+
+  it "should find the or symbol" do
+    content = <<-END
+    def method_name
+      call_foo or call_bar
+    end
+    END
+    verify_content_complexity(content, 2)
+  end
+
+  it "should deal with nested if blocks containing && and ||" do
+    content = <<-END
+    def method_name
+      if first_condition then
+        call_foo if second_condition && third_condition
+        call_bar if fourth_condition || fifth_condition
+      end
+    end
+    END
+    verify_content_complexity(content, 6)
+  end
+
+  it "should count stupid nested if and else blocks" do
+    content = <<-END
+    def method_name
+      if first_condition then
+        call_foo
+      else
+        if second_condition then
+          call_bar
+        else
+          call_bam if third_condition
+        end
+        call_baz if fourth_condition
+      end
+    end
+    END
+    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/empty_rescue_body_check_spec.rb

@@ -0,0 +1,140 @@
+require File.expand_path(File.dirname(__FILE__) + '/../../spec_helper')
+
+describe Roodi::Checks::EmptyRescueBodyCheck do
+  before(:each) do
+    @roodi = Roodi::Core::Runner.new(Roodi::Checks::EmptyRescueBodyCheck.new)
+  end
+  
+  it "should accept a rescue body with content and no parameter" do
+    content = <<-END
+    begin
+      call_method
+    rescue
+      puts "Recover from the call"
+    end
+    END
+    @roodi.check_content(content)
+    @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
+      call_method
+    rescue Exception => e
+      puts "Recover from the call"
+    end
+    END
+    @roodi.check_content(content)
+    @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
+      call_method
+    rescue
+    end
+    END
+    @roodi.check_content(content)
+    errors = @roodi.errors
+    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 with an explicit nil" do
+    content = <<-END
+    call_method rescue nil
+    END
+    @roodi.check_content(content)
+    errors = @roodi.errors
+    errors.should be_empty
+  end
+
+  it "should reject an empty rescue block with a parameter" do
+    content = <<-END
+    begin
+      call_method
+    rescue Exception => e
+    end
+    END
+    @roodi.check_content(content)
+    errors = @roodi.errors
+    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/for_loop_check_spec.rb

@@ -0,0 +1,18 @@
+require File.expand_path(File.dirname(__FILE__) + '/../../spec_helper')
+
+describe Roodi::Checks::ForLoopCheck do
+  before(:each) do
+    @roodi = Roodi::Core::Runner.new(Roodi::Checks::ForLoopCheck.new)
+  end
+  
+  it "should reject for loops" do
+    content = <<-END
+    for i in 1..2
+    end
+    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 'for' loops. Use Enumerable.each instead.")
+  end
+end

data/spec/roodi/checks/method_line_count_check_spec.rb

@@ -0,0 +1,56 @@
+require File.expand_path(File.dirname(__FILE__) + '/../../spec_helper')
+
+describe Roodi::Checks::MethodLineCountCheck do
+  before(:each) do
+    @roodi = Roodi::Core::Runner.new(Roodi::Checks::MethodLineCountCheck.new({'line_count' => 1}))
+  end
+  
+  it "should accept methods with less lines than the threshold" do
+    content = <<-END
+    def zero_line_method
+    end
+    END
+    @roodi.check_content(content)
+    @roodi.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
+    @roodi.check_content(content)
+    @roodi.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
+    @roodi.check_content(content)
+    errors = @roodi.errors
+    errors.should_not be_empty
+    errors[0].to_s.should eql("dummy-file.rb:1 - Method \"two_line_method\" has 2 lines.  It should have 1 or less.")
+  end
+
+  it "should count only lines from the method" do
+    content = <<-END
+    def first_method
+      puts 1
+    end
+
+    def second_method
+      puts 1
+      puts 2
+    end
+    END
+    @roodi.check_content(content)
+    errors = @roodi.errors
+    errors.should_not be_empty
+    errors[0].to_s.should eql("dummy-file.rb:5 - Method \"second_method\" has 2 lines.  It should have 1 or less.")
+  end
+end

data/spec/roodi/checks/method_name_check_spec.rb

@@ -0,0 +1,76 @@
+require File.expand_path(File.dirname(__FILE__) + '/../../spec_helper')
+
+describe Roodi::Checks::MethodNameCheck do
+  before(:each) do
+    @roodi = Roodi::Core::Runner.new(Roodi::Checks::MethodNameCheck.new)
+  end
+  
+  it "should accept method names with underscores" do
+    content = <<-END
+    def good_method_name
+    end
+    END
+    @roodi.check_content(content)
+    @roodi.errors.should be_empty
+  end
+
+  it "should accept method names with numbers" do
+    content = <<-END
+    def good_method_1_name
+    end
+    END
+    @roodi.check_content(content)
+    @roodi.errors.should be_empty
+  end
+
+  it "should accept method names ending a question mark" do
+    content = <<-END
+    def good_method_name?
+    end
+    END
+    @roodi.check_content(content)
+    @roodi.errors.should be_empty
+  end
+
+  it "should accept method names ending an exclamation mark" do
+    content = <<-END
+    def good_method_name!
+    end
+    END
+    @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=
+    end
+    END
+    @roodi.check_content(content)
+    @roodi.errors.should be_empty
+  end
+
+  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
+
+  it "should reject camel case method names" do
+    content = <<-END
+    def badMethodName
+    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 \"badMethodName\" should match pattern /^[_a-z<>=\\[|+-\\/\\*`]+[_a-z0-9_<>=~@\\[\\]]*[=!\\?]?$/")
+  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/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::Runner.new(Roodi::Checks::ModuleLineCountCheck.new({'line_count' => 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].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

@@ -0,0 +1,27 @@
+require File.expand_path(File.dirname(__FILE__) + '/../../spec_helper')
+
+describe Roodi::Checks::ModuleNameCheck do
+  before(:each) do
+    @roodi = Roodi::Core::Runner.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].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/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

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::Runner.new(Roodi::Checks::ParameterNumberCheck.new({'parameter_count' => 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].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
+    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].to_s.should eql("dummy-file.rb:1 - Method name \"two_parameter_method\" has 2 parameters.  It should have 1 or less.")
+  end
+end