Contents

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.select {|arg| [Sexp, Symbol].include? arg.class}.count - 1
        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

Version data entries

11 entries across 11 versions & 1 rubygems

Version	Path
roodi-5.0.0	lib/roodi/checks/parameter_number_check.rb
roodi-4.1.1	lib/roodi/checks/parameter_number_check.rb
roodi-4.1.0	lib/roodi/checks/parameter_number_check.rb
roodi-4.0.0	lib/roodi/checks/parameter_number_check.rb
roodi-3.3.1	lib/roodi/checks/parameter_number_check.rb
roodi-3.3.0	lib/roodi/checks/parameter_number_check.rb
roodi-3.2.0	lib/roodi/checks/parameter_number_check.rb
roodi-3.1.1	lib/roodi/checks/parameter_number_check.rb
roodi-3.1.0	lib/roodi/checks/parameter_number_check.rb
roodi-3.0.1	lib/roodi/checks/parameter_number_check.rb
roodi-3.0.0	lib/roodi/checks/parameter_number_check.rb