metric_fu-roodi 2.2.2 → 3.0.0

data/lib/roodi/checks/parameter_number_check.rb

@@ -1,34 +0,0 @@
-require 'roodi/checks/check'
-
-module Roodi
-  module Checks
-    # Checks a method to make sure the number of parameters it has is under the specified limit.
-    # 
-    # A method taking too many parameters is a code smell that indicates it might be doing too 
-    # much, or that the parameters should be grouped into one or more objects of their own.  It
-    # probably needs some refactoring. 
-    class ParameterNumberCheck < Check
-      
-      DEFAULT_PARAMETER_COUNT = 5
-      
-      attr_accessor :parameter_count
-
-      def initialize
-        super()
-        self.parameter_count = DEFAULT_PARAMETER_COUNT
-      end
-      
-      def interesting_nodes
-        [:defn]
-      end
-
-      def evaluate_start(node)
-        method_name = node[1]
-        arguments = node[2]
-        actual_parameter_count = arguments.inject(-1) { |count, each| count = count + (each.class == Symbol ? 1 : 0) }
-        add_error "Method name \"#{method_name}\" has #{actual_parameter_count} parameters.  It should have #{@parameter_count} or less." unless actual_parameter_count <= @parameter_count
-      end
-
-    end
-  end
-end

data/lib/roodi/core.rb

@@ -1 +0,0 @@
-require 'roodi/core/runner'

data/lib/roodi/core/checking_visitor.rb

@@ -1,26 +0,0 @@
-module Roodi
-  module Core
-    class CheckingVisitor
-      def initialize(*checks)
-        @checks ||= {}
-        checks.first.each do |check|
-          nodes = check.interesting_nodes
-          nodes.each do |node|
-            @checks[node] ||= []
-            @checks[node] << check
-            @checks[node].uniq!
-          end
-        end
-      end
-
-      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)}
-
-        checks.each {|check| check.evaluate_node_end(node)} unless checks.nil?
-      end
-    end
-  end
-end

data/lib/roodi/core/error.rb

@@ -1,17 +0,0 @@
-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/lib/roodi/core/parser.rb

@@ -1,48 +0,0 @@
-require 'rubygems'
-require 'ruby_parser'
-require 'rbconfig'
-
-module Roodi
-  module Core
-    class Parser
-      def parse(content, filename)
-        silence_stream(STDERR) do 
-          return silent_parse(content, filename)
-        end
-      end
-      
-      private
-      
-      def silence_stream(stream)
-        old_stream = stream.dup
-        stream.reopen(null_stream_output)
-        stream.sync = true
-        yield
-      ensure
-        stream.reopen(old_stream)
-      end
-      
-      def silent_parse(content, filename)
-        @parser ||= RubyParser.new
-        @parser.parse(content, filename)
-      end
-      
-      def null_stream_output
-        null_output_for_platform(RbConfig::CONFIG['host_os'])
-      end
-      
-      def null_output_for_platform(host_os)
-        case host_os
-        when windows_host_os_matcher
-          'NUL:'
-        else
-          '/dev/null'
-        end
-      end
-      
-      def windows_host_os_matcher
-        /mingw|mswin32|cygwin/o
-      end
-    end
-  end
-end

data/lib/roodi/core/runner.rb

@@ -1,81 +0,0 @@
-require 'pp'
-require 'yaml'
-
-require 'roodi/core/checking_visitor'
-require 'roodi/core/parser'
-require 'roodi/core/visitable_sexp'
-
-module Roodi
-  module Core
-    class Runner
-      DEFAULT_CONFIG = File.join(File.dirname(__FILE__), "..", "..", "..", "roodi.yml")
-      
-      attr_writer :config
-      
-      def initialize(*checks)
-        @config = DEFAULT_CONFIG
-        @checks = checks unless checks.empty?
-      end
-      
-      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, filename = "dummy-file.rb")
-        check(filename, content)
-      end
-  
-      def check_file(filename)
-        return unless File.exists?(filename)
-        check(filename, File.read(filename))
-      end
-  
-      def print(filename, content)
-        node = parse(filename, content)
-        puts "Line: #{node.line}"
-        pp node
-      end
-
-      def print_content(content)
-        print("dummy-file.rb", content)
-      end
-  
-      def print_file(filename)
-        print(filename, File.read(filename))
-      end
-  
-      def errors
-        @checks ||= []
-        all_errors = @checks.collect {|check| check.errors}
-        all_errors.flatten
-      end
-      
-      private
-      
-      def parse(filename, content)
-        begin
-          Parser.new.parse(content, filename)
-        rescue Exception => e
-          puts "#{filename} looks like it's not a valid Ruby file.  Skipping..." if ENV["ROODI_DEBUG"]
-          nil
-        end
-      end
-
-      def load_checks
-        check_objects = []
-        checks = YAML.load_file @config
-        checks.each do |check_class_name, options|
-          check_class = Roodi::Checks.const_get(check_class_name)
-          check_objects << check_class.make(options || {})
-        end
-        check_objects
-      end
-
-    end
-  end
-end

data/lib/roodi/core/visitable_sexp.rb

@@ -1,25 +0,0 @@
-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_task.rb

@@ -1,35 +0,0 @@
-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

@@ -1,26 +0,0 @@
-$: << 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

@@ -1,25 +0,0 @@
-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

@@ -1,89 +0,0 @@
-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

@@ -1,105 +0,0 @@
-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