turboladen/tailor

View on GitHub
lib/tailor/rulers/max_code_lines_in_method_ruler.rb

Summary

Maintainability
A
2 hrs
Test Coverage
require_relative '../ruler'
require_relative '../lexer/lexer_constants'

class Tailor
  module Rulers
    class MaxCodeLinesInMethodRuler < Tailor::Ruler
      include Tailor::LexerConstants

      def initialize(config, options)
        super(config, options)
        add_lexer_observers(:ignored_nl, :kw, :nl)
        @method_start_lines = []
        @kw_start_lines = []
        @end_last_method = false
      end

      def ignored_nl_update(lexed_line, _, _)
        return if @method_start_lines.empty?
        return if lexed_line.only_spaces?
        return if lexed_line.comment_line?

        @method_start_lines.each do |line|
          line[:count] += 1
          log "Method from line #{line[:lineno]} now at #{line[:count]} lines."
        end

        if @end_last_method
          measure(@method_start_lines.last[:count],
            @method_start_lines.last[:lineno],
            @method_start_lines.last[:column])
          @method_start_lines.pop
          @end_last_method = false
        end
      end

      def kw_update(token, _, lineno, column)
        if token == 'def'
          @method_start_lines << { lineno: lineno, column: column, count: 0 }
          log "Method start lines: #{@method_start_lines}"
        end

        unless token.modifier_keyword? ||
          !token.keyword_to_indent? ||
          token.do_is_for_a_loop? ||
          token.continuation_keyword?
          @kw_start_lines << lineno
          log "Keyword start lines: #{@kw_start_lines}"
        end

        if token == 'end'
          log "Got 'end' of method."

          unless @method_start_lines.empty?
            if @method_start_lines.last[:lineno] == @kw_start_lines.last
              #msg = "Method from line #{@method_start_lines.last[:lineno]}"
              #msg << " was #{@method_start_lines.last[:count]} lines long."
              #log msg
              @end_last_method = true
            end
          end

          @kw_start_lines.pop
          log "End of keyword statement.  Keywords: #{@kw_start_lines}"
        end
      end

      def nl_update(lexed_line, lineno, column)
        ignored_nl_update(lexed_line, lineno, column)
      end

      # Checks to see if the actual count of code lines in the method is greater
      # than the value in +@config+.
      #
      # @param [Fixnum] actual_count The number of code lines found.
      # @param [Fixnum] lineno The line the potential problem is on.
      # @param [Fixnum] column The column the potential problem is on.
      def measure(actual_count, lineno, column)
        if actual_count > @config
          msg = "Method has #{actual_count} code lines, but "
          msg << "should have no more than #{@config}."

          @problems << Problem.new(problem_type, lineno, column, msg,
            @options[:level])
        end
      end
    end
  end
end