Contents

require File.join( File.dirname( File.expand_path(__FILE__)), 'smell_detector')
require File.join(File.dirname(File.dirname(File.expand_path(__FILE__))), 'smell_warning')

module Reek
  module Smells

    #
    # A Long Method is any method that has a large number of lines.
    #
    # Currently +LongMethod+ reports any method with more than
    # 5 statements.
    #
    class LongMethod < SmellDetector

      SMELL_CLASS = self.name.split(/::/)[-1]
      SUBCLASS_TOO_MANY_STATEMENTS = 'TooManyStatements'

      STATEMENT_COUNT_KEY = 'statement_count'

      # The name of the config field that sets the maximum number of
      # statements permitted in any method.
      MAX_ALLOWED_STATEMENTS_KEY = 'max_statements'

      DEFAULT_MAX_STATEMENTS = 5

      def self.default_config
        super.adopt(
          MAX_ALLOWED_STATEMENTS_KEY => DEFAULT_MAX_STATEMENTS,
          EXCLUDE_KEY => ['initialize']
        )
      end

      def initialize(source, config = LongMethod.default_config)
        super(source, config)
      end

      #
      # Checks the length of the given +method+.
      #
      # @return [Array<SmellWarning>]
      #
      def examine_context(ctx)
        @max_allowed_statements = value(MAX_ALLOWED_STATEMENTS_KEY, ctx, DEFAULT_MAX_STATEMENTS)
        num = ctx.num_statements
        return [] if num <= @max_allowed_statements
        smell = SmellWarning.new(SMELL_CLASS, ctx.full_name, [ctx.exp.line],
          "has approx #{num} statements",
          @source, SUBCLASS_TOO_MANY_STATEMENTS,
          {STATEMENT_COUNT_KEY => num})
        [smell]
      end
    end
  end
end

Version data entries

8 entries across 8 versions & 1 rubygems

Version	Path
reek-1.3.1	lib/reek/smells/long_method.rb
reek-1.3	lib/reek/smells/long_method.rb
reek-1.2.13	lib/reek/smells/long_method.rb
reek-1.2.12	lib/reek/smells/long_method.rb
reek-1.2.11	lib/reek/smells/long_method.rb
reek-1.2.10	lib/reek/smells/long_method.rb
reek-1.2.9	lib/reek/smells/long_method.rb
reek-1.2.8	lib/reek/smells/long_method.rb