metric_fu-roodi 2.2.0

data/lib/roodi/core/visitable_sexp.rb

@@ -0,0 +1,25 @@
+require 'rubygems'
+require 'sexp'
+
+class Sexp
+  def accept(visitor)
+    visitor.visit(self)
+  end
+
+  def node_type
+    first
+  end
+
+  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/lib/roodi/version.rb

@@ -0,0 +1,3 @@
+module Roodi
+  VERSION = '2.2.0'
+end

data/lib/roodi_task.rb

@@ -0,0 +1,35 @@
+class RoodiTask < Rake::TaskLib
+  attr_accessor :name
+  attr_accessor :patterns
+  attr_accessor :config
+  attr_accessor :verbose
+
+  def initialize name = :roodi, patterns = nil, config = nil
+    @name      = name
+    @patterns  = patterns || %w(app/**/*.rb lib/**/*.rb spec/**/*.rb test/**/*.rb)
+    @config    = config
+    @verbose   = Rake.application.options.trace
+
+    yield self if block_given?
+
+    define
+  end
+
+  def define
+    desc "Check for design issues in: #{patterns.join(', ')}"
+    task name do
+      runner = Roodi::Core::Runner.new
+
+      runner.config = config if config
+
+      patterns.each do |pattern|
+        Dir.glob(pattern).each { |file| runner.check_file(file) }
+      end
+
+      runner.errors.each {|error| puts error}
+
+      raise "Found #{runner.errors.size} errors." unless runner.errors.empty?
+    end
+    self
+  end
+end

data/roodi.gemspec

@@ -0,0 +1,26 @@
+$: << File.expand_path("../lib", __FILE__)
+require "roodi/version"
+
+Gem::Specification.new do |gem|
+
+  gem.name = "metric_fu-roodi"
+  gem.summary = "Roodi stands for Ruby Object Oriented Design Inferometer"
+  gem.description = "Roodi stands for Ruby Object Oriented Design Inferometer"
+  gem.homepage = "http://roodi.rubyforge.org"
+  gem.authors = ["Marty Andrews"]
+  gem.email = "marty@cogent.co"
+
+  gem.version = Roodi::VERSION.dup
+  gem.platform = Gem::Platform::RUBY
+  gem.add_runtime_dependency("ruby_parser")
+  gem.homepage    = "http://github.com/metricfu/roodi"
+  # TODO check if this is necessary
+  # gem.required_ruby_version     = ">= 1.8.7"
+  # gem.required_rubygems_version = ">= 1.3.6"
+  gem.files              = `git ls-files`.split($\)
+  gem.test_files         =  gem.files.grep(%r{^(test|spec|features)/})
+  gem.executables        =  gem.files.grep(%r{^bin/}).map{ |f| File.basename(f) }
+  gem.require_paths = ["lib"]
+  gem.license     = 'MIT'
+
+end

data/roodi.yml

@@ -0,0 +1,25 @@
+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_<>=~@\[\]]*[=!\?]?$/ 
+# MissingForeignKeyIndexCheck:
+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::Runner.new(Roodi::Checks::AbcMetricMethodCheck.make({'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

@@ -0,0 +1,105 @@
+require File.expand_path(File.dirname(__FILE__) + '/../../spec_helper')
+
+describe Roodi::Checks::AssignmentInConditionalCheck do
+  before(:each) do
+    @roodi = Roodi::Core::Runner.new(Roodi::Checks::AssignmentInConditionalCheck.make)
+  end
+  
+  it "should accept an assignment before an if clause" do
+    content = <<-END
+    count = count + 1 if some_condition
+    END
+    @roodi.check_content(content)
+    errors = @roodi.errors
+    errors.should be_empty
+  end
+
+  it "should reject an assignment inside an if clause" do
+    content = <<-END
+    call_foo if bar = bam
+    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 inside an unless clause" do
+    content = <<-END
+    call_foo unless bar = bam
+    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 inside a while clause" do
+    content = <<-END
+    call_foo while bar = bam
+    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 inside an unless clause" do
+    content = <<-END
+    call_foo while bar = bam
+    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 inside a a ternary operator check clause" do
+    content = 'call_foo (bar = bam) ? baz : bad'
+    @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 '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/case_missing_else_check_spec.rb

@@ -0,0 +1,32 @@
+require File.expand_path(File.dirname(__FILE__) + '/../../spec_helper')
+
+describe Roodi::Checks::CaseMissingElseCheck do
+  before(:each) do
+    @roodi = Roodi::Core::Runner.new(Roodi::Checks::CaseMissingElseCheck.make)
+  end
+  
+  it "should accept case statements that do have an else" do
+    content = <<-END
+    case foo
+      when "bar": "ok"
+      else "good"
+    end
+    END
+    @roodi.check_content(content)
+    errors = @roodi.errors
+    errors.should be_empty
+  end
+  
+  it "should reject case statements that do have an else" do
+    content = <<-END
+    case foo
+      when "bar": "ok"
+      when "bar": "bad"
+    end
+    END
+    @roodi.check_content(content)
+    errors = @roodi.errors
+    errors.should_not be_empty
+    errors[0].to_s.should match(/dummy-file.rb:[1-2] - Case statement is missing an else clause./)
+  end
+end

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::Runner.new(Roodi::Checks::ClassLineCountCheck.make({'line_count' => 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].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

@@ -0,0 +1,39 @@
+require File.expand_path(File.dirname(__FILE__) + '/../../spec_helper')
+
+describe Roodi::Checks::ClassNameCheck do
+  before(:each) do
+    @roodi = Roodi::Core::Runner.new(Roodi::Checks::ClassNameCheck.make)
+  end
+  
+  it "should accept camel case class names starting in capitals" do
+    content = <<-END
+    class GoodClassName 
+    end
+    END
+    @roodi.check_content(content)
+    @roodi.errors.should be_empty
+  end
+
+  it "should be able to parse scoped class names" do
+    content = <<-END
+    class MyScope::GoodClassName 
+      def method
+      end
+    end
+    END
+    # @roodi.print_content(content)
+    @roodi.check_content(content)
+    @roodi.errors.should be_empty
+  end
+
+  it "should reject class names with underscores" do
+    content = <<-END
+    class Bad_ClassName 
+    end
+    END
+    @roodi.check_content(content)
+    errors = @roodi.errors
+    errors.should_not be_empty
+    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::Runner.new(Roodi::Checks::ClassVariableCheck.make)
+  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 match(/dummy-file.rb:[1-2] - Don't use class variables. You might want to try a different design./)
+  end
+end